diff options
author | Karl Berry <karl@freefriends.org> | 2019-09-30 21:52:46 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-09-30 21:52:46 +0000 |
commit | 6c0fed440c27ba0d6856feeb1000320320cf8a96 (patch) | |
tree | 8cc4e971b5e90015e329853a2213f557eb5c9cd8 /Master/texmf-dist/doc/latex/xsim | |
parent | ea9225ae59ad8eedf594cd44fcb2e37414995215 (diff) |
xsim (30sep19)
git-svn-id: svn://tug.org/texlive/trunk@52232 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/xsim')
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/README | 9 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.pdf | bin | 30541 -> 30938 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.tex | 6 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/xsim.history | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/xsim.ideas | 3 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/xsim_manual.pdf | bin | 1163299 -> 1225761 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/xsim/xsim_manual.tex | 48 |
7 files changed, 46 insertions, 25 deletions
diff --git a/Master/texmf-dist/doc/latex/xsim/README b/Master/texmf-dist/doc/latex/xsim/README index 1c1284233fd..722702fd3ca 100644 --- a/Master/texmf-dist/doc/latex/xsim/README +++ b/Master/texmf-dist/doc/latex/xsim/README @@ -1,5 +1,5 @@ -------------------------------------------------------------------------- -XSIM 2018/02/12 v0.11 +XSIM 2019/09/30 v0.12 eXercise Sheets IMproved @@ -8,7 +8,7 @@ Clemens Niederberger 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 @@ -25,6 +25,7 @@ The Current Maintainer of this work is Clemens Niederberger. The xsim package consists of the code files: xsim.sty xsimverb.sty + xsim.auxfile.code.tex xsim.base.code.tex xsim.blanks.code.tex xsim.collections.code.tex @@ -34,11 +35,11 @@ The xsim package consists of the code files: xsim.goals.code.tex xsim.grades.code.tex xsim.interface.code.tex - xsim.layouts.code.tex xsim.modules.code.tex xsim.properties.code.tex xsim.random.code.tex xsim.solutions.code.tex + xsim.style.layouts.code.tex xsim.tags.code.tex xsim.templates.code.tex xsim.translations.code.tex @@ -63,8 +64,8 @@ The xsim package consists of the example files: xsim.grade-distribution.tex, xsim.grade-distribution.pdf xsim.hints.tex, xsim.hints.pdf xsim.listings.tex, xsim.listings.pdf - xsim.multiplechoice.tex, xsim.multiplechoice.pdf xsim.listofexercises.tex, xsim.listofexercises.pdf + xsim.multiplechoice.tex, xsim.multiplechoice.pdf xsim.pointsums.tex, xsim.pointsums.pdf xsim.randomexercises.tex, xsim.randomexercises.pdf xsim.various.tex, xsim.various.pdf diff --git a/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.pdf b/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.pdf Binary files differindex bbbcfbc18a7..72894ac9a63 100644 --- a/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.pdf +++ b/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.pdf diff --git a/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.tex b/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.tex index f753f13939e..66afaf9b8ad 100644 --- a/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.tex +++ b/Master/texmf-dist/doc/latex/xsim/examples/xsim.code-and-output.tex @@ -10,7 +10,7 @@ } \makeatletter -\NewDocumentEnvironment{example}{o} +\NewDocumentEnvironment{example}{!o} {% \XSIMgobblechars{2}% \XSIMsetfilebegin{\@percentchar\space file `\jobname.tmp'}% @@ -25,7 +25,7 @@ \input{\jobname.tmp} } -\NewDocumentEnvironment{code}{o} +\NewDocumentEnvironment{code}{!o} {% \XSIMgobblechars{2}% \IfNoValueTF{#1} @@ -46,7 +46,7 @@ \bigskip -\begin{code} +\begin{code}[] blubber \LaTeX \end{code} diff --git a/Master/texmf-dist/doc/latex/xsim/xsim.history b/Master/texmf-dist/doc/latex/xsim/xsim.history index b0a2fe526bd..a22d42ad031 100644 --- a/Master/texmf-dist/doc/latex/xsim/xsim.history +++ b/Master/texmf-dist/doc/latex/xsim/xsim.history @@ -7,7 +7,7 @@ Clemens Niederberger 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 @@ -111,3 +111,6 @@ HISTORY: - introduce a \xsim_if_<tagging>_value:nTF for each tag kind - \ProvideExerciseTagging + v0.12 2019/09/30 - add parameter versions for the plural forms of exercise + and solution names + - bug fixes (issues 37, 39, 43, 47) diff --git a/Master/texmf-dist/doc/latex/xsim/xsim.ideas b/Master/texmf-dist/doc/latex/xsim/xsim.ideas index 29fa058fded..7a7810f84de 100644 --- a/Master/texmf-dist/doc/latex/xsim/xsim.ideas +++ b/Master/texmf-dist/doc/latex/xsim/xsim.ideas @@ -7,7 +7,7 @@ Clemens Niederberger 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 @@ -29,3 +29,4 @@ IDEAS: - provide a switch: either write the environments to an external file or save it to an auxiliary file ? (not really sure about this one -- probably not) +- some kind of `subexercise' mechanism diff --git a/Master/texmf-dist/doc/latex/xsim/xsim_manual.pdf b/Master/texmf-dist/doc/latex/xsim/xsim_manual.pdf Binary files differindex 2cc93eb00b0..bfd2c316412 100644 --- a/Master/texmf-dist/doc/latex/xsim/xsim_manual.pdf +++ b/Master/texmf-dist/doc/latex/xsim/xsim_manual.pdf 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 |