diff --git a/lessonbuilder/help/pom.xml b/lessonbuilder/help/pom.xml new file mode 100644 index 000000000000..b24600024f40 --- /dev/null +++ b/lessonbuilder/help/pom.xml @@ -0,0 +1,33 @@ + + + 4.0.0 + + + org.sakaiproject.lessonbuilder + lessonbuilder + 10-SNAPSHOT + + + sakai-lessonbuildertool-help + org.sakaiproject.lessonbuilder + lessonbuilder-help + + Sakai Project + http://sakaiproject.org/ + + 2011 + jar + + + shared + + + + + + src + + + src + + diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addassignments.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addassignments.html new file mode 100644 index 000000000000..9472b7a7ea87 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addassignments.html @@ -0,0 +1,52 @@ + + +Add Assignments to a Page + + + + + +
+

Add Assignments to a Page

+ + +

This option lets you add a link to an assignmentin the Sakai Assignments tool.

+ +

To add an assignment to your page, use the "Add Content" pull-down and choose Add Assignment. This will give you a list of all assignments already created in the Assignments tool. Select the one you wish to add and use selected item.

+ +

To create a new assignment, use the "Add Content" pull-down and choose Create new assignment using Assignments. +This will call the Assignments tool, and allow you to create a new assignment or modify an existing one. When you are +ready to add the new assignment, click the Continue with Add Assignment button at the top. That will return you to +the list of assignments, where you can choose the assignment you just created.

+ +

Edit an Assignment

+ +

Click Edit to the left of the assignment you would like to modify.

+ +

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ + + +

To save your changes, click Update Item. To remove the Assignment from your Lesson Builder page, click Delete.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addmultimedia.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addmultimedia.html new file mode 100644 index 000000000000..9d90075348eb --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addmultimedia.html @@ -0,0 +1,100 @@ + + +Adding Embedded Content to the Page + + + + + +
+

Adding Embedded Content to the Page

+ + + +

NOTE: "Add Content Link" and "Embed Content on Page" are similar. Both can add files or URLs. The +difference is that content links appear as links in your Lessons page, whereas +embedded content is displayed on the page. Normally Embed Content is used for audio and video where you want +a player to appear on your page. However it can be used for other types of file (e.g. Adobe PDF) as well. +Whether embedded content will actually work depends upon whether browsers can display it, or can +find a player to display it.

+ +

Embed Content on Page

+

This option allows you to show media files or links (such as videos and songs), and present them directly on the page. +Embed Content can also double as a Web Content tool, allowing you to link to and display websites in your Lessons page.

+ +

Use the "Add Content" pull-down and choose Embed Content on Page.

+ +

There are several different ways to use this tool: + +

+

+ +

In many cases, you will need to adjust the size of the box in which the content is shown. +Use the Edit button, as explained below. + +

Edit Multimedia
+ +

To edit your multimedia content, first click Edit to the left of the item you would like to modify.

+ +

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ +

For images, we recommend setting either width or height and leaving +the other blank. The browser will pick an appropriate size for the one +you left blank.

+ +

Some players will stretch or cut off the image if you don't set the right size. Older copies of Windows Media Player (e.g. on Windows XP) seem particularly prone to this. So for movies, it is safest to adjust the size to match the actual size and shape of the movie.

+ +

To save your changes, click Update Item. To remove the multimedia item from your Lessons page, click Delete.

+ +
Delete a Resource
+ +

Click Edit to the left of the resource you would like to remove, then click Delete.

+

The delete function in Lessons only removes the link on the Lessons page. +If you would like to completely delete an uploaded file from your worksite, the file will also need to be removed from the Resources tool. To do this, click Resources on the left menu and click on the folder that has the same title as the Lessons from which the file was removed. Click Actions --> Remove to the right of the file. Click Remove to complete the process.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addpage.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addpage.html new file mode 100644 index 000000000000..a507b39066af --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addpage.html @@ -0,0 +1,44 @@ + + +Add More Pages + + + + + +
+

Add More Pages at Top Level (Left Margin)

+ + + +

This function appears on top-level pages only (a page in the +left margin.) You may add pages to other pages using the "Add Subpage" +function.

+ +

"Add More Pages" allows you to create one or more new pages which will be added +to the left margin. You can also choose an existing page, even one +that has been deleted. + +

Use the "More Tools" pull-down and choose Add More Pages.

+ +

