diff options
author | Karl Berry <karl@freefriends.org> | 2020-03-21 21:17:24 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-03-21 21:17:24 +0000 |
commit | da88d6a955687f433382b1d3072ef1ac42fc5fc1 (patch) | |
tree | 2a1fee615e4ef42bbbae0c534eb084f7acc6bacb /Master/texmf-dist/doc/latex/tasks | |
parent | 24d14de67d56a3947139cedc5ff40a43569d9085 (diff) |
tasks (21mar20)
git-svn-id: svn://tug.org/texlive/trunk@54449 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tasks')
-rw-r--r-- | Master/texmf-dist/doc/latex/tasks/README | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tasks/tasks-manual.pdf | bin | 0 -> 465232 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tasks/tasks-manual.tex (renamed from Master/texmf-dist/doc/latex/tasks/tasks_en.tex) | 145 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tasks/tasks_en.pdf | bin | 448228 -> 0 bytes |
4 files changed, 60 insertions, 89 deletions
diff --git a/Master/texmf-dist/doc/latex/tasks/README b/Master/texmf-dist/doc/latex/tasks/README index aa177739fa0..76abb73d319 100644 --- a/Master/texmf-dist/doc/latex/tasks/README +++ b/Master/texmf-dist/doc/latex/tasks/README @@ -1,7 +1,7 @@ -------------------------------------------------------------------------- -the TASKS package v1.1a 2020/01/11 +the TASKS package v1.2 2020/03/21 - horizontally columned lists + lists with columns filled horizontally -------------------------------------------------------------------------- Clemens Niederberger diff --git a/Master/texmf-dist/doc/latex/tasks/tasks-manual.pdf b/Master/texmf-dist/doc/latex/tasks/tasks-manual.pdf Binary files differnew file mode 100644 index 00000000000..e16f2d755b0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tasks/tasks-manual.pdf diff --git a/Master/texmf-dist/doc/latex/tasks/tasks_en.tex b/Master/texmf-dist/doc/latex/tasks/tasks-manual.tex index 8821283a822..2bcfb18d3ef 100644 --- a/Master/texmf-dist/doc/latex/tasks/tasks_en.tex +++ b/Master/texmf-dist/doc/latex/tasks/tasks-manual.tex @@ -1,7 +1,7 @@ % -------------------------------------------------------------------------- % the TASKS package % -% horizontally columned lists +% lists with columns filled horizontally % % -------------------------------------------------------------------------- % Clemens Niederberger @@ -25,76 +25,27 @@ % If you have any ideas, questions, suggestions or bugs to report, please % feel free to contact me. % -------------------------------------------------------------------------- -\documentclass[load-preamble+]{cnltx-doc} -\usepackage{tasks} - -\setcnltx{ - package = {tasks} , - authors = Clemens Niederberger , - email = {contact@mychemistry.eu} , - url = {https://github.com/cgnieder/tasks/} , - info = {horizontally columned lists} , - add-cmds = { - NewTasksEnvironment, - RenewTasksEnvironment, - settasks, - startnewitemline , - task - } , - add-silent-cmds = { - DeclareInstance, DeclareTemplateInterface, - leftthumbsup, - sample, Sample , theexercise - } -} - -\newpackagename\ExSheets{ExSheets} -\newpackagename\xsim{xsim} -\newpackagename\Tasks{tasks} - -% ---------------------------------------------------------------------------- -% other packages, bibliography, index -\usepackage{xcoffins,tikz,wasysym,enumitem,booktabs,siunitx} -\usepackage[accsupp]{acro} -\DeclareAcronym{id}{ - short = id , - long = Identifier , - format = \scshape , - pdfstring = ID , - accsupp = ID -} - -\usepackage{filecontents} -\usepackage{csquotes} - -% ---------------------------------------------------------------------------- -% example definitions that have to be done in the preamble: -\usepackage{xsim} -\usepackage{dingbat} - -\newcommand*\sample{This is some sample text we will use to create a somewhat - longer text spanning a few lines.} -\newcommand*\Sample{\sample\ \sample\par\sample} +\documentclass{tasks-manual} \begin{document} \section{Preface} -\subsection{Motivation} +\subsection{Motivation \& History} Originally \Tasks\ has been an integral part of the -\ExSheets\changedversion{0.7} package. 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 \env{tasks} environment available. -Since I agree with this the environment has been extracted into a package if -its own, \Tasks. Since then \Tasks{} has been distributed as a package of its -own but as part of the \ExSheets{} bundle\changedversion{0.10}. With v0.10 I -decided to make it a completely independent package. So the relation to -\ExSheets{} only is a historical one. +\ExSheets\changedversion{0.7} package~\cite{pkg: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 \env{tasks} +environment available. Since I agree with this the environment has been +extracted into a package if its own, \Tasks. Since then \Tasks\ has been +distributed as a package of its own but as part of the \ExSheets\ +bundle\changedversion{0.10}. With v0.10 I decided to make it a completely +independent package. So the relation to \ExSheets\ only is a historical one. The reason for the \env{tasks} environment is an unwritten agreement in German maths textbooks (exspecially in (junior) high school textbooks) 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 \pkg{enumitem} package for +better off using traditional \LaTeX\ lists and the \pkg{enumitem} package for customization. \subsection{Changes} @@ -117,26 +68,33 @@ The \sinceversion{1.0} step to version~1.0 brought some significant changes: \needpackage{xparse} and \pkg{xtemplate}. \section{How it works} -\subsection{The Basics} +\subsection{Background} The \env{tasks} environment is similar to a list like \env{enumerate} but not the same. Here are some of the differences: -\begin{itemize} - \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: the body of the \env{tasks} environment is split - at \emph{every} occurrence of the item separator. For this reason the - default separator is not \cs*{item} but \cs{task} so it is unique to this - environment only. This directly leads to\ldots - \item \ldots{} a fourth difference: the \env{tasks} environment cannot be - nested. You can, however, use an \env*{itemize} environment or another +\begin{tasks}[style=enumerate] + \task there is no pagebreak possible inside an item but only between items. + \task the enumeration default is a), b), c) \ldots + \task the body of the \env{tasks} environment is split at \emph{every} + occurrence of the item separator. For this reason the default separator + is not \cs*{item} but \cs{task} so it is unique to this environment only. + This directly leads to\ldots + \task \ldots\ the fact that the \env{tasks} environment cannot be nested. + You can, however, use an \env*{itemize} environment or another \enquote{real} list in it. - \item A fifth difference: verbatim material cannot be used in it. You'll + \task A fifth difference: verbatim material cannot be used in it. You'll have to use \cs*{string}, \cs*{texttt} or \cs*{detokenize}. If this won't suffice then don't use \env{tasks}. -% \item A sixth difference: %footnotes -\end{itemize} +\end{tasks} + +\begin{bewareofthedog} + The environments of \Tasks\ are what I like to call + \enquote{pseudo-environments}. This means like environments defined by the + package \pkg{environ}~\cite{pkg:environ} the body of the environment is read + as argument before it is processed. This is why verbatim material cannot be + used in \Tasks' lists. +\end{bewareofthedog} +\subsection{The Basics} \begin{environments} \environment{tasks}[\oarg{options}\darg{num of columns}] List like environment where the single items are introduced with @@ -234,6 +192,11 @@ following command: \command{startnewitemline} Introduce a new line in a \env{tasks} environment. \end{commands} +While this works it also needs a bit of care since the width of the items +doesn't change which means in order to use the full width you'd have to use +trickery like \cs*{rlap} which then means the danger of the item text sticking +into the margin. + \begin{example} \begin{tasks}(4) \task the first @@ -250,14 +213,9 @@ following command: \end{tasks} \end{example} -While this works it also needs a bit of care since the width of the items -doesn't change which means in order to use the full width you'd have to use -trickery like \cs*{rlap} which then means the danger of the item text sticking -into the margin\ldots - \section{Available Options}\label{sec:tasks:options} -The \Tasks{} package does not have any package options\changedversion{0.10}. +The \Tasks\ package does not have any package options\changedversion{0.10}. The environment \env{tasks} has a number of options, though, namely the following ones that can be set using a setup command: @@ -315,6 +273,8 @@ following ones that can be set using a setup command: \keyval{start}{integer}\Default{1} \sinceversion{1.1}Set the starting value with which the list starts counting. + \keyval{counter}{counter}\Default{task} + \sinceversion{1.2}The counter to be used to count the items. \keybool{debug}\Default{false} \sinceversion{0.10}If set to true \cs*{fboxsep} is set to \code{0pt} inside the \env{tasks} environment and \cs*{fbox} is used to draw a frame @@ -359,8 +319,8 @@ Now the same list as above but with three columns and a different label: \end{tasks} \end{example} -Let's use it inside a question, \ie, inside \xsim's \env{exercise} -environment: +Let's use it inside a question, \ie, inside \pkg{xsim}'s \env{exercise} +environment~\cite{pkg:xsim}: \begin{example} % since settings are local the following ones will be lost % outside this example; @@ -431,6 +391,14 @@ argument of \cs{task}. This will temporarily overwrite the default label. \end{tasks} \end{example} +\begin{commands} + \command{tasksifmeasuringTF}[\marg{true}\marg{false}] + \sinceversion{1.2}This command used inside a label checks if the label is + typeset for measuring its width or if it is typeset \enquote{for + real}. Might be useful sometimes. There are also the variants + \cs{tasksifmeasuringT} and \cs{tasksifmeasuringF}. +\end{commands} + \section{New \code{tasks}-like Environments} It is possible to add custom environments that work like the \code{tasks} environment. @@ -451,8 +419,8 @@ The \env{tasks} environment is defined as follows: The separator does not have to be a control sequence: \begin{example} % preamble: - % \usepackage{dingbat} - \NewTasksEnvironment[label=\footnotesize\leftthumbsup,label-width=15pt]{done}[*] + % \usepackage{fontawesome} + \NewTasksEnvironment[label=\faThumbsOUp,label-width=15pt]{done}[*] \begin{done} * First task * Second task @@ -472,8 +440,8 @@ argument. \begin{example} % preamble: - % \usepackage{dingbat} - \NewTasksEnvironment[label=\footnotesize\leftthumbsup,label-width=15pt]{done}[*] + % \usepackage{fontawesome} + \NewTasksEnvironment[label=\faThumbsOUp,label-width=15pt]{done}[*] \begin{done}(3) * First task * Second task @@ -524,4 +492,7 @@ This is rather brief this time: { label = \arabic*. } \end{sourcecode} +\clearpage +\printbibliography + \end{document} diff --git a/Master/texmf-dist/doc/latex/tasks/tasks_en.pdf b/Master/texmf-dist/doc/latex/tasks/tasks_en.pdf Binary files differdeleted file mode 100644 index 27389741a3c..00000000000 --- a/Master/texmf-dist/doc/latex/tasks/tasks_en.pdf +++ /dev/null |