summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/postnotes/postnotes.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-02-13 20:53:21 +0000
committerKarl Berry <karl@freefriends.org>2023-02-13 20:53:21 +0000
commit37168a3aca3950d1cc6a939d43aec01fe8805243 (patch)
tree1a9ee88157b5ff26eb6968bd3b0dd3789c8bb190 /Master/texmf-dist/doc/latex/postnotes/postnotes.tex
parentd7404141d7de6c4908735674baf2e9c494e0b29e (diff)
postnotes (13feb23)
git-svn-id: svn://tug.org/texlive/trunk@65820 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.tex67
1 files changed, 36 insertions, 31 deletions
diff --git a/Master/texmf-dist/doc/latex/postnotes/postnotes.tex b/Master/texmf-dist/doc/latex/postnotes/postnotes.tex
index 79f77d22cbb..2496f321219 100644
--- a/Master/texmf-dist/doc/latex/postnotes/postnotes.tex
+++ b/Master/texmf-dist/doc/latex/postnotes/postnotes.tex
@@ -4,7 +4,7 @@
%
% This file is part of the LaTeX package "postnotes".
%
-% Copyright (C) 2022 Gustavo Barros
+% Copyright (C) 2022-2023 Gustavo Barros
%
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -313,7 +313,7 @@ is also provided.
\begin{function}{\postnotesetup}
\begin{syntax}
- \cs{postnotesetup}\oarg{options}
+ \cs{postnotesetup}\marg{options}
\end{syntax}
\end{function}
Package options can be configured by means of \cs{postnotesetup}, which
@@ -540,34 +540,34 @@ expanded in place, but rather stored with ``no manipulation'' to be typeset
later at \cs{printpostnotes}. For this reason, some contextual information is
stored at the place \cs{postnotesection} is called, and made available at the
point it's content gets expanded by means of some variables (you can use
-\cs{postnotesectionx} instead, in which case these variables are of little
-use). When the content of a notes section gets typeset, \cs{pnthechapter}
-contains the value of \cs{thechapter} where \cs{postnotesection} was
-originally called. Similarly, \cs{pnthesection} contains the value of
-\cs{thesection}. \cs{pnthechapternextnote} and \cs{pnthesectionnextnote} are
-meant to support the automation of the notes subdivision by using hooks to
-sectioning commands, which is a quite natural way to do this. However, since
-it may be problematic to hook \emph{after} sectioning commands --
-\cs{section}, for example, figures prominently in the documentation of
-\pkg{ltcmdhooks} as a case of ``look ahead'' command for which the
-\texttt{after} hook is not supported -- we will typically want to hook
-\emph{before} them. But, at this point the values of the \texttt{chapter} or
-\texttt{section} counters have not yet been stepped, therefore \cs{thechapter}
-and \cs{thesection} do not correspond to what we would like to refer to. For
-this reason, \cs{pnthechapternextnote} contains the value of \cs{thechapter}
-at the point the ``next note'' is placed (a \cs{postnote}, that is), the first
-in the chapter, and already inside it, thus with an expected value of the
-\texttt{chapter} counter. Similarly, \cs{pnthesectionnextnote} contains the
-value of \cs{thesection} for the ``next note''. Of course, the ``next note''
-variables are \emph{proxies}, but they are meant to support the automation of
-the subdivision of the notes through the use of \texttt{before} hooks to the
-document's sectioning commands, in which case the subdivision of the notes
-will correspond to the document's structure and, given empty notes sections
-are skipped, the values will be the ones we are interested in. But more
-complex use cases may require something different. Either way, it is up to
-the user to judge whether the \emph{proxy} is a good one for their use case,
-the variables just do what they say, and contain the values of interest for
-the ``next note''.
+\cs{postnotesection}\texttt{[exp]} instead, in which case these variables are
+of little use). When the content of a notes section gets typeset,
+\cs{pnthechapter} contains the value of \cs{thechapter} where
+\cs{postnotesection} was originally called. Similarly, \cs{pnthesection}
+contains the value of \cs{thesection}. \cs{pnthechapternextnote} and
+\cs{pnthesectionnextnote} are meant to support the automation of the notes
+subdivision by using hooks to sectioning commands, which is a quite natural
+way to do this. However, since it may be problematic to hook \emph{after}
+sectioning commands -- \cs{section}, for example, figures prominently in the
+documentation of \pkg{ltcmdhooks} as a case of ``look ahead'' command for
+which the \texttt{after} hook is not supported -- we will typically want to
+hook \emph{before} them. But, at this point the values of the
+\texttt{chapter} or \texttt{section} counters have not yet been stepped,
+therefore \cs{thechapter} and \cs{thesection} do not correspond to what we
+would like to refer to. For this reason, \cs{pnthechapternextnote} contains
+the value of \cs{thechapter} at the point the ``next note'' is placed (a
+\cs{postnote}, that is), the first in the chapter, and already inside it, thus
+with an expected value of the \texttt{chapter} counter. Similarly,
+\cs{pnthesectionnextnote} contains the value of \cs{thesection} for the ``next
+note''. Of course, the ``next note'' variables are \emph{proxies}, but they
+are meant to support the automation of the subdivision of the notes through
+the use of \texttt{before} hooks to the document's sectioning commands, in
+which case the subdivision of the notes will correspond to the document's
+structure and, given empty notes sections are skipped, the values will be the
+ones we are interested in. But more complex use cases may require something
+different. Either way, it is up to the user to judge whether the \emph{proxy}
+is a good one for their use case, the variables just do what they say, and
+contain the values of interest for the ``next note''.
This is meant to be simple. Some examples might make things more concrete.
At its most basic, \cs{postnotesection} can just be set manually:
@@ -963,11 +963,16 @@ provided by (in chronological order):
% 2022-03-28: https://chat.stackexchange.com/transcript/message/60754383#60754383
% 2022-03-31: https://github.com/latex3/hyperref/issues/230
% 2022-04-09: https://github.com/latex3/hyperref/issues/229
+ % 2023-02-10: https://chat.stackexchange.com/transcript/message/62955941#62955941 (and discussion)
David Carlisle,
% 2022-03-28: https://chat.stackexchange.com/transcript/message/60754383#60754383
% 2022-04-08: https://tex.stackexchange.com/a/640035 (comments)
- and Moritz Wemheuer.
+ % 2023-02-10: https://chat.stackexchange.com/transcript/message/62955941#62955941 (and discussion)
+ % 2023-02-10: https://tex.stackexchange.com/a/674846
+ Moritz Wemheuer,
% 2022-04-05: https://tex.stackexchange.com/q/597359#comment1594585_597389
+ and Joseph Wright.
+ % 2023-02-10: https://chat.stackexchange.com/transcript/message/62955941#62955941 (and discussion)
The package's language support have been provided or improved thanks to:
\username{Pika78} (French)