summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex114
1 files changed, 88 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex
index 74ed6fdc596..d71603bff11 100644
--- a/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex
+++ b/Master/texmf-dist/doc/latex/exsheets/exsheets_en.tex
@@ -26,10 +26,21 @@
%
% The Current Maintainer of this work is Clemens Niederberger.
% --------------------------------------------------------------------------
-% The exsheets package consists of the files
+% The exsheets bundle consists of the files
% - exsheets.sty, exsheets_headings.def, exsheets_headings.cfg,
% exsheets_configurations.cfg,
-% - exsheets_en.tex, exsheets_en.pdf,
+% exsheets_en.tex, exsheets_en.pdf
+%
+% - tasks.sty, tasks.cfg, tasks_en.tex, task_en.pdf
+%
+% - translations.sty, translations_en.tex, translations_en.pdf,
+% translations-basic-dictionary-english.trsl,
+% translations-basic-dictionary-french.trsl,
+% translations-basic-dictionary-german.trsl,
+% translations-basic-dictionary-spanish.trsl
+%
+% - cntformats.sty, cntformats_en.tex, cntformats_en.pdf
+%
% - README
% --------------------------------------------------------------------------
% If you have any ideas, questions, suggestions or bugs to report, please
@@ -41,8 +52,9 @@
% https://bitbucket.org/cgnieder/cnpkgdoc/
% the class is licensed LPPL 1.3 or later
%
-% use `xelatex' and `biber' for compilation
+% use `pdflatex' and `biber' for compilation
%
+\PassOptionsToPackage{supstfm=libertinesups}{superiors}
\documentclass[DIV10,toc=index,toc=bib,numbers=noendperiod]{cnpkgdoc}
% ----------------------------------------------------------------------------
% document layout and typographic features
@@ -50,9 +62,13 @@
pkg = {[load-headings,load-tasks]exsheets} ,
url = {https://bitbucket.org/cgnieder/exsheets/} ,
title = the ExSheets bundle ,
- subtitle = {the packages \ExSheets, \Tasks, \translations and \cntformats\\
+ subtitle = {%
+ the packages \ExSheets, \href{tasks_en.pdf}{\Tasks},
+ \href{translations_en.pdf}{\translations} and
+ \href{cntformats_en.pdf}{\cntformats}\\
\emph{or}\\
- Yet another package for the creation of exercise sheets and exams.} ,
+ Yet another package for the creation of exercise sheets and exams.%
+ } ,
name = ExSheets ,
language = en ,
modules = true ,
@@ -170,7 +186,7 @@
\makeindex[options={-s \jobname.ist},intoc,columns=3]
\usepackage{csquotes}
-\usepackage[backend=biber]{biblatex}
+\usepackage[backend=biber,style=alphabetic]{biblatex}
\addbibresource{biblatex-examples.bib}
\addbibresource{\jobname.bib}
@@ -181,49 +197,56 @@
maintainer = {Joseph Wright},
date = {2010-10-11},
version = {2.13},
- url = {http://www.ctan.org/pkg/answers/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/answers/}
}
@package{enumitem,
title = {enumitem},
author = {Javier Bezos},
date = {2011-09-28},
version = {3.5.2},
- url = {http://www.ctan.org/pkg/enumitem/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/enumitem/}
+}
+@package{eqexam,
+ title = {eqexam},
+ author = {D. P. Story},
+ date = {2011-09-01},
+ version = {3.0k},
+ url = {http://mirror.ctan.org/macros/latex/contrib/eqexam/}
}
@package{exam,
title = {exam},
author = {Philip Hirschhorn},
date = {2011-05-22},
version = {2.4},
- url = {http://www.ctan.org/pkg/exam/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/exam/}
}
@package{examdesign,
title = {examdesign},
author = {Jason Alexander},
date = {2001-03-26},
version = {1.1},
- url = {http://www.ctan.org/pkg/examdesign/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/examdesign/}
}
@package{exercise,
title = {exercise},
author = {Paul Pichaureau},
date = {2012-05-08},
version = {1.58},
- url = {http://www.ctan.org/pkg/answers/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/answers/}
}
@package{multienum,
title = {multienum},
author = {Dennis Kletzing},
date = {2005-05-19},
version = {n.n.},
- url = {http://www.ctan.org/pkg/multienum/}
+ url = {http://mirror.ctan.org/macros/latex/contrib/multienum/}
}
@package{probsoln,
title = {probsoln},
author = {Nicola L. C. Talbot},
- date = {2011-12-10},
- version = {3.02},
- url = {http://www.ctan.org/pkg/probsolns/}
+ date = {2012-08-23},
+ version = {3.04},
+ url = {http://mirror.ctan.org/macros/latex/contrib/probsoln/}
}
\end{filecontents}
@@ -338,10 +361,11 @@ It has the status ``maintained.''
\section{Motivation}\secidx[Motivation]{Preliminary}
There are already quite a number of packages that allow the creation of exercise
-sheets or written exams. Just to name the most common ones: \paket{exam}~\cite{exam},
-\paket{examdesign}~\cite{examdesign}, \paket{exercise}~\cite{exercise},
-\paket{probsoln}~\cite{probsoln}, \paket{answers}~\cite{answers} (and
-\href{http://www.ctan.org/characterization/primary/document-types/exams-exercise-sets-and-answers/}{many more}).
+sheets or written exams. Just to name the most common ones:
+\paket*{eqexam}~\cite{eqexam}, \paket*{exam}~\cite{exam},
+\paket*{examdesign}~\cite{examdesign}, \paket*{exercise}~\cite{exercise},
+\paket*{probsoln}~\cite{probsoln}, \paket*{answers}~\cite{answers} (and many more%
+\footnote{see \url{http://www.ctan.org/characterization/primary/document-types/exams-exercise-sets-and-answers/}}).
One thing I missed in all packages that I've tried out\footnote{Well, probably I
didn't try hard enough\ldots} was a high flexibility in choosing which questions
@@ -367,14 +391,14 @@ the \paket*{multienum} package~\cite{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 \paket{examdesign}, for example. Or exploit
-the possibilities \paket{enumitem}~\cite{enumitem} gives you.
+these are your needs take a look at \paket{examdesign}~\cite{examdesign}, for
+example. Or exploit the possibilities \paket{enumitem}~\cite{enumitem} gives you.
-I had the idea for this package in 2008. Back then my \TeX\ skills were by far
+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 able to
realize it without all the l3 packages like \paket*{l3kernel} and \paket*{l3packages}.
-I actively began to develop \ExSheets in spring 2011 but it wasn't until now
-(September 2012) that I consider it stable enough for wider usage. At the time
+I actively began to develop \ExSheets in spring~2011 but it wasn't until now
+(September~2012) that I consider it stable enough for 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.
@@ -428,6 +452,19 @@ actually lead to the most annoying changes. In this case say
I am very sorry for any inconvenience! I am trying to keep such changes as minimal
and rare as possibly. However, it is not always avoidable when a package is new
and still a child. It will grow up eventually.
+
+\ExSheets' other packages -- \href{tasks_en.pdf}{\Tasks},
+\href{translations_en.pdf}{\translations} and \href{cntformats_en.pdf}{\cntformats}
+-- have gotten their own documentation which are essentially extracted from this
+very document you're reading now. They still will be documented in the main
+documentation (this document), though. Right now (April~25th~2013) the separate
+documentations do not contain much more information than is written here but they
+might, in time, get more details about the corresponding package.
+
+\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 improvements
+like new features and countless bug fixes.
\secidx*{Preliminary}
\part{The \ExSheets package}\label{part:exsheets}\secidx{\ExSheets}[ExSheets]
@@ -814,6 +851,9 @@ You have two possibilities to display and count them:
option allows to set an extra word for it.
\Option[points]{use-name}{\default{true}|false}\Default{true}
Don't display the name at all. Or do.
+ \Option[points]{format}{<code>}\Default{\cmd*{@firtsofone}}
+ \sinceversion{0.9d}Format number plus name as a whole. Ideally \code{<code>} would
+ end with a command that takes an argument. Else number plus name will be braced.
\Option[points]{number-format}{<any code>}\Default{}
This option allows formatting of the number, \eg italics:
\key{number-format}{\cmd{textit}}.
@@ -2118,6 +2158,11 @@ will be loaded \cmd*{AtBeginDocument}.
\part{The \Tasks package (\tasksversion)}\label{part:tasks}
\secidx{\Tasks}[tasks]
+\section{About the Documentation}
+\noindent\sinceversion{0.9a}The \Tasks package got its own documentation --
+\url{tasks_en.pdf}. This effectively means that the following part won't be
+updated any more. Updates will go in the linked file instead.
+
\section{Motivation}\secidx[Motivation]{\Tasks}[tasks]
\noindent\changedversion{0.7}Originally \Tasks has been an integral part of
\ExSheets. However, users told me that it indeed could be useful to have it as a
@@ -2255,6 +2300,11 @@ The environment itself has some more options, namely these:
Sets the width of the item labels.
\Option{label-offset}{<dim>}\Default{.3333em}
\sinceversion{0.7}Sets the offset, \emph{i.e.}, the distance between label and item.
+ \Option{item-indent}\Default{2.5em}
+ \sinceversion{0.9a}The indent of an item, \textit{i.e.}, the horizontal space
+ available for both label and label-offset. If \code{indent = label-width + label=offset}
+ the label will align with the textblock above (if \key{label-align}{left} is
+ set).
\Option{label-align}{left|right|center}\Default{left}
\sinceversion{0.7}Determines how the labels are aligned within the label-box
whose width is set with \key{label-width}
@@ -2467,6 +2517,11 @@ This is rather brief this time:
\part{The \translations package (\trnsltversion)}
\label{part:translations}\secidx{\translations}[translations]
+\section{About the Documentation}
+\noindent\sinceversion{0.9a}The \translations package got its own documentation --
+\url{translations_en.pdf}. This effectively means that the following part won't be
+updated any more. Updates will go in the linked file instead.
+
\section{Motivation}\secidx[Motivation]{\translations}[translations]
I wrote this package when I was in need for an expandable version of
\paket*{translator}'s \cmd{translate}. If you don't need that then there is no
@@ -2528,7 +2583,9 @@ These are the commands provided by \translations:
specified language.
\Befehl{LoadDictionaryFor}{<lang>}\ma{<name>}\newline
Loads a file named \code{<name>-<lang>.trsl}.
- \Befehl{DeclareDictTranslation}{<key>}\ma{<translation>}% TODO: beschreibung
+\Befehl{DeclareDictTranslation}{<key>}\ma{<translation>}\newline
+ This command is to be used in a dictionary file and picks up the language
+ of that file.
\end{beschreibung}
Quite a number of languages already are defined, either directly or via an alias.
So, before you define a language you should take a look in \code{translations.sty}
@@ -2577,6 +2634,11 @@ A typical dictionary file should look as follows:
\part{The \cntformats package (\cntfmtsversion)}
\label{part:cntformats}\secidx{\cntformats}[cntformats]
+\section{About the Documentation}
+\noindent\sinceversion{0.5}The \cntformats{} package got its own documentation --
+\url{cntformats_en.pdf}. This effectively means that the following part won't be
+updated any more. Updates will go in the linked file instead.
+
\section{Motivation}\secidx[Motivation]{\cntformats}[cntformats]
\cntformats provides a way to format counters with what I will call patterns.
This does not in any way effect the usual \LaTeXe\ way of treating counters and
@@ -2601,7 +2663,7 @@ arguments that specify the format:
\stepcounter{subsection}
\ReadCounterPattern{se[R](sse[a])}
\end{beispiel}
-\code{A} stands for \cmd{Alph} and \code{r} for \cmd{roman}. A complete list can
+\code{R} stands for \cmd{Roman} and \code{a} for \cmd{alph}. A complete list can
be found in table~\ref{tab:predefined:formats} on page~\pageref{tab:predefined:formats}.
As you can see you can insert arbitrary other tokens in a pattern that won't be
changed.