You may create several pages at once, as long as the names follow +a numerical pattern. E.g. if you specify a name of "Page 2" and ask for +3 pages, you will get "Page 2," "Page 3," and Page 4.

+ +

If you check "Make new pages copies of the current one (except that subpages are omitted)", then the new page is +a copy of the current one. Otherwise it's a new (blank) page. When pages are copied, subpages are omitted.

+ +

Use Put Existing Page in the Left Margin to use a existing page. This can be used to restore +top-level pages that were accidentally deleted, or to put existing subpages in the left margin. + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addquestions.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addquestions.html new file mode 100644 index 000000000000..d4f265d779d9 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addquestions.html @@ -0,0 +1,71 @@ + + +Add Simple Questions to a Page + + + + + +
+

Adding Simple Questions to a Page

+ + + +

This function lets you add multiple choice and short answer questions to a Lessons page. These questions can be graded, or used as polls.

+ +

Use the "Add Content" pull-down and choose Add Question.

+ +

To add a multiple choice question:

+ + +

To add a short answer question:

+ + +

For both question types:

+ + +
Grading
+ +

To specify a correct answer, check one of the answers (multiple choice), or supply at least one answer (short answer). If you do not +specific a correct answer, your question is either ungraded or manuallyy graded. + +

There are 3 different types of grading: + +

+ +

+If Grade this question is checked, you must specify the name of an iten in the Gradebook.

+ +
View a Graph of the Responses to a Multiple Choice question
+ +

Click the Show Poll button above the multiple choice question you would like to see the responses to. A simple bar graph will appear below the question, displaying the number of students that selected each answer choice. Click Hide Poll to hide the graph.

+ +

Back to top

+ +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addquizzes.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addquizzes.html new file mode 100644 index 000000000000..350fe95360d0 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addquizzes.html @@ -0,0 +1,55 @@ + + +Add Quizzes to a Page + + + + + +
+

Add Quizzes or Tests to a Page

+ + +

This option lets you add quizes from the Sakai Tests and Quizes tool. + +

Use the "Add Content" pull-down and choose Add Quiz. That will give you a list of assessments already created in the Tests & Quizzes tool. Click the one you wish to add and then click Add This Assessment.

+ +

To create a new quiz, use the link Create new quiz using Tests and Quizzes at the top of the page. +This will call the Tests and Quizzes, and allow you to create a new assignment or modify an existing one. When you are +ready to add the new quiz, click the Continue with Add Quiz button at the top. That will return you to +the list of quizzes, where you can choose the quiz you just created.

+ + +

Edit a Quiz

+ +

Click Edit to the left of the quiz you would like to modify.

+ +

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ + +

To save your changes, click Update Item. To remove the Quiz from your Lessons page, click Delete.

+ + + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addresources.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addresources.html new file mode 100644 index 000000000000..c414c09fd8d4 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addresources.html @@ -0,0 +1,76 @@ + + +Add Content Links to the Page + + + + + +
+

Adding Content Links to the Page

+ + + +

NOTE: "Add Content Link" and "Embed Content" are similar. Both can be either files or URLs. The +difference is that content links appear as links in your Lessons page, whereas +embed content is displayed in a box on the page, if the student's browser is able to do this.

+ +

Use the "Add Content" pull-down and choose Add Content Link.

+

You can add a file to your page by:

+ + +
Edit a Resource
+

Click the Edit button to the left of the resource you would like to modify.

+ +

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ + +

To save your changes, click Update Item.

+
Delete a Resource
+ +

Click Edit to the left of the resource you would like to remove, then click Delete.

+

The delete function in Lessons only removes the link on the Lessons page. +If you would like to completely delete an uploaded file from your worksite, the file will also need to be removed from the Resources tool. To do this, click Resources on the left menu and click on the folder that has the same title as the Lessons from which the file was removed. Click Actions --> Remove to the right of the file. Click Remove to complete the process.

+ +
Access Controls for Resource
+ +

When you select Don't Release Item Until All Prerequisites are Completed, Lessons will +control students' access to the resource. The resources are actually stored in the Resources tool. +That means that students can get to them directly, through that tool. If you don't want to allow +that, you can set the resource or the folder containing it to Hidden in the resources tool. Lessons +can access files even if they are hidden.

+ +

