[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_ImageResponse.tex Authoring_NumericalResponse.tex Authoring_OptionResponse.tex Authoring_RadiobuttonResponse.tex Authoring_RankResponse.tex Authoring_StringResponse.tex Authoring_XML_Intro.tex
damieng
damieng at source.lon-capa.org
Tue Jan 24 14:26:27 EST 2017
damieng Tue Jan 24 19:26:27 2017 EDT
Modified files:
/loncom/html/adm/help/tex Authoring_ImageResponse.tex
Authoring_NumericalResponse.tex
Authoring_OptionResponse.tex
Authoring_RadiobuttonResponse.tex
Authoring_RankResponse.tex
Authoring_StringResponse.tex
Authoring_XML_Intro.tex
Log:
misc minor edits in authoring doc
Index: loncom/html/adm/help/tex/Authoring_ImageResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_ImageResponse.tex:1.4 loncom/html/adm/help/tex/Authoring_ImageResponse.tex:1.5
--- loncom/html/adm/help/tex/Authoring_ImageResponse.tex:1.4 Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_ImageResponse.tex Tue Jan 24 19:26:27 2017
@@ -22,7 +22,7 @@
to describe to the student what they are expected to click on.
\end{itemize}
-Possible attributes for \texttt{<imageresponse>} are:
+Possible attributes for \textbf{imageresponse} are:
\begin{itemize}
\item \textbf{max}: the maximum number of foils displayed at once
(if more are specified, some will not be displayed)
Index: loncom/html/adm/help/tex/Authoring_NumericalResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.4 loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.5
--- loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.4 Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_NumericalResponse.tex Tue Jan 24 19:26:27 2017
@@ -3,12 +3,14 @@
\textbf{numericalresponse} implements a numerical answer,
it needs an internal \textbf{textline} for the the response to go in.
It checks all styles of numerical supported in CAPA.
+The answer can be specified with the \textbf{answer} attribute or with an \textbf{answergroup}.
+
Possible attributes are:
\begin{itemize}
-\item \textbf{answer}\index{answer}: required, specifies the correct
-answer, may be either a perl list or scalar
+\item \textbf{answer}\index{answer}: specifies the correct 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
+\item \textbf{format}: string to format the number displayed as the answer. See \textbf{num} in \ref{Authoring_Output_Tags} for examples.
+\item \textbf{preprocess}: optional, pre-process Perl subroutine
\end{itemize}
Index: loncom/html/adm/help/tex/Authoring_OptionResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.4 loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.5
--- loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.4 Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_OptionResponse.tex Tue Jan 24 19:26:27 2017
@@ -10,7 +10,7 @@
should be a perl list of possible options for the student.
\end{itemize}
-Possible attributes for \texttt{<optionresponse>} are:
+Possible attributes for \textbf{optionresponse} are:
\begin{itemize}
\item \textbf{max}: the maximum number of foils displayed at once
(if more are specified, some will not be displayed)
Index: loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.4 loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.5
--- loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.4 Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex Tue Jan 24 19:26:27 2017
@@ -8,7 +8,7 @@
Several true foils can be specified, but only one (randomly chosen) will be displayed.
-Possible attributes for \texttt{<radiobuttonresponse>} are:
+Possible attributes for \textbf{radiobuttonresponse} are:
\begin{itemize}
\item \textbf{max}: the maximum number of foils displayed at once
(if more are specified, some will not be displayed)
Index: loncom/html/adm/help/tex/Authoring_RankResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_RankResponse.tex:1.1 loncom/html/adm/help/tex/Authoring_RankResponse.tex:1.2
--- loncom/html/adm/help/tex/Authoring_RankResponse.tex:1.1 Tue Jan 24 18:14:47 2017
+++ loncom/html/adm/help/tex/Authoring_RankResponse.tex Tue Jan 24 19:26:27 2017
@@ -3,8 +3,8 @@
\textbf{rankresponse} asks to sort a list of items in the right order.
The foils \textbf{value} attribute is a number used to specify the correct order.
If two items are equivalent, ranking is done in the same way as it is done for sports events.
-Say that there are two second places, then the ranking is "1 2 2 4 5 6".
-For three second places, the correct ranking is "1 2 2 2 5 6".
+Say that there are two second places, then the ranking is ``1 2 2 4 5 6''.
+For three second places, the correct ranking is ``1 2 2 2 5 6''.
\\ \\
Possible attributes are:
\begin{itemize}
Index: loncom/html/adm/help/tex/Authoring_StringResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.1 loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.2
--- loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.1 Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_StringResponse.tex Tue Jan 24 19:26:27 2017
@@ -5,7 +5,8 @@
Possible attributes are:
\begin{itemize}
\item \textbf{answer}: the correct answer, either a perl list or scalar
- \item \textbf{type}: specifies how the string is checked (like the CAPA styles). Possible values are:
+ \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
@@ -13,5 +14,5 @@
\item[re]: regular expression
\end{description}
\item \textbf{answerdisplay}: string to display for answer
- \item \textbf{preprocess}: pre-process Perl subroutine
+ \item \textbf{preprocess}: optional, pre-process Perl subroutine
\end{itemize}
Index: loncom/html/adm/help/tex/Authoring_XML_Intro.tex
diff -u loncom/html/adm/help/tex/Authoring_XML_Intro.tex:1.2 loncom/html/adm/help/tex/Authoring_XML_Intro.tex:1.3
--- loncom/html/adm/help/tex/Authoring_XML_Intro.tex:1.2 Fri Feb 18 20:41:10 2005
+++ loncom/html/adm/help/tex/Authoring_XML_Intro.tex Tue Jan 24 19:26:27 2017
@@ -1,11 +1,19 @@
\label{Authoring_XML_Intro}
-It is assumed that the reader is already familiar with the basic terminology
-of XML. If not, it is recommended that you read http://www.w3schools.com/xml/xml\_syntax.asp
-to acquire a basic understanding of how to read and write XML.
+LON-CAPA uses a syntax similar to XML and HTML.
+Here are some basic style guides if you do not know the syntax:
+%NOTE: the _ cannot be copy-pasted from the PDF, it would require using \usepackage[T1]{fontenc}
+\begin{description}
+\item[XML] \texttt{http://www.w3schools.com/xml/xml\_syntax.asp}
+\item[HTML] \texttt{http://www.w3schools.com/html/html5\_syntax.asp}
+\end{description}
-LON-CAPA uses a very simple subset of XML and there is a lot you do
+Compared to the XML syntax, the LON-CAPA language does not require a prolog at the beginning, and does not require encoding special characters within script elements.
+
+Compared to the HTML syntax, the LON-CAPA language does not require a DOCTYPE, but requires closing all elements. Problem documents do not use the html and body tags. Aside from that, most HTML elements can be used in LON-CAPA documents.
+
+LON-CAPA uses a very simple subset of the XML syntax and there is a lot you do
\emph{not} need to know, including but not limited to: CDATA, DTDs,
namespaces, and stylesheets. If you search for XML resources on the
Internet yourself, you do not need to read about those things to learn
-how LON-CAPA uses XML for problems.
+how LON-CAPA uses XML/HTML for problems.
More information about the LON-CAPA-cvs
mailing list