damieng damieng at source.lon-capa.org
Mon Jan 23 15:29:42 EST 2017

damieng		Mon Jan 23 20:29:42 2017 EDT

Authoring_StringResponse.tex

Modified files:
Author_LON-CAPA_Introduction.tex
Authoring_Equations.tex
Authoring_Foil_Structure_Tags.tex
Authoring_ImageResponse.tex
Authoring_NumericalResponse.tex
Authoring_OptionResponse.tex
Authoring_Output_Tags.tex
Creating_Formula_Response.tex
Creating_Math_Response_Problems.tex
Custom_Response_Problem_Creation.tex
Custom_Response_Problems.tex
Function_Plot_Response_Overview.tex
Function_Plot_Response_Question.tex
Math_Response_Problems.tex
Option_Response_Problem_Creation.tex
String_Response_Problem_Creation.tex
Log:
doc improved for editors, responses, index

-------------- next part --------------
@@ -1,4 +1,4 @@

Numerical Response problems are answered by entering a number and an optional
unit. For instance, a numerical response problem might have an answer of
--- loncom/html/adm/help/tex/Author_LON-CAPA_Introduction.tex:1.14	Fri Jan 20 22:06:05 2017
+++ loncom/html/adm/help/tex/Author_LON-CAPA_Introduction.tex	Mon Jan 23 20:29:42 2017
@@ -59,7 +59,7 @@
\begin{itemize}
\item The \emph{plain text editor} is simply a text area that lets you edit the source code directly. It lacks any special feature, but can be useful for people with disabilities because it is supported by screen readers. To use it, CodeMirror must be disabled in the preferences, in the \emph{Authoring Space Configuration} section.
\item \emph{CodeMirror} is a text editor, and it is launched when you click on the EditXML'' button. It lets you edit the source code directly, but adds syntax highlighting and templates to help with editing the code.
-\item \emph{CKEditor} is a simple WYSIWYG HTML editor used in LON-CAPA to edit blocks of plain text or HTML. It is used when you click on the Edit'' button for a \texttt{.html} file and click on Rich formatting''. It can also be used within the colorful editor to edit blocks of text, also by clicking on the Rich formatting'' link.
+\item \emph{CKEditor} is a simple WYSIWYG HTML editor used in LON-CAPA to edit blocks of plain text or HTML. It is used when you click on the Edit'' button for a \texttt{.html} file and click on Rich formatting''. It can also be used within the colorful editor to edit blocks of text, also by clicking on the Rich formatting'' link. CKEditor is just an HTML editor, and it does not support LON-CAPA elements well, with the exception of \texttt{<m>} and \texttt{<chem>}, for which plugins have been added.
\item The \emph{colorful editor} is LON-CAPA's default editor, launched when you click on the Edit'' button for a \texttt{.problem} file. It hides the source code and displays the document with colored boxes representing the elements. It provides a list of elements that can be inserted at a particular place in the document, helps to choose correct values when several values are possible for an attribute, and generally makes sure the syntax is correct.
\item \emph{Daxe} is a new editor, meant to replace the colorful editor in the future. It is started with the Daxe'' button. Like the colorful editor, it hides the source code and provides a graphical interface which makes it easier to create documents without knowing the language. It displays elements in a better way, and makes it easier to edit documents with cut/copy/paste and drag \& drop features. HTML elements are often displayed exactly the way they look like in the end. Many response elements have both a simple'' and an advanced'' view, making it easy to create simple problems. A preview is available to the right, making it easy to see what the entire document will look like.
\end{itemize}
--- loncom/html/adm/help/tex/Authoring_Equations.tex:1.1	Thu Dec 29 01:57:13 2016
+++ loncom/html/adm/help/tex/Authoring_Equations.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Authoring_Equations}
+\label{Authoring_Equations}\index{equations}