If the resource is an HTML page, there can be issues with images and other items +referred to on the page. You can make them public. But you can also put the images, etc, somewhere else in the same folder +as the main document, and set either the individual files or the folder to hidden, in the +Resources tool. When you access a file in Lessons, if the file is accessible, it will +also allow you to access other files in the same folder, even if they are hidden. + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addsubpages.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addsubpages.html new file mode 100644 index 000000000000..1a623e60b4cc --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addsubpages.html @@ -0,0 +1,78 @@ + + +Adding Additional Pagest + + + + + +
+

Adding Additional Pages

+ + + +

Add Subpages

+

Lessons pages can refer to other pages. Since pages are commonly organized as a hierarchy, Lessons refers pages +referenced in another page as "subpages" of it.

+ +

Use the "Add Content" pull-down and choose Add Subpage. +Fill in the text field labeled Page title with the title of your new subpage and click Create.

+ +

This will take you to a blank Lessons page, where you can add new content pieces as you see fit.

+ +

Alternatively, rather than filling in a title, click "Choose Existing Page." That will let you include an existing subpage +in a second location, or restore a deleted page. NOTE: if you include the same subpage in more than one place, there is just +one copy of the page. If you make changes on the page, the change will appear at all locations.

+ +
Less common ways to use pages
+ +

The term "subpage" can be somewhat misleading, since it's prefectly possible for the same page to be referred from from several +other pages. It's also possible to have a sequence of pages where each is really the next page in the sequence, rather than +a subpage. It's even possible for pages to refer to each other, producing a loop, though we don't recommend doing this.

+ +

Add subpage is still the way to set this up. Normally it creates a new page, and puts a link to it on the original +page. That is, it creates a new subpage. However there is also an option for choosing an existing page. +That lets you add a reference to an existing page. This is the way to make the same page appear on more +than one other page. + +

Next page The Add Page dialog has an option that's worth explaining: "Next page." Normally Lessons treats +pages that appear on another page as "subpages." The navigation at the top of the page will show that +you've gone down another level, and give you an easy way to return. But if you're constructing a +sequence of pages, you probably don't want Lessons to treat them as subpages. That is, you want the +navigation at the top to treat them as at the same level, not adding another level to the "bread crumbs", +but displaying the next and previous pages in the sequence using the Next and Previous links at the top. +To do this, when you create or add a reference to the next page in the sequence, choose the "Next page" +option.

+ +

Edit a Subpage
+ +

To edit information about a subpage, click Edit to the left of the subpage you would like to modify.

+ +

The options available for modification are as follows:

+ + +

To save your changes, click Update Item. To remove the subpage from your page, click Delete.

+ + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addtext.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addtext.html new file mode 100644 index 000000000000..3a18b09557f1 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addtext.html @@ -0,0 +1,59 @@ + + +Add text or HTML content to a page + + + + + +
+

Add text or HTML content ot a page

+ + + +

This function allows you to add a block of text to your page. You +can also use it to add other web content, such as tables or links. +However it is often more convenient to use "Add Resources" to add +links to the page.

+ +

Add Text

+ +

Use the "Add Content" pull-down and choose Add Text. Enter your text in the rich text editor provided and click Save at the bottom of the page.

+ +

You can use text to introduce other pieces of content on the page, this can help orient the student.

+ +

If you have groups or sections in the site, a set of checkboxes will be shown under the rich text editor. +This allows you to make this text visible only to some groups. Students who are not in one of the checked sections of groups will not see this item on their page at all. + +

Edit Text
+ +

If you want to edit a piece of text that you have already added to the page, click Edit to the left of the text item. When you are satisfied with your changes, click Save at the bottom of the page. You can also click Cancel to return to your page without applying any changes.

+ +
Remove Text
+ +

If you want to remove a piece of text, click Edit to the left of the text item. Click the Delete button below the text editor.

+

Warning: There is no confirmation step; clicking the delete button will permanently remove the text item from your Lesson Builder page. There is no way to retrieve it once it has been deleted.

+ +
Allowable content
+ +

To prevent users from adding content that might cause problems for other users, Sakai provides ways of +avoiding "dangerous" content. Javascript code is considered dangerous. Even embedding content from other +sites may be considered dangerous.

+ +

Normally the instructor can embed content from other sites. Whether or not they can use Javascript is +controlled by institutional policy.

+ +

Student-supplied content is more restrictive. Students are never permitted to add Javascript or other +dangerous content.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addtopics.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addtopics.html new file mode 100644 index 000000000000..7e9b5968ab6e --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addtopics.html @@ -0,0 +1,58 @@ + + +Add Forum Topics to a Page + + + + + +
+

