summaryrefslogtreecommitdiff
path: root/texmf-dist/doc/latex/thorshammer/thors-the-man.tex
diff options
context:
space:
mode:
Diffstat (limited to 'texmf-dist/doc/latex/thorshammer/thors-the-man.tex')
-rw-r--r--texmf-dist/doc/latex/thorshammer/thors-the-man.tex119
1 files changed, 56 insertions, 63 deletions
diff --git a/texmf-dist/doc/latex/thorshammer/thors-the-man.tex b/texmf-dist/doc/latex/thorshammer/thors-the-man.tex
index be267d67..82b71cb5 100644
--- a/texmf-dist/doc/latex/thorshammer/thors-the-man.tex
+++ b/texmf-dist/doc/latex/thorshammer/thors-the-man.tex
@@ -78,7 +78,7 @@
email={dpstory@acrotex.net},
subject=Documentation for the thorshammer package,
talksite={\url{www.acrotex.net}},
- version={1.5.7, 2020/01/13},
+ version={1.5.11, 2021/06/24},
Keywords={assessment workflow, LaTeX, AcroTeX},
copyrightStatus=True,
copyrightNotice={Copyright (C) \the\year, D. P. Story},
@@ -209,46 +209,49 @@ Thor's way.
\section{Preliminaries}
Most important is the correct installation of \pkg{thorshammer} along with
-its required packages and folder JavaScript files.
+its required packages and folder JavaScript files. These are discussed in
+this section.
\subsection{Package requirements}
-The most recent version of the packages \pkg{insdljs} (2019/10/23),
-\pkg{exerquiz} (2019/10/13), \pkg{eq-save} (2019/08/07) are required. These three packages
-were modified slightly to obtain features needed by \pkg{thorshammer}.
+The most recent version of the packages \pkg{insdljs} (2021/06/19),
+\pkg{exerquiz} (2021/05/29), \pkg{eq-save} (2021/04/27) are required. These
+three packages were modified slightly to obtain features needed by
+\pkg{thorshammer}.
-The \pkg{thorshammer} package ships with two folder JavaScript files
-\texttt{aeb\_pro.js}\FmtMP{\textsf{aeb\_pro.js}} (Version 1.7.2 or later,
+The \pkg{thorshammer} package requires the folder JavaScript files
+\texttt{aeb\_pro.js}\FmtMP{\textsf{aeb\_pro.js}} (Version 1.6.2 or later,
required) and \texttt{aeb-reader.js}\FmtMP{\textsf{aeb-reader.js}} (Version
-1.0 or later); these two are found in \texttt{folder-js}
-folder\FmtMP{\texttt{folder-js} folder}. The latter is a new JavaScript file,
-the former ships with the \pkg{aeb\_pro} package. These files give access to
+1.0 or later); these two are distributed by the
+\pkg{acrotex-js}\FmtMP{\pkg{acrotex-js} pkg} package, dated 2021/06/24 or
+later, and are found in \texttt{js-files} folder
+of the distribution of \pkg{acrotex-js}. These files give access to
security restricted JavaScript methods. If you already have \pkg{aeb\_pro}
-installed, be sure you have Version 1.7.2 of \texttt{aeb\_pro.js}, if not,
-install Version 1.7.2 provided by this distribution.
+installed, be sure you have Version 1.6.2 of \texttt{aeb\_pro.js}, if not,
+install Version 1.6.2 provided by the \pkg{acrotex-js} distribution.
The \texttt{aeb\_pro.js} is used on the instructor's system, along with
-\app{Acrobat} (\app{AA}), to author quizzes. \app{Distiller} is not used unless the
-author prefers a TEX $\rightarrow$ DVI $\rightarrow$ PS $\rightarrow$ PDF
-workflow, using \app{Distiller} as the PDF creator. For this workflow,
-\app{pdflatex}, \app{lualatex}, and \app{xelatex} will work as PDF creators;
-however, \app{Acrobat} ia needed to execute the JavaScript code generated by
-the command \cs{sadQuizzes} and to execute the action sequences provided by
-this package.
+\app{Acrobat} (\app{AA}), to author quizzes. \app{Distiller} is not used
+unless the author prefers a TEX $\rightarrow$ DVI $\rightarrow$ PS
+$\rightarrow$ PDF workflow, using \app{Distiller} as the PDF creator. For
+this workflow, \app{pdflatex}, \app{lualatex}, and \app{xelatex} will work as
+PDF creators; however, \app{Acrobat} is needed to execute the JavaScript code
+generated by the command \cs{sadQuizzes} and to execute the action sequences
+provided by this package.
Once the quizzes are created, the author can take the quizzes in \app{Adobe
Reader} (\app{AR}) to get the same experience as his students. Additionally,
-\texttt{aeb-reader.js} can be installed on the instructor's system and on the
-student's work environment, if possible/permitted. \texttt{aeb-reader.js}
+\texttt{aeb-reader.js}\FmtMP{\textsf{aeb-reader.js}} can be installed on the
+student's work environment, if possible/permitted; \texttt{aeb-reader.js}
contains a subset of JavaScript methods taken from \texttt{aeb\_pro.js} that
\emph{will enhance student experience}. The author can install this file on
his system to take the quizzes in the same environment, again using
\app{Adobe Reader}. \textbf{Warning:}\FmtMP{\textbf{Warning}} Do not install
-\texttt{aeb\_pro.js} in any folder where an \app{Adobe Reader} used by
-students would read it.
+\texttt{aeb\_pro.js} in any folder where an \app{Adobe Reader} is used by
+students.
\paragraph*{Other enhancements to user experience.} \app{Adobe Reader} is by default in \uif{Protected Mode}.
-Then \uif{Protected Mode} is enabled, one or more security dialog boxes popup
+When \uif{Protected Mode} is enabled, one or more security dialog boxes popup
as the student saves his/her document. To eliminate this annoyance, clear the
\uif{Enable Protected Mode at startup} checkbox, as shown in the
\hyperref[fig:PM]{Figure~\ref*{fig:PM}}. On your personal system, open
@@ -272,10 +275,10 @@ the sysadmin\FmtMP{sysadmin permission} to make those changes.
%\pkg{aeb\_pro} package, though the package itself is not required. As a convenience,
%\texttt{aeb\_pro.js} is also include in the \texttt{folder-js} folder.
-\paragraph*{Installation of JS files for \app{Acrobat}.} The JavaScript file \texttt{aeb-reader.js}
-is provided in the \texttt{folder-js} folder. Discussion of how and where to
-install folder JavaScript files is found in the file
-\texttt{docs/install\_jsfiles.pdf}. Read and follow the directions carefully.
+\paragraph*{Installation of JS files for \app{Acrobat}.} The description of the installation of
+the JavaScript file \texttt{aeb\_pro.js} is provided by the \pkg{acrotex-js}
+package; read the \texttt{install\_jsfiles.pdf} file found in the
+\texttt{docs} folder of the \pkg{acrotex-js} package.
\paragraph*{Installation of JS files for \app{Adobe Reader}.} The folder JavaScript
file \texttt{aeb-reader.js} may be installed for use by \app{Adobe Reader} as
@@ -283,11 +286,12 @@ well. Installing \texttt{aeb-reader.js} enhances the experience of the
students as they save their quiz document after completing the quiz.
Normally, it is not possible to install such a JavaScript file for use by
students; however, if the students take the quiz in a Computer Lab, the
-sysadmin can install \texttt{aeb-reader.js} on all the computers used in the
+sysadmin\FmtMP{sysadmin} can install \texttt{aeb-reader.js} on all the computers used in the
Computer Lab. Discussion of how and where to install folder JavaScript files
-is found in the file \texttt{docs/install\_jsfiles.pdf}. Read and follow the
-directions carefully. (\app{Reader} looks for its folder JavaScript files in
-the same location where \app{Acrobat} would look for them.)
+is found in the file \texttt{docs/install\_jsfiles.pdf} of the
+\pkg{acrotex-js} package. Read and follow the directions carefully.
+(\app{Reader} looks for its folder JavaScript files in the same location
+where \app{Acrobat} would look for them.)
\subsection{Package options}
@@ -1938,7 +1942,7 @@ distribution.
to see if there are any errors. The attachment to this file
contains the quiz results, save and do with them what you will,
perhaps merging them into a larger spreadsheet.
- \item \textbf{\textsf{Thor protects} action.} Applies to a collection of
+ \item \textbf{\textsf{Thor protects} action.}\FmtMP{Secret password is \texttt{"acrotex"}} Applies to a collection of
newly created quizzes that specify the \opt{batchdistr} option.
Running this action places security on the quizzes so the student's
cannot view the answers even if they are using \app{Acrobat}.
@@ -1958,7 +1962,7 @@ distribution.
quizzes to the students folders, you can use \textsf{Thor
distributes} to accomplish that task.
\end{itemize}
- \item \textbf{\textsf{Thor protects and distributes} action.} Applies to
+ \item \textbf{\textsf{Thor protects and distributes} action.}\FmtMP{Secret password is \texttt{"acrotex"}} Applies to
a collection of newly created quizzes that specify the
\opt{batchdistr} option. Refer to
\hyperref[ss:bd]{Section~\ref{ss:bd}} for more details. The action is
@@ -1987,6 +1991,10 @@ distribution.
see \hyperref[item:RS]{item~\ref*{item:RS}} titled \textbf{Remove Security}.
After removing security, we continue with the \textsf{Thor's way} action.
\end{itemize}
+\textbf{A Note on Password Protection.} The default password for the two
+action sequences is \texttt{"acrotex"}. This can be changed for your system
+by editing the two sequences from within the \app{Acrobat} user interface and
+changing the password there.
\section{Further discussion of Basic Methods}
@@ -2118,40 +2126,25 @@ system drive that students have access to, designated as SD (system drive).
\section{The \tops{\protect\opt{ordinary}}{ordinary} option}\label{ordinary}
This option was prompted by an \pkg{exerquiz} user who had a unique problem:
-He wanted to put password protection on the \uif{Correct} button of an
-\pkg{exerquiz} quiz. He wanted to distribute quizzes to his students. The
-students would take the quiz, and, on pressing the \uif{End Quiz} button,
-would get their score, but the \uif{Correct} button would be denied to them
-through a password mechanism.
+He wanted to put password protection (PIN security) on the \uif{Correct}
+button of an \pkg{exerquiz} quiz. He wanted to distribute quizzes to his
+students. The students would take the quiz, and, on pressing the \uif{End
+Quiz} button, would get their score, but the \uif{Correct} button would be
+denied to them through a password mechanism.
Solving this problem necessitated some of the special features of
-\pkg{thorshammer}, without the use of \cs{sadQuizzes}.
+\pkg{thorshammer}, without the use of \cs{sadQuizzes}, as well as the creation
+of a few new commands.
To see the solution to this problem, go to the
-\texttt{examples/orginary-option} folder. There are three files in that
-folder:
-\begin{itemize}
- \item {\ttfamily quiz-pwd-to-correct-AA.tex}: This file requires the use
- of \app{Acrobat} to create the quizzes. The password is dynamically
- encoded as the PDF is loaded into \app{Acrobat} for the first time.
- \item {\ttfamily quiz-pwd-to-correct-AR.tex}: Again, the \uif{Correct}
- button is password protected, only \app{Adobe Reader} is required
- to build this file; however, the encrypted password cannot be built
- dynamically. It must be first computed and hard-wired placed in the
- source document.
- \item {\ttfamily get-hash-string.tex}: This is a companion file to the
- `AR' version described above. Build this file using any method.
- Open it in \app{Adobe Reader} and press the \uif{Push} button. A
- response dialog box opens, enter your chosen password (PIN number)
- and press \uif{OK}. The hash string of your password appears on the
- text field. Copy the password (or PIN) and the hash string to
- {\ttfamily quiz-pwd-to-correct\allowbreak-AR.tex}. Comment out the human readable
- password in your file and paste the hash string into the value of
- the \texttt{\_PinCode} JavaScript variable, then build the file
- {\ttfamily quiz-pwd-to\allowbreak-correct-AR.tex}. Now, the \uif{Correct}
- button is password (PIN) protected.
+\texttt{examples/orginary-option} folder to find the demo file
+\texttt{thqz-p2c.tex}. This file uses the
+\pkg{\href{https://ctan.org/pkg/eq-pin2corr}{eq-pin2corr}} package.\footnote{\pkg{eq-pin2corr} is
+a package capable of placing PIN security (and other security) on an \pkg{exerquiz} quiz, apart from the
+use of the \pkg{thorshammer} package.}
+Additional discussion of the techniques and special ``transition'' commands
+is found in the demo document.
-\end{itemize}
\section{My retirement}