--- doc/tutorial/Attic/tutorial.lyx 2002/05/31 13:51:31 1.2 +++ doc/tutorial/Attic/tutorial.lyx 2002/06/04 21:07:28 1.5 @@ -27,15 +27,24 @@ \quotes_times 2 \papercolumns 1 \papersides 1 -\paperpagestyle fancy +\paperpagestyle headings \layout Title -Introduction to the Learning +Learning \emph on Online \emph default Network with CAPA +\newline + +\emph on +\SpecialChar ~ + +\newline + +\size larger +Author's Tutorial And Manual \layout Standard \added_space_top vfill \align center \SpecialChar ~ @@ -82,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 @@ -101,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: @@ -120,15 +123,55 @@ developed your objectives for your cours \layout Itemize developed your problems for testing and identified the question formats. - The Template for Mapping Website to LON-CAPA that you filled in will assist - you in the process of creating your course website structure in LON-CAPA. +\layout Subsection + +About This Manual +\layout Standard + +Throughout this manual, keywords and phrases literally present on the computer + screen will be referred to in +\series bold +bold type +\series default +. + Function names and scripts will be shown in a +\family typewriter +typewriter font +\family default +. +\layout Standard + +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 + + through +\begin_inset LatexCommand \ref{Creating a Course} + +\end_inset + + comprise a basic tutorial that can get you started using LON-CAPA, even + with no previous LON-CAPA experience. \layout Standard -This tutorial describes how to use the various author functions available - in LON-CAPA. +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 can put the solution to your problem online for everyone. \layout Section The LON-CAPA Author Interface +\begin_inset LatexCommand \label{Author Interface} + +\end_inset + + \layout Subsection Login as Course Author @@ -140,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} @@ -180,11 +219,9 @@ Fill in the Username and Password boxes This will take you to your LON-CAPA User Roles menu. \layout Description -Note: Your Username is your PILOT ID, which is the part of your PILOT email - address to the left of the @. - Your password is your PILOT email password. - Both the PILOT ID and the password are case sensitive, so make sure you - type upper- and lower-case letters correctly. +Note: Your Username and Password will be given to you by your system administrat +or. + Both are case sensitive, so make sure you type them with the correct case. \layout Subsection @@ -219,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; @@ -250,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 @@ -282,7 +319,7 @@ remote \layout Comment 3. - By commiting to this + By committing to this \begin_inset Quotes eld \end_inset @@ -291,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 @@ -310,50 +347,8 @@ 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. - Moreover, I observe that on a real remote, the vast majority of buttons - are labelled with one conceptual entity (i.e., -\begin_inset Quotes eld -\end_inset - -1 -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -5 -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -FF -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -[the pause symbol] -\begin_inset Quotes erd -\end_inset - -, etc)., not -\begin_inset Quotes eld -\end_inset - -Change User -\begin_inset Quotes erd -\end_inset - - which is two entities by my count, at least for an initial user. \layout Comment \SpecialChar ~ @@ -376,7 +371,7 @@ Change User 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 @@ -389,8 +384,7 @@ The upshot is that the only upside to th \layout Comment -Also, based on my relatively little info, I think you're data-mining the - web logs to see what people actually use. +We're data-mining the web logs to see what people actually use. This is good. We may need to do some really simple stuff before he finishes. Raw statistics on what buttons are pressed most often can probably be interpret @@ -525,11 +519,16 @@ Content Page \end_inset displays course content. - It is mostly a conventional HTML page. - -\layout Comment + It is essentially a conventional HTML page. + These resources use the extension +\begin_inset Quotes eld +\end_inset + +.html +\begin_inset Quotes erd +\end_inset -Check this; is it exactly like HTML pages? +. \layout Itemize A @@ -573,8 +572,8 @@ Sequence \series default type represents a programmed series of events. - The users of this resource can use array keys or NAV buttons 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 @@ -584,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 @@ -652,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 - + @@ -858,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 @@ -873,16 +862,7 @@ How to Create New Content Pages Content Pages \series default are HTML documents that display the course information you are presenting. - These documents can be created in any order. -\layout Comment - -Is this worth mentioning? -\layout Standard - -To create new Content Pages, do the following: -\layout Comment - -Is step one necessary? I don't see how it could be. + To create new Content Pages, do the following: \layout Enumerate Click the @@ -911,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 @@ -932,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 @@ -958,6 +932,11 @@ Save and then attempt to clean HTML \layout Standard Repeat this process as many times as necessary to create your Content Pages. + +\layout Standard + +If you're following this as a tutorial, create at least one content page, + which we'll use later as raw material. \layout Subsection How to Edit Existing Content Pages @@ -1010,6 +989,24 @@ Save and then attempt to clean HTML \layout Subsection Creating Online Problems Using LON-CAPA +\layout Standard + +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 @@ -1057,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 @@ -1079,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 @@ -1103,9 +1100,6 @@ String Response for the answer. Examples of string response questions are vocabulary tests, short answer and entering chemical formulas. -\layout Comment - -Case sensitivity? \layout Standard Note that it is easy to abuse String Response problems. @@ -1142,14 +1136,11 @@ 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 correct answers. -\layout Comment - -Check this stuff. \layout Subsubsection Numerical Response Problems @@ -1166,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 @@ -1262,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 @@ -1286,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 @@ -1520,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 @@ -1550,6 +1547,9 @@ Option Response \end_inset Problems +\layout Subsubsection + +Option Response problems with Concept Groups \layout Standard \begin_float fig @@ -1573,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 @@ -1675,10 +1675,15 @@ Example: Matching Problem You might want to ask the student to match musical compositions with their composers. You could create an Option Response problem with 4 Concept Groups, and - place the following four things each in one concept group: + place the following four things each in their own concept group: \layout Itemize Claire de Lune +\begin_inset LatexCommand \index{Clair de Lune} + +\end_inset + + \begin_float footnote \layout Standard @@ -1877,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 @@ -1929,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 @@ -2076,7 +2094,7 @@ ci \begin_inset Quotes eld \end_inset -Case Insenstive +Case Insensitive \begin_inset Quotes erd \end_inset @@ -2140,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 @@ -2198,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 @@ -2210,56 +2228,362 @@ 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 +\layout Enumerate -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 +Scroll down to the Hint element, and type some text that will help students + when they answer incorrectly. +\layout Enumerate + +Click the Submit Changes button. +\layout Subsection + +Creating Numerical Response And Formula Response Problems +\layout Standard + +Numerical Response problems are answered by entering a number and an optional + unit. + For instance, a numerical response problem might have an answer of +\begin_inset Formula \( 2m/s^{2} \) \end_inset -Pick two of the following -\begin_inset Quotes erd +. + Formula Response problems are answered by entering a mathematical formula. + For instance, a numerical response problem might have an answer of +\begin_inset Formula \( x^{2}+11 \) \end_inset . - This is probably not a useful feature. -\end_deeper -\layout Enumerate + The answer may be in any equivalent format. + For instance, for +\begin_inset Formula \( x^{2}+11 \) +\end_inset -Scroll down to the Hint element, and type some text that will help students - when they answer incorrectly. -\layout Enumerate +, the system will accept +\begin_inset Formula \( x*x-11 \) +\end_inset -Click the Submit Changes button. + or +\begin_inset Formula \( x^{2}+21-10 \) +\end_inset + + as well. +\layout Standard + +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, 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} + +\end_inset + + for Numerical Response problems and section +\begin_inset LatexCommand \ref{Formula Response} + +\end_inset + + for Formula Response problems. +\layout Section + +Publishing Your Resources +\layout Standard + +In order to make the content you've created available for courses to use, + you must publish your content. + LON-CAPA provides an easy interface for publishing your content pages, + problem resources, and sequences. + 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 -Creating Numerical Response -\begin_inset LatexCommand \index{Numerical Response} +What is Metadata? +\begin_inset LatexCommand \index{Metadata} \end_inset -\begin_inset LatexCommand \label{Numerical Response} +\begin_inset LatexCommand \label{What Is Metadata?} \end_inset - Problems + \layout Standard -Numerical Response problems are answered by entering a number and an optional - unit. - For instance, a numerical response problem might have an answer of -\begin_inset Formula \( 2m/s^{2} \) + +\emph on +Metadata +\emph default + is +\emph on +data about data +\emph default +. + Metadata can often be thought of as a label on some bit of information + that can be useful to people or computer programs trying to use the data. + Without metadata, the person or computer trying to use the original information + would have to just guess what the original data is about. + For instance, if you create a problem and neglect to say in the title or + subject of the problem what it is about, then a human who wants to use + that problem would have to read the problem itself to see what it was about, + which is much more difficult then just reading a title. + A computer trying to do the same thing would just be out of luck; it is + too stupid to understand the problem statement at all. +\layout Standard + +One example of metadata you use all the time is the of a web page, + which usually shows up in the title bar of the browser. + 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 + +Publishing A Resource +\begin_inset LatexCommand \index{Resource, Publishing} + +\end_inset + + +\begin_inset LatexCommand \index{Publishing Resource} + +\end_inset + + +\layout Standard + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 168 +file constructionSpaceForPublishing.eps +width 3 80 +flags 9 + +\end_inset + + +\layout Caption + +Construction Space for Publishing +\begin_inset LatexCommand \label{Construction Space for Publishing Figure} + +\end_inset + + +\end_float +To publish a resource, log in and choose your role to be an Author. + Then click +\series bold +CSTR +\series default + to go to your construction space. + You should see something like figure +\begin_inset LatexCommand \ref{Construction Space for Publishing Figure} + \end_inset . + Click on the +\series bold +Publish +\series default + button for the resource you wish to publish. +\begin_float fig \layout Standard +\align center -To create an Numerical Response problem, create a new resource as described - in section +\begin_inset Figure size 476 338 +file publishMetadata.eps +width 3 80 +flags 9 + +\end_inset + + +\layout Caption + +Publishing Metadata Screen +\begin_inset LatexCommand \label{Publishing Metadata Screen Figure} + +\end_inset + + +\end_float + You'll get a metadata screen that should look something like figure +\begin_inset LatexCommand \ref{Publishing Metadata Screen Figure} + +\end_inset + +. + Fill out the form. + If you are creating resources that may be used in several courses, you + should talk with the other authors and establish some sort of standard + title and subject scheme in advance. + +\layout Standard + +The language is the language the problem is written in. + The Publisher/Owner is the person who owns the problem; it should be the + email address where anybody with questions about the resource can contact + someone who can help them. + In smaller environments, this is likely to be the author. + In larger environments, it may be a coordinator or manager. +\layout Standard + +The +\series bold +Keywords +\series default + and the +\series bold +Abstract +\series default + are more information about the problem. + The +\series bold +Keywords +\series default + are words that are strongly connected to your problem; for instance a physics + problem about a pulley might include +\begin_inset Quotes eld +\end_inset + +pulley +\begin_inset Quotes erd +\end_inset + + as a key word. + LON-CAPA pulls out likely-looking keywords for you so you can just click + on their check boxes to make them keywords. + +\series bold +Additional keywords +\series default + allows you to add any keyword to your problem that are not actually in + the problem. + For instance, on that same problem a physicist might add the keyword +\begin_inset Quotes eld +\end_inset + +statics +\begin_inset Quotes erd +\end_inset + +, 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. + This setting controls who is allowed to use your resource. + +\layout Itemize + + +\series bold +Limited to courses in the domain published +\series default + means that only courses running in the same domain as you can use your + content. + Talk to your LON-CAPA administrator if you want more information about + your domain. +\layout Itemize + + +\series bold +Free +\series default + means that anyone can find and use the resource. +\layout Itemize + + +\series bold +Private - visible to author only +\series default + means that it can't be used for any course. +\layout Itemize + + +\series bold +Public - no authentication required +\series default + means anyone can find and use the resource. +\layout Standard + +Now when you click +\series bold +Finalize Publication +\series default +, your resource will be published and usable (unless you set the distribution + to +\begin_inset Quotes eld +\end_inset + +private +\begin_inset Quotes erd +\end_inset + +). +\layout Standard + +If you're following this as a tutorial, publish your resources so we can + use them in the next section. +\layout Section + +Creating A Course +\begin_inset LatexCommand \label{Creating a Course} + +\end_inset + +: Maps and Sequences +\layout Standard + +In order to create a useful course, we need to arrange our raw materials + so that students can use them. +\layout Subsection + +Binding Together Resources In One Map: Page +\begin_inset LatexCommand \index{Page} + +\end_inset + + +\layout Standard + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 238 83 +file mapEditorSelection.eps +width 3 40 +flags 9 + +\end_inset + + +\layout Caption + +Map Editor Selection +\begin_inset LatexCommand \label{Map Editor Selection Figure} + +\end_inset + + +\end_float +To join several resources into one web page, you need to create a +\series bold +Map +\series default + of type +\series bold +Page +\series default +. + To create Page resource, create a new resource as described in section + \begin_inset LatexCommand \ref{Creating New Content Pages} \end_inset @@ -2269,7 +2593,7 @@ To create an Numerical Response problem, \begin_inset Quotes eld \end_inset -problem +page \begin_inset Quotes erd \end_inset @@ -2277,46 +2601,95 @@ problem \begin_inset Quotes eld \end_inset -.problem +.page \begin_inset Quotes erd \end_inset . - You should see a screen as in figure -\begin_inset LatexCommand \ref{Creating a new problem resource} + After you enter in the URL ending in +\begin_inset Quotes eld +\end_inset + +.page +\begin_inset Quotes erd +\end_inset + +, you should see a screen as in figure +\begin_inset LatexCommand \ref{Map Editor Selection Figure} \end_inset . -\layout Enumerate + You can use either the advanced editor or the simplified editor. + +\layout Comment -In the drop-down option box as seen in -\begin_inset LatexCommand \ref{Creating a new problem resource} +The following is a commented-out section of the manual, likely to not be + useful. +\layout Comment + +About The Editor +\layout Comment + +\begin_float fig +\layout Caption + +Example of the Map Editor +\begin_inset LatexCommand \label{Map Editor Example Figure} \end_inset -, select + +\end_float +Maps are very powerful and can do a lot. + 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 which will provide more help for the student. + +\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 +\begin_inset LatexCommand \ref{Map Editor Example Figure} + +\end_inset + +. + The map editor can display the different paths in your browser, and allow + you to edit, insert, and delete resources from your map. + The editor has a \series bold -Simple Numerical Response Problem +Start \series default -, and click the + area and a \series bold -New Problem +Finish \series default - button. -\layout Enumerate + area. + The students in the course will progress along on path or another, depending + on decisions made at each resource, as explained later. + Different paths are represented with different lines in the map editor. + 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 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 + based on their performance, but the total uses of this feature are limited + only by your imagination. +\layout Subsection + +Creating a Simple .page With The Simple Editor +\layout Standard -Click the -\series bold -Edit -\series default - button above the sample problem to enter edit mode. \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 302 -file numericalResponseEditor.eps +\begin_inset Figure size 476 250 +file mapSimpleEditor.eps width 3 80 flags 9 @@ -2325,123 +2698,491 @@ flags 9 \layout Caption -Numerical Response Editor -\begin_inset LatexCommand \label{Numerical Response Editor Figure} +Simple Map Editor +\begin_inset LatexCommand \label{Simple Map Editor} \end_inset \end_float - You should see the String Response editor page open up, which should look - something like what you see in figure -\begin_inset LatexCommand \ref{Numerical Response Editor Figure} +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 . -\layout Enumerate + +\layout Standard -Please refer to the CAPA manual for help with Numerical Response Problems. -\layout Comment +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 -Copout. - I need this info. +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 Formula Response -\begin_inset LatexCommand \index{Formula Response} +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 LatexCommand \label{Formula Response} +\begin_inset Figure size 476 205 +file mapAdvancedEditorNew.eps +width 3 80 +flags 11 \end_inset - Problems -\layout Standard -Formula Response problems are answered by entering a mathematical formula. - For instance, a numerical response problem might have an answer of -\begin_inset Formula \( x^{2}+11 \) +\layout Caption + +Initial Map Editor +\begin_inset LatexCommand \label{Initial Map Editor FIgure} + \end_inset -. - The answer may be in any equivalent format. - For instance, for -\begin_inset Formula \( x^{2}+11 \) + +\end_float +You should the initial map editor as seen in figure +\begin_inset LatexCommand \ref{Initial Map Editor FIgure} + \end_inset -, the system will accept -\begin_inset Formula \( x*x-11 \) +. + 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 - or -\begin_inset Formula \( x^{2}+21-10 \) + +\layout Caption + +Clicked Start in the Map Constructor +\begin_inset LatexCommand \label{Clicked Start Figure} + \end_inset - as well. -\layout Standard -To create an Formula Response problem, create a new resource as described - in section -\begin_inset LatexCommand \ref{Creating New Content Pages} +\end_float +Click the Start box. + You'll see what you see in figure +\begin_inset LatexCommand \ref{Clicked Start Figure} \end_inset . - This is a + Click \begin_inset Quotes eld \end_inset -problem +Link Resource \begin_inset Quotes erd \end_inset - resource so the URL must end in + in the secondary window, then click on the Finish box. +\begin_float fig +\layout Standard +\align center + +\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 -.problem +straighten \begin_inset Quotes erd \end_inset . - You should see a screen as in figure -\begin_inset LatexCommand \ref{Creating a new problem resource} + 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 -In the drop-down option box as seen in -\begin_inset LatexCommand \ref{Creating a new problem resource} +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 271 252 +file mapInsertResource.eps +height 3 30 +flags 9 \end_inset -, select + +\layout Caption + +Inserting a Resource +\begin_inset LatexCommand \label{Inserting a Resource Figure} + +\end_inset + + +\end_float +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 + +. + Click \series bold -Simple Formula Problem +Insert Resource Into Link \series default -, and click the +. + A new resource will appear in the link. + Click the resource. +\layout Enumerate + +Click \series bold -New Problem +Browse \series default - button. +, and the +\series bold +Network Directory Browser +\series default + will appear, +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 357 162 +file mapEditorDirectoryBrowser.eps +width 3 60 +flags 9 + +\end_inset + + +\layout Caption + +Network Directory Browser +\begin_inset LatexCommand \label{Map Editor Network Directory Browser Figure} + +\end_inset + + +\end_float + looking something like figure +\begin_inset LatexCommand \ref{Map Editor Network Directory Browser Figure} + +\end_inset + +. + Press the select button that is next to the resource you want to include. +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 42 252 +file mapEditorResourceChosen.eps +height 3 30 +flags 9 + +\end_inset + + +\layout Caption + +Resource Chosen +\begin_inset LatexCommand \label{Map Resource Chosen Figure} + +\end_inset + + +\end_float + Once you've done that, if you look back at the window that popped up when + you clicked on +\series bold +New Resource +\series default +, you'll see something like figure +\begin_inset LatexCommand \ref{Map Resource Chosen Figure} + +\end_inset + +. + You can type the +\series bold +URL +\series default + and +\series bold +Title +\series default + into the secondary window, if you prefer, following the format you see + above. + After you click +\series bold +Save Changes +\series default +, your changes will be saved, and the icons for the resource will appear + in the +\series bold +Res +\series default + box, as shown in figure +\begin_inset LatexCommand \ref{Map Resource Chosen Figure} + +\end_inset + +. +\begin_deeper +\layout Standard + +Clicking on the left icon for a resource will open a new browser window + with an informational page about that resource. + Clicking on the right icon for a resource will open a new browser window + taking you to the rendering of that resource. +\end_deeper \layout Enumerate -Click the +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 + +When you are done adding resources, click the \series bold -Edit +Save Map \series default - button above the sample problem to enter edit mode. + link to save the map. +\layout Standard + +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 + +The advanced editor has many more capabilities which you can explore. +\layout Subsection + +Creating Sequences +\begin_inset LatexCommand \index{Sequence} + +\end_inset + + +\layout Standard + +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 + +In order to view sequences, they need to be part of a +\series bold +course +\series default +. \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 302 -file numericalResponseEditor.eps +\begin_inset Figure size 238 231 +file creatingANewCourse.eps +width 3 40 +flags 9 + +\end_inset + + +\layout Caption + +Creating a New Course +\begin_inset LatexCommand \label{Creating a New Course Figure} + +\end_inset + + +\end_float + 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 +\begin_inset LatexCommand \index{Numerical Response} + +\end_inset + + +\begin_inset LatexCommand \label{Numerical Response} + +\end_inset + + And Formula Response Questions +\layout Standard + +Numerical Response problems are very powerful. + In fact, they are so powerful it would be impossible to fully explain what + 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 + knowledge necessary. + The more you learn, the more you will find you can do. +\layout Standard + +In this chapter and the next, I will use the terms +\series bold +static +\series default + and +\series bold +dynamic +\series default +. + +\series bold +Static +\series default + means the object never changes, and is the same for each student. + By contrast, +\series bold +dynamic +\series default + means the value can change, because there is some script that computes + it for each student. +\layout Standard + +If you like, you can follow this chapter along as its own tutorial. + Create a Numerical Response problem using the instructions in section +\begin_inset LatexCommand \ref{Creating New Content Pages} + +\end_inset + +, ending your resource name with +\begin_inset Quotes eld +\end_inset + +.problem +\begin_inset Quotes erd +\end_inset + +, and create a new +\series bold +Simple Numerical Response +\series default + problem. +\layout Subsection + +The Parts of a Numerical Response Problem +\layout Standard + +\begin_float fig +\layout Standard +\align center + +\begin_inset Figure size 476 356 +file numericalResponse1.eps width 3 80 flags 9 @@ -2450,142 +3191,726 @@ flags 9 \layout Caption -Numerical Response Editor +Numerical Response editor \begin_inset LatexCommand \label{Numerical Response Editor Figure} \end_inset \end_float - You should see the Formula Response editor page open up, which should look - something like what you see in figure +A Numerical Response problem has seven major parts by default, as seen in + figure \begin_inset LatexCommand \ref{Numerical Response Editor Figure} \end_inset +: +\layout Enumerate + +The +\series bold +Script +\series default . + The script is the heart of advanced Numerical Response problems. + It can be used to decide some of the parameters of the problem, compute + the answer to the problem, and do just about anything else you can imagine. + The Script language is +\series bold +Perl +\begin_float footnote +\layout Standard + +For lots and lots more information about Perl, see the Perl website at http://ww +w.perl.org/ . +\end_float +. + You do not need to know Perl to use the Script block, as we will be stepping + through some advanced examples in this chapter, but knowing Perl can help. \layout Enumerate -Please refer to the CAPA manual for help with Numerical Response Problems. -\layout Comment +Like other problem types, the +\series bold +Text Block +\series default + is used to display the problem the student will see. + In addition, you can place things in the +\series bold +Text Block +\series default + based on computations done in the +\series bold +Script +\series default +. +\layout Enumerate -Copout. - I need this info. -\layout Section +The +\series bold +Answer +\series default + is the answer the system is looking for. + This can also use parameters from the +\series bold +Script +\series default + block, allowing the answer to be computed dynamically. +\layout Enumerate -Publishing Your Course +A +\series bold +tolerance +\begin_inset LatexCommand \index{tolerance} + +\end_inset + + +\series default + parameter, which determines how closely the system will require the student + answer to be in order to count it correct. + For technical reasons, it is almost never a good idea to set this parameter + to zero +\begin_float footnote \layout Standard -In order to make the content you've created available for courses to use, - 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 - the metadata out as accurately as possible. -\layout Subsection +Computers can only approximate computations involving real numbers. + For instance, a computer's [decimal] answer to the simple problem +\begin_inset Formula \( \frac{1}{3} \) +\end_inset -What is Metadata? -\begin_inset LatexCommand \index{Metadata} + is +\begin_inset Quotes eld +\end_inset +0.33333333333333331 +\begin_inset Quotes erd \end_inset +. + It +\emph on +should +\emph default + be an infinite series of 3's, and there certainly shouldn't be a +\begin_inset Quotes eld +\end_inset -\begin_inset LatexCommand \label{What Is Metadata?} +1 +\begin_inset Quotes erd +\end_inset + in the answer, but no computer can represent an infinitely long, infinitely + detailed real number. + Therefore, for any problem where the answer is not a small integer, you + +\emph on +need +\emph default + to allow a tolerance factor, or the students will find it nearly impossible + to exactly match the computers idea of the answer. +\end_float +, though you may find the default too large for some problems. + There are two kinds of tolerance. + If there is some answer +\begin_inset Formula \( a \) \end_inset + and a tolerance +\begin_inset Formula \( t \) +\end_inset +, +\begin_deeper +\layout Enumerate + +an +\series bold +Absolute +\series default + tolerance +\begin_inset LatexCommand \index{absolute tolerance} + +\end_inset + + +\begin_inset LatexCommand \index{tolerance, absolute} + +\end_inset + + will take anything in the range +\begin_inset Formula \( a\pm t \) +\end_inset + +. + So if +\begin_inset Formula \( a=10 \) +\end_inset + + and +\begin_inset Formula \( t=2 \) +\end_inset + +, then anything between 8 and 12 is acceptable +\begin_float footnote +\end_deeper \layout Standard +For much the same reasons a tolerance is almost always a good idea, it's + almost impossible to say whether an answer that is +\emph on +exactly +\emph default + +\begin_inset Formula \( a\pm t \) +\end_inset + + will be accepted by the computer. + But the computer does use many decimal places of accuracy; if you want + to have the student answer exactly +\begin_inset Quotes eld +\end_inset + +2 +\begin_inset Quotes erd +\end_inset + +, then specifying a tolerance of +\begin_inset Quotes eld +\end_inset + +.0000001 +\begin_inset Quotes erd +\end_inset + is OK. + (Don't use too many more zeros, though you can use less if you like.) +\end_float +. + Any number in the tolerance field \emph on -Metadata +without \emph default - is + a +\series bold +% +\series default + symbol is an absolute tolerance. +\begin_deeper +\layout Enumerate + +a +\series bold +Relative +\series default + tolerance +\begin_inset LatexCommand \index{relative tolerance} + +\end_inset + + +\begin_inset LatexCommand \index{tolerance, relative} + +\end_inset + + will take anything in the range +\begin_inset Formula \( a\pm at \) +\end_inset + +, where \emph on -data about data +t +\emph default + is interpreted as a percentage. + Any number in the tolerance field +\emph on +followed by \emph default + a +\series bold +% +\series default + symbol is a relative tolerance. + For example, +\begin_inset Formula \( a=10 \) +\end_inset + + and +\begin_inset Formula \( t=10\% \) +\end_inset + + will accept anything between 9 and 11. + +\end_deeper +\layout Enumerate + +A +\series bold +significant figures +\series default + specification tells the system how many significant figures there are in + the problem, as either a single number or a range of acceptable values, + expressed as +\series bold +min,max +\series default . - Metadata can often be thought of as a label on some bit of information - that can be useful to people or computer programs trying to use the data. - Without metadata, the person or computer trying to use the original information - would have to just guess what the original data is about. - For instance, if you create a problem and neglect to say in the title or - subject of the problem what it is about, then a human who wants to use - that problem would have to read the problem itself to see what it was about, - which is much more difficult then just reading a title. - A computer trying to do the same thing would just be out of luck; it is - too stupid to understand the problem statement at all. + The system will check to make sure that the student's answer contains this + many significant digits, useful in many scientific calculations. + For example, if the problem has three significant digits, the significant + digit specification is +\begin_inset Quotes eld +\end_inset + +3 +\begin_inset Quotes erd +\end_inset + +, and the answer is +\begin_inset Quotes eld +\end_inset + +1.3 +\begin_inset Quotes erd +\end_inset + +, the system will require the students to type +\begin_inset Quotes eld +\end_inset + +1.30 +\begin_inset Quotes erd +\end_inset + +, even though numerically, +\begin_inset Quotes eld +\end_inset + +1.3 +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +1.30 +\begin_inset Quotes erd +\end_inset + + are the same. +\begin_deeper +\layout Comment + +Confirm this. +\end_deeper +\layout Enumerate + +The +\series bold +Single Line Text Entry +\series default + area, as in other problems, allow you to manipulate the text entry area + the student will see. +\layout Enumerate + +Finally, the +\series bold +Hint +\series default + provides a place to help students who get the problem incorrect the first + time. +\layout Subsection + +Simple Numerical Response Answer \layout Standard -One example of metadata you use all the time is the <TITLE> of a webpage, - 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. - 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. +Along with showing the Numerical Response editor, figure +\begin_inset LatexCommand \ref{Numerical Response Editor Figure} + +\end_inset + + also shows the parameters for one of the simplest possible types of numerical + response. + The +\series bold +Text Block +\series default + has the problem's question, which is the static text +\begin_inset Quotes eld +\end_inset + +What is 2 + 2? +\begin_inset Quotes erd +\end_inset + + The +\series bold +Answer +\series default + is +\begin_inset Quotes eld +\end_inset + +4 +\begin_inset Quotes erd +\end_inset + +. + The +\series bold +Hint +\series default + has been set to something appropriate for this problem (unless this problem + is being given to very young children). + Everything else has the default values from when the problem was created. +\layout Standard + +If you create a problem like this, hit +\series bold +Submit Changes +\series default +, then hit +\series bold +View +\series default + after the changes have been submitted, you can try the problem out for + yourself. + Note the last box in the HTML page has the answer LON-CAPA is looking for + conveniently displayed for you, along with the range the computer will + accept and the number of significant digits the computer requires. +\layout Standard + +As you're playing with the problem, if you use up all your tries or get + the answer correct but wish to continue playing with the problem, use the + +\series bold +Reset Submissions +\series default + button to clear your answer attempts. + \layout Subsection -Publishing A Resource -\begin_inset LatexCommand \index{Resource, Publishing} +Simple Script Usage +\layout Standard + +Totally static problems only scratch the surface of the Numerical Response + capabilities. + To really explore the power of LON-CAPA, we need to start creating dynamic + problems. + But before we can get to truly dynamic problems, we need to learn how to + work with the +\series bold +Script +\begin_inset LatexCommand \index{Script} \end_inset -\begin_inset LatexCommand \index{Publishing Resource} +\series default + window. +\layout Standard + +A script consists of several +\series bold +statements +\series default +, separated by +\series bold +semi-colons +\series default +. + A +\series bold +statement +\begin_inset LatexCommand \index{statement} \end_inset +\series default + is the smallest kind of instruction to the computer you can give. + Most problems will be built from several statements. + \layout Standard +A script can contain +\series bold +comments +\series default +, which are not interpreted as statements by the computer. + Comments start with +\series bold +# +\series default +, and go to the end of that line. + Thus, if a line starts with #, the whole line is ignored. + Comments can also begin in the middle of a line. + It is a good idea to comment more complicated scripts, as it can be very + difficult to read a large script and figure out what it does. + It is a +\emph on +very +\emph default + good idea to adopt some sort of commenting standard, especially if you + 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 +variable assignment +\series default +. + A +\series bold +variable +\series default + can hold any value in it. + Simple values, such as a number or a string of text, start with a +\series bold +$ +\series default +. + In the +\series bold +Script +\series default +, you need to assign to variables before you use them. + Put the program in Figure \begin_float fig -\layout Standard +\layout LyX-Code \align center +$variable = 3; +\layout Caption +\pextra_type 3 \pextra_widthp 40 -\begin_inset Figure size 476 168 -file constructionSpaceForPublishing.eps -width 3 80 -flags 9 +A simple script with a variable +\begin_inset LatexCommand \label{A simple script with a variable} \end_inset -\layout Caption +\end_float + +\begin_inset LatexCommand \ref{A simple script with a variable} -Construction Space for Publishing -\begin_inset LatexCommand \label{Construction Space for Publishing Figure} +\end_inset + into the +\series bold +Script +\series default + field of the Numerical Response. + This creates a simple variable named +\series bold +variable +\series default + and assigns it the value of +\begin_inset Quotes eld \end_inset +3 +\begin_inset Quotes erd +\end_inset + +. + That's one statement. +\layout Standard + +Variable names are +\emph on +case sensitive +\emph default +, must start with a letter, and can only consist of letters, numbers, and + underscores. + Variable names can be as long as you want. + +\layout Standard + +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 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 capitalize variables +\begin_float footnote +\layout Standard +The author favors +\family typewriter +capsOnNewWords +\family default +. + Some people use +\family typewriter +underscore_to_seperate_words +\family default +. + Many use uppercase letters to specify constants like +\family typewriter +PI +\family default + or +\family typewriter +GOLDEN_MEAN +\family default +. + Some people always +\family typewriter +StartWithCapatalization +\family default +. + What's really importent is to be consistent, so you don't have to guess + whether the variable you're thinking of is +\family typewriter +coefFriction +\family default +, +\family typewriter +CoefFriction +\family default +, +\family typewriter +COEF_FRICTION +\family default +, or something else. \end_float -To publish a resource, log in and choose your role to be an Author. - Then click +. + It is a good idea to adopt a standard. + If you are working with a group, you may wish to discuss it in your group + and agree on a convention. + +\layout Standard + +If you \series bold -CSTR +Submit Changes \series default - to go to your construction space. - You should see something like figure -\begin_inset LatexCommand \ref{Construction Space for Publishing Figure} + and +\series bold +View +\series default + the problem, you'll see nothing has changed. + That's because in order for a variable to be useful, it must be used. + The variable can be used in several places. +\layout Subsubsection + +Variables in Scripts +\layout Standard + +Variables can be used later in the same script. + For instance, we can add another line below the +\family typewriter +$variable +\family default + line as such: +\layout LyX-Code + +$variable2 = $variable + 2; +\layout Standard + +Now there is a variable called +\family typewriter +$variable2 +\family default + with the the number +\begin_inset Quotes eld +\end_inset +5 +\begin_inset Quotes erd +\end_inset + + as its value. + +\layout Standard + +Variables can also be used in +\emph on +strings +\emph default + +\begin_inset LatexCommand \index{strings} + +\end_inset + +, which are a sequence of letters. + The underlying language of the script, Perl, has a very large number of + ways of using variables in strings, but the easiest and most common way + is to use normal double-quotes and just spell out the name of the variable + you want to use in the string, like this: +\layout LyX-Code + +$stringVar = +\begin_inset Quotes eld +\end_inset + +I have a variable with the value $variable. +\begin_inset Quotes erd +\end_inset + + +\layout Standard + +This will put the string +\begin_inset Quotes eld +\end_inset + +I have a variable with the value 3. +\begin_inset Quotes erd +\end_inset + + into the variable named +\begin_inset Quotes eld +\end_inset + +stringVar +\begin_inset Quotes erd \end_inset . - Click on the +\layout Standard + +If you are following this chapter as a tutorial, add the previous two lines + and save the problem. + There's no need to view it; there's still no visible change. +\layout Subsubsection + +Variables in the Text Block +\layout Standard + +Once you've defined variables in the \series bold -Publish +Script \series default - button for the resource you wish to publish. +, you can use them in the +\series bold +Text Block +\series default +. + For example, using the previous three-line script we've created so far, + you can place the following in the +\series bold +Text Block +\series default +: +\layout LyX-Code + +See the 3: $variable<br /> +\layout LyX-Code + +See the string: <b>$stringVar</b><br /> +\layout Standard + \begin_float fig \layout Standard \align center -\begin_inset Figure size 476 338 -file publishMetadata.eps -width 3 80 +\begin_inset Figure size 353 99 +file numericalResponseVarInText.eps flags 9 \end_inset @@ -2593,183 +3918,832 @@ flags 9 \layout Caption -Publishing Metadata Screen -\begin_inset LatexCommand \label{Publishing Metadata Screen Figure} +Result of Variables in the Text Block +\begin_inset LatexCommand \label{Result of Variables in the Text Block Figure} \end_inset \end_float - You'll get a metadata screen that should look something like figure -\begin_inset LatexCommand \ref{Publishing Metadata Screen Figure} +If you save that and hit +\series bold +View +\series default +, you should get what you see in figure +\begin_inset LatexCommand \ref{Result of Variables in the Text Block Figure} \end_inset . - Fill out the form. - If you are creating resources that may be used in several courses, you - should talk with the other authors and establish some sort of standard - title and subject scheme in advance. - + Note how the +\begin_inset Quotes eld +\end_inset + +$variable +\begin_inset Quotes erd +\end_inset + + was turned into a 3, and the +\begin_inset Quotes eld +\end_inset + +$stringVar +\begin_inset Quotes erd +\end_inset + + was turned into +\begin_inset Quotes eld +\end_inset + +I have a variable with the value 3. +\begin_inset Quotes erd +\end_inset + + +\layout Subsubsection + +Variables in the Answer Block \layout Standard -The language is the language the problem is written in. - The Publisher/Owner is the person who owns the problem; it should be the - email address where anybody with questions about the resource can contact - someone who can help them. - In smaller environments, this is likely to be the author. - In larger environments, it may be a coordinator or manager. +You can use variables in the +\series bold +Answer +\series default + part of the question, too. + This means you can compute an answer to a question, which we'll see in + a bit. + If you set the answer of the question to be +\begin_inset Quotes eld +\end_inset + +$variable +\begin_inset Quotes erd +\end_inset + + (without the quotes), +\series bold +Save Changes +\series default + and +\series bold +View +\series default + it, you'll see that LON-CAPA is now expecting +\begin_inset Quotes eld +\end_inset + +3 +\begin_inset Quotes erd +\end_inset + + as the answer, plus or minus 5%. +\layout Subsection + +Calling Functions \layout Standard -The +With variables, you can store strings or numbers. + \series bold -Keywords +Functions \series default - and the + 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 -Abstract +Script \series default - are more information about the problem. + 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 +\begin_inset LatexCommand \index{Randomization} + +\end_inset + + +\layout Standard + +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 -Keywords +Script \series default - are words that are strongly connected to your problem; for instance a physics - problem about a pulley might include + 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 -pulley +What is $a plus $b? \begin_inset Quotes erd \end_inset - as a key word. - LON-CAPA pulls out likely-looking keywords for you so you can just click - on them to make them keywords. - +, and in the \series bold -Additional keywords +Answer \series default - allows you to add any keyword to your problem that are not actually in - the problem. - For instance, on that same problem a physicist might add the keyword + put \begin_inset Quotes eld \end_inset -statics +$answer \begin_inset Quotes erd \end_inset -, even though it doesn't appear in the original problem, because Physics - uses that as a classification of problem type. +, 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 -Finally, you need to set the copyright and distribution notice. - This setting controls who is allowed to use your resource. +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 + +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 Itemize +\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 -Limited to courses in the domain published +Unit \series default - means that only courses running in the same domain as you can use your - content. - Talk to your LON-CAPA administrator if you want more information about - your domain. -\layout Itemize + 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 -Free +Format \series default - means that anyone can find and use the resource. -\layout Itemize + 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 +\layout Standard + +It's always a good idea to look at other people's LON-CAPA problems, especially + those from the same discipline as your problems, and see what they are + doing. + \series bold -Private - visible to author only +Very often, the easiest way to create a new problem is to copy it and modify + the copy until it does what you need. + \series default - means that it can't be used for any course. -\layout Itemize + The more complicated a problem is, the more time you'll save by doing this. + 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. + 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 -Public - no authentication required +EditXML \series default - means anyone can find and use the resource. + 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 -Now when you click +\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 + +, 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 -Finalize Publication +Sample Points \series default -, your resource will be published and usable (unless you set the distribution - to + +\begin_inset LatexCommand \index{Sample Points} + +\end_inset + + field. + The sampling specifications takes the following format: +\layout Itemize + +A comma seperated list of the variables you wish to interpret, +\layout Itemize + +followed by \begin_inset Quotes eld \end_inset -private +@ \begin_inset Quotes erd \end_inset -). -\layout Section + (not in quotes), +\layout Itemize -Things That Need To Be Added -\layout Subsection +followed by any number of the following two things, separated by semi-colons: +\begin_deeper +\layout Enumerate -LON-CAPA and Units -\layout Subsection +a comma separated list of as many numbers as there are variables, which + specifies one sampling point, OR +\layout Enumerate -Creating a default metadata file -\layout Subsection +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 -Detailed number problem info -\layout Subsection +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 -Detailed formula problem info -\layout Subsection +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 Quotes eld +\end_inset + +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 + + +\begin_inset Quotes eld +\end_inset + +x@1:5#4;10 +\begin_inset Quotes erd +\end_inset + + will take 4 samples from somewhere between 1 and 5, and also sample at + 10. +\layout Standard + +For +\begin_inset Formula \( 2x^{2}+3y^{3} \) +\end_inset -My questions\SpecialChar \ldots{} +, which has two variables, one could specify +\layout Itemize + + +\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 @@ -2783,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