--- loncom/html/adm/help/tex/Authoring_Output_Tags.tex 2007/05/21 16:43:17 1.7 +++ loncom/html/adm/help/tex/Authoring_Output_Tags.tex 2016/08/20 16:06:50 1.21 @@ -4,32 +4,40 @@ This group of tags generates useful output. \begin{itemize} -\item \textbf{algebra}\index{algebra}: Typesets algebraic expressions +\item \textbf{algebra}\index{algebra}\index{format algebra}: Typesets algebraic expressions \begin{verbatim} - 2x^y+sqrt(3/x^2) +2x^y+sqrt(3/x^2) \end{verbatim} -\item \textbf{chem}\index{chem}: Typesets chemical equation +Expressions are displayed using the math expression display mechanism defined in the user's preferences. The default is tth. See the section below concerning the $<$m$>$ tag for more information on that as well as on the attribute \textbf{display}. +\item \textbf{chem}\index{chem}\index{format reaction}: Typesets chemical equation \begin{verbatim} - 02 + 2H2 -> 2H20 + O2 + 2H2 -> 2H2O \end{verbatim} -\item \textbf{num}\index{num}: Typesets a number +\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} - 31454678 + 31454678 results in 3.15 x 10^7 + 31454678 results in 31454678.00 + 31454678 results in 3.145 x 10^7 + 314.54678 results in 314.5 + 31454678 results in 31,454,678.00 + 31454678 results in $31,454,678.00 + 31454678 results in 31000000 + 31454678 results in 31,000,000 \end{verbatim} \item \textbf{parse}\index{parse}: to display the parsed view of a variable's contents \begin{verbatim} - - \$table + $table \end{verbatim} -\item \textbf{standalone}\index{standalone}: Everything inbetween the +\item \textbf{standalone}\index{standalone}: Everything in between the start and end tag is shown only on the web and only if the resource is not part of a course. \item \textbf{displayduedate}\index{displayduedate}: This will insert the @@ -105,22 +113,63 @@ in LON-CAPA style files. \item \textbf{window}\index{window}: This creates a link that when clicked shows the intervening information in a pop-up window. By default the window will be 500 pixels wide and 200 pixels tall, and the link text will be a superscript * (so as to look like a footnote). These can be changed using the attributes \begin{itemize} -\item[width] controls the starting width of the popup window -\item[height] controls the starting height of the popup window -\item[linktext] the text that should appear as the link that causes the creation of the window +\item \textbf{width} controls the starting width of the popup window +\item \textbf{height} controls the starting height of the popup window +\item \textbf{linktext} the text that should appear as the link that causes the creation of the window +\item \textbf{printtext} the text that should appear instead of a footnote when printed \end{itemize} -When printing this included text will get turned into a real footnote. +When printing, the included text will get turned into a real footnote. + +\item \textbf{windowlink}\index{windowlink}: This creates a link to a resource that comes up in a pop-up window. The link will be the intervening information +between the start and the end tag. By default the window will be 500 pixels wide and 200 pixels tall. + +\begin{itemize} +\item \textbf{width} controls the starting width of the popup window +\item \textbf{height} controls the starting height of the popup window +\item \textbf{href} the address +\end{itemize} + +\item \textbf{togglebox}\index{togglebox}: This creates a toggling box that can be clicked open and close. + +\begin{itemize} +\item \textbf{heading} heading text of the box, by default no heading +\item \textbf{headerbg} background color of the header, by default white +\item \textbf{showtext} the text that appears to make the box visible, by default the translation of `show' +\item \textbf{hidetext} the text that appears to hide the box again, by default the translation of `hide' +\end{itemize} + +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 -to HTML (or MathML) on the fly. If the attribute \textbf{eval} is set -to {}``\textbf{on}'' the intervening text will have a perl variable -expansion done to it before being converted. The default is to convert -to the display mechanism that the user has selected. This can be +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 -``\textbf{tth}'' or ``\textbf{jsMath}'' or ``\textbf{mimetex}''which -will force a specfic display mechanism. +``\textbf{tth}'' or ``\textbf{mimetex}''which +will force a specfic display mechanism. Note, however, that setting the attribute \textbf{display} to \textbf{jsmath} is generally discouraged as it works best if users have installed jsmath fonts on their computer. +See \\ \texttt{http://www.math.union.edu/\char`~ dpvc/jsmath/}. + +If you want variables inside of this tag to be evaluated before the +tex gets converted, then use eval=``on'' \index{eval=on}. For +example, $<$m eval=``on''$>$\$ \$eqn \$$<$/m$>$, +will evaluate the variable \$eqn first and then run it through the +TTH\index{TTH} converter. Anytime you use a variable inside of the m tag, +you will want to set eval to on. + +For example, put the following in a script in the resource: + +\texttt{\$eqn = "\$a+\$b";} + +\texttt{\$eqn =~ s/\textbackslash{}+-/-/g;} + +and in a text area, you can type: + +\texttt{$<$m eval=``on''$>$\$ \$eqn \$$<$/m$>$} + +You will get the equation rendered with no +-, no matter what value +\$b may take on. + \item \textbf{randomlabel}\index{randomlabel}: This shows a specified image with images or text labels randomly assigned to a set of specific @@ -159,4 +208,14 @@ external image or a LON-CAPA resource. I \item \textbf{height}\index{height}: The height of the image in pixels. \item \textbf{texwidth}\index{texwidth}: The width of the image in millimeters. \end{itemize} + +\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} + + +The formula for the circumference of a circle is 2*pi*r + + +\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. + \end{itemize}