diff options
Diffstat (limited to 'macros/latex/contrib/postnotes/postnotes.tex')
-rw-r--r-- | macros/latex/contrib/postnotes/postnotes.tex | 71 |
1 files changed, 40 insertions, 31 deletions
diff --git a/macros/latex/contrib/postnotes/postnotes.tex b/macros/latex/contrib/postnotes/postnotes.tex index eab8f438ed..c47a9d9cdf 100644 --- a/macros/latex/contrib/postnotes/postnotes.tex +++ b/macros/latex/contrib/postnotes/postnotes.tex @@ -278,7 +278,10 @@ 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}. +\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''). \begin{function}{\printpostnotes} \begin{syntax} @@ -525,33 +528,35 @@ Just like with \cs{postnote}, the contents of \cs{postnotesection} are not 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. 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''. +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''. This is meant to be simple. Some examples might make things more concrete. At its most basic, \cs{postnotesection} can just be set manually: @@ -820,9 +825,9 @@ don't have to worry about them. These strings will automatically adjust to the document language, set either by \pkg{babel} or by \pkg{polyglossia}, \emph{if} the language is supported by -\pkg{postnotes}. Currently supported are English and Portuguese, and their -variants. Either way, you can always change these variables to the values of -your preference. If you are not using either \pkg{babel} or +\pkg{postnotes}. Currently supported are English, French, Portuguese, and +their variants. Either way, you can always change these variables to the +values of your preference. If you are not using either \pkg{babel} or \pkg{polyglossia}, you can do so directly, for example, with: \begin{pnsnippet} \renewcommand*{\pntitle}{My title} @@ -953,6 +958,10 @@ provided by (in chronological order): and Moritz Wemheuer. % 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). + % 2022-04-25: https://github.com/gusbrs/postnotes/issues/1#issuecomment-1108634938 + If I have inadvertently left anyone off the list I apologize, and please let me know, so that I can correct the oversight. |