[latex3-commits] [git/LaTeX3-latex3-latex2e] shipout-hook-adjust: more documentation on \ShipoutBox [ci skip] (98b56b02)

[Frank Mittelbach]

Repository : https://github.com/latex3/latex2e
On branch  : shipout-hook-adjust
Link       : https://github.com/latex3/latex2e/commit/98b56b021cab6c9f7de4c333aa732c40e6514cbb

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

commit 98b56b021cab6c9f7de4c333aa732c40e6514cbb
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Wed Jan 13 11:22:33 2021 +0100

    more documentation on \ShipoutBox [ci skip]


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

98b56b021cab6c9f7de4c333aa732c40e6514cbb
 base/ltshipout.dtx | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/base/ltshipout.dtx b/base/ltshipout.dtx
index 980bff3e..70f5c126 100644
--- a/base/ltshipout.dtx
+++ b/base/ltshipout.dtx
@@ -139,6 +139,19 @@
 %  \begin{variable}{\ShipoutBox,\l_shipout_box}
 %    This box register is called \cs{ShipoutBox} (alternatively
 %    available via the L3 name \cs{l_shipout_box}).
+%
+%    During the execution of \hook{shipout/before} this box contains
+%    the accumulated material for the page, but not yet any material
+%    added by other shipout hooks.
+%    During execution of \hook{shipout/after}, i.e., after the shipout
+%    has happened, the box also contains any background or foreground
+%    material.
+%
+%    Material from the hooks \hook{shipout/firstpage} or
+%    \hook{shipout/lastpage} is not included (but only used during the
+%    actual shipout) to facilitate reuse of the box data (e.g.,
+%    \hook{shipout/firstpage} material should never be added to a
+%    later page of the output).
 %  \end{variable}
 %
 %