diff options
author | Karl Berry <karl@freefriends.org> | 2014-07-20 22:05:15 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-07-20 22:05:15 +0000 |
commit | 0e871146bcb1bf041dac127d5b76011aa31e28aa (patch) | |
tree | 527340c7b55c4780d82bb55b95844d571ed58ace /Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex | |
parent | 320402419add6802f1b48c988bea73773d0d67d4 (diff) |
exsheets (20jul14)
git-svn-id: svn://tug.org/texlive/trunk@34665 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex | 150 |
1 files changed, 89 insertions, 61 deletions
diff --git a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex index a96d6c2584c..728d373118f 100644 --- a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex +++ b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex @@ -1,8 +1,8 @@ % arara: pdflatex % !arara: biber +% arara: pdflatex % !arara: pdflatex % !arara: pdflatex -% arara: pdflatex % -------------------------------------------------------------------------- % the EXSHEETS package % @@ -31,7 +31,7 @@ % feel free to contact me. % -------------------------------------------------------------------------- \documentclass[load-preamble+,scrartcl={DIV10}]{cnltx-doc} -\usepackage[load-headings,load-tasks]{exsheets} +\usepackage{exsheets} \setcnltx{ package = {exsheets} , authors = Clemens Niederberger , @@ -39,8 +39,7 @@ url = {https://bitbucket.org/cgnieder/exsheets/} , title = the \ExSheets\ bundle , info = {% - the packages \ExSheets, \ExSheetslistings, \href{tasks_en.pdf}{\Tasks} and - \href{cntformats_en.pdf}{\cntformats}\\ + the packages \ExSheets{} and \ExSheetslistings \\ \emph{or}\\ Yet another package for the creation of exercise sheets and exams.% } , @@ -75,6 +74,7 @@ GetQuestionProperty, grade, includequestions,iflastquestion, + IfQuestionPropertyF,IfQuestionPropertyT,IfQuestionPropertyTF, IfQuestionSubtitleF,IfQuestionSubtitleT,IfQuestionSubtitleTF, lastvariant, NewQuSolPair,NewLstQuSolPair, @@ -133,8 +133,6 @@ \usepackage{exsheets-listings} \edef\exsheetslistingsverion{v\csname exsheets@listings@version\endcsname} -\edef\cntfmtsversion{\csname @cntfmts@version\endcsname} -\edef\tasksversion{v\csname @tasks@version\endcsname} \microtypesetup{tracking=scshape} @@ -282,18 +280,14 @@ in section~\ref{sec:additional_info}. Then there is --~at least in Germany~-- the habit of having lists of exercises aligned in columns but counting from the left to the right instead from up to -down. \ExSheets\ provides a possibility for that (see the \Tasks\ package). -I am not quite content with it as it works now, though\footnote{There are - still other possibilities, for example take a look here: - \url{http://tex.stackexchange.com/questions/67966/enumerate-in-multicols} or - at the \pkg{multienum} package~\cite{pkg:multienum}.}. - -On the other hand \ExSheets\ doesn't --~and probably won't~-- offer a real -possibility for creating multiple choice questions. As a fact it doesn't -provide many (if any) means to specify the \emph{type} of question or the -structure. If these are your needs take a look at -\pkg{examdesign}~\cite{pkg:examdesign}, for example. Or exploit the -possibilities \pkg{enumitem}~\cite{pkg:enumitem} gives you. +down. That's why the \pkg{tasks} package was developed as part of \ExSheets{} +and was ditrsibuted as part of the bundle\changedversion{0.15}. Now it is a +package of its own but is loaded by \ExSheets{} automatically with the +necessary setup to make them work together nicely. + +\ExSheets{} has no native support for multiple choice tests but that doesn't +mean that you can't create them with \ExSheets. It just means that they may +be a bit more work with \ExSheets{} than with other packages. I had the idea for this package in 2008. Back then my \TeX{} skills were by far not good enough to write it. Actually, even today I wouldn't have been @@ -304,21 +298,17 @@ wider usage. At the time of writing (\today) there still are probably lots of rough edges let alone bugs so I am very interested in all kinds of feedback. \section{Additional Packages} -\ExSheets\ actually bundles four packages: \ExSheets, \ExSheetslistings\ -\Tasks\ and \cntformats. \ExSheetslistings\ is an add-on to \ExSheets\ -that offers some functionality to use \pkg{listings} with \ExSheets. It is -presented in part~\ref{part:listings}. - -The \Tasks\ package and the \cntformats\ package have their own -documentation. These packages provide functionality that is used by -\ExSheets. They can, however, be used independently from \ExSheets. - -The package \cntformats\ is probably not really useful on a user-level but -maybe for package writers. +\ExSheets\ actually bundles two packages: \ExSheets, \ExSheetslistings. +\ExSheetslistings\ is an add-on to \ExSheets\ that offers some functionality +to use \pkg{listings} with \ExSheets. It is presented in +part~\ref{part:listings}. \ExSheets\ used to bundle the \pkg{translations} package, too\changedversion{0.9i}, but doesn't any more. You can find the -\pkg{translations} package as a package of it's own on the \ac{ctan}. +\pkg{translations} package as a package of it's own on the \ac{ctan}. It also +used to bundle the packages \pkg{tasks} and +\pkg{cntformats}\changedversion{0.15}. They're available now as packages of +their own as well. \section{Installation and Documentation} If you install \ExSheets\ manually beware to put the files @@ -327,26 +317,23 @@ If you install \ExSheets\ manually beware to put the files \item[]\verb+exsheets_headings.cfg+ \end{itemize} in the same directory as the \code{exsheets.sty} file\footnote{That is, a - directory like \code{texmf-local/tex/latex/exsheets}, probably}. You -\emph{can} install the other packages, \Tasks\ and \cntformats, in different -locations but since they belong to \ExSheets\ they probably should be placed -in the same directory. - -You should put the file \code{tasks.cfg} in the same directory as the -\code{tasks.sty} file. + directory like \code{texmf-local/tex/latex/exsheets}, probably}. As with every manual package installation you need to make sure to put the files in a directory where \TeX\ can find them and afterwards update the database. -\subsection{The \Tasks\ Package} -\noindent\sinceversion{0.9a}The \Tasks\ package has got its own documentation -- -\url{tasks_en.pdf}. Please read that file for details on the package. +\subsection{The \pkg*{tasks} Package} +The \pkg{tasks} package~\cite{pkg:tasks} used to be part of the \ExSheets\ +bundle but is a package of its own now\changedversion{0.15} and released +independently. You can find it as every other package on \ctan\ and in a full +\TeX~Live or \hologo{MiKTeX} installation. -\subsection{The \cntformats\ Package} -\noindent\sinceversion{0.5}The \cntformats\ package has got its own -documentation -- \url{cntformats_en.pdf}. Please read that file for details -on the package. +\subsection{The \pkg*{cntformats} Package} +The \pkg{cntformats} package~\cite{pkg:cntformats} used to be part of the +\ExSheets\ bundle but is a package of its own now\changedversion{0.15} and +released independently. You can find it as every other package on \ctan\ and +in a full \TeX~Live or \hologo{MiKTeX} installation. \subsection{The \pkg*{translations} Package} The \pkg{translations} package~\cite{pkg:translations} used to be part of the @@ -430,14 +417,26 @@ New options: \item New option \option{post-hook} to the \env{question} environment that allows to add code directly after the question body, see section~\ref{sec:opti-ques-envir}. - \item New command \cs{ExSheetsHeading}. + \item New command \cs{ExSheetsHeading}, see + section~\ref{sec:using-an-exsheets}. \item New pre-defined question properties \code{question-body}, - \code{bonus-points} and \code{counter}, see section - \ref{sec:additional_info}. + \code{bonus-points} and \code{counter}, see + section~\ref{sec:additional_info}. \item New option \option{save-to-aux}, see section \ref{sec:additional_info}. \end{itemize} +\subsection{Version 0.15} +\begin{itemize} + \item The packages \pkg{tasks} and \pkg{cntformats} have been removed from + the bundle and are now distributed as packages of their own. + \item The options \option*{load-headings} and \option*{load-tasks} have been + dropped. The optional functionality they provided is now provided all the + time. + \item New command \cs{IfQuestionPropertyTF}, see + section~\ref{sec:additional_info}. +\end{itemize} + \section{Thanks} I need to thank the many users who gave me feedback so far! For one thing this shows me that \ExSheets\ is useful to people. It also led to many @@ -512,14 +511,14 @@ The package \ExSheets\ has some options, namely the following ones: This code is placed immediately before the subtitle of the questions and solutions. It only has an effect with a title instance that uses the subtitle coffin, see section~\ref{sec:exsheets-headings}. - %% load-headings - \keybool{load-headings}\Default{false} - Loads additional styles for the headings. More on this is described in - section~\ref{sec:exsheets-headings}. - %% load-tasks - \keybool{load-tasks}\Default{false} - Loads additional styles for the \env{tasks} environment. See - the \href{tasks_en.pdf}{documentation of the \Tasks\ package}. + % %% load-headings + % \keybool{load-headings}\Default{false} + % Loads additional styles for the headings. More on this is described in + % section~\ref{sec:exsheets-headings}. + % %% load-tasks + % \keybool{load-tasks}\Default{false} + % Loads additional styles for the \env{tasks} environment. See + % the \href{tasks_en.pdf}{documentation of the \Tasks\ package}. %% totoc \keybool{totoc}\Default{false} This option adds the questions and solutions with their names and numbers @@ -1291,6 +1290,12 @@ Now the commands for recovering the properties: command is expandable. Since\changedversion{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. + \expandable\command{IfQuestionPropertyTF}[\marg{name}\marg{id}\marg{true}\marg{false}] + A command\sinceversion{0.15} that returns \meta{true} if the question with + the \acs{id} \meta{id} has the property \meta{name} and \meta{false} + otherwise. The variants \cs{IfQuestionPropertyT} and + \cs{IfQuestionPropertyF} also exist which only have the \meta{true} or the + \meta{false} branch. \end{commands} Let's say we have declared the properties \code{notes}, \code{reference} and @@ -1849,12 +1854,10 @@ handle pairs. \end{figure} The following subsections will show all definitions of the instances available -with the package option \option{load-headings} and how they look. This will -hopefully give you enough ideas to create your own instance if you want to -have another heading style than the ones available. - -Of you use the option \option{load-headings} each of the following instances is -available through the option \key{headings}{instance}. +and how they look. This will hopefully give you enough ideas to create your +own instance if you want to have another heading style than the ones +available. Each of the following instances is available through the option +\key{headings}{instance}. The following examples use a sample text defined as follows: \begin{sourcecode} @@ -2352,6 +2355,31 @@ Text before A `fancy-wp' heading. \sample \end{question} +\subsection{Using an \ExSheets{} Heading in Custom Code}\label{sec:using-an-exsheets} + +It can be useful to have access to \ExSheets{} headings in custom code. This +is possible with the following command\sinceversion{0.14}: + +\begin{commands} + \command{ExSheetsHeading}[\marg{instance}\marg{title}\marg{number}% + \marg{points}\marg{bonus}\marg{id}] + The meaning of the arguments is as follows: + \begin{itemize} + \item \meta{instance}: the name of the headings instance to be used. + \item \meta{title}: the contents of the \code{title} coffin. + \item \meta{number}: the contents of the \code{number} coffin. + \item \meta{points}: The number of points given to the question. If + non-zero this will cause the points to be printed in the \code{points} + coffin. + \item \meta{bonus}: the same as \meta{points} but for bonus points. + \item \meta{id}: the \acs{id} of the question this heading belongs to. + \end{itemize} +\end{commands} + +In combination with \cs{ForEachQuestion} the command can be used to build a +custom list of questions. An example of its usage can be seen at the German +Q\&A~site \TeX welt: \url{http://texwelt.de/wissen/fragen/6698#6738}. + \subsection{Load Custom Configurations} If you have custom configurations you want to be loaded automatically then save them in a file \code{exsheets\_configurations.cfg}. If this file is present it |