summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/exsheets/tasks_en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/exsheets/tasks_en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/exsheets/tasks_en.tex133
1 files changed, 69 insertions, 64 deletions
diff --git a/Master/texmf-dist/doc/latex/exsheets/tasks_en.tex b/Master/texmf-dist/doc/latex/exsheets/tasks_en.tex
index 7bc73eaac63..62967bad831 100644
--- a/Master/texmf-dist/doc/latex/exsheets/tasks_en.tex
+++ b/Master/texmf-dist/doc/latex/exsheets/tasks_en.tex
@@ -47,7 +47,12 @@
pkg = {[more]tasks} ,
url = {https://bitbucket.org/cgnieder/exsheets/} ,
title = \Tasks ,
- subtitle = {{\small part of the \href{exsheets_en.pdf}{\ExSheets} bundle}\\[\baselineskip]create horizontal columned lists} ,
+ subtitle = {%
+ {\small
+ part of the \href{exsheets_en.pdf}{\ExSheets} bundle%
+ }\\[\baselineskip]
+ create horizontal columned lists%
+ } ,
name = tasks ,
language = en ,
modules = true ,
@@ -175,12 +180,6 @@
\pdfstringdefDisableCommands{\def\llap#1{#1\space}\def\bigstar{*}}
% ----------------------------------------------------------------------------
-% title page
-% \TitlePicture{%
-% \parbox{.8\linewidth}{%
-% }%
-% }
-
\def\s{This is some sample text we will use to create a somewhat
longer text spanning a few lines.}
\def\sample{\s\ \s\par\s}
@@ -189,22 +188,23 @@
\section{Motivation}\secidx{Motivation}
\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
-stand-alone package not having to load the whole \ExSheets beast just for having
-the \code{tasks} environment available. Since I agree with this the environment
-has been extracted into a package if its own, \Tasks.
-
-The reason for the \code{tasks} environment is an unwritten agreement in German
-maths textbooks (in (junior) high school, especially) to organize exercises in
-columns counting horizontally rather than vertically. That is what \code{tasks}
-primarily is for. If you don't need this feature you're better off using traditional
-\LaTeX{} lists and the \paket{enumitem} package for customization.
+\ExSheets. However, users told me that it indeed could be useful to have it
+as a stand-alone package not having to load the whole \ExSheets beast just for
+having the \code{tasks} environment available. Since I agree with this the
+environment has been extracted into a package if its own, \Tasks.
+
+The reason for the \code{tasks} environment is an unwritten agreement in
+German maths textbooks (in (junior) high school, especially) to organize
+exercises in columns counting horizontally rather than vertically. That is
+what \code{tasks} primarily is for. If you don't need this feature you're
+better off using traditional \LaTeX{} lists and the \paket{enumitem} package
+for customization.
\secidx*{Motivation}
\section{License and Requirements}\label{sec:license}\secidx{Requirements}
\Tasks is placed under the terms of the \LaTeX{} Project Public License,
-version 1.3 or later (\url{http://www.latex-project.org/lppl.txt}). It has the
-status ``maintained.''
+version 1.3 or later (\url{http://www.latex-project.org/lppl.txt}). It has
+the status ``maintained.''
\Tasks requires packages \paket{l3kernel} ,\paket{xparse}, \paket{l3keys2e},
\paket{epic}, \paket*{cntformats}\footnote{Part of the \ExSheets bundle},
@@ -214,19 +214,20 @@ status ``maintained.''
\section{How it works}
\subsection{The Basics}
The \code{tasks} environment is similar to a list like \code{enumerate} but not
-the same:
+the same. Here are some of the differences:
\begin{itemize}
- \item The first difference: there is no pagebreak possible inside an item but
- only between items.
- \item The second difference: the enumeration default is a), b), c) \ldots
- \item The third difference: there is a split at \emph{every} occurrence of the
- item separator. For this reason the default separator is not \cmd*{item} but
- \cmd{task} so it is unique to this environment only.
- \item The fourth difference: the \code{tasks} environment cannot be nested. You
- can, however, use an \code{itemize} environment or something in it.
- \item The fifth difference: verbatim material cannot be used in it. You'll
- have to use \cmd*{string}, \cmd*{texttt} or \cmd*{detokenize}. If this won't
- suffice then don't use \code{tasks}.
+\item A first difference: there is no pagebreak possible inside an item but
+ only between items.
+\item A second difference: the enumeration default is a), b), c) \ldots
+\item A third difference: there is a split at \emph{every} occurrence of the
+ item separator. For this reason the default separator is not \cmd*{item}
+ but \cmd{task} so it is unique to this environment only.
+\item A fourth difference: the \code{tasks} environment cannot be nested.
+ You can, however, use an \code{itemize} environment or something in it.
+\item A fifth difference: verbatim material cannot be used in it. You'll
+ have to use \cmd*{string}, \cmd*{texttt} or \cmd*{detokenize}. If this
+ won't suffice then don't use \code{tasks}.
+\item A sixth difference: %footnotes
\end{itemize}
\begin{beschreibung}
@@ -254,8 +255,8 @@ Some text before the list.
\end{tasks}
And also some text after it.
-The environment takes the optional argument \da{<num of columns>} with which the
-number of columns used by the environment is specified.
+The environment takes the optional argument \da{<num of columns>} with which
+the number of columns used by the environment is specified.
\begin{beispiel}[code only]
\begin{tasks}(2)
\task \sample
@@ -275,7 +276,7 @@ number of columns used by the environment is specified.
\subsection{Introducing a New Row}
\noindent\sinceversion{0.9}Sometimes it may come in handy if the current
-row of items could be terminated and a new one is started. This is possible
+row of items could be terminated and a new one is started. This is possible
with the following command:
\begin{beschreibung}
\Befehl{startnewitemline}
@@ -319,12 +320,14 @@ The \Tasks package has one package option which also is called when you load
The environment itself has some more options, namely these:
\begin{beschreibung}
\Option{style}{<instance>}\Default{}
- Choose the instance to be used. Read more on this in section~\ref{sec:tasks}.
+ Choose the instance to be used. Read more on this in
+ section~\ref{sec:tasks}.
\Option{counter-format}{<counter specs>}\Default{}
- \sinceversion{0.9}Sets a custom label. The letters \code{tsk} are replaced
- with the task-counter. An optional argument directly following these letters
- specifies the counter format: \code{1}: \cmd{arabic}, \code{a}: \cmd{alph},
- \code{A}: \cmd{Alph}, \code{r}: \cmd{roman} and \code{R}: \cmd{Roman}.
+ \sinceversion{0.9}Sets a custom label. The letters \code{tsk} are replaced
+ with the task-counter. An optional argument directly following these
+ letters specifies the counter format: \code{1}: \cmd{arabic}, \code{a}:
+ \cmd{alph}, \code{A}: \cmd{Alph}, \code{r}: \cmd{roman} and \code{R}:
+ \cmd{Roman}.
\Option{label-format}{<code>}\Default{}
\changedversion{0.9}Can be used to apply a formatting like, \emph{e.g.},
\cmd*{bfseries} to the labels.
@@ -333,15 +336,16 @@ The environment itself has some more options, namely these:
\Option{label-width}{<dim>}\Default{1em}
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.
+ \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).
+ \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}
+ \sinceversion{0.7}Determines how the labels are aligned within the
+ label-box whose width is set with \key{label-width}.
\Option{before-skip}{<skip>}\Default{0pt}
Sets the skip before the list.
\Option{after-skip}{<skip>}\Default{0pt}
@@ -349,9 +353,9 @@ The environment itself has some more options, namely these:
\Option{after-item-skip}{<skip>}\Default{1ex plus 1ex minus 1ex}
\sinceversion{0.9}This vertical skip is inserted between rows of items.
\Option{resume}{\default{true}|false}\Default{false}
- The enumeration will resume from a previous \code{tasks} environment. In order
- to use this option properly you shouldn't mix different \code{tasks} environments
- that both count their items.
+ The enumeration will resume from a previous \code{tasks} environment. In
+ order to use this option properly you shouldn't mix different \code{tasks}
+ environments that both count their items.
\end{beschreibung}
These options can also be set using a setup command:
\begin{beschreibung}
@@ -376,8 +380,8 @@ Now the same list as above but with three columns and a different label:
\task \s\par\s
\end{tasks}
-Let's use it inside a question, \textit{i.e.}, inside \ExSheets' \code{question}
-environment:
+Let's use it inside a question, \textit{i.e.}, inside \ExSheets'
+\code{question} environment:
\begin{beispiel}
% since settings are local the following ones will be lost
% outside this example;
@@ -405,9 +409,9 @@ environment:
\secidx*{Options}
\section{Available Instances}\label{sec:tasks:instances}
-When you use the package option \key{more} of the \Tasks package or load \ExSheets
-with the \key{load-tasks} option there are currently three additional instances
-for the \code{tasks} object available:
+When you use the package option \key{more} of the \Tasks package or load
+\ExSheets with the \key{load-tasks} option there are currently three
+additional instances for the \code{tasks} object available:
\begin{description}
\item[itemize] uses \cmd{labelitemi} as labels.
\item[enumerate] enumerates the items with 1., 2., \ldots
@@ -442,12 +446,13 @@ argument of \cmd{task}. This will temporarily overwrite the default label.
\secidx*{Custom Labels}
\section{New Tasks}\secidx{Own Environments}
-It is possible to add custom environments that work like the \code{tasks} environment.
+It is possible to add custom environments that work like the \code{tasks}
+environment.
\begin{beschreibung}
\Befehl{NewTasks}[<options>]{<name>}\oa{<separator}\da{<cols>}\newline
Define environment \ma{<name>} that uses \code{<separator>} to introduce a
- new item. Default for \code{<separator>} is \cmd{task}, default for
- \code{<cols>} is \code{1}. The \code{<options>} are the ones described in
+ new item. Default for \code{<separator>} is \cmd{task}, default for
+ \code{<cols>} is \code{1}. The \code{<options>} are the ones described in
section~\ref{sec:tasks:options}.
\Befehl{RenewTasks}[<options>]{<name>}\oa{<separator}\da{<cols>}\newline
Renew environment previously defined with \cmd{NewTasks}.
@@ -469,13 +474,13 @@ The separator does not have to be a control sequence:
\end{beispiel}
Although this might seem handy or even nice I strongly advice against using
something different than a command sequence. Remember that the items will be
-split at \emph{every} occurrence of the separator. So in order to use the
+split at \emph{every} occurrence of the separator. So in order to use the
separator (here for example for a starred variant of a command) within an item
-it has to be hidden in braces. This is avoided of you use a command sequence
+it has to be hidden in braces. This is avoided of you use a command sequence
which even doesn't have to be defined.
Let's say you want a \code{choices} environment that has three columns in its
-default state. You could do something like this:
+default state. You could do something like this:
\begin{beispiel}
% preamble:
% \NewTasks[style=multiplechoice]{choices}[\choice](3)
@@ -511,13 +516,13 @@ Equivalent to the styling of \ExSheets{} \Tasks uses \paket{xtemplate} to
declare additional instances for the lists.
\subsection{The \code{tasks} Object}\label{sec:tasks}\secidx{The `tasks' Object}
-The object that's defined by \Tasks is the `tasks' object.
-This time there are four instances available for the one template (again
-`default') that was defined.
+The object that's defined by \Tasks is the `tasks' object. This time there
+are four instances available for the one template (again `default') that was
+defined.
\subsubsection{Available Options}
This section only lists the options that can be used when defining an instance
-of the `default' template. The following subsections will give some examples
+of the `default' template. The following subsections will give some examples
of their usage.
\begin{beispiel}[code only]