[latex3-commits] [latex3/latex2e] UF-latex-lab-footnote-cleanup: improve docu (9732f9d8)
github at latex-project.org
github at latex-project.org
Mon Sep 30 20:35:28 CEST 2024
Repository : https://github.com/latex3/latex2e
On branch : UF-latex-lab-footnote-cleanup
Link : https://github.com/latex3/latex2e/commit/9732f9d867c078b227e2a61aab927a3e6c554c80
>---------------------------------------------------------------
commit 9732f9d867c078b227e2a61aab927a3e6c554c80
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date: Mon Sep 30 20:35:28 2024 +0200
improve docu
>---------------------------------------------------------------
9732f9d867c078b227e2a61aab927a3e6c554c80
required/latex-lab/latex-lab-footnotes.dtx | 41 ++++++++++++++++++++++--------
1 file changed, 31 insertions(+), 10 deletions(-)
diff --git a/required/latex-lab/latex-lab-footnotes.dtx b/required/latex-lab/latex-lab-footnotes.dtx
index 7a7d72ad..d285ff56 100644
--- a/required/latex-lab/latex-lab-footnotes.dtx
+++ b/required/latex-lab/latex-lab-footnotes.dtx
@@ -228,7 +228,8 @@
%
% To cater for different layout configurations there are four
% sockets that can be set by a package or
-% class but there should be only one per document setting them, i.e., if two packages/classes set them they are mutually
+% class but there should be only one per document setting them,
+% i.e., if two packages/classes set them they are mutually
% incompatible (or rather the last one wins most likely).
% These are:
% \begin{description}
@@ -496,6 +497,12 @@
%
% \DescribeSocket[noprint]{tagsupport/fnmark}
%
+% The socket is used in \cs{@footnotemark}/\cs{fnote_footnotemark:}
+% and takes \cs{@makefnmark} as argument. It prints the mark in the text
+% and surrounds it with a tagging structure and a link. As such it is
+% not solely for tagging and so should not be used with \cs{UseTaggingSocket}
+% as this would swallow the argument and loose the link support.
+%
% \fmi{describe and decide on names}
%
%
@@ -503,31 +510,45 @@
%
% \DescribeSocket[noprint]{tagsupport/fntext/begin}
%
+% This socket is used before the main processing socket
+% (so before the \cs{insert} command). It opens the FEnote structure.
+% As it sets also the tl-var for the current structure and this is used
+% in destinations it should not use as tagging socket.
+%
%
% \item[\socket{tagsupport/fntext/end} (no argument)]
%
% \DescribeSocket[noprint]{tagsupport/fntext/end}
%
+% This socket is used after the main processing socket
+% (so after the \cs{insert} command). It closes the FEnote structure.
%
% \item[\socket{tagsupport/fntext/mark} (1 argument)]
%
% \DescribeSocket[noprint]{tagsupport/fntext/mark}
%
+% This socket is used around the mark in the footnote text.
+% It adds tagging support but also link support, so like the other
+% tagsupport sockets it should be always active.
%
% \item[\socket{tagsupport/fntext/text} (1 argument)]
%
% \DescribeSocket[noprint]{tagsupport/fntext/text}
%
+% This socket handles mc-chunks around the text of the footnote. As it
+% takes an argument (the text) is should not be use as tagging socket either.
%
% \end{description}
%
%
% The \emph{footnotemark} should create a \texttt{/Lbl} structure\footnote{to make it easier
-% to identify the role we use \texttt{/footnotemark} which we rolemap to \texttt{/Lbl}} that should contain a \texttt{/Ref} entry pointing
+% to identify the role we use \texttt{/footnotemark} which we rolemap to \texttt{/Lbl}}
+% that should contain a \texttt{/Ref} entry pointing
% to the structure of the \emph{footnotetext}.
%
-% The \emph{footnotetext} should create a \texttt{/FENote}\footnote{We tag it as \texttt{/footnote} and role map it.}
-% structure with a \texttt{/Ref}
+% The \emph{footnotetext} should create a \texttt{/FENote}%
+% \footnote{We tag it as \texttt{/footnote} and role map it.}
+% structure with a \texttt{/Ref}
% entry pointing to the structures of \emph{all} marks related to the note.
% The mark at the begin of the
% note is in a \texttt{/Lbl}\footnote{We tag it as \texttt{/footnotelabel}.}
@@ -582,8 +603,8 @@
% with their own structure number as a key in a property.
%
% A following \cs{footnotetext} compares its own \cs{@thefnmark} with the values in
-% the prop. If there is a match it stores the structure numbers and removes the entries
-% from the properties (so in a normal document the property will never contain more than
+% the prop. If there is one or more match it stores the structure numbers and removes the entries
+% from the property (so in a normal document the property will never contain more than
% a few entries).
%
% This works well as long as the \cs{footnotemark} commands are issued before the \cs{footnotetext} and
@@ -626,9 +647,9 @@
%
% \subsubsection{\cs{footref}}
%
-% \cs{footref} use internally the same command to set the mark as \cs{footnotemark}, it only
+% \cs{footref} uses internally the same command to set the mark as \cs{footnotemark}, it only
% defines \cs{@thefnmark} differently. This \cs{@thefnmark} is not suitable for the method described
-% above, as it contains a reference command it can't be used to match a note, also \cs{footref} can
+% above: as it contains a reference command it can't be used to match a note, also \cs{footref} can
% be used after the note has already been set. \cs{footref} disables therefore the automatic detection.
%
% Instead the \cs{label} command is
@@ -672,7 +693,7 @@
%
% A \cs{footnotetext} creates a bunch of destinations (in most cases this sums up to
% two destinations): one for every structure number in the \texttt{/Ref} (used as target
-% by the mark commands) and one for the structure number of the footnotetest itself
+% by the mark commands) and one for the structure number of the footnotetext itself
% (used as target by \cs{footref}s commands).
%
% \subsection{Implementation details regarding tagging}
@@ -900,7 +921,7 @@
% to a label inside the note.
% \begin{macrocode}
\tl_new:N \l_@@_currentstruct_tl
-\tl_set:Nn \l_@@_currentstruct_tl {1}
+\tl_set:Nn \l_@@_currentstruct_tl {2}
% \end{macrocode}
%
%
More information about the latex3-commits
mailing list.