Add Forum Topics to a Page

+ + +

This options lets you add a link to a topic in the Sakai Forums tool.

+ +

Use the "Add Content" pull-down and choose Add Forum Topic. This will give you a list of forum topics already created in your +forum tool. Click the one you wish to add and then click Use Selected Item.

+ +

To create a new topic, use the link Create new topic at the top of the page. If you have more +than one forum tool in your site, you may see a separate link for each tool. +This will call the forum tool, and allow you to create a new topic or modify an existing one. When you are +ready to add the new topic to your Lessons page, click the Continue with Add Forum Topic button at the top. That will return you to +the list of topics, where you can choose the topic you just created.

+ +

Note that only topics may be added. Depending upon the tool, topics are contained within categories or forums. +Categories and forums may not be added, just actual topics.

+ + +

Edit a Forum Topic

+ +

Click Edit to the left of the topic you would like to modify.

+ +

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ + +

To save your changes, click Update Item. To remove the Topic from your Lessons page, click Delete.

+ + + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/addwebsite.html b/lessonbuilder/help/src/sakai_lessonbuildertool/addwebsite.html new file mode 100644 index 000000000000..19db89fa202f --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/addwebsite.html @@ -0,0 +1,50 @@ + + +Import Content from ZIP file + + + + + +
+

Import Content From a ZIP file

+ + + +

This function allows you to load a file in ZIP format. Many authoring tools +intended for instructors can export in ZIP format. Sakai has special support +for ZIP files produced by Camtasia, Wimba Create, and Articulate, but any ZIP +file should work.

+ +

Use the "Add Content" pull-down and choose Upload Content in ZIP File.

+ +

Where possible, Lessons will add a link to the content you +have just uploaded. For this to work, we must be able to identify a +particular file from the upload that is the "starting point." +The code can recognize this for certain common formats, including +Camtasia, Wimba Create, and Articulate. For other files, we will use index.html +or index.htm if it exists.

+ +

The file contained in the ZIP file are loaded into a new folder in Resources.

+ +

The "Upload Content in a ZIP File" dialog allows you to specify a file. If you do it will +be uploaded and processed. However you can also choose a ZIP file is already +present in the Resources tool. If you do that, Lessons will read the ZIP archive, +extract all files in it, and add them as if you had uploaded the ZIP file.

+ +

This function depends upon features in the Sakai kernel. It may not appear for +older versions of Sakai.

+ + + + +

+ +

+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/ccexport.html b/lessonbuilder/help/src/sakai_lessonbuildertool/ccexport.html new file mode 100644 index 000000000000..a4c2a5ddf6aa --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/ccexport.html @@ -0,0 +1,63 @@ + + +Export Common Cartridge + + + + + +
+

Export Common Cartridge

+ + + +

This function allows you to save (download) a file in IMS Common Cartridge +Format containing the contents of the current site. +Other course management +systems such as Blackboard can load the contents of a course +in Common Cartridge format. So this can be used to move content +between course management systems. It can also be used if you simply want +to save the contents of your site in a form that can be used later.

+ +

Use the "More Tools" pull-down and choose Export CC.

+ +

Note that the Common Cartidge format only handles some aspects of +a site. Details will be lost. E.g. only the most common types of quiz +question will be saved. And items that Lessons would put inline on the page +(e.g. blocks of text added with "Add Text" and movies added with "Add Multimedia") +will appear as links when the Common Cartridge file is loaded. This is a limitation +of the Common Cartridge standard, and not a Sakai problem.

+ +

The export will contain a file in the resources area called +cc-objects/export-errors. It will contain a list of any problems in +exporting, including questions and Lessons content that can't be +handled by the Common Cartridge format.

+ +

Here are the types of content that will be included:

+ + +

Note that most other systems do not recognize assignments. They +simply import the text of the assignmentn as a document.

+ +

Currently Sakai can save in Common Cartridge versions 1.1 and 1.2. +1.2 is the default. We've seen problems trying to load 1.2 files into +Moodle and Blackboard, so we recommend using version 1.1 for them. +The only significant difference is that 1.2 is supposed to understand +Assignments, and also quiz questions of type "Multiple Correct, Single Answer." +However no implementation we've found other than Sakai actually treats +these types correctly.

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/ccimport.html b/lessonbuilder/help/src/sakai_lessonbuildertool/ccimport.html new file mode 100644 index 000000000000..fb6e57c13e1a --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/ccimport.html @@ -0,0 +1,59 @@ + + +Import Common Cartridge + + + + + +
+

