summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/xsim/xsim_manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/xsim/xsim_manual.tex')
-rw-r--r--Master/texmf-dist/doc/latex/xsim/xsim_manual.tex48
1 files changed, 32 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/xsim/xsim_manual.tex b/Master/texmf-dist/doc/latex/xsim/xsim_manual.tex
index 53c620c1bb7..afc17fd68a2 100644
--- a/Master/texmf-dist/doc/latex/xsim/xsim_manual.tex
+++ b/Master/texmf-dist/doc/latex/xsim/xsim_manual.tex
@@ -13,7 +13,7 @@
% Web: https://github.com/cgnieder/xsim
% E-Mail: contact@mychemistry.eu
% ----------------------------------------------------------------------------
-% Copyright 2017--2018 Clemens Niederberger
+% Copyright 2017--2019 Clemens Niederberger
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
@@ -218,7 +218,7 @@ As can be seen in the example a solution is not printed with the default
setup. This can be changed using the following option.
\begin{options}
\keybool{print}\Module{solution}\Default{false}
- Set if solutions are printed or or not.
+ Set if solutions are printed or not.
\end{options}
The option (belonging to the module \module*{solution}) can either be set
@@ -238,13 +238,13 @@ or with the setup command for all following solutions:
There is an completely analoguous option for the \env{exercise} environment:
\begin{options}
\keybool{print}\Module{exercise}\Default{true}
- Set if exercises are printed or or not.
+ Set if exercises are printed or not.
\end{options}
More details on those two environments can be found in
section~\vref{sec:using-printing}.
\section{How the Exercise Environments Work}\label{sec:how-exerc-envir}
-Both the exercise and the solution enviroments write the contents of their
+Both the exercise and the solution environments write the contents of their
bodies verbatim to external files following a certain naming structure:
\begin{itemize}
\item
@@ -252,7 +252,7 @@ bodies verbatim to external files following a certain naming structure:
\end{itemize}
The name starts with the name of the job (which is the name of the document
itself) followed by type and id of the corresponding exercise and then
-followed by the environment type. For example both enviroments from the first
+followed by the environment type. For example both environments from the first
example have been written to files named
\begin{itemize}
\item \verbcode+xsim_manual-exercise-1-exercise-body.tex+ and
@@ -287,9 +287,12 @@ order to deal with this somehow \xsim\ offers the following option:
auxiliary files.
\end{options}
-Another thing to keep in mind: the environment in many ways works the same way
-as the \env{filecontents} environment. \emph{This also means that you
- \emph{cannot} have comments on the first line of the environments:}
+\begin{bewareofthedog}
+ Another thing to keep in mind: the environment in many ways works the same
+ way as the \env{filecontents} environment. \emph{This also means that you
+ \emph{cannot} have comments or \cs*{label}s or anything else on the first
+ line of the environments!}
+\end{bewareofthedog}
\begin{sourcecode}
\begin{exercise}[points=2] % this comment will cause trouble
Lorem ipsum
@@ -357,7 +360,9 @@ Declaring a new exercise type will also define a new command:
exercise-env = exercise ,
solution-env = solution ,
exercise-name = \XSIMtranslate{exercise} ,
+ exercises-name = \XSIMtranslate{exercises} ,
solution-name = \XSIMtranslate{solution} ,
+ solutions-name = \XSIMtranslate{solutions} ,
exercise-template = default ,
solution-template = default
}
@@ -375,9 +380,17 @@ must) be set. Here is the complete list:
\paraval{exercise-name}{exercise name}
The name of the exercises of type \meta{type} -- used for typesetting.
\emph{This parameter is mandatory.}
+ \paraval{exercises-name}{exercises name}
+ The\sinceversion{0.12} plural name of the exercises of type \meta{type} --
+ used for typesetting. If this is not set explicitly an \code{s} is
+ appended to the singular name.
\paraval{solution-name}{solution name}
The name of the solutions of type \meta{type} -- used for typesetting.
\emph{This parameter is mandatory.}
+ \paraval{solutions-name}{solutions name}
+ The\sinceversion{0.12} plural name of the solutions of type \meta{type} --
+ used for typesetting. If this is not set explicitly an \code{s} is
+ appended to the singular name.
\paraval{exercise-template}{exercise template}
The template used for typesetting the exercises of type \meta{type}.
\emph{This parameter is mandatory.} See
@@ -446,7 +459,7 @@ Exercise like the \env{exercise} environment and possibly others defined with
Holds the user id of an exercise if defined. Otherwise it is equal to
\property{id}.
\propval{counter}{text}
- Holds the counter value represenation of an exercise (\ie, what you
+ Holds the counter value representation of an exercise (\ie, what you
usually know as \cs*{the\meta{counter}}). \emph{Cannot be set by the
user}.
\propval{counter-value}{integer}
@@ -477,19 +490,19 @@ Exercise like the \env{exercise} environment and possibly others defined with
\propval{topics}{csv list of topics}
Holds the list of topics the exercise should be associated with.
\propval{page}{text}
- Holds the page counter value represenation of an exercise (\ie, what you
+ Holds the page counter value representation of an exercise (\ie, what you
usually know as \cs*{thepage}).
\propval{page-value}{integer}
Holds the page counter value of an exercise (\ie, what you usually know as
\cs*{arabic}\Marg{page}).
\propval{section}{text}
- Holds the section counter value represenation of an exercise (\ie, what
+ Holds the section counter value representation of an exercise (\ie, what
you usually know as \cs*{thesection}).
\propval{section-value}{integer}
Holds the section counter value of an exercise (\ie, what you usually know
as \cs*{arabic}\Marg{section}).
\propval{chapter}{text}
- Holds the chapter counter value represenation of an exercise (\ie, what
+ Holds the chapter counter value representation of an exercise (\ie, what
you usually know as \cs*{thechapter}). \emph{Only if a command
\cs*{chapter} \emph{and} a counter \code{chapter} exist.}
\propval{chapter-value}{integer}
@@ -631,7 +644,7 @@ available (after a compilation) throughout the document.
respectively. The starred version prints nothing. Defined in terms of
\cs{AddtoExerciseGoal} and \cs{AddtoExerciseGoalPrint}.
\command{points}[\marg{value}]
- Print \meta{value}followed by an appropriate translation of the words
+ Print \meta{value} followed by an appropriate translation of the words
\enquote{point} or \enquote{points}, respectively. Defined in terms of
\cs{ExerciseGoalValuePrint}.
\command{printbonus}[\marg{type}]
@@ -709,7 +722,7 @@ following code:
\begin{sourcecode}
\DeclareExerciseTagging{tags}
\DeclareExerciseTagging{topics}
- \xsimsetup{tags/ingore-untagged=false}
+ \xsimsetup{tags/ignore-untagged=false}
\end{sourcecode}
This means that these options are available:
\begin{options}
@@ -1536,7 +1549,7 @@ Table templates are used by \cs{gradingtable}. Those are the templates set
with the option \option{template} of module \module{grading-table}
The predefined templates are \enquote{\code{default}} and
-\enquote{\code{default}}, see sections~\vref{sec:table-templ-default}
+\enquote{\code{default*}}, see sections~\vref{sec:table-templ-default}
and~\vref{sec:table-templ-default*}.
\subsection{Examples}\label{sec:template-examples}
@@ -1938,7 +1951,7 @@ Those are the options for customization:
\keyval{linespread}{decimal number}\Module{blank}\Default{\code{1}}
Set the linespread for the blank lines. This only has an effect if
\cs{blank} is used at the begin of a paragraph.
- \keyval{line-increment}{dim}\Module{blank}\Default{\code{1pt}}
+ \keyval{line-increment}{dim}\Module{blank}\Default{\code{0.001\cs*{linewidth}}}
The blank line is built in multiples of this value. If the value is too
large you may end up with uneven lines. If the value is too small you may
end up with a non-ending compilation. Experiment with values to find the
@@ -2281,6 +2294,9 @@ package work or how different kinds of problems can be solved or how different
kinds of layouts can be achieved as well as how to solve concrete problems
that have come up in different \LaTeX\ forums.
+Besides showing excerpts of the code and the resulting pdf the examples below
+also link to both the \code{tex} source the resulting pdf.
+
\listexamplefiles
\printbibliography