[prev in list] [next in list] [prev in thread] [next in thread] 

List:       lon-capa-cvs
Subject:    [LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_CustomResponse.tex Authoring_Equations.tex
From:       damieng <damieng () source ! lon-capa ! org>
Date:       2017-02-01 21:18:43
Message-ID: cvsdamieng1485983923 () cvsserver
[Download RAW message or body]

This is a MIME encoded message


damieng		Wed Feb  1 21:18:43 2017 EDT

  Added files:                 
    /loncom/html/adm/help/tex	Authoring_CustomResponse.tex 
                             	Authoring_EssayResponse.tex 
                             	Authoring_OrganicResponse.tex 
                             	Authoring_ReactionResponse.tex 

  Modified files:              
    /loncom/html/adm/help/tex	Authoring_Equations.tex 
                             	Authoring_FormulaResponse.tex 
                             	Authoring_NumericalResponse.tex 
                             	Authoring_OptionResponse.tex 
                             	Authoring_Output_Tags.tex 
                             	Authoring_RadiobuttonResponse.tex 
                             	Authoring_StringResponse.tex 
                             	Creating_New_Content_Pages.tex 
  Log:
  added doc for math, chem, hints, customresponse, essayresponse, organicresponse, reactionresponse
  
["damieng-20170201211843.txt" (text/plain)]

Index: loncom/html/adm/help/tex/Authoring_Equations.tex
diff -u loncom/html/adm/help/tex/Authoring_Equations.tex:1.2 \
                loncom/html/adm/help/tex/Authoring_Equations.tex:1.3
--- loncom/html/adm/help/tex/Authoring_Equations.tex:1.2	Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_Equations.tex	Wed Feb  1 21:18:43 2017
@@ -1,13 +1,20 @@
 \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
-browser).  Math templates are provided for basic mathematical expressions. At the \
                bottom of the DragMath pop-up is a ``Render LaTeX'' button that
-will insert the DragMath expression as LaTeX within \texttt{$<$m$>$\$ \$$<$/m$>$} \
tags in the original file editor window. +\index{Latex}\index{tex}\index{math \
equations}LON-CAPA renders math using LaTeX, +and the LaTeX syntax is usually used to \
create equations (see \textbf{lm} in \ref{Authoring_Output_Tags} for an alternative). \
+ +LaTeX equations can be entered directly in the source with the text editor,
+within \texttt{<m>\$~\$</m>} tags. When the browser has support for Java applets,
+the DragMath editor can also be used to generate LaTeX.
+To start DragMath in the text editor, insert the cursor at the desired equation \
location and click on the `Edit Math' button. +At the bottom of the DragMath pop-up \
is a `Render LaTeX' button that will insert the DragMath expression as LaTeX within \
\texttt{<m>\$ \$</m>} tags in the text.  
 The DragMath editor may not offer the template that you need, or the expression may \
