summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/acrotex/doc
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-01-23 03:02:06 +0000
committerNorbert Preining <norbert@preining.info>2021-01-23 03:02:06 +0000
commitfcf66e0c8c8c0f5d590d5ac4411b13977aef8a30 (patch)
treec3e833039bb26ff1b8a5730bff18f6f3c5f6ae56 /macros/latex/contrib/acrotex/doc
parente1a7798f45cd37c0aa0bfaaef5f0acb4e48bc867 (diff)
CTAN sync 202101230302
Diffstat (limited to 'macros/latex/contrib/acrotex/doc')
-rw-r--r--macros/latex/contrib/acrotex/doc/aeb_man.pdfbin1364576 -> 1499729 bytes
-rw-r--r--macros/latex/contrib/acrotex/doc/aeb_man.tex63
-rw-r--r--macros/latex/contrib/acrotex/doc/eformman.pdfbin991820 -> 987217 bytes
-rw-r--r--macros/latex/contrib/acrotex/doc/eformman.tex63
4 files changed, 76 insertions, 50 deletions
diff --git a/macros/latex/contrib/acrotex/doc/aeb_man.pdf b/macros/latex/contrib/acrotex/doc/aeb_man.pdf
index 1e6d223e3c..c62c427b52 100644
--- a/macros/latex/contrib/acrotex/doc/aeb_man.pdf
+++ b/macros/latex/contrib/acrotex/doc/aeb_man.pdf
Binary files differ
diff --git a/macros/latex/contrib/acrotex/doc/aeb_man.tex b/macros/latex/contrib/acrotex/doc/aeb_man.tex
index dd5cead2f7..cf08a13258 100644
--- a/macros/latex/contrib/acrotex/doc/aeb_man.tex
+++ b/macros/latex/contrib/acrotex/doc/aeb_man.tex
@@ -233,10 +233,10 @@
\university{{\AcroT} Software Development Team}
\email{dpstory@acrotex.net}
\versionLabel{Dated:}
-\version{2020/11/11}
+\version{2021/01/20}
\copyrightyears{1999-\the\year}
\nocopyright
-\prepared{2020/11/11}
+\prepared{2021/01/20}
\revisionLabel{Distribution Dated:}
\copyrightStatus{True}
@@ -698,9 +698,9 @@ writing to this document level. For those who use the
In this section, we describe how to insert document level
Java\-Scripts into a \textsf{PDF} file, prepared from a
-\LaTeX{} source that uses the \texttt{exerquiz} package. Even
+\LaTeX{} source that uses the \pkg{exerquiz} package. Even
though the handling and insertion of document level JavaScript is
-done with the package \textsf{insdljs}, a little care must be
+done with the package \pkg{insdljs}, a little care must be
taken, at least in the Distiller case, when building your
{\PDF} document.
@@ -6971,25 +6971,24 @@ how to use the ``every'' command.\footnote{eforms manual on Web:
\subsubsection{Change color of Correction Marks}
-The colors used to mark the quiz can be changed by redefining the
-commands \cs{check\-Color}, \cs{crossColor} and \cs{correctColor} in
-the \textit{preamble} or before. Below are the
-defaults:
-\begin{Verbatim}[xleftmargin=\amtIndent]
-\renewcommand\checkColor{["RGB", 0, .6, 0]}
-\renewcommand\crossColor{color.red}
-\renewcommand\correctColor{["RGB", 0, .6, 0]} % webgreen
+The colors used to mark quizzes are changed in the \textit{preamble} by
+redefining the commands listed below. The default definitions are,
+\begin{Verbatim}[xleftmargin=\amtIndent,fontsize=\small,commandchars=!()]
+\newcommand\rghtColorJSDef{["RGB",!,0,!,.6,!,0]} %!textsf( color for right response)
+\newcommand\wrngColorJSDef{color.red} %!textsf( color for wrong response)
+\newcommand\partialColorJSDef{color.blue} %!textsf( color for partial credit)
+\newcommand\defaultColorJSDef{color.black} %!textsf( reset color)
\end{Verbatim}
\noindent The colors are inserted into the field using JavaScript, so the color definitions
-are in the color space of the JavaScript object model.
+are in the color space of the JavaScript color object model.
\subsubsection{The `Correction' Button}\label{sss:CorrButton}
The `Correction' button is defined by the \cs{CorrButton} has two
parameters.
-\begin{Verbatim}[xleftmargin=\amtIndent]
-\CorrButton[mod_appear]{field_name}
+\begin{Verbatim}[xleftmargin=\amtIndent,commandchars=!()]
+\CorrButton[!ameta(mod_appear)]{!ameta(field_name)}
\end{Verbatim}
The second parameter is the field name that contains the total score for the
quiz (see the above examples). It also has one optional argument that can be
@@ -9305,10 +9304,12 @@ for example, it could read \cs{randomi=132088850}, then use
\end{Verbatim}
Of course comment out \cs{inputRandomSeed}.
-\settowidth{\aebdimen}{\cs{obeyLocalRandomize}}%
+\settowidth{\aebdimen}{\cs{allowRandomizedChoices}}%
\begin{dCmd}[commandchars=!()]{\aebdimen+2\fboxsep+2\fboxrule}
\turnOnRandomize
\obeyLocalRandomize
+\doNotRandomizeChoices
+\allowRandomizedChoices
\end{dCmd}
\newtopic\indent The command \cs{turnOnRandomize} overrides all local settings of \cs{bChoices}
@@ -9340,22 +9341,30 @@ the choices will not be randomized, because the \texttt{random}
option was not specified; or they will be randomized if the
\texttt{random} option is used.
-\newtopic\textcolor{red}{Limitations:} There are natural limitations on the use
-of \cs{bChoices} and \cs{eChoices} and consequently, there are
-limitations on the randomization. The content between \cs{Ans} and
-\cs{eAns} cannot have any verbatim text. This is usually not a
-problem for mathematical content, but could be a limitation for
-computer science where questions about syntax may be posed. I have
-in mind a work-around, but haven't pursued the problem as of yet.
+\newtopic\indent The command \cs{doNotRandomizeChoices} overrides the
+\opt{allowrandomize} option; when in effect, randomization of the choices
+does not occur. The companion command \cs{allowRandomizedChoices} restores the
+authority of the \opt{allowrandomize} option.
+
+\newtopic\textcolor{red}{Limitations:} There are natural limitations on the
+use of \cs{bChoices} and \cs{eChoices} and consequently, there are
+limitations on the randomization. The content between \cs{Ans} and \cs{eAns}
+cannot have any verbatim text. This is usually not a problem for mathematical
+content, but could be a limitation for computer science where questions about
+syntax may be posed.
+
+% I have in mind a work-around, but haven't pursued the
+% problem as of yet.
\section{Creating a Quiz Summary Table}\label{s:sumrytbl}
This feature is designed for a \texttt{quiz} (as opposed to a
\texttt{shortquiz}) and is probably most useful for a long quiz, spanning
-several pages. The \cs{displaySumryTbl} command creates a table that summarizes
-the user's effort for the quiz; \cs{displaySumryTbl} must follow the final
-\verb!\end{questions}! and \emph{must be on a separate page} from the last question of the quiz.
-An example of the generated table is shown below in \hyperref[fig:qzSumryTbl]{Figure~\ref*{fig:qzSumryTbl}}.
+several pages. The \cs{displaySumryTbl} command creates a table that
+summarizes the user's effort for the quiz; \cs{displaySumryTbl} must follow
+the final \verb!\end{questions}! and \emph{must be on a separate page} from
+the last question of the quiz. An example of the generated table is shown
+below in \hyperref[fig:qzSumryTbl]{Figure~\ref*{fig:qzSumryTbl}}.
\exAeBBlogPDF{p=377} The demo file for this section is
\texttt{\href{\urlAcroTeXBlog/?p=377}{sumry\_tbl.pdf}}, found
diff --git a/macros/latex/contrib/acrotex/doc/eformman.pdf b/macros/latex/contrib/acrotex/doc/eformman.pdf
index 788d0683c5..03a576d453 100644
--- a/macros/latex/contrib/acrotex/doc/eformman.pdf
+++ b/macros/latex/contrib/acrotex/doc/eformman.pdf
Binary files differ
diff --git a/macros/latex/contrib/acrotex/doc/eformman.tex b/macros/latex/contrib/acrotex/doc/eformman.tex
index ef8d90a37c..881a9f4090 100644
--- a/macros/latex/contrib/acrotex/doc/eformman.tex
+++ b/macros/latex/contrib/acrotex/doc/eformman.tex
@@ -27,6 +27,7 @@
\def\mSTRUT{\makebox[0pt][l]{\phantom{$\frac00$}}}
\let\vrbnormal\sffamily
\let\uif\sffamily
+\let\key\texttt
%\makeatletter
@@ -79,7 +80,7 @@
subject={Documentation for the eforms and insdljs packages},
talksite={\url{www.acrotex.net}},
version={2.0},
- prepared={2020/11/11},
+ prepared={2021/01/20},
preparedLabel={Distribution Dated:},
keywords={LaTeX, hyperref, PDF, exercises, quizzes},
copyrightStatus=True,
@@ -1206,10 +1207,10 @@ places message in the console when the field is signed.
\item The \cs{Lock} key can be used to lock various fields when the document
is signed.
-\begin{Verbatim}[xleftmargin=\amtIndent,numbers=left]
+\begin{Verbatim}[xleftmargin=\amtIndent,numbers=left,commandchars=!()]
\Lock{/Action/All}
-\Lock{/Action/Include/Fields [(field1)(field2)...]}
-\Lock{/Action/Exclude/Fields [(field1)(field2)...]}
+\Lock{/Action/IncludeFields{!ameta(field!SUB1),!ameta(field!SUB2),...}}
+\Lock{/Action/ExcludeFields{!ameta(field!SUB1),!ameta(field!SUB2),...}}
\end{Verbatim}
\begin{itemize}
\item In (1), all fields are locked when the signature field is signed.
@@ -1218,7 +1219,7 @@ is signed.
\item In (3), all fields, except the ones listed, are locked when the
signature field is signed.
\end{itemize}
-The \texttt{/Fields} key is required when the action is either \texttt{/Include} or \texttt{/Exclude}.
+%The \texttt{/Fields} key is required when the action is either \texttt{/Include} or \texttt{/Exclude}.
\end{itemize}
@@ -2672,20 +2673,22 @@ JavaScript code (\anglemeta{script}).
\settowidth{\aebdimen}{\ttfamily lock=\darg{\anglemeta{PDF KV-pairs}}}
\def\1{\llap{\Cs{Lock}\hspace{\marginparsep}}}%Lock
\begin{dCmd}[commandchars=!()]{\aebdimen+2\fboxsep+2\fboxrule}
-!1lock={!anglemeta(PDF KV-pairs)}
+!1lock={!anglemeta(KV-pairs)}
\end{dCmd}
-\CmdDescription The \texttt{lock} key is used with signature fields, currently, there is
- no nice user interface to this key. Typical entries are
-\begin{Verbatim}[xleftmargin=\amtIndent]
-lock={/Action/All} % lock all fields in the doc
-lock={/Action/Include % lock all fields listed in Fields
- /Fields [(field1)(field2)...]}
-lock={/Action/Exclude % lock all fields not listed in Fields
- /Fields [(field1)(field2)...]}
+\CmdDescription The \texttt{lock} key is used with signature fields; use the
+\key{action} key (with supported values of \texttt{all}, \texttt{include}, and \texttt{exclude})
+and the \key{fields} key to determine the lock action.
+\begin{Verbatim}[xleftmargin=\amtIndent,commandchars=!()]
+%!sffamily lock all fields in the doc
+lock={action=all}
+% !sffamily lock all fields listed by !texttt(fields) key
+lock={action=include,fields={!ameta(field!SUB1),!ameta(field!SUB2),...}}
+% !sffamily lock all fields not listed by !texttt(fields) key
+lock={action=exclude,fields={!ameta(field!SUB1),!ameta(field!SUB2),...}}
\end{Verbatim}
-\newtopic Another option that is included in the Signed tab is titled ``This script executes
+\newtopic Another option that is included in the \uif{Signed tab} is titled ``This script executes
when field is signed.''
This is an option that, through the user interface, is mutually exclusive from
@@ -2883,12 +2886,12 @@ required to have \app{Acrobat}~5.0 (or later).
\section{Package Options}
The \textsf{insdljs} supports five common ``drivers'': \texttt{dvipsone},
-\texttt{dvips}, \texttt{pdftex} (including the executable \textsf{lu(la)tex}), \texttt{dvipdfm},
-\texttt{dvipdfmx}, \texttt{xetex}, and \texttt{tex\-tures}. When using
-\texttt{dvipsone} or \texttt{dvips}, \app{Acrobat} Distiller and \app{Acrobat}
-(version 5.0 or later) are required to embed the JavaScripts at the
-document level. The other drivers have primitives that allow the embedding
-of the JavaScripts.
+\texttt{dvips}, \texttt{pdftex} (including the executable
+\textsf{lu(la)tex}), \texttt{dvipdfm}, \texttt{dvipdfmx}, \texttt{xetex}, and
+\texttt{tex\-tures}. When using \texttt{dvips}, \app{Acrobat} Distiller and
+\app{Acrobat} (version 5.0 or later) are required to embed the JavaScripts at
+the document level. The other drivers have primitives that allow the
+embedding of the JavaScripts.
\newtopic Other options are discussed in the following paragraphs.
\begin{description}\def\NH{\hspace{-\labelsep}}
@@ -3417,12 +3420,12 @@ console.println("Exiting the button area");
\AAMouseExit{\JS{\JSAAX}}}
]{myButton}{30bp}{15bp}
\end{dCmd*}
-\newtopic The code lines of \cs{JSAAE} and \cs{JSAAX} are so simple, \texttt{defineJS} environment
+\newtopic The code lines of \cs{JSAAE} and \cs{JSAAX} are so simple, \env{defineJS} environment
was really not needed.
\newtopic See \Nameref{lengthyJS} for an additional example of the use of the \texttt{defineJS} environment.
-The \pkg{insdljs} package defines two ``silent'' versions of \env{defineJS},
+The \pkg{insdljs} package defines two ``silent'' versions of \env{defineJS}, these are
\env{@defineJS} and \env{defineJS*}.
\settowidth{\aebdimen}{\ttfamily\string\begin\darg{@defineJS}[\ameta{chngCats}]\darg{\cs{\ameta{cmd}}}}
\begin{dCmd}[commandchars=!()]{\aebdimen+2\fboxsep+2\fboxrule}
@@ -3485,6 +3488,11 @@ stream; this keeps the declaration local. The \hyperlink{cmd}{\cs{cmd}} key is d
\hyperref[supportedKVs]{Appendix~\ref*{supportedKVs}}, titled `\nameref{supportedKVs}', beginning on \pageref*{supportedKVs}; specifically,
\cs{cmd} is listed in under the heading \textcolor{blue}{Specialized, non-PDF Spec commands}.
+%http://www.acrotex.net/blog/?p=1442
+
+\exAeBBlogPDF{p=1442} A comprehensive discussion of the features to the \env{defineJS}
+environment is found in the article titled \href{\urlAcroTeXBlog/?p=1442}{\relax{\protect\pkg{insdljs}}: Exploring the {\protect\env{defineJS}} environment} from the {\AcroBlog}
+website.\footnote{\url{http://www.acrotex.net/blog/?p=1442}}
\newpage
%\appendix
@@ -3605,6 +3613,15 @@ your system, you can use \emph{named colors} to specify color for the
\end{Verbatim}
then each of the following is valid: \verb!\textColor{myBlue}! (for specifying text color for text fields), \verb!\BG{myBlue}! (for specifying the background color of a field), \verb!\BC{myBlue}! (for specifying the border color of a field), and \verb!\Color{myBlue}! (for specifying the border color of a link).
+
+\paragraph*{Setting some defaults.} Before getting to the specification of
+the key-values, there are two convenience commands for setting the default
+text font and text size. These are
+\cs{textFontDefault\darg{\ameta{font-spec}}}
+(\cs{textFontDefault\darg{Helv}}) for setting the default text font and
+\cs{textSizeDefault\darg{\ameta{size}}} (\cs{textSizeDefault\darg{9}}) for
+setting the default text size.
+
\newpage
\begingroup
\setlength{\extrarowheight}{3mm}\setlength{\tabcolsep}{3pt}