diff options
author | Karl Berry <karl@freefriends.org> | 2022-12-28 22:28:54 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-12-28 22:28:54 +0000 |
commit | e5e1082561ce3eb3d5ee2245c28f906b87daa076 (patch) | |
tree | 3cf5cb29803f56870b18945ac064a20457c737ad /Master/texmf-dist/doc/latex/postnotes/postnotes.tex | |
parent | 7c4fdb40c3d8ae02f9b3f15cd69e62576a8fb248 (diff) |
postnotes (28dec22)
git-svn-id: svn://tug.org/texlive/trunk@65385 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/postnotes/postnotes.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/postnotes/postnotes.tex | 39 |
1 files changed, 22 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/postnotes/postnotes.tex b/Master/texmf-dist/doc/latex/postnotes/postnotes.tex index 04ea7ccc274..79f77d22cbb 100644 --- a/Master/texmf-dist/doc/latex/postnotes/postnotes.tex +++ b/Master/texmf-dist/doc/latex/postnotes/postnotes.tex @@ -159,10 +159,8 @@ \setlength{\marginparsep}{2\labelsep} \NewDocumentCommand\opt{m}{\texttt{#1}} -% Temporary workaround for 'l3doc' bug. -% https://github.com/latex3/latex3/issues/1111 -% FIXME Remove when fixed upstream. -\NewDocElement[macrolike=false]{Option}{option} + +\NewDocumentCommand\username{m}{`\texttt{#1}'} \begin{document} @@ -284,10 +282,7 @@ for making notes subdivisions, and it places \meta{text} between the notes where it occurs, at the point the notes are printed by \cs{printpostnotes}. For more details and some examples, see \zcref{sec:notes-sections}. Its \meta{options} are presented in \zcref{sec:options}, -\zcref[ref=title,noname]{sec:section-options}. A \cs{postnotesectionx} is -also provided which expands \meta{text} in place (\texttt{x}-type expansion) -before storing it (differently from \cs{postnotesection} which stores -\meta{text} with ``no manipulation''). +\zcref[ref=title,noname]{sec:section-options}. \begin{function}{\printpostnotes} \begin{syntax} @@ -450,14 +445,17 @@ following: \bigskip{} \DescribeOption{mark} % +\DescribeOption{markstr} % By default, the mark generated by \cs{postnote} is determined by the printed representation of the \texttt{postnote} counter, \cs{thepostnote}, which is -stepped when \cs{postnote} is called. But the \opt{mark} option allows you to -manually set it, in case you want, or need, to do so. When \opt{mark} is -manually set, the \texttt{postnote} counter is not stepped. Note that, -differently from the optional argument of \cs{footnote}, this does not need to -be a number, it can receive some text as value, which is directly used as the -mark. +stepped when \cs{postnote} is called. But the \opt{mark} and \opt{markstr} +options allow you to manually set it, in case you want, or need, to do so. +When either \opt{mark} or \opt{markstr} is manually set, the \texttt{postnote} +counter is not stepped. The difference between them is that \opt{mark} must +receive a number as value, and uses its value to also set the \opt{sortnum} +option, while \opt{markstr}, differently from the optional argument of +\cs{footnote}, can receive a string as value which is directly used as the +mark, but it does not set \opt{sortnum}. \DescribeOption{sortnum} % Normally, the sort value used for sorting the notes queue (see the \opt{sort} @@ -468,7 +466,7 @@ manually with the \opt{sortnum} option, typically, when you have also manually specified the mark. It receives a floating point number as value. So, for example, if one needed to insert a note between notes 2 and 3, without disturbing the numbering of other notes, one could use -\texttt{\cs{postnote}[mark=2*,sortnum=2.5]\marg{text}}. +\texttt{\cs{postnote}[markstr=2*,sortnum=2.5]\marg{text}}. \DescribeOption{nomark} % The \opt{nomark} option makes \cs{postnote} inhibit the typesetting of the @@ -503,6 +501,13 @@ available for the first and last note on a given page through the variables is typeset. For details on how to use these variables, see \zcref{sec:headers}. +\DescribeOption{exp} % +By default, \cs{postnotesection} stores its \meta{text} argument with ``no +manipulation''. The \opt{exp} option allows one to fully expand +(\texttt{x}-type expansion) \meta{text} in place before storing it. It is a +boolean option, and the option given with no value is equivalent to +\texttt{exp=true}. + \section{Notes sections} \zlabel{sec:notes-sections} @@ -898,7 +903,7 @@ correctly ordered printed notes (as a result of sorting): \postnote{2} \begin{table}[p] \caption{Table} - Table.\postnote[mark=5,sortnum=5]{3} + Table.\postnote[mark=5]{3} \end{table} \postnote{4} \postnote{5} @@ -965,7 +970,7 @@ provided by (in chronological order): % 2022-04-05: https://tex.stackexchange.com/q/597359#comment1594585_597389 The package's language support have been provided or improved thanks to: - `\texttt{Pika78}' (French) + \username{Pika78} (French) % 2022-04-25: https://github.com/gusbrs/postnotes/issues/1#issuecomment-1108634938 and Herbert Voß (German). % 2022-11-12: https://github.com/gusbrs/postnotes/issues/2 |