Import Common Cartridge

+ + + +

This function allows you to read a file in IMS Common Cartridge +Format. This format is used by content vendors to supply instructional +material, including tests and pages of content. Other course management +systems such as Blackboard can also export the contents of a course +in Common Cartridge format. So this can be used to move content +between course management systems. + +

Use the "More Tools" pull-down and choose Import CC.

+ +

Currently Sakai can read Common Cartridge versions 1.0, 1.1, and 1.2. + +

When you import a Common Cartridge, it can (depending upon the cartridge) +create new pages with content on them, and add tests, forum topics, and assignments. +It can also create question pools. If it create a question pool, you will only see the pool +if you go into Tests and Quizes and use "Questions Pools." + +

Roles
+ +

Cartridges can specify that certain resources should be available +only to instructors, or only instructors and "mentors." Lessons +does not implement mentors, as there is no natural Sakai equivalent. +Instructor-only content is intended for things such as answer sheets. + +

For the current release of Lessons, instructor-only content +is loaded into the site, but not placed on a page. Where the tool +permits it, it is hidden. Currently this is implemented as follows: +

+ +

No method is currently implemented to hide topics in YAFT or Jforums. + +

+ +

+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/comments.html b/lessonbuilder/help/src/sakai_lessonbuildertool/comments.html new file mode 100644 index 000000000000..3edabcdb0a8a --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/comments.html @@ -0,0 +1,86 @@ + + +Add text or HTML content to a page + + + + + +
+

Student Comments

+ + + +

This is a tool that permits students to make comments. Once +a student has added a comment, they may change or delete it for 30 minutes. After that, +only an instructor may change or delete it.

+ +

Comments may be graded, if you choose that option.

+ +

Use the "Add Content" pull-down and choose Add Comments Tool.

+ +
Edit
+ +

The Edit button will allow you to change certain details about the +comment tool. This includes the following:

+ + +

To save your changes, click Update Item.

+

The Delete option may be used to delete the comments block from the page. Note that +the comments themselves remain in the database, although only an administrator will be able to retrieve them.

+ +
Grading
+ + + +

The points you enter apply to all comments by that +student in that comment section. So if they have made multiple comments, +any new score you enter will show next to every comment by that student. +

+ + + +

In the Grading Pane you'll see a button +Toggle Comments to the right of each student. That will show +or hide a listing of all the comments entered by that student. +Show Context will show you the whole page, with that student's +comments highlighted.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/external.html b/lessonbuilder/help/src/sakai_lessonbuildertool/external.html new file mode 100644 index 000000000000..65e9882cf3b1 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/external.html @@ -0,0 +1,34 @@ + + +External Tool + + + + + +
+

External Tool

+ + + +

This function can be used to add external tools that use the IMS Basic Learning Tool +Interoperability standard. This standard permits applications to be written that will +support any course management system. Typically these are commercial web application +run by publishers.

+ +

Your campus support staff can help you identify tools that will work with this +option.

+ +

