remove old readme
[atutor.git] / documentation / instructor / content.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict //EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
2 <html lang="en">\r
3 <head>\r
4         <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />\r
5         <title>ATutor 1.5 Instructor Documentation</title>\r
6         <link rel="stylesheet" href="../styles.css" type="text/css" />\r
7 </head>\r
8 <body>\r
9 \r
10 \r
11 <div class="nifty"><b class="rtop"><b class="r1"></b><b class="r2"></b><b class="r3"></b><b class="r4"></b></b>\r
12         <h1>2. Content</h1>\r
13         <p>In order to add and manage content for a course, you must first be logged in as an instructor. By selecting a course, you can manage your content from the Manage tab, or by the Content Navigation tree.</p>\r
14 \r
15         <h3>Table of Contents</h3>\r
16         <div id="toc">\r
17                 <ul>\r
18                         <li>2.1 <a href="#2.1">Creating and Editing Content</a></li>\r
19                         <li>2.2 <a href="#2.2">Content Packages</a></li>\r
20                 </ul>\r
21         </div>\r
22 \r
23 <b class="rbottom"><b class="r4"></b><b class="r3"></b><b class="r2"></b><b class="r1"></b></b></div>\r
24 \r
25 \r
26 <div class="nifty"><b class="rtop"><b class="r1"></b><b class="r2"></b><b class="r3"></b><b class="r4"></b></b>\r
27         <a name="2.1"></a><h2>2.1 Creating and Editing Content</h2>\r
28 \r
29         <p>Once you have selected a course, you can create or edit course content by selecting the <i>Manage</i> tab, then selecting the <i>Content</i> option.</p>\r
30 \r
31         <p>You should now see a table of all the content in your current course. If you have no content, this list will be empty. If you already have content in your course, you can select an item and click the <code>Edit</code> button to begin editing. If you want to create new content, select the <i>Create Content</i> link along the top.</p>\r
32 \r
33         <p>Whether editing or creating new content, the interface is the same for both actions.</p>\r
34         \r
35         <a name="2.1.1"></a><h3>2.1.1 Content</h3>\r
36         <p>Content can be created in either 'plain text' or 'HTML' modes. Plain text mode is useful for quickly writing up text content. Conversely, HTML mode allows for extra features like text formatting and layout, but is a little more complex to use.</p>\r
37 \r
38         <dl>\r
39                 <dt>Formatting: Plain Text</dt>\r
40                 <dd>If using plain text mode, just type the content in the Body window. Note that any extra spaces between characters will be removed (i.e. two or more spaces), but any blank lines will be saved with the text.</dd>\r
41 \r
42                 <dt>Formatting: HTML</dt>\r
43                 <dd>If using HTML mode, you can type HTML tags in the Body window along with your text. If you are unfamiliar with HTML, you can use the visual editor by clicking the <code>Switch to visual editor</code> button.</dd>\r
44 \r
45                 <dt>File Manager</dt>\r
46                 <dd>\r
47                         <p>The File Manager is a tool that allows you to upload files from your local system to be used in your course.</p>\r
48                         \r
49                         <p><code>Create Folder</code> creates a folder on the ATutor system so you can better organize your uploaded files. You can create folders and/or move files into that folder at any time you like.</p>\r
50 \r
51                         <p><code>Browse...</code> opens a local file browser window so you can select the file you want to upload.</p>\r
52 \r
53                         <p><code>Upload</code> will upload the specified file to the ATutor system. You can specify a file by either typing the path and filename in the <kbd>text field</kbd> or by using the <code>Browse</code> button.</p>\r
54 \r
55                         <p><em>Create a New File</em> link will display a new interface where you can quickly create a new text or HTML file. If using Text mode, any blank lines will be saved with the file. If using HTML, you should be familiar with using HTML tags as no visual editor is provided. Clicking <code>Save</code> will save a new file with your specified information (filename and content) into the ATutor system and bring you back to the File Manager. <code>Cancel</code> will discard the file and bring you back to the File Manager browser.</p>\r
56 \r
57                         <p><code>Rename</code> button renames a single, selected file.</p>\r
58 \r
59                         <p><code>Delete</code> and <code>Move</code> buttons deletes or moves the selected files and folders (and its contents) from the ATutor system. You can select multiple files and folders for deletion or moving.</p>\r
60 \r
61                         <p><code>Insert</code> appears under the <em>Action</em> column for files that can be inserted into the content. Clicking the <code>Insert</code> button will add appropriate HTML code into the body of the content. If you are formatting in <em>plain text</em> you will need to switch to <em>HTML</em> formatting in order for it to display properly.</p>\r
62                 </dd>\r
63 \r
64                 <dt>Terms</dt>\r
65                 <dd><p>In either plain text, or HTML formatting modes, you can insert <em>terms</em> which are used to tell the ATutor system the words you want to define in the glossary.</p>\r
66                 \r
67                 <p>Clicking the <em>Add Term</em> link will add <kbd>[?][/?]</kbd> into your content, and any text you put after <kbd>[?]</kbd> and before <kbd>[/?]</kbd> will specify the term you want to define. Alternatively, you can manually type <kbd>[?][/?]</kbd> into your text without having to click the <em>Add Term</em>.</p>\r
68 \r
69                 <p>Once you have specified the terms you would like to define, you can go to the <em>Glossary Terms</em> tab to write the definitions. Once done, the terms and their definitions will appear in the glossary and in the content.</p>\r
70 \r
71                 <dt>Code</dt>\r
72                 <dd><p>In either plain text, or HTML formatting modes, you can insert <em>code</em> which is useful for differentiating blocks of text (like math equations, program code, or quotations)from the rest of the text content.</p>\r
73                 \r
74                 <p>Clicking the <em>Add Code</em> link will add <kbd>[code][/code]</kbd> into your content, and whatever text you put after <kbd>[code]</kbd> and before <kbd>[/code]</kbd> will specify the text you want to differentiate. Alternatively, you can manually type <kbd>[code][/code]</kbd> into your text without having to click the <em>Add Code</em> link.</p>\r
75                 </dd>\r
76 \r
77                 <dt>Colours</dt>\r
78                 <dd>Like <em>code</em> and <em>terms</em> you can add colour to your text content in the same way. You can either click the appropriate colour icon to insert colour tags into the content. Valid colour options are blue, red, green, orange, purple, and gray. You can also type the colour codes manually by using the following tags: <kbd>[blue][/blue]</kbd>, <kbd>[red][/red]</kbd>, <kbd>[green][/green]</kbd>, <kbd>[orange][/orange]</kbd>, <kbd>[purple][/purple]</kbd>, and <kbd>[gray][/gray]</kbd></dd>.\r
79 \r
80                 <dt>Upload from File</dt>\r
81                 <dd>Instead of typing your content, you can upload it from a text or HTML file on your local file system. Once uploaded, the content of that file will be displayed in the <em>Body</em> window. Keep in mind that uploading in this manner will replace any content in the <em>Body</em> window.</dd>\r
82 \r
83                 <dt>Save and Close</dt>\r
84                 <dd>At any point of editing or creating content, you can chose to <kbd>Save</kbd> your content, or <kbd>Cancel</kbd> your changes. \r
85                 </dd>\r
86         </dl>\r
87 \r
88         <a name="2.1.2"></a><h3>2.1.2 Properties</h3>\r
89         <p>In the properties tab, you can specify a Release Date, keywords for easier searching, and specify related topics.</p>\r
90 \r
91         <dl>\r
92                 <dt>Release Date</dt>\r
93                 <dd>The release date is the date in which the content will be visible to the course. You can schedule a release in the future by specifying a later date. Also, if you specify a release date that has past, it will be released immediately.</dd>\r
94 \r
95                 <dt>Keywords</dt>\r
96                 <dd>Words in the Keywords are given greater emphasis during searching. Therefore they will be placed higher in a list of search results than if there were no keywords. Keywords are also used to as Learning Object Metadata.</dd>\r
97 \r
98                 <dt>Related Topics</dt>\r
99                 <dd><p>For each piece of content you have in the course, you can specify what other content in the course is related. Moving content up the related topics list places that content closer to the top of the Content Navigation window. The opposite is true if you move content down the Related Topics list.</p>\r
100                 <p>You can also make content a child of another piece of content. In this case, the child content will appear as sub-content on the Content Navigation window. All sub-content children and their parent will appear in the Related Topics window.</p>\r
101                 </dd>\r
102         </dl>\r
103 \r
104         <a name="2.1.3"></a><h3>2.1.3 Glossary Terms</h3>\r
105         <p>If you specified Terms in the Content tab, you have the opportunity to define those terms here. For each term specified in the <em>Content</em> tab, there is a Definition window where you provide your explanation. If there are no glossary terms listed, you can add glossary terms by going to the Content tab and adding Term tags.</p>\r
106         \r
107         <p>In order to set a Related Term, you must have at least two defined terms in the glossary.</p>\r
108                 \r
109         <a name="2.1.4"></a><h3>2.1.4 Preview</h3>\r
110         <p>Under the Preview tab, you can see how your content will appear to a user, including Terms, Code, and Colors you added to the content.</p>\r
111                 \r
112         <a name="2.1.5"></a><h3>2.1.5 Accessibility</h3>\r
113         <p></p>\r
114 <b class="rbottom"><b class="r4"></b><b class="r3"></b><b class="r2"></b><b class="r1"></b></b></div>\r
115 \r
116 <div class="nifty"><b class="rtop"><b class="r1"></b><b class="r2"></b><b class="r3"></b><b class="r4"></b></b>\r
117         <a name="2.2"></a><h2>2.2 Content Packages</h2>\r
118         <p>ATutor provides importing and exporting course content using IMS 1.1.3/SCORM 1.2 content package specification. This allows ATutor content to be viewed offline, and transferred to other systems.</p>\r
119 \r
120         <a name="2.2.1"></a><h3>2.2.1 Exporting Content</h3>\r
121         <p>An entire course or a single chapter can be exported as an IMS 1.1.3/SCORM 1.2 content package. Exported packages are archived into a single file using ZIP compression. All content is exported including the terms and glossary, colours, and code.</p>\r
122         \r
123         <p>To export content, select the scope by choosing an option from the <em>What to export</em> menu. Then, clicking <kbd>Export</kbd> will generate a download through your browser. Optionally, you can choose to export the content directly to TILE if you have a TILE authoring account.</p>\r
124         \r
125         <a name="2.2.2"></a><h3>2.2.2 Viewing Exported Content</h3>\r
126         <p>To view a content package exported from ATutor, you will either need a IMS 1.1.3/SCORM 1.2 viewer, or a web browser. To view the content in a web browser, first extract the contents of the ZIP file and then open the file <kbd>index.html</kbd> in the browser.</p>\r
127 \r
128         <a name="2.2.3"></a><h3>2.2.3 Importing Content</h3>\r
129         <p>To import a content package into ATutor, it must conform to IMS 1.1.3/SCORM 1.2 content package specifications.</p>\r
130 \r
131         <p>Before importing, you must specify where in the course structure the new content is to be placed by using the <em>Import into</em> menu.</p>\r
132         \r
133         <p>Select the content package to upload by supplying the file from your local filesystem by typing in the path into the textfield or by using the <kbd>Browse</kbd> button. You can also import a content package over the Web by providing an URL.</p>\r
134 \r
135         <p>Clicking <kbd>Import</kbd> will upload the content into the course and at the hierarchy location specified.</p>\r
136         \r
137 <b class="rbottom"><b class="r4"></b><b class="r3"></b><b class="r2"></b><b class="r1"></b></b></div>\r
138 \r
139 </body>\r
140 </html>