[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Authoring_Dynamic_Plot_Color_Selection.tex Authoring_Dynamic_Plot_Curve.tex Authoring_Dynamic_Plot_Curve_Data.tex Authoring_Dynamic_Plot_Gnuplot.tex Authoring_Dynamic_Plot_Key.tex Authoring_Dynamic_Plot_Label.tex Authoring_Scripting_Tags.tex
raeburn
raeburn at source.lon-capa.org
Thu Aug 22 15:42:55 EDT 2013
raeburn Thu Aug 22 19:42:55 2013 EDT
Modified files:
/loncom/html/adm/help/tex
Authoring_Dynamic_Plot_Color_Selection.tex
Authoring_Dynamic_Plot_Curve.tex
Authoring_Dynamic_Plot_Curve_Data.tex
Authoring_Dynamic_Plot_Gnuplot.tex
Authoring_Dynamic_Plot_Key.tex
Authoring_Dynamic_Plot_Label.tex
Authoring_Scripting_Tags.tex
Log:
- Compromise to support display in both contextual online help, and aggregated
in manual (PDF).
- Identify the "section" by name, because the \ref is converted to a question
mark icon only, and not a number in online help context.
-------------- next part --------------
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Color_Selection.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Color_Selection.tex:1.2 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Color_Selection.tex:1.3
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Color_Selection.tex:1.2 Fri Jul 5 18:30:40 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Color_Selection.tex Thu Aug 22 19:42:55 2013
@@ -2,8 +2,8 @@
The default colors are a white background (xffffff) with black (x000000) forground, gridlines, and curve.
\begin{itemize}
-\item Background color is an attribute of the gnuplot tag (see section \ref{Authoring_Dynamic_Plot_Gnuplot}). This controls the color of the plot image. The default is white (xffffff).
-\item Foreground color is an attribute of the gnuplot tag (see section \ref{Authoring_Dynamic_Plot_Gnuplot}). This controls the color of the border.
-\item Gridline color is an attribute of the axis tag (see section \ref{Authoring_Dynamic_Plot_Axes}).
-\item Curve color is an attribute of the curve tag (see section \ref{Authoring_Dynamic_Plot_Curve}). This is the color of the curve function or data points. Different curves can be given different colors.
+\item Background color is an attribute of the gnuplot tag (see Authoring Dynamically Generated Plots section \ref{Authoring_Dynamic_Plot_Gnuplot}). This controls the color of the plot image. The default is white (xffffff).
+\item Foreground color is an attribute of the gnuplot tag (see Authoring Dynamically Generated Plots section \ref{Authoring_Dynamic_Plot_Gnuplot}). This controls the color of the border.
+\item Gridline color is an attribute of the axis tag (see Plot Axes Details section \ref{Authoring_Dynamic_Plot_Axes}).
+\item Curve color is an attribute of the curve tag (see Specifying Curves to Plot section \ref{Authoring_Dynamic_Plot_Curve}). This is the color of the curve function or data points. Different curves can be given different colors.
\end{itemize}
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve.tex:1.5 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve.tex:1.6
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve.tex:1.5 Fri Jul 5 18:30:40 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve.tex Thu Aug 22 19:42:55 2013
@@ -21,7 +21,7 @@
\item linestyle
-See line styles (section \ref{Authoring_Dynamic_Plot_Linestyle}) for
+See Line Styles section \ref{Authoring_Dynamic_Plot_Linestyle} for
more information about the available line styles and their data requirements.
\item linetype
@@ -73,6 +73,6 @@
There are two ways of entering the information to be plotted, which are
accessed using the subtags of \textbf{curve}, \textbf{data}
-(see section \ref{Authoring_Dynamic_Plot_Curve_Data}) and \textbf{function}
-(see section \ref{Authoring_Dynamic_Plot_Curve_Function}).
+(see Plotting Data Points section \ref{Authoring_Dynamic_Plot_Curve_Data}) and \textbf{function}
+(see Plotting Functions section \ref{Authoring_Dynamic_Plot_Curve_Function}).
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve_Data.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve_Data.tex:1.3 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve_Data.tex:1.4
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve_Data.tex:1.3 Fri Jul 5 18:30:40 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Curve_Data.tex Thu Aug 22 19:42:55 2013
@@ -1,19 +1,20 @@
\label{Authoring_Dynamic_Plot_Curve_Data}
The \textbf{data} tag is used to specify the values plotted in the
-\textbf{gnuplot} tag (see section \ref{Authoring_Dynamic_Plot_Gnuplot}).
-The \textbf{data} tag is only used in the \textbf{Curve} tag
-(see section \ref{Authoring_Dynamic_Plot_Curve}).
+\textbf{gnuplot} tag (see Authoring Dynamically Generated Plots section
+\ref{Authoring_Dynamic_Plot_Gnuplot}).
+The \textbf{data} tag is only used in the \textbf{Curve} tag
+(see Specifying Curves to Plot section \ref{Authoring_Dynamic_Plot_Curve}).
-The data must be either a perl array, \texttt{@X}, or a comma seperated list,
+The data must be either a perl array, \texttt{@X}, or a comma separated list,
such as ``0.5,0.9,1.5, 2.4'' (without quotes). 'NaN' is a valid value.
-Note the the "Y" values are entered in a separate array.
+Note the the "Y" values are entered in a separate array.
The function and number of \textbf{data} tags required varies based on the
-line style (see section \ref{Authoring_Dynamic_Plot_Linestyle}) chosen for the
+line style (see Data and Line Styles section \ref{Authoring_Dynamic_Plot_Linestyle}) chosen for the
curve. Some linestyles require extra arrays for supplemental information.
In all cases the first \textbf{data} tag will hold the ``X'' values
and the second will hold the ``Y'' values.
All of the data sets in the \textbf{data} tag must have the same number of
-elements.
+elements.
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Gnuplot.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Gnuplot.tex:1.7 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Gnuplot.tex:1.8
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Gnuplot.tex:1.7 Sat Jul 13 21:50:50 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Gnuplot.tex Thu Aug 22 19:42:55 2013
@@ -1,22 +1,23 @@
\label{Authoring_Dynamic_Plot_Gnuplot}
\index{gnuplot}\index{plot}\index{dynamic plot}
-The \textbf{gnuplot} LON-CAPA tag allows an author to design a plot which is created
-when it is viewed. This is intended for use in homework problems
-where each student needs to see a distinct plot. It can be used in
-conjunction with a \textbf{script} tag to generate curve data for random plots.
+The \textbf{gnuplot} LON-CAPA tag allows an author to design a plot which will be
+created programatically at the time when it is requested for display by a student.
+This is intended for use in homework problems where a distinct plot should be
+rendered for each student. It can be used in conjunction with a
+\textbf{script} tag to generate curve data for random plots.
If you are using
static data a dynamically generated plot is not appropriate because of
the overhead associated with generating the plot. In that case, use a
-picture (see \ref{Authoring_Adding_Pictures}).
+picture (see Adding Picture section \ref{Authoring_Adding_Pictures}).
The easiset way to create a template for a gnuplot tag is to use the colorful
problem editor, and select \textbf{GnuPlot} from the \textbf{Insert} dropdown menu.
-Then the boxes may be filled with the assistance of this documentation. By default, only
+Thereafter the boxes may be filled using this documentation to assist you. By default, only
the parent \textbf{gnuplot} tag and the child \textbf{curve} tag are created by
-default when the plot is inserted with the colorful editor. Other tags can be
+when the plot is inserted into a problem using the colorful editor. Other tags can be
added to decorate and polish your plot using the \textbf{Insert:} dropdown
-from the colorful editor.
+provided by the colorful editor.
The following \textbf{gnuplot} parameters may be set:
@@ -30,7 +31,7 @@
for help on specifying colors.
\item \texttt{foreground color of image (x000000)}
-See the color selection section \ref{Authoring_Dynamic_Plot_Color_Selection}
+See the color selection section \ref{Authoring_Dynamic_Plot_Color_Selection}
for help on specifying colors.
\item \texttt{height of image (pixels)}
@@ -45,10 +46,10 @@
\item \texttt{Display grid} ``Yes'' or ``No''.
-\item \texttt{Number of samples for non-data plots} If a \textbf{function} tag
-(see section \ref{Authoring_Dynamic_Plot_Curve_Function}) is used to specify the
-\textbf{curve} (see section \ref{Authoring_Dynamic_Plot_Curve}), this indicates the number
-of sample points to use.
+\item \texttt{Number of samples for non-data plots} If a \textbf{function} tag is used
+(see Plotting Functions section \ref{Authoring_Dynamic_Plot_Curve_Function}) to specify the
+\textbf{curve} (see Specifying Curves to Plot section \ref{Authoring_Dynamic_Plot_Curve}),
+this indicates the number of sample points to use.
\item \texttt{Draw border around plot} ``Yes'' or ``No''
@@ -81,12 +82,12 @@
editor):
\begin{itemize}
-\item \textbf{curve} (see section \ref{Authoring_Dynamic_Plot_Curve})
-\item \textbf{title}, \textbf{xlabel}, and \textbf{ylabel} (see section
+\item \textbf{curve} (see Specifying Curves to Plot section \ref{Authoring_Dynamic_Plot_Curve})
+\item \textbf{title}, \textbf{xlabel}, and \textbf{ylabel} (see Plot Labels and Key section
\ref{Authoring_Dynamic_Plot_Title_X_Y_Label})
-\item \textbf{key} (see section \ref{Authoring_Dynamic_Plot_Key})
-\item \textbf{label} (see section \ref{Authoring_Dynamic_Plot_Label})
-\item \textbf{axes} (see section \ref{Authoring_Dynamic_Plot_Axes})
-\item \textbf{tics} (see section \ref{Authoring_Dynamic_Plot_Tics})
+\item \textbf{key} (see Plot Labels and Key section \ref{Authoring_Dynamic_Plot_Key})
+\item \textbf{label} (see Plot Labels and Key section \ref{Authoring_Dynamic_Plot_Label})
+\item \textbf{axes} (see Plot Axes Details section \ref{Authoring_Dynamic_Plot_Axes})
+\item \textbf{tics} (see Plot Axes Details section \ref{Authoring_Dynamic_Plot_Tics})
\end{itemize}
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Key.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Key.tex:1.2 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Key.tex:1.3
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Key.tex:1.2 Fri Jul 5 18:30:40 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Key.tex Thu Aug 22 19:42:55 2013
@@ -2,7 +2,8 @@
The \textbf{key} tag causes a key to be drawn on the plot when it is generated.
The key will contain an entry for each \textbf{curve} which has a name
-(see section \ref{Authoring_Dynamic_Plot_Curve}).
+(see Specifying Curves to Plot section \ref{Authoring_Dynamic_Plot_Curve}).
The key is the color of the foreground of the plot, specified in the
-\textbf{gnuplot} tag (see section \ref{Authoring_Dynamic_Plot_Gnuplot}).
+\textbf{gnuplot} tag (see Authoring Dynamically Generated Plots section
+\ref{Authoring_Dynamic_Plot_Gnuplot}).
Index: loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Label.tex
diff -u loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Label.tex:1.5 loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Label.tex:1.6
--- loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Label.tex:1.5 Fri Jul 5 18:30:40 2013
+++ loncom/html/adm/help/tex/Authoring_Dynamic_Plot_Label.tex Thu Aug 22 19:42:55 2013
@@ -5,7 +5,8 @@
which fall within the plot will show.
The color used will be to foreground color of the plot and the font will be
the size specified for the plot, both of which are set in the
-\textbf{gnuplot} tag (see section \ref{Authoring_Dynamic_Plot_Gnuplot}).
+\textbf{gnuplot} tag (see Authoring Dynamically Generated Plots section
+\ref{Authoring_Dynamic_Plot_Gnuplot}).
\begin{itemize}
\item \texttt{justification of the label text on the plot}
Index: loncom/html/adm/help/tex/Authoring_Scripting_Tags.tex
diff -u loncom/html/adm/help/tex/Authoring_Scripting_Tags.tex:1.4 loncom/html/adm/help/tex/Authoring_Scripting_Tags.tex:1.5
--- loncom/html/adm/help/tex/Authoring_Scripting_Tags.tex:1.4 Sat Aug 17 21:25:18 2013
+++ loncom/html/adm/help/tex/Authoring_Scripting_Tags.tex Thu Aug 22 19:42:55 2013
@@ -34,8 +34,8 @@
of parts wrapped. When N is less than the total number of parts wrapped,
there will be gaps in the assessment chart, and also in the table
of submissions for each student, corresponding to those parts which are
-never available to that particular student. For more examples see section
-\ref{Authoring_Library_Scripts}.
+never available to that particular student. For more examples see Authoring
+Library Files section \ref{Authoring_Library_Scripts}.
\item \textbf{solved}\index{solved}: Everything inside the tag is skipped
if the problem is {}``not solved''.
\item \textbf{while}\index{while}: This implements a while loop. The required
More information about the LON-CAPA-cvs
mailing list