Use the "Add Content" pull-down and choose Add External Tool.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/help.xml b/lessonbuilder/help/src/sakai_lessonbuildertool/help.xml new file mode 100644 index 000000000000..2074e0b6cd63 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/help.xml @@ -0,0 +1,153 @@ + + + + + + lessonbuildertoolOverview + Lessons Overview + /sakai_lessonbuildertool/overview.html + sakai.lessonbuildertool + + + + lessonbuildertoolAddText + Add Text to a Page + /sakai_lessonbuildertool/addtext.html + + + + lessonbuildertoolAddMultimedia + Embed Content on Page + /sakai_lessonbuildertool/addmultimedia.html + + + + lessonbuildertoolAddResources + Add Content Link + /sakai_lessonbuildertool/addresources.html + + + + lessonbuildertoolAddSubpages + Add Additional Pages to a Page + /sakai_lessonbuildertool/addsubpages.html + + + + lessonbuildertoolAddWebsite + Upload content from a ZIP file + /sakai_lessonbuildertool/addwebsite.html + + + + lessonbuildertoolAddAssignments + Add Assignments to a Page + /sakai_lessonbuildertool/addassignments.html + + + + lessonbuildertoolAddQuizzes + Add Quizzes to a Page + /sakai_lessonbuildertool/addquizzes.html + + + + lessonbuildertoolAddTopics + Add Forum Topics to a Page + /sakai_lessonbuildertool/addtopics.html + + + + lessonbuildertoolAddQuestions + Add Simple Questions to a Page + /sakai_lessonbuildertool/addquestions.html + + + + lessonbuildertoolComments + Allow Student Comments + /sakai_lessonbuildertool/comments.html + + + + lessonbuildertoolStudentContent + Allow Student to add their own Pages + /sakai_lessonbuildertool/studentcontent.html + + + + lessonbuildertoolExternal + Add External Tool using IMS Basic Learning Tool Interoperability Protocol + /sakai_lessonbuildertool/external.html + + + + lessonbuildertoolReorganize + Reorganize content + /sakai_lessonbuildertool/reorganize.html + + + + lessonbuildertoolSettings + Change Page Settings + /sakai_lessonbuildertool/settings.html + + + + lessonbuildertoolAddTop + Add a Top-level Page + /sakai_lessonbuildertool/addpage.html + + + + lessonbuildertoolRemove + Remove a Top-level Page + /sakai_lessonbuildertool/remove.html + + + + lessonbuildertoolCCImport + Import a file in Common Cartridge Format + /sakai_lessonbuildertool/ccimport.html + + + + lessonbuildertoolCCExport + Export a file in Common Cartridge Format + /sakai_lessonbuildertool/ccexport.html + + + + root + + + + Lessons + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/lessonbuilder.html b/lessonbuilder/help/src/sakai_lessonbuildertool/lessonbuilder.html new file mode 100755 index 000000000000..0fe965c2e161 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/lessonbuilder.html @@ -0,0 +1,135 @@ + + + + + Sakai Help + + + +
+

Sakai Help

+

Lesson Builder

+

1. Introduction

+

Lesson Builder is a tool that allows an instructor to organize resources, quizzes, tests, and media on a single page. You can have as many Lesson Builder pages in your site as you see fit. Each Lesson Builder page can be customized to suit the needs of the lesson by taking some of the tools available in Sakai and putting them onto a single page. You can add assignments, tests, resources, text, links, images, discussion forums and other pieces of media to a Lesson Builder page.

+
+ +

Use the action buttons at the top of the page to add content.

+

+
+

2. Add Text

+ +

Click Add Text at the top of the page to add text to the page. Enter your text in the rich text editor provided and click Save at the bottom of the page.

+

You can use text to introduce other pieces of content on the page, this can help orient the student.

+

+
2.1 Edit Text
+

If you want to edit a piece of text that you have already added to the page, click Edit to the left of the text item. When you are satisfied with your changes, click Save at the bottom of the page. You can also click Cancel to return to your page without applying any changes.

+
2.2 Remove Text
+

If you want to remove a piece of text, click Edit to the left of the text item. Click the Delete button below the text editor.

+

Warning: There is no confirmation step; clicking the delete button will permanently remove the text item from your Lesson Builder page. There is no way to retrieve it once it has been deleted.

+ +

3. Add Resources

+

Click Add Resource at the top of the page.

+

You can add a file to your page by:

+ +
3.1 Edit a Resource
+

Click the Edit button to the left of the resource you would like to modify.

+

+

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ +

+

To save your changes, click Update Item.

+
3.2 Delete a Resource
+

Click Edit to the left of the resource you would like to remove, then click Delete.

+

If you would like to completely delete an uploaded file from your worksite, the file will also need to be removed from the Resources tool. To do this, click Resources on the left menu and click on the folder that has the same title as the Lesson Builder from which the file was removed. Click Actions --> Remove to the right of the file. Click Remove to complete the process.

+

4. Add Assignments

+

Click the Add Assignment button at the top of the page. This will give you a list of all assignments already created in the Assignments tool. Select the one you wish to add and use selected item.

+

Note that you cannot create assignments in the Lesson Builder tool; you must go to the Assignments tool and create them there.

+

+
4.1 Edit an Assignment
+

Click Edit to the left of the assignment you would like to modify.

+

+

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ +

+

To save your changes, click Edit Item. To remove the Assignment from your Lesson Builder page, click Delete.

+

5. Add Tests & Quizzes

+