not appear as you expect. The most powerful method of entering math or touching up \
DragMath output is to learn about the LaTeX syntax. An Internet search for ``LaTeX \
math quick reference'' will result in many resources.  
-Within the \texttt{$<$m$>$} tag, additional tags control the display of LaTeX math. \
The \$ open and closing syntax will create an inline equation. To create an equation \
in a separate paragraph, use double signs, \$\$. Alternative notations are also \
accepted, \textbackslash{}( opening with \textbackslash{}) closing can be used for an \
inline equation, and \textbackslash{}[ opening with \textbackslash{}] closing results \
in a separate paragraph. The \$ and \$\$ methods are recommended as ``LaTeX robust'' \
and the \textbackslash{}( and \textbackslash{}[ methods are considered ``LaTeX \
fragile.'' The robust methods should be used if the fragile methods result in \
unexpected behavior. +To create equations in CKEditor (the WYSIWYG editor launched \
with the ``Rich formatting'' link), +you can use the $\Sigma$ button. It requires \
knowing the LaTeX syntax, but provides a real-time preview. Equations can be edited \
with a double-click on the rendering. +
+Within the \texttt{<m>} tag, additional tags control the display of LaTeX math. The \
\$ open and closing syntax will create an inline equation. To create an equation in a \
separate paragraph, use double signs, \$\$. Alternative notations are also accepted, \
\textbackslash{}( opening with \textbackslash{}) closing can be used for an inline \
equation, and \textbackslash{}[ opening with \textbackslash{}] closing results in a \
separate paragraph. The \$ and \$\$ methods are recommended as ``LaTeX robust'' and \
the \textbackslash{}( and \textbackslash{}[ methods are considered ``LaTeX fragile.'' \
The robust methods should be used if the fragile methods result in unexpected \
behavior.  
 Some simple sytax from common LaTeX math:
 \begin{itemize}
@@ -17,5 +24,5 @@
 \item use \texttt{\{} and \texttt{\}} as delimiters, e.g. \texttt{x\_\{upper\}} for \
$x_{upper}$  \end{itemize}
  
-
+See \textbf{m} in \ref{Authoring_Output_Tags} for more information about it.
 
Index: loncom/html/adm/help/tex/Authoring_FormulaResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_FormulaResponse.tex:1.1 \
                loncom/html/adm/help/tex/Authoring_FormulaResponse.tex:1.2
--- loncom/html/adm/help/tex/Authoring_FormulaResponse.tex:1.1	Tue Jan 24 18:48:24 \
                2017
+++ loncom/html/adm/help/tex/Authoring_FormulaResponse.tex	Wed Feb  1 21:18:43 2017
@@ -12,3 +12,5 @@
 \item \textbf{samples}\index{samples}: optional, sample points. See \
\ref{Formula_Response_Sampling}.  \item \textbf{preprocess}: optional, pre-process \
Perl subroutine  \end{itemize}
+
+Hints can be specified with \textbf{formulahint}.
Index: loncom/html/adm/help/tex/Authoring_NumericalResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.5 \
                loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.6
--- loncom/html/adm/help/tex/Authoring_NumericalResponse.tex:1.5	Tue Jan 24 19:26:27 \
                2017
+++ loncom/html/adm/help/tex/Authoring_NumericalResponse.tex	Wed Feb  1 21:18:43 2017
@@ -14,3 +14,5 @@
 \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}
+
+Hints can be specified with \textbf{numericalhint}.
Index: loncom/html/adm/help/tex/Authoring_OptionResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.5 \
                loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.6
--- loncom/html/adm/help/tex/Authoring_OptionResponse.tex:1.5	Tue Jan 24 19:26:27 \
                2017
+++ loncom/html/adm/help/tex/Authoring_OptionResponse.tex	Wed Feb  1 21:18:43 2017
@@ -17,3 +17,5 @@
   \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}
+
+Hints can be specified with \textbf{optionhint}.
Index: loncom/html/adm/help/tex/Authoring_Output_Tags.tex
diff -u loncom/html/adm/help/tex/Authoring_Output_Tags.tex:1.25 \
                loncom/html/adm/help/tex/Authoring_Output_Tags.tex:1.26
--- loncom/html/adm/help/tex/Authoring_Output_Tags.tex:1.25	Mon Jan 23 20:29:42 2017
+++ loncom/html/adm/help/tex/Authoring_Output_Tags.tex	Wed Feb  1 21:18:43 2017
@@ -17,8 +17,30 @@
   <chem>O2 + 2H2 -> 2H2O</chem>
 \end{verbatim}
 will be rendered:
-
 $\mathrm{O_2} + 2\,\mathrm{H_2} \to 2\,\mathrm{H_2O}$
+
+\textbf{Syntax Description}
+\begin{itemize}
+\item Reactants are separated from products by `\texttt{->}'.
+\item Individual reactants and products are separated by `\texttt{  +}' (leading \
space is obligatory). +\item Numbers preceding the first symbol of a chemical specie \
are considered to be stoichiometric coefficients. +\item Numbers appearing after the \
first symbol of a chemical specie are considered to be subscripts. +\item \
Superscripts are initialized by `\texttt{\^{}}' and terminated by a space. +\item \
Ionic charges are superscripts composed of a number followed by a sign (i.e. \
`\texttt{\^{}2+}'). +\end{itemize}
+
+\textbf{More examples}
+\begin{itemize}
+\item $\mathrm{Ca}(\mathrm{NO}_3)_2$ is written as:\\
+\texttt{Ca(NO3)2}
+\item $\mathrm{OH}^- + \mathrm{H_3O}^+ \to 2\mathrm{H_2O}$ is written as:\\
+\texttt{OH\^{}- + H3O\^{}+ -> 2H2O}
+\item $[\mathrm{Co}(\mathrm{H_2O})_6]^{2+} + 4\mathrm{Cl}^- \to \
[\mathrm{CoCl_4}]^{2-} + 6\mathrm{H_2O}$ is written as:\\ +\texttt{[Co(H2O)6]\^{}2+ + \
4Cl\^{}- -> [CoCl4]\^{}2- + 6H2O} +\item $^3_1\mathrm{H} + ^2_1\mathrm{H} \to \
^4_2\mathrm{He} + ^1_0\mathrm{n}$ is written as:\\ +\texttt{\^{}3 1H + \^{}2 1H -> \
\^{}4 2He + \^{}1 0n} +\end{itemize}
+
 \item \textbf{num}\index{num}\index{format number}: Typesets a number formatted in \
scientific notation, fixed point, fixed point with commas, fixed point with commas \
and dollar sign, or in significant digits.   \begin{verbatim}
   <num format="2E">31454678</num> results in 3.15 x 10^7
Index: loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.5 \
                loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.6
--- loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex:1.5	Tue Jan 24 \
                19:26:27 2017
+++ loncom/html/adm/help/tex/Authoring_RadiobuttonResponse.tex	Wed Feb  1 21:18:43 \
2017 @@ -15,3 +15,5 @@
   \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}
+
+Hints can be specified with \textbf{radiobuttonhint}.
Index: loncom/html/adm/help/tex/Authoring_StringResponse.tex
diff -u loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.2 \
                loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.3
--- loncom/html/adm/help/tex/Authoring_StringResponse.tex:1.2	Tue Jan 24 19:26:27 \
                2017
+++ loncom/html/adm/help/tex/Authoring_StringResponse.tex	Wed Feb  1 21:18:43 2017
@@ -16,3 +16,5 @@
   \item \textbf{answerdisplay}: string to display for answer
   \item \textbf{preprocess}: optional, pre-process Perl subroutine
 \end{itemize}
+
+Hints can be specified with \textbf{stringhint}.
Index: loncom/html/adm/help/tex/Creating_New_Content_Pages.tex
diff -u loncom/html/adm/help/tex/Creating_New_Content_Pages.tex:1.16 \
                loncom/html/adm/help/tex/Creating_New_Content_Pages.tex:1.17
--- loncom/html/adm/help/tex/Creating_New_Content_Pages.tex:1.16	Sat Aug 20 17:48:11 \
                2016
+++ loncom/html/adm/help/tex/Creating_New_Content_Pages.tex	Wed Feb  1 21:18:43 2017
@@ -12,18 +12,13 @@
 right of the authoring space page as shown in the dropdown menu of the figure \
\ref{New Content Menu}.  
 When you edit a web page, you will be presented with a plain text editor as shown in \
                the 
-figure \ref{Plain Text HTML Editor}. Clicking 
-the link for the Rich Formatting displays the HTML WYSIWYG editor with buttons to \
help you create html entities +figure \ref{Plain Text HTML Editor}.
+Clicking the link for the Rich Formatting displays the HTML WYSIWYG editor \
(CKEditor) +with buttons to help you create html entities
 with correct tags as shown in the figure \ref{Rich Text HTML Editor}. If the rich \
                layout is not as you expect, look
-for the button to view/edit the source, and then manually make adjustments to the \
                html tags. Note that buttons are
-available to select graphics to include in the HTML file. Buttons are also provided \
                to create/edit links.
-
-To create equations, you can use the `Edit Math' button in the plain text editor, or \
                you can type LaTeX equations
-directly in the \texttt{<m></m>} tags in the plain text editor. The `Edit Math' \
                button launches a pop-up window
-containing the DragMath equation editor (Java plugin supprt in user's
-browser required).  The pop-up includes a ``Render LaTeX'' button which
-can be clicked to insert the math expression composed in Drag Math as
-LaTeX within $<$m$>$\$ \$$<$/m$>$ in the file editor in the original window.
+for the button to view/edit the source, and then manually make adjustments to the \
html tags. +Note that buttons are available to select graphics to include in the HTML \
file. +Buttons are also provided to create/edit links. See below how to create and \
edit equations.  
 Note that convenient help links for \textbf{Greek Symbols, Other Symbols, and Output \
Tags}\index{Greek symbols}\index{symbols, html}\index{output tags} immediately above \
the editor in the figures. Also note the link to check spelling below the \
editor.\index{spelling checker}  

Index: loncom/html/adm/help/tex/Authoring_CustomResponse.tex
+++ loncom/html/adm/help/tex/Authoring_CustomResponse.tex
\label{Authoring_CustomResponse}\index{customresponse}

\textbf{customresponse} queries for text without any constraint (any character is \
allowed). A script analyzes the answer to grade it automatically. \\ \\
Possible attributes are:
\begin{itemize}
\item \textbf{answerdisplay}: string to display for answer
\end{itemize}

The \textbf{answer} element inside, with the Perl code used for grading, can have the \
following attribute: \begin{itemize}
\item \textbf{type}: should be \texttt{loncapa/perl}
\end{itemize}

Hints can be specified with \textbf{customhint}.

Index: loncom/html/adm/help/tex/Authoring_EssayResponse.tex
+++ loncom/html/adm/help/tex/Authoring_EssayResponse.tex
\label{Authoring_EssayResponse}\index{essayresponse}

\textbf{essayresponse} queries for a long text or a line, possibly with spell \
checking. An internal \textbf{textfield} element is necessary for the student's \
response to go in.

Hints can be specified with \textbf{stringhint}.

Index: loncom/html/adm/help/tex/Authoring_OrganicResponse.tex
+++ loncom/html/adm/help/tex/Authoring_OrganicResponse.tex
\label{Authoring_OrganicResponse}\index{organicresponse}

\textbf{organicresponse} queries for an organic chemical structure with a molecular \
editor. \\ \\
Possible attributes are:
\begin{itemize}
  \item \textbf{options}: Comma-separated list of options:
    \begin{itemize}
      \item autoez: auto E,Z stereochemistry
      \item multipart: multipart Structures
      \item nostereo: no stereochemistry
      \item reaction: is a reaction
      \item number: able to number atoms
    \end{itemize}
  \item \textbf{molecule}: Starting Molecule. Syntax: JME.
  \item \textbf{answer}: Correct Answer.
    Syntax: SMILES (Simplified Molecular Input Line Entry System).
  \item \textbf{jmeanswer}: JME string of the answer
  \item \textbf{width}: Width of correct answer image (in pixel)
\end{itemize}

Hints can be specified with \textbf{organichint}.

Index: loncom/html/adm/help/tex/Authoring_ReactionResponse.tex
+++ loncom/html/adm/help/tex/Authoring_ReactionResponse.tex
\label{Authoring_ReactionResponse}\index{reactionresponse}

\textbf{reactionresponse} queries for a chemical reaction.
An internal \textbf{textline} element is necessary for the student's response to go \
in. \\ \\
Possible attributes are:
\begin{itemize}
  \item \textbf{answer}: see \textbf{chem} at \ref{Authoring_Output_Tags} for the \
chemical reaction syntax  \item \textbf{initial}: initial reaction displayed to \
students \end{itemize}

Hints can be specified with \textbf{reactionhint}.



_______________________________________________
LON-CAPA-cvs mailing list
LON-CAPA-cvs@mail.lon-capa.org
http://mail.lon-capa.org/mailman/listinfo/lon-capa-cvs


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic