diff options
author | Karl Berry <karl@freefriends.org> | 2013-12-02 22:18:13 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-12-02 22:18:13 +0000 |
commit | ac2cf3ee05ab2a5494afa92dbbdc6d56e7518bae (patch) | |
tree | 00742fb981b2fb0e6cf8ee6b973a6f582b5d46b7 /Master/texmf-dist/doc/latex/exsheets | |
parent | c2d797847ce261ccb5b01de5ce8f45175422abb3 (diff) |
exsheets (2dec13)
git-svn-id: svn://tug.org/texlive/trunk@32302 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/exsheets')
-rw-r--r-- | Master/texmf-dist/doc/latex/exsheets/README | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/exsheets/exsheets_en.pdf | bin | 693812 -> 666983 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex | 111 |
3 files changed, 100 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/latex/exsheets/README b/Master/texmf-dist/doc/latex/exsheets/README index faed4849294..d464675a53e 100644 --- a/Master/texmf-dist/doc/latex/exsheets/README +++ b/Master/texmf-dist/doc/latex/exsheets/README @@ -1,7 +1,7 @@ -------------------------------------------------------------------------- -EXSHEETS 2013/11/20 +EXSHEETS 2013/12/02 bundled packages: -the EXSHEETS package v0.11 +the EXSHEETS package v0.12 Yet another package for the creation of exercise sheets the EXSHEETS-LISTINGS package v0.2 Using listings in exsheets diff --git a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.pdf b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.pdf Binary files differindex 3b54dfb80f5..624c25da908 100644 --- a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.pdf +++ b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.pdf diff --git a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex index 54c8e2196c1..f8fa3f14b60 100644 --- a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex +++ b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex @@ -65,6 +65,7 @@ C, checkedchoicebox,choice,choicebox, correct, + CurrentQuestionID, DebugExSheets, DeclareQuestionClass,DeclareQuestionProperty, examspace, @@ -74,6 +75,7 @@ GetQuestionProperty, grade, includequestions,iflastquestion, + IfQuestionSubtitleF,IfQuestionSubtitleT,IfQuestionSubtitleTF, lastvariant, NewQuSolPair,NewLstQuSolPair, numberofquestions, @@ -447,20 +449,18 @@ what any consequences of that will be for \ExSheets. \section{Package Options}\label{sec:options} The package \ExSheets\ has some options, namely the following ones: \begin{options} - %% color - \keyval{color}{colour}\Default{exsheetsblue} - A custom colour that is used in certain but very rare circumstances. %% counter-format \keyval{counter-format}{counter-format}\Default{qu.} Formatting of the counter of the questions. This option takes a special kind of string that is described in section~\ref{ssec:counter}. \keyval{counter-within}{counter}\Default - Resets the \code{question} counter with every step of \code{<counter>}. + Resets the \code{question} counter with every step of \meta{counter}. %% auto-label \keybool{auto-label}\Default{false} If set to \code{true} \ExSheets\ will automatically place a - \cs*{label}\Marg{qu:\meta{id}} for each question. It will also create the - question properties \code{ref} and \code{pageref}, see + \cs*{label}\Marg{qu:\meta{id}} for each question. See + section~\ref{sec:auto-label-opti} for ways to customize this. It will + also create the question properties \code{ref} and \code{pageref}, see section~\ref{sec:additional_info} for more on this. %% headings \keyval{headings}{instance}\Default{block} @@ -557,6 +557,18 @@ You can also assign bonus points by inserting \code{\meta{point}+\meta{bonus \end{question} \end{example} +The points are counted and added to the total sum of points, see +section~\ref{sec:points} for details on this. \sinceversion{0.12}Should you +want that the points of a specific question \emph{should not be added} to the +total sum then precede it with a bang \code{!}: +\begin{example} + \begin{question}{!3} + This question's points won't be added to the total sum. + \end{question} +\end{example} +Beware that this also prevents bonus points. The points simply will be +written where the heading instance puts them. + \sinceversion{0.3}On additional thing: you might want to define custom commands that should behave differently if they're inside or outside of the \env{question} environment. In this case you can use these commands: @@ -572,7 +584,7 @@ commands that should behave differently if they're inside or outside of the input stream if not. \end{commands} -\subsection{Options to the \env*{question} Environment} +\subsection{Options to the \env*{question} Environment}\label{sec:opti-ques-envir} The \env{question} environment takes one or more of the following options: \begin{options} \keychoice{type}{exam,exercise}\Module{question}\Default{exercise} @@ -625,6 +637,52 @@ for example useful when you want to print a sample solution for an exam. With \keyis{use}{false} it is fully discarded which means it is not accessible through an \acs{id} and a possible solution will not be saved. +\subsection{Subtitles to Questions} +The \option{subtitle} option mentioned in section~\ref{sec:opti-ques-envir} +can be used to add a subtitle to a question. However, unless you choose a +suitable heading (see section~\ref{sec:exsheets-headings}) it won't be +printed. Currently there is \emph{one} heading instance that uses the +subtitles but it should be easy to create a custom heading using one of the +existing ones as a starter example. When creating such a heading you may want +to distinguish between the cases when a subtitle has been given and when no +subtitle is present. This can be done with the following commands: +\begin{commands} + \expandable\command{IfQuestionSubtitleTF}[\marg{true code}\marg{false code}] + Tests if the current question has a subtitle. Leaves either \meta{true + code} or \meta{false code} in the input stream. + \expandable\command{IfQuestionSubtitleT}[\marg{true code}] + Tests if the current question has a subtitle. Leaves \meta{true code} in + the input stream if it has. + \expandable\command{IfQuestionSubtitleF}[\marg{false code}] + Tests if the current question has a subtitle. Leaves \meta{false code} in + the input stream if it hasn't. +\end{commands} + +A subtitle is also a property of a question in the sense of +section~\ref{sec:additional_info}. That means if a subtitle is given it can +be retrieved with \cs{GetQuestionProperty}. + +As an example you could define your own heading instance that prints the +\acs{id} of a question and (if given) the subtitle: + +\begin{sourcecode} + \DeclareInstance{exsheets-heading}{QE}{default}{ + join = { + title[r,B]number[l,B](.333em,0pt) ; + title[r,B]subtitle[l,B](1em,0pt) + } , + attach = { + main[l,vc]title[l,vc](0pt,0pt) ; + main[r,vc]points[l,vc](\marginparsep,0pt) + } , + subtitle-post-code = {ID: \CurrentQuestionID} , + number-post-code = {\IfQuestionSubtitleF{ID: \CurrentQuestionID}} + } +\end{sourcecode} + +Please see section~\ref{sec:exsheets-headings} for more details on heading +instances. + \subsection{The \env*{solution} Environment} If you want to save/print (more on the exact usage in section~\ref{sec:solutions}) a solution you have to use the \env{solution} @@ -987,9 +1045,8 @@ the following command: \begin{commands} \command{DebugExSheets}[\Marg{\choices{true,false}}] Enable or disable visual \ExSheets' debugging. - \command{CurrentQuestionID} - \sinceversion{0.4a}Expands to the current question \acs{id} (after two - expansions). + \expandable\command{CurrentQuestionID} + \sinceversion{0.4a}Expands to the current question \acs{id}. \end{commands} Let's create some more questions and take a look what this command does: \begin{example} @@ -1168,9 +1225,12 @@ Now the commands for recovering the properties: Recover the number of the question with the \acs{id} \meta{id}. The number is displayed according to the format set with \option{counter-format}. - \command{GetQuestionProperty}[\marg{name}\marg{id}] + \expandable\command{GetQuestionProperty}[\marg{name}\marg{id}] Recover the property \meta{name} of the question with the \acs{id} - \meta{id}. Of course the property must have been declared before. + \meta{id}. Of course the property must have been declared before. The + command is expandable. Since\sinceversion{0.12} the properties of a + question are written to the \code{aux} file it is possible to retrieve + them before the corresponding \env{question} environment has been used. \end{commands} Let's say we have declared the properties \code{notes}, \code{reference} and @@ -1233,7 +1293,8 @@ It is now possible to recover these values later: \sinceversion{0.7a}If you use the package option \option{auto-label} the properties \code{ref} and \code{pageref} are predefined which will call the -corresponding \cs*{ref} or \cs*{pageref}, respectively. +corresponding \cs*{ref} or \cs*{pageref}, respectively. Also see +section~\ref{sec:auto-label-opti}. Please note that these properties \emph{are not the same} as the dividing concepts explained in section~\ref{sec:dividing-concepts} although they may @@ -1462,6 +1523,30 @@ following macro: usage of \cs{includequestions}. \end{commands} +\section{The \option*{auto-label} Option}\label{sec:auto-label-opti} +The\sinceversion{0.12} package option \option{auto-label} sets a +\cs*{label}\Marg{qu:\meta{id}} every time the question environment is used. +Both the used command and the automated label can be customized using the +following options: + +\begin{options} + \keyval{label-format}{code}\Default{qu:\#1} + The pattern for generating the automatic label. \code{\#1} gets replaced + by the \ac{id} of the corresponding question. + \keyval{label-cmd}{macro}\Default{\cs*{label}} + The command used for generating the label. A command that should take one + mandatory argument. + \keyval{ref-cmd}{macro}\Default{\cs*{ref}} + The command used in the \code{ref} property created by the + \option{auto-label} option, also see section \ref{sec:additional_info}. + The command should take one mandatory argument. + \keyval{pageref-cmd}{macro}\Default{\cs*{pageref}} + The command used in the \code{pageref} property created by the + \option{auto-label} option, also see section \ref{sec:additional_info}. + The command should take one mandatory argument. +\end{options} + + \section{Own Question/Solution Pairs} \noindent\changedversion{0.9}\ExSheets\ provides he possibility to create new environments that behave like the \env{question} and \env{solution} |