[latex3-commits] [git/LaTeX3-latex3-latex2e] shipout-hook-adjust: typos and the like (a600d41c)
Frank Mittelbach
frank.mittelbach at latex-project.org
Tue Jan 19 22:59:11 CET 2021
Repository : https://github.com/latex3/latex2e
On branch : shipout-hook-adjust
Link : https://github.com/latex3/latex2e/commit/a600d41cedf235686a75d8e80c626154cb6570d7
>---------------------------------------------------------------
commit a600d41cedf235686a75d8e80c626154cb6570d7
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Tue Jan 19 22:59:11 2021 +0100
typos and the like
>---------------------------------------------------------------
a600d41cedf235686a75d8e80c626154cb6570d7
base/ltshipout.dtx | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/base/ltshipout.dtx b/base/ltshipout.dtx
index 9daa89ff..09f5046d 100644
--- a/base/ltshipout.dtx
+++ b/base/ltshipout.dtx
@@ -122,16 +122,17 @@
%
% \begin{function}{\RawShipout}
% This command implements a simplified shipout that bypasses the
-% forground and background
+% foreground and background
% hooks, e.g., only \hook{shipout/firstpage} and
% \hook{shipout/lastpage} are executed and the total shipout
% counters are incremented.
%
% The command doesn't use \cs{ShipoutBox} but its own private box
% register so that it can be used inside of shipout hooks to do
-% some extra shipouts. It does have access to \cs{Shipoutbox}
-% though if it is used in \hook{shipout/before} can use its
-% content.
+% some additional shipouts while already in the output routine with
+% the current page being stored in \cs{ShipoutBox}. It does have
+% access to \cs{ShipoutBox} if it is used in \hook{shipout/before}
+% (or \hook{shipout/after} and can use its content.
%
% It is safe to use it in \hook{shipout/before} or
% \hook{shipout/after} but not necessarily in the other
@@ -274,7 +275,7 @@
% actual shipout. It is even run if there was a
% \cs{DiscardShipoutBox} request in the document.
%
-% The other hooks (except \hook{shipout/after} are added inside
+% The other hooks (except \hook{shipout/after}) are added inside
% hboxes to the box being shipped out in the following order:
% \begin{center}
% \begin{tabular}{ll}
@@ -289,7 +290,7 @@
% added at that point.
%
% Once the (page) box has been shipped out the \hook{shipout/after}
-% hook is called (while you are still inide the output routine). It
+% hook is called (while you are still inside the output routine). It
% is not called if the shipout box was discarded.
%
% In a document that doesn't produce pages, e.g., only makes
@@ -383,7 +384,7 @@
% asynchronously!
%
% Also important: it \emph{must not} be set, only read. There are
-% no provisions to prevent that restricition, but if you manipulate
+% no provisions to prevent that restriction, but if you manipulate
% it, chaos will be the result. To emphasize this fact it is not
% provided as a \LaTeX{} counter but as a \TeX{} counter (i.e., a
% command), so \cs{Alph}\verb={=\cs{ReadonlyShipoutCounter}\verb=}=
@@ -513,7 +514,7 @@
% The kernel alternative is \cs{RawShipout} which is integrated
% with the \LaTeX{} mechanisms and updates, for example, the
% \cs{ReadonlyShipoutCounter} counter. Please use \cs{RawShipout}
-% for new code if you want to bypass the before, forground and
+% for new code if you want to bypass the before, foreground and
% background hooks.
% \end{function}
%
@@ -682,7 +683,7 @@
%
%
% \begin{macro}{\l_@@_raw_box}
-% The \cs{RawShipout} gets it own box but it is internal as there
+% The \cs{RawShipout} gets its own box but it is internal as there
% is no hook manipulation for it.
% \begin{macrocode}
\box_new:N \l_@@_raw_box
@@ -796,7 +797,7 @@
% standard \LaTeX{} output routine but \cs{shipout} might be called
% from a package that has some special processing logic). If it is
% void we aren't shipping anything out and processing ends.\footnote{In that
-% case we don't reset the deadcyles, that would be up to the OR
+% case we don't reset the deadcycles, that would be up to the OR
% processing logic to do.}
% \begin{macrocode}
\cs_new:Npn \@@_execute_main_cont:Nnnn #1#2#3#4 {
@@ -1071,7 +1072,7 @@
% There are three commands to handle the \hook{shipout/firstpage}
% hook:
% \cs{@@_run_firstpage_hook:}, \cs{@@_add_firstpage_specials:} and
-% \cs{@@_drop_firstpage_hook}.
+% \cs{@@_drop_firstpage_specials:}.
%
% That hook is supposed to contain \cs{special}s and similar
% material to be placed at the very beginning of the output page
@@ -1126,7 +1127,7 @@
%
%
%
-% \begin{macro}{\@@_add_firstpage_specials:,\@@_drop_firstpage_hook}
+% \begin{macro}{\@@_add_firstpage_specials:,\@@_drop_firstpage_specials:}
% The \cs{@@_add_firstpage_specials:} then adds the \cs{special}s
% stored in \cs{l_@@_firstpage_box} to the page to be shipped out
% when the time is ready. Note that if there was no material in the
@@ -1145,7 +1146,7 @@
% Adding something to the beginning means adding it to the
% background as that layer is done first in the output.
% \begin{macrocode}
- \@@_add_background_box:n { \hbox_unpack:N \l_@@_firstpage_box }
+ \@@_add_background_box:n { \hbox_unpack_drop:N \l_@@_firstpage_box }
% \end{macrocode}
% After the actual shipout \cs{@@_drop_firstpage_specials:} is
% run to
@@ -1159,7 +1160,7 @@
% \end{macrocode}
%
% The \cs{@@_drop_firstpage_specials:} is run after the shipout has
-% accured but before the \hook{shipout/afterpage} hook is executed.
+% occurred but before the \hook{shipout/afterpage} hook is executed.
% That is the point where we have to restore the \cs{ShipoutBox} to
% its state without the \hook{shipout/firstpage} material.
% \begin{macrocode}
@@ -1868,7 +1869,7 @@
% support gets undone the underlying data is no longer used (and
% sufficiently obscure that it should not interfere with existing
% commands) and properly removing it would mean we need to make the
-% \cs{unclare at ...} and its support macros available in all earlier
+% \cs{undeclare at ...} and its support macros available in all earlier
% kernel releases which is pointless (and actually worse).
%
% \begin{macrocode}
More information about the latex3-commits
mailing list.