Skip to content

Commit

Permalink
LSNBLDR-384; put help back for version 2.8 and 2.9
Browse files Browse the repository at this point in the history 
git-svn-id: https://source.sakaiproject.org/svn/lessonbuilder/trunk@309737 66ffb92e-73f9-0310-93c1-f5514f145a0a
  • Loading branch information
@clhedrick
clhedrick committed May 22, 2014
1 parent 1ceed89 commit 143b8f1
Show file tree
Hide file tree
Showing 23 changed files with 1,595 additions and 0 deletions.
33 changes: 33 additions & 0 deletions lessonbuilder/help/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.sakaiproject.lessonbuilder</groupId>
<artifactId>lessonbuilder</artifactId>
<version>10-SNAPSHOT</version>
</parent>

<name>sakai-lessonbuildertool-help</name>
<groupId>org.sakaiproject.lessonbuilder</groupId>
<artifactId>lessonbuilder-help</artifactId>
<organization>
<name>Sakai Project</name>
<url>http://sakaiproject.org/</url>
</organization>
<inceptionYear>2011</inceptionYear>
<packaging>jar</packaging>

<properties>
<deploy.target>shared</deploy.target>
</properties>

<build>
<resources>
<resource>
<directory>src</directory>
</resource>
</resources>
<sourceDirectory>src</sourceDirectory>
</build>
</project>
52 changes: 52 additions & 0 deletions lessonbuilder/help/src/sakai_lessonbuildertool/addassignments.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head>
<title>Add Assignments to a Page</title>
<style type="text/css">
/* Style for specific inline images */

/* Style for specific ordered lists */

/* Style for specific table cells */
</style>
<link type="text/css" href="/library/skin/tool_base.css" media="all" rel="stylesheet" />
<link type="text/css" href="/library/skin/default/tool.css" media="all" rel="stylesheet" />
</head>
<body>
<div class="helpBody">
<h2>Add Assignments to a Page</h2>
<a name="top"> </a>

<p> This option lets you add a link to an assignmentin the Sakai Assignments tool.</p>

<p>To add an assignment to your page, use the "Add Content" pull-down and choose <strong>Add Assignment</strong>. 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. </p>

<p>To create a new assignment, use the "Add Content" pull-down and choose <strong>Create new assignment using Assignments</strong>.
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 <strong>Continue with Add Assignment</strong> button at the top. That will return you to
the list of assignments, where you can choose the assignment you just created.</p>

<h3><a name="4.1">Edit an Assignment</a></h5>

<p>Click <strong>Edit</strong> to the left of the assignment you would like to modify.</p>

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

<ul>
<li><strong>Item Name</strong> - Change the name of the text on the link to your assignment on the main Lessons page.</li>
<li><strong>Item Description</strong> - Change/add a description to your assignment, which will appear beneath the link to the assignment.</li>
<li><strong>Change Assignment</strong> - Change the Assignment to a different one.</li>
<li><strong>Edit Assignment</strong> - Open the Assignments tool pointed at this assignment, so you can modify it.</li>
<li><strong>Don't Release Item Until All Prerequisites are Completed</strong> - Select this option if you would like it to be accessible only after previously required items have been completed.</li>
<li><strong>Require that the student submit this assignment </strong>- Select this option to make this item a required item; students must complete required items before progressing in a Lessons plan.</li>
<li><strong>Require that the student receive ____ points on this assignment </strong>- Select this option to make it necessary to score a certain number of points on the assessment to continue. This option can only be selected if the item is Required.</li>
<li><strong>Edit the groups for which this item should be shown </strong> - If you have groups or sections in the site, allows you to make this
assignment 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.
</ul>

<p>To save your changes, click <strong>Update Item</strong>. To remove the Assignment from your Lesson Builder page, click <strong>Delete</strong>.</p>

<p><a href="#top">Back to top</a></p>


</div>
</body></html>
100 changes: 100 additions & 0 deletions lessonbuilder/help/src/sakai_lessonbuildertool/addmultimedia.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head>
<title>Adding Embedded Content to the Page</title>
<style type="text/css">
/* Style for specific inline images */

/* Style for specific ordered lists */