Click the Add Quiz button at the top of the page. This will give you a list of assessments already created in the Tests & Quizzes tool. Click the one you wish to add and then click Add This Assessment.

+

Note that you cannot create quizzes in the Lesson Builder tool; you must go to the Tests & Quizzes tool on the left menu and create them there.

+
5.1 Edit a Quiz
+

Click Edit to the left of the quiz you would like to modify.

+

+

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ +

+

To save your changes, click Update Item. To remove the Quiz from your Lesson Builder page, click Delete.

+

6. Add Multimedia

+

The multimedia option allows you to upload media files (such as videos and songs), and present them directly on the page. The Multimedia option can also double as a Web Content tool, allowing you to link to and display websites on your Lesson Builder page.

+

Click the Add Multimedia button at the top of the page.

+

You can add a multimedia file to your page by:

+ +
6.1 Edit Multimedia
+

To edit your multimedia content, first click Edit to the left of the item you would like to modify.

+

+

This will open up an Edit Item box on your screen. The options available for modification are as follows:

+ +

+

To save your changes, click Update Item. To remove the multimedia item from your Lesson Builder page, click Delete.

+

7. Add Subpages

+

Each Lesson Builder tool that you add to your worksite can have multiple pages associated with it. These pages are referred to as subpages.

+

Click the Add Subpage button at the top of the page. Fill in the text field labeled Page title with the title of your new subpage and click Create.

+

+

This will take you to a blank Lesson Builder page, where you can add new content pieces as you see fit.

+
7.1 Edit a Subpage
+

To edit information about a subpage, click Edit to the left of the subpage you would like to modify.

+

+

The options available for modification are as follows:

+ +

+

To save your changes, click Update Item. To remove the subpage from your page, click Delete.

+

8. Reorganize Content

+

By default, new content items are added to the bottom of a Lesson Builder page. You can use the Reorder tool to arrange the content in any order. You can also copy items from other pages into the current one, and delete items.

+

To start, click the Reorder button at the top of the page. Drag and drop content items into your preferred order. Click Save to complete the process.

+
+ + diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/overview.html b/lessonbuilder/help/src/sakai_lessonbuildertool/overview.html new file mode 100644 index 000000000000..1a5691cc5041 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/overview.html @@ -0,0 +1,62 @@ + + + + +Lesson Overview + + + + + +
+

Lessons: Overview

+

Introduction

+

Lessons is a way to structure content. Use cases include:

+ + +

Use the action buttons at the top of the page to add content.

+ +

How Do I?

+ +

Tools that allow you to add content to a page:

+ + + +

The following functions appear in a separate menu "More tools." It appears only on top-level pages.

+ + +

Other functions:

+ + + + + + diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/remove.html b/lessonbuilder/help/src/sakai_lessonbuildertool/remove.html new file mode 100644 index 000000000000..c30ed2a614e9 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/remove.html @@ -0,0 +1,39 @@ + + +Remove Top-Level Page + + + + + +
+

Remove Top-Level Page

+ + + +

This function allows you to remove a top-level page. Note that the +page is not actually removed from the databsae. It may be attached +as a subpage to another page, effectively moving it to a +different location.

+ +

Use the "More Tools" pull-down and choose Remove Page.

+ +

This function appears only in a top-level page, i.e. a page that appears in the left margin. +To remove other pages, find the page on which they are located and use the "Remove" option of the "Edit" dialog. + +

To attach a page you have removed to another page, use "Add subpage" with the "Choose Existing Page" +option. To put a page you have removed back in the left margin, use the "Choose Existing Page" option +on "Add More Pages." + + +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/reorganize.html b/lessonbuilder/help/src/sakai_lessonbuildertool/reorganize.html new file mode 100644 index 000000000000..3e9dde3f74f6 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/reorganize.html @@ -0,0 +1,35 @@ + + +Reorganize Content + + + + + +
+

Reorganize Content

+ + + +

By default, new content items are added to the bottom of a Lessons page. You can use the Reorder tool to arrange the content in any order.

+ +

To start, click the Reorder button at the top of the page. Drag and drop content items into your preferred order. Click Save to complete the process.

+ +

Note that it is also possible to use the keyboard to move items. Select the number to the left of the item, and use the control +key, plus up-arrow or down-arrow. With certain browsers it may be necessary to key the arrows twice.

+ +

You can also use the Reorder tool to copy items from one page to another. Click the link "Add items from another page." After you select a page, all of the items will be copied into the current one. If you don't want some of the items, you can remove them.