\index{Latex}\index{tex}\index{math equations}LON-CAPA renders math using LaTeX. LaTeX can be entered directly as described below or the LaTeX can be generated using the DragMath math editor. Some LON-CAPA editors provide an Edit Math' menu button.  To use DragMath, after inserting the cursor in the desired equation location, the Edit Math' button launches a pop-up window
containing the DragMath equation editor (which requires Java plugin support in the user's
--- loncom/html/adm/help/tex/Authoring_Foil_Structure_Tags.tex:1.1	Tue Jun 10 19:29:26 2003
+++ loncom/html/adm/help/tex/Authoring_Foil_Structure_Tags.tex	Mon Jan 23 20:29:42 2017
@@ -1,12 +1,12 @@
\label{Authoring_Foil_Structure_Tags}

-All tags that implement a foil structure have an optional arg of \emph{max}
+All response tags that implement a foil structure have an optional arg of \emph{max}
that controls the maximum number of total foils to show.

\begin{itemize}
\item \textbf{foilgroup}\index{foilgroup}: required. Must surround all
-foil definitions.
+foil definitions. Only the optionresponse foilgroup can have attributes.
\item \textbf{foil}\index{foil}: required. The foil is defined by what
is delimited by the \textbf{foil} tag.
\item \textbf{conceptgroup}\index{conceptgroup}: optional. Surrounds a
--- loncom/html/adm/help/tex/Authoring_ImageResponse.tex:1.3	Wed Oct 18 22:20:19 2006
+++ loncom/html/adm/help/tex/Authoring_ImageResponse.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Authoring_ImageResponse}
+\label{Authoring_ImageResponse}\index{imageresponse}

\textbf{imageresponse} implements a image-click answer. \textbf{imageresponse}
tags should contain a \textbf{foilgroup} tag, which contain \textbf{foil}
@@ -21,3 +21,9 @@
before the image is shown on the screen. This text is typically used
to describe to the student what they are expected to click on.
\end{itemize}
+
+Possible attributes for \texttt{<imageresponse>} are:
+\begin{itemize}
+  \item \textbf{max}: the maximum number of foils displayed at once
+  (if more are specified, some will not be displayed)
+\end{itemize}
--- loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.3	Tue Nov 29 20:35:08 2016
+++ loncom/html/adm/help/tex/Authoring_NumericalResponse.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Authoring_NumericalResponse}
+\label{Authoring_NumericalResponse}\index{numericalresponse}

it needs an internal \textbf{textline} for the the response to go in.
@@ -8,4 +8,7 @@
answer, may be either a perl list or scalar
\item \textbf{unit}\index{unit}: optional, specifies unit of correct answer, CAPA style
+\item \textbf{incorrect}: Incorrect Answers. When switched into exam (bubble sheet'') mode, LON-CAPA usually create wrong answers automatically. To specify wrong answers yourself, you need to provide an array of incorrect values in this attribute. You need to provide at least as many incorrects as 1 less than the number of bubbles on the exam. You can provide more if you want to.
+\item \textbf{format}: string to format the number displayed as the answer
+\item \textbf{preprocess}: pre-process Perl subroutine
\end{itemize}
--- loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.3	Tue Aug  7 22:46:54 2007
+++ loncom/html/adm/help/tex/Authoring_OptionResponse.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Authoring_OptionResponse}
+\label{Authoring_OptionResponse}\index{optionresponse}

\textbf{optionresponse} implements a {}select from these choices''
style question. The choices are specified by the instructor and use
@@ -9,3 +9,11 @@
\item \textbf{foilgroup}: required to have an \emph{options} attribute which
should be a perl list of possible options for the student.
\end{itemize}
+
+Possible attributes for \texttt{<optionresponse>} are:
+\begin{itemize}
+  \item \textbf{max}: the maximum number of foils displayed at once
+  (if more are specified, some will not be displayed)
+  \item \textbf{randomize}: set to \texttt{yes} to randomize the order of foils when displayed
+  \item \textbf{TeXlayout}: set to \texttt{horizontal} to display foils horizontally for printing
+\end{itemize}
--- loncom/html/adm/help/tex/Authoring_Output_Tags.tex:1.24	Sat Jan 21 00:02:05 2017
+++ loncom/html/adm/help/tex/Authoring_Output_Tags.tex	Mon Jan 23 20:29:42 2017
@@ -148,7 +148,7 @@
When printing, the included text will be rendered in a visible box.

-\item \textbf{m}\index{m}: The inside text is \LaTeX{}, and is converted
+\item \textbf{m}\index{m}\index{equations}: The inside text is \LaTeX{}, and is converted
to HTML (or MathML) on the fly. The default is to convert
to the display mechanism that the user has selected in preferences. This can be
overriden by setting the attribute \textbf{display} to one of
@@ -178,7 +178,7 @@
\\$b may take on.

