[latex3-commits] [latex3/latex2e] latex-lab/uf-review-05: math docu improvements (96d4d07c)

[github at latex-project.org]

Repository : https://github.com/latex3/latex2e
On branch  : latex-lab/uf-review-05
Link       : https://github.com/latex3/latex2e/commit/96d4d07c530e3966e8fd1d538fa5429d15388f78

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

commit 96d4d07c530e3966e8fd1d538fa5429d15388f78
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date:   Wed Nov 8 23:56:46 2023 +0100

    math docu improvements


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

96d4d07c530e3966e8fd1d538fa5429d15388f78
 required/latex-lab/latex-lab-math.dtx | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/required/latex-lab/latex-lab-math.dtx b/required/latex-lab/latex-lab-math.dtx
index fd04395c..9f8dfe14 100644
--- a/required/latex-lab/latex-lab-math.dtx
+++ b/required/latex-lab/latex-lab-math.dtx
@@ -75,6 +75,18 @@
 % \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 +97,7 @@
 % 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 +122,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}
@@ -143,7 +157,6 @@
 %   \item Similar incorrect grabbing with |$$| also.
 %   \item The grabbing, for all the display environments (and |\) \]|), needs
 %       to deal with nesting: \pkg{amsmath} contains code for this.  
-%   \item 
 % \end{enumerate} 
 %
 % \subsection{Other problems}
@@ -160,7 +173,7 @@
 %  \car*{Joseph wrote, inter alia:\\
 %      My thinking [regarding] \cs{RegisterMathEnvironment}\\
 %    - (New) Math environments should not be created-then-patched, but only
-%    generated by a [(future)] dedicated command (\cs{DeclareMathEnviornment}, 
+%    generated by a [(future)] dedicated command (\cs{DeclareMathEnvironment}, 
 %    presumably)\\
 %    - Math environments created with \pkg{ltcmd} [commands] should not be copied, . . .\\
 %    - Package authors should be able to manually set up math environments with a public boolean.}