+ +

The tool can also be used to remove items from the page. Simply click on the red X, or drag them to the removed page area. Removed items will continue to show in the removed page area, so you can put them back.

+ +

Back to top

+ + +
+ diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/settings.html b/lessonbuilder/help/src/sakai_lessonbuildertool/settings.html new file mode 100644 index 000000000000..0d736c631354 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/settings.html @@ -0,0 +1,94 @@ + + +Settings + + + + + +
+

Settings

+ + + +

The settings dialog allows you to adjust various parameters +of the current page:

+ +

To use it, click on the gear icon at the upper right of the window. + +

+ +

The following options only appear on top-level pages, i.e. pages that show in the left margin: +

  • Hide this page from users. - Use this when you're not ready for students to see +the page yet. It will not appear in the left margin.
  • + +
  • Hide this page until the following date - Use this when you want a page to become +available at a certain date or time. Note that the page will show in the left margin before then, but +won't be usable. (There is no way to specify release dates for items in the left margin.)
  • + + + +

    More information about style sheets

    + +

    If you are writing a style sheet, you may find it useful to know some classes that +you may use, and the sections of the page that they control: + +

    + +

    Back to top

    + + +
    + diff --git a/lessonbuilder/help/src/sakai_lessonbuildertool/studentcontent.html b/lessonbuilder/help/src/sakai_lessonbuildertool/studentcontent.html new file mode 100644 index 000000000000..8eabd595c6f2 --- /dev/null +++ b/lessonbuilder/help/src/sakai_lessonbuildertool/studentcontent.html @@ -0,0 +1,151 @@ + + +Add text or HTML content to a page + + + + + +
    +

    Student Content

    + + + +

    This tool permits students to add pages of their +own. Those pages look much like regular Lessons pages, although there are +fewer options. This allows students to share material with the rest of the class. +There is an option to permit other students to comment on their work. Student pages can also +be graded, or assessed according to a rubric.

    + +

    Small icons appear to the left of the point for each student's page. +The icons show which entries are new, and which contain new content or new +comments.

    + +

    Use the "Add Content" pull-down and choose Add Student Content.

    + +
    Edit
    + +

    The Edit button will allow you to change certain details about the +comment tool. This includes the following: + +

    +

    To save your changes, click Update Item.

    +

    The Delete option may be used to delete the student block from the page. Note that +the student pages themselves remain in the database, although only an administrator will be able to retrieve them.

    +

    Note that when a student uploads a file through a student page, it is normally put into the +resources area of their workspace. Lessons will give authorized readers of the page access to any +file that is listed in the student's page, +even if it wouldn't normally be visible to others. + +

    Grading
    + + + +

    Note that students may create subpages, so there may be more than +one page for a given student. The point score applies to all pages by +that student. + +

    To simplify the job of grading all students, you'll find < and +> buttons on the left and right sides of the grading section. That +lets you move to the previous or next student. + +

    + +

    The points you enter apply to all comments by that +student in that student content section. So if they have made multiple comments, +any new score you enter will show next to every comment by that student. +

    + + + +

    In the Grading Pane you'll see a button +Toggle Comments to the right of each student. That will show +or hide a listing of all the comments entered by that student. +Show Context will show you the student content page on which that +particular comment appeared, with that student's +comments highlighted.

    + +
    Peer Review
    + +

    Select Add a peer review rubric to each page if you want to allow students to review +other students' work. This will add a rubric to the bottom of every student page. You can select the +criteria appearing on the rubric. Use "create rubric" for this. Otherwise you can choose the sample +rubric.

    + +

    With the rubric available, students can evaluate all other student pages. You can also choose + Allow self grade to let them evaluate their own page. Students can see a summary +of how others have rated their page

    + +

    The instructor will see a button "Show Peer Evaluation Statistics". This will show a rubric for +each student page, with a summary of the ratings give to it. If you click on a student name, it +will show you the ratings that that student gave others.

    + +

    Back to top

    + + +
    + diff --git a/lessonbuilder/pom.xml b/lessonbuilder/pom.xml index 073d6b059808..188c5c69ecf9 100644 --- a/lessonbuilder/pom.xml +++ b/lessonbuilder/pom.xml @@ -107,6 +107,10 @@ 2.9 + + help + + oldhbm src29 @@ -153,6 +157,10 @@ 2.8 + + help + + oldhbm