--- doc/tutorial/Attic/tutorial.lyx 2002/06/03 05:15:59 1.3 +++ doc/tutorial/Attic/tutorial.lyx 2002/06/04 21:07:28 1.5 @@ -27,7 +27,7 @@ \quotes_times 2 \papercolumns 1 \papersides 1 -\paperpagestyle fancy +\paperpagestyle headings \layout Title @@ -91,7 +91,7 @@ Michigan State University Introduction to LON-CAPA \layout Comment -This is a comment which will not show in any other rendering of this document. +This is a comment that will not show in any other rendering of this document. I will use them to document my observations as I work through this tutorial. \layout Comment @@ -110,15 +110,9 @@ IMHO \layout Standard LON-CAPA is a web-based interface that helps to organize and present your - course website, deliver and manage problem problems, and manage student - enrollment. - All author functions are done using a web browser (Netscape 4.x or higher - is recommended) and the LON-CAPA Author Interface. - The URL for LON-CAPA is -\family typewriter -http://s10.lite.msu.edu -\family default -. + course website, deliver and manage problems, and manage student enrollment. + All author functions are done using a web browser (Netscape 4.x or higher, + a recent Mozilla, or IE 5+ required) and the LON-CAPA Author Interface. \layout Standard At this time, you should have: @@ -140,9 +134,16 @@ Throughout this manual, keywords and phr bold type \series default . + Function names and scripts will be shown in a +\family typewriter +typewriter font +\family default +. \layout Standard -Chapters +Much of this document can be used as a tutorial that will introduce you + to the authoring system. + In particular, chapters \begin_inset LatexCommand \ref{Author Interface} \end_inset @@ -152,14 +153,17 @@ Chapters \end_inset - comprise a tutorial that will introduce you to the authoring system. - After that, this document is a reference manual for authoring course materials. + comprise a basic tutorial that can get you started using LON-CAPA, even + with no previous LON-CAPA experience. \layout Standard -For more information, see the website at http://help.loncapa.org/, where you - can get help and information. +For more information, see the website at +\family typewriter +http://help.loncapa.org/ +\family default +, where you can get help. If you cannot find an answer for your question, please email us and let - us know, so we put the solution to your problem online. + us know, so we can put the solution to your problem online for everyone. \layout Section The LON-CAPA Author Interface @@ -179,11 +183,7 @@ Login as Course Author \layout Standard To begin using LON-CAPA, you first need to log in to your account on LON-CAPA. - Open your web browser and navigate to the LON-CAPA URL: -\family typewriter -http://s10.lite.msu.edu/ -\family default - . + Open your web browser and navigate to your local LON-CAPA URL. You will be presented with a log in screen as in figure \begin_inset LatexCommand \ref{LON-CAPA Log in screen} @@ -256,7 +256,7 @@ remote control complexity of modern remotes, for three major reasons: One, they never, ever, ever change. Two, they provide immense amounts of tactile feedback, allowing one to - overcome the complexity of using one by putting the knowlege into motor + overcome the complexity of using one by putting the knowledge into motor memory. (There are equivalent usability principles in usability, as well; look up Fitt's Law, for instance.) Three, they all basically do the same thing; @@ -287,9 +287,9 @@ menu remote control space. \layout Comment -In fact, the metaphor is so unsuccessful that any moderately savvy internet +In fact, the metaphor is so unsuccessful that any moderately savvy Internet user will almost immediately come to conceptualize the remote as just another - list of links, albiet a clumsy and inconvenient one. + list of links, albeit a clumsy and inconvenient one. Why not give them that in the first place? \layout Comment @@ -319,7 +319,7 @@ remote \layout Comment 3. - By commiting to this + By committing to this \begin_inset Quotes eld \end_inset @@ -328,7 +328,7 @@ remote control \end_inset layout, you commit to a remote control's layout limitations, except that - an actual remote control can get away with a 6pt or smaller font, or wierd + an actual remote control can get away with a 6pt or smaller font, or weird specialized symbols, or whatnot. I'm looking at a (real) remote control right now that manages to get \begin_inset Quotes eld @@ -347,7 +347,7 @@ ROLES \begin_inset Quotes erd \end_inset - button takes up on my printout! So in actuality, you're commiting to something + button takes up on my printout! So in actuality, you're committing to something no sane remote control designer could deal with. \layout Comment @@ -371,7 +371,7 @@ ROLES The upshot is that the only upside to the remote control is a moderately pleasing graphic; the downsides are pretty much everything, up to and including - possible illegality under accessability laws. + possible illegality under accessibility laws. Unfortunately, I do not see any way to salvage any aspect of the remote control; it's going to suck until it's replaced. Pleasing graphics are relatively easy to come by nowadays; it should not @@ -520,10 +520,15 @@ Content Page displays course content. It is essentially a conventional HTML page. - -\layout Comment + These resources use the extension +\begin_inset Quotes eld +\end_inset -Check this; is it exactly like HTML pages? +.html +\begin_inset Quotes erd +\end_inset + +. \layout Itemize A @@ -567,8 +572,8 @@ Sequence \series default type represents a programmed series of events. - The users of this resource can use buttons on their remote or the NAV button - to follow the sequence. + The users of this resource can use directional buttons on their remote + or the NAV button to follow the sequence. These resources are stored in files that must use the extension \begin_inset Quotes eld \end_inset @@ -578,18 +583,6 @@ Sequence \end_inset . -\layout Comment - -What -\begin_inset Quotes eld -\end_inset - -arrow keys -\begin_inset Quotes erd -\end_inset - -? Surely not the ones on the keyboard\SpecialChar \ldots{} - \layout Itemize A @@ -646,21 +639,15 @@ Construction Space \end_inset -\end_float -The Construction Space, as seen in figure -\begin_inset LatexCommand \ref{Construction Space Figure} - -\end_inset +\layout Standard -, is the section of LON-CAPA where you create and manage your course resources. - The Construction Space consists of a green tool bar at the top of the page - and a list of all directories and resources below. +Contents of the Construction Space: \layout Standard \begin_inset Tabular - + @@ -852,6 +839,14 @@ Type a name in the entry box to create a \end_inset +\end_float +The Construction Space, as seen in figure +\begin_inset LatexCommand \ref{Construction Space Figure} + +\end_inset + +, is the section of LON-CAPA where you create and manage your course resources. + The figure explains what each button does. \layout Subsection How to Create New Content Pages @@ -868,9 +863,6 @@ Content Pages \series default are HTML documents that display the course information you are presenting. To create new Content Pages, do the following: -\layout Comment - -Is step one necessary? I don't see how it could be. \layout Enumerate Click the @@ -899,20 +891,13 @@ directory/new_resource.html Press the Return or Enter key. \layout Enumerate -You should see something like the following message: -\series bold -File not found: /home/wmsonj/priv/\SpecialChar \- -directory/new_resource.html -\series default -, and an Edit button. +You should see something like the following message: File not found: /home/wmson +j/priv/\SpecialChar \- +directory/new_resource.html, and an Edit button. Click the -\begin_inset Quotes eld -\end_inset - +\series bold Edit -\begin_inset Quotes erd -\end_inset - +\series default button, and an HTML editor will open with a simple page template. \layout Enumerate @@ -920,7 +905,8 @@ Type the content into the editor, \emph on OR \emph default - copy and paste HTML source code into the editor. + copy and paste HTML source code obtained through the use of some other + HTML authoring program into the editor. \layout Enumerate Optionally, click the @@ -1008,6 +994,19 @@ Creating Online Problems Using LON-CAPA If you're following this as a tutorial, go ahead and make one of each of these problem types now. We'll be using them later as raw material to assemble maps and sequences. +\layout Standard + +While several problem types are listed here, in LON-CAPA, all problems are + actually the same. + All problems are written in XML, which can be obtained and edited with + the +\series bold +EditXML +\series default + button you'll see. + The problem types listed in this manual are actually just templates. + As your knowledge advances, you may wish to play with the XML representation + directly to see what you can do. \layout Subsubsection Problems Types @@ -1055,7 +1054,7 @@ Radio Response foils, True or False. \layout Standard -Multiple choice problems contain between 3 and 10 foils. +Multiple choice problems contain between 3 to 10 foils. You may display from three to five foils for each problem and the system randomly picks the choices that are presented to the student. \layout Comment @@ -1077,12 +1076,12 @@ Option Response problems present foils t pick one to present to the student from each group. The student must match each of his or her questions correctly to the possible answers before receiving credit for the problem. - For more details, see the Create Option Response ( + For more details, see Create Option Response in section \begin_inset LatexCommand \ref{Create Option Response Problem} \end_inset -). +. \layout Subsubsection String Response Problems @@ -1137,7 +1136,7 @@ Samuel Clements \begin_inset Quotes erd \end_inset -, then the student will definately get it wrong. +, then the student will definitely get it wrong. There is some room for flexibility in the string processing, but it can be difficult to get it all right. Before you use a String Response problem, be sure you can easily characterize @@ -1158,7 +1157,7 @@ Numerical Response \series default problems are answered by entering a number and (optionally) a unit, such as 2.5 m/s^2. - Tolerance and significant digits can be specified as well. + Tolerance and required significant digits can be specified as well. \layout Subsubsection Formula Response Problems @@ -1254,7 +1253,7 @@ Radio Response Creation Form \end_float - You will need to create the posible answers and the questions. + You will need to create the possible answers and the questions. \layout Enumerate In the drop-down option box as seen in @@ -1278,6 +1277,12 @@ Click the Edit \series default button above the sample problem to enter edit mode. + You should see an editing screen like figure +\begin_inset LatexCommand \ref{Radio Response Creation Form} + +\end_inset + +. \layout Enumerate In the @@ -1512,7 +1517,7 @@ true \begin_inset Quotes eld \end_inset -Napolean conquered Japan in the year 189 A.D. +Napoleon conquered Japan in the year 189 A.D. \begin_inset Quotes erd \end_inset @@ -1542,6 +1547,9 @@ Option Response \end_inset Problems +\layout Subsubsection + +Option Response problems with Concept Groups \layout Standard \begin_float fig @@ -1565,7 +1573,7 @@ Option Response Problem \end_float -Each Option Response problem has three parts: +Each Option Response problem can have three parts: \layout Enumerate The Concept Groups @@ -1874,7 +1882,7 @@ To delete the irrelevant options from th \series bold Delete Option \series default - dropdown, and hit the Save Changes button. + drop down, and hit the Save Changes button. Do that for each option you wish to remove. \layout Enumerate @@ -1926,6 +1934,19 @@ In the Hint area, provide a helpful hint Save Changes \series default button. +\layout Subsubsection + +Simple Option Response: No Concept Groups +\layout Standard + +If you select +\series bold +Simple Option Response +\series default + from the drop-down box, you get a template that will allow you to enter + up to eight foils, and the system will randomly select from these foils, + with no grouping. + Otherwise, it's identical to Option Response problems. \layout Subsection Creating a String Response Problem @@ -2073,7 +2094,7 @@ ci \begin_inset Quotes eld \end_inset -Case Insenstive +Case Insensitive \begin_inset Quotes erd \end_inset @@ -2137,7 +2158,7 @@ Multiple Choice . The student's answers must contain the same letters as the question author's, - but order is unimportent. + but order is unimportant. This is usually used to give a multiple choice question in the question's \series bold @@ -2195,8 +2216,8 @@ abcg . \layout Standard -It is conventional to tell the students whether the question is case sensitive - or not. +It is conventional to inform the students if the problem is case sensitive, + or that the order of the answers doesn't matter. \end_deeper \layout Enumerate @@ -2207,23 +2228,6 @@ Single Line Text Entry Area block and set a length in the Size box. This will only affect the size of the box on the screen; if you set the box size to 2, the student can still enter 3 or more letters in their answer. -\begin_deeper -\layout Comment - -This seems like a great feature to either eliminate, or make useful. - Allowing the teacher to limit it to 3, and then not letting the student - type more then 3 chars might be a way of giving the student a hint. - Probably not worth it, as the problem text can always just say -\begin_inset Quotes eld -\end_inset - -Pick two of the following -\begin_inset Quotes erd -\end_inset - -. - This is probably not a useful feature. -\end_deeper \layout Enumerate Scroll down to the Hint element, and type some text that will help students @@ -2267,8 +2271,8 @@ Numerical Response problems are answered Creating Numerical Response and Formula Response problems starts the same as the other problem types, but because of the power of Numerical Response - and Formula Response problems, it is too difficult to cover them in this - tutorial. + and Formula Response problems, they are covered in their own section after + the end of the tutorial. For more information about these problem types, please see section \begin_inset LatexCommand \ref{Numerical Response} @@ -2289,9 +2293,8 @@ In order to make the content you've crea you must publish your content. LON-CAPA provides an easy interface for publishing your content pages, problem resources, and sequences. - A common interface allows you to specify title, author information, keywords, - and other metadata. - LON-CAPA uses this metadata for many things, and it's importent to fill + You can specify title, author information, keywords, and other metadata. + LON-CAPA uses this metadata for many things, and it's important to fill the metadata out as accurately as possible. \layout Subsection @@ -2329,10 +2332,10 @@ data about data too stupid to understand the problem statement at all. \layout Standard -One example of metadata you use all the time is the of a webpage, +One example of metadata you use all the time is the <TITLE> of a web page, which usually shows up in the title bar of the browser. - That's information about the webpage itself, not actually part of the web - page. + That's information about the web page itself, not actually part of the + web page. People use it when they bookmark a page, so they know what the page is. Search engines use it as a clue about the content of the web page. \layout Subsection @@ -2454,7 +2457,7 @@ pulley as a key word. LON-CAPA pulls out likely-looking keywords for you so you can just click - on them to make them keywords. + on their check boxes to make them keywords. \series bold Additional keywords @@ -2471,7 +2474,6 @@ statics , even though it doesn't appear in the original problem, because Physics uses that as a classification of problem type. - \layout Standard Finally, you need to set the copyright and distribution notice. @@ -2554,8 +2556,9 @@ Binding Together Resources In One Map: P \layout Standard \align center -\begin_inset Figure size 429 66 -file mapEditingButton.eps +\begin_inset Figure size 238 83 +file mapEditorSelection.eps +width 3 40 flags 9 \end_inset @@ -2563,14 +2566,14 @@ flags 9 \layout Caption -Map Editing Button -\begin_inset LatexCommand \label{Map Editing Button Figure} +Map Editor Selection +\begin_inset LatexCommand \label{Map Editor Selection Figure} \end_inset \end_float -To join several resources into one page, you need to create a +To join several resources into one web page, you need to create a \series bold Map \series default @@ -2612,48 +2615,21 @@ page \end_inset , you should see a screen as in figure -\begin_inset LatexCommand \ref{Map Editing Button Figure} +\begin_inset LatexCommand \ref{Map Editor Selection Figure} \end_inset . - Click the button to get to the sequence editor. + You can use either the advanced editor or the simplified editor. -\begin_float fig -\layout Standard -\align center - -\begin_inset Figure size 476 226 -file mapEditInitial.eps -width 3 80 -flags 11 - -\end_inset - - -\layout Caption - -Initial Map Editor -\begin_inset LatexCommand \label{Initial Map Editor FIgure} - -\end_inset - - -\end_float -After the system notices the map does not yet exist and creates it for you. - You should the initial map editor as seen in figure -\begin_inset LatexCommand \ref{Initial Map Editor FIgure} - -\end_inset +\layout Comment -. - Note there are two windows. - One is the workspace, and one is the window which will contain information - as you add resources. -\layout Subsection +The following is a commented-out section of the manual, likely to not be + useful. +\layout Comment About The Editor -\layout Standard +\layout Comment \begin_float fig \layout Caption @@ -2666,12 +2642,12 @@ Example of the Map Editor \end_float Maps are very powerful and can do a lot. - They can make decisions as the user progresses, and go down different paths + They can make decisions as the user progresses, going down different paths under different circumstances. For instance, a map can go down one path if the user gets a problem right, - and another path if they don't. + and another path if they don't which will provide more help for the student. -\layout Standard +\layout Comment To facilitate editing these powerful entities, LON-CAPA has a map editor that helps you take advantage of this power, as seen in figure @@ -2697,7 +2673,7 @@ Finish In the example figure, there are two paths the student can go down, depending on whether or not they get the problem at the branch point correct. By the end of this section, we'll create the map represented in this figure. -\layout Standard +\layout Comment The branching ability can obviously be used to help the student understand the concept in the problem by having them go through some extra material @@ -2705,19 +2681,15 @@ The branching ability can obviously be u only by your imagination. \layout Subsection -Creating a Simple Map: Page +Creating a Simple .page With The Simple Editor \layout Standard -To add a resource to the map: -\layout Enumerate - -Click on an unused light gray area. \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 242 -file mapEditFirstClick.eps +\begin_inset Figure size 476 250 +file mapSimpleEditor.eps width 3 80 flags 9 @@ -2726,55 +2698,208 @@ flags 9 \layout Caption -Map Editor after clicking on the box labelled -\begin_inset Quotes eld +Simple Map Editor +\begin_inset LatexCommand \label{Simple Map Editor} + \end_inset -here -\begin_inset Quotes erd + +\end_float +After creating a new .page resource and getting the editor selection prompt + (figure +\begin_inset LatexCommand \ref{Map Editor Selection Figure} + +\end_inset + +), click the +\series bold +Simple Edit +\series default + button to get to the simple sequence editor, which appears in figure +\begin_inset LatexCommand \ref{Simple Map Editor} + \end_inset . -\begin_inset LatexCommand \label{Map Editor First Click Figure} +\layout Standard + +The Simple Editor can create .sequences and .pages which are linear, which + means they have no branches or conditions. +\layout Standard + +On the right side of the simple editor is the +\series bold +Target +\series default +, which represents the map you are currently building. + On the left side is the +\series bold +Import +\series default + area, which represents a work area you can use for your convenience to + load and manipulate resource you may wish to include in your map. + Using the three buttons in the middle of the screen, from top to bottom + you can cut things out of the Target, copy from the Target to the Import, + and copy from the Import to the Target, respectively. +\layout Standard + +On both sides of the screen, you can do a Group Search and a Group Import. + A Group Search allows you to run a search, then import selected results + from that search into either directly into your Map, or into your Import + space. + Checkboxes will appear next to the results in the Group Search, and you + can click the resource you wish to add to your map. + After you select the resource, you will be presented with a screen that + allows you to change the order of the selected resources, then you will + be able to import the selected resources and work with them. +\layout Standard + +A Group Import works in a similar fashion, but allows you to use the LON-CAPA + network browser to select your resources. +\layout Standard + +On the Import side, you can also browse for another Map, and load the resources + used in that map into your Import workspace. + You can also discard the selected resources, clear all the resources, and + view the selected resource from the buttons on the Import side of the screen. + +\layout Standard + +Both list boxes support standard multi-select mechanisms as used in your + OS. +\layout Subsection + +Creating a Simple .page With The Advanced Editor +\layout Standard + +After creating a new .page resource and getting the editor selection prompt + (figure +\begin_inset LatexCommand \ref{Map Editor Selection Figure} + +\end_inset + +), click the +\series bold +Advanced Edit +\series default + button to get to the advanced sequence editor. + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 205 +file mapAdvancedEditorNew.eps +width 3 80 +flags 11 + +\end_inset + + +\layout Caption + +Initial Map Editor +\begin_inset LatexCommand \label{Initial Map Editor FIgure} + +\end_inset + + +\end_float +You should the initial map editor as seen in figure +\begin_inset LatexCommand \ref{Initial Map Editor FIgure} + +\end_inset + +. + Note there are two windows. + One is the workspace, and one is a secondary window which will contain + information as you add resources. +\layout Enumerate + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 221 +file mapClickedStart.eps +width 3 80 +flags 9 + +\end_inset + + +\layout Caption + +Clicked Start in the Map Constructor +\begin_inset LatexCommand \label{Clicked Start Figure} \end_inset \end_float - In figure -\begin_inset LatexCommand \ref{Map Editor First Click Figure} +Click the Start box. + You'll see what you see in figure +\begin_inset LatexCommand \ref{Clicked Start Figure} \end_inset -, the map editor after clicking on the area labelled +. + Click \begin_inset Quotes eld \end_inset -here +Link Resource \begin_inset Quotes erd \end_inset - is shown. - In that figure, lines have been added to show where the box boundaries - are for the purposes of demonstration. - This is to allow you to stay in sync with this tutorial; normally this - doesn't matter. - -\begin_deeper + in the secondary window, then click on the Finish box. +\begin_float fig \layout Standard +\align center -Note that the contents of the seperate window have changed. -\end_deeper +\begin_inset Figure size 70 210 +file mapStraightened.eps +height 3 25 +flags 9 + +\end_inset + + +\layout Caption + +Straightened Map +\begin_inset LatexCommand \label{Striaghtened map} + +\end_inset + + +\end_float + After that, click +\begin_inset Quotes eld +\end_inset + +straighten +\begin_inset Quotes erd +\end_inset + +. + You should see something like figure +\begin_inset LatexCommand \ref{Striaghtened map} + +\end_inset + +. + This creates a simple map that flows from beginning to end. \layout Enumerate \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 218 -file mapNewResource.eps -width 3 80 +\begin_inset Figure size 271 252 +file mapInsertResource.eps +height 3 30 flags 9 \end_inset @@ -2782,31 +2907,31 @@ flags 9 \layout Caption -Map Resource Editor -\begin_inset LatexCommand \label{Map Resource Editor Figure} +Inserting a Resource +\begin_inset LatexCommand \label{Inserting a Resource Figure} \end_inset \end_float -Click on -\series bold -Insert Resource -\series default - in the secondary window. - A -\series bold -Resource -\series default - will appear in the map editor. - Click on the new Resource, and you'll get something like Figure -\begin_inset LatexCommand \ref{Map Resource Editor Figure} +To insert a resource into the flow, click the black line with two arrows. + In the secondary window, you'll see something like figure +\begin_inset LatexCommand \ref{Inserting a Resource Figure} \end_inset - will show appear. +. Click \series bold +Insert Resource Into Link +\series default +. + A new resource will appear in the link. + Click the resource. +\layout Enumerate + +Click +\series bold Browse \series default , and the @@ -2818,9 +2943,9 @@ Network Directory Browser \layout Standard \align center -\begin_inset Figure size 476 216 +\begin_inset Figure size 357 162 file mapEditorDirectoryBrowser.eps -width 3 80 +width 3 60 flags 9 \end_inset @@ -2846,9 +2971,9 @@ Network Directory Browser \layout Standard \align center -\begin_inset Figure size 476 213 +\begin_inset Figure size 42 252 file mapEditorResourceChosen.eps -width 3 80 +height 3 30 flags 9 \end_inset @@ -2861,7 +2986,7 @@ Resource Chosen \end_inset - (HTML page) + \end_float Once you've done that, if you look back at the window that popped up when you clicked on @@ -2882,7 +3007,8 @@ URL \series bold Title \series default - if you prefer, following the format you see above. + into the secondary window, if you prefer, following the format you see + above. After you click \series bold Save Changes @@ -2908,116 +3034,79 @@ Clicking on the left icon for a resource \end_deeper \layout Enumerate -Let's give practice giving ourselves a bit more space. - Click on the grey space just left of your resource, and select -\series bold -Insert Column Right -\series default -. - This will add a column to the right of that space. - Now, click on the bottom row in the grey area, and select -\series bold -Insert Row Above -\series default -. - This gives us enough space to work with. +Repeat steps two and three for as many resources as you'd like to bind together + into one page. + You can insert the new resources anywhere you'd like. \layout Enumerate -Now, in the map editor window, click just to the left of the +When you are done adding resources, click the \series bold -Res +Save Map \series default - box. -\begin_float fig + link to save the map. \layout Standard -\align center - -\begin_inset Figure size 357 190 -file mapSecondWindowSecondResource.eps -flags 9 - -\end_inset +In addition to manually adding in resources, the Advanced Editor also has + the ability to import resource in the same way that the Simple Editor can: + From a LON-CAPA network browser window, from a Group Search, or from another + Map. +\layout Standard -\layout Caption +The advanced editor has many more capabilities which you can explore. +\layout Subsection -Choosing your second resource -\begin_inset LatexCommand \label{Map Second Resource Figure} +Creating Sequences +\begin_inset LatexCommand \index{Sequence} \end_inset -\end_float - The secondary window will appear as it does in figure -\begin_inset LatexCommand \ref{Map Second Resource Figure} +\layout Standard -\end_inset +Sequences are a series of resources that can be navigated using the +\series bold +NAV +\series default + remote control button, or by using the arrow keys on the remote control. + Sequence maps are created identically to page maps. + The only difference is how they are displayed. +\layout Subsection + +Creating a Course: Top-level Sequence +\layout Standard -, but for now just choose +In order to view sequences, they need to be part of a \series bold -Insert Resource +course \series default - again, not the new options. - Insert a resource in the same manner as before. +. \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 243 -file mapTwoResources.eps -width 3 80 -flags 11 +\begin_inset Figure size 238 231 +file creatingANewCourse.eps +width 3 40 +flags 9 \end_inset \layout Caption -Two Resource in the Map Editor -\begin_inset LatexCommand \label{Two Resources in the Map Editor Figure} +Creating a New Course +\begin_inset LatexCommand \label{Creating a New Course Figure} \end_inset \end_float - You should have something that looks like figure -\begin_inset LatexCommand \ref{Two Resources in the Map Editor Figure} - -\end_inset - -, though the exact placement may differ. - Now we need to link them together. -\layout Enumerate - -Click the Start box. - In the secondary window, select -\series bold -Link Resource -\series default -. - The secondary window will prompt you to click on the resource you want - to link it to. - Click the first resource you added to the map. - A new link is created. -\layout Enumerate - -Repeat the last step, linking the first resource to the second resource, - and the second resource to -\series bold -Finish -\series default -. -\layout Enumerate - -Now, in the editor window, click -\series bold -Save Map -\series default -. - A dialog box will pop up, telling you the map has been saved. -\layout Standard - -Now that you + Courses have a Top-level Map which defines the whole course. + This top-level map will often itself contain maps corresponding to homework + assignments or weekly sequences. + To view your maps, you will need to make them part of a course. + Only Domain Administrators can make courses and set their Top-level maps, + so coordinate with your Domain Administrator if you need to view your maps. \layout Section Numerical Response @@ -3030,7 +3119,7 @@ Numerical Response \end_inset - Problems + And Formula Response Questions \layout Standard Numerical Response problems are very powerful. @@ -3038,7 +3127,7 @@ Numerical Response problems are very pow is possible in a document like this. This chapter will focus on just getting you started with Numerical Response problems, and showing you some of the possibilities, with no prerequisite - knowlege necessary. + knowledge necessary. The more you learn, the more you will find you can do. \layout Standard @@ -3334,7 +3423,7 @@ t is interpreted as a percentage. Any number in the tolerance field \emph on -with +followed by \emph default a \series bold @@ -3525,7 +3614,7 @@ A script consists of several \series bold statements \series default -, seperated by +, separated by \series bold semi-colons \series default @@ -3563,8 +3652,9 @@ comments very \emph default good idea to adopt some sort of commenting standard, especially if you - are working in a group or others may use your problems in the future. -\layout Standard + are working in a group or you believe other people may use your problems + in the future. +\layout Itemize One of the simplest statements in LON-CAPA is a \series bold @@ -3640,11 +3730,12 @@ case sensitive Getting variable names right is a skill. Variable names should not be too long, because they become easy to mistype. Variable names should also not be too short, with the exception of some - conventionally short variable names we'll talk about later. + conventionally short variable names used in control flow statements, which + are not covered in this manual. \layout Standard There are many variable naming conventions, covering both how to name and - how to capatalize variables + how to capitalize variables \begin_float footnote \layout Standard @@ -3721,11 +3812,11 @@ $variable $variable2 = $variable + 2; \layout Standard -Now there's a variable called +Now there is a variable called \family typewriter $variable2 \family default - with the value + with the the number \begin_inset Quotes eld \end_inset @@ -3733,7 +3824,7 @@ $variable2 \begin_inset Quotes erd \end_inset -. + as its value. \layout Standard @@ -3911,7 +4002,72 @@ View Calling Functions \layout Standard -Now you've seen how to use variables and stuff, see how to call functions. +With variables, you can store strings or numbers. + +\series bold +Functions +\series default + allow you to manipulate these strings or numbers. + Functions work like mathematical functions: They take some number of arguments + in, and return one argument, usually a number or a string for our purposes. + There are a lot of functions available in LON-CAPA. + You can see a complete list at http://mileva.lite.msu.edu/loncapadocs/homework/hom +ework5.html. + For now, let's just look at some simple examples. +\layout Standard + +\begin_float fig +\layout LyX-Code + +$a = 3; +\layout LyX-Code + +$b = &sin($a); +\layout LyX-Code + +$c = &pow(3, &floor($a)); +\layout Caption + +Some Function Calls +\begin_inset LatexCommand \label{Some Function Calls Figure} + +\end_inset + + +\end_float +In the +\series bold +Script +\series default + block, function names start with +\series bold +& +\series default +. + Some example function calls are shown in figure +\begin_inset LatexCommand \ref{Some Function Calls Figure} + +\end_inset + +. + You can see that functions can take either variables, numbers, or the results + of other function calls as parameters. + The +\family typewriter +sin +\family default + function returns the sine of an angle expressed in radians. + +\family typewriter +pow +\family default + raises the first parameter to the power of the second parameter. + +\family typewriter +floor +\family default + returns the nearest integer below the parameter, which since 3 is already + an integer is 3. \layout Subsubsection Randomization @@ -3922,13 +4078,297 @@ Randomization \layout Standard -One of the most importent functions for LON-CAPA is the RANDOM function. +For LON-CAPA, one of the most important functions is the +\family typewriter +random +\family default + function. + Random takes three parameters, a +\emph on +lower limit +\emph default +, an +\emph on +upper limit +\emph default +, and an +\emph on +interval +\emph default +. + The +\family typewriter +random +\family default + function returns a random value between the upper and lower limit, some + integer number of +\emph on +interval +\emph default +'s away from the lower limit. + Thus, for example, +\family typewriter +&random(1,2,.2) +\family default + might return 1, 1.2, 1.4, 1.6, 1.8, or 2. + +\family typewriter +random +\family default + uses a uniform distribution. + Other distributions are available in LON-CAPA, and can be found by consulting + the function list. +\layout Standard + +\begin_float fig +\layout LyX-Code + +$a = &random(1,10,1); +\layout LyX-Code + +$b = &random(-10, -3, 1); +\layout LyX-Code + +$answer = $a+$b; +\layout Caption + +Sample +\family typewriter +random +\family default + Calls +\begin_inset LatexCommand \label{Sample Random Calls figure} + +\end_inset + + +\end_float +If you put the script in figure +\begin_inset LatexCommand \ref{Sample Random Calls figure} + +\end_inset + + into the +\series bold +Script +\series default + block (replacing whatever contents might be in the block already), you'll + get two random variables $a and $b. + Now, in the +\series bold +Text Block +\series default +, put +\begin_inset Quotes eld +\end_inset + +What is $a plus $b? +\begin_inset Quotes erd +\end_inset + +, and in the +\series bold +Answer +\series default + put +\begin_inset Quotes eld +\end_inset + +$answer +\begin_inset Quotes erd +\end_inset + +, without the quotes for either of them. + (It is a good idea to create a variable to hold the answer and call it + $answer, or some other reasonably standard name. + Do not try to compute the answer in the +\series bold +Answer +\series default + field itself; it will not work as you expect.) Now save the problem and + +\series bold +View +\series default + it. + You'll see a randomized problem. +\layout Standard + +For each student, the same random number will be used each time they visit + the problem, but each student will get different random numbers. + For any but the simplest random problems, you'll want to see several random + problems to make sure everything is working out correctly. + This is what the +\series bold +Random Seed +\begin_inset LatexCommand \index{Random Seed} + +\end_inset + + +\series default + field is for. + To see another randomized version of the problem you've just created, put + another number into the +\series bold +Random Seed +\series default + field and hit +\series bold +Change +\series default +. + It doesn't really matter what number you put into the field. + But for any given +\series bold +Random Seed +\series default + with the same problem, you'll see the same randomized problem generated + for you. + (If you change the +\series bold +Script +\series default +, you are no longer guaranteed to get the same problem.) +\layout Standard + +If you're doing this as a tutorial, try a few random seeds to see what happens. \layout Subsection Dynamic, Randomized Problems: Putting It All Together \layout Standard -placeholder +Now you have all the tools to create those wonderful dynamic, randomized + problems that you've seen in LON-CAPA. +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 197 +file numericalResponseSlopeProblem.eps +width 3 80 +flags 9 + +\end_inset + + +\layout Caption + +Slope Problem Parameters +\begin_inset LatexCommand \label{Slope Problem Parameters Figure} + +\end_inset + + +\end_float + For example, try filling out your problem with the parameters shown in + figure +\begin_inset LatexCommand \ref{Slope Problem Parameters Figure} + +\end_inset + +. + +\layout Standard + +When creating randomized problems, you want to make sure that the problems + always have an answer. + Consider what might happen if I had chosen the two slopes +\emph on +both +\emph default + with the expression +\family typewriter +&rand(-1,1,.2) +\family default +. + One out of ten students would get a problem where both slopes were equal, + which has either no solution (for unequal y-intercepts) or an infinite + number of solutions (for equal slopes and y-intercepts). + Both of these cause a division-by-zero error on the division that computes + the answer. + There are many ways to avoid this, one of the easiest of which is picking + one slope negative and one positive. + This same problem can show up in many other places, too, so be careful. +\layout Subsection + +Units, Format +\layout Standard + +Numerical Response problems can require units. + In the problem editing form, place the desired unit in the +\series bold +Unit +\series default + field. + For information about what units the system accepts, see http://capa4.lite.msu.edu +/demolibrary/Links/UnitsSymbolsT2.html. + The computer will accept the answer in any of its accepted unit formats. + For example, if the answer to a problem is +\begin_inset Quotes eld +\end_inset + +1ft +\begin_inset Quotes erd +\end_inset + +, the computer will accept +\begin_inset Quotes eld +\end_inset + +12in +\begin_inset Quotes erd +\end_inset + + as correct. +\layout Standard + +Additionally, you can format the number displayed by the computer as the + answer. + For instance, if the answer is one-third, the computer will display that + it computed +\begin_inset Quotes eld +\end_inset + +.333333333 +\begin_inset Quotes erd +\end_inset + + as the answer. + If you'd like to shorten that, you can use the +\series bold +Format +\series default + field. + Format strings like +\begin_inset Quotes eld +\end_inset + +2e +\begin_inset Quotes erd +\end_inset + + (without the quotes) will display three significant digits in scientific + notation. + Format strings like +\begin_inset Quotes eld +\end_inset + +2f +\begin_inset Quotes erd +\end_inset + + will display three significant digit in traditional notation if possible, + and scientific notation if the number is too large or too small. + You can use any small number that you want instead of +\begin_inset Quotes eld +\end_inset + +2 +\begin_inset Quotes erd +\end_inset + +. \layout Subsection For More Information @@ -3944,109 +4384,366 @@ Very often, the easiest way to create a \series default The more complicated a problem is, the more time you'll save by doing this. - Also, you may find new ideas you can use and elaborate in your problems. + You may also find new ideas you can use and elaborate on in your problems. \layout Comment Is there UI for this? Check. \layout Standard The full power of the Perl is well outside the scope of this document. - Without going into the same level of detail as the previous examples, here's - some ideas to stimulate your imagination: -\layout Itemize + Looking in the function list at http://mileva.lite.msu.edu/loncapadocs/homework/ho +mework5.html can give you some ideas. + O'Reilly has some good Perl books. + The Perl 5 Pocket Reference will contain more then what you need to know + to use LON-CAPA, available at http://www.oreilly.com/catalog/perlpr3/ . +\layout Standard + +If you have any problems, consult http://help.loncapa.org/fom/cache/5.html + . + If you don't find the answer to your problem, please help us expand the + FAQ by emailing us your question so we can answer it. +\layout Standard + +Our advanced users often come to prefer the XML interface for the problems, + available through the +\series bold +EditXML +\series default + buttons. + Covering the XML format is beyond the scope of this manual, but you can + learn a lot by using the editor to make changes and seeing what happens + to the XML. +\layout Subsection + +Formula Response +\begin_inset LatexCommand \index{Formula Response} + +\end_inset + + +\begin_inset LatexCommand \label{Formula Response} + +\end_inset + + Problems +\layout Standard + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 262 +file formulaResponse.eps +width 3 80 +flags 9 + +\end_inset + + +\layout Caption + +Formula Response Problem +\end_float +Formula response problems asks the student to type in a formula as an answer. + If the answer is +\begin_inset Formula \( 2x^{2}+4 \) +\end_inset -Variable text. +, the student is allowed to type +\begin_inset Quotes eld +\end_inset + +2*x*x+4 +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +x*x + x*x + 4 +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +2*x^2 + 14 - 10 +\begin_inset Quotes erd +\end_inset + +, or any other equivalent expression. + Formula Response problems have many of the same characteristics of Numerical + Response problems, including the ability to run scripts, dynamically generate + answers, etc. +\layout Standard + +As you may know, it is extremely difficult to determine whether a given + expression is exactly equal to another expression in general. + For example, is +\begin_inset Formula \( \sin 2x=2\sin x\cos x \) +\end_inset + +? Symbolically proving it one way or another is impossible in general. + Therefore, LON-CAPA uses a sampling system. + If your answer and the student's answer agree at the sampling points within + your given tolerance factor, the student's answer will be accepted, otherwise + it will be rejected. +\layout Subsubsection + +Sampling Specifications +\layout Standard + +To specify where to sample the formulas to determine whether the student's + answer is correct, you need to put a sampling specification in the +\series bold +Sample Points +\series default + +\begin_inset LatexCommand \index{Sample Points} + +\end_inset + + field. + The sampling specifications takes the following format: \layout Itemize -Perl has several other data structures which might be of use. - You may wish to do one of the many simple Perl tutorials on the Web. - I recommend searching Google for +A comma seperated list of the variables you wish to interpret, +\layout Itemize + +followed by \begin_inset Quotes eld \end_inset -perl tutorial +@ \begin_inset Quotes erd \end_inset -. -\layout Section + (not in quotes), +\layout Itemize -Formula Response -\begin_inset LatexCommand \index{Formula Response} +followed by any number of the following two things, separated by semi-colons: +\begin_deeper +\layout Enumerate +a comma separated list of as many numbers as there are variables, which + specifies one sampling point, OR +\layout Enumerate + +a comma separated list of as many numbers as there are variables, followed + a colon, followed by another list of as many numbers as there are variables, + followed by #, followed by an integer. +\end_deeper +\layout Standard + +The first form specifies one point to sample. + The second form specifies a range for each variable, and the system will + take as many random samples from that range as the number after the #. +\layout Standard + +For +\begin_inset Formula \( 2x^{2}+4 \) +\end_inset + +, with one variable +\begin_inset Quotes eld +\end_inset + +x +\begin_inset Quotes erd \end_inset +, one could specify +\layout Itemize -\begin_inset LatexCommand \label{Formula Response} +\begin_inset Quotes eld \end_inset - Problems -\layout Section +x@2 +\begin_inset Quotes erd +\end_inset + +, which will sample the answers only at 2. + (This is generally a bad idea, as the student could get lucky and match + at that point) +\layout Itemize -Additional Problem Components -\layout Standard -Using the \begin_inset Quotes eld \end_inset -Insert +x@1:5#4;10 \begin_inset Quotes erd \end_inset - menu that appears in many of the problem editors, a wide variety of different - things can be added to the problems. -\layout Section + will take 4 samples from somewhere between 1 and 5, and also sample at + 10. +\layout Standard -Things That Need To Be Added -\layout Subsection +For +\begin_inset Formula \( 2x^{2}+3y^{3} \) +\end_inset -LON-CAPA and Units -\layout Subsection +, which has two variables, one could specify +\layout Itemize -Creating a default metadata file -\layout Subsection -My questions\SpecialChar \ldots{} +\begin_inset Quotes eld +\end_inset + +x,y@4,5:10,12#4;0,0 +\begin_inset Quotes erd +\end_inset + +, which take four samples from the box determined by the points (4, 5) and + (10, 12), and also sample the point (0, 0). +\layout Subsubsection +Formula Notes \layout Itemize -How do I do the things above? +The formula evaluator can not handle things of the form +\begin_inset Quotes eld +\end_inset + +x + - y +\begin_inset Quotes erd +\end_inset + +. + If you have a random variable that may be positive or negative (as in the + example following this section), you can try wrapping the references to + that variable in parenthesis. + As always, it is a good idea to try out several randomized versions of + your problems to make sure everything works correctly. \layout Itemize -Is there any pre-existing documentation for number or formula problems? + +\series bold +Never use relative tolerance in Formula Response problems. +\begin_inset LatexCommand \index{tolerance, in formula response} + +\end_inset + + +\begin_inset LatexCommand \index{relative tolerance, in formula response} + +\end_inset + + +\series default + Relative tolerance is poorly defined in Formula Response problems. + Always use absolute tolerance. +\layout Subsubsection + +Example Formula Response +\layout Standard + +A very simple formula response problem: +\layout Standard + +In the +\series bold +Script +\series default +, place the following: +\layout LyX-Code + +$slope = random(-5,5,.5); +\layout LyX-Code + +$yint = random(-5,5,.5); \layout Itemize -Is there any pre-existing documentation for maps et al? I seem to have exhausted - the documentation. +In the +\series bold +Text Block +\series default +, place the following: +\begin_inset Quotes eld +\end_inset + +For a line with slope $slope and y-intercept $yint, what is y equal to? +\begin_inset Quotes erd +\end_inset + + \layout Itemize -What is the LON-CAPA default resource? If it's free, can just anyone +In the +\series bold +Answer +\series default +, place the following: \begin_inset Quotes eld \end_inset -find and use it +$slope*x + ($yint) \begin_inset Quotes erd \end_inset -, or just + +\layout Itemize + +Set the Tolerance to .000001. +\layout Itemize + +Set the +\series bold +Answer +\series default + to \begin_inset Quotes eld \end_inset -use it if they already know where it is +$slope * x + $yint \begin_inset Quotes erd \end_inset -? (In other words, how powerful is the search feature?) What's the difference - between free and public? -\layout Section +. +\layout Itemize + +Set the +\series bold +Sample Points +\series default + to x@0,1,2,3 . +\layout Comment + +TODO: +\layout Comment + +* Get sampling problem figured out +\layout Comment + +\SpecialChar ~ + +\layout Comment + +\SpecialChar ~ + +\newline +\SpecialChar ~ + +\layout Comment Appendix A: Student Interface -\layout Standard +\layout Comment \begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 152 353 +file studentInterface.eps +flags 9 + +\end_inset + + \layout Caption Student Remote Control @@ -4060,49 +4757,49 @@ The Student Remote Control will automati a LON-CAPA course as a student. The Student Remote Control contains most of the functions of the Author Remote Control and the following additional functions. -\layout Itemize +\layout Comment \series bold NAV (NAVIGATE CONTENTS) \series default allows you to directly access resources from the course outline. -\layout Itemize +\layout Comment \series bold ARROWS (LEFT and RIGHT) \series default allows you to move to the backward or forward through the course. -\layout Itemize +\layout Comment \series bold GRDS (MY GRADES) \series default allows you to check your grades in the courses you are taking. -\layout Itemize +\layout Comment \series bold SBKM (SET BOOKMARK) \series default allows you to bookmark pages for easy access. -\layout Itemize +\layout Comment \series bold VBKM (VIEW BOOKMARK) \series default displays your bookmarks for easy access to bookmarked resources. -\layout Itemize +\layout Comment \series bold ANOT (ANOTATE) \series default allows you to create personal notes. -\layout Itemize +\layout Comment \series bold