File:  [LON-CAPA] / loncom / html / adm / help / tex / Authoring_Internal_Tags.tex
Revision 1.3: download - view: text, annotated - select for diffs
Sat Aug 20 16:06:50 2016 UTC (7 years, 10 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, version_2_11_X, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2, HEAD
- Use LaTeX-style single and double quotes.

\label{Authoring_Internal_Tags}


\begin{itemize}
\item \textbf{labelgroup}\index{labelgroup}: One is required, but multiple are allowed.
This declares a group of locations and labels associated with them. Possible
attributes are:

\begin{itemize}
\item \textbf{name}\index{name}: This is the name of the group. A hash
with this name will be generated holding the mappings for later use
in the problem. For each location a value will be set for which label
is there (EX. \$hash\{`1'\}=``TEXT-2''). For locations with values,
the hash will contain 2 items, a location to value mapping (\$hash\{`value\_1'\}=10),
and a label to value mapping (\$hash\{`labelvalue\_2'\}=10). For all
image style of labels there will also be a label description to label
URL mapping (\$hash\{`image\_2'\}=IMG-URL). The entry \textbf{numlocations}
will also be set to the total number of locations that exist (Note: locations and labels start counting from one.) 
\item \textbf{type}\index{type}: the type of labels in this group, either
`\textbf{image}' or `\textbf{text}'
\item \textbf{location}\index{location}: declares a location on the image
that a label should appear at. Possible attributes are:

\begin{itemize}
\item \textbf{x}\index{x}: The x value of the location in pixels.
\item \textbf{y}\index{y}: The y value of the location in pixels.
\item \textbf{value}\index{value}: An optional scalar value to associate
at this location.
\item \textbf{label}\index{label}: Declaration of a label. If this is a
\textbf{text} type label, the internal text should be the text of
the label (HTML is not currently supported); if this is an \textbf{image}
type of label, the internal text must be a LON-CAPA resource specification,
and the description filed must be set. Possible attributes are:

\begin{itemize}
\item \textbf{description}\index{description}: Required field for image
labels. It will be used when setting values in the hash.
\end{itemize}
\end{itemize}
\end{itemize}
\end{itemize}

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>