From 4fcd51f020e5d12da9e8fa9dcff83c632385cb24 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 31 Jul 2011 18:30:04 +0000 Subject: rm xpackages, now l3packages + l3experimental git-svn-id: svn://tug.org/texlive/trunk@23286 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/xpackages/README | 102 - .../doc/latex/xpackages/xbase/ldcsetup.pdf | Bin 339754 -> 0 bytes .../doc/latex/xpackages/xbase/template-test.tex | 77 - .../doc/latex/xpackages/xbase/template-test2.tex | 110 - .../doc/latex/xpackages/xbase/template.pdf | Bin 571213 -> 0 bytes .../doc/latex/xpackages/xbase/tprestrict-test.tex | 80 - .../doc/latex/xpackages/xbase/xparse.pdf | Bin 414843 -> 0 bytes .../doc/latex/xpackages/xbase/xtemplate.pdf | Bin 414562 -> 0 bytes .../doc/latex/xpackages/xcoffins/xcoffins-test.tex | 380 --- .../xcoffins-tschichold-example-keyval.tex | 281 -- .../xcoffins/xcoffins-tschichold-example.tex | 185 -- .../doc/latex/xpackages/xhead/xhead-test.tex | 245 -- .../texmf-dist/doc/latex/xpackages/xhead/xhead.pdf | Bin 538852 -> 0 bytes .../doc/latex/xpackages/xtras/l3keys2e-demo.tex | 46 - .../doc/latex/xpackages/xtras/l3keys2e.pdf | Bin 456306 -> 0 bytes .../source/latex/xpackages/xbase/ldcsetup.dtx | 331 -- .../source/latex/xpackages/xbase/template.dtx | 2452 -------------- .../source/latex/xpackages/xbase/xbase.ins | 74 - .../source/latex/xpackages/xbase/xparse.dtx | 2985 ----------------- .../source/latex/xpackages/xbase/xtemplate.dtx | 3383 -------------------- .../source/latex/xpackages/xcoffins/l3coffins.dtx | 2137 ------------- .../source/latex/xpackages/xcoffins/xcoffins.dtx | 869 ----- .../source/latex/xpackages/xcoffins/xcoffins.ins | 30 - .../source/latex/xpackages/xhead/xhead.dtx | 986 ------ .../source/latex/xpackages/xhead/xhead.ins | 73 - .../source/latex/xpackages/xtras/l3keys2e.dtx | 308 -- .../source/latex/xpackages/xtras/l3keys2e.ins | 19 - .../tex/latex/xpackages/xbase/ldcsetup.sty | 193 -- .../tex/latex/xpackages/xbase/template.sty | 566 ---- .../tex/latex/xpackages/xbase/xparse.sty | 1198 ------- .../tex/latex/xpackages/xbase/xtemplate.sty | 1245 ------- .../tex/latex/xpackages/xcoffins/l3coffins.sty | 1026 ------ .../tex/latex/xpackages/xcoffins/xcoffins.sty | 174 - .../texmf-dist/tex/latex/xpackages/xhead/xhead.sty | 376 --- .../tex/latex/xpackages/xtras/l3keys2e.sty | 142 - 35 files changed, 20073 deletions(-) delete mode 100644 Master/texmf-dist/doc/latex/xpackages/README delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/ldcsetup.pdf delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/template-test.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/template-test2.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/template.pdf delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/tprestrict-test.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/xparse.pdf delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xbase/xtemplate.pdf delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-test.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example-keyval.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xhead/xhead-test.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xhead/xhead.pdf delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e-demo.tex delete mode 100644 Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e.pdf delete mode 100644 Master/texmf-dist/source/latex/xpackages/xbase/ldcsetup.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xbase/template.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xbase/xbase.ins delete mode 100644 Master/texmf-dist/source/latex/xpackages/xbase/xparse.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xbase/xtemplate.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xcoffins/l3coffins.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xcoffins/xcoffins.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xcoffins/xcoffins.ins delete mode 100644 Master/texmf-dist/source/latex/xpackages/xhead/xhead.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xhead/xhead.ins delete mode 100644 Master/texmf-dist/source/latex/xpackages/xtras/l3keys2e.dtx delete mode 100644 Master/texmf-dist/source/latex/xpackages/xtras/l3keys2e.ins delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xbase/ldcsetup.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xbase/template.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xbase/xparse.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xbase/xtemplate.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xcoffins/l3coffins.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xcoffins/xcoffins.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xhead/xhead.sty delete mode 100644 Master/texmf-dist/tex/latex/xpackages/xtras/l3keys2e.sty (limited to 'Master/texmf-dist') diff --git a/Master/texmf-dist/doc/latex/xpackages/README b/Master/texmf-dist/doc/latex/xpackages/README deleted file mode 100644 index 571316db1dd..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/README +++ /dev/null @@ -1,102 +0,0 @@ - - Experimental LaTeX3 High-Level Concepts - ======================================= - - 2009/11/25 - - -WHERE TO GET IT ---------------- - -The files in this distribution represent a snapshot of selected files -from the Subversion (SVN) repository of the LaTeX3 Project. - -To obtain current versions of the files, visit - which contains further -instructions. - -OVERVIEW --------- - -The xpackages are a collection of experimental implementations -for aspects of the LaTeX3 kernel, dealing with higher-level -ideas such as the Desginer Interface. Some of them work as stand -alone packages, providing new functionality, and can be used -on top of LaTeX2e with no changes to the existing kernel. -Others go further, and redefine LaTeX2e internals to provide -better methods for managing certain constructs. - -All xpackages require expl3 and, in addition to this, many require -functionality provided by the packages within the xbase bundle. - -Currently included in the CTAN release of xpackages are the following -bundles: - xbase - xtras - -xbase ------ - -The xbase bundle provides mechansims for defining document commands -(xparse) and design constructions (xtemplate). - -The xparse package provides a high-level interface for declaring -document commands, e.g., a uniform way to define commands taking -optional arguments, optional stars (and others), mandatory arguments -and more. - -The xtemplate package provides an interface for defining generic -functions using a key=val syntax. This is designed to be -"self-documenting", with the key definitions providing information -on how they are to be used. - -The legacy template and ldcsetup packages are included at the -present time, but new LaTeX3 code will not use these! - -Source files: - - xbase.ins - - xparse.dtx - - xtemplate.dtx - -xtras ------ - -The xtras bundle provides functionality to bridge between LaTeX2e -and LaTeX3. It provides add-ons to LaTeX2e to allow other xpackages -to be used in the LaTeX2e context. - -The l3keys2e package allows keys defined using l3keys to be used -as package and class options with LaTeX2e. This is tied to the -method the existing kernel uses for processing options, and so it -is likely that a stand-alone LaTeX3 kernel will use a very different -approach. - - -DISCUSSION ----------- - -Discussion concerning the approach, suggestions for improvements, changes, -additions, etc. should be addressed to the list LATEX-L. - -You can subscribe to this list by sending mail to - - listserv@urz.uni-heidelberg.de - -with the body containing - - subscribe LATEX-L - - -BUGS ----- - -If you find a real bug that makes a package stop working you can -report it via the standard LaTeX bug reporting mechanism of the LaTeX -distribution (see bugs.txt there) using the category "Experimental -LaTeX kernel". However please do *not* use this method for -suggestions / comments / improvements / etc. For this the list LATEX-L -should be used instead. - - ---- Copyright 1998 -- 2009 - The LaTeX3 Project. All rights reserved --- diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/ldcsetup.pdf b/Master/texmf-dist/doc/latex/xpackages/xbase/ldcsetup.pdf deleted file mode 100644 index 25ff0de5d62..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xbase/ldcsetup.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/template-test.tex b/Master/texmf-dist/doc/latex/xpackages/xbase/template-test.tex deleted file mode 100644 index 5684ce7a90f..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xbase/template-test.tex +++ /dev/null @@ -1,77 +0,0 @@ -% \iffalse -%% (C) Copyright 2000-2004 LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3a of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%% $Id: template-test.tex 1628 2009-10-25 09:54:34Z mittelba $ -%% -% \fi -% -\RequirePackage{template} - -\DeclareTemplateType{xxx}{0} - -\DeclareTemplate{xxx}{test}{0} - { - xkey=n \xkey, - key =i {yyy} \value - } - { - \DoParameterAssignments - \show\xkey - \show\value - \value - } - -\DeclareTemplateType{yyy}{0} - -\DeclareTemplate{yyy}{foo}{0} - { - keya =L \foo - } - { - \DoParameterAssignments - \show\foo - } - - -\DeclareInstance{xxx}{bar}{test} - { - xkey = \UseTemplate{yyy}{foo}{ keya = 20pt }, - key = \UseTemplate{yyy}{foo}{ keya = 10pt } - } - -\ShowInstance{xxx}{bar} - -\UseInstance{xxx}{bar} - -\stop diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/template-test2.tex b/Master/texmf-dist/doc/latex/xpackages/xbase/template-test2.tex deleted file mode 100644 index 489e9f2304a..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xbase/template-test2.tex +++ /dev/null @@ -1,110 +0,0 @@ -% \iffalse -%% (C) Copyright 2000-2004 LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3a of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/cgi-bin/cvsweb.cgi/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%% $Id: template-test2.tex 585 2006-12-12 17:31:48Z morten $ -%% -% \fi -% - - -\RequirePackage{template} -\RequirePackage{trace} - -\DeclareTemplateType{xxx}{0} - -\def\MultiSelection{\MultiSelectionError} -%\def\foo{bar} - -%\traceon - -\DeclareTemplate{xxx}{test}{0} - { - xkey=n [\foo] \xkey, - ykey=n [\DelayEvaluation\foo] \ykey, - zkey=n \zkey, - last=n [last] \lastkey, - set =i {xxx} \xxx - } - { - \DoParameterAssignments - \typeout{abc} - } -\ShowTemplate{xxx}{test} - - -\DeclareInstance{xxx}{bar}{test} - { - zkey = foo, - xkey = baz, - } - -\DeclareInstance{xxx}{baz}{test} - { - last = first, - set = \UseTemplate{xxx}{test}{zkey=rrr}, - zkey = foo - } - - -\ShowInstance{xxx}{bar} -\ShowInstance{xxx}{baz} - -\DeclareTemplateType{yyy}{0} - -\DeclareTemplate{yyy}{foo}{0} - { - keya =L \foo - } - { - \DoParameterAssignments - \show\foo - } - - -\DeclareInstance{xxx}{bar}{test} - { - xkey = \UseTemplate{yyy}{foo}{ keya = 20pt }, - key = \UseTemplate{yyy}{foo}{ keya = 10pt } - } - -\ShowInstance{xxx}{bar} - -\UseInstance{xxx}{bar} - -\stop - -%%% Local Variables: -%%% mode: plain-tex -%%% TeX-master: t -%%% End: diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/template.pdf b/Master/texmf-dist/doc/latex/xpackages/xbase/template.pdf deleted file mode 100644 index 008dd0ddab6..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xbase/template.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/tprestrict-test.tex b/Master/texmf-dist/doc/latex/xpackages/xbase/tprestrict-test.tex deleted file mode 100644 index d981888d450..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xbase/tprestrict-test.tex +++ /dev/null @@ -1,80 +0,0 @@ -% \iffalse -%% (C) Copyright 2000-2004 LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3a of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%% $Id: tprestrict-test.tex 1628 2009-10-25 09:54:34Z mittelba $ -%% -% \fi -% - -\makeatletter -\RequirePackage{template} -\IgnoreWhiteSpace - -\newcount\ca -\newdimen\da - - -\DeclareTemplateType{type}{0} - -\DeclareTemplate{type}{Ta}{0}{ - one =l [2in] \da, - two =c [5] \ca} - {\DoParameterAssignments\typeout{\da=\the\da,\@spaces \ca=\the\ca}} - -\ShowTemplate{type}{Ta} - -\typeout{1^^J==} -\UseTemplate{type}{Ta}{} - -\typeout{2^^J==} -\UseTemplate{type}{Ta}{one=44pt, two=7} - - -\DeclareRestrictedTemplate{type}{Tb}{Ta}{one=33pt} - -\ShowTemplate{type}{Tb} - -\typeout{RESTRICT^^J3^^J==} - -\DeclareInstance{type}{foo}{Tb}{two=9} - -\ShowInstance{type}{foo} - -\UseInstance{type}{foo} - -\typeout{4^^J==} -\UseTemplate{type}{Tb}{two=7} - -\stop - diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/xparse.pdf b/Master/texmf-dist/doc/latex/xpackages/xbase/xparse.pdf deleted file mode 100644 index 8f3ed0e8327..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xbase/xparse.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/xpackages/xbase/xtemplate.pdf b/Master/texmf-dist/doc/latex/xpackages/xbase/xtemplate.pdf deleted file mode 100644 index d8375dc1005..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xbase/xtemplate.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-test.tex b/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-test.tex deleted file mode 100644 index 1ede1770c08..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-test.tex +++ /dev/null @@ -1,380 +0,0 @@ - -\documentclass{article} - -\usepackage[T1]{fontenc} -\usepackage{times,multicol} -\usepackage{xcoffins} - -\usepackage{color} -\newcommand\cbox[2][.8]{{\setlength\fboxsep{0pt}\colorbox[gray]{#1}{#2}}} - -\newcommand\hrulebox [2]{\setbox#1\hbox to#2{{\scriptsize\itshape - \color{blue}\hrulefill #2\hrulefill}}} -\newcommand\vrulebox [2]{\setbox#1\vbox to#2{{\hsize 1pt\centering\scriptsize - \itshape\color{blue}\leaders\vrule\vfill - \hbox to0pt{\hss #2\hss}\leaders\vrule\vfill\par}}} - - -\addtolength\textwidth{10pt} - -\showboxdepth 9999 -\showboxbreadth 9999 -\tracingonline 1 - - -\scrollmode - -\newbox\zzz - - -\begin{document} - - -\title{Test file for coffins} -\author{FMi} -\maketitle - -First we add a few test coffins: -\begin{verbatim} - \newcoffin \aaa - \newcoffin \bbb - \newcoffin \ccc - \newcoffin \ddd -\end{verbatim} - \newcoffin \aaa - \newcoffin \bbb - \newcoffin \ccc - \newcoffin \ddd -and some boxes not set up as ordinary boxes (without extra poles): -\begin{verbatim} - \newbox \xxx - \newbox \yyy -\end{verbatim} - \newbox \xxx - \newbox \yyy - - -If a coffin receives data a set of ``natural'' default poles are automatically added. -\begin{verbatim} -\sbox\aaa{\fbox{\begin{tabular}[b]{l}123\\4\\5\end{tabular}}} -\showcoffindata \aaa -\end{verbatim} -\sbox\aaa{\fbox{\begin{tabular}[b]{l}123\\4\\5\end{tabular}}} -\showcoffindata \aaa - - -In contrast, boxes not declared as coffins have no poles defined. However, if -used as coffins at least the natural default poles can be used without -further problems, i.e.,they are changed to coffins automatically on use. -\begin{verbatim} -\sbox\xxx{\fbox{Some very looooonggg Caption Text}} -\showpoles \xxx -\end{verbatim} -\sbox\xxx{\fbox{Some very looooonggg Caption Text}} -\showcoffindata \xxx - - -Using \verb|\setvcoffin| instead of \verb|\sbox| gives us the codes with -\texttt{T} and \texttt{B}. Similar to \verb|\parbox| this command requires to -specify a target width of the box: -\begin{verbatim} -\setvcoffin \aaa {1.5cm} {\centering - \fbox{\begin{tabular}[b]{l}123\\4\\5\end{tabular}}} -\showcoffindata \aaa -\end{verbatim} -\setvcoffin \aaa {1.5cm} {\centering - \fbox{\begin{tabular}[b]{l}123\\4\\5\end{tabular}}} -\showcoffindata \aaa - -There are a dozen natural poles per box (some with multiple names); you can -move each of the poles to someplace else (either to an absolute position in -``box space'' or relative to its previous position). The coordinates can -refer to box dimensions (using \verb|\height|, \verb|\depth|, - and \verb|width|). First we move some pole and add one -additional one: -\begin{verbatim} -\setcoffinpole \aaa [h]{t}(\height -3pt) -\setcoffinpole \aaa [v]{l}(0pt) -\setcoffinpole \aaa [h]{mybottom}(\depth +2pt) -\showcoffindata \aaa -\end{verbatim} -\setcoffinpole \aaa [h]{t}(\height -3pt) -\setcoffinpole \aaa [v]{l}(0pt) -\setcoffinpole \aaa [h]{mybottom}(\depth +2pt) -\showcoffindata \aaa - - -More interesting in many cases is the relative move of poles. For this the -poles better exist or one gets an error and \texttt{0pt,0pt} is used: -\begin{verbatim} -\adjustcoffinpole \aaa [h]{H}(1pt) -\adjustcoffinpole \aaa [v]{l}(1pt) -\adjustcoffinpole \aaa [h]{undefined}(1pt) -\showcoffindata \aaa -\end{verbatim} -\adjustcoffinpole \aaa [h]{H}(1pt) -\adjustcoffinpole \aaa [v]{l}(1pt) -\adjustcoffinpole \aaa [h]{undefined}(1pt) -\showcoffindata \aaa - - - -\sbox \aaa {\fontsize{14.4}{5.5pc minus .5pc}\sffamily C\,H\,A\,P\,T\,E\,R - \fontsize{36}{40pt}\selectfont 2} - -\setvcoffin \bbb {11cm} - {\raggedleft\normalfont\fontsize{36}{38pt}\bfseries - The Structure of a \LaTeX{} Document} - -\setvcoffin \ccc {13cm} - {Some sample blind text to produce paragraph data after a heading. - Some sample blind text to produce paragraph data after a heading. - Some sample blind text to produce paragraph data after a heading. - Some sample blind text to produce paragraph data after a heading. - \endgraf - Some more sample blind text to produce paragraph data after a heading. - Some more sample blind text to produce paragraph data after a heading. -} - - -Suppose you have the following blocks of text: - -\bigskip - -\noindent\cbox{\usebox\aaa} - -\begin{multicols}{2} -\ttfamily\tiny -\ExplSyntaxOn - \noindent \coffin_print_pole_values:Nn \aaa \\ -\ExplSyntaxOff -\end{multicols} - -\medskip - -\noindent\cbox{\usebox\bbb} - -\medskip - -\noindent\cbox{\usebox\ccc} - -\bigskip - -produced by: -\begin{verbatim} -\sbox \aaa {\fontsize{14.4}{5.5pc minus .5pc}\sffamily - C\,H\,A\,P\,T\,E\,R - \fontsize{36}{40pt}\selectfont 2} -\setvcoffin \bbb {11cm} - {\raggedleft\normalfont\fontsize{36}{38pt}\bfseries - The Structure of a \LaTeX{} Document} -\setvcoffin \ccc {13cm} - {Some sample blind text to produce paragraph - data after a heading. ... } -\end{verbatim} - -How do you turn this into a heading of TLC2? - - -\newbox\RBi -\newbox\RBii -\newbox\RBiii - -\hrulebox\RBi{62pt} -\vrulebox\RBii{90pt} -\vrulebox\RBiii{60pt} - -\aligncoffins \bbb [T,r] \aaa [H,r](-62pt,60pt) -\aligncoffins \ccc[T,r] \bbb[B,r](62pt,90pt) - - \aligncoffins * \ccc[\bbb-T,\bbb-hc] \RBiii[b,hc](28pt,0pt) - \aligncoffins * \ccc[\bbb-b,\bbb-r] \RBi[H,r](0pt,-5pt) - \aligncoffins * \ccc[\bbb-B,\bbb-hc] \RBii[t,r](14pt,0pt) - -\newpage - -How do you best define/describe the following design? - -\medskip - -\noindent\cbox{\usebox\ccc} - - - - - - -\newpage \pagestyle{empty} - -\newcoffin \eee -\newcoffin \fff -\newcoffin \ggg - -\sbox \aaa {\small\scshape les vases communicants} -\sbox \bbb {\scshape comunicating} -\sbox \ccc {\fontsize{70pt}{60pt} \bfseries Ve\S els} -\sbox \ddd {\scshape andr\'e breton} -\setvcoffin \eee {4.7cm}{\noindent Translated by Mary Ann Caws \&\break - Geoffrey T.\,Harris, with notes \&\break - introduction by Mary Ann Caws\parfillskip=0pt\relax - } -\sbox \fff {University of Nebraska Press: Lincoln \& London} - -\setvcoffin \ggg {100mm}{\noindent\fbox{\parbox{97mm}{\leavevmode\vspace*{228mm}}}} - - -\aligncoffins \ccc [H,r] \ddd [H,r](0pt,-12pt) -\aligncoffins \ccc [t,l] \bbb (0pt,6pt) -\aligncoffins \ccc [H,r] \aaa [H,r](0pt,138pt) -\aligncoffins \eee [T,l] \ccc (0pt,22pc) -\aligncoffins \fff \eee [B,l](0pt,4pc) -\aligncoffins \ggg [b,l] \fff [B,l](54pt,11pc) - - -\vspace*{-2cm} -\noindent\cbox{\usebox\ggg} - - -\newpage - -\section{Rotation} - -\sbox \aaa {\tabcolsep0pt\begin{tabular}[c]{|c|}\hline a\\b\\cccccccccccccc\\d - \\e\\e\\e\\e\\\hline\end{tabular}} -\sbox \bbb {\fbox{A sample Text}} - -% just for the sake of it: -\adjustcoffinpole \aaa {T}(24pt) -\displaycoffinpoles \aaa {black} -x\cbox{\usebox \aaa }x -% -\rotatecoffin \aaa {45} -\displaycoffinhandle \aaa {b}{hc} {blue} -\displaycoffinhandle \aaa {b}{l} {blue} -\displaycoffinhandle \aaa {t}{r} {blue} -\displaycoffinhandle \aaa {vc}{r} {blue} -\displaycoffinhandle \aaa {vc}{l} {blue} -\quad -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {45} -\displaycoffinhandle \aaa {b}{r} {red} -\displaycoffinhandle \aaa {vc}{l} {red} -\quad -x\cbox{\usebox \aaa }x - -\vspace{1cm} - -\rotatecoffin \aaa {45} -\displaycoffinhandle \aaa {b}{l} {yellow} -% -x\cbox{\usebox \aaa }x -% - -\vspace{1cm} - -x\cbox{\usebox \bbb }x -% -\rotatecoffin \bbb {45} -\displaycoffinhandle \bbb {B}{hc} {yellow} -\quad -x\cbox{\usebox \bbb }x - - -\section{Rotation + alignment} - -\aligncoffins \aaa [b,l] \bbb[B,hc](30pt,0pt) -x\cbox{\usebox \aaa }x - - -After we have aligned a roated box with some other box we need to decide about -the bounding box of the new box. Right now this become the enclosing box and -we do not maintain information about the inner boxes. So when we rotate that -new box there seems to be unnecessary space in the enclosing bounding box, -even though that is correct if you think of the aligned box being unrotated. - -There is at least the possibility to refer to the handles of the inner boxes -as one can see by two of the green handles - -\medskip - -\rotatecoffin \aaa {45} -\displaycoffinhandle \aaa {vc}{hc} {green} -\displaycoffinhandle \aaa {H}{l} {green} -\displaycoffinhandle \aaa {\aaa-T}{\aaa-r} {green} -\displaycoffinhandle \aaa {\bbb-H}{\bbb-r} {green} -%\quad -x\cbox{\usebox \aaa }x - -We could do better, if we want to, by actually checking for max and -min of all inner bounding box corners and construct the result BB box from -that---but is it worth it? - -Perhaps it is! After all, the current implementation shows different results -depending on when you align boxes and when you rotate, e.g., aligning first -gives totally different bounding box results. - -\newpage - -Aligning first and then 135 + 45 rotation gives this: - -\sbox \aaa {\tabcolsep0pt\begin{tabular}[c]{|c|}\hline a\\b\\cccccccccccccc\\d - \\e\\e\\e\\e\\\hline\end{tabular}} -\sbox \bbb {\fbox{A sample Text}} -\rotatecoffin \bbb {90} - -\aligncoffins \aaa [b,l] \bbb[B,hc](-30pt,0pt) -x\cbox{\usebox \aaa }x -\qquad -\rotatecoffin \aaa {135} -x\cbox{\usebox \aaa }x -\qquad -\rotatecoffin \aaa {45} -x\cbox{\usebox \aaa }x - - - - -\newpage - -\section{Rotation by small amounts} - -\sbox \aaa {\tabcolsep0pt\begin{tabular}[c]{|c|}\hline a\\b\\ccccccccc\\d - \\e\\e\\e\\\hline\end{tabular}} - -\subsection{30 + 30 +30 } -\rotatecoffin \aaa {30} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {30} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {30} -x\cbox{\usebox \aaa }x - -\subsection{6 * 10 + 45 + 45 + 30} - -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x - -\vspace{1cm} -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {10} -x\cbox{\usebox \aaa }x - -\vspace{1cm} -\rotatecoffin \aaa {45} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {45} -x\cbox{\usebox \aaa }x -\rotatecoffin \aaa {30} -x\cbox{\usebox \aaa }x - - -\end{document} - - diff --git a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example-keyval.tex b/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example-keyval.tex deleted file mode 100644 index e83c0b490b6..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example-keyval.tex +++ /dev/null @@ -1,281 +0,0 @@ - -\documentclass{article} - -\usepackage[a4paper,margin=5pt]{geometry} - -\usepackage[T1]{fontenc} -\usepackage{times,multicol,graphicx} -\usepackage{xcoffins} - -\usepackage{times,color} -\newcommand\cbox[2][.8]{{\setlength\fboxsep{0pt}\colorbox[gray]{#1}{#2}}} - -\ExplSyntaxOn - -\ExplSyntaxOff - - - -%\scrollmode - -\pagestyle{empty} - -\begin{document} - - \NewCoffin \result - \NewCoffin \aaa - \NewCoffin \bbb - \NewCoffin \ccc - \NewCoffin \ddd - \NewCoffin \eee - \NewCoffin \fff - \NewCoffin \rulei - \NewCoffin \ruleii - \NewCoffin \ruleiii - -\SetHorizontalCoffin \result {} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\sffamily\bfseries typographische} -\SetHorizontalCoffin \ccc {\fontsize{12}{10}\sffamily - \quad zeitschrift des bildungsverbandes der - deutschen buchdrucker leipzig - \textbullet{} oktoberheft 1925} -\SetHorizontalCoffin \ddd {\fontsize{28}{20}\sffamily sonderheft} -\SetVerticalCoffin \eee {180pt} - {\raggedleft\fontsize{31}{36}\sffamily\bfseries - elementare\\ - typographie} -\SetVerticalCoffin \fff {140pt} - {\raggedright \fontsize{13}{14}\sffamily\bfseries - natan altman \\ - otto baumberger \\ - herbert mayer \\ - max burchartz \\ - el lissitzky \\ - ladislaus moholy-nagy \\ - moln\'ar f.~farkas \\ - johannes molzahn \\ - kurt schwitters \\ - mart stam \\ - ivan tschichold} - -\RotateCoffin \bbb {90} -\RotateCoffin \ccc {270} - -\SetHorizontalCoffin \rulei {\color{red}\rule{6.5in}{1pc}} -\SetHorizontalCoffin \ruleii {\color{red}\rule{1pc}{23.5cm}} -\SetHorizontalCoffin \ruleiii{\color{black}\rule{10pt}{152pt}} - - -\JoinCoffins \result \aaa -\JoinCoffins [ - coffin1-hpole = \aaa-t , - coffin1-vpole = \aaa-r , - coffin2-hpole = b , - coffin2-vpole = r , - voffset = 2 mm , -] \result \rulei -\JoinCoffins [ - coffin1-hpole = \aaa-b , - coffin1-vpole = \aaa-l , - coffin2-hpole = B , - coffin2-vpole = r , - hoffset = 2 pt , -] \result \bbb -\JoinCoffins [ - coffin1-hpole = \bbb-t , - coffin1-vpole = \bbb-r , - coffin2-hpole = t , - coffin2-vpole = r , - hoffset = -2 mm , -] \result \ruleii -\JoinCoffins [ - coffin1-hpole = \aaa-B , - coffin1-vpole = \aaa-r , - coffin2-hpole = B , - coffin2-vpole = l , - hoffset = 66 pt , - voffset = 14 pc , -] \result \ccc -\JoinCoffins [ - coffin1-hpole = \bbb-l , - coffin1-vpole = \ccc-B , - coffin2-hpole = t , - coffin2-vpole = r , - hoffset = -2 mm , -] \result \fff -\JoinCoffins [ - coffin1-hpole = \fff-b , - coffin1-vpole = \fff-r , - coffin2-hpole = b , - coffin2-vpole = l , - hoffset = 2 mm , -] \result \ruleiii -\JoinCoffins [ - coffin1-hpole = \ccc-r , - coffin1-vpole = \fff-l , - coffin2-hpole = B , - coffin2-vpole = r , -] \result \eee -\JoinCoffins [ - coffin1-hpole = \eee-T , - coffin1-vpole = \eee-r , - coffin2-hpole = B , - coffin2-vpole = r , - voffset = 4 pc , -] \result \ddd - - -\vspace*{3cm} -\begin{center} - {\Large Title page of ``elementare typographie'' by Ivan Tschichold\par} - -\large -\vspace*{1cm} - - 1. first the scanned original from 1925 - -\vspace*{6mm} - - 2. then the recreated \TeX{} version from 2010 using coffins---not - attempting\\ to match the fonts and size but the structure - -\vspace*{6mm} - - 3. and finally the source code used. - - This document uses the new - implementation by Joseph in \texttt{l3coffins-new}. - -\end{center} - -\newpage - - -\begin{center} - \null - \fbox{\includegraphics[scale=.95]{elementare-typographie-title.jpg}} -\end{center} - -\newpage - -\TypesetCoffin \result - -\newpage - -\vspace*{3cm} -\begin{center} - {\Large Code used: \par} -\vspace*{1cm} - - -\begin{minipage}{14cm} -\begin{verbatim} -\SetHorizontalCoffin\result{} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\sffamily\bfseries typographische} -\SetHorizontalCoffin \ccc {\fontsize{12}{10}\sffamily - \quad zeitschrift des bildungsverbandes der - deutschen buchdrucker leipzig - \textbullet{} oktoberheft 1925} -\SetHorizontalCoffin \ddd {\fontsize{28}{20}\sffamily sonderheft} -\SetVerticalCoffin \eee {180pt} - {\raggedleft\fontsize{31}{36}\sffamily\bfseries - elementare\\ - typographie} -\SetVerticalCoffin \fff {140pt} - {\raggedright \fontsize{13}{14}\sffamily\bfseries - natan altman \\ - otto baumberger \\ - herbert mayer \\ - max burchartz \\ - el lissitzky \\ - ladislaus moholy-nagy \\ - moln\'ar f.~farkas \\ - jahannes molzahn \\ - kurt schwitters \\ - mart stam \\ - ivan tschichold} - -\RotateCoffin \bbb {90} -\RotateCoffin \ccc {270} - -\SetHorizontalCoffin \rulei {\color{red}\rule{6.5in}{1pc}} -\SetHorizontalCoffin \ruleii {\color{red}\rule{1pc}{23.5cm}} -\SetHorizontalCoffin \ruleiii{\color{black}\rule{10pt}{152pt}} - -\JoinCoffins \result \aaa -\JoinCoffins [ - coffin1-hpole = \aaa-t , - coffin1-vpole = \aaa-r , - coffin2-hpole = b , - coffin2-vpole = r , - voffset = 2 mm , -] \result \rulei -\JoinCoffins [ - coffin1-hpole = \aaa-b , - coffin1-vpole = \aaa-l , - coffin2-hpole = B , - coffin2-vpole = r , - hoffset = 2 pt , -] \result \bbb -\JoinCoffins [ - coffin1-hpole = \bbb-t , - coffin1-vpole = \bbb-r , - coffin2-hpole = t , - coffin2-vpole = r , - hoffset = -2 mm , -] \result \ruleii -\JoinCoffins [ - coffin1-hpole = \aaa-B , - coffin1-vpole = \aaa-r , - coffin2-hpole = B , - coffin2-vpole = l , - hoffset = 66 pt , - voffset = 14 pc , -] \result \ccc -\JoinCoffins [ - coffin1-hpole = \bbb-l , - coffin1-vpole = \ccc-B , - coffin2-hpole = t , - coffin2-vpole = r , - hoffset = -2 mm , -] \result \fff -\JoinCoffins [ - coffin1-hpole = \fff-b , - coffin1-vpole = \fff-r , - coffin2-hpole = b , - coffin2-vpole = l , - hoffset = 2 mm , -] \result \ruleiii -\JoinCoffins [ - coffin1-hpole = \ccc-r , - coffin1-vpole = \fff-l , - coffin2-hpole = B , - coffin2-vpole = r , -] \result \eee -\JoinCoffins [ - coffin1-hpole = \eee-T , - coffin1-vpole = \eee-r , - coffin2-hpole = B , - coffin2-vpole = r , - voffset = 4 pc , -] \result \ddd -\SetHorizontalCoffin\result{} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries - mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\rotatebox{90}{\sffamily\bfseries - typographische}} - -\TypesetCoffin \result -\end{verbatim} - -This is not necessarily the final syntax but for now it does its job. For -example, flexible support for adding ornaments (lines, \ldots) is still -missing, so above the rules got added as predefined individual coffins. - -\end{minipage} -\end{center} - -\end{document} - diff --git a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example.tex b/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example.tex deleted file mode 100644 index 343c9d7e29f..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xcoffins/xcoffins-tschichold-example.tex +++ /dev/null @@ -1,185 +0,0 @@ - -\documentclass{article} - -\usepackage[a4paper,margin=5pt]{geometry} - -\usepackage[T1]{fontenc} -\usepackage{times,multicol,graphicx} -\usepackage{xcoffins} - -\usepackage{times,color} -\newcommand\cbox[2][.8]{{\setlength\fboxsep{0pt}\colorbox[gray]{#1}{#2}}} - -\ExplSyntaxOn - -\ExplSyntaxOff - - - -%\scrollmode - -\pagestyle{empty} - -\begin{document} - - \NewCoffin \result - \NewCoffin \aaa - \NewCoffin \bbb - \NewCoffin \ccc - \NewCoffin \ddd - \NewCoffin \eee - \NewCoffin \fff - \NewCoffin \rulei - \NewCoffin \ruleii - \NewCoffin \ruleiii - -\SetHorizontalCoffin \result {} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\sffamily\bfseries typographische} -\SetHorizontalCoffin \ccc {\fontsize{12}{10}\sffamily - \quad zeitschrift des bildungsverbandes der - deutschen buchdrucker leipzig - \textbullet{} oktoberheft 1925} -\SetHorizontalCoffin \ddd {\fontsize{28}{20}\sffamily sonderheft} -\SetVerticalCoffin \eee {180pt} - {\raggedleft\fontsize{31}{36}\sffamily\bfseries - elementare\\ - typographie} -\SetVerticalCoffin \fff {140pt} - {\raggedright \fontsize{13}{14}\sffamily\bfseries - natan altman \\ - otto baumberger \\ - herbert mayer \\ - max burchartz \\ - el lissitzky \\ - ladislaus moholy-nagy \\ - moln\'ar f.~farkas \\ - johannes molzahn \\ - kurt schwitters \\ - mart stam \\ - ivan tschichold} - -\RotateCoffin \bbb {90} -\RotateCoffin \ccc {270} - -\SetHorizontalCoffin \rulei {\color{red}\rule{6.5in}{1pc}} -\SetHorizontalCoffin \ruleii {\color{red}\rule{1pc}{23.5cm}} -\SetHorizontalCoffin \ruleiii{\color{black}\rule{10pt}{152pt}} - - -\JoinCoffins \result \aaa -\JoinCoffins \result[\aaa-t,\aaa-r] \rulei [b,r](0pt,2mm) -\JoinCoffins \result[\aaa-b,\aaa-l] \bbb [B,r](2pt,0pt) -\JoinCoffins \result[\bbb-t,\bbb-r] \ruleii [t,r](-2mm,0pt) -\JoinCoffins \result[\aaa-B,\aaa-r] \ccc [B,l](66pt,14pc) -\JoinCoffins \result[\bbb-l,\ccc-B] \fff [t,r](-2mm,0pt) -\JoinCoffins \result[\fff-b,\fff-r] \ruleiii [b,l](2mm,0pt) -\JoinCoffins \result[\ccc-r,\fff-l] \eee [B,r] -\JoinCoffins \result[\eee-T,\eee-r] \ddd [B,r](0pt,4pc) - - -\vspace*{3cm} -\begin{center} - {\Large Title page of ``elementare typographie'' by Ivan Tschichold\par} - -\large -\vspace*{1cm} - - 1. first the scanned original from 1925 - -\vspace*{6mm} - - 2. then the recreated \TeX{} version from 2010 using coffins---not - attempting\\ to match the fonts and size but the structure - -\vspace*{6mm} - - 3. and finally the source code used. - - This document uses the new - implementation by Joseph in \texttt{l3coffins-new}. - -\end{center} - -\newpage - - -\begin{center} - \null - \fbox{\includegraphics[scale=.95]{elementare-typographie-title.jpg}} -\end{center} - -\newpage - -\TypesetCoffin \result - -\newpage - -\vspace*{3cm} -\begin{center} - {\Large Code used: \par} -\vspace*{1cm} - - -\begin{minipage}{14cm} -\begin{verbatim} -\SetHorizontalCoffin\result{} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\sffamily\bfseries typographische} -\SetHorizontalCoffin \ccc {\fontsize{12}{10}\sffamily - \quad zeitschrift des bildungsverbandes der - deutschen buchdrucker leipzig - \textbullet{} oktoberheft 1925} -\SetHorizontalCoffin \ddd {\fontsize{28}{20}\sffamily sonderheft} -\SetVerticalCoffin \eee {180pt} - {\raggedleft\fontsize{31}{36}\sffamily\bfseries - elementare\\ - typographie} -\SetVerticalCoffin \fff {140pt} - {\raggedright \fontsize{13}{14}\sffamily\bfseries - natan altman \\ - otto baumberger \\ - herbert mayer \\ - max burchartz \\ - el lissitzky \\ - ladislaus moholy-nagy \\ - moln\'ar f.~farkas \\ - jahannes molzahn \\ - kurt schwitters \\ - mart stam \\ - ivan tschichold} - -\RotateCoffin \bbb {90} -\RotateCoffin \ccc {270} - -\SetHorizontalCoffin \rulei {\color{red}\rule{6.5in}{1pc}} -\SetHorizontalCoffin \ruleii {\color{red}\rule{1pc}{23.5cm}} -\SetHorizontalCoffin \ruleiii{\color{black}\rule{10pt}{152pt}} - -\JoinCoffins \result \aaa -\JoinCoffins \result[\aaa-t,\aaa-r] \rulei [b,r](0pt,2mm) -\JoinCoffins \result[\aaa-b,\aaa-l] \bbb [B,r](2pt,0pt) -\JoinCoffins \result[\bbb-t,\bbb-r] \ruleii [t,r](-2mm,0pt) -\JoinCoffins \result[\aaa-B,\aaa-r] \ccc [B,l](66pt,14pc) -\JoinCoffins \result[\bbb-l,\ccc-B] \fff [t,r](-2mm,0pt) -\JoinCoffins \result[\fff-b,\fff-r] \ruleiii [b,l](2mm,0pt) -\JoinCoffins \result[\ccc-r,\fff-l] \eee [B,r] -\JoinCoffins \result[\eee-T,\eee-r] \ddd [B,r](0pt,4pc) -\SetHorizontalCoffin\result{} -\SetHorizontalCoffin \aaa {\fontsize{52}{50}\sffamily\bfseries - mitteilungen} -\SetHorizontalCoffin \bbb {\fontsize{52}{50}\rotatebox{90}{\sffamily\bfseries - typographische}} - -\TypesetCoffin \result -\end{verbatim} - -This is not necessarily the final syntax but for now it does its job. For -example, flexible support for adding ornaments (lines, \ldots) is still -missing, so above the rules got added as predefined individual coffins. - -\end{minipage} -\end{center} - -\end{document} - diff --git a/Master/texmf-dist/doc/latex/xpackages/xhead/xhead-test.tex b/Master/texmf-dist/doc/latex/xpackages/xhead/xhead-test.tex deleted file mode 100644 index f845a1f077a..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xhead/xhead-test.tex +++ /dev/null @@ -1,245 +0,0 @@ -\documentclass[twoside,check-declarations]{article} - -\pagestyle{headings} -\usepackage{xparse,xtemplate} - - -\usepackage{xgalley} - -\ExplSyntaxOn - -\DeclareTemplateInterface { parshape } { rectangle } { 0 } { - forbid-page-break : boolean = false , -} - -\DeclareTemplateCode { parshape } { rectangle } { 0 } - { - forbid-page-break = \l_xgalley_parshape_no_break_bool , - } - { - \AssignTemplateKeys - \xgalley_measure_adjust_parshape: - } - -\DeclareInstance { parshape } { plain } { rectangle } { - forbid-page-break = false -} - -\DeclareInstance {measure} {fullwidth} {absolute} { - left-margin = 0pt , - right-margin = 0pt -} - -\ExplSyntaxOff - - -\usepackage{xhead} - - -\DeclareDocumentCommand \sectionII {som} - { \UseInstance{heading}{sectionII} {#1}{#2}\BooleanFalse\NoValue\BooleanFalse{#3}{} } - -\DeclareDocumentCommand \subsectionII {som} - { \UseInstance{heading}{subsectionII} {#1}{#2}\BooleanFalse\NoValue\BooleanFalse{#3}{} } - -\DeclareDocumentCommand \subsubsectionII {som} - { \UseInstance{heading}{subsubsectionII} {#1}{#2}\BooleanFalse\NoValue\BooleanFalse{#3}{} } - - - -\DeclareInstance {heading} {sectionII} {2e-vertical} - { - name = section, - level = 1, - indent = 0pt, - above-skip = 3.5ex plus 1ex minus 0.2ex, - below-skip = 2.3ex plus 0.2ex, - title-decl = \normalfont\Large\bfseries, - indent-after = false, - } -\DeclareInstance {heading} {subsectionII} {2e-vertical} - { - name = subsection, - level = 2, - indent = 0pt, - above-skip = 3.25ex plus 1ex minus 0.2ex, - below-skip = 1.5ex plus 0.2ex, - title-decl = \normalfont\large\bfseries, - indent-after = false, - } - -\DeclareInstance {heading} {subsubsectionII} {2e-vertical} - { - name = subsubsection, - level = 3, - indent = 0pt, - above-skip = 3.25ex plus 1ex minus 0.2ex, - below-skip = 1.5ex plus 0.2ex, - title-decl = \normalfont\normalsize\bfseries, - indent-after = false, - } - - -\DeclareDocumentCommand \section {D<>{} sososm} - { \UseInstance{heading}{section} {#2}{#3}{#4}{#5}{#6}{#7}{#1} } - -\DeclareDocumentCommand \subsection {D<>{} sososm} - { \UseInstance{heading}{subsection} {#2}{#3}{#4}{#5}{#6}{#7}{#1} } - -\DeclareDocumentCommand \subsubsection {D<>{} sososm} - { \UseInstance{heading}{subsubsection} {#2}{#3}{#4}{#5}{#6}{#7}{#1} } - - -\DeclareInstance {heading} {section} {3a-vertical} - { - name = section, - level = 1, - indent = 0pt, - above-skip = 3.5ex plus 1ex minus 0.2ex, - below-skip = 2.3ex plus 0.2ex, - font = \normalfont\Large\bfseries, - indent-after = false, - } -\DeclareInstance {heading} {subsection} {3a-vertical} - { - name = subsection, - level = 2, - indent = 0pt, - above-skip = 3.25ex plus 1ex minus 0.2ex, - below-skip = 1.5ex plus 0.2ex, - font = \normalfont\large\bfseries, - indent-after = false, - } - -\DeclareInstance {heading} {subsubsection} {3a-vertical} - { - name = subsubsection, - level = 3, - indent = 0pt, - above-skip = 3.25ex plus 1ex minus 0.2ex, - below-skip = 1.5ex plus 0.2ex, - font = \normalfont\normalsize\bfseries, - indent-after = false, - } - -\DeclareInstance {heading} {section} {3b-vertical} - { - name = section, - level = 1, - indent = 0pt, - above-skip = 3.25ex plus 1ex minus 0.2ex, - below-skip = 1.5ex plus 0.2ex, - indent-after = false, - title-format = \UseTemplate{textblock-2}{hangfrom} - { - font-1 = \normalfont\Huge\sffamily , - font-2 = \normalfont\Large\bfseries, - parshape = plain , - justification = flush-left , - } - } - - -\setcounter{secnumdepth}{2} - -\begin{document} - - -\tableofcontents - - -\sectionII{2e section test} -Some text - -\subsectionII*{2e subsection test - star} -Some text - -\subsectionII{2e subsection test} -Some text - -\subsectionII{2e subsection test - very long very long very long very long - very long very long very long very long very long very long very with some - variance in text long very long very long very long very long very long } -Some text - -\subsubsectionII{2e subsubsection test} -Some text - -\subsectionII[2e subsection short]{2e subsection test - optional arg} -Some text - -\newpage - -\subsubsectionII*{2e subsubsection test - star} -Some text - -\subsubsectionII[2e subsubsection short]{2e subsubsection test - optional arg} -Some text - - -\sectionII[2e section short]{2e section test - optional arg} -Some text - -\sectionII*{2e section test - star} -Some text - -\newpage - - -\section{3a section test} -Some text - -\subsection*{3a subsection test - star} -Some text - -\subsection*[subsection star - forced]*{3a subsection test - star - forced} -Some text - -\subsection{3a subsection test} -Some text - -\subsection{3a subsection test - very long very long very long very long - very long very long very long very long very long very long very with some - variance in text long very long very long very long very long very long } -Some text - -\subsubsection{3a subsubsection test} -Some text - -\subsection[3a subsection short]{3a subsection test - optional arg} -Some text - -\newpage - -\subsubsection*{3a subsubsection test - star} -Some text - -\subsubsection*[subsubsection star - forced]*{3a subsubsection test - star - forced} -Some text - -\subsubsection[3a subsubsection short]{3a subsubsection test - optional arg} -Some text - -\section[3a section short]{3a section test - optional arg} -Some text - -\section*{3a section test - star} -Some text - -\section***{3a section test - 3 stars} -Some text - -\section*[][]*{3a section test - 2 stars} -Some text - -\section[3a section short2][3a section run]{3a section test - 2 optional args} -Some text - -\newpage - -Some more text - -\section{3a section test - angles} -Some text - -\end{document} diff --git a/Master/texmf-dist/doc/latex/xpackages/xhead/xhead.pdf b/Master/texmf-dist/doc/latex/xpackages/xhead/xhead.pdf deleted file mode 100644 index b41698108cf..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xhead/xhead.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e-demo.tex b/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e-demo.tex deleted file mode 100644 index a00531e0741..00000000000 --- a/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e-demo.tex +++ /dev/null @@ -1,46 +0,0 @@ -% !TEX encoding = ISO-8859-1 -% !TEX program = pdflatex -% -% This file demonstrates the use of the l3keys2e module to allow -% LaTeX3 keyvals (created using l3keys) to be used as LaTeX2e -% package or class options. -% - -% First, create a class -\begin{filecontents}{l3keys2e-class.cls} - \LoadClass{article} - \RequirePackage{l3keys2e} - \ProvidesExplClass{l3keys2e-class}{0000/00/00}{0.0}{test} - \keys_define:nn { test1 } { - option1 .code:n = {\wlog{You~gave~`#1'~for~option1}} - } - \ProcessKeysOptions { test1 } -\end{filecontents} - -% Load the class with some options. -% The class itself recognises `option1', leaving `option2' and -% `option3' as global optons which are not yet used. -\documentclass[option1=check,option2=more stuff,option3=unused] - {l3keys2e-class} - -%Now create a package -\begin{filecontents}{l3keys2e-package.sty} - \RequirePackage{l3keys2e} - \ProvidesExplPackage{l3keys2e-package}{0000/00/00}{0.0}{test} - \keys_define:nn { test2 } { - option1 .code:n = {\wlog{You~gave~`#1'~for~option1~(again)}}, - option2 .code:n = {\wlog{You~gave~`#1'~for~option2}}, - option4 .code:n = {\wlog{You~gave~`#1'~for~option4}}, - } - \ProcessKeysOptions { test2 } -\end{filecontents} - -% Load the package. -\usepackage[option4={extra stuff},option5=undefined!] - {l3keys2e-package} - -\begin{document} -% The log should show that option3 is an unused global option, and that -% option5 is not known by the l3keys2e-demo package. Everything else -% should simply be listed in the log. -\end{document} diff --git a/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e.pdf b/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e.pdf deleted file mode 100644 index 7afdd8c91e9..00000000000 Binary files a/Master/texmf-dist/doc/latex/xpackages/xtras/l3keys2e.pdf and /dev/null differ diff --git a/Master/texmf-dist/source/latex/xpackages/xbase/ldcsetup.dtx b/Master/texmf-dist/source/latex/xpackages/xbase/ldcsetup.dtx deleted file mode 100644 index b47930bc217..00000000000 --- a/Master/texmf-dist/source/latex/xpackages/xbase/ldcsetup.dtx +++ /dev/null @@ -1,331 +0,0 @@ -% \iffalse -%% File: ldcsetup.dtx (C) Copyright 1999 Frank Mittelbach, Chris Rowley, David Carlisle -%% (C) Copyright 2004-2009 Frank Mittelbach, LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3c of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%<*driver|package> -\RequirePackage{expl3} -% -%\fi -\GetIdInfo$Id: ldcsetup.dtx 1628 2009-10-25 09:54:34Z mittelba $ - {coding conventions and stuff} -%\iffalse -%<*driver> -%\fi -\ProvidesFile{\filename.\filenameext} - [\filedate\space v\fileversion\space\filedescription] -%\iffalse -\documentclass{l3doc} -\begin{document} -\DocInput{ldcsetup.dtx} -\end{document} -% -% \fi -% -% \CheckSum{0} -% -% \title{The \textsf{ldcsetup} package\thanks{This file -% has version number \fileversion, last -% revised \filedate.}} -% \author{DPC, FMi} -% \date{\filedate} -% \maketitle -% -% \begin{abstract} -% Basic code shared by several other packages currently under development. -% \end{abstract} -% -% \StopEventually{} -% -% \begin{macrocode} -%<*package> -\ProvidesExplPackage - {\filename}{\filedate}{\fileversion}{\filedescription} -% \end{macrocode} -% \begin{macrocode} -\RequirePackage{keyval} -\RequirePackage{expl3} -\ExplSyntaxOff -% \end{macrocode} -% -% \section{Ignoring White Space} -% Within a package, or in a document preamble, you can use -% |\IgnoreWhiteSpace| this makes white space ignored, and |@| -% a letter, and |~| a space character. It lasts until the end of the -% current package or preamble. -% -%% Puts an ignored space at the end of the line, so `|\ |' does the right -% thing. (Perhaps should instead just change catcode of |^^M|) -% \begin{macrocode} -\def\IgnoreWhiteSpace{% - \edef\@tempa{% - \catcode`\noexpand\~=\the\catcode`\~\relax - \catcode`\noexpand\ =\the\catcode`\ \relax - \catcode`\noexpand\^^I=\the\catcode`\^^I\relax - \catcode`\noexpand\@=\the\catcode`\@\relax - \endlinechar=\the\endlinechar\relax - }% - \ifx\@currname\@empty - \expandafter\AtBeginDocument\expandafter{\@tempa}% - \else - \expandafter\AtEndOfPackage\expandafter{\@tempa}% - \fi - \catcode`\~=10\relax - \catcode`\ =9\relax - \catcode`\^^I=9\relax - \makeatletter - \endlinechar=` % - \relax -} -% \end{macrocode} -% The new syntax requires |:| and |_| to be letters; instead of -% putting that into |\IgnoreWhiteSpace| we make a new command which -% helps to gradually change packages from old to new syntax. -% \begin{macrocode} -\def\InternalSyntaxOn{% - \edef\@tempa{% - \catcode`\noexpand\~=\the\catcode`\~\relax - \catcode`\noexpand\ =\the\catcode`\ \relax - \catcode`\noexpand\^^I=\the\catcode`\^^I\relax - \catcode`\noexpand\@=\the\catcode`\@\relax - \catcode`\noexpand\:=\the\catcode`\:\relax - \catcode`\noexpand\_=\the\catcode`\_\relax - \endlinechar=\the\endlinechar\relax -%FMi fix is not properly reset - \endlinechar=13\relax - }% -%%% ???? -% this needs further work, don't think it is working - \ifx\InternalSyntaxOff\relax - \expandafter\def\expandafter\InternalSyntaxOff\expandafter - {\@tempa\let\InternalSyntaxOff\relax}% - \fi - \ifx\@currname\@empty - \expandafter\AtBeginDocument\expandafter{\@tempa}% - \else - \expandafter\AtEndOfPackage\expandafter{\@tempa}% - \fi - \catcode`\~=10\relax - \catcode`\ =9\relax - \catcode`\^^I=9\relax - \makeatletter - \catcode`\_=11\relax - \catcode`\:=11\relax - \endlinechar=` % - \relax -} -\let\InternalSyntaxOff\relax -% \end{macrocode} -% -% Do it for this package. -% \begin{macrocode} -%\InternalSyntaxOn -\ExplSyntaxOn -% \end{macrocode} -% -% \section{KV fixes} -% Allow\footnote{Not needed now?} key names to start with |\|. -% \begin{macrocode} -\cs_set_nopar:Npn \define@key#1#2{% - \@ifnextchar[ - {\KV@def{#1}{\string#2}} - {\@namedef{KV@#1@\string#2}####1}} -\cs_set_nopar:Npn \setkeys#1#2{% - \cs_set_nopar:Npn \KV@prefix{KV@#1@\expandafter\string}% - \KV@do#2,\relax,} -% \end{macrocode} -% -% Make KV |#| safe. -% \begin{macrocode} -% \end{macrocode} -% -% \begin{macrocode} -\newtoks\KV@toks -% \end{macrocode} -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@@sp@c#1\@nil#2\relax#3{\KV@toks{#1}\cs_set_nopar:Npx #3{\the\KV@toks}} -% \end{macrocode} -% -% Generate error messages on missing `,'. -% -% More exactly if two `=' appear after a key generate an error. -% The current KV just silently ignores everything after the second `='. -% \begin{macrocode} -\cs_set_nopar:Npn \KV@equal{=} -% \end{macrocode} -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@split#1=#2=#3\relax{% - \KV@@sp@def\@tempa{#1}% - \cs_set_nopar:Npn \@tempd{#3}% - \ifx\@tempa\@empty\else - \expandafter\cs_set_eq:NN \expandafter\@tempc - \csname\KV@prefix\@tempa\endcsname - \ifx\@tempc\relax - \KV@error{\@tempa\space \expandafter\@gobbletwo\string\@undefined}\@eha - \else - \ifx\@tempd\@empty - \KV@default - \else - \KV@@sp@def\@tempb{#2}% - \ifx\@tempd\KV@equal - \expandafter\@tempc\expandafter{\@tempb}\relax - \else - \KV@error{Extra~=~ sign~ after~ `#1'}\KV@erry - \fi - \fi - \fi - \fi} -% \end{macrocode} -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@erry{\expandafter\KV@errx\meaning\@tempd\relax ignored\MessageBreak - missing~comma~in~`\expandafter\strip@prefix\meaning\@tempb'~?} -% \end{macrocode} -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@errx#1>#2==\relax{% - `#2' } -% \end{macrocode} -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@default{% - \expandafter\cs_set_eq:NN \expandafter\@tempb - \csname\KV@prefix\@tempa @default\endcsname - \ifx\@tempb\relax - \KV@error{No value specified for \@tempa}\@eha - \else - \@tempb\relax - \fi} -% \end{macrocode} -% -% \LaTeX\ style error message. -% \begin{macrocode} -\cs_set_nopar:Npn \KV@error#1#2{\PackageError{keyval}{#1}{#2}} -% \end{macrocode} -% -% Instead of doing a full KV parse, and evaluating all the keys, -% you might want to parse a parameter list, even for undefined keys, -% removing spaces, splitting up the `,` and `=' and resolving cases -% where no value is supplied. This is used in |\DeclareGenericFunction| -% which \emph{defines} a set of keys via such a KV parse. -% -% A setting of |, key = value ,| will result in |\KV@elt{key}{value}| -% being added to the list, a seting of |, key ,| will result in -% |\KV@default@elt{key}| being added. At the end of the parse the list -% is executed. No keys are checked at this stage (so no csnames are used -% up) the two |\KV|\ldots|@elt| commands must be defined as appropriate. -% -% \begin{macrocode} -\cs_set_nopar:Npn \KV@parse#1{ - \begingroup -% \end{macrocode} -% -% Locally fudge |\KV@@def| to just add to a token register -% rather than make a definition. -% \begin{macrocode} -\cs_set_nopar:Npn \KV@@sp@c##1\@nil##2\relax##3{\addto@hook##3{{##1}}} -% \end{macrocode} -% -% Locally fudge |\KV@split| to just add to a token register -% rather than execute the code for the found keys. -% \begin{macrocode} -\cs_set_nopar:Npn \KV@split##1=##2=##3\relax{% - \cs_set_nopar:Npn \@tempd{##3}% - \expandafter\ifx\expandafter=\@firstofone##1=\else - \ifx\@tempd\@empty - \addto@hook\KV@toks\KV@default@elt - \KV@@sp@def\KV@toks{##1}% - \else - \ifx\@tempd\KV@equal - \addto@hook\KV@toks\KV@elt - \KV@@sp@def\KV@toks{##1}% - \KV@@sp@def\KV@toks{##2}% - \else - \KV@err{Extra `=' after `##1'}\@ehd - \fi - \fi - \fi} -% \end{macrocode} -% -% Initialise -% \begin{macrocode} - \KV@toks{} -% \end{macrocode} -% Do the parse -% \begin{macrocode} - \KV@do#1,\relax, -% \end{macrocode} -% Evaluate the token register outside the group. -% \begin{macrocode} - \expandafter - \endgroup - \the\KV@toks} -% \end{macrocode} -% -% \section{Calc fixes} -% -% Count Register assignments via calc. Here we also provide some -% global versions since a normal global prefix won't have any effect. -% \begin{macrocode} -\cs_set_eq:NN \SetInternalCounter \calc_int_set:Nn -\cs_set_eq:NN \GSetInternalCounter\calc_int_gset:Nn -% \end{macrocode} -% -% -% \section{Misc code that is best collected in one place} -% -% This section will receive odd code that would be of potential use to -% other packages and should eventually made it to the kernel -% (perhaps). -% -% \begin{macro}{\UndeclareRobustCommand} -% Remove a robust command from memory if it isn't used any -% longer. Of course this doesn't free the hash table but at least -% the space gets reclaimed. -% \begin{macrocode} -\cs_set_nopar:Npn \UndeclareRobustCommand#1{% - \cs_gundefine:N #1 - \exp_args:Nc \cs_gundefine:N {\cs_to_str:N #1~} -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macrocode} -% -% \end{macrocode} -% -% \Finale -% diff --git a/Master/texmf-dist/source/latex/xpackages/xbase/template.dtx b/Master/texmf-dist/source/latex/xpackages/xbase/template.dtx deleted file mode 100644 index c5006a5e3fb..00000000000 --- a/Master/texmf-dist/source/latex/xpackages/xbase/template.dtx +++ /dev/null @@ -1,2452 +0,0 @@ -% \iffalse -%% File: template.dtx (C) Copyright 1999-2001 David Carlisle, Frank Mittelbach -%% (C) Copyright 2004-2009 Frank Mittelbach, LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3c of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%<*driver|package> -\RequirePackage{expl3} -% -%\fi -\GetIdInfo$Id: template.dtx 2063 2010-10-03 08:26:49Z mittelba $ - {template} -%\iffalse -%<*driver> -%\fi -\ProvidesFile{\filename.\filenameext} - [\filedate\space v\fileversion\space\filedescription] -%\iffalse -\documentclass{l3doc} -\makeatletter - \newenvironment{decl}[1][]% - {\par\small\addvspace{4.5ex plus 1ex}% - \vskip -\parskip - \ifx\relax#1\relax - \def\@decl@date{}% - \else - \def\@decl@date{\NEWfeature{#1}}% - \fi - \noindent\hspace{-\leftmargini}% - \begin{tabular}{|l|}\hline\ignorespaces}% - {\\\hline\end{tabular}\nobreak\@decl@date\par\nobreak - \vspace{2.3ex}\vskip -\parskip\@afterheading} -\makeatother - - \begin{document} - \catcode`\_=11 - \catcode`\:=11 - \DocInput{template.dtx} - \end{document} -% -% -% -% \fi -% -% -% \CheckSum{0} -% -% \title{The \textsf{template} package\thanks{This file -% has version number \fileversion, last -% revised \filedate.}} -% \author{DPC, FMi} -% \date{\filedate} -% \maketitle -% -% \changes{0.06}{1998/12/17}{generic functions reborn as templates} -% -% \tableofcontents -% -% \section{Introduction} -% A \emph{Template} is a named `function' that has a fixed number -% of \emph{mandatory arguments} and an additional set of \emph{keys} -% or `named attributes' that are set in a `key value list'. That is, -% a comma separated set of assignments of the form:\\ -% \meta{key$_1$} |=| \meta{value$_1$} |,| -% \meta{key$_2$} |=| \meta{value$_2$} \ldots -% -% More specific instances of the template may be declared by -% specifying settings of the parameters. The key value list is parsed -% at the time the instance is declared, and an `internal' set of -% parameter assignments is passed to the template code. It is normally -% not parsed at run-time, though it is possible to enforce this -% behaviour. -% -% Templates have a \emph{type} and a \emph{name}. Templates -% of the same type have the same argument and parameter -% structure. That is, templates of the same type are expected to be -% exchangeable semantically. (However, except for checking that -% templates of the same type always have the same number of arguments -% this is not enforced by the code.) -% -% A template type is declared via the |\DeclareTemplateType| -% declaration which takes two arguments: the name for the type and the -% number of arguments a template of this type requires. -% -% Templates are declared via the |\DeclareTemplate| -% command which takes five arguments -% \begin{itemize} -% \item The \emph{type} of the template (no |\|). -% \item The \emph{name} of the template (no |\|). -% \item The number of arguments for the template (same as on type -% declaration). -% \item A list declaring the keys accepted by the template, -% with information about the action to take when the key is specified -% with a value. -% \item The code for the template. This may be arbitrary \TeX\ -% code. At some point it should execute |\DoParameterAssignments| -% to run the parameter assigments. -% -% The mandatory arguments are accessed via |#1|, |#2|, \ldots -% \end{itemize} -% -% -% Each element of the key specification list is of the form: -% \begin{flushleft} -% \meta{key name} |=| -% \meta{key type} \meta{optional default} \meta{internal code} -% \end{flushleft} -% -% The \meta{key types} are essentially specified by giving a symbolic -% representation of the assignment function to be used by \TeX. -% -% Currently the possibilities are -% -% \begin{center}\catcode`|=12 -% \begin{tabular}{l|ll|l} -% key type& letter& internal code& argument form\\\hline -% Command & f\emph{n}&command name & command definition\\ -% name & n & command name & command definition\\ -% length & l & length register& calc length syntax\\ -% fake length & L & command name & calc length syntax\\ -% count & c & count register& calc count syntax\\ -% fake count & C & command name & calc count syntax\\ -% boolean & b & name of \verb|\newif| switch& true or false\\ -% switch & s & \marg{true code}\marg{false code}& true or false\\ -% instance& i\marg{type}& command name& instance of this \emph{type}\\ -% direct & x & Internal code& any\\ -% general & g & general code & any -% \end{tabular} -% \end{center} -% -% In addition, any of these types may be prefixed by |+| to -% denote a global assignment (described below). -% |f| takes a digit from 0--9 to denote the number of arguments. -% |n| is in fact the same as |f0|. When an instance is declared -% The value assigned to the key should be the definition of -% the command, using |#1|\ldots|#9| to denote the specified arguments. -% -% |c| takes an internal form a count register, -% not a \LaTeX\ counter name. -% -% For |f|, |n|, |l|, and |c|, the assignment is done twice, once -% at the time an instance is \emph{declared}. (This may involve -% using \textsf{calc} expresions. Then the `primitive assignment' -% of the value (not using calc) is copied to the internal parameter -% list, to be executed when an instance is run. Sometimes you need the -% expression to be evaluated at the time an instance is run rather -% than the time it is declared. For example it may be an expression -% involving some values that are not fixed throughout a document. -% In this case the instance declaration may give a value in the -% form |\DelayedEvaluation|\marg{calc expression}. In this case -% the value is not evaluated when the instance is declared, and -% instead the entire expression is copied to the `internal parameter -% list' and is evaluated whenever the instance is used. -% -% |L| and |C| take the same value types as |l| and |c| but the internal -% assignments are to macros not registers. -% -% Keys declared with |b| and |s| each take values either \emph{true} or -% \emph{false}. if the key zzz is declared with |b| then specifying -% |zzz=true| will essentially pass |\zzztrue| to the internal parameter -% list (although in fact |\zzztrue| need not be defined) . If instead -% zzz had been declared via |s|, then |zzz=true| would pass the tokens -% of the \marg{true code} to the internal parameter list. -% -% If a key is specified as |x|, then when used the \emph{internal code} -% will be copied to the internal parameter lists. This code may use |#1| -% to denote the value supplied to the key in the instance declaration. -% Note that this code is \emph{only} copied at the time the instance is -% declared. It is not executed at this time. It is executed when the -% instance is executed.\footnote{Despite the question of whether or -% not x and g are still necessary these days, they have the wrong -% `names' since x is the one that is not executed during delcaration -% while g is.} -% -% If a key is declared with |g| then the code is run at the time the -% instance is declared. By default \emph{nothing} is passed to the -% internal parameter list. This code may use |#1| to denote the -% value that will be supplied when an instance is declared. -% Any code that should be run when an instance is executed should -% be explicitly passed to the internal parameter list using -% |\toks_add_right:Nn\l_TP_KV_assignments_toks{|\ldots|}| -% -% A key declared with |i|\marg{type} takes as value the name of a -% declared instance of that type. The command token associated with -% the key will store a command essentially equivalent to a call -% to |\UseInstance|\marg{type}\marg{name}, but in a slightly optimised -% internal form. -% As an exception to this rule the replacement code may be of the form -% |\UseTemplate| followed by the key settings for the template -% but without the mandatory arguments. In this case the `inner' -% instance declaration is `pre compiled' and the token assigned to -% the store the value assigned to this key will execute an instance -% of the template directly, it will not re-parse the keyword settings -% each time the instance is used. -% -% \section{Commands} -% -% -% \subsection{Template declaration commands} -% -% \begin{decl} -% |\DeclareTemplateType| \marg{type}\marg{num} -% \end{decl} -% Declare a template type. -% -% \begin{decl} -% |\DeclareTemplate| -% \marg{type}\marg{tname}\marg{num}\marg{keyspec}\marg{code} -% \end{decl} -% Declare a template \meta{tname} of type \meta{type} with the set of -% keys as defined by \meta{keyspec}. From this template instances can -% be declared using |\DeclareInstance| At runtime such instances will run -% \meta{code} and expect \meta{num} mandatory arguments (same number -% for all templates of one type).\footnote{The \meta{num} argument is -% redundent as it can be deduced from the type. However, for practical -% reasons it seems better to keep that information with each -% individual template declaration.} -% -% \begin{decl} -% |\DeclareRestrictedTemplate| -% \marg{type}\marg{new-tname}\marg{old-tname}\marg{keyvals} -% \end{decl} -% Declare as new template \meta{new-tname} for type \meta{type} by -% taking template \meta{old-tname} as the basis and setting one or -% more of its keys to specific values. -% -% \begin{decl} -% |\DoParameterAssignments| -% \end{decl} -% The list of key value assignments made (and saved) during template -% declaration is evaluated at this point in the template code. -% -% -% \subsection{Instance declaration commands} -% -% \begin{decl} -% |\DeclareInstance| \marg{type}\marg{iname}\marg{tname}\marg{keyvals} -% \end{decl} -% Declare an instance of type \meta{type} named \meta{iname} build -% from using template \meta{tname} with key settings as given by -% \meta{keyvals}. -% -% \begin{decl} -% |\DeclareCollectionInstance| -% \marg{collection}\marg{type}\marg{iname}\marg{tname}\marg{keyvals} -% \end{decl} -% Same as |\DeclareInstance| except that this instance is only active -% when for the type \meta{type} the collection \meta{collection} was -% selected via |\UseCollection|. E.g., within the frontmatter one -% could make all headings behave differently by defining collection -% instances for template type `head'. -% -% \subsection{Key value commands} -% -% \begin{decl} -% |\DelayEvaluation|\marg{code} -% \end{decl} -% Used in the value spec for an instance to declare that the value -% \meta{code} should not be evaluated at declaration time but at -% run-time. Can also be used in the defaults for keys (given in square -% brackets) in the declaration of templates. -% -% \begin{decl} -% |\MultiSelection| \meta{counter} \marg{cases} \marg{else} -% \end{decl} -% Used in the value spec for an instance key to declare that the value of -% this key depends on the current setting of \meta{counter} at run-time. -% The \meta{cases} argument is a comma-separated list of ``values'', -% the \meta{else} argument a single ``value''. If at run-time -% \meta{counter} has the value $i$ then the $i$-th element of the -% \meta{cases} list is selected. If that does not exist the -% \meta{else} case is returned. -% -% -% \subsection{Processing commands} -% -% \begin{decl} -% |\UseTemplate| \marg{type}\marg{tname}\marg{keyval} -% \end{decl} -% Execute a template \meta{tname} of type \meta{type} at run-time -% using \meta{keyvals} as the value assignments for its keys. In this -% case the keys are evaluated at run-time thus this method is far -% slower than using a predeclared instance of this template (see -% below). This command can also appear as the value for a key of type -% `i' in which case the evaluation happens at declaration time of the -% template that contains this key! -% -% -% \begin{decl} -% |\UseInstance| \marg{type}\marg{iname} -% \end{decl} -% Run the instance \meta{iname} of template type \meta{type}. If a -% collection is in force see if there is a collection instance of name -% \meta{iname} and if so run that instead. -% -% \begin{decl} -% |\UseCollection| \marg{type}\marg{collection} -% \end{decl} -% Declare that from now on (normal scoping rules) the collection -% \meta{collection} for template type \meta{type} is in force. This -% means that a call to |\UseInstance| will first check if there is a -% collection instance defined, and if so use that instance, otherwise -% use the normal instance. -% -% -% \subsection{Test commands} -% -% \begin{decl} -% |\IfExistsInstanceTF| \marg{type}\marg{iname}\marg{true}\marg{false} -% \end{decl} -% Test if for template type \meta{type} an instance with name -% \meta{iname} exists. Select \meta{true} or \meta{false} code -% accordingly. -% -% -% -% \section{Examples of template key types} -% -% The general syntax for key specification in templates (fourth argument -% of the command |\DeclareTemplate|) is: -%\begin{flushleft} -%| {| \\ -%| | \meta{key-name$_1$} |=|\meta{key-type$_1$} -% \meta{optional-default$_1$} \meta{storage-bin$_1$}|,|\\ -%| | \meta{key-name$_2$} |=|\meta{key-type$_2$} -% \meta{optional-default$_2$} \meta{storage-bin$_2$}|,|\\ -%| ...|\\ -%| }| -%\end{flushleft} -% In this section we look at all possible key types and give examples -% for them. -% -% -% \subsection{Attributes that receive names as values} -% -% The type |n| expects to receive a \LaTeX{} name as a value. Used, -% for example, to specify the name of a \LaTeX{} counter to use. -%\begin{verbatim} -% heading-id =n \heading@id, -% counter-id =n [\DelayEvaluation{\heading@id}] \heading@counter, -%\end{verbatim} -% Notice the use of |\DelayEvaluation| in the default of -% |counter-id|. It is necessary to make the default the token -% |\heading@id| if we want to inherit the value from the |heading-id| -% key. Otherwise it gets value of |\heading@id| at the time the -% instance is declared. -% -% -% \subsection{Attributes that receive functions as values} -% -% -% The type |f|\meta{num} expects a function with \meta{num} arguments -% as a value. The arguments are denoted by |#1|, |#2|, etc. In most -% cases either |f0| (for declarations) or |f1| (to format one argument) are -% needed. -%\begin{verbatim} -% initial-font =f0 \initial@font, -% initial-format =f1 [#1] \initial@boxhandling, -%\end{verbatim} -% -% \subsection{Attributes that receive dimensions as values} -% -% As far as specifying instances the |l| and |L| type behave -% identically. They differ only in the type of internal storage-bin -% they need: |l| expects a length register while |L| expects an -% ordinary macro name and assigns its value via |\cs_set_nopar:Npn |. -%\begin{verbatim} -% pre-sep =l \topsep, -% post-sep =L \botsep, -%\end{verbatim} -% -% -% -% \subsection{Attributes that receive integers as values} -% -% The |c| and |C| type receive integers as values. Again either of -% them can be transparently used. In case of |c| the -% \meta{storage-bin} has to be a \TeX{} count register not a \LaTeX{} -% counter name, i.e., set up via |\newcount|. (\LaTeX{} counters can -% be used as well if they are accessed via their internal name, i.e., -% via |\c@|\meta{\LaTeX-counter}) -%\begin{verbatim} -% pre-penalty =c \@beginparpenalty, -% penalty =C \hmaterial@penalty, -%\end{verbatim} -% -% -% -% \subsection{Attributes that receive template instances as values} -% -% The type |i|\marg{type} takes as value the name of a declared -% instance of that type. The \meta{storage-bin} associated with the -% key will store a command essentially equivalent to a call to -% |\UseInstance|\marg{type}\marg{name}, but in a slightly optimised -% internal form. -% -% As an exception to this rule the replacement code may be of the form -% |\UseTemplate| followed by the key settings for the template but -% without the mandatory arguments. In this case the `inner' instance -% declaration is `pre compiled' and the token assigned to the store -% the value assigned to this key will execute an instance of the -% template directly, it will not re-parse the keyword settings each -% time the instance is used. -%\begin{verbatim} -% justification-setup =i{justification} \list@justification, -%\end{verbatim} -% -% Usage within an instance declaration is either -%\begin{verbatim} -% justification-setup = raggedright, -%\end{verbatim} -% i.e., name of a declared instance or a call to |\UseTemplate| -%\begin{verbatim} -% justification-setup = \UseTemplate{justification}{TeX} -% { startskip = 0pt, ... }, -%\end{verbatim} -% -% -% -% \subsection{Attributes that receive true or false values} -% -% The type |s| expects the strings |true| or |false| as values. In -% this case the declaration has no \meta{storage-bin}. Instead the -% declaration consists of two brace groups containing code. Depending -% on the value one of the groups gets copied verbatim into the -% internal parameter list of the instance and gets executed at -% run-time at the point where |\DoParameterAssignments| is seen. -%\begin{verbatim} -% item-implicit-boolean =s -% { \cs_set_nopar:Npn \item@implicit@code{\item\relax} }{}, -% numbered-boolean =b [true] @heading@nums, -%\end{verbatim} -% -% -% \subsection{Attributes that accept any value} -% -% The type |g| is a low-level specification which contains arbitrary -% code in place of the \meta{storage-bin}. This code is evaluated at -% declaration time of the instance and by default \emph{nothing} is -% passed to the internal parameter list (this has to happen explicitly -% from within the code). |#1| may be used to access the value -% specified. -% -% The main purpose for this type is of historical nature (originally -% most of the other types have been implemented internally using |g|). -% -% The type |x| also requires code in place of the \meta{storage-bin}. -% However with this type all of the code is copied unevaluated to the -% internal parameter list. There are some applications for this type -% when implementing customisable defaults. However, it is likely that -% it will not survive a final release. -%\begin{verbatim} -% generic-key =g \typeout{#1}, -% extra-assigns =x \typeout{#1}, -%\end{verbatim} -% -% -% -% -% -% -% \section{A complete example} -% -% The following example shows a sketch of a template for typesetting -% captions to be used as part of a larger mechanism setting whole -% floats.\footnote{I made it up while I went along so if you spot the -% ``missing brace'' or some other blunder tell me, FMi.} -% -% We declare a template type \texttt{caption} then define an example -% template for that type and finally produce some instances from that. -% -% \subsection{Declaring the template type} -% -% To define the template type we first have to ask ourselves what -% information would be varying each time such a template is used? A -% potential answer could be the following: -% \begin{itemize} -% \item -% The float name, e.g., `Table' or `Fig.' etc. -% \item -% The float -% number e.g., `10' or `3--c' etc. -% \item -% The actual caption text as specified in the document. -% \end{itemize} -% Since the above items would be differed in each instantiation of -% such a template we would pass them as mandatory argument to the -% template. -% -% Are there others? Possibly. Here are two more that seem to be -% useful, at least in a number of cases: -% \begin{itemize} -% \item -% The text of the legend in document classes that distinguish -% between caption text (heading to the figure/table) and legend -% (explanatory material) -% \item -% Measure to which the caption should be typeset. -% \end{itemize} -% The last one of these might need some extra explanation. Suppose a -% design requires that the caption width is decided depending on the -% width of the table of figure, e.g., the caption is supposed to -% typeset below some illustration and should not be wider than that -% illustration, or the caption is typeset aside to the illustration -% using the remaining space. In that case the process that formats the -% whole float needs to communicate with the current template to pass -% that (varying) information along. Of course, that could happen by -% using global variables, e.g., the outer process sets the measure as -% desired before calling the caption formatting template. What makes -% more sense is likely to be a matter of taste but it also has to do -% with the precise semantics of the template type. Staying with our -% example: if the the semantics of the template type \texttt{caption} -% is supposed to produce a formatted box (in \TeX{} terms) then we -% should pass the measure as an argument if we ever intend to allow -% for variations. If on the other hand the semantics are to format a -% certain set of text into the current galley (which has measure of -% its own) then a measure argument would not belong to this template -% type. -% -% Are there other variations sensible? Yes, for example, instead of -% passing a fixed string like ``Fig.'' as the first argument one could -% pass an abstract float type identifier and let the template worry to -% deduce from that information what fixed string to produce. -% -% Another question: why should we pass the fixed text (or an abstract -% identifier from which it can be deduced) and the number as separate -% arguments to the template instead of passing a combined string (like -% it is done in the |\@makecaption| command of \LaTeXe{})? Answer: -% because this allows to build templates that can individually -% manipulate both bits of information, e.g., to format the number in a -% different font, etc. -% -% So what are the conclusions of this discussion? Defining the -% semantics of a template type is difficult and often needs several -% trials to come up with something that is covering the anticipated -% use. There is clearly not a cardinal way for defining template -% types; how the overall separation into smaller units is done is -% partly a matter of taste and partly a matter of the major layout -% characteristics that one tries to support. -% -% Returning to our example: let's assume we settle for the first four -% arguments, i.e., the calling template is responsible for setting the -% measure for the caption text if necessary. -% -% What we also have to do is to define (at least for ourselves) what -% data the arguments accept and what their semantics are. An informal -% summary of that could be the following: -% \begin{center} -% \begin{tabular}{rrl} -% \textit{Arg} & \textit{Data Type} & \textit{Description} \\[3pt] -% 1 & text & fixed float description -% \\ -% 2 & text/|\NoValue| & float number -% \\ -% 3 & text & caption text -% \\ -% 4 & text/|\NoValue| & legend text -% \\ -% \end{tabular} -% \end{center} -% The second and the fourth argument are allowed to be missing (i.e., -% can get |\NoValue| passed as a value). Note that the empty string in -% case of a text argument is different from |\NoValue|. -% -% We further declare that it is permissible for a template of this -% type to ignore the information provided by all arguments except 3, -% i.e., the caption text. -% -% Finally the result of the template formatting should is to typeset -% text into a current galley (paragraph mode in \LaTeX{} lingua). -% -% All the above is semantic information that (at least right now) is -% not being enforced by declaring a template type (except for the -% number of arguments) but each template of a certain type is supposed -% to conform to this specification nonetheless.\footnote{To make this -% even clearer we are thinking of extending the template type -% declaration with another argument in which one has to formally or -% informally (?) specifies information like the one in the table -% above.} -% -% This finally leads to the following declaration: -%\begin{verbatim} -%\DeclareTemplateType{caption}{4} -%\end{verbatim} -% -% \subsection{Defining a first template} -% -% We start by defining a simple template of type \texttt{caption} -% which roughly formats a caption like those being presented in -% \LaTeXe{}'s article class, i.e., the caption is typeset as a -% paragraph if it is longer than a single line, otherwise it is -% centered. The legend even if present is ignored. Above and below we -% give the designer the possibility to add some space. -% -% In fact the examples is more or less identical in code to -% |\@makecaption| except that if the second argument (i.e., the -% number) is |\NoValue| it and its preceding space\footnote{For those -% who wonder: spaces are by default ignored within definitions when -% the new packages are used due to a command \texttt{\textbackslash -% InternalSyntaxOn}, do get a normal space one has to use -% \texttt{\textasciitilde} and to obtain an unbreakable space -% \texttt{\textbackslash nobreakspace}.} gets ignored. -% -% We start by declaring the template \texttt{toosimple} of type -% \texttt{caption} having four mandatory arguments (as described in -% the discussion of the template type). -%\begin{verbatim} -%\DeclareTemplate{caption}{toosimple}{4} -%\end{verbatim} -% The next argument of |\DeclareTemplate| lists all keys for the -% template. In this case we have keys for the vertical spaces above -% and below. We make them type |L| to save on registers but with a bit -% of care we could also have used scratch registers like |\@tempskipa| -% etc. Their default values are both zero. -%\begin{verbatim} -% { -% above-skip =L [0pt] \caption@above@skip , -% below-skip =L [0pt] \caption@below@skip , -% } -%\end{verbatim} -% The final argument of |\DeclareTemplate| contains the actual -% processing code. We start with looking at the second mandatory -% argument (caption number) to find out if it is |\NoValue| and -% depending on the result define a helper command |\caption@start|. -%\begin{verbatim} -% { -% \IfNoValueTF{#2} -% { \cs_set_nopar:Npn \caption@start{#1:~} } -% { \cs_set_nopar:Npn \caption@start{#1~#2:~} } -%\end{verbatim} -% Having dealt with the prelims we now run |\DoParameterAssigments| at -% which point the keys of the template are made available, e.g., at -% this point all those right hand containers such as -% |\caption@above@skip| get assigned the value specified in an -% instantiation of the template. (That scheme allows to do preliminary -% processing up front, e.g., defaults for the keys could be assigned -% prior to that point in which case they are overwritten if the -% template instance specifies a different value. the use of specifying -% defaults via the |[..]| syntax as done above is slightly faster at -% run-time but needs more memory.) -%\begin{verbatim} -% \DoParameterAssigments -%\end{verbatim} -% The rest of the code should look familiar to anybody who ever looked -% at \texttt{article.cls}. The only point worth mentioning are the -% |\relax| commands after |\caption@above@skip| and -% |\caption@below@skip|. Since we have decided to use |L| as key type -% these commands are macros and not registers containing the -% dimensions as strings. This means that we have to be careful to -% ensure that \TeX{} knows where the dimension ends. In certain cases -% text following such a command might be mistaken as being part of the -% dimension (e.g., if followed by the word \texttt{plus}, etc.). In -% the code below this could only happen for the second |\vskip| but it -% is good practice to always add a terminating |\relax| to avoid such -% hidden traps. -%\begin{verbatim} -% \vskip \caption@above@skip \relax -% \sbox \@tempboxa {\caption@start #3} -% \ifdim \wd\@tempboxa >\hsize -% \caption@start #3\par -% \else -% \global \@minipagefalse -% \hb@xt@\hsize{\hfil\box\@tempboxa\hfil} -% \fi -% \vskip \caption@below@skip \relax -% } -%\end{verbatim} -% -% Why is the above template of not much use? Simply because it doesn't -% offer any flexibility to declare different designs. The only -% alteration offered to the designer is to modify the space above and -% below the caption, e.g., the following declaration would mimic the -% definition within the \texttt{article.cls} class of \LaTeXe : -%\begin{verbatim} -%\DeclareInstance{caption}{article}{toosimple} -% { -% above-skip = 0pt, -% below-skip = 10pt, -% } -%\end{verbatim} -% And that's all that can be manipulated. All items that people asking -% to change, e.g., not having a colon after the number, using -% different fonts and font sizes, etc.\ are still hard-wired and thus -% inaccessible. So we have to do better if we want to make use of the -% power the template mechanism offers. -% -% -% -% \subsection{Defining a better template} -% -% First step in defining better templates is to ask ourselves a couple -% of questions: -% \begin{itemize} -% \item What are the main characteristics of the layout the template -% is supposed to support? -% \item What are the elements that we want to allow (or can allow) the -% designer to modify? -% \end{itemize} -% -% Take the first question first: the layout supported by the template -% of the previous section had as its main characteristics that it -% would center the caption if it would fit in a single line in the -% current measure. We could consider this being an unchangable -% characteristic of the layout this template produces (and a designer -% would need to use a different template of type \texttt{caption} if a -% design compatible with this restriction is desired) or we could try -% to make our template smarter by adding bells and wistles that allow -% the designer to say stuff like: -%\begin{verbatim} -% one-line-format = \hfil #1 \hfil, -%\end{verbatim} -% or -%\begin{verbatim} -% one-line-action = center, -%\end{verbatim} -% depending on how we intend to offer changing the behavior of the -% template. Like when trying to define sensible template types we have -% no single road to heaven (and probably as many to hell) --- it has a -% lot to do with how we think about design. -% -% My advice, after having tried to work with these concepts for a -% while, is to keep templates simple in so far as that most of not all -% attribute for a template should be relevant for the design. In other -% words, if you have attributes that, depending on their setting, make -% half of the other attributes not applicable then it may be -% appropriate to think about providing several templates instead. To -% give an example from \LaTeXe : instead of having |\@startsection| -% deal with both vertical heads and run-in heads provide individual -% templates. (|\@startsection| is this famous command where design -% switches are build in by making dimensions negative to signal -% something and afterwards use the absolute value.) -% Another way to look at this is to say that a template should -% normally not contain large amounts of code which is only selected in -% a subset of attribute settings. -% -% As said before there are no golden rules, it is perfectly possible -% to make hugely complicated templates that solve every possible -% aspect of layout one could think of in one go --- it is just that -% with keeping it more simple one can get the same functionality with -% less headaches for the template writer as well as the template user -% later on. -% -% Returning to our example: allowing to handle the case of a single -% line caption specially could well be considered part of the -% template. In contrast: layouts that would put the caption number -% sideways, i.e., which would need totally different internal coding -% should probably be coded as a separate template of type -% \texttt{caption}. -% -% So for our next example template we settle for the fixed caption -% text plus number (if any) being at the beginning of the variable -% caption text (coming from the document) and being together formatted -% as some sort of a pargraph. In case of the whole caption being a -% single line we allow the designer to specify how to lay it out -% (e.g., centered, flush left, etc.). If there is a legend it will get -% formatted by a vertical space followed by the legend formatted as -% another paragraph. -% -% More precisely we allow for the following bells and wistles: -%\begin{verbatim} -%\DeclareTemplate{caption}{lesssimple}{4} -% { -%\end{verbatim} -% The designer can specify the space above and below the caption like -% we did in our first example. -%\begin{verbatim} -% above-skip =L [0pt] \caption@above@skip , -% below-skip =L [0pt] \caption@below@skip , -%\end{verbatim} -% Regarding the caption number we support the case where no number is -% present (the value being |\NoValue|) as well as the number being -% present. For both cases the designer has to specify what formatting -% should be attached. By default all is being typeset in the font the -% whole caption is presented but if there is a need for it the -% designer can use the following keys to attach special formatting -% devices to each particular item beside specifying special spacing -% information or replacing the default colon after the number with -% something else. -%\begin{verbatim} -% number-format =f2 [#1~#2:~] \caption@number@format, -% nonumber-format =f1 [#1:~] \caption@nonumber@format, -%\end{verbatim} -% If the caption is fitting onto a single line we make it possible -% for the designer to specify how this single line should be -% positioned (the default is to center the line). -%\begin{verbatim} -% single-line-format =f1 [\hfil#1\hfil] \caption@single@line@format, -%\end{verbatim} -% The font for the caption (including the fixed text and the number -% unless specified differently above) is going to be the one decided -% by the next key. -%\begin{verbatim} -% caption-font =f0 [\normalfont] \caption@font, -%\end{verbatim} -% The next attribute deserves some extra explanation: here we make use -% of an interface which is explained in more detail when we reveil the -% support for galley formatting.\footnote{Guess I have to apologize -% for the fact that i partly make use of that interface in this -% example while on other occasions (like the use of vertical spacing) -% within the example I do not---consistency around midnight is not my -% strength I fear (FMi).} In a nutshell the template type \texttt{hj} -% (hyphenation \& justification) allows one to define a) the -% justification concepts applied to the upcoming paragraphs, e.g., -% whether they should be set flush left, adjusted, first line -% centered, etc.\ b) the linebreaking strategy used and c) the -% hyphenation rules which should apply. All this is done by selecting -% an appropriate (predefined) instance of this type as will hopefully -% become somewhat clearer in the example instances shown below. -%\begin{verbatim} -% caption-hj-setup =i {hj} [default] \caption@hj@instance, -%\end{verbatim} -% In case there is a legend to format we give the designer the -% possibility to specify by how much vertical space it should be -% separated from the preceding paragraph (i.e., the caption text). The -% attributes for font and hj setup are comparable to those for the -% caption text itself (except that they will only apply to the -% legend). The only addition is the key \texttt{legend-text} which is -% allowed to take a fixed text (plus any formating and spacing for it) -% which will be added to the front of the legend in case it is -% provided at all (by default it is empty). -%\begin{verbatim} -% legend-sep =L [0pt] \caption@legend@sep , -% legend-text =f0 [] \caption@legend@text, -% legend-font =f0 [\normalfont] \caption@legend@font, -% legend-hj-setup =i {hj} [default] \caption@legend@hj@instance, -% } -%\end{verbatim} -% The actual code for the template should hold few if any -% surprises. In fact it is more or less identical to the one of the -% first template example, except that now we have now taken out some -% of the hardwired decisions and placed them into attributes. -%\begin{verbatim} -% { -% \IfNoValueTF{#2} -% { \cs_set_nopar:Npn \caption@start{\caption@number@format{#1}{#2}} } -% { \cs_set_nopar:Npn \caption@start{\caption@nonumber@format{#1}} } -% \DoParameterAssigments -% \vskip \caption@above@skip \relax -%\end{verbatim} -% To properly measure the caption to determine if it fits a single -% line we have to set it in the right font, so here as well as below -% we have to apply |\caption@font|. -%\begin{verbatim} -% \sbox \@tempboxa {\caption@font \caption@start #3} -% \ifdim \wd\@tempboxa >\hsize -% \begingroup -% \caption@font \caption@hj@instance -% \caption@start #3\par -% \endgroup -% \else -% \global \@minipagefalse -% \hb@xt@\hsize{\caption@single@line@format{\box\@tempboxa}} -% \fi -%\end{verbatim} -% To decide whether or not we have to set any legend we have to test -% |#4| for being |\NoValue|. This part of the code was not present in -% the previous example but otherwise should be straight forward. -%\begin{verbatim} -% \IfNoValueF{#4} -% { -% \vskip \caption@legend@sep \relax -% \begingroup -% \caption@legend@font \caption@legend@hj@instance -% \caption@legend@text -% #4\par -% \endgroup -% } -% \vskip \caption@below@skip \relax -% } -%\end{verbatim} -% -% I wouldn't claim the the above template is good or contains -% everything that would be desired and I'm sure that in the end we -% will have several such template for typesetting the caption part and -% perhaps decide on a different template type in the first place. So -% this is only to give a glimpse of how the template interface could -% be applied and I hope that reading it can see a) how they can apply -% it to other areas as well as see what is wrong with the example -% itself. -% -% To just note one point that i thought of being wrong after writing -% the above paragraphs: the key \texttt{single-line-format} was -% declared to be a function with one argument with the idea that -% besides specifying the single line should be centered (|\hfil|) on -% both sides, or flush left, or flush right (|\hfil| on one side) one -% could also specify something like -%\begin{verbatim} -% single-line-format = \hspace{10pt}#1\hfil, -%\end{verbatim} -% that is a fixed indentation on the left in case where the caption is -% a single line. However, of course one can't. Or at least it is not -% safe to do so since our test in the code tests the width of the line -% without taking into account such a finite fixed space and guess what -% might happen? So in summary, flexibility needs some thought and -% often some afterthoughts as well --- happy thinking :-) -% -% -% -% \subsection{Defining a few instances} -% -% So let us conclude this example with a few sample instances. We -% start with one that repeats what current \LaTeXe{} provides in the -% article class. It shows all keys with values. However in fact only -% the first key is actually needed since all others are the same as -% the default values in the template (and of course a legend is not -% specifiable in standard \LaTeX{} coding so those settings simply do -% not apply anyway). -%\begin{verbatim} -%\DeclareInstance{caption}{article}{lesssimple} -% { -% above-skip = 10pt, -% below-skip = 0pt, -% number-format = #1~#2:~, -% nonumber-format = #1:~, -% single-line-format = \hfil#1\hfil, -% caption-font = \normalfont, -% caption-hj-setup = default, -% legend-sep = 0pt, -% legend-text = , -% legend-font = \normalfont, -% legend-hj-setup = default, -% } -%\end{verbatim} -% -% The next examples are taken from books on the shelf essentially a -% random selection I fear. This one is from \emph{Introduction to -% Database Design} by C.~J.~Date and it uses Helvetica for the caption -% text with the caption flush left, with the figure and the fixed -% string (e.g., `Fig.' in bold face) separated by a quad of space. No -% legend either so this is not set up. The \texttt{hj} instance -% \texttt{noindentflushleft} is supposed to produce a ragged right paragraph -% without any indentation. It would have to be set up elsewhere -% (instance to the template of type \texttt{hj}). -%\begin{verbatim} -%\DeclareInstance{caption}{DATE}{lesssimple} -% { -% above-skip = 10pt, -% below-skip = 0pt, -% number-format = \textbf{#1~#2}\quad, -% nonumber-format = \textbf{#1}\quad, -% single-line-format = #1\hfil, -% caption-font = \fontfamily{phv} \normalfont, -% caption-hj-setup = noindentflushleft, -% } -%\end{verbatim} -% -% The final example is from the book ``Methods of Book Design'' by -% H.~Williamson which sets the caption centered if it fits a single -% line but adjusted as a paragraph without any indentation if longer -% than a single line. It uses old style numerals followed by a period -% for the number (though the example isn't quite right as i guess the -% text font used already has oldstyle numerals as default, so -% |\oldstylenums| is in fact not necessary). -%\begin{verbatim} -%\DeclareInstance{caption}{WILLIAMSON}{lesssimple} -% { -% above-skip = 10pt, -% below-skip = 0pt, -% number-format = #1~\oldstylenums{#2}.~, -% nonumber-format = #1~, -% single-line-format = \hfil#1\hfil, -% caption-font = \normalfont, -% caption-hj-setup = noindentadjusted, -% } -%\end{verbatim} -% -% -% -% \section{Notes} -% -% \subsection{Note on multi-valued parameters} -% -% -% The following code\footnote{docu taken from trial implementation in -% xlists.dtx, FMi} implements for registers (ie L,l,C,c keys) and -% for names (ie n key) a multi-selection mechanism of the following -% form: -% \begin{verbatim} -% key = \MultiSelection \ListDepth { -% \DelayEvaluation {2.5em}, -% 20pt + 34pt } -% { \DelayEvaluation {1em} }, -% \end{verbatim} -% where the first argument to |\MultiSelection| is a counter, the -% second argument is a comma separated list of values denoting the -% values for the cases 1, 2,\ldots, and the third argument contains -% the value for all other cases. -% -% The values are evaluated at declaration time in case of registers -% and therefore can contain calc expressions as well as -% |\DelayEvaluation|. -% -% Due to the implementation the case list is not allowed to have a -% trailing comma! And of course no checks are made whatsoever :-( -% -% A probably much nicer syntax would be something like this: -% \begin{verbatim} -% key = \MultiSelection { -% selector = \ListDepth, -% 1 = \DelayEvaluation {2.5em}, -% 2 = 20pt + 34pt, -% else = \DelayEvaluation {1em} -% }, -% \end{verbatim} -% but i found that too difficult to implement right now. -% -% I think it should also be considered if this kind of thing should be -% a generally available feature on all key types especially on the -% f\meta{number} ones. -% -% Anyway it is what i need for lists right now and as such it is -% sufficient. -% -% -% \subsection{Notes on template restriction} -% -% Possible semantics: -% -% a: just:-) changes the defaults ie the new template has as -% defaults those of its source as modified by the supplied -% keyvals; -% -% b: similar to a: but also removes some keywords ie the new template -% will not accept the keywods whose values are set by the suppied -% keyvals; -% -% c: plan C. -% -% -% Towards an implementation of b: but without a restriction on what -% keys appear where. -% -% -% -% -% \subsection{Open issues} -% -% In this section unresolved issues or ideas to think about and -% perhaps implement are collected. There is no particular order to -% them. -% -% \begin{itemize} -% \item The order of arguments in |\UseCollection| is illogical in my -% eyes! A collection typically modifies the behavior of several -% types and thus should perhaps be first (as it is in the -% |\DeclareCollectionInstance| case). Or not, or what? -% -% \item How should |\IfExistsInstanceTF| behave for Collection -% instances? Do we need a special check for those or a default -% action? Or do we need an additional test for the existence of -% collection instances? -% -% \item It was suggested that the template type declaration should get -% another argument in which (in?)formally the semantics for the -% template types are described, e.g., data type of arguments, -% resulting output, \ldots{} (somewhat like the description arguments -% for functions and variables in Emacs-Lisp). The advantage being -% that this helps employing the templates better as well as perhaps -% guiding context sensitive editors to support the work with such -% templates (e.g., providing help texts). -% -% \item The same might be of interest for the keys of individual -% templates though here syntax support is already available to some -% extend by the declaration of key types. -% -% \item There might be a need to distinguish between \TeX's dimen and -% skip registers. Right now this is not done and both |l| and |L| -% accepts what \LaTeX{} calls ``rubber length'' specifications. -% -% \item The type |b| can probably vanish. It is equivalent to -% specifying the mutators of a |\newif| command in the brace groups, -% e.g. -%\begin{verbatim} -% numbered-boolean =b [true] @heading@nums, -% numbered-boolean =s [true] {\@heading@numstrue} -% {\@heading@numsfalse}, -%\end{verbatim} -% -% \item See issue raised about syntax (and semantics) for -% |\Multiselection|. -% -% \item |f0| keys should perhaps support |\UseTemplate| by replacing -% it with its internal form. or perhaps this is a rubbish idea? -% -% \item Marcin Wolinski suggested to use |\EvalOnUse| instead or in -% addition to |\DelayEvalutation|. -% -% \end{itemize} -% -% \StopEventually{} -% -% \section{Implementation} -% \begin{macrocode} -%<*package> -\ProvidesExplPackage - {\filename}{\filedate}{\fileversion}{\filedescription} -% \end{macrocode} -% -% \begin{macrocode} -\RequirePackage{expl3} -\RequirePackage{ldcsetup,xparse} -% \end{macrocode} -% -% -% Declare a private token register for building parameter lists. -% Having the number saves a few expandafters -% (probably not needed in the end). -% \begin{macrocode} -\toks_new:N\l_TP_KV_assignments_toks -\toks_new:N\l_TP_default_assignments_toks -% \end{macrocode} -% -% -% -% \begin{macro}{\TP_declare_instance:Nnn} -% \begin{macro}{\TP_declare_instance:cnn} -% Declare a command name to be an instance of a template -% ie with a particular setting of the parameters.\\ -% |#1| internal command name for instance to be (globally) declared\\ -% |#2| template type/template name\\ -% |#3| key value assignments for parameters of |#2| -% \begin{macrocode} -\cs_new_nopar:Npn \TP_declare_instance:Nnn #1#2#3 { - \group_begin: - \TP_instdecl_generate_assignments:nn {#2}{#3} - \cs_gset_nopar:Npx #1 { - \tl_if_eq:cNTF { TP>/#2 } \c_TP_doparameterassignments_tl -% \end{macrocode} -% If the body of the template consists only of the token -% |\DoParameterAssignments|, then we insert the list of parameter -% assignments directly. Otherwise we have push them onto the stack -% and prepare to execute the body code (which in turn will pop them -% again when it reaches |\DoParameterAssignments| inside). -% \begin{macrocode} - { \toks_use:N \l_TP_KV_assignments_toks } - { - \exp_not:N \TP_push_assignments:n - {\toks_use:N\l_TP_KV_assignments_toks} - \exp_not:c {TP>/#2} - } - } - \group_end:} -\cs_generate_variant:Nn \TP_declare_instance:Nnn {cnn} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% \begin{macro}{\c_TP_doparameterassignments_tl} -% \begin{macrocode} -\tl_set:Nn \c_TP_doparameterassignments_tl {\DoParameterAssignments} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\UseTemplate} -% |{type}{templatename}{keyval}| -% Directly use a template with a particular parameter setting. -% This is also picked up if used in a nested fashion inside a parameter -% list.\\ -% |#1| type of a template.\\ -% |#2| name of a template.\\ -% |#3| key value assignments for parameters of |#1|. -% \begin{macrocode} -\cs_new_nopar:Npn \UseTemplate #1#2#3{ - \TP_instdecl_generate_assignments:nn {#1/#2}{#3} - \TP_push_assignments: - \use:c { TP>/#1/#2 } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\DoParameterAssignments} -% Access the parameter assignment list that was once stored in -% |\l_TP_KV_assignments_toks| and then moved onto the -% |\g_TP_assignments_stack_toks|. -% \begin{macrocode} -\cs_new_nopar:Npn \DoParameterAssignments{ - \exp_after:wN - \TP_pop_and_execute_assignments:nw - \toks_use:N \g_TP_assignments_stack_toks \q_stop -} -% \end{macrocode} -% -% \end{macro} -% -% \begin{macro}{\TP_pop_and_execute_assignments:nw} -% \begin{macrocode} -\cs_new_nopar:Npn \TP_pop_and_execute_assignments:nw#1#2\q_stop{ - \toks_gset:Nn \g_TP_assignments_stack_toks {#2} - #1} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\g_TP_assignments_stack_toks} -% \begin{macrocode} -\toks_new:N \g_TP_assignments_stack_toks -\toks_gset:Nn \g_TP_assignments_stack_toks {\scan_stop:}% avoid brace loss -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_push_assignments:n} -% \begin{macro}{\TP_push_assignments:} -% Push a list of parameter assignments onto the -% |\g_TP_assignments_stack_toks|. As it all happens in token -% registers |#|s need no doubling. |\TP_push_assignments:| expects -% it to be |\l_TP_KV_assignments_toks| (needs fixing). -% \begin{macrocode} -\cs_new:Npn \TP_push_assignments:n#1{ - \toks_gput_left:Nn\g_TP_assignments_stack_toks{{#1}} -} -\cs_new_nopar:Npn \TP_push_assignments:{ - \toks_gset:No \g_TP_assignments_stack_toks - {\exp_after:wN - {\toks_use:N\exp_after:wN\l_TP_KV_assignments_toks\exp_after:wN} - \toks_use:N\g_TP_assignments_stack_toks} -} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% -% \begin{macro}{\DeclareTemplateType} -% |{type}{nofarg}| -% \begin{macrocode} -\cs_new_nopar:Npn \DeclareTemplateType #1#2{ - \tl_set:cn {TP@<#1>} {{}#2}} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\TP_get_csname_prefix:n} -% |{type}| returns prefix for csnames for template type, -% based on current collection. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_get_csname_prefix:n #1 { - <\exp_after:wN\exp_after:wN\exp_after:wN - \use_i:nn - \cs:w TP@<#1>\cs_end:>#1/ -} -% \end{macrocode} -% -% \end{macro} -% -% \begin{macro}{\TP_get_arg_count:n} -% |{type}| returns arg count for the template type. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_get_arg_count:n #1 { - \exp_after:wN\exp_after:wN\exp_after:wN - \use_ii:nn - \cs:w TP@<#1>\cs_end: -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\DeclareTemplate} -% |{type}{templatename}{nofarg}{keywordspec}{code}| -% \begin{macrocode} -\cs_new:Npn\DeclareTemplate #1#2#3#4#5{ - \cs_if_free:cTF{TP@<#1>} - {\undefinedtype\DeclareTemplateType{#1}#3} - { - \int_compare:nNnF{#3}={\TP_get_arg_count:n{#1}} - { \BadArgCount } - } -% \end{macrocode} -% Parse the key declaration, and execute the list with a suitable -% definition of |\KV@elt|. -% \begin{macrocode} - \cs_set_eq:NN \KV_elt:nn \TP_templdecl_process_KV:nn - \cs_set_nopar:Npn \KV_default_elt:n##1{ - \PackageError{template}{Missing~ =~ after~ ##1}\@ehd} - \cs_set_eq:NN\KV@elt\KV_elt:nn - \cs_set_eq:NN\KV@default@elt\KV_default_elt:n - \tl_set:Nn \l_TP_curr_name_tl {#1/#2} - \toks_clear:N\l_TP_default_assignments_toks -% \end{macrocode} -% At this point there should be a test for which catcode regime we are -% in. We just test if spaces are ignored. -% \begin{macrocode} - %\int_compare:nNnTF{\char_value_catcode:n{`\ }}=\c_nine - %\KV_parse_picky_no_space_removal_no_sanitize:n - %\KV_parse_picky_space_removal_no_sanitize:n - \KV@parse{#4} -% \end{macrocode} -% -% Define the defaults: the setting for |TPD>/\l_TP_curr_name_tl| is a -% tricky since |\l_TP_default_assignments_toks| may contain |#|. We -% have to use an |x| expansion rather than -% |o| since that will hide those during the assignment. -% FIX THIS (see below)! -% \begin{macrocode} - \cs_set_nopar:cpx { TPD>/\l_TP_curr_name_tl } - {\toks_use:N\l_TP_default_assignments_toks} - - \tl_clear:c {TPR>/\l_TP_curr_name_tl} - - \tl_set_eq:cN {TPO>/\l_TP_curr_name_tl}\l_TP_curr_name_tl -% \end{macrocode} -% -% Define the template (using |\cs_new_nopar:Npn| means that one can't -% redefine a template easily). -% \begin{macrocode} - \cs_generate_from_arg_count:cNnn {TP>/\l_TP_curr_name_tl} - \cs_set:Npn {#3}{#5} -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\tl_set:cx} -% FIX this: The code above only works because in the past |\tl_set:cx| was -% defined as follows: -% \begin{macrocode} -\cs_set:Npn \tl_set:cx {\exp_args:Nc \tl_set:Nx} -% \end{macrocode} -% i.e., expanding the second arg at the very end. -% This is no longer the case but for the moment I revert to the old -% definition until the template code is fixed to not rely on |\tl_set:cx| -% expanding the second arg at the very last minute. -% \end{macro} -% -% \begin{macro}{\TP_templdecl_process_KV:nn} -% The list of undefined keys and values is put in the list of the form\\ -% |\KV_elt:nn|\marg{key1}\marg{val1}%^^A -% |\KV_elt:nn|\marg{key2}\marg{val2}\ldots\\ -% So just need to give this macro a suitable definition. We just need -% to look at the first token of the value, to see what sort of key -% it is, so call a helper function to split that off. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_process_KV:nn #1#2 {% - \cs_set_eq:NN \TP_templdecl_add_global_or_nothing: \prg_do_nothing: - \bool_set_false:N\l_TP_global_assignment_bool - \tl_set:Nn\l_TP_currkey_tl{#1} - \TP_templdecl_parse_KV:N#2\q_stop} -% \end{macrocode} -% \end{macro} -% -% -% -% \begin{macro}{\TP_templdecl_parse_KV:N} -% Case switch on the possible key types. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_parse_KV:N #1 { -% \end{macrocode} -% In |#1| we have key, in |#2| the first character after the equal -% sign and in |#3| the remainder of the line. We now have to parse -% that remainder to find out if it contains a default value (in -% brackets) and then set up the key declaration needed to parse -% instance declarations. The method is similar in most cases: we call -% |\TP_parse_optional_key_default:nw| which parses for the default -% and pass it already found key name as first argument, what to do in -% the end as second argument, and the remainder delimited by |\q_stop| -% so that it becomes parseable. -% -% Note that the code in the second argument to -% |\TP_parse_optional_key_default:nw| normally calls on a macro with -% one more argument than actually provided: the reason being that the -% missing argument will be the remainder of the line (added by -% |\TP_parse_optional_key_default:nw| after the default has be -% removed (if present)). -% \begin{macrocode} - \cs_if_free:cTF{TP_use_arg_type_#1:w} - {\PackageError{template}{Unknown~key~type~ (#1)~for~\l_TP_currkey_tl}\@eha} - {\use:c{TP_use_arg_type_#1:w}} -% \end{macrocode} -% The |f| and |i| keys are somewhat different since there we first -% have to parse for an additional argument (a digit in case of |f| -% or an template type name in case of |i|): -% \begin{macrocode} -% \end{macrocode} -% One more alternative: a |+| after the equal sign signals global -% so we change |\TP_templdecl_add_global_or_nothing:| to append a -% |\pref_global:D| to the assignment toks and then reparse the rest. -% \begin{macrocode} -% \cs_set_nopar:Npn \TP_templdecl_add_global_or_nothing: -% {\toks_put_right:Nn \l_TP_KV_assignments_toks {\pref_global:D} } -% \TP_templdecl_parse_KV:nw{#1}#3\TP_templdecl_parse_KV:nnw -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\l_TP_global_assignment_bool} -% For keeping track of the assignments. -% \begin{macrocode} -\bool_new:N \l_TP_global_assignment_bool -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_+:w} -% The |+| does two things: Sets a boolean true to be used by the -% types that can't simply be prefixed with |\pref_global:D| and -% defines |\TP_templdecl_add_global_or_nothing:| to put the prefix -% onto the list. After that we simply call the big switch -% again.\footnote{It should probably all be changed to not rely on -% the prefix working}. -% \begin{macrocode} -\cs_new_nopar:cpn{TP_use_arg_type_+:w} { - \bool_set_true:N\l_TP_global_assignment_bool - \cs_set_nopar:Npn \TP_templdecl_add_global_or_nothing: - {\toks_put_right:Nn \l_TP_KV_assignments_toks {\pref_global:D} } - \TP_templdecl_parse_KV:N -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_l:w} -% The |l| sets a length register. We disable the prefix and insert -% either |\gsetlength| or |\setlength| depending on whether a |+| -% was seen or not. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_l:w { - \TP_parse_optional_key_default:nw - { - \cs_set_eq:NN \TP_templdecl_add_global_or_nothing: \prg_do_nothing: - \bool_if:NTF \l_TP_global_assignment_bool - {\TP_templdecl_setup_register_key:Nn\gsetlength} - {\TP_templdecl_setup_register_key:Nn\setlength} - } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_L:w} -% The |L| sets a fake length register. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_L:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_fakeregister_key:NNn\setlength\l_tmpa_skip} -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_c:w} -% The |c| sets a count register. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_c:w { - \TP_parse_optional_key_default:nw - { - \cs_set_eq:NN\TP_templdecl_add_global_or_nothing:\prg_do_nothing: - \bool_if:NTF \l_TP_global_assignment_bool - {\TP_templdecl_setup_register_key:Nn\GSetInternalCounter} - {\TP_templdecl_setup_register_key:Nn\SetInternalCounter} - } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_C:w} -% The |C| sets a fake count register. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_C:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_fakeregister_key:NNn - \SetInternalCounter\l_tmpa_int} -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_n:w} -% The |n| sets a token list variable. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_n:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_n_key:N} -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_f:w} -% \begin{macro}{\TP_templdecl_parse_f_arg:nw} -% The |f| defines a command with between 0 and 9 arguments. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_f:w #1{ - %\TP_templdecl_parse_f_arg:nw {#1} - \TP_parse_optional_key_default:nw{\TP_templdecl_setup_f_key:Nn{#1}} -} -% \end{macrocode} -% Helper for |\TP_templdecl_parse_KV:nnw|. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_parse_f_arg:nw#1#2{ -% \end{macrocode} -% The third argument of |\TP_templdecl_setup_f_key:Nn|, i.e., the -% macro name, is the remaining data up to |\q_stop| which is picked up -% by |\TP_parse_optional_key_default:nw|. -% \begin{macrocode} - \TP_parse_optional_key_default:nw{\TP_templdecl_setup_f_key:Nn{#1}{#2}} -} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% -% \begin{macro}{\TP_use_arg_type_b:w} -% \begin{macro}{\TP_templdecl_setup_b_key:nn} -% The |b| uses access to the |\if_true:| and |\if_false:| -% primitives. Needed? -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_b:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_b_key:n} -} -% \end{macrocode} -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_b_key:n#1{ - \cs_set_eq:cN { if#1 } \if_true: - \TP_templdecl_define_key:n - { \TP_templdecl_eval_b_key_value:nn {#1}{##1} } -} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_eval_b_key_value:nn} -% Modify so the boolean does not need to have been -% declared with |\newif| -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_eval_b_key_value:nn#1#2{ - \cs_if_free:cTF {if#2} - { \PackageError{template}{Bad~boolean~setting~#1=#2}\@eha } - { \tl_set_eq:cc {if_#1:}{if_#2:} - \toks_put_right:Nf \l_TP_KV_assignments_toks - { \tl_set_eq:cc {if_#1:}{if_#2:} } - } -} -% \end{macrocode} -% -% \end{macro} -% -% \begin{macro}{\TP_use_arg_type_s:w} -% \begin{macro}{\TP_templdecl_setup_s_key:n} -% The |s| chooses between true and false. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_s:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_s_key:n} -} -% \end{macrocode} -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_s_key:n #1 { - \TP_templdecl_define_key:n - { \TP_templdecl_eval_s_key_value:nnn{##1}#1 } -} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% -% -% -% -% -% -% \begin{macro}{\TP_use_arg_type_i:w} -% The |i| expects an instance. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_i:w #1{ - \TP_parse_optional_key_default:nw{\TP_templdecl_setup_i_key:nnn{#1}} -} -% \end{macrocode} -% -% declaration |hd =i{head} \fooo| \\ -% use |hd = mine|\\ -% makes |\fooo| shorthand for |\UseInstance{head}{mine}| -% -% also allowed: |hd = \UseTemplate{head}{...}{...}|\\ -% in case you want to use an unnamed instance of type |head| -% in this place. -% \end{macro} -% -% \begin{macro}{\TP_templdecl_setup_i_key:nnn} -% MH change: do either local or global. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_i_key:nnn#1#2{ - \TP_templdecl_define_key:n - { - \TP_templdecl_eval_i_key_value:Nnn #2 {#1}{##1} - } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_eval_i_key_value:Nnn} -% MH change: Add extra argument for local or global. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_eval_i_key_value:Nnn #1#2#3 { - \tl_if_head_eq_meaning:nNTF {#3.}\UseTemplate - { - \iow_term:x{\token_to_str:N\UseTemplate\space seen} -% \end{macrocode} -% -% Code below from |\TP_templdecl_setup_f_key:Nn| (should be -% combined and cleaned up) -% at this point one should also check if first arg of |\UseTemplate| -% corresponds to |#2| and if not complain (not done) -% -% \begin{macrocode} - {\TP_templdecl_declare_tmp_instance:nnnn #3 } - \toks_put_right:No \l_TP_KV_assignments_toks - { \exp_after:wN \KV@toks \exp_after:wN {\g_tmpa_tl} } - %\TP_templdecl_add_global_or_nothing: - %\toks_put_right:Nn \l_TP_KV_assignments_toks - % { \cs_set_nopar:Npx #1{ \toks_use:N \KV@toks} } - \bool_if:NTF \l_TP_global_assignment_bool - {\toks_put_right:Nn \l_TP_KV_assignments_toks - {\cs_gset_nopar:Npx #1 { \toks_use:N \KV@toks}} - } - {\toks_put_right:Nn \l_TP_KV_assignments_toks - {\cs_set_nopar:Npx #1 { \toks_use:N \KV@toks}} - } - } - { - \TP_let_instance:Nnn#1{#2}{#3} -% \end{macrocode} -% We want the |\cs_set_eq:Nc| hiding in |\TP_let_instance:Nnn| to expand -% fully to two csnames so we put a |\tex_romannumeral:D 0| (which in -% itself expands to nothing) in front. This expands the |\cs_set_eq:Nc| fully -% before finding out that |\cs_set_eq:NwN| is not expandable. -% \begin{macrocode} - \toks_put_right:Nf \l_TP_KV_assignments_toks - { \TP_let_instance:Nnn#1{#2}{#3} } - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% -% -% -% -% -% \begin{macro}{\TP_use_arg_type_x:w} -% \begin{macro}{\TP_templdecl_setup_x_key:nn} -% The |x| runs internal code. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_x:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_x_key:n} -} -% \end{macrocode} -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_x_key:n#1{ - \TP_templdecl_define_key:n - { \toks_put_right:Nn\l_TP_KV_assignments_toks{#1} } -} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% -% -% -% -% \begin{macro}{\TP_use_arg_type_g:w} -% \begin{macro}{\TP_templdecl_setup_g_key:nn} -% The |g| runs any code. -% \begin{macrocode} -\cs_new_nopar:Npn\TP_use_arg_type_g:w { - \TP_parse_optional_key_default:nw - {\TP_templdecl_setup_g_key:n} -} -% \end{macrocode} -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_g_key:n #1 { - \TP_templdecl_define_key:n{#1}} -% \end{macrocode} -% -% \end{macro} -% \end{macro} -% -% -% -% -% \begin{macro}{\TP_templdecl_define_key:n} -% Here we define the key in the current template. Original code from -% r522 is essentially unreadable but we keep it here until the -% internal structure is finally sorted out. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_define_key:n#1{ - \exp_after:wN \cs_set:Npn \cs:w - KV@\l_TP_curr_name_tl @\l_TP_currkey_tl - \exp_after:wN\cs_end: - \exp_after:wN##\exp_after:wN1\exp_after:wN{ - \exp_after:wN\TP_templdecl_remove_from_default_assignments:N - \cs:w KV@\l_TP_curr_name_tl @\l_TP_currkey_tl - \exp_after:wN \cs_end: - \TP_templdecl_add_global_or_nothing: - #1 - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% -% -% -% -% -% -% -% \begin{macro}{\TP_parse_optional_key_default:nw} -% Look for default value. -% \begin{macrocode} -\cs_set:Npn \TP_ignore_leading_space_in_arg_ii:nn#1#2{ - \exp_args:Nf\TP_ignore_leading_space_in_arg_ii_aux:nn - {\exp_not:N #2}{#1} -} -\cs_set:Npn \TP_ignore_leading_space_in_arg_ii_aux:nn#1#2{#2{#1}} - - -\DeclareDocumentCommand\TP_parse_optional_key_default:nw{mo}{ - \IfNoValueTF{#2} - {\TP_templdecl_finish_key_setup:nw{#1}} - {\TP_templdecl_finish_key_setup_with_default:nnw{#1}{#2}} -} -%\show\TP_parse_optional_key_default:nw -%\exp_args:Nc\show{\string\TP_parse_optional_key_default:nw} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_finish_key_setup:nw} -% After having parsed the line and not found any default value it -% remains to actually define the key for the instance parsing by -% executing the setup code (in |#1|) giving it |#2| (i.e., the -% remainder of the line) as an argument. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_finish_key_setup:nw#1#2\q_stop{ - \TP_ignore_leading_space_in_arg_ii:nn{#1}{#2} - %%%#1{#2} -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_finish_key_setup_with_default:nnw} -% If there is a default the situation is more complicated since we -% not only have to set up the key for the instance but also have to -% add the default value to |\l_TP_default_assignments_toks| in an -% appropriate way. -% -% First set up the the key itself: -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_finish_key_setup_with_default:nnw#1#2#3\q_stop{ - \TP_ignore_leading_space_in_arg_ii:nn{#1}{#3} - %%% #1 {#3} -% \end{macrocode} -% Now we run the new key code (which is stored in |\KV@...| hopefully) -% and give it the default found. By doing this in a group and by -% locally emptying |\l_TP_KV_assignments_toks| we will get the -% resulting assignment code into that register. -% -% (We set |\TP_templdecl_remove_from_default_assignments:N| to -% |\use_none:n| since this is a temporary operation and we don't want -% to change the default really.) -% \begin{macrocode} - \group_begin: - \toks_clear:N \l_TP_KV_assignments_toks - \cs_set_eq:NN \TP_templdecl_remove_from_default_assignments:N \use_none:n - \use:c{KV@\l_TP_curr_name_tl @\l_TP_currkey_tl}{#2} -% \end{macrocode} -% And now for a final trick: before closing the group again and losing -% our local changes we run |\exp_after:wN| several times to get the -% value of |\l_TP_KV_assignments_toks| into -% |\l_TP_default_assignments_toks| outside that group! -% \begin{macrocode} - \exp_after:wN - \group_end: - \exp_after:wN - \toks_set:Nn - \exp_after:wN - \l_TP_default_assignments_toks - \exp_after:wN - { \cs:w KV@\l_TP_curr_name_tl @\l_TP_currkey_tl \exp_after:wN \cs_end: - \exp_after:wN - { \toks_use:N \exp_after:wN \l_TP_KV_assignments_toks - \exp_after:wN - } - \toks_use:N\l_TP_default_assignments_toks - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% \begin{macro}{\c_TP_true_tl} -% \begin{macrocode} -\tl_new:Nn \c_TP_true_tl {true} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_eval_s_key_value:nnn} -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_eval_s_key_value:nnn#1#2#3 { -% no error check on this yet. - \tl_set:Nn \l_tmpa_tl {#1} - \tl_if_eq:NNTF \l_tmpa_tl \c_TP_true_tl - { \toks_put_right:Nn \l_TP_KV_assignments_toks {#2} } - { \toks_put_right:Nn \l_TP_KV_assignments_toks {#3} } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_setup_register_key:Nnn} -% This is normally called automatically by |\DeclareTemplate|. -% -% Command for setting a template attribute whose name -% corresponds directly to a \TeX{} count or length register\\ -% |#1| the function to set the value eg \cs{setlength}.\\ -% |#2| key name.\\ -% |#3| the register to set. -% -% This command \emph{fully evaluates} the argument at declare time, -% and assigns the value to the register. It also passes an assignment -% of the register to the final value into the parameter list for the -% template. -% -% If the value is a call to |\DelayEvaluation|, don't evaluate it now, -% just pass the whole assignment to the template. Remember to remove -% the |\DelayEvaluation|. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_register_key:Nn #1#2{ - \TP_templdecl_define_key:n{ - \tl_if_head_eq_meaning:nNTF{##1}\DelayEvaluation - { -% \end{macrocode} -% Old line commented out. Remove |\DelayEvaluation| and also remove -% the braces surrounding its argument. -% \begin{macrocode} - \toks_put_right:Nn \l_TP_KV_assignments_toks {#1#2{##1}} - %\toks_set:No\l_tmpa_toks{\use_ii:nn ##1} - %\toks_put_right:Nx \l_TP_KV_assignments_toks - % {\exp_not:n{#1#2}{\toks_use:N \l_tmpa_toks}} - } -% \end{macrocode} -% -% -% check for |\MultiSelection| creeping up and if so add something like -% -% \begin{verbatim} -% \setlength\register{\ifcase\selector \or value1 \or value2 -% ... \else valueotherwise \fi} -% \end{verbatim} -% to |\l_TP_KV_assignments_toks|. -% -% \begin{macrocode} - { - \tl_if_head_eq_meaning:nNTF{##1..}\MultiSelection - { - \group_begin: - \TP_multiselection_add:nnnnnn #1#2##1 - \group_end: -% \end{macrocode} -% -% -% there are probably better ways to do this (:-) -% -% \begin{macrocode} - \tl_if_in:onTF{\toks_use:N\g_TP_multiselection_toks}\DelayEvaluation - { - \toks_put_right:No\l_TP_KV_assignments_toks - { - \exp_after:wN#1\exp_after:wN#2\exp_after:wN - {\toks_use:N\g_TP_multiselection_toks} - } - } - { - \toks_put_right:No\l_TP_KV_assignments_toks - { - \exp_after:wN #2 - \exp_after:wN= \toks_use:N\g_TP_multiselection_toks\scan_stop: - } - } -% \end{macrocode} -% -% -% otherwise do as before -% -% \begin{macrocode} - } - { - #1#2{##1} - \toks_put_right:No\l_TP_KV_assignments_toks { - \exp_after:wN #2 \exp_after:wN = \tex_the:D #2\scan_stop: - } - } - } - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% -% -% -% \begin{macro}{\DelayEvaluation} -% \begin{macro}{\MultiSelection} -% Since we are testing explicitly for |\DelayEvaluation| and -% |\MultiSelection| a few places we better give them unique -% meanings! -% \begin{macrocode} -\cs_new_nopar:Npn\DelayEvaluation #1{\use_none:n{\DelayEvaluation}#1} -\cs_new_nopar:Npn\MultiSelection #1{\use_none:n{\MultiSelection}#1} -% \end{macrocode} -% \end{macro} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_remove_from_default_assignments:N} -% Note: the toks register is more or less a plists and should -% perhaps be implemented as such as this would make far more -% readable code. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_remove_from_default_assignments:N#1{ - \cs_set_nopar:Npn \TP_tmp:w ##1#1##2##3#1##4\q_stop{ - \l_TP_default_assignments_toks{##1##3} - } - \exp_after:wN \TP_tmp:w - \toks_use:N\l_TP_default_assignments_toks #1\scan_stop:#1\q_stop} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_setup_f_key:Nn} -% Same for macro names. Again usually called automatically when -% declaring a new template.\\ -% |#1| Determines how many arguments the function should have.\\ -% |#2| The macro to be defined. -% -% If the `|##1|`, the value passed as the argument of the key -% to the macro |#2| is invoked starts with |\FunctionInstance|, then a -% special procedure is taken. Instead of defining a macro with the -% specified number of arguments, the paramater list of the nested -% function instance is parsed, and |#2| is defined to be a macro -% expanding to that instance. In this case the specified template -% is responsible for picking up the requested number of -% arguments. (This is \emph{not} checked.) -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_f_key:Nn#1#2{ -% \end{macrocode} -% -% |##1| can either be arbitrary inline code, in which case it will be -% defined with something similar to |\newcommand[val]| so it needs to -% use |#1| -- |#val|. -% -% define it locally here (why this, David???) -% \begin{macrocode} - \TP_templdecl_define_key:n - { \TP_templdecl_define_function:NNn#1#2{##1} } -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\TP_templdecl_define_function:NNn} -% Use number of arguments to define function. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_define_function:NNn#1#2#3{ - \cs_generate_from_arg_count:NNnn #2 \cs_set:Npn {#1}{#3} - \toks_put_right:Nf \l_TP_KV_assignments_toks { - \cs_generate_from_arg_count:NNnn #2 \cs_set:Npn {#1}{#3} - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% \begin{macro}{\TP_templdecl_setup_n_key:N} -% Here is the extended version that tries to deal with -% |\MultiSelection|. -% -% In case of `n' keys there is no evaluation at declaration time so it -% is not sensible to look for |\DelayEvaluation|. For this reason as -% well as for the fact that |\TP_multiselection_add:nnnnnn| above -% assumes that it deals -% with registers that can be accessed via |\toks_use:N| we have to use a -% different command to handle the |\MultiSelection| args but -% it is essentially doing the same. -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_n_key:N#1{ - \TP_templdecl_define_key:n{ - \tl_if_head_eq_meaning:nNTF{##1..}\MultiSelection - { - \group_begin: - \TP_templdecl_multiselection:nnnn ##1 - \group_end: -% \end{macrocode} -% Extracting the correct item from the |\if_case:w| we are building -% requires a bit of care. Firstly we want to expand the appropirate -% number of times to get to the item but we also want to ensure we do -% not have any unwanted leftover |\fi:|s or other junk which is bound -% to cause errors later on. Therefore we start an |f| expansion (so we -% don't have to count |\exp_after:wN|s and then stop it again when we -% want to. -% \begin{macrocode} - \toks_put_right:Nx\l_TP_KV_assignments_toks { - \exp_not:n{\tl_set:Nf #1} { \toks_use:N \g_TP_multiselection_toks} - } - } - { - \cs_set_nopar:Npn #1{##1} % setting it? - \toks_put_right:Nn \l_TP_KV_assignments_toks - { \tl_set:Nn #1{##1} } - } - } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_multiselection:nnnn} -% Start the |\if_case:w|. When the item is retrieved using an |f| -% type expansion we better stop it at the right place once we have -% emerged on the other side of the conditional. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_multiselection:nnnn #1#2#3#4{ - \toks_gset:Nn \g_TP_multiselection_toks {\if_case:w #2} - \clist_map_inline:nn {#3}{ - \TP_multiselection_add_or_case:n {\exp_stop_f:##1} - } - \toks_gput_right:Nn\g_TP_multiselection_toks { - \else: \use_i_after_fi:nw { \exp_stop_f: #4} \fi: - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% -% -% -% -% -% \begin{macro}{\DeclareInstance} -% |{type}{instname}{templatename}{keyval}| -% \begin{macrocode} -\cs_new_nopar:Npn \DeclareInstance { \DeclareCollectionInstance{} } -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\DeclareCollectionInstance} -% |{collection}{type}{instname}{templatename}{keyval}| -% The fifth argument is picked up implicitly. -% \begin{macrocode} -\cs_new:Npn \DeclareCollectionInstance#1#2#3#4{ - \TP_declare_instance:cnn { <#1>#2/#3 }{ #2/#4 } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\UseCollection} -% |{type}{collection}| -% \begin{macrocode} -\cs_new_nopar:Npn \UseCollection#1#2{ - \tl_set:cx { TP@<#1> } - { {#2} \TP_get_arg_count:n{#1} } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_let_instance:Nnn} -% |\internalcommand{type}{instname}| -% -% The way this macro is used, it must result in |\cs_set_eq:NwN| || -% || after exactly two expansions as it is used this way -% in |\TP_templdecl_eval_i_key_value:nnn|! -% \begin{macrocode} -\cs_new_nopar:Npn \TP_let_instance:Nnn#1#2#3{ - \cs_set_eq:Nc #1 - { - \cs_if_free:cTF { \TP_get_csname_prefix:n{#2} #3 } - { <>#2/ } - { \TP_get_csname_prefix:n{#2} } - #3 - } -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\UseInstance} -% |{type}{instname}| -% \begin{macrocode} -\cs_new_nopar:Npn \UseInstance#1#2{ - \TP_let_instance:Nnn \l_tmpa_tl {#1}{#2} - \tl_if_eq:NNTF \l_tmpa_tl \scan_stop: - \INSTANCEundefined - \l_tmpa_tl -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_declare_tmp_instance:nnnn} -% This macro is called when we have seen a |\UseTemplate| -% declaration as part of an |i| key value. Therefore the -% first argument will be dropped (it contains the token -% |\UseTemplate|) the second and third will be combined to refer to -% the template and the fourth argument will be implictly picked up -% by |\TP_declare_instance:Nnn|. -% \begin{macrocode} -\cs_new:Npn \TP_templdecl_declare_tmp_instance:nnnn#1#2#3{% - \TP_declare_instance:Nnn \g_tmpa_tl {#2/#3} } -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\ShowTemplate} -% Some extension to |\ShowTemplate| so that we also get to see the -% restrictions if any -% \begin{macrocode} -\cs_new_nopar:Npn \ShowTemplate#1#2{ - \iow_term:x{*******~ Template:~ #1/#2~ *******} - \iow_term:x{*} - \iow_term:x{*~ Defaults:} - \iow_term:x{*} - \iow_term:x{\token_to_str:N\TPD>/#1/#2= - \cs_meaning:c{TPD>/#1/#2}} - \iow_term:x{*} - \iow_term:x{*~ Restrictions:} - \iow_term:x{*} - \iow_term:x{\token_to_str:N\TPR>/#1/#2= - \cs_meaning:c{TPR>/#1/#2}} - \iow_term:x{*} - \iow_term:x{*~ Body:} - \iow_term:x{*} - \cs_show:c {TP>/#1/#2}} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\ShowCollectionInstance} -% \begin{macrocode} -\cs_new_nopar:Npn \ShowCollectionInstance#1#2#3{ - \iow_term:x{*******~ Instance:~ <#1>#2/#3~ *******} - \iow_term:x{*} - \cs_show:c {<#1>#2/#3}} -\cs_new_nopar:Npn \ShowInstance{\ShowCollectionInstance{}} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_templdecl_setup_fakeregister_key:NNn} -% |{setcomand}{privateregister}{key}{internalcode}| -% \begin{macrocode} -\cs_new_nopar:Npn \TP_templdecl_setup_fakeregister_key:NNn#1#2#3{ - \TP_templdecl_define_key:n{ - \tl_if_head_eq_meaning:nNTF{##1..}\DelayEvaluation - { -% \end{macrocode} -% In the v0.08 version of \texttt{template.dtx} a -% |\DelayEvaluation| for a faked register would simply be equiv to -% a |\cs_set_nopar:Npn | (code is below commented out). The negative side effect -% of this is that something like |=L| used with |\DelayEvaluation| -% would not allow for calc syntax since it would end up as -% |\cs_set_nopar:Npn |\allowbreak|\foo|\allowbreak|{a+b}|. The code below changes -% this to first assign to a scratch register (at runtime) and then -% do an |\edef|. Could be coded differently to save space (at cost -% of time) -% \begin{macrocode} -% \toks_put_right:Nn \l_TP_KV_assignments_toks {\cs_set_nopar:Npn #3{##1}} -% \toks_put_right:Nn \l_TP_KV_assignments_toks -% {#1#2{##1}\cs_set_nopar:Npx #3{\toks_use:N#2}} - \toks_set:No \l_tmpa_toks {\use_ii:nn ##1} - \toks_put_right:Nx \l_TP_KV_assignments_toks { - \exp_not:n{#1#2}{\toks_use:N \l_tmpa_toks} - \exp_not:n{ \cs_set_nopar:Npx #3{\toks_use:N#2} } - - } - } -% \end{macrocode} -% -% -% Otherwise same game for fake registers except that instead of -% passing the register to |\TP_multiselection_add:nnnnnn| we pass a -% temp fake one and -% doing a def instead of using |\setlength| or |\setcounter| -% -% and i haven't done the |\DelayEvaluation| bit for that case! as -% i'm not sure what the best approach is for those -% things\footnote{we might disallow it for that case in general --- -% not a nice rule but an explainable one} -% -% \begin{macrocode} - { - \tl_if_head_eq_meaning:nNTF{##1..}\MultiSelection - { - \group_begin: - \TP_multiselection_add:nnnnnn#1#2##1 - \group_end: - \toks_put_right:Nx\l_TP_KV_assignments_toks - {\exp_not:n{\cs_set_nopar:Npn #3} {\toks_use:N\g_TP_multiselection_toks}} - } - { - #1#2{##1} - \toks_put_right:Nx\l_TP_KV_assignments_toks - {\exp_not:n{\cs_set_nopar:Npn#3} {\toks_use:N#2}} - } - } - } -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\g_TP_multiselection_toks} -% \begin{macrocode} -\toks_new:N \g_TP_multiselection_toks -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\TP_multiselection_add:nnnnnn} -% \marg{operation} \marg{register} |\MultiSelection| -% \marg{selector} \marg{case-list} \marg{else-case} -% -% This command builds up the |\if_case:w| code from the three -% arguments of |\MultiSelection| and stores it in -% |\g_TP_multiselection_toks|. This code is supposed to be run in a -% group so a) we don't have to initialise |\g_TP_multiselection_toks| -% and b) all changes to the used registers not affecting the -% outside. -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_multiselection_add:nnnnnn #1#2#3#4#5#6{ - \toks_gset:Nn \g_TP_multiselection_toks {\if_case:w #4} - \clist_map_inline:nn {#5}{ - \tl_if_head_eq_meaning:nNTF{##1..}\DelayEvaluation - { - \TP_multiselection_add_or_case:n {##1} - } - { - #1#2{##1} - \TP_multiselection_add_or_case:o { \toks_use:N #2 } - } - } - \toks_gput_right:Nn \g_TP_multiselection_toks { - \else: \use_i_after_fi:nw{#6}\fi: - } -} -% \end{macrocode} -% -% \end{macro} -% -% \begin{macro}{\TP_multiselection_add_or_case:o} -% No need to worry about where |\or:| is allowed to be added since -% all loops in \LaTeX3 process the item outside conditionals. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_multiselection_add_or_case:n #1 { - \toks_gput_right:Nn \g_TP_multiselection_toks { - \or: \use_i_after_orelse:nw{#1} - } -} -\cs_generate_variant:Nn \TP_multiselection_add_or_case:n {o} -% \end{macrocode} -% \end{macro} -% -% Since i like to set things like |item-label-text| using this -% mechanism i need to handle the `n' key specially. -% -% Actually i could have probably extended -% |\TP_templdecl_setup_f_key:nnN| thus making -% this generally available to all f\meta{number} keys but was too lazy -% (or too stupid) to get it right first time so settled for the simple -% solution. -% -% So |\TP_templdecl_parse_KV:nnw| now calls -% |\TP_templdecl_setup_n_key:nN| for the `n' key. looks like -% this thus be fixed some time soon -% -% -% -% -% -% -% -% \begin{macro}{\IfExistsInstanceTF} -% tests that there is a \emph{default} definition -% taken from xinitials.dtx: -% \begin{macrocode} -\cs_new_nopar:Npn \IfExistsInstanceTF#1#2{ - \cs_if_exist:cTF{<>#1/#2} -} -% \end{macrocode} -% -% FMi: what happens if we are in collection FOO and there exists an -% instance I for type T within this collection but there doesn't exist -% an instance in the empty collection? -% -% What would happen if \ldots\ --- not clear to me what the sematics -% really should be. The code below is not better only different( and -% slower).\footnote{fix semantics} -% \begin{macrocode} -\cs_set_nopar:Npn \IfExistsInstanceTF#1#2{ - \TP_let_instance:Nnn \l_tmpa_tl {#1}{#2} -% next is not \tl_if_eq:NNTF but ...FT so done manually - \if_meaning:w\l_tmpa_tl\scan_stop: - \exp_after:wN\use_ii:nn - \else: - \exp_after:wN\use_i:nn - \fi:} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\DeclareRestrictedTemplate} -% Setting it up: -% -%| \DeclareRestrictedTemplate|\\ -% |{T-type} {new-T-name} {source-T-name} {keyvals}| -% -% This uses the same code as {T-type} {source-T-name} but adds -% settings from {keyvals} -% \begin{macrocode} -\cs_new_nopar:Npn \DeclareRestrictedTemplate#1#2#3#4{ - % CCC do we need a group here?? - \tl_set_eq:cc { TPD>/#1/#2 } { TPD>/#1/#3 } - \tl_set_eq:cc { TP>/#1/#2 } { TP>/#1/#3 } - \toks_set:Nv \l_TP_KV_assignments_toks { TPR>/ #1 / #3 } -% adds stuff to \l_TP_KV_assignments_toks - \setkeys {\cs:w TPO>/#1/#3\cs_end:}{#4} - - \tl_set:cx { TPR>/#1/#2 } - { \toks_use:N \l_TP_KV_assignments_toks } - \cs_if_free:cTF { TPO>/#1/#3 } - { \tl_set:cn {TPO>/#1/#2}{#1/#3} } - { \tl_set_eq:cc {TPO>/#1/#2}{TPO>/#1/#3} } -} -% \end{macrocode} -% \end{macro} -% -% -% Internals: -% -% \begin{macro}{\TP_instdecl_generate_assignments:nn} -% These could probably be inlined, even when they do something! -% -% Assumption: setkeys fully expands its first argument. -% -% \begin{macrocode} -\cs_new_nopar:Npn \TP_instdecl_generate_assignments:nn#1#2 { - % Returns to \l_TP_KV_assignments_toks - % the restrictions - % stored in the TP-structure (at present - % in YAM) of the template #1 - \exp_args:NNo \toks_set:No \l_TP_default_assignments_toks - {\cs:w TPD>/#1\cs_end:\scan_stop:\scan_stop:} - \toks_set:Nv \l_TP_KV_assignments_toks { TPR>/ #1 } - \setkeys { \cs:w TPO>/#1 \cs_end: } - { #2 } % adds stuff to \l_TP_KV_assignments_toks - -% prepends stuff to \l_TP_KV_assignments_toks : - \exp_after:wN\TP_instdecl_add_default_recurse:nn - \toks_use:N\l_TP_default_assignments_toks - -} -% \end{macrocode} -% \end{macro} -% -% -% \begin{macro}{\TP_instdecl_add_default_recurse:nn} -% [ 2001/06/10 Think about doing this properly with explicit plists! --- but -% this means that one has to think about whether or not plists should be -% implemented as token registers and not as tl vars as they are now. ] -% \begin{macrocode} -\cs_new_nopar:Npn \TP_instdecl_add_default_recurse:nn#1#2{ - \token_if_eq_meaning:NNF #1\scan_stop: - { - \l_tmpa_toks{#2} - \tl_set:Nx \l_tmpa_tl { - {\toks_use:N \l_tmpa_toks \toks_use:N \l_TP_KV_assignments_toks} - } - \l_TP_KV_assignments_toks \l_tmpa_tl - \TP_instdecl_add_default_recurse:nn - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% |TPD>/type/name| stores the default parameter assignments. -% -% |TPR>/type/name| stores the parameter assignments that have been -% made for a restricted template otherwise it is undefined (or |\scan_stop:|). -% -% -% |TPO>/type/name| stores the full name (i.e. as |type/name|) -% of the template a restricted -% template is coming from originally. -% -% -% -% -% \begin{macro}{\TP_split_finite_skip_value:nnNN} -% This macro is for use in error checking template values like -% "text-float-sep" that can't contain infinite glue and needs the -% shrink and/or stretch components. First argument is the skip -% register (which is likely to be user input), second is a template -% key name, and the last two are the \meta{dimen} registers that -% stores the stretch and shrink components. Assignments are global. -% \begin{macrocode} -\cs_new_nopar:Npn \TP_split_finite_skip_value:nnNN #1#2{ - \skip_split_finite_else_action:nnNN {#1} { - \PackageError{template}{Value~ for~ key~ #2~ contains~ `fil(ll)'} - {Only~ finite~ minus~ or~ plus~ parts~ are~ allowed~ for~ this~ key.} - } -} -% \end{macrocode} -% \end{macro} -% -% -% -% -% \begin{macrocode} -% -% \end{macrocode} -% -% \Finale -% diff --git a/Master/texmf-dist/source/latex/xpackages/xbase/xbase.ins b/Master/texmf-dist/source/latex/xpackages/xbase/xbase.ins deleted file mode 100644 index aef2755ba99..00000000000 --- a/Master/texmf-dist/source/latex/xpackages/xbase/xbase.ins +++ /dev/null @@ -1,74 +0,0 @@ -% \iffalse -%% -%% This file will generate fast loadable files and documentation -%% driver files from the dtx files in this package when run through -%% LaTeX or TeX. -%% -%% (C) Copyright 2000-2009 LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3c of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -%% $Id: xbase.ins 1650 2009-10-30 22:34:24Z joseph $ -%% -% \fi -% - -\input docstrip -\keepsilent -\askforoverwritefalse - -\preamble - -(C) Copyright The LaTeX3 Project and any individual authors -listed elsewhere in this file. - -This is a generated file. - -This file was generated from file(s) of the xbase bundle. ---------------------------------------------------------- - -This file may only be distributed together with a copy of this bundle. -You may however distribute the bundle without such generated files. - -====================================================================== - -\endpreamble - - -\generate{% - \file{ldcsetup.sty}{\from{ldcsetup.dtx}{package}} - \file{template.sty}{\from{template.dtx}{package,trace}} - \file{xtemplate.sty}{\from{xtemplate.dtx}{package}} - \file{xparse.sty}{\from{xparse.dtx}{package}} -} - -\endbatchfile diff --git a/Master/texmf-dist/source/latex/xpackages/xbase/xparse.dtx b/Master/texmf-dist/source/latex/xpackages/xbase/xparse.dtx deleted file mode 100644 index 1a90d4891f4..00000000000 --- a/Master/texmf-dist/source/latex/xpackages/xbase/xparse.dtx +++ /dev/null @@ -1,2985 +0,0 @@ -% \iffalse -%% File: xparse.dtx (C) Copyright 1999 Frank Mittelbach, Chris Rowley, -%% David Carlisle -%% (C) Copyright 2004-2008 Frank Mittelbach, -%% LaTeX3 Project -%% (C) Copyright 2009-2010 LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3c of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%% -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -% -%<*driver|package> -\RequirePackage{l3names} -% -%\fi -\GetIdInfo$Id: xparse.dtx 2219 2011-04-08 21:07:45Z joseph $ - {Generic document command parser} -%\iffalse -%<*driver> -%\fi -\ProvidesFile{\filename.\filenameext} - [\filedate\space v\fileversion\space\filedescription] -%\iffalse -\documentclass{l3doc} -\usepackage{amstext} -\begin{document} - \DocInput{xparse.dtx} -\end{document} -% -% \fi -% -% \title{The \textsf{xparse} package\thanks{This file -% has version number \fileversion, last -% revised \filedate.}\\ -% Generic document command parser} -% \author{\Team} -% \date{\filedate} -% \maketitle -% -%\begin{documentation} -% -%\section{Creating document commands} -% -% The \pkg{xparse} package provides a high-level interface for -% producing document-level commands. In that way, it is intended as -% a replacement for the \LaTeXe\ \cs{newcommand} macro. However, -% \pkg{xparse} works so that the interface to a function (optional -% arguments, stars and mandatory arguments, for example) is separate -% from the internal implementation. \pkg{xparse} provides a normalised -% input for the internal form of a function, independent of the -% document-level argument arrangement. -% -% At present, the functions in \pkg{xparse} which are regarded as -% `stable' are: -%\begin{itemize} -% \item \cs{DeclareDocumentCommand} -% \item \cs{NewDocumentCommand} -% \item \cs{RenewDocumentCommand} -% \item \cs{ProvideDocumentCommand} -% \item \cs{DeclareDocumentEnvironment} -% \item \cs{NewDocumentEnvironment} -% \item \cs{RenewDocumentEnvironment} -% \item \cs{ProvideDocumentEnvironment} -% \item \cs{IfNoValue(TF)} (the need for \cs{IfValue(TF)} is currently -% an item of active discussion) -% \item \cs{IfBoolean(TF)} -%\end{itemize} -% with the other functions currently regarded as `experimental'. Please -% try all of the commands provided here, but be aware that the -% experimental ones may change or disappear. -% -%\subsection{Specifying arguments} -% -% Before introducing the functions used to create document commands, -% the method for specifying arguments with \pkg{xparse} will be -% illustrated. In order to allow each argument to be defined -% independently, \pkg{xparse} does not simply need to know the -% number of arguments for a function, but also the nature of each -% one. This is done by constructing an \emph{argument specification}, -% which defines the number of arguments, the type of each argument -% and any additional information needed for \pkg{xparse} to read the -% user input and properly pass it through to internal functions. -% -% The basic form of the argument specifier is a list of letters, where -% each letter defines a type of argument. As will be described below, -% some of the types need additional information, such as default values. -% The argument types can be divided into two, those which define -% arguments that are mandatory (potentially raising an error if not -% found) and those which define optional arguments. The mandatory types -% are: -%\begin{itemize}[font=\ttfamily] -% \item[m] A standard mandatory argument, which can either be a single -% token alone or multiple tokens surrounded by curly braces. -% Regardless of the input, the argument will be passed to the -% internal code surrounded by a brace pair. This is the \pkg{xparse} -% type specifier for a normal \TeX\ argument. -% \item[l] An argument which reads everything up to the first -% open group token: in standard \LaTeX\ this is a left brace. -% \item[u] Reads an argument `until' \meta{tokens} are encountered, -% where the desired \meta{tokens} are given as an argument to the -% specifier: \texttt{u}\marg{tokens}. -%\end{itemize} -% The types which define optional arguments are: -%\begin{itemize}[font=\ttfamily] -% \item[o] A standard \LaTeX\ optional argument, surrounded with square -% brackets, which will supply -% the special \cs{NoValue} token if not given (as described later). -% \item[d] An optional argument which is delimited by \meta{token1} -% and \meta{token2}, which are given as arguments: -% \texttt{d}\meta{token1}\meta{token2}. As with \texttt{o}, if no -% value is given the special token \cs{NoValue} is returned. -% \item[O] As for \texttt{o}, but returns \meta{default} if no -% value is given. Should be given as \texttt{O}\marg{default}. -% \item[D] As for \texttt{d}, but returns \meta{default} if no -% value is given: \texttt{D}\meta{token1}\meta{token2}\marg{default}. -% Internally, the \texttt{o}, \texttt{d} and \texttt{O} types are -% short-cuts to an appropriated-constructed \texttt{D} type argument. -% \item[s] An optional star, which will result in a value -% \cs{BooleanTrue} if a star is present and \cs{BooleanFalse} -% otherwise (as described later). -% \item[t] An optional \meta{token}, which will result in a value -% \cs{BooleanTrue} if \meta{token} is present and \cs{BooleanFalse} -% otherwise. Given as \texttt{t}\meta{token}. -% \item[g] An optional argument given inside a pair of \TeX\ group -% tokens (in standard \LaTeX, |{| \ldots |}|), which returns -% \cs{NoValue} if not present. -% \item[G] As for \texttt{g} but returns \meta{default} if no value -% is given: \texttt{G}\marg{default}. -%\end{itemize} -% -% Using these specifiers, it is possible to create complex input syntax -% very easily. For example, given the argument definition -% `|s o o m O{default}|', the input `|*[Foo]{Bar}|' would be parsed as: -%\begin{itemize}[nolistsep] -% \item |#1| = |\BooleanTrue| -% \item |#2| = |{Foo}| -% \item |#3| = |\NoValue| -% \item |#4| = |{Bar}| -% \item |#5| = |{default}| -%\end{itemize} -% whereas `|[One][Two]{}[Three]|' would be parsed as: -%\begin{itemize}[nolistsep] -% \item |#1| = |\BooleanFalse| -% \item |#2| = |{One}| -% \item |#3| = |{Two}| -% \item |#4| = |{}| -% \item |#5| = |{Three}| -%\end{itemize} -% Note that after parsing the input there will be always exactly the -% same number of \meta{balanced text} arguments as the number of letters -% in the argument specifier. The \cs{BooleanTrue} and \cs{BooleanFalse} -% tokens are passed without braces; all other arguments are passed as -% brace groups. -% -% Two more tokens have a special meaning when creating an argument -% specifier. First, \texttt{+} is used to make an argument long (to -% accept paragraph tokens). In contrast to \LaTeXe's \cs{newcommand}, -% this applies on an argument-by-argument basis. So modifying the -% example to `|s o o +m O{default}|' means that the mandatory argument -% is now \cs{long}, whereas the optional arguments are not. -% -% Secondly, the token \texttt{>} is used to declare so-called -% `argument processors', which can be used to modify the contents of an -% argument before it is passed to the macro definition. The use of -% argument processors is a somewhat advanced topic, (or at least a less -% commonly used feature) and is covered in Section~\ref{sec:processors}. -% -%\subsection{Spacing and optional arguments} -% -% TeX will find the first argument after a function name irrespective -% of any intervening spaces. This is true for both mandatory and -% optional arguments. So "\foo[arg]" and \verb*"\foo [arg]" are -% equivalent. Spaces are also ignored when collecting arguments up -% to the last mandatory argument to be collected (as it must exist). -% So after -%\begin{verbatim} -% \DeclareDocumentCommand \foo { m o m } { ... } -%\end{verbatim} -% the user input "\foo{arg1}[arg2]{arg3}" and -% \verb*"\foo{arg1} [arg2] {arg3}" will both be parsed in the same -% way. However, spaces are \emph{not} ignored when parsing optional -% arguments after the last mandatory argument. Thus with -%\begin{verbatim} -% \DeclareDocumentCommand \foo { m o } { ... } -%\end{verbatim} -% "\foo{arg1}[arg2]" will find an optional argument but -% \verb*"\foo{arg1} [arg2]" will not. This is so that trailing optional -% arguments are not picked up `by accident' in input. -% -%\subsection{Declaring commands and environments} -% -% With the concept of an argument specifier defined, it is now -% possible to describe the methods available for creating both -% functions and environments using \pkg{xparse}. -% -% The interface-building commands are the preferred method for -% creating document-level functions in \LaTeX3. All of the functions -% generated in this way are naturally robust (using the \eTeX\ -% \cs{protected} mechanism). -% -%\begin{function}{ -% \DeclareDocumentCommand| -% \NewDocumentCommand| -% \RenewDocumentCommand| -% \ProvideDocumentCommand -%} -% \begin{syntax} -% "\DeclareDocumentCommand" \Arg{arg spec} \Arg{code} -% \end{syntax} -% This family of commands are used to create a document-level -% . The argument specification for the function is -% given by , and the function will execute . -% -% As an example: -% \begin{verbatim} -% \DeclareDocumentCommand \chapter { s o m } { -% \IfBooleanTF {#1} { -% \typesetnormalchapter {#2} {#3} -% }{ -% \typesetstarchapter {#3} -% } -% } -% \end{verbatim} -% would be a way to define a \cs{chapter} command which would -% essentially behave like the current \LaTeXe\ command (except that it -% would accept an optional argument even when a \texttt{*} was parsed). -% The \cs{typesetnormalchapter} could test its first argument for being -% \cs{NoValue} to see if an optional argument was present. -% -% The difference between the \cs{Declare\ldots}, \cs{New\ldots} -% \cs{Renew\ldots} and \cs{Provide\ldots} versions is the behaviour -% if is already defined. -% \begin{itemize} -% \item \cs{DeclareDocumentCommand} will always create the new -% definition, irrespective of any existing with the -% same name. -% \item \cs{NewDocumentCommand} will issue an error if -% has already been defined. -% \item \cs{RenewDocumentCommand} will issue an error if -% has not previously been defined. -% \item \cs{ProvideDocumentCommand} creates a new definition for -% only if one has not already been given. -% \end{itemize} -% -% \begin{texnote} -% Unlike \LaTeXe's \cs{newcommand} and relatives, the -% \cs{DeclareDocumentCommand} function do not prevent creation of -% functions with names starting \cs{end\ldots}. -% \end{texnote} -%\end{function} -% -%\begin{function}{% -% \DeclareDocumentEnvironment| -% \NewDocumentEnvironment| -% \RenewDocumentEnvironment| -% \ProvideDocumentEnvironment -%} -% \begin{syntax} -% "\DeclareDocumentEnvironment" \Arg{environment} \Arg{arg spec} -% ~~~~\Arg{start code} \Arg{end code} -% \end{syntax} -% These commands work in the same way as \cs{DeclareDocumentCommand}, -% etc., but create environments (\cs{begin}|{||}| \ldots -% \cs{end}|{||}|). Both the and -% may access the arguments as defined by . -% -% \begin{texnote} -% When loaded as part of a \LaTeX3 format, these, these commands do -% not create a pair of macros \cs{} and -% \cs{end}. Thus \LaTeX3 environments have to be -% accessed using the \cs{begin} \ldots \cs{end} mechanism. When -% \pkg{xparse} is loaded as a \LaTeXe\ package, \cs{} -% and \cs{end} are defined, as this is necessary to -% allow the new environment to work! -% \end{texnote} -%\end{function} -% -%\subsection{Testing special values} -% -% Optional arguments created using \pkg{xparse} make use of dedicated -% variables to return information about the nature of the argument -% received. -% -%\begin{variable}{\NoValue} -% \cs{NoValue} is a special marker returned by \pkg{xparse} if no -% value is given for an optional argument. If typeset (which should -% not happen), it will print the value \texttt{-NoValue-}. -%\end{variable} -% -%\begin{function}{\IfNoValue / (TF) (EXP)} -% \begin{syntax} -% "\IfNoValueTF" \Arg{argument} \Arg{true code} \Arg{false code} -% \end{syntax} -% The \cs{IfNoValue} tests are used to check if (|#1|, -% |#2|, etc.) is the special \cs{NoValue} token. For example -% \begin{verbatim} -% \DeclareDocumentCommand \foo { o m } { -% \IfNoValueTF {#1} { -% \DoSomethingJustWithMandatoryArgument {#2} -% }{ -% \DoSomethingWithBothArguments {#1} {#2} -% } -% } -% \end{verbatim} -% will use a different internal function if the optional argument -% is given than if it is not present. -% -% As the \cs{IfNoValue(TF)} tests are expandable, it is possible to -% test these values later, for example at the point of typesetting or -% in an expansion context. -%\end{function} -% -%\begin{function}{\IfValue / (TF) (EXP)} -% \begin{syntax} -% "\IfValueTF" \Arg{argument} \Arg{true code} \Arg{false code} -% \end{syntax} -% The reverse form of the \cs{IfNoValue(TF)} tests are also available -% as \cs{IfValue(TF)}. The context will determine which logical -% form makes the most sense for a given code scenario. -%\end{function} -% -%\begin{variable}{ -% \BooleanFalse| -% \BooleanTrue -%} -% The \texttt{true} and \texttt{false} flags set when searching for -% an optional token (using \texttt{s} or \texttt{t}) have -% names which are accessible outside of code blocks. -%\end{variable} -% -%\begin{function}{\IfBoolean / (TF) (EXP)} -% \begin{syntax} -% "\IfBooleanTF" \Arg{true code} \Arg{false code} -% \end{syntax} -% Used to test if (|#1|, |#2|, etc.) is \cs{BooleanTrue} -% or \cs{BooleanFalse}. For example -% \begin{verbatim} -% \DeclareDocumentCommand \foo { s m } { -% \IfBooleanTF #1 { -% \DoSomethingWithStar {#2} -% }{ -% \DoSomethingWithoutStar {#2} -% } -% } -% \end{verbatim} -% checks for a star as the first argument, then chooses the action to -% take based on this information. -%\end{function} -% -%\subsection{Argument processors} -%\label{sec:processors} -% -% \pkg{xparse} introduces the idea of an argument processor, which is -% applied to an argument \emph{after} it has been grabbed by the -% underlying system but before it is passed to \meta{code}. An argument -% processor can therefore be used to regularise input at an early stage, -% allowing the internal functions to be completely independent of input -% form. Processors are applied to user input and to default values for -% optional arguments, but \emph{not} to the special \cs{NoValue} marker. -% -% Each argument processor is specified by the syntax -% \texttt{>}\marg{processor} in the argument specification. Processors -% are applied from right to left, so that -%\begin{verbatim} -% >{\ProcessorB} >{\ProcessorA} m -%\end{verbatim} -% would apply \cs{ProcessorA} -% followed by \cs{ProcessorB} to the tokens grabbed by the \texttt{m} -% argument. -% -%\begin{variable}{\ProcessedArgument} -% \pkg{xparse} defines a very small set of processor functions. In the -% main, it is anticipated that code writers will want to create their -% own processors. These need to accept one argument, which is the -% tokens as grabbed (or as returned by a previous processor function). -% Processor functions should return the processed argument as the -% variable \cs{ProcessedArgument}. -%\end{variable} -% -%\begin{function}{\xparse_process_to_str:n} -% \begin{syntax} -% "\xparse_process_to_str:n" \Arg{grabbed argument} -% \end{syntax} -% The \cs{xparse_process_to_str:n} processor applies the \LaTeX3 -% \cs{tl_to_str:n} function to the . For example -% \begin{verbatim} -% \DeclareDocumentCommand \foo { >{\xparse_arg_to_str:n} m } { -% #1 % Which is now detokenized -% } -% \end{verbatim} -%\end{function} -% -%\begin{function}{ \ReverseBoolean } -% \begin{syntax} -% \cs{ReverseBoolean} -% \end{syntax} -% This processor reverses the logic of \cs{BooleanTrue} and -% \cs{BooleanFalse}, so that the the example from earlier would become -% \begin{verbatim} -% \DeclareDocumentCommand \foo { > { \ReverseBoolean } s m } { -% \IfBooleanTF #1 -% { \DoSomethingWithoutStar {#2} } -% { \DoSomethingWithStar {#2} } -% } -% \end{verbatim} -%\end{function} -% -%\begin{function}{ \SplitArgument } -% \begin{syntax} -% \cs{SplitArgument} \Arg{number} \Arg{token} -% \end{syntax} -% This processor splits the argument given at each occurrence of the -% \meta{token} up to a maximum of \meta{number} tokens (thus -% dividing the input into \( \text{\meta{number}} + 1 \) parts). -% An error is given if too many \meta{tokens} are present in the -% input. The processed input is places inside -% \( \text{\meta{number}} + 1 \) sets of braces for further use. -% If there are less than \Arg{number} of \Arg{tokens} in the argument -% then empty brace groups are added at the end of the processed -% argument. -% \begin{verbatim} -% \DeclareDocumentCommand \foo -% { > { \SplitArgument { 2 } { ; } } m } -% { \InternalFunctionOfThreeArguments #1 } -% \end{verbatim} -% Any category code \( 13 \) (active) \meta{tokens} will be replaced -% before the split takes place. -%\end{function} -% -%\begin{function}{ \SplitList } -% \begin{syntax} -% \cs{SplitList} \Arg{token} -% \end{syntax} -% This processor splits the argument given at each occurrence of the -% \meta{token} where the number of items is not fixed. Each item is -% then wrapped in braces within "#1". The result is that the -% processed argument can be further processed using a mapping function. -% \begin{verbatim} -% \DeclareDocumentCommand \foo -% { > { \SplitList { ; } } m } -% { \MappingFunction #1 } -% \end{verbatim} -% Any category code \( 13 \) (active) \meta{tokens} will be replaced -% before the split takes place. -%\end{function} -% -%\subsection{Separating interface and implementation} -% -% One \emph{experimental} idea implemented in \pkg{xparse} is to -% separate out document command interfaces (the argument specification) -% from the implementation (code). This is carried out using a -% pair of functions, \cs{DeclareDocumentCommandInterface} and -% \cs{DeclareDocumentCommandImplementation} -% -%\begin{function}{\DeclareDocumentCommandInterface} -% \begin{syntax} -% "\DeclareDocumentCommandInterface" -% ~~~~\Arg{implementation} \Arg{arg spec} -% \end{syntax} -% This declares a , which will take arguments as detailed -% in the . When executed, the will look for -% code stored as an . -%\end{function} -% -%\begin{function}{\DeclareDocumentCommandImplementation} -% \begin{syntax} -% "\DeclareDocumentCommandImplementation" -% ~~~~\Arg{implementation} \Arg{code} -% \end{syntax} -% Declares the for a function to accept -% arguments and expand to . An implementation must take the -% same number of arguments as a linked interface, although this is not -% enforced by the code. -%\end{function} -% -%\subsection{Fully-expandable document commands} -% -% There are \emph{very rare} occasion when it may be useful to create -% functions using a fully-expandable argument grabber. To support this, -% \pkg{xparse} can create expandable functions as well as the usual -% robust ones. This imposes a number of restrictions on the nature of -% the arguments accepted by a function, and the code it implements. -% This facility should only be used when \emph{absolutely necessary}; -% if you do not understand when this might be, \emph{do not use these -% functions}! -% -%\begin{function}{\DeclareExpandableDocumentCommand} -% \begin{syntax} -% "\DeclareExpandableDocumentCommand" -% ~~~~ \Arg{arg spec} \Arg{code} -% \end{syntax} -% This command is used to create a document-level , -% which will grab its arguments in a fully-expandable manner. The -% argument specification for the function is given by , -% and the function will execute . In general, will -% also be fully expandable, although it is possible that this will -% not be the case (for example, a function for use in a table might -% expand so that \cs{omit} is the first non-expandable token). -% -% Parsing arguments expandably imposes a number of restrictions on -% both the type of arguments that can be read and the error checking -% available: -% \begin{itemize} -% \item The function must have at least one mandatory argument, and -% in particular the last argument must be one of the mandatory -% types (\texttt{l}, \texttt{m} or \texttt{u}). -% \item All arguments are either short or long: it is not possible -% to mix short and long argument types. -% \item The `optional group' argument types \texttt{g} and -% \texttt{G} are not available. -% \item It is not possible to differentiate between, for example -% |\foo[| and |\foo{[}|: in both cases the \texttt{[} will be -% interpreted as the start of an optional argument. As a result -% result, checking for optional arguments is less robust than -% in the standard version. -% \end{itemize} -% \pkg{xparse} will issue an error if an argument specifier is given -% which does not conform to the first three requirements. The last -% item is an issue when the function is used, and so is beyond the -% scope of \pkg{xparse} itself. -%\end{function} -% -%\subsection{Access to the argument specification} -% -% The argument specifications for document commands and environments are -% available for examination and use. -% -%\begin{function}{ -% \GetDocumentCommandArgSpec | -% \GetDocumentEnvironmentArgSpec | -%} -% \begin{syntax} -% \cs{GetDocumentCommandArgSpec} \meta{function} -% \cs{GetDocumentEnvironmentArgSpec} \meta{environment} -% \end{syntax} -% These functions transfer the current argument specification for the -% requested \meta{function} or \meta{environment} into the token list -% variable \cs{ArgumentSpecification}. If the \meta{function} or -% \meta{environment} has no known argument specification then an error -% is issued. The assignment to \cs{ArgumentSpecification} is local to -% the current \TeX\ group. -%\end{function} -% -%\begin{function}{ -% \ShowDocumentCommandArgSpec | -% \ShowDocumentEnvironmentArgSpec | -%} -% \begin{syntax} -% \cs{ShowDocumentCommandArgSpec} \meta{function} -% \cs{ShowDocumentEnvironmentArgSpec} \meta{environment} -% \end{syntax} -% These functions show the current argument specification for the -% requested \meta{function} or \meta{environment} at the terminal. If -% the \meta{function} or \meta{environment} has no known argument -% specification then an error is issued. -%\end{function} -% -%\end{documentation} -% -%\begin{implementation} -% -%\subsection{Variables and constants} -% -%\begin{variable}{\c_xparse_shorthands_prop} -% Shorthands and replacement text: set up at the start of the package, -% and not be be altered later! -%\end{variable} -% -%\begin{variable}{\l_xparse_arg_tl} -% Variable used as internal representation of -% \cs{ProcessedArgument}. Unlike the later, this register should not -% be used directly when creating new processors. -%\end{variable} -% -%\begin{variable}{\l_xparse_args_tl} -% Token list variable for arguments as they are picked up for passing -% on to user functions. -%\end{variable} -% -%\begin{variable}{\l_xparse_environment_args_tl} -% Token list register to pass arguments to the end of an environment -% from the beginning. -%\end{variable} -% -%\begin{variable}{\l_xparse_environment_bool} -% When creating functions, a short cut can be taken if all of the -% arguments are of \texttt{m} type. The code for environments cannot -% do that, and so a flag is needed. -%\end{variable} -% -%\begin{variable}{\l_xparse_error_bool} -% For flagging up errors when making expandable commands. -%\end{variable} -% -%\begin{variable}{\l_xparse_function_tl} -% Needed to pass along the function name when creating in an expandable -% manner. This is needed as a series of functions have to be created -% when making expandable functions. (In contrast, standard robust -% functions need at most two functions.) -%\end{variable} -% -%\begin{variable}{\l_xparse_last_arg_tl} -% The last argument type added. As this must be mandatory when creating -% expandable commands, this variable is needed to enforce this -% behaviour. -%\end{variable} -% -%\begin{variable}{\l_xparse_long_bool} -% Flag used to indicate creation of \cs{long} arguments. -%\end{variable} -% -%\begin{variable}{\l_xparse_m_args_int} -% Used to enumerate the \texttt{m} arguments with no modifications -% (i.e., neither long nor processed after grabbing). -%\end{variable} -% -%\begin{variable}{\l_xparse_m_only_bool} -% Flag used to indicate that all arguments are of type \texttt{m}, -% with no no modifications. -%\end{variable} -% -%\begin{variable}{\l_xparse_mandatory_args_int} -% For counting up all mandatory arguments so that the code can tell -% when optional arguments come after the last mandatory one. Counts -% down again as mandatory arguments are added to the signature, so will -% be zero for any trailing optional arguments. -%\end{variable} -% -%\begin{variable}{\l_xparse_processor_bool} -% When converting an argument specification into a signature there is -% a need to know if there are any argument processors set up. This is -% used to tell if \texttt{m} arguments can simply be counted up or need -% handling on a one-off basis. -%\end{variable} -% -%\begin{variable}{\l_xparse_processor_int} -% Each time a processor is set up in the grabber routine, it is stored -% and the total number of processors is recorded here. Later, the -% variable is counted back down to use the processors in reverse order -% to the collection order. -%\end{variable} -% -%\begin{variable}{\l_xparse_signature_tl} -% For constructing the signature of the function defined. As -% \pkg{xparse} works through an argument specification, grabber -% functions are added to this variable for each argument. -%\end{variable} -% -%\begin{variable}{\l_xparse_tmp_tl} -% Scratch space, used for example to convert shorthand argument types -% into the full versions. -%\end{variable} -% -%\begin{variable}{\l_xparse_total_args_int} -% Used to enumerate the total number of arguments (i.e., the number of -% letters in the argument specification). -%\end{variable} -% -%\subsection{Internal functions} -% -%\begin{function}{ -% \xparse_add_arg:n | -% \xparse_add_arg:V -%} -% \begin{syntax} -% "\xparse_add_arg:n" -% \end{syntax} -% Adds to the output \pkg{xparse} supplies to the -% defined , applying any post-processing that is needed. -%\end{function} -% -%\begin{function}{ -% \xparse_add_grabber_mandatory:N| -% \xparse_add_grabber_optional:N -%} -% \begin{syntax} -% "\xparse_add_grabber_mandatory:N" -% \end{syntax} -% Adds appropriate grabber for to the signature -% being constructed, making it long if necessary. The -% \texttt{optional} version includes a second check to see if space -% skipping should be on or off. -%\end{function} -% -%\begin{function}{ -% \xparse_add_type_+:w| -% \xparse_add_type_>:w| -% \xparse_add_type_d:w| -% \xparse_add_type_D:w| -% \xparse_add_type_g:w| -% \xparse_add_type_G:w| -% \xparse_add_type_l:w| -% \xparse_add_type_m:w| -% \xparse_add_type_t:w| -% \xparse_add_type_u:w -%} -% \begin{syntax} -% "\xparse_add_type_u:w" -% \end{syntax} -% Carry out necessary processes to add given of argument to -% the signature being constructed. Depending on the argument type -% being added, one or more arguments will be absorbed. -%\end{function} -% -%\begin{function}{\xparse_check_and_add:N} -% \begin{syntax} -% "\xparse_check_and_add:N" -% \end{syntax} -% Ensures that is valid, and if so adds it to the signature -% being constructed. -%\end{function} -% -%\begin{function}{ -% \xparse_count_mandatory:n| -% \xparse_count_mandatory:N -%} -% \begin{syntax} -% "\xparse_count_mandatory:N" -% \end{syntax} -% Used to count how many mandatory arguments an argument specification -% contains. The \texttt{n} function carries out the set up, before -% handing of to the \texttt{N} function. This reads one token, and -% calls the appropriate counter function. -%\end{function} -% -%\begin{function}{ -% \xparse_count_type_>:w| -% \xparse_count_type_+:w| -% \xparse_count_type_d:w| -% \xparse_count_type_D:w| -% \xparse_count_type_g:w| -% \xparse_count_type_G:w| -% \xparse_count_type_l:w| -% \xparse_count_type_m:w| -% \xparse_count_type_t:w| -% \xparse_count_type_u:w| -%} -% \begin{syntax} -% "\xparse_count_type_D:w" -% \end{syntax} -% Used to count up mandatory arguments: one function for each argument -% type so that a simple loop can be used. Only the functions for -% mandatory arguments do any more than call the loop again. -%\end{function} -% -%\begin{function}{\xparse_declare_cmd:Nnn} -% \begin{syntax} -% "\xparse_declare_cmd:Nnn" \Arg{signature} -% ~~~~\Arg{code} -% \end{syntax} -% Declares using for argument definition and -% as expansion. -% \begin{texnote} -% This is the internal name for \cs{DeclareDocumentCommand}. -% \end{texnote} -%\end{function} -% -%\begin{function}{\xparse_declare_cmd_interface:Nnn} -% \begin{syntax} -% "\xparse_declare_cmd_interface:Nnn" -% ~~~~\Arg{implementation} \Arg{signature} -% \end{syntax} -% Declares using , which should have code stored -% as . -% \begin{texnote} -% This is the internal name for \cs{DeclareDocumentCommandInterface}. -% \end{texnote} -%\end{function} -% -%\begin{function}{\xparse_declare_cmd_implementation:nNn} -% \begin{syntax} -% "\xparse_declare_cmd_implementation:nNn" -% ~~~~\Arg{implementation} \Arg{code} -% \end{syntax} -% Declares taking arguments as an , -% to be accessed using an interface defined elsewhere. -% \begin{texnote} -% This is the internal name for -% \cs{DeclareDocumentCommandImplementation}. -% \end{texnote} -%\end{function} -% -%\begin{function}{\xparse_declare_env:nnnn} -% \begin{syntax} -% "\xparse_declare_env:nnnn" \Arg{env} \Arg{arg spec} -% ~~~~\Arg{start code} \Arg{end code} -% \end{syntax} -% Declares as an environment taking arguments -% at \cs{begin}\{\}. The is executed at the beginning -% of the environment, and the at the end. Both parts may -% use the arguments defined by . -% \begin{texnote} -% This is the internal name for \cs{DeclareDocumentEnvironment}. -% \end{texnote} -%\end{function} -% -%\begin{function}{\xparse_flush_m_args:} -% \begin{syntax} -% "\xparse_flush_m_args:" -% \end{syntax} -% Adds an outstanding \texttt{m} arguments to the signature. -%\end{function} -% -%\begin{function}{\xparse_grab_arg:w} -% \begin{syntax} -% "\xparse_grab_arg:w" -% \end{syntax} -% Function re-defined each time an argument is grabbed to actually -% do the grabbing. It is this function which will raise an error if -% an argument runs away. -%\end{function} -% -%\begin{function}{ -% \xparse_grab_D:w | -% \xparse_grab_D_long:w | -% \xparse_grab_D_trailing:w | -% \xparse_grab_D_long_trailing:w| -% \xparse_grab_G:w | -% \xparse_grab_G_long:w | -% \xparse_grab_G_trailing:w | -% \xparse_grab_G_long_trailing:w| -% \xparse_grab_l:w | -% \xparse_grab_l_long:w | -% \xparse_grab_m:w | -% \xparse_grab_m_long:w | -% \xparse_grab_m_1:w | -% \xparse_grab_m_2:w | -% \xparse_grab_m_3:w | -% \xparse_grab_m_4:w | -% \xparse_grab_m_5:w | -% \xparse_grab_m_6:w | -% \xparse_grab_m_7:w | -% \xparse_grab_m_8:w | -% \xparse_grab_t:w | -% \xparse_grab_t_long:w | -% \xparse_grab_t_trailing:w | -% \xparse_grab_t_long_trailing:w| -% \xparse_grab_u:w | -% \xparse_grab_u_long:w | -%} -% \begin{syntax} -% "\xparse_grab_D:w" "\l_xparse_args_tl" -% \end{syntax} -% Argument grabbing functions, which re-arrange other -% so that the argument is read correctly. The \texttt{trailing} -% versions do not skip spaces when searching for optional arguments. -% For each argument type, the various versions feed the appropriate -% information to a common auxiliary function which then sets up -% \cs{xparse_grab_arg:w} to actually carry out the argument absorption. -%\end{function} -% -%\begin{function}{\xparse_if_no_value:n / (TF) (EXP)} -% \begin{syntax} -% "\xparse_if_no_value:nTF" \Arg{arg} -% ~~~~\Arg{true code} \Arg{false code} -% \end{syntax} -% Executes if is equal to the special -% \cs{NoValue} marker and otherwise. Provided that -% the primitive \cs{(pdf)strcmp} is available, this function is -% expandable. -%\end{function} -% -%\begin{function}{ -% \xparse_prepare_signature:n| -% \xparse_prepare_signature:N -%} -% \begin{syntax} -% "\xparse_prepare_signature:n" \Arg{arg specs} -% \end{syntax} -% Parse one or more and convert to an output . -%\end{function} -% -%\begin{function}{\xparse_process_arg:n} -% \begin{syntax} -% "\xparse_process_arg:n" \Arg{processor} -% \end{syntax} -% Sets up code to apply to next grabbed argument. -%\end{function} -% -%\subsection{Creating expandable commands} -% -%\begin{function}{ -% \xparse_exp_add_type_d:w| -% \xparse_exp_add_type_D:w| -% \xparse_exp_add_type_l:w| -% \xparse_exp_add_type_m:w| -% \xparse_exp_add_type_t:w| -% \xparse_exp_add_type_u:w -%} -% \begin{syntax} -% "\xparse_exp_add_type_u:w" \Arg{delimiter} -% \end{syntax} -% Carry out necessary processes to add given of argument for -% an expandable command. Depending on the argument type being added, -% one or more arguments will be absorbed. -%\end{function} -% -%\begin{function}{\xparse_exp_check_and_add:N} -% \begin{syntax} -% "\xparse_exp_check_and_add:N" -% \end{syntax} -% Ensures that is valid, and if so adds it to expandable -% function being constructed. -%\end{function} -% -%\begin{function}{\xparse_exp_declare_cmd:Nnn} -% \begin{syntax} -% "\xparse_exp_declare_cmd:Nnn" \Arg{signature} -% ~~~~\Arg{code} -% \end{syntax} -% Declares using for argument definition and -% as expansion, and creating an expandable command. -% \begin{texnote} -% This is the internal name for -% \cs{DeclareExpandableDocumentCommand}. -% \end{texnote} -%\end{function} -% -%\begin{function}{ -% \xparse_exp_prepare_function:n| -% \xparse_exp_prepare_function:N -%} -% \begin{syntax} -% "\xparse_exp_prepare_function:n" \Arg{arg specs} -% \end{syntax} -% Parse one or more and convert to an expandable -% function. -%\end{function} -% -%\begin{function}{\xparse_exp_set:cpx} -% \begin{syntax} -% "\xparse_exp_set:cpx" \Arg{code} -% \end{syntax} -% An alias for either \cs{cs_set:cpx} or \cs{cs_set_nopar:cpx}, -% depending on the \cs{long} status of the expandable function. -%\end{function} -% -%\section{\pkg{xparse} implementation} -% -% The usual lead-off: only needed for the package, of course (one day we -% may have a \LaTeX3 kernel). -% \begin{macrocode} -%<*package> -\ProvidesExplPackage - {\filename}{\filedate}{\fileversion}{\filedescription} -\RequirePackage{expl3} -% -%<*initex|package> -% \end{macrocode} -% -%\subsection{Variables and constants} -% -%\begin{macro}{\c_xparse_shorthands_prop} -% Shorthands are stored as a property list: this is set up here as it -% is a constant. -% \begin{macrocode} -\prop_new:N \c_xparse_shorthands_prop -\prop_put:Nnn \c_xparse_shorthands_prop { o } { d[] } -\prop_put:Nnn \c_xparse_shorthands_prop { O } { D[] } -\prop_put:Nnn \c_xparse_shorthands_prop { s } { t* } -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_arg_tl} -% Token registers for single grabbed argument when post-processing. -% \begin{macrocode} -\tl_new:N \l_xparse_arg_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_args_tl} -% Token registers for grabbed arguments. -% \begin{macrocode} -\tl_new:N \l_xparse_args_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_environment_bool} -% Generating environments uses the same mechanism as generating -% functions. However, full processing of arguments is always needed -% for environments, and so the function-generating code needs to -% know this. -% \begin{macrocode} -\bool_new:N \l_xparse_environment_bool -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_error_bool} -% Used to signal an error when creating expandable functions. -% \begin{macrocode} -\bool_new:N \l_xparse_error_bool -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_function_tl} -% When creating expandable functions, the current function name needs -% to be passed along. -% \begin{macrocode} -\tl_new:N \l_xparse_function_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_last_arg_tl} -% Used when creating expandable arguments. -% \begin{macrocode} -\tl_new:N \l_xparse_last_arg_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_long_bool} -% A flag for \cs{long} arguments. -% \begin{macrocode} -\bool_new:N \l_xparse_long_bool -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_m_args_int} -% The number of simple \texttt{m} arguments is tracked so they can be -% dumped \emph{en masse}. -% \begin{macrocode} -\int_new:N \l_xparse_m_args_int -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_m_only_bool} -% A flag to indicate that only \texttt{m} arguments have been found. -% \begin{macrocode} -\bool_new:N \l_xparse_m_only_bool -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_mandatory_args_int} -% So that trailing optional arguments can be picked up, a count has to -% be taken of all mandatory arguments. This is then decreased as -% mandatory arguments are added to the signature, so will be zero -% only if there are no more mandatory arguments to add. -% \begin{macrocode} -\int_new:N \l_xparse_mandatory_args_int -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_processor_bool} -% When reading through the argument specifier, a flag is needed to -% show that a processor has been found for the current argument. This -% is used when checking how to handle \texttt{m} arguments. -% \begin{macrocode} -\bool_new:N \l_xparse_processor_bool -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_processor_int} -% In the grabber routine, each processor is saved with a number -% recording the order it was found in. The total is then used to work -% back through the grabbers so they apply to the argument right to left. -% \begin{macrocode} -\int_new:N \l_xparse_processor_int -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_signature_tl} -% Token registers for constructing signatures. -% \begin{macrocode} -\tl_new:N \l_xparse_signature_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_tmp_tl} -% A general purpose token list variable. -% \begin{macrocode} -\tl_new:N \l_xparse_tmp_tl -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\l_xparse_total_args_int} -% Thje total number of arguments is used to create the internal function -% which has a fixed number of arguments. -% \begin{macrocode} -\int_new:N \l_xparse_total_args_int -% \end{macrocode} -%\end{macro} -% -%\subsection{Turning the argument specifier into grabbers} -% -%\begin{macro}{\xparse_add_grabber_mandatory:N} -%\begin{macro}{\xparse_add_grabber_optional:N} -% To keep the various checks needed in one place, adding the grabber to -% the signature is done here. For mandatory arguments, the only question -% is whether to add a long grabber. For optional arguments, there is -% also a check to see if any mandatory arguments are still to be added. -% This is used to determine whether to skip spaces or not where -% searching for the argument. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_add_grabber_mandatory:N #1 { - \tl_put_right:Nx \l_xparse_signature_tl { - \exp_not:c { - xparse_grab_ #1 \bool_if:NT \l_xparse_long_bool { _long } :w - } - } - \bool_set_false:N \l_xparse_long_bool - \int_decr:N \l_xparse_mandatory_args_int -} -\cs_new_nopar:Npn \xparse_add_grabber_optional:N #1 { - \tl_put_right:Nx \l_xparse_signature_tl { - \exp_not:c { - xparse_grab_ #1 - \bool_if:NT \l_xparse_long_bool { _long } - \int_compare:nF { - \l_xparse_mandatory_args_int > \c_zero - } { _trailing } - :w - } - } - \bool_set_false:N \l_xparse_long_bool -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -% All of the argument-adding functions work in essentially the same -% way, except the one for \texttt{m} arguments. Any collected \texttt{m} -% arguments are added to the signature, then the appropriate grabber -% is added to the signature. Some of the adding functions also pick up -% one or more arguments, and are also added to the signature. All of the -% functions then call the loop function \cs{xparse_prepare_signature:N}. -% -%\begin{macro}{\xparse_add_type_+:w} -% Making the next argument \cs{long} means setting the flag and -% knocking one back off the total argument count. The \texttt{m} -% arguments are recorded here as this has to be done for every case -% where there is then a \cs{long} argument. -% \begin{macrocode} -\cs_new_nopar:cpn { xparse_add_type_+:w } { - \xparse_flush_m_args: - \bool_set_true:N \l_xparse_long_bool - \bool_set_false:N \l_xparse_m_only_bool - \int_decr:N \l_xparse_total_args_int - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_>:w} -% When a processor is found, the function \cs{xparse_process_arg:n} -% is added to the signature along with the processor code itself. When -% the signature is used, the code will be added to an execution list by -% \cs{xparse_process_arg:n}. Here, the loop calls -% \cs{xparse_prepare_signature_aux:N} rather than -% \cs{xparse_prepare_signature:N} so that the flag is not reset. -% \begin{macrocode} -\cs_new:cpn { xparse_add_type_>:w } #1 { - \bool_set_true:N \l_xparse_processor_bool - \xparse_flush_m_args: - \int_decr:N \l_xparse_total_args_int - \tl_put_right:Nn \l_xparse_signature_tl { - \xparse_process_arg:n {#1} - } - \xparse_prepare_signature_aux:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_d:w} -% To save on repeated code, \texttt{d} is actually turned into -% the same grabber as is used by \texttt{D}, by putting the -% \cs{NoValue} default in the correct place. So there is some -% simple argument re-arrangement to do. Remember that |#1| and |#2| -% should be single tokens. -% \begin{macrocode} -\cs_new:Npn \xparse_add_type_d:w #1#2 { - \xparse_add_type_D:w #1 #2 { \NoValue } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_D:w} -% All of the optional delimited arguments are handled internally by -% the \texttt{D} type. At this stage, the two delimiters are stored -% along with the default value. -% \begin{macrocode} -\cs_new:Npn \xparse_add_type_D:w #1#2#3 { - \xparse_flush_m_args: - \xparse_add_grabber_optional:N D - \tl_put_right:Nn \l_xparse_signature_tl { #1 #2 {#3} } - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_g:w} -% The \texttt{g} type is simply an alias for \texttt{G} with the -% correct default built-in. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_add_type_g:w { - \xparse_add_type_G:w { \NoValue } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_G:w} -% For the \texttt{G} type, the grabber and the default are added to -% the signature. -% \begin{macrocode} -\cs_new:Npn \xparse_add_type_G:w #1 { - \xparse_flush_m_args: - \xparse_add_grabber_optional:N G - \tl_put_right:Nn \l_xparse_signature_tl { {#1} } - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_l:w} -% Finding \texttt{l} arguments is very simple: there is nothing to do -% other than add the grabber. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_add_type_l:w { - \xparse_flush_m_args: - \xparse_add_grabber_mandatory:N l - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_m:w} -% The \texttt{m} type is special as short arguments which are not -% post-processed are simply counted at this stage. Thus there is a check -% to see if either of these cases apply. If so, a one-argument grabber -% is added to the signature. On the other hand, if a standard short -% argument is required it is simply counted at this stage, to be -% added later using \cs{xparse_flush_m_args:}. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_add_type_m:w { - \bool_if:nTF { - \l_xparse_long_bool || \l_xparse_processor_bool - } { - \xparse_flush_m_args: - \xparse_add_grabber_mandatory:N m - }{ - \int_incr:N \l_xparse_m_args_int - } - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_t:w} -% Setting up a \texttt{t} argument means collecting one token for the -% test, and adding it along with the grabber to the signature. -% \begin{macrocode} -\cs_new:Npn \xparse_add_type_t:w #1 { - \xparse_flush_m_args: - \xparse_add_grabber_optional:N t - \tl_put_right:Nn \l_xparse_signature_tl { #1 } - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_add_type_u:w} -% At the set up stage, the \texttt{u} type argument is identical to the -% \texttt{G} type except for the name of the grabber function. -% \begin{macrocode} -\cs_new:Npn \xparse_add_type_u:w #1 { - \xparse_flush_m_args: - \xparse_add_grabber_mandatory:N u - \tl_put_right:Nn \l_xparse_signature_tl { {#1} } - \xparse_prepare_signature:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_check_and_add:N} -% This function checks if the argument type actually exists and gives -% an error if it doesn't. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_check_and_add:N #1 { - \cs_if_free:cTF { xparse_add_type_ #1 :w } { - \msg_kernel_error:nnx { xparse } { unknown-argument-type } {#1} - \xparse_add_type_m:w - }{ - \use:c { xparse_add_type_ #1 :w } - } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_count_mandatory:n} -%\begin{macro}{\xparse_count_mandatory:N} -%\begin{macro}[aux]{\xparse_count_mandatory_aux:N} -% To count up mandatory arguments before the main parsing run, the -% same approach is used. First, check if the current token is a -% short-cut for another argument type. If it is, expand it and loop -% again. If not, then look for a `counting' function to check the -% argument type. No error is raised here if one is not found as one -% will be raised by later code. -% \begin{macrocode} -\cs_new:Npn \xparse_count_mandatory:n #1 { - \int_zero:N \l_xparse_mandatory_args_int - \xparse_count_mandatory:N #1 \q_nil -} -\cs_new:Npn \xparse_count_mandatory:N #1 { - \quark_if_nil:NF #1 { - \prop_if_in:NnTF \c_xparse_shorthands_prop {#1} { - \prop_get:NnN \c_xparse_shorthands_prop {#1} \l_xparse_tmp_tl - \exp_last_unbraced:NV \xparse_count_mandatory:N \l_xparse_tmp_tl - }{ - \xparse_count_mandatory_aux:N #1 - } - } -} -\cs_new:Npn \xparse_count_mandatory_aux:N #1 { - \cs_if_free:cTF { xparse_count_type_ #1 :w } { - \xparse_count_type_m:w - }{ - \use:c { xparse_count_type_ #1 :w } - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_count_type_>:w} -%\begin{macro}{\xparse_count_type_+:w} -%\begin{macro}{\xparse_count_type_d:w} -%\begin{macro}{\xparse_count_type_D:w} -%\begin{macro}{\xparse_count_type_g:w} -%\begin{macro}{\xparse_count_type_G:w} -%\begin{macro}{\xparse_count_type_l:w} -%\begin{macro}{\xparse_count_type_m:w} -%\begin{macro}{\xparse_count_type_t:w} -%\begin{macro}{\xparse_count_type_u:w} -% For counting the mandatory arguments, a function is provided for -% each argument type that will mop any extra arguments and call the -% loop function. Only the counting functions for mandatory arguments -% actually do anything: the rest are simply there to ensure the loop -% continues correctly. -% \begin{macrocode} -\cs_new:cpn { xparse_count_type_>:w } #1 { - \xparse_count_mandatory:N -} -\cs_new_nopar:cpn { xparse_count_type_+:w } { - \xparse_count_mandatory:N -} -\cs_new:Npn \xparse_count_type_d:w #1#2 { - \xparse_count_mandatory:N -} -\cs_new:Npn \xparse_count_type_D:w #1#2#3 { - \xparse_count_mandatory:N -} -\cs_new_nopar:Npn \xparse_count_type_g:w { - \xparse_count_mandatory:N -} -\cs_new:Npn \xparse_count_type_G:w #1 { - \xparse_count_mandatory:N -} -\cs_new_nopar:Npn \xparse_count_type_l:w { - \int_incr:N \l_xparse_mandatory_args_int - \xparse_count_mandatory:N -} -\cs_new_nopar:Npn \xparse_count_type_m:w { - \int_incr:N \l_xparse_mandatory_args_int - \xparse_count_mandatory:N -} -\cs_new:Npn \xparse_count_type_t:w #1 { - \xparse_count_mandatory:N -} -\cs_new:Npn \xparse_count_type_u:w #1 { - \int_incr:N \l_xparse_mandatory_args_int - \xparse_count_mandatory:N -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_declare_cmd:Nnn} -%\begin{macro}[aux]{\xparse_declare_cmd_aux:Nnn} -%\begin{macro}[aux]{\xparse_declare_cmd_aux:cnn} -%\begin{macro}[aux]{\xparse_declare_cmd_all_m:Nn} -%\begin{macro}[aux]{\xparse_declare_cmd_mixed:Nn} -% First, the signature is set up from the argument specification. There -% is then a check: if only \texttt{m} arguments are needed (which -% includes functions with no arguments at all) then the definition is -% simple. On the other hand, if the signature is more complex then an -% internal function actually contains the code with the user function -% as a simple wrapper. -% \begin{macrocode} -\cs_new:Npn \xparse_declare_cmd:Nnn #1#2 { - \cs_if_exist:NTF #1 - { - \msg_kernel_warning:nnxx { xparse } { redefine-command } - { \token_to_str:N #1 } { \exp_not:n {#2} } - } - { - \msg_kernel_info:nnxx { xparse } { define-command } - { \token_to_str:N #1 } { \exp_not:n {#2} } - } - \xparse_declare_cmd_aux:Nnn #1 {#2} -} -\cs_new:Npn \xparse_declare_cmd_aux:Nnn #1#2#3 { - \cs_if_exist:cF { l_xparse_ \token_to_str:N #1 _arg_spec_tl } - { \tl_new:c { l_xparse_ \token_to_str:N #1 _arg_spec_tl } } - \tl_set:cn { l_xparse_ \token_to_str:N #1 _arg_spec_tl } {#2} - \xparse_count_mandatory:n {#2} - \xparse_prepare_signature:n {#2} - \bool_if:NTF \l_xparse_m_only_bool { - \xparse_declare_cmd_all_m:Nn #1 {#3} - }{ - \xparse_declare_cmd_mixed:Nn #1 {#3} - } -} -\cs_generate_variant:Nn \xparse_declare_cmd_aux:Nnn { cnn } -\cs_new:Npn \xparse_declare_cmd_all_m:Nn #1#2 { - \cs_generate_from_arg_count:NNnn - #1 \cs_set_protected_nopar:Npn \l_xparse_total_args_int {#2} -} -\cs_new:Npn \xparse_declare_cmd_mixed:Nn #1#2 { - \group_begin: - \tex_escapechar:D 92 \scan_stop: - \tl_set:Nx \l_xparse_function_tl { \token_to_str:N #1 } - \exp_args:NNNo \group_end: - \tl_set:Nn \l_xparse_function_tl { \l_xparse_function_tl } - \cs_set_protected_nopar:Npx #1 { - \exp_not:n { - \int_zero:N \l_xparse_processor_int - \tl_set:Nn \l_xparse_args_tl - } { \exp_not:c { \l_xparse_function_tl } } - \exp_not:V \l_xparse_signature_tl - \exp_not:N \l_xparse_args_tl - } - \cs_generate_from_arg_count:cNnn - { \token_to_str:N #1 } \cs_set:Npn \l_xparse_total_args_int {#2} -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_declare_cmd_implementation:nNn} -% Creating a stand-alone implementation using the `two-part' mechanism -% is quite easy as this is just a wrapper for -% \cs{cs_generate_from_arg_count:cNnn}. -% \begin{macrocode} -\cs_new:Npn \xparse_declare_cmd_implementation:nNn #1#2#3 { - \cs_generate_from_arg_count:cNnn { implementation_ #1 :w } - \cs_set:Npn {#2} {#3} -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_declare_cmd_interface:Nnn} -%\begin{macro}[aux]{\xparse_declare_cmd_interface_all_m:Nn} -%\begin{macro}[aux]{\xparse_declare_cmd_interface_mixed:Nn} -% As with the basic function \cs{xparse_declare_cmd:Nnn}, there are -% three things to do here. First, generate a signature from the -% argument specification. Then use that to create a function which -% will call the implementation part. Finally, a holder implementation -% is created. As before, there is a short-cut for functions which only -% have \texttt{m} type arguments. -% \begin{macrocode} -\cs_new:Npn \xparse_declare_cmd_interface:Nnn #1#2#3 { - \xparse_prepare_signature:n {#3} - \bool_if:NTF \l_xparse_m_only_bool { - \xparse_declare_cmd_interface_all_m:Nn #1 {#2} - }{ - \xparse_declare_cmd_interface_mixed:Nn #1 {#2} - } - \cs_generate_from_arg_count:cNnn { implementation_ #2 :w } - \cs_set:Npn \l_xparse_total_args_int { ``#2'' } -} -\cs_new:Npn \xparse_declare_cmd_interface_all_m:Nn #1#2 { - \cs_generate_from_arg_count:NNnn - #1 \cs_set_protected_nopar:Npn \l_xparse_total_args_int - { \use:c { implementation_ #2 :w } } -} -\cs_new:Npn \xparse_declare_cmd_interface_mixed:Nn #1#2 { - \cs_set_protected_nopar:Npx #1 { - \exp_not:n { - \int_zero:N \l_xparse_processor_int - \tl_set:Nn \l_xparse_args_tl - } { \exp_not:c { \token_to_str:N #1 } } - \exp_not:V \l_xparse_signature_tl - \exp_not:N \l_xparse_args_tl - } - \cs_generate_from_arg_count:cNnn - { \token_to_str:N #1 } \cs_set:Npn \l_xparse_total_args_int - { \use:c { implementation_ #2 :w } } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_declare_env:nnnn} -% The idea here is to make sure that the end of the environment has the -% same arguments available as the beginning. -% \begin{macrocode} -\cs_new:Npn \xparse_declare_env:nnnn #1#2#3#4 { - \bool_set_true:N \l_xparse_environment_bool -% -%<*initex> - \cs_if_exist:cTF { environment_begin_ #1 :w } -% -%<*package> - \cs_if_exist:cTF {#1} -% -%<*initex|package> - { - \msg_kernel_warning:nnxx { xparse } { redefine-environment } - {#1} { \exp_not:n {#2} } - } - { - \msg_kernel_info:nnxx { xparse } { define-environment } - {#1} { \exp_not:n {#2} } - } - \xparse_declare_cmd_aux:cnn { environment_begin_ #1 :w } {#2} { - \group_begin: - \cs_set_protected_nopar:cpx { environment_end_ #1 :w } - { - \exp_not:c { environment_end_ #1 _aux:N } - \exp_not:V \l_xparse_args_tl - \group_end: - } - #3 - } - \cs_set_protected_nopar:cpx { environment_end_ #1 : } - { \exp_not:c { environment_end_ #1 :w } } - \bool_set_false:N \l_xparse_environment_bool - \cs_set_nopar:cpx { environment_end_ #1 _aux:N } ##1 { - \exp_not:c { environment_end_ #1 _aux :w } - } - \cs_generate_from_arg_count:cNnn - { environment_end_ #1 _aux :w } \cs_set:Npn - \l_xparse_total_args_int {#4} -% -%<*package> - \cs_set_eq:cc {#1} { environment_begin_ #1 :w } - \cs_set_eq:cc { end #1 } { environment_end_ #1 : } -% -%<*initex|package> -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_flush_m_args:} -% As \texttt{m} arguments are simply counted, there is a need to add -% them to the token register in a block. As this function can only -% be called if something other than \texttt{m} turns up, the flag can -% be switched here. The total number of mandatory arguments added to -% the signature is also decreased by the appropriate amount. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_flush_m_args: { - \cs_if_exist:cT { - xparse_grab_m_ \int_use:N \l_xparse_m_args_int :w - } { - \tl_put_right:Nx \l_xparse_signature_tl { - \exp_not:c { xparse_grab_m_ \int_use:N \l_xparse_m_args_int :w } - } - \int_set:Nn \l_xparse_mandatory_args_int { - \l_xparse_mandatory_args_int - \l_xparse_m_args_int - } - } - \int_zero:N \l_xparse_m_args_int - \bool_set_false:N \l_xparse_m_only_bool -} -% \end{macrocode} -%\end{macro} -% -% -%\begin{macro}[TF]{\xparse_if_no_value:n} -% Tests for \cs{NoValue}. -% \begin{macrocode} -\prg_new_conditional:Nnn \xparse_if_no_value:n { TF,T,F } { - \str_if_eq:nnTF {#1} { \NoValue } { - \prg_return_true: - }{ - \prg_return_false: - } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_prepare_signature:n} -% Creating the signature is a case of working through the input and -% turning into the output in \cs{l_xparse_signature_tl}. A track is -% also kept of the total number of arguments. This function sets -% everything up then hands off to the parser. -% \begin{macrocode} -\cs_new:Npn \xparse_prepare_signature:n #1 { - \bool_set_false:N \l_xparse_long_bool - \int_zero:N \l_xparse_m_args_int - \bool_if:NTF \l_xparse_environment_bool { - \bool_set_false:N \l_xparse_m_only_bool - }{ - \bool_set_true:N \l_xparse_m_only_bool - } - \bool_set_false:N \l_xparse_processor_bool - \tl_clear:N \l_xparse_signature_tl - \int_zero:N \l_xparse_total_args_int - \xparse_prepare_signature:N #1 \q_nil -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_prepare_signature:N} -%\begin{macro}[aux]{\xparse_prepare_signature_aux:N} -% The main signature-preparation loop is in two parts, to keep the code -% a little clearer. Most of the checks here is pretty clear, with a key -% point to watch what is next on the stack so that the loop continues -% correctly. -% \begin{macrocode} -\cs_new:Npn \xparse_prepare_signature:N #1 { - \bool_set_false:N \l_xparse_processor_bool - \xparse_prepare_signature_aux:N #1 -} -\cs_new:Npn \xparse_prepare_signature_aux:N #1 { - \quark_if_nil:NTF #1 { - \bool_if:NF \l_xparse_m_only_bool { - \xparse_flush_m_args: - } - }{ - \prop_if_in:NnTF \c_xparse_shorthands_prop {#1} { - \prop_get:NnN \c_xparse_shorthands_prop {#1} \l_xparse_tmp_tl - \exp_last_unbraced:NV \xparse_prepare_signature:N \l_xparse_tmp_tl - }{ - \int_incr:N \l_xparse_total_args_int - \xparse_check_and_add:N #1 - } - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_process_arg:n} -% Processors are saved for use later during the grabbing process. -% \begin{macrocode} -\cs_new:Npn \xparse_process_arg:n #1 { - \int_incr:N \l_xparse_processor_int - \cs_set:cpn { - xparse_processor_ \int_use:N \l_xparse_processor_int :n - } ##1 - { #1 {##1} } -} -% \end{macrocode} -%\end{macro} -% -%\subsection{Grabbing arguments} -% -%\begin{macro}{\xparse_add_arg:n} -%\begin{macro}{\xparse_add_arg:V} -%\begin{macro}[aux]{\xparse_add_arg_aux:n} -%\begin{macro}[aux]{\xparse_add_arg_aux:V} -% The argument-storing system provides a single point for interfacing -% with processors. They are done in a loop, counting downward. In this -% way, the processor which was found last is executed first. The result -% is that processors apply from right to left, as intended. Notice that -% a set of braces are added back around the result of processing so that -% the internal function will correctly pick up one argument for each -% input argument. -% \begin{macrocode} -\cs_new:Npn \xparse_add_arg:n #1 { - \int_compare:nTF { \l_xparse_processor_int = \c_zero } { - \tl_put_right:Nn \l_xparse_args_tl { {#1} } - }{ - \xparse_if_no_value:nTF {#1} { - \int_zero:N \l_xparse_processor_int - \tl_put_right:Nn \l_xparse_args_tl { {#1} } - }{ - \xparse_add_arg_aux:n {#1} - } - } -} -\cs_generate_variant:Nn \xparse_add_arg:n { V } -\cs_new:Npn \xparse_add_arg_aux:n #1 { - \tl_set_eq:NN \ProcessedArgument \l_xparse_arg_tl - \use:c { xparse_processor_ \int_use:N \l_xparse_processor_int :n } - {#1} - \int_decr:N \l_xparse_processor_int - \int_compare:nTF { \l_xparse_processor_int = \c_zero } { - \tl_put_right:Nx \l_xparse_args_tl { - { \exp_not:V \ProcessedArgument } - } - }{ - \xparse_add_arg_aux:V \ProcessedArgument - } -} -\cs_generate_variant:Nn \xparse_add_arg_aux:n { V } -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -% All of the grabbers follow the same basic pattern. The initial -% function sets up the appropriate information to define -% \cs{parse_grab_arg:w} to grab the argument. This means determining -% whether to use \cs{cs_set:Npn} or \cs{cs_set_nopar:Npn}, and for -% optional arguments whether to skip spaces. In all cases, -% \cs{xparse_grab_arg:w} is then called to actually do the grabbing. -% -%\begin{macro}{\xparse_grab_arg:w} -%\begin{macro}[aux]{\xparse_grab_arg_aux_i:w} -%\begin{macro}[aux]{\xparse_grab_arg_aux_ii:w} -% Each time an argument is actually grabbed, \pkg{xparse} defines a -% function to do it. In that way, long arguments from previous functions -% can be included in the definition of the grabber function, so that -% it does not raise an error if not long. The generic function used -% for this is reserved here. A couple of auxiliary functions are also -% needed in various places. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_arg:w { } -\cs_new:Npn \xparse_grab_arg_aux_i:w { } -\cs_new:Npn \xparse_grab_arg_aux_ii:w { } -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_D:w} -%\begin{macro}{\xparse_grab_D_long:w} -%\begin{macro}{\xparse_grab_D_trailing:w} -%\begin{macro}{\xparse_grab_D_long_trailing:w} -% The generic delimited argument grabber. The auxiliary function does -% a peek test before calling \cs{xparse_grab_arg:w}, so that the -% optional nature of the argument works as expected. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_D:w #1#2#3#4 \l_xparse_args_tl { - \xparse_grab_D_aux:NNnnNn #1 #2 {#3} {#4} \cs_set_nopar:Npn - { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_D_long:w #1#2#3#4 \l_xparse_args_tl { - \xparse_grab_D_aux:NNnnNn #1 #2 {#3} {#4} \cs_set:Npn - { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_D_trailing:w #1#2#3#4 \l_xparse_args_tl { - \xparse_grab_D_aux:NNnnNn #1 #2 {#3} {#4} \cs_set_nopar:Npn { } -} -\cs_new:Npn \xparse_grab_D_long_trailing:w #1#2#3#4 - \l_xparse_args_tl { - \xparse_grab_D_aux:NNnnNn #1 #2 {#3} {#4} \cs_set:Npn { } -} -% \end{macrocode} -%\begin{macro}[aux]{\xparse_grab_D_aux:NNnnNn} -% This is a bit complicated. The idea is that, in order to check for -% nested optional argument tokens (\texttt{[[...]]} and so on) the -% argument needs to be grabbed without removing any braces at all. If -% this is not done, then cases like |[{[}]| fail. So after testing for -% an optional argument, it is collected piece-wise. First, the opening -% token is removed, then a check is made for a group. If it looks like -% the entire argument is a group, then an extra set of braces are -% added back in. The closing token is then used to collect everything -% else. There is then a test to see if there is nesting, by looking -% for a `spare' open-argument token. If that is found, things hand off -% to a loop to deal with that. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_D_aux:NNnnNn #1#2#3#4#5#6 { - #5 \xparse_grab_arg:w #1 { - \peek_meaning:NTF \c_group_begin_token { - \xparse_grab_arg_aux_i:w - }{ - \xparse_grab_arg_aux_ii:w - } - } - #5 \xparse_grab_arg_aux_i:w ##1 { - \peek_charcode:NTF #2 { - \xparse_grab_arg_aux_ii:w { {##1} } - }{ - \xparse_grab_arg_aux_ii:w {##1} - } - } - #5 \xparse_grab_arg_aux_ii:w ##1 #2 { - \tl_if_in:nnTF {##1} {#1} { - \xparse_grab_D_nested:NNnnN #1 #2 {##1} {#4} #5 - }{ - \xparse_add_arg:n {##1} - #4 \l_xparse_args_tl - } - } - \use:c { peek_charcode #6 :NTF } #1 { - \xparse_grab_arg:w - }{ - \xparse_add_arg:n {#3} - #4 \l_xparse_args_tl - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\begin{macro}[aux]{\xparse_grab_D_nested:NNnnN} -%\begin{macro}{\_l_xparse_nesting_a_tl} -%\begin{macro}{\_l_xparse_nesting_b_tl} -%\begin{macro}{\q_xparse} -% Catching nested optional arguments means more work. The aim here is -% to collect up each pair of optional tokens without \TeX\ helping out, -% and without counting anything. The code above will already have -% removed the leading opening token and a closing token, but the -% wrong one. The aim is then to work through the the material grabbed -% so far and divide it up on each opening token, grabbing a closing -% token to match (thus working in pairs). Once there are no opening -% tokens, then there is a second check to see if there are any -% opening tokens in the second part of the argument (for things -% like "[][]"). Once everything has been found, the entire collected -% material is added to the output as a single argument. -% \begin{macrocode} -\tl_new:N \_l_xparse_nesting_a_tl -\tl_new:N \_l_xparse_nesting_b_tl -\quark_new:N \q_xparse -\cs_new_protected:Npn \xparse_grab_D_nested:NNnnN #1#2#3#4#5 { - \tl_clear:N \_l_xparse_nesting_a_tl - \tl_clear:N \_l_xparse_nesting_b_tl - #5 \xparse_grab_arg:w ##1 #1 ##2 \q_xparse ##3 #2 - { - \tl_put_right:Nn \_l_xparse_nesting_a_tl { ##1 #1 } - \tl_put_right:Nn \_l_xparse_nesting_b_tl { #2 ##3 } - \tl_if_in:nnTF {##2} {#1} - { \xparse_grab_arg:w ##2 \q_xparse } - { - \tl_put_right:Nn \_l_xparse_nesting_a_tl {##2} - \tl_if_in:NnTF \_l_xparse_nesting_b_tl {#1} - { - \tl_set_eq:NN \l_xparse_tmp_tl \_l_xparse_nesting_b_tl - \tl_clear:N \_l_xparse_nesting_b_tl - \exp_last_unbraced:NV \xparse_grab_arg:w - \l_xparse_tmp_tl \q_xparse - } - { - \tl_put_right:NV \_l_xparse_nesting_a_tl - \_l_xparse_nesting_b_tl - \xparse_add_arg:V \_l_xparse_nesting_a_tl - #4 \l_xparse_args_tl - } - } - } - \xparse_grab_arg:w #3 \q_xparse -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_G:w} -%\begin{macro}{\xparse_grab_G_long:w} -%\begin{macro}{\xparse_grab_G_trailing:w} -%\begin{macro}{\xparse_grab_G_long_trailing:w} -%\begin{macro}[aux]{\xparse_grab_G_aux:nnNn} -% Optional groups are checked by meaning, so that the same code will -% work with, for example, Con\TeX{}t-like input. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_G:w #1#2 \l_xparse_args_tl { - \xparse_grab_G_aux:nnNn {#1} {#2} \cs_set_nopar:Npn { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_G_long:w #1#2 \l_xparse_args_tl { - \xparse_grab_G_aux:nnNn {#1} {#2} \cs_set:Npn { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_G_trailing:w #1#2 \l_xparse_args_tl { - \xparse_grab_G_aux:nnNn {#1} {#2} \cs_set_nopar:Npn { } -} -\cs_new:Npn \xparse_grab_G_long_trailing:w #1#2 \l_xparse_args_tl { - \xparse_grab_G_aux:nnNn {#1} {#2} \cs_set:Npn { } -} -\cs_set:Npn \xparse_grab_G_aux:nnNn #1#2#3#4 { - #3 \xparse_grab_arg:w ##1 { - \xparse_add_arg:n {##1} - #2 \l_xparse_args_tl - } - \use:c { peek_meaning #4 :NTF } \c_group_begin_token { - \xparse_grab_arg:w - }{ - \xparse_add_arg:n {#1} - #2 \l_xparse_args_tl - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_l:w} -%\begin{macro}{\xparse_grab_l_long:w} -%\begin{macro}[aux]{\xparse_grab_l_aux:nN} -% Argument grabbers for mandatory \TeX\ arguments are pretty simple. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_l:w #1 \l_xparse_args_tl { - \xparse_grab_l_aux:nN {#1} \cs_set_nopar:Npn -} -\cs_new:Npn \xparse_grab_l_long:w #1 \l_xparse_args_tl { - \xparse_grab_l_aux:nN {#1} \cs_set:Npn -} -\cs_new:Npn \xparse_grab_l_aux:nN #1#2 { - #2 \xparse_grab_arg:w ##1## { - \xparse_add_arg:n {##1} - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_m:w} -%\begin{macro}{\xparse_grab_m_long:w} -% Collecting a single mandatory argument is quite easy. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_m:w #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1 { - \xparse_add_arg:n {##1} - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:Npn \xparse_grab_m_long:w #1 \l_xparse_args_tl { - \cs_set:Npn \xparse_grab_arg:w ##1 { - \xparse_add_arg:n {##1} - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_m_1:w} -%\begin{macro}{\xparse_grab_m_2:w} -%\begin{macro}{\xparse_grab_m_3:w} -%\begin{macro}{\xparse_grab_m_4:w} -%\begin{macro}{\xparse_grab_m_5:w} -%\begin{macro}{\xparse_grab_m_6:w} -%\begin{macro}{\xparse_grab_m_7:w} -%\begin{macro}{\xparse_grab_m_8:w} -% Grabbing 1--8 mandatory arguments. We don't need to worry about -% nine arguments as this is only possible if everything is -% mandatory. Each function has an auxiliary so that \cs{par} tokens -% from other arguments still work. -% \begin{macrocode} -\cs_new:cpn { xparse_grab_m_1:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1 { - \tl_put_right:Nn \l_xparse_args_tl { {##1} } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_2:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2 { - \tl_put_right:Nn \l_xparse_args_tl { {##1} {##2} } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_3:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3 { - \tl_put_right:Nn \l_xparse_args_tl { {##1} {##2} {##3} } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_4:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3##4 { - \tl_put_right:Nn \l_xparse_args_tl { {##1} {##2} {##3} {##4} } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_5:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3##4##5 { - \tl_put_right:Nn \l_xparse_args_tl { - {##1} {##2} {##3} {##4} {##5} - } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_6:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3##4##5##6 { - \tl_put_right:Nn \l_xparse_args_tl { - {##1} {##2} {##3} {##4} {##5} {##6} - } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_7:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3##4##5##6##7 { - \tl_put_right:Nn \l_xparse_args_tl { - {##1} {##2} {##3} {##4} {##5} {##6} {##7} - } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -\cs_new:cpn { xparse_grab_m_8:w } #1 \l_xparse_args_tl { - \cs_set_nopar:Npn \xparse_grab_arg:w ##1##2##3##4##5##6##7##8 { - \tl_put_right:Nn \l_xparse_args_tl { - {##1} {##2} {##3} {##4} {##5} {##6} {##7} {##8} - } - #1 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_t:w} -%\begin{macro}{\xparse_grab_t_long:w} -%\begin{macro}{\xparse_grab_t_trailing:w} -%\begin{macro}{\xparse_grab_t_long_trailing:w} -%\begin{macro}[aux]{\xparse_grab_t_aux:NnNn} -% Dealing with a token is quite easy. Check the match, remove the -% token if needed and add a flag to the output. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_t:w #1#2 \l_xparse_args_tl { - \xparse_grab_t_aux:NnNn #1 {#2} \cs_set_nopar:Npn { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_t_long:w #1#2 \l_xparse_args_tl { - \xparse_grab_t_aux:NnNn #1 {#2} \cs_set:Npn { _ignore_spaces } -} -\cs_new:Npn \xparse_grab_t_trailing:w #1#2 \l_xparse_args_tl { - \xparse_grab_t_aux:NnNn #1 {#2} \cs_set_nopar:Npn { } -} -\cs_new:Npn \xparse_grab_t_long_trailing:w #1#2 \l_xparse_args_tl { - \xparse_grab_t_aux:NnNn #1 {#2} \cs_set:Npn { } -} -\cs_new:Npn \xparse_grab_t_aux:NnNn #1#2#3#4 { - #3 \xparse_grab_arg:w { - \use:c { peek_charcode_remove #4 :NTF } #1 { - \xparse_add_arg:n { \BooleanTrue } - #2 \l_xparse_args_tl - }{ - \xparse_add_arg:n { \BooleanFalse } - #2 \l_xparse_args_tl - } - } - \xparse_grab_arg:w -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_grab_u:w} -%\begin{macro}{\xparse_grab_u_long:w} -%\begin{macro}[aux]{\xparse_grab_u_aux:NnN} -% Grabbing up to a list of tokens is quite easy: define the grabber, -% and then collect. -% \begin{macrocode} -\cs_new:Npn \xparse_grab_u:w #1#2 \l_xparse_args_tl { - \xparse_grab_u_aux:NnN {#1} {#2} \cs_set_nopar:Npn -} -\cs_new:Npn \xparse_grab_u_long:w #1#2 \l_xparse_args_tl { - \xparse_grab_u_aux:NnN {#1} {#2} \cs_set:Npn -} -\cs_new:Npn \xparse_grab_u_aux:NnN #1#2#3 { - #3 \xparse_grab_arg:w ##1 #1 { - \xparse_add_arg:n {##1} - #2 \l_xparse_args_tl - } - \xparse_grab_arg:w -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\subsection{Argument processors} -% -%\begin{macro}{\xparse_process_to_str:n} -% A basic argument processor: as much an example as anything else. -% \begin{macrocode} -\cs_new:Npn \xparse_process_to_str:n #1 { - \tl_set:Nx \ProcessedArgument { - \tl_to_str:n {#1} - } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\_parse_bool_reverse:N} -% A simple reversal. -% \begin{macrocode} -\cs_new_protected:Npn \_xparse_bool_reverse:N #1 { - \bool_if:NTF #1 - { \tl_set:Nn \ProcessedArgument { \c_false_bool } } - { \tl_set:Nn \ProcessedArgument { \c_true_bool } } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\_l_xparse_split_argument_tl} -%\begin{macro}{\_xparse_split_argument:nnn} -%\begin{macro}[aux]{\_xparse_split_argument_aux_i:w} -%\begin{macro}[aux]{\_xparse_split_argument_aux_ii:w} -%\begin{macro}[aux]{\_xparse_split_argument_aux_iii:w} -% The idea of this function is to split the input \( n + 1 \) times using -% a given token. -% \begin{macrocode} -\tl_new:N \_l_xparse_split_argument_tl -\group_begin: - \char_make_active:N \@ - \cs_gset_protected:Npn \_xparse_split_argument:nnn #1#2#3 - { - \tl_set:Nn \_l_xparse_split_argument_tl {#3} - \group_begin: - \char_set_lccode:nn { `\@ } { `#2} - \tl_to_lowercase:n - { - \group_end: - \tl_replace_all_in:Nnn \_l_xparse_split_argument_tl { @ } {#2} - } - \cs_set_protected:Npn \_xparse_split_argument_aux_i:w - ##1 \q_mark ##2 #2 ##3 \q_stop - { - \tl_put_right:Nn \ProcessedArgument { {##2} } - ##1 \q_mark ##3 \q_stop - } - \cs_set_protected:Npn \_xparse_split_argument_aux_iii:w - ##1 #2 ##2 \q_stop - { - \IfNoValueF {##1} - { - \msg_kernel_error:nnxxx { xparse } { split-excess-tokens } - { \exp_not:n {#2} } {#1} { \exp_not:n {#3} } - } - } - \tl_set:Nx \l_xparse_tmp_tl - { - \prg_replicate:nn { #1 + 1 } - { \_xparse_split_argument_aux_i:w } - \_xparse_split_argument_aux_ii:w - \exp_not:N \q_mark - \exp_not:V \_l_xparse_split_argument_tl - \prg_replicate:nn {#1} { \exp_not:n {#2} \NoValue } - \exp_not:n { #2 \q_stop } - } - \l_xparse_tmp_tl - } -\group_end: -\cs_set_protected:Npn \_xparse_split_argument_aux_i:w { } -\cs_set_protected:Npn \_xparse_split_argument_aux_ii:w - #1 \q_mark #2 \q_stop - { - \tl_if_empty:nF {#2} - { \_xparse_split_argument_aux_iii:w #2 \q_stop } - } -\cs_set_protected:Npn \_xparse_split_argument_aux_iii:w { } -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\_l_xparse_split_list_tl} -%\begin{macro}{\_xparse_split_list:nn} -%\begin{macro}{\_xparse_split_list_aux:w} -% Splitting a list is done again by first dealing with active -% characters, then looping over the list using the same method as the -% \cs{clist_map_\ldots} functions. -% \begin{macrocode} -\tl_new:N \_l_xparse_split_list_tl -\group_begin: - \char_make_active:N \@ - \cs_gset_protected:Npn \_xparse_split_list:nn #1#2 - { - \tl_set:Nn \_l_xparse_split_list_tl {#2} - \group_begin: - \char_set_lccode:nn { `\@ } { `#1 } - \tl_to_lowercase:n - { - \group_end: - \tl_replace_all_in:Nnn \_l_xparse_split_list_tl { @ } {#1} - } - \cs_set:Npn \_xparse_split_list_aux:w ##1 #1 - { - \quark_if_recursion_tail_stop:n {##1} - \tl_put_right:Nn \ProcessedArgument { {##1} } - \_xparse_split_list_aux:w - } - \tl_if_empty:NTF \_l_xparse_split_list_tl - { \tl_set:Nn \ProcessedArgument { { } } } - { - \tl_clear:N \ProcessedArgument - \exp_last_unbraced:NV \_xparse_split_list_aux:w - \_l_xparse_split_list_tl #1 - \q_recursion_tail #1 \q_recursion_stop - } - } -\group_end: -\cs_set:Npn \_xparse_split_list_aux:w { } -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\subsection{Creating expandable functions} -% -% The trick here is to pass each grabbed argument along a chain of -% auxiliary functions. Each one ultimately calls the next in the chain, -% so that all of the arguments are passed along delimited using -% \cs{q_xparse}. At the end of the chain, the marker is removed -% so that the user-supplied code can be passed the correct number -% of arguments. All of this is done by expansion! -% -%\begin{macro}{\xparse_exp_add_type_d:w} -% As in the standard case, the trick here is to slot in the default -% and treat as type \texttt{D}. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_add_type_d:w #1#2 { - \xparse_exp_add_type_D:w #1 #2 { \NoValue } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_exp_add_type_D:w} -% The most complex argument to grab in an expandable manner is the -% general delimited one. First, a short-cut is set up in -% \cs{l_xparse_tmp_tl} for the name of the current grabber function. -% This is then created to grab one argument and test if it is equal -% to the opening delimiter. If the test fails, the code adds the default -% value and closing delimiter before `recycling' the argument. In either -% case, the second auxiliary function is called. It finds the closing -% delimiter and so the optional argument (if any). The function then -% calls the next one in the chain, passing along the argument(s) -% grabbed thus-far using \cs{q_xparse} as a marker. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_add_type_D:w #1#2#3 { - \tl_set:Nx \l_xparse_tmp_tl { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_use:N \l_xparse_total_args_int - } - \xparse_exp_set:cpx { \l_xparse_tmp_tl } ##1 \q_xparse ##2 { - \exp_not:N \tl_if_head_eq_charcode:nNTF {##2} #1 { - \exp_not:c { \l_xparse_tmp_tl aux } - ##1 \exp_not:N \q_xparse - }{ - \exp_not:c { \l_xparse_tmp_tl aux } - ##1 \exp_not:N \q_xparse #3 #2 {##2} - } - } - \xparse_exp_set:cpx { \l_xparse_tmp_tl aux} ##1 \q_xparse ##2 #2 { - \exp_not:c { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_eval:n { \l_xparse_total_args_int + 1 } - } ##1 {##2} \exp_not:N \q_xparse - } - \xparse_exp_prepare_function:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_exp_add_type_l:w} -%\begin{macro}{\xparse_exp_add_type_m:w} -% Gathering \texttt{l} and \texttt{m} arguments is almost the same. -% The grabber for the current argument is created to simply get the -% necessary argument and pass it along with any others through to the -% next function in the chain. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_exp_add_type_l:w { - \xparse_exp_set:cpx { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_use:N \l_xparse_total_args_int - } ##1 \q_xparse ##2## { - \exp_not:c { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_eval:n { \l_xparse_total_args_int + 1 } - } - ##1 {##2} \exp_not:N \q_xparse - } - \xparse_exp_prepare_function:N -} -\cs_new_nopar:Npn \xparse_exp_add_type_m:w { - \int_incr:N \l_xparse_m_args_int - \xparse_exp_set:cpx { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_use:N \l_xparse_total_args_int - } ##1 \q_xparse ##2 { - \exp_not:c { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_eval:n { \l_xparse_total_args_int + 1 } - } - ##1 {##2} \exp_not:N \q_xparse - } - \xparse_exp_prepare_function:N -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_exp_add_type_t:w} -% Looking for a single token is a simpler version of the \texttt{D} -% code. The same idea of picking up one argument is used, but there is -% no need for a second function as there is no closing token to find. So -% either \cs{BooleanTrue} or \cs{BooleanFalse} are added to the list of -% arguments. In the later case, the grabber argument must be `recycled'. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_add_type_t:w #1 { - \tl_set:Nx \l_xparse_tmp_tl { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_eval:n { \l_xparse_total_args_int + 1 } - } - \xparse_exp_set:cpx { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_use:N \l_xparse_total_args_int - } ##1 \q_xparse ##2 { - \exp_not:N \tl_if_head_eq_charcode:nNTF {##2} #1 { - \exp_not:c { \l_xparse_tmp_tl } - ##1 \exp_not:n { { \BooleanTrue } \q_xparse } - }{ - \exp_not:c { \l_xparse_tmp_tl } - ##1 \exp_not:n { { \BooleanFalse } \q_xparse {##2} } - } - } - \xparse_exp_prepare_function:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_exp_add_type_u:w} -% Setting up for a \texttt{u} argument is a case of defining the -% grabber for the current argument in a delimited fashion. The rest of -% the process is as the other grabbers: add to the chain and call the -% next function. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_add_type_u:w #1 { - \xparse_exp_set:cpx { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_use:N \l_xparse_total_args_int - } ##1 \q_xparse ##2 #1 { - \exp_not:c { - \exp_after:wN \token_to_str:N \l_xparse_function_tl - \int_eval:n { \l_xparse_total_args_int + 1 } - } - ##1 {##2} \exp_not:N \q_xparse - } - \xparse_exp_prepare_function:N -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_exp_check_and_add:N} -% Virtually identical to the normal version, except calling the -% expandable \texttt{add} functions rather than the standard versions. -% \begin{macrocode} -\cs_new_nopar:Npn \xparse_exp_check_and_add:N #1 { - \cs_if_free:cTF { xparse_exp_add_type_ #1 :w } { - \msg_kernel_error:nnx { xparse } { unknown-argument-type } {#1} - \tl_set:Nn \l_xparse_last_arg_tl { m } - \xparse_exp_add_type_m:w - }{ - \tl_set:Nn \l_xparse_last_arg_tl {#1} - \use:c { xparse_exp_add_type_ #1 :w } - } -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\xparse_exp_declare_cmd:Nnn} -%\begin{macro}[aux]{\xparse_exp_declare_cmd_all_m:Nn} -%\begin{macro}[aux]{\xparse_exp_declare_cmd_mixed:Nn} -%\begin{macro}[aux]{\xparse_exp_declare_cmd_mixed_aux:Nn} -% The overall scheme here is very different from the standard method. -% For each argument, an internal function is created to grab an argument -% and pass along previous ones. Each `daisy chains' to call the next -% one in the sequence. Thus at the end of the chain, an extra `argument' -% function is included to unwind the chain and pass data to the the -% internal function containing the actual code. If all of the arguments -% are type \texttt{m}, then the same tick is used as in the standard -% version. The \texttt{x} in the lead-off and mop-up functions makes -% sure that the braces around the first argument are not lost. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_declare_cmd:Nnn #1#2#3 { - \cs_if_exist:NTF #1 - { - \msg_kernel_warning:nnxx { xparse } { redefine-command } - { \token_to_str:N #1 } { \exp_not:n {#2} } - } - { - \msg_kernel_info:nnxx { xparse } { define-command } - { \token_to_str:N #1 } { \exp_not:n {#2} } - } - \group_begin: - \tex_escapechar:D 92 \scan_stop: - \tl_set:Nx \l_xparse_function_tl { \token_to_str:N #1} - \exp_args:NNNo \group_end: - \tl_set:Nn \l_xparse_function_tl { \l_xparse_function_tl } - \xparse_exp_prepare_function:n {#2} - \int_compare:nTF { - \l_xparse_total_args_int = \l_xparse_m_args_int - } { - \xparse_exp_declare_cmd_all_m:Nn #1 {#3} - }{ - \xparse_exp_declare_cmd_mixed:Nn #1 {#3} - } -} -\cs_new:Npn \xparse_exp_declare_cmd_all_m:Nn #1#2 { - \bool_if:NTF \l_xparse_long_bool { - \cs_generate_from_arg_count:NNnn - #1 \cs_set:Npn \l_xparse_total_args_int {#2} - }{ - \cs_generate_from_arg_count:NNnn - #1 \cs_set_nopar:Npn \l_xparse_total_args_int {#2} - } -} -\cs_new:Npn \xparse_exp_declare_cmd_mixed:Nn #1#2 { - \exp_args:NnV \tl_if_in:nnTF { l m u } \l_xparse_last_arg_tl { - \xparse_exp_declare_cmd_mixed_aux:Nn #1 {#2} - }{ - \msg_kernel_error:nn { xparse } { expandable-ending-optional } - } -} -\cs_new:Npn \xparse_exp_declare_cmd_mixed_aux:Nn #1#2 { - \cs_set_nopar:Npx #1 { - \exp_not:c { \token_to_str:N #1 1 } x \exp_not:N \q_xparse - } - \cs_set_nopar:cpx { - \token_to_str:N #1 \int_eval:n { \l_xparse_total_args_int + 1 } - } x ##1 \q_xparse { - \exp_not:c { \token_to_str:N #1 } ##1 - } - \cs_generate_from_arg_count:cNnn - { \token_to_str:N #1 } \cs_set:Npn \l_xparse_total_args_int {#2} -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_exp_prepare_function:n} -%\begin{macro}[aux]{\xparse_exp_prepare_function_aux:n} -% A couple of early validation tests. Processors are forbidden, as are -% \texttt{g}, \texttt{l} and \texttt{u} arguments (the later more for -% ease than any technical reason). -% \begin{macrocode} -\cs_new:Npn \xparse_exp_prepare_function:n #1 { - \bool_set_false:N \l_xparse_error_bool - \tl_if_in:nnT {#1} { > } { - \msg_kernel_error:nnx { xparse } { processor-in-expandable } {#1} - \bool_set_true:N \l_xparse_error_bool - } - \tl_if_in:nnT {#1} { g } { - \msg_kernel_error:nnx { xparse } { grouped-in-expandable } - { g } {#1} - \bool_set_true:N \l_xparse_error_bool - } - \tl_if_in:nnT {#1} { G } { - \msg_kernel_error:nnx { xparse } { grouped-in-expandable } - { G } {#1} - \bool_set_true:N \l_xparse_error_bool - } - \bool_if:NF \l_xparse_error_bool { - \xparse_exp_prepare_function_aux:n {#1} - } -} -\cs_new:Npn \xparse_exp_prepare_function_aux:n #1 { - \cs_set_eq:NN \xparse_prepare_next:w \xparse_exp_prepare_function:N - \cs_set_eq:NN \xparse_exp_set:cpx \cs_set_nopar:cpx - \bool_set_false:N \l_xparse_long_bool - \int_zero:N \l_xparse_m_args_int - \int_zero:N \l_xparse_total_args_int - \tl_if_in:nnT {#1} { + } { - \bool_set_true:N \l_xparse_long_bool - \cs_set_eq:NN \xparse_exp_set:cpx \cs_set:cpx - } - \xparse_exp_prepare_function:N #1 \q_nil -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_exp_prepare_function:N} -%\begin{macro}[aux]{\xparse_exp_prepare_function_long:N} -%\begin{macro}[aux]{\xparse_exp_prepare_function_short:N} -% Preparing functions is a case of reading the signature, as in the -% normal case. However, everything has to be either short or long, and -% so there is an extra step to make sure that once one \texttt{+} has -% been seen everything has one. That detour then takes us back to -% a standard looping concept. -% \begin{macrocode} -\cs_new:Npn \xparse_exp_prepare_function:N #1 { - \bool_if:NTF \l_xparse_long_bool { - \xparse_exp_prepare_function_long:N #1 - }{ - \xparse_exp_prepare_function_short:N #1 - } -} -\cs_new:Npn \xparse_exp_prepare_function_long:N #1 { - \quark_if_nil:NF #1 { - \str_if_eq:nnTF {#1} { + } { - \xparse_exp_prepare_function_short:N - }{ - \msg_kernel_error:nn { xparse } { expandable-inconsistent-long } - \xparse_exp_prepare_function_short:N #1 - } - } -} -\cs_new:Npn \xparse_exp_prepare_function_short:N #1 { - \quark_if_nil:NF #1 { - \prop_if_in:NnTF \c_xparse_shorthands_prop {#1} { - \prop_get:NnN \c_xparse_shorthands_prop {#1} \l_xparse_tmp_tl - \bool_if:NT \l_xparse_long_bool { - \tl_put_left:Nn \l_xparse_tmp_tl { + } - } - \exp_last_unbraced:NV \xparse_exp_prepare_function:N - \l_xparse_tmp_tl - }{ - \int_incr:N \l_xparse_total_args_int - \xparse_exp_check_and_add:N #1 - } - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_exp_set:cpx} -% A short-cut to save constantly re-testing \cs{l_xparse_long_bool}. -% \begin{macrocode} -\cs_new_eq:NN \xparse_exp_set:cpx \cs_set_nopar:cpx -% \end{macrocode} -%\end{macro} -% -%\subsection{Access to the argument specification} -% -%\begin{macro}{\xparse_get_arg_spec:N} -%\begin{macro}{\xparse_get_arg_spec:n} -%\begin{macro}{\ArgumentSpecification} -% Recovering the argument specification is also trivial, using the -% \cs{tl_set_eq:cN} function. -% \begin{macrocode} -\cs_new_protected:Npn \xparse_get_arg_spec:N #1 { - \cs_if_exist:cTF { l_xparse_ \token_to_str:N #1 _arg_spec_tl } - { - \tl_set_eq:Nc \ArgumentSpecification - { l_xparse_ \token_to_str:N #1 _arg_spec_tl } - } - { - \msg_kernel_error:nnx { xparse } { unknown-document-command } - { \token_to_str:N #1 } - } -} -\cs_new_protected:Npn \xparse_get_arg_spec:n #1 { - \cs_if_exist:cTF { l_xparse_ #1 _arg_spec_tl } - { - \tl_set_eq:Nc \ArgumentSpecification { l_xparse_ #1 _arg_spec_tl } - } - { - \msg_kernel_error:nnx { xparse } - { unknown-document-environment } {#1} - } -} -\tl_new:N \ArgumentSpecification -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\xparse_show_arg_spec:N} -%\begin{macro}{\xparse_show_arg_spec:n} -% Showing the argument specification simply means finding it and then -% calling the \cs{tl_show:c} function. -% \begin{macrocode} -\cs_new_protected:Npn \xparse_show_arg_spec:N #1 { - \cs_if_exist:cTF { l_xparse_ \token_to_str:N #1 _arg_spec_tl } - { - \tl_set_eq:Nc \ArgumentSpecification - { l_xparse_ \token_to_str:N #1 _arg_spec_tl } - \tl_show:N \ArgumentSpecification - } - { - \msg_kernel_error:nnx { xparse } { unknown-document-command } - { \token_to_str:N #1 } - } -} -\cs_new_protected:Npn \xparse_show_arg_spec:n #1 { - \cs_if_exist:cTF { l_xparse_ #1 _arg_spec_tl } - { - \tl_set_eq:Nc \ArgumentSpecification { l_xparse_ #1 _arg_spec_tl } - \tl_show:N \ArgumentSpecification - } - { - \msg_kernel_error:nnx { xparse } - { unknown-document-environment } {#1} - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\subsection{Messages} -% -% Some messages intended as errors. -% \begin{macrocode} -\msg_kernel_new:nnnn { xparse } { command-already-defined } - { Command~'#1'~already~defined! } - { - You~have~used~\token_to_str:N \NewDocumentCommand \\ - with~a~command~that~already~has~a~definition.\\ - Perhaps~you~meant~\token_to_str:N \RenewDocumentCommand. - } -\msg_kernel_new:nnnn { xparse } { command-not-yet-defined } - { Command ~'#1'~not~yet~defined! } - { - You~have~used~\token_to_str:N \RenewDocumentCommand \\ - with~a~command~that~was~never~defined.\\ - Perhaps~you~meant~\token_to_str:N \NewDocumentCommand. - } -\msg_kernel_new:nnnn { xparse } { environment-already-defined } - { Environment~'#1'~already~defined! } - { - You~have~used~\token_to_str:N \NewDocumentEnvironment \\ - with~a~command~that~already~has~a~definition.\\ - Perhaps~you~meant~\token_to_str:N \RenewDocumentEnvironment. - } -\msg_kernel_new:nnnn { xparse } { environment-not-yet-defined } - {Environment~'#1'~not~yet~defined! } - { - You~have~used~\token_to_str:N \RenewDocumentEnvironment \\ - with~a command~that~was~never~defined.\\ - Perhaps~you~meant~\token_to_str:N \NewDocumentEnvironment. - } -\msg_kernel_new:nnnn { xparse } { expandable-ending-optional } - { - Signature~for~expandable~command~ends~with \\ - optional~argument~\msg_line_context:. - } - { - Expandable~commands~must~have~a~final~mandatory~argument \\ - (or~no arguments~at all).~You~cannot~have~a~terminal~optional \\ - argument~with~expandable~commands. - } -\msg_kernel_new:nnnn { xparse } { expandable-inconsistent-long } - { - Inconsistent~handling~of~long~arguments~for \\ - expandable~command~\msg_line_context:. - } - { - The~arguments~for~an~expandable~command~must~either~all~be \\ - short~or~all~be~long.~You~have~tried~to~mix~the~two~types. - } -\msg_kernel_new:nnnn { xparse } { grouped-in-expandable } - {% - Argument~specifier~'#1'~forbidden~in~expandable~commands~ - \msg_line_context:. - } - { - Argument~specification~'#2'~contains~the~optional~grouped~ - argument~#1':\\ - this~is only~supported~for~standard~robust~functions. - } -\msg_kernel_new:nnnn { xparse } { processor-in-expandable } - { - Argument~processors~cannot~be~used \\ - with~expandable~functions~\msg_line_context:. - } - { - Argument~specification~'#1'~contains~a~processor~function:\\ - this~is~only~supported~for~standard~robust~functions. - } -\msg_kernel_new:nnnn { xparse } { split-excess-tokens } - { Too~many~'#1'~tokens~when~trying~to~split~argument. } - { - LaTeX~was~asked~to~split~the~input~'#3'\\ - at~each~occurrence~of~the~token~'#1',~up~to~a~maximum~of~#2~tokens.\\ - There~were~too~many~'#1'~tokens. - } -\msg_kernel_new:nnnn { xparse } { unknown-argument-type } - { Unknown~argument~type~'#1'~replaced~by~'m'.~Fingers~crossed~... } - { - The~letter~#1'~does~not~specify~a~known~argument~type.\\ - I'm~assuming~you~want~a~standard~mandatory~argument~(type~'m'). - } -\msg_kernel_new:nnnn { xparse } { unknown-document-command } - { Unknown~document~command~'#1'. } - { - You~have~asked~for~the~argument~specification~for~a~command~'#1',~ - but~this~is~not~a~document~command. - } -\msg_kernel_new:nnnn { xparse } { unknown-document-environment } - { Unknown~document~environment~'#1'. } - { - You~have~asked~for~the~argument~specification~for~a~command~'#1',~ - but~this~is~not~a~document~environment. - } -% \end{macrocode} -% -% Intended more for information. -% \begin{macrocode} -\msg_kernel_new:nnn { xparse } { define-command } - { - Defining~document~command~#1\\ - with~arg.~spec.~'#2'~\msg_line_context:. - } -\msg_kernel_new:nnn { xparse } { define-environment } - { - Defining~document~environment~'#1'\\ - with~arg.~spec.~'#2'~\msg_line_context:. - } -\msg_kernel_new:nnn { xparse } { redefine-command } - { - Redefining~document~command~#1\\ - with~arg.~spec.~'#2'~\msg_line_context:. - } -\msg_kernel_new:nnn { xparse } { redefine-environment } - { - Redefining~document~environment~'#1'\\ - with~arg.~spec.~'#2'~\msg_line_context:. - } -% \end{macrocode} -% -%\subsection{User functions} -% -% The user functions are more or less just the internal functions -% renamed. -% -%\begin{macro}{\BooleanFalse} -%\begin{macro}{\BooleanTrue} -% Design-space names for the Boolean values. -% \begin{macrocode} -\cs_new_eq:NN \BooleanFalse \c_false_bool -\cs_new_eq:NN \BooleanTrue \c_true_bool -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\DeclareDocumentCommand} -%\begin{macro}{\NewDocumentCommand} -%\begin{macro}{\RenewDocumentCommand} -%\begin{macro}{\ProvideDocumentCommand} -% The user macros are pretty simple wrappers around the internal ones. -% \begin{macrocode} -\cs_new_protected:Npn \DeclareDocumentCommand #1#2#3 { - \xparse_declare_cmd:Nnn #1 {#2} {#3} -} -\cs_new_protected:Npn \NewDocumentCommand #1#2#3 { - \cs_if_exist:NTF #1 { - \msg_kernel_error:nnx { xparse } { command-already-defined } - { \token_to_str:N #1 } - }{ - \xparse_declare_cmd:Nnn #1 {#2} {#3} - } -} -\cs_new_protected:Npn \RenewDocumentCommand #1#2#3 { - \cs_if_exist:NTF #1 { - \xparse_declare_cmd_aux:Nnn #1 {#2} {#3} - \msg_kernel_info:nnxx { xparse } { redefine-command } - { \token_to_str:N #1 } { \exp_not:n {#2} } - }{ - \msg_kernel_error:nnx { xparse } { command-not-yet-defined } - { \token_to_str:N #1 } - } -} -\cs_new_protected:Npn \ProvideDocumentCommand #1#2#3 { - \cs_if_exist:NF #1 { - \xparse_declare_cmd:Nnn #1 {#2} {#3} - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\DeclareDocumentCommandImplementation} -%\begin{macro}{\DeclareDocumentCommandInterface} -% The separate implementation/interface system is again pretty simple -% to create at the outer layer. -% \begin{macrocode} -\cs_new_protected:Npn \DeclareDocumentCommandImplementation #1#2#3 { - \xparse_declare_cmd_implementation:nNn {#1} #2 {#3} -} -\cs_new_protected:Npn \DeclareDocumentCommandInterface #1#2#3 { - \xparse_declare_cmd_interface:Nnn #1 {#2} {#3} -} -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\DeclareDocumentEnvironment} -%\begin{macro}{\NewDocumentEnvironment} -%\begin{macro}{\RenewDocumentEnvironment} -%\begin{macro}{\ProvideDocumentEnvironment} -% Very similar for environments. -% \begin{macrocode} -\cs_new_protected:Npn \DeclareDocumentEnvironment #1#2#3#4 { - \xparse_declare_env:nnnn {#1} {#2} {#3} {#4} -} -\cs_new_protected:Npn \NewDocumentEnvironment #1#2#3#4 { -% -%<*initex> - \cs_if_exist:cTF { environment_begin_ #1 :w } { -% -%<*package> - \cs_if_exist:cTF {#1} { -% -%<*initex|package> - \msg_kernel_error:nnx { xparse } - { environment-already-defined } {#1} - }{ - \xparse_declare_env:nnnn {#1} {#2} {#3} {#4} - } -} -\cs_new_protected:Npn \RenewDocumentEnvironment #1#2#3#4 { -% -%<*initex> - \cs_if_exist:cTF { environment_begin_ #1 :w } { -% -%<*package> - \cs_if_exist:cTF {#1} { -% -%<*initex|package> - \xparse_declare_env:nnnn {#1} {#2} {#3} {#4} - }{ - \msg_kernel_error:nnx { xparse } - { environment-not-yet-defined } {#1} - } -} -\cs_new_protected:Npn \ProvideDocumentEnvironment #1#2#3#4 { -% -%<*initex> - \cs_if_exist:cF { environment_begin_ #1 :w } { -% -%<*package> - \cs_if_exist:cF { #1 } { -% -%<*initex|package> - \xparse_declare_env:nnnn {#1} {#2} {#3} {#4} - } -} -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\DeclareExpandableDocumentCommand} -% The expandable version of the basic function is essentially the same. -% \begin{macrocode} -\cs_new_protected:Npn \DeclareExpandableDocumentCommand #1#2#3 { - \xparse_exp_declare_cmd:Nnn #1 {#2} {#3} -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}[TF]{\IfBoolean} -% The logical \meta{true} and \meta{false} statements are just the -% normal \cs{c_true_bool} and \cs{c_false_bool}, so testing for them is -% done with the \cs{bool_if:NTF} functions from \textsf{l3prg}. -% \begin{macrocode} -\cs_new_eq:NN \IfBooleanTF \bool_if:NTF -\cs_new_eq:NN \IfBooleanT \bool_if:NT -\cs_new_eq:NN \IfBooleanF \bool_if:NF -% \end{macrocode} -%\end{macro} -% -%\begin{macro}[TF]{\IfNoValue} -% Simple re-naming. -% \begin{macrocode} -\cs_new_eq:NN \IfNoValueF \xparse_if_no_value:nF -\cs_new_eq:NN \IfNoValueT \xparse_if_no_value:nT -\cs_new_eq:NN \IfNoValueTF \xparse_if_no_value:nTF -% \end{macrocode} -%\end{macro} -%\begin{macro}[TF]{\IfValue} -% Inverted logic. -% \begin{macrocode} -\cs_set:Npn \IfValueF { \xparse_if_no_value:nT } -\cs_set:Npn \IfValueT { \xparse_if_no_value:nF } -\cs_set:Npn \IfValueTF #1#2#3 { - \xparse_if_no_value:nTF {#1} {#3} {#2} -} -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\NoValue} -% The marker for no value being give: this can be typeset safely. -% This is coded by hand as making it \cs{protected} ensures that it -% will not turn into anything else by accident. -% \begin{macrocode} -\cs_new_protected:Npn \NoValue { -NoValue- } -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\ProcessedArgument} -% Processed arguments are returned using this name, which is reserved -% here although the definition will change. -% \begin{macrocode} -\cs_new:Npn \ProcessedArgument { } -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\ReverseBoolean} -% A processor to reverse the logic for token detection. -% \begin{macrocode} -\cs_new_eq:NN \ReverseBoolean \_xparse_bool_reverse:N -% \end{macrocode} -%\end{macro} -% -%\begin{macro}{\SplitArgument} -%\begin{macro}{\SplitList} -% Another simple copy. -% \begin{macrocode} -\cs_new_eq:NN \SplitArgument \_xparse_split_argument:nnn -\cs_new_eq:NN \SplitList \_xparse_split_list:nn -% \end{macrocode} -%\end{macro} -%\end{macro} -% -%\begin{macro}{\GetDocumentCommandArgSpec} -%\begin{macro}{\GetDocumentEnvironmentArgSpec} -%\begin{macro}{\ShowDocumentCommandArgSpec} -%\begin{macro}{\ShowDocumentEnvironmentArgSpec} -% More simple mappings. -% \begin{macrocode} -\cs_new_eq:NN \GetDocumentCommandArgSpec \xparse_get_arg_spec:N -\cs_new_eq:NN \GetDocumentEnvironmmentArgSpec \xparse_get_arg_spec:n -\cs_new_eq:NN \ShowDocumentCommandArgSpec \xparse_show_arg_spec:N -\cs_new_eq:NN \ShowDocumentEnvironmentArgSpec \xparse_show_arg_spec:n -% \end{macrocode} -%\end{macro} -%\end{macro} -%\end{macro} -%\end{macro} -% -% \begin{macrocode} -% -% \end{macrocode} -% -% \end{implementation} -% -% \PrintIndex diff --git a/Master/texmf-dist/source/latex/xpackages/xbase/xtemplate.dtx b/Master/texmf-dist/source/latex/xpackages/xbase/xtemplate.dtx deleted file mode 100644 index 0ad4f0699ab..00000000000 --- a/Master/texmf-dist/source/latex/xpackages/xbase/xtemplate.dtx +++ /dev/null @@ -1,3383 +0,0 @@ -% \iffalse -%% File: xtemplate.dtx (C) Copyright 1999-2001 David Carlisle, Frank Mittelbach -%% (C) Copyright 2004-2010 Frank Mittelbach, LaTeX3 Project -%% -%% It may be distributed and/or modified under the conditions of the -%% LaTeX Project Public License (LPPL), either version 1.3c of this -%% license or (at your option) any later version. The latest version -%% of this license is in the file -%% -%% http://www.latex-project.org/lppl.txt -%%1 -%% This file is part of the ``xbase bundle'' (The Work in LPPL) -%% and all files in that bundle must be distributed together. -%% -%% The released version of this bundle is available from CTAN. -%% -%% ----------------------------------------------------------------------- -%% -%% The development version of the bundle can be found at -%% -%% http://www.latex-project.org/svnroot/experimental/trunk/ -%% -%% for those people who are interested. -%% -%%%%%%%%%%% -%% NOTE: %% -%%%%%%%%%%% -%% -%% Snapshots taken from the repository represent work in progress and may -%% not work or may contain conflicting material! We therefore ask -%% people _not_ to put them into distributions, archives, etc. without -%% prior consultation with the LaTeX Project Team. -%% -%% ----------------------------------------------------------------------- -%% -% -%<*driver|package> -\RequirePackage{l3names} -% -%\fi -\GetIdInfo$Id: xtemplate.dtx 2115 2011-01-03 21:46:30Z joseph $ - {Prototype document functions} -%\iffalse -%<*driver> -%\fi -\ProvidesFile{\filename.\filenameext} - [\filedate\space v\fileversion\space\filedescription] -%\iffalse -\documentclass[full]{l3doc} -\ExplSyntaxOn -% SYNTAX environments getting ugly. This helps: -\cs_if_exist:NT \g_doc_syntax_dim { - \dim_set:Nn \g_doc_syntax_dim {\textwidth} -} -\ExplSyntaxOff -\usepackage{booktabs} -\begin{document} - \DocInput{xtemplate.dtx} -\end{document} -% -% \fi -% -% \title{The \textsf{xtemplate} package\thanks{This file -% has version number \fileversion, last -% revised \filedate.}} -% \author{\Team} -% \date{\filedate} -% \maketitle -% -% \begin{documentation} -% -% \section{Introduction} -% -% There are three broad `layers' between putting down ideas into a source file -% and ending up with a typeset document. These layers of document writing are: -% \begin{enumerate} -% \item Authoring of the text, with mark-up -% \item Document layout design -% \item Implementation (with \TeX\ programming) of the design -% \end{enumerate} -% We write the text as an author, and we see the visual output of the design -% after the document is generated; the \TeX\ implementation in the middle is -% the glue between the two. -% -% \LaTeX's greatest success has been to standardise a system of mark-up that -% balances the trade-off between ease of reading and ease of writing to suit -% almost all forms of technical writing. It's -% other original strength was a good background in typographical design; while -% the standard \LaTeXe\ classes look somewhat dated now in terms of their -% visual design, their typography is generally sound. (Barring the occasional -% minor faults.) -% -% However, \LaTeXe\ has always lacked a standard approach to customising -% the visual design of a document. Changing the looks of the standard classes -% involved either: -% \begin{itemize} -% \item Creating a new version of the implementation code of the class and -% editing it. -% \item Loading one of the many packages to customise certain elements of -% the standard classes. -% \item Loading a completely different document class, such as -% \textsf{KOMA-Script} or \textsf{memoir}, that allows easy -% customisation. -% \end{itemize} -% All three of these approaches have their drawbacks and learning curves. -% -% The idea behind \pkg{xtemplate} is to cleanly separate the three layers -% introduced at the beginning of this section, so that document authors who -% are not programmers can easily change the design of their documents. -% \pkg{xtemplate} also makes it easier for \LaTeX\ programmers to provide -% their own customisations on top of a pre-existing class. -% -% \section{What is a document?} -% -% Besides the textual content of the words themselves, the source file of a -% document contains mark-up elements that add structure to the document. -% These elements include sectional divisions, figure/table captions, -% lists of various sorts, theorems/proofs, and so on. -% The list will be different for every document that can be written. -% -% Each element can be represented logically without worrying about the -% formatting, with mark-up such as \cmd\section, \cmd\caption, -% "\begin{enumerate}" and so on. -% The output of each one of these document -% elements will be a typeset representation of the information marked up, and -% the visual arrangement and design of these elements can vary widely in -% producing a variety of desired outcomes. -% -% For each type of document element, there may be design variations that -% contain the same sort of information but present it in slightly different -% ways. -% For example, the difference between a numbered and an unnumbered -% section, \cmd\section\ and \cmd\section"*", or the difference between an -% itemised list or an enumerated list. -% -% There are three distinct layers in the definition of `a document' at this -% level: -% \begin{enumerate} -% \item Semantic elements such as the ideas of sections and lists. -% \item A set of design solutions for representing these elements visually. -% \item Specific variations for these designs that represent the elements in the document. -% \end{enumerate} -% In the parlance of the \pkg{xtemplate} package, we call these object types, -% templates, and instances, and they are discussed below in -% sections \ref{sec:objects}, \ref{sec:templates}, and~\ref{sec:instances}, -% respectively. -% -% \section {Objects, templates, and instances} -% -% By formally declaring our document to be composed of mark-up elements -% grouped into objects, which are interpreted and typeset with a set of -% templates, each of which has one or more instances with which to compose each -% and every semantic unit of the text, we can cleanly separate -% the components of document construction. -% The \pkg{xtemplate} package provides the tools to do this. -% -% \subsection{Object types}\label{sec:objects} -% -% An `object type' (or sometimes just `object') is an abstract idea of a -% document element that takes a -% fixed number of arguments corresponding to the information from the -% document author that it is representing. -% A sectioning object, for example, might take three inputs: `title', -% `short title', and `label'. -% -% Any given document class will define which object types are to be used in -% the -% document, and any template of a given object type can be used to generate an -% instance for the object. -% (Of course, different templates will produce different typeset -% representations, but the underlying content will be the same.) -% -% \begin{function}{\DeclareObjectType} -% \begin{syntax} -% "\DeclareObjectType" \Arg{name} \Arg{Nargs} -% \end{syntax} -% This function defines an \emph{object type}, -% where \meta{name} is the name of the object type and \meta{Nargs} is the number of -% arguments an instance of this type should take. For example, -% \begin{quote} -% \begin{verbatim} -% \DeclareObjectType{sectioning}{3} -% \end{verbatim} -% \end{quote} -% Note that object types are global entities: \cs{DeclareObjectType} -% will apply outside of any \TeX\ grouping in force when it is -% called. -% \end{function} -% -% \subsection{Templates}\label{sec:templates} -% -% A \emph{template} is a generalised design solution for representing the -% information of a specified \emph{object type}. -% Templates that do the same thing~--- e.g., two completely different ways of -% printing a chapter heading~--- are grouped together by their object type and -% given -% separate names. -% There are two important parts to a template: -% \begin{itemize} -% \item The parameters it takes to vary the design it is producing. -% \item The implementation of the design. -% \end{itemize} -% As a document author or designer does not care about the implementation -% but rather only the interface to the template, these two aspects of the template -% definition are split into two independent declarations, \cmd\DeclareTemplateInterface\ -% and \cmd\DeclareTemplateCode. -% -% \begin{function}{\DeclareTemplateInterface} -% \par -% \begin{syntax} -% "\DeclareTemplateInterface" \Arg{object type} \Arg{template} \Arg{Nargs} -% "{" -% " " ":" "," -% " " ":" "=" "," -% " ..." -% "}" -% \end{syntax} -% The \meta{name of keys} can be any string of \textsc{ascii} characters (with -% the exception of ":", "=" and "," as they are part of the syntax); -% we recommend only using lower case letters and dashes, however. -% Note that spaces in key names are ignored, so that key names can be -% spaced out for ease of reading without affecting the recognition of -% keys inside and outside of code blocks. -% -% The define what sort of input the key accepts, such as `boolean', -% `integer', and so on. The complete list of possible is shown in -% \autoref{tab:keytypes}. -% -% Like objects, templates are global entities: both -% \cs{DeclareTemplateInterface} \cs{DeclareTemplateCode} will apply -% outside of any \TeX\ grouping in force when it is called. -% \end{function} -% -% \begin{table}[p] -% \begin{tabular}{@{}ll@{}} -% \toprule -% Key Type & Description of input \\ -% \midrule -% "boolean" & "true" or "false" \\ -% "choice "\Arg{choices} & A list of pre-defined choices \\ -% "code" & Generalised key type; use "#1" as the input to the key \\ -% "commalist" & A comma-separated list of arbitrary items \\ -% "function "$N$ & A function definition with $N$ arguments -% ($N$ from $0$ to $9$) \\ -% "instance "\Arg{name} & An instance of type \meta{name} \\ -% "integer" & An integer expression (e.g., {\small "(1 + 5)/2"}) \\ -% "length" & A dimension expression (e.g., {\small "3pt + 2cm"}) \\ -% "skip" & A dimension expression with glue -% (e.g., {\small "3pt plus 2pt minus 1pt"}) \\ -% "tokenlist" & A `token list' input; any text or commands \\ -% \bottomrule -% \end{tabular} -% \caption{`Key types' for defining template interfaces with \cs{DeclareTemplateInterface}.} -% \label{tab:keytypes} -% \end{table} -% -% \begin{table}[p] -% \begin{tabular}{@{}lcl@{}} -% \toprule -% Key Type && Description of binding \\ -% \midrule -% "boolean" &$\star$& Boolean variable; e.g., "\l_tmpa_bool" \\ -% "choice" && "{" \meta{choice\,$_1$} "=" \meta{code\,$_1$} "," \meta{choice\,$_2$} "=" \meta{code\,$_2$} "," \dots "}" \\ -% "code" && \meta{code} ; use "#1" as the input to the key \\ -% "commalist" &$\star$& Comma-list variable; e.g., "\l_tmpa_clist" \\ -% "function" &$\star$& Function w/ $N$ arguments; e.g., "\use_i:nn" \\ -% "instance" &$\star$& An instance variable; e.g., "\g_foo_instance" \\ -% "integer" &$\star$& Integer variable; e.g., "\l_tmpa_int" \\ -% "length" &$\star$& Dimension variable; e.g., "\l_tmpa_dim" \\ -% "skip" &$\star$& Skip variable; e.g., "\l_tmpa_skip" \\ -% "tokenlist" &$\star$& Token list variable; e.g., "\l_tmpa_tl" \\ -% \bottomrule -% \end{tabular} -% \caption{Bindings required for different key types when defining template implementations with \cs{DeclareTemplateCode}. Starred entries may be prefixed with the keyword \texttt{global} to make a global assignment.} -% \label{tab:keyvariables} -% \end{table} -% -% \begin{function}{\DeclareTemplateCode} -% \par -% \begin{syntax} -% "\DeclareTemplateCode" \Arg{object type} \Arg{template} \Arg{Nargs} -% "{" -% " " "=" "," -% " " "=" "," -% " ..." -% "}{" -% " "\meta{implementation code} -% " \AssignTemplateKeys" -% " "\meta{more implementation code} -% "}" -% \end{syntax} -% After the keys have been declared with "\DeclareTemplateInterface", the -% implementation binds each with an -% (for key types such as `integer', `length', `tokenlist', etc.) -% \unskip\footnote{^^A -% It is possible, if you wish, to use the same variable for multiple keys; -% this allows `key synonyms' to be defined such as |color| and |colour| which -% can perform the same function in the template implementation.} -% or with a certain fragment to execute, which will be described below. -% -% Assignments to variables which should be made globally are indicated by adding the -% word \texttt{global} before the variable name: -% -% \begin{syntax} -% " " "=" "," -% " " "=" global "," -% \end{syntax} -% -% The key types "choices" and "code" do not take variable bindings; instead, -% fragments of code are defined which are executed instead. The complete list -% of bindings taken by different key types is shown in \autoref{tab:keyvariables}. -% The "choices" key type is explained fully in \autoref{sec:choices-key} below. -% -% \begin{function}{\AssignTemplateKeys} -% \par -% The final argument of \cs{DeclareTemplateCode} contains the -% for the template design, taking arguments |#1|, |#2|, etc.\ according to the number of -% arguments allowed, . \cs{AssignTemplateKeys} must be -% executed in order to assign variables and perform code executions according -% to the keys set. -% \end{function} -% \end{function} -% -% \subsection{Multiple choices} -% \label{sec:choices-key} -% -% The \texttt{choice} keytype implements multiple choice input. At the -% interface level, only the list of valid choices is needed: -% \begin{verbatim} -% \DeclareTemplateInterface { foo } { bar } 0 { -% key-name : choice { A,B,C } -% } -% \end{verbatim} -% where the choices are given as a comma-list (which must therefore -% be wrapped in braces). A default value can also be given: -% \begin{verbatim} -% \DeclareTemplateInterface { foo } { bar } 0 { -% key-name : choice { A,B,C } = A -% } -% \end{verbatim} -% -% At the implementation level, each choice is associated with code, -% using a nested key--value list. -% \begin{verbatim} -% \DeclareTemplateCode { foo } { bar } 0 { -% key-name = { -% A = Code-A , -% B = Code-B , -% C = Code-C , -% } -% } { ... } -% \end{verbatim} -% The two choice lists should match, but in the implementation a -% special \texttt{unknown} choice is also available. This can be used -% to ignore values and implement an `else' branch: -% \begin{verbatim} -% \DeclareTemplateCode { foo } { bar } 0 { -% key-name = { -% A = Code-A , -% B = Code-B , -% C = Code-C , -% unknown = Else-code -% } -% } { ... } -% \end{verbatim} -% The \texttt{unknown} entry must be the last one given, and should -% \emph{not} be listed in the interface part of of the template. -% -% For keys which accept the values "true" and "false" both the boolean -% and choice key types can be used. As template interfaces are intended -% to prompt clarity at the design level, the boolean key type should be -% favoured, with the choice type reserved for keys which take arbitrary -% values. -% -% \subsection{Instances}\label{sec:instances} -% -% After a template is defined it still needs to be put to use. -% The parameters that it expects need to be defined before it can be used in -% a document. -% Every time a template has parameters given to it, an \emph{instance} is -% created, and this is the code that ends up in the document to perform the -% typesetting of whatever pieces of information are input into it. -% -% For example, a template might say `here is a section with or without a -% number that might be centred or left aligned and print its contents in a -% certain font of a certain size, with a bit of a gap before and after it' -% whereas an instance declares `this is a section with a number, which is centred and set -% in 12pt italic with a 10pt skip before and a 12pt skip after it'. -% -% Therefore, an instance is just a frozen version of a template with specific -% settings as chosen by the designer. -% -% \begin{function}{\DeclareInstance} -% \par -% \begin{syntax} -% "\DeclareInstance" \Arg{object type} \Arg{instance} \Arg{template} \Arg{parameters} -% \end{syntax} -% The name of the instance being declared is , with -% the keyval input to set some or all of the