[latex3-commits] [git/LaTeX3-latex3-latex3] master: xbox: Document code-level parbox interface (127224631)

[Joseph Wright]

Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/12722463138e72405cd4d7e30e77fc6315a8c472

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

commit 12722463138e72405cd4d7e30e77fc6315a8c472
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Tue Aug 25 14:08:29 2020 +0100

    xbox: Document code-level parbox interface


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

12722463138e72405cd4d7e30e77fc6315a8c472
 l3trial/xbox/xbox.dtx | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/l3trial/xbox/xbox.dtx b/l3trial/xbox/xbox.dtx
index 2ef263a4a..0d8916821 100644
--- a/l3trial/xbox/xbox.dtx
+++ b/l3trial/xbox/xbox.dtx
@@ -378,6 +378,42 @@
 % \end{function}
 %
 % \begin{function}
+%   {\xbox_parbox_to_wd:nnn, \xbox_parbox_to_wd_and_ht:nnnnn}
+%   \begin{syntax}
+%     \cs{xbox_parbox_to_wd:nnn} \Arg{width} \Arg{position} \Arg{content}
+%     \cs{xbox_parbox_to_wd_and_ht:nnnnn} \Arg{width} \Arg{height} \Arg{position} \Arg{inner position} \Arg{content}
+%   \end{syntax}
+%   Typesets the \meta{content} in a vertical mode inserted at the current
+%   reference point. Line breaks will occur, and any \cs{par} tokens in
+%   the \meta{content} act in the normal way. The \meta{position} aligns the
+%   box in the following way
+%   \begin{itemize}
+%     \item[b] the baseline of the bottom line of the box lines up with the
+%       current reference point (\TeX{} \tn{vbox})
+%     \item[c] the middle of the box lines up with the math axis of the
+%       current line (\TeX{} \tn{vcenter}-like) (the standard setting)
+%     \item[t] the baseline of the top line of the box lines up with the
+%       current reference point (\TeX{} \tn{vtop})
+%   \end{itemize}
+%   In contrast to the \LaTeXe{} implementation, math mode is not used to
+%   insert vertically-centered material.
+%
+%   The \meta{height} sets the height of the box, within which the \meta{inner
+%   position} may be used to control text placement within the box
+%   \begin{itemize}
+%     \item[c] vertically centered (the standard setting),
+%     \item[b] flush to the bottom of the box,
+%     \item[t] flush to the top of the box,
+%     \item[s] interline space stretched or shrunk to fill the \meta{height}
+%       (if possible),
+%   \end{itemize}
+%
+%   At the start of the box, the \LaTeXe{} command \tn{@parboxrestore}
+%   is called. This resets  number of line-breaking commands, as described in
+%   the \LaTeXe{} documentation. The \tn{hsize} is also set to \meta{width}.
+% \end{function}
+%
+% \begin{function}
 %   {
 %     \xbox_raise:nn,
 %     \xbox_raise_with_ht:nnn,