-\item \textbf{lm}\index{lm}: This is another way to input math, which does not require
+\item \textbf{lm}\index{lm}\index{equations}: This is another way to input math, which does not require
knowing \LaTeX{}.
The lm syntax describes mathematical operations rather than appearance (as opposed to LaTeX, which describes how the math should appear). Display is the same when the math operations are the same, for instance 2*(x) will be displayed just like 2x. One advantage to that system is that math will be displayed in a consistent way, even when written by several authors. The drawback is that display cannot be chosen precisely.
Eventually, this syntax will also be used to evaluate \texttt{<formularesponse>} (it is already used for the real-time preview).
@@ -288,9 +288,9 @@

\item \textbf{problemtype}\index{problemtype}: This tag allows you to show or hide output based on what the problem-type parameter is set to in the course. For example: \begin{verbatim}
<problemtype mode="show" for="exam,survey">
-<startouttext />
-The formula for the circumference of a circle is 2*pi*r
-<endouttext />
+  <startouttext />
+  The formula for the circumference of a circle is 2*pi*r
+  <endouttext />
</problemtype>
\end{verbatim}
Will only show the output text when the problem is set to the type of exam or survey in the course.  The attribute for mode can be set to show or hide.  The attribute for for can be problem, exam, survey, or practice.
@@ -1,7 +1,17 @@

\textbf{radiobuttonresponse} implements a true/false question with
one correct answer. It uses the foil structure tags as described in
\ref{Authoring_Foil_Structure_Tags}, but the \emph{value} of a foil can only
be \textbf{true}, \textbf{false}, or \textbf{unused}.
+It is possible to use a Perl variable for the value attribute, as long as it can only have a valid value.

+Several true foils can be specified, but only one (randomly chosen) will be displayed.
+
+\begin{itemize}
+  \item \textbf{max}: the maximum number of foils displayed at once
+  (if more are specified, some will not be displayed)
+  \item \textbf{randomize}: set to \texttt{yes} to randomize the order of foils when displayed
+  \item \textbf{direction}: set to \texttt{horizontal} to display foils horizontally
+\end{itemize}
--- loncom/html/adm/help/tex/Creating_Formula_Response.tex:1.2	Fri Jul  5 18:30:40 2013
+++ loncom/html/adm/help/tex/Creating_Formula_Response.tex	Mon Jan 23 20:29:42 2017
@@ -1,6 +1,6 @@
\label{Creating_Formula_Response}

-\index{Formula Response, Creating}\label{Formula Response, Creating}
+\index{Formula Response}\label{Formula Response, Creating}
%
\begin{figure}
\begin{center}\includegraphics[  width=0.80\paperwidth]{formulaResponse}\end{center}
--- loncom/html/adm/help/tex/Creating_Math_Response_Problems.tex:1.5	Tue Jan 17 02:58:48 2017
+++ loncom/html/adm/help/tex/Creating_Math_Response_Problems.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Creating_Math_Response_Problems}
+\label{Creating_Math_Response_Problems}\index{Math Response}

Math response problems use a cas system to evaluate the student response. Which computer algebra system is to
be used is specified in the cas argument of the mathresponse tag; both Maxima and R are supported. Maxima and R
@@ -1,4 +1,4 @@

as described in section \ref{Creating_Content_Overview}. This is a {}problem''
@@ -52,4 +52,22 @@
be marked \textbf{true}, but only one will be shown to any given student.
If it is set to \textbf{false}, it will be considered an incorrect answer.
If it is set to \textbf{Unused}, the system will not use that foil.
+\\ \\
+\begin{verbatim}
+  <foilgroup>
+    <foil location="random" value="true" name="right1">
+      <startouttext />This is the right answer.<endouttext />
+    </foil>
+    <foil location="random" value="false" name="wrong1">
+      <startouttext />This is the first wrong answer.<endouttext />
+    </foil>
+    <foil location="random" value="false" name="wrong2">
+      <startouttext />This is the second wrong answer.<endouttext />
+    </foil>
+  </foilgroup>
+\end{verbatim}

--- loncom/html/adm/help/tex/Custom_Response_Problem_Creation.tex:1.6	Sat Aug 20 17:48:11 2016
+++ loncom/html/adm/help/tex/Custom_Response_Problem_Creation.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Custom_Response_Problem_Creation}
+\label{Custom_Response_Problem_Creation}\index{Custom Response}
Custom Response is a way to have a problem graded based on an algorithm. The use of this response type is
generally discouraged, since the responses will not be analyzable by the LON-CAPA statistics tools.

