[latex3-commits] [latex3/latex2e] latexlab/uf-review-math: docu WIP [ci-skip] (f5bfe7f5)

[github at latex-project.org]

Repository : https://github.com/latex3/latex2e
On branch  : latexlab/uf-review-math
Link       : https://github.com/latex3/latex2e/commit/f5bfe7f5ba7ac3329fb27b5829c0bce3a157ad97

>---------------------------------------------------------------

commit f5bfe7f5ba7ac3329fb27b5829c0bce3a157ad97
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date:   Sat Oct 14 16:17:28 2023 +0200

    docu WIP [ci-skip]


>---------------------------------------------------------------

f5bfe7f5ba7ac3329fb27b5829c0bce3a157ad97
 required/latex-lab/latex-lab-math.dtx | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/required/latex-lab/latex-lab-math.dtx b/required/latex-lab/latex-lab-math.dtx
index 41d0cd11..f4ef1666 100644
--- a/required/latex-lab/latex-lab-math.dtx
+++ b/required/latex-lab/latex-lab-math.dtx
@@ -75,6 +75,19 @@
 % \car*{Todo: update all the documentation! Both here and 
 %   (what little there is!) in the implementation section.}
 %   
+% Tagging math involves a variety of tasks that require that math is captured before the
+% typesetting
+% \begin{itemize} 
+% \item When typesetting the math MC-tags and structure commands must 
+% be inserted at the begin and the end, and perhaps also around lines 
+% or other subparts of the equation.   
+% \item The source and/or a mathml-representation of the source must be available
+% so that it can be (perhaps after some preprocessing) be used in an associated file
+% or in an alternate text
+% \item It must be possible to measure the math for e.g. a bbox setting. 
+% \end{itemize}
+%  
+%
 % This file implements capture of all math mode material at the outer
 % level, i.e., a formula is captured in its entirety with inner text
 % blocks (possibly containing further math) absorbed as part of the
@@ -85,6 +98,9 @@
 % would only result in a single capture of the tokens
 % ``\verb*/a \in A \text{ for all $a<5$}/''.
 %
+% 
+% 
+% \section{Math capture}
 % \subsection{Code level interfaces}
 %
 % \begin{function}{\math_register_env:n, \math_register_env:nn}
@@ -109,7 +125,8 @@
 %   \end{syntax}
 %   Declares that the captured math content should be passed to the
 %   \meta{tokens}, which will receive the environment type as |#1| and
-%   the content as |#2|.
+%   the content as |#2|. The processing is done before the typesetting. It is not
+%   applied if \cs{ifmeasuring@} is true.
 % \end{function}
 %
 % \subsection{Document level interfaces}