/* Style for specific table cells */
</style>
<link type="text/css" href="/library/skin/tool_base.css" media="all" rel="stylesheet" />
<link type="text/css" href="/library/skin/default/tool.css" media="all" rel="stylesheet" />
</head>
<body>
<div class="helpBody">
<h2>Adding Embedded Content to the Page</h2>

<a name="top"> </a>

<p>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.</p>

<h4><a name="6">Embed Content on Page</a></h4>
<p>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.</p>

<p>Use the "Add Content" pull-down and choose <strong>Embed Content on Page</strong>.</p>

<p> There are several different ways to use this tool:

<ul>
<li> <strong>Upload a file.</strong> In this case Lessons will choose a player to show
the file. The player depends upon the type of file and the browser.
In order to get the best results on a variety of devices,
we recommend using MP4 format. For best use on portable devices, the
file should be prepared with software that specifically optimizes for
those devices. For audio, we recommend MP3, although WAV is also widely
supported.</li>

<li> <strong>Select an existing resource</strong>. Use this if you have
already uploaded the file, and it is available in the site's Resources tool.</li>

<li> <strong>Enter a URL for a file stored on the web.</strong> This should produce
the same result as uploading the file through Lessons.</li>

<li> <strong>Enter a URL for a video sharing site, e.g. Youtube.</strong> Lessons can
recognize URLs for most common video sites, and add appropriate players.
Most video sharing sites have options in the player to give you the
URL for the video. Simply using the URL that shows in the bar at
the top of your browser may not work.</li>

<li> <strong>Enter an "embed code" or "widget code" for a video sharing site.</strong>
Most video sharing sites have options in the player to give you an
appropriate embed code. Many sites will give you both a URL and an
embed code. You might try both to see which works better. Other things
being equal, we recommend using the URL.</li>

</ul>
</p>

<p> 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.

<h5><a name="6.1"> Edit Multimedia</a></h5>

<p>To edit your multimedia content, first click <strong>Edit</strong> to the left of the item you would like to modify.</p>

<p>This will open up an <em>Edit Item</em> box on your screen. The options available for modification are as follows:</p>
<ul>
<li><strong>Height</strong> - Change the height of the internal frame that will display your web link or contain your media. Note, you may use either percentages (%) or pixels (px) to denote either relative or absolute measurements.</li>
<li><strong>Width</strong> - Change the width of the internal frame that will display your web link or contain your media. Note, you may use either percentages (%) or pixels (px) to denote either relative or absolute measurements.</li>
<li><strong>Item Description</strong> - Change/add a description to your multimedia file, which will appear beneath the multimedia file.</li>
<li><strong>Change File or URL</strong> - Change the source of the media or change the URL of your web link.</li>
<li><strong>Edit the groups for which this item should be shown </strong> - If you have groups or sections in the site, allows you to make this
item 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.</li>

</ul>
<p> 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.</p>

<p>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.</p>

<p>To save your changes, click <strong>Update Item</strong>. To remove the multimedia item from your Lessons page, click <strong>Delete</strong>.</p>

<h5><a name="3.2">Delete a Resource</a></h5>

<p>Click <strong>Edit</strong> to the left of the resource you would like to remove, then click <strong>Delete</strong>.</p>
<p>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 <strong>Resources</strong> on the left menu and click on the folder that has the same title as the Lessons from which the file was removed. Click <strong>Actions --> Remove</strong> to the right of the file. Click <strong>Remove</strong> to complete the process.</p>

<p><a href="#top">Back to top</a></p>


</div>
</body></html>
44 changes: 44 additions & 0 deletions lessonbuilder/help/src/sakai_lessonbuildertool/addpage.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head>
<title>Add More Pages</title>
<style type="text/css">
/* Style for specific inline images */

/* Style for specific ordered lists */

/* Style for specific table cells */
</style>
<link type="text/css" href="/library/skin/tool_base.css" media="all" rel="stylesheet" />
<link type="text/css" href="/library/skin/default/tool.css" media="all" rel="stylesheet" />
</head>
<body>
<div class="helpBody">
<h2>Add More Pages at Top Level (Left Margin) </h2>