--- loncom/html/adm/help/tex/Custom_Response_Problems.tex:1.7	Wed Jun 26 08:14:55 2013
+++ loncom/html/adm/help/tex/Custom_Response_Problems.tex	Mon Jan 23 20:29:42 2017
@@ -1,2 +1,2 @@
-\label{Custom_Response_Problems}
+\label{Custom_Response_Problems}\index{Custom Response}
Custom Response is a way to have a problem graded based on an algorithm constructed in the perl script. The use of this response type is generally discouraged, since the responses will not be analyzable by the LON-CAPA statistics tools.
--- loncom/html/adm/help/tex/Function_Plot_Response_Overview.tex:1.2	Mon Sep  9 20:47:04 2013
+++ loncom/html/adm/help/tex/Function_Plot_Response_Overview.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Function_Plot_Response_Overview}
+\label{Function_Plot_Response_Overview}\index{Function Plot Response}

A \textbf{Function Plot Response} problem requires that the student create a plot that matches specified criteria. Examples can be functions that have certain slopes, curvature, maxima or minima at specified independent coordinate values. The students create their answer by dragging the curves and adjusting the slopes.

--- loncom/html/adm/help/tex/Function_Plot_Response_Question.tex:1.2	Wed Jun 26 08:14:55 2013
+++ loncom/html/adm/help/tex/Function_Plot_Response_Question.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Function_Plot_Response_Question}
+\label{Function_Plot_Response_Question}\index{Function Plot Response}

Creating a \textbf{Function Plot Response} problem involves several steps. This section introduces the major settings and subsequent sections cover other details.

--- loncom/html/adm/help/tex/Math_Response_Problems.tex:1.4	Wed Jun 26 08:14:55 2013
+++ loncom/html/adm/help/tex/Math_Response_Problems.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Math_Response_Problems}
+\label{Math_Response_Problems}\index{Math Response}

Math Response is a way to have a problem graded based on an algorithm that is executed inside of a
computer algebra system based on an algorithm written by the problem author. It is extremely powerful,
--- loncom/html/adm/help/tex/Option_Response_Problem_Creation.tex:1.4	Wed Jun 26 08:14:55 2013
+++ loncom/html/adm/help/tex/Option_Response_Problem_Creation.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{Option_Response_Problem_Creation}
+\label{Option_Response_Problem_Creation}\index{Option Response}

To create an Option Response problem, create a new resource as described
in section \ref{Creating_Content_Overview}. This is a {}problem'' resource
@@ -1,5 +1,4 @@
-of foils with buttons. The student can select \emph{one} of
+of foils with radio buttons. The student can select \emph{one} of
these statements by clicking the appropriate radio button.
-
--- loncom/html/adm/help/tex/String_Response_Problem_Creation.tex:1.6	Fri Jul  5 18:30:40 2013
+++ loncom/html/adm/help/tex/String_Response_Problem_Creation.tex	Mon Jan 23 20:29:42 2017
@@ -1,4 +1,4 @@
-\label{String_Response_Problem_Creation}
+\label{String_Response_Problem_Creation}\index{String Response}

To create a \textbf{String Response} problem, create a new resource (described in
\ref{Creating_Online_Problems}. This is a {}problem'' resource

\label{Authoring_MatchResponse}\index{matchresponse}

\textbf{matchresponse} queries for matches betweens items from two lists.
It is also possible to query for matches with optionresponse,
but optionresponse only accepts simple text for the matches.
With matchresponse, it is possible to use anything as a match,
such as equations, images, plots, or long styled texts.

The \texttt{foilgroup} must contain an \texttt{itemgroup} with \texttt{item} elements.

Possible attributes are:
\begin{itemize}
\item \textbf{max}: the maximum number of foils displayed at once
\item \textbf{randomize}: set to \texttt{yes} to randomize the order of foils when displayed
\end{itemize}

\label{Authoring_StringResponse}\index{stringresponse}

\textbf{stringresponse} queries for a string without any initial constraint.

Possible attributes are:
\begin{itemize}
\item \textbf{type}: specifies how the string is checked (like the CAPA styles). Possible values are:
\begin{description}
\item[cs]: case sensitive, order important
\item[ci]: case insensitive, order important
\item[mc]: case insensitive, order unimportant
\item[re]: regular expression
\end{description}