<a name="top"> </a>

<p> 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.</p>

<p> "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.

<p>Use the "More Tools" pull-down and choose <strong>Add More Pages</strong>.</p>

<p> 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.</p>

<p> 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.</p>

<p> Use <strong>Put Existing Page in the Left Margin</strong> 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.

<p><a href="#top">Back to top</a></p>


</div>
</body></html>
71 changes: 71 additions & 0 deletions lessonbuilder/help/src/sakai_lessonbuildertool/addquestions.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head>
<title>Add Simple Questions to a Page</title>
<style type="text/css">
/* Style for specific inline images */

/* Style for specific ordered lists */

/* Style for specific table cells */
</style>
<link type="text/css" href="/library/skin/tool_base.css" media="all" rel="stylesheet" />
<link type="text/css" href="/library/skin/default/tool.css" media="all" rel="stylesheet" />
</head>
<body>
<div class="helpBody">
<h2>Adding Simple Questions to a Page</h2>

<a name="top"> </a>

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

<p>Use the "Add Content" pull-down and choose <strong>Add Question</strong>.</p>

<p>To add a <strong>multiple choice</strong> question:</p>
<ul>
<li>Select <strong>Multiple Choice</strong> as the question type.</li>
<li>Input the text of your question under <strong>Question Text</strong>.</li>
<li>Insert the possible answer choices under the <strong>Possible Answers</strong> heading. Press <strong>Add New Answer</strong> to add an additional answer choice, and check the checkbox next to the answer text to mark it as a correct answer. (For polls, do not mark any answer as correct.)</li>
<li>Optionally allow students to see a bar graph of how other students have answered after they themselves have answered by selecting the checkbox <strong>Show students a graph of how others responded after they answer the question</strong>.</li>
</ul>

<p>To add a <strong>short answer</strong> question:</p>
<ul>
<li>Select <strong>Short Answer</strong> as the question type.</li>
<li>Input the text of your question under <strong>Question Text</strong>.</li>
<li>Insert the possible answer choices under the <strong>Possible Answers</strong> heading. Press <strong>Add New Answer</strong> to add an additional answer choice. Note that answer choices are <em>not</em> case sensitive.</li>
</ul>

<p>For both question types:</p>
<ul>
<li>To insert an entry in the Gradebook for this question, select <strong>Grade this question</strong>. If you select this, you
must supply a title for the assignment in the Gradebook, and the maximum number of points.</li>
<li>Any text in the textbox <strong>Text shown if answer is correct</strong> is only shown to students that answer a question correctly. Similarly, text in <strong>Text shown if answer is incorrect</strong> is only shown to students that answer the question incorrectly.</li>
<li><strong>Don't Release Item Until All Prerequisites are Completed</strong> - Select this option if you would like it to be accessible only after previously required items have been completed.</li>
<li><strong>Require that the student submit this assignment </strong>- Select this option to make this item a required item; students must complete required items before progressing in a Lessons plan. Any answer will count. They do not need to submit a correct answer.</li>
</ul>

<h5>Grading</h5>

<p> 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.

<p> There are 3 different types of grading:

<ul>
<li> Ungraded, i.e. polls. No correct answer is supplied, and <strong>Grade this question</strong> is not checked.
<li> Automatic grading. A correct answer is supplied. If you specify <strong>Grade this question</strong> and a number of points, you can override Lessons' automatic grading by entering the number of points yourself in the Grading Pane. An answer is considered correct if you give it the maximum number of points.
<li> Manual grading. No correct answer is supplied, but <strong>Grade this question</strong> is checked. In this case, you must use the Grading Panel to grade the question. An answer is considered correct if you give it the maximum number of points.
</ul>

<p>
If <strong>Grade this question</strong> is checked, you must specify the name of an iten in the Gradebook.</p>

<h5>View a Graph of the Responses to a Multiple Choice question</h5>

<p>Click the <strong>Show Poll</strong> 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 <strong>Hide Poll</strong> to hide the graph.</p>

<p><a href="#top">Back to top</a></p>

</div>
</body></html>
Loading

0 comments on commit 143b8f1

Please sign in to comment.