xcoffins.pdf. - CTAN

The xcoffins package
Design-level coffins ∗
The L ATEX3 Project †
Released 2012/07/29
1 Introduction: the coffin concept
In L ATEX3 terminology, a “coffin” is a box containing typeset material. Along with the
box itself, the coffin structure includes information on the size and shape of the box,
which makes it possible to align two or more coffins easily. This is achieved by providing
a series of ‘poles’ for each coffin. These are horizontal and vertical lines through the coffin
at defined positions, for example the top or horizontal centre. The points where these
poles intersect are called “handles”. Two coffins can then be aligned by describing the
relationship between a handle on one coffin with a handle on the second. In words, an
example might then read
Align the top-left handle of coffin A with the bottom-right handle of coffin B.
The locations of coffin handles are much easier to understand visually. Figure 1
shows the standard handle positions for a coffin typeset in horizontal mode (left) and in
vertical mode (right). Notice that the later case results in a greater number of handles
being available. As illustrated, each handle results from the intersection of two poles.
For example, the centre of the coffin is marked (hc,vc), i.e. it is the point of intersection
of the horizontal centre pole with the vertical centre pole. New handles are generated
automatically when poles are added to a coffin: handles are “dynamic” entities.
∗ This file describes v4029, last revised 2012/07/29.
† E-mail: latex-team@latex-project.org
(l,t)
(l,vc)
(l,H)
(l,b)
(hc,t)
(hc,vc)
(hc,H)
(hc,b)
(r,t)
(r,vc)
(r,H)
(r,b)
(l,t)
(l,T)
(l,vc)
(l,H)
(l,b)
(hc,t)
(hc,T)
(hc,vc)
(hc,H)
(hc,b)
Figure 1: Standard coffin handles: left, horizontal coffin; right, vertical coffin
1
(r,t)
(r,T)
(r,vc)
(r,H)
(r,b)

\NewCoffin
\SetHorizontalCoffin
\SetVerticalCoffin
2 Creating and setting coffins
Before any alignment can take place, coffins must be created and their contents must
be created. All coffin operations are local to the current TEX group with the exception
of coffin creation. Coffins are also “colour safe”: in contrast to the code-level \box_...
functions there is no need to add additional grouping to coffins when dealing with colour.
\NewCoffin 〈coffin〉
Before a 〈coffin〉 can be used, it must be allocated using \NewCoffin. The name of the
〈coffin〉 should be a control sequence (starting with the escape character, usually \), for
example
\NewCoffin\MyCoffin
Coffins are allocated globally, and an error will be raised if the name of the 〈coffin〉 is
not globally-unique.
\SetHorizontalCoffin 〈coffin〉 {〈material〉}
Typesets the 〈material〉 in horizontal mode, storing the result in the 〈coffin〉. The standard
poles for the 〈coffin〉 are then set up based on the size of the typeset material.
\SetVerticalCoffin 〈coffin〉 {〈width〉} {〈material〉}
Typesets the 〈material〉 in vertical mode constrained to the given 〈width〉 and stores the
result in the 〈coffin〉. The standard poles for the 〈coffin〉 are then set up based on the
size of the typeset material.
3 Controlling coffin poles
A number of standard poles are automatically generated when the coffin is set or an
alignment takes place. The standard poles for all coffins are:
l a pole running along the left-hand edge of the bounding box of the coffin;
hc a pole running vertically through the centre of the coffin half-way between the leftand
right-hand edges of the bounding box (i.e. the “horizontal centre”);
r a pole running along the right-hand edge of the bounding box of the coffin;
b a pole running along the bottom edge of the bounding box of the coffin;
vc a pole running horizontally through the centre of the coffin half-way between the
bottom and top edges of the bounding box (i.e. the “vertical centre”);
t a pole running along the top edge of the bounding box of the coffin;
H a pole running along the baseline of the typeset material contained in the coffin.
2

\SetHorizontalPole
\SetVerticalPole
\TotalHeight
\Height
In addition, coffins containing vertical-mode material also feature poles which reflect the
richer nature of these systems:
B a pole running along the baseline of the material at the bottom of the coffin.
T a pole running along the baseline of the material at the top of the coffin.
\SetHorizontalPole 〈coffin〉 {〈pole〉} {〈offset〉}
Sets the 〈pole〉 to run horizontally through the 〈coffin〉. The 〈pole〉 will be located at the
〈offset〉 from the bottom edge of the bounding box of the 〈coffin〉. The 〈offset〉 should
be given as a dimension expression; this may include the terms \TotalHeight, \Height,
\Depth and \Width, which will evaluate to the appropriate dimensions of the 〈coffin〉.
For example, to create a pole running horizontally through the coffin at one third of the
distance from the base of the coffin to the top, the appropriate instruction would be
\SetHorizontalPole \MyCoffin {height/3} {\TotalHeight/3}
Note that poles which run horizontally are described in terms of their vertical location
in the coffin. Also notice that the total height of the coffin is described by the sum
of \Height and \Depth: these are both measured from the horizontal baseline of the
material in the coffin.
\SetVerticalPole 〈coffin〉 {〈pole〉} {〈offset〉}
Sets the 〈pole〉 to run vertically through the 〈coffin〉. The 〈pole〉 will be located at the
〈offset〉 from the left-hand edge of the bounding box of the 〈coffin〉. The 〈offset〉 should
be given as a dimension expression; this may include the terms \TotalHeight, \Height,
\Depth and \Width, which will evaluate to the appropriate dimensions of the 〈coffin〉.
For example, to create a pole running vertically through the coffin at one third of the
distance from the left-hand edge, the appropriate instruction would be
\SetVerticalPole \MyCoffin {width/3} {\Width/3}
Note that poles which run vertically are described in terms of their horizontal location
in the coffin.
\TotalHeight
Within the 〈offset〉 argument of \SetHorizontalPole and \SetVerticalPole, \TotalHeight
will give the distance from the base to the top of the bounding box of the relevant coffin.
\Height
Within the 〈offset〉 argument of \SetHorizontalPole and \SetVerticalPole, \Height
will give the distance from the baseline to the top of the bounding box of the relevant
coffin.
3

\Depth
\Width
\RotateCoffin
\ResizeCoffin
\ScaleCoffin
\Depth
(l,t)
(l,vc)
(l,H)
(l,b)
(hc,t)
(hc,vc)
(hc,H)
(hc,b)
(r,t)
(r,vc)
(r,H)
(r,b)
(l,t)
(l,vc)
(hc,t)
(hc,vc)
(l,H)
(l,b)
(r,t)
(r,vc)
(hc,H)
(hc,b)
(r,H)
(r,b)
Figure 2: Coffin rotation: left, unrotated; right, rotated by 45°.
Within the 〈offset〉 argument of \SetHorizontalPole and \SetVerticalPole, \Depth
will give the distance from the baseline to the bottom of the bounding box of the relevant
coffin.
\Width
Within the 〈offset〉 argument of \SetHorizontalPole and \SetVerticalPole, \Width
will give the distance from the right edge to the left edge of the bounding box of the
relevant coffin.
4 Rotating coffins
\RotateCoffin 〈coffin〉 {〈angle〉}
Rotates the 〈coffin〉 by the given 〈angle〉 about its reference point (given in degrees
counter-clockwise) . This process will rotate both the coffin content and poles. Multiple
rotations will not result in the bounding box of the coffin growing unnecessarily.
The effect of rotation on a coffin is illustrated in Figure 2. As is shown, the coffin
handles will remain correctly positioned relative to the content of the coffin. The “top”
of a rotated coffin may of course no longer be the edge closest to the top of the physical
page.
5 Resizing coffins
\ResizeCoffin 〈coffin〉 {〈width〉} {〈total-height〉}
Resized the 〈coffin〉 to 〈width〉 and 〈total-height〉, both of which should be given as dimension
expressions.
\ScaleCoffin 〈coffin〉 {〈x-scale〉} {〈y-scale〉}
Scales the 〈coffin〉 by a factors 〈x-scale〉 and 〈y-scale〉 in the horizontal and vertical
directions, respectively. The two scale factors should be given as real numbers.
4

\JoinCoffins
(l,t)
(l,vc)
(l,H)
(l,b)
(hc,t)
(hc,vc)
(hc,H)
(hc,b)
(r,t)
(r,vc)
(r,H)
(r,b)
(l,t)
(l,vc)
(l,H)
(l,b)
Figure 3: Coffin resizing: left, resized to exactly 4 cm by 6 cm; right, scaled a factors of
2 and 0.5 in x and y, respectively (example coffin as in Figure 2).
\ResizeCoffin and \ScaleCoffin can be used interchangeably: whether scale factors
or absolute values are the best form for the resizing will depend upon the context
(Figure 3).
6 Joining coffins
The key operation for coffins is joining coffins to each other. This is always carried out
such that the first coffin is the “parent”, and is updated by the alignment. The second
“child” coffin is not altered by the alignment process.
\JoinCoffins *
〈coffin1〉 [ 〈coffin1-pole1〉 , 〈coffin1-pole2〉 ]
〈coffin2〉 [ 〈coffin2-pole1〉 , 〈coffin2-pole2〉 ]
( 〈x-offset〉 , 〈y-offset〉 )
Joining of two coffins is carried out by the \JoinCoffins function, which takes two
mandatory arguments: the “parent” 〈coffin1 〉 and the “child” 〈coffin2 〉. All of the other
arguments shown are optional.
The standard \JoinCoffins functions joins 〈coffin2 〉 to 〈coffin1 〉 such that the
bounding box of 〈coffin1 〉 after the process will expand. The new bounding box will
be the smallest rectangle covering the bounding boxes of the two input coffins. When the
starred variant of \JoinCoffins is used, the bounding box of 〈coffin1 〉 is not altered,
i.e. 〈coffin2 〉 may protrude outside of the bounding box of the updated 〈coffin1 〉. The
difference between the two forms of alignment is best illustrated using a visual example.
In Figure 4, the two processes are contrasted. In both cases, the small red coffin has
been aligned with the large grey coffin. In the left-hand illustration, the \JoinCoffins
function was used, resulting in an expanded bounding box. In contrast, on the right
\AttachCoffin was used, meaning that the bounding box does not include the area of
the smaller coffin.
The alignment is carried out by first calculating 〈handle1 〉, the point of intersection
of 〈coffin1-pole1 〉 and 〈coffin1-pole2 〉, and 〈handle2 〉, the point of intersection of
〈coffin2-pole1 〉 and 〈coffin2-pole2 〉. If the two 〈poles〉 are not specified, \JoinCoffins
will use the default value (H,l), i.e. the reference point used by TEX for the underlying
box. Once the two 〈handles〉 have been located, 〈coffin2 〉 is then attached to
〈coffin1 〉 such that the relationship between 〈handle1 〉 and 〈handle2 〉 is described by the
5
(hc,t)
(hc,vc)
(hc,H)
(hc,b)
(r,t)
(r,vc)
(r,H)
(r,b)

Figure 4: Contrast between \JoinCoffins (left) and \JoinCoffins* (right); the bounding
box of the coffin is show in black.
Figure 5: The effect of rotation of a joined coffin: the black line shows the coffin bounding
box.
〈x-offset〉 and 〈y-offset〉. This 〈offset〉 is an optional argument, and if it is not given then
(0 pt, 0 pt) is used.
Notice that when \JoinCoffins is used the new bounding box is the smallest rectangle
containing the bounding boxes of the two input coffins. As a result, it will include
additional white space unless one coffin entirely overlaps the other (Figure 5, left).
Rotation of coffins will take account of the extent of the material after rotation when
re-calculating the bounding box. This means that no unnecessary white space will be
added on rotation (Figure 5, right).
As part of the joining procedure, the poles of the two input coffins are preserved
within the structure of the updated coffin. In this way it is possible to carry out complex
alignment procedures. The poles of a coffin after alignment may therefore be divided into
three groups:
1. The “native” poles of the updated coffin, such as l, r, hc, etc.
2. Poles derived from 〈coffin1 〉, such as 〈coffin1〉-l, 〈coffin1〉-r, 〈coffin1〉-hc,
etc.
3. Poles derived from 〈coffin2 〉, such as 〈coffin2〉-l, 〈coffin2〉-r, 〈coffin2〉-hc,
etc.
Applying this ability allows a series of joining operations to take place, as illustrated
in Figure 6. In this example, the scheme used for alignment was as follows:
6

Figure 6: Aligning coffins using poles from previous operations.
\SetHorizontalCoffin\OutputCoffin{}
\SetHorizontalCoffin\RedCoffin
{\color{red!20!white}\rule{0.2 in}{0.2 in}}
\JoinCoffins\OutputCoffin[vc,hc]\RedCoffin[vc,hc]
\SetHorizontalCoffin\BlueCoffin
{\color{blue!20!white}\rule{0.2 in}{0.2 in}}
\JoinCoffins\OutputCoffin[\RedCoffin-vc,\RedCoffin-hc]
\BlueCoffin[b,l]
\SetHorizontalCoffin\GreenCoffin
{\color{green!20!white}\rule{0.2 in}{0.2 in}}
\JoinCoffins\OutputCoffin[\BlueCoffin-vc,\BlueCoffin-hc]
\GreenCoffin[b,l]
\SetHorizontalCoffin\YellowCoffin
{\color{yellow!20!white}\rule{0.2 in}{0.2 in}}
\JoinCoffins\OutputCoffin[\GreenCoffin-vc,\GreenCoffin-hc]
\YellowCoffin[b,l]
\SetHorizontalCoffin \OrangeCoffin
{\color{orange!20!white}\rule{0.2 in}{0.2 in}}
\JoinCoffins\OutputCoffin[\BlueCoffin-t,\BlueCoffin-l]
\OrangeCoffin[b,r]
\TypesetCoffin\OutputCoffin
This process begins by setting up \OutputCoffin to hold the joined output. Each join
then takes place placing the new addition relative to the previous one. As each coffin
joined has a unique name it is possible to align relative to each one of the component
parts of the assembly. This is illustrated by the addition of the final \OrangeCoffin
based on the earlier placement of the \BlueCoffin.
7

\TypesetCoffin
\CoffinDepth
\CoffinHeight
\CoffinTotalHeight
\CoffinWidth
7 Typesetting coffins
\TypesetCoffin
〈coffin〉 [ 〈pole1〉 , 〈pole2〉 ]
( 〈x-offset〉 , 〈y-offset〉 )
Typesetting is carried out by first calculating 〈handle〉, the point of intersection of 〈pole1 〉
and 〈pole2 〉. This is an optional argument, and if not given then (H,l), the TEX reference
point of the underlying box, is used. The coffin is then typeset such that the relationship
between the current reference point in the document and the 〈handle〉 is described by
the 〈x-offset〉 and 〈y-offset〉. This 〈offset〉 is optional, and if not given (0 pt, 0 pt) is
used. Typesetting a coffin is therefore analogous to carrying out an alignment where the
“parent” coffin is the current insertion point.
8 Measuring coffins
There are places in the design process where it is useful to be able to measure coffins
outside of pole-setting procedures.
\CoffinDepth 〈coffin〉
Calculates the depth (below the baseline) of the 〈coffin〉 in a form suitable for use in a
〈dimension expression〉, for example \setlength{\mylength}{\CoffinDepth\ExampleCoffin}.
\CoffinHeight 〈coffin〉
Calculates the height (above the baseline) of the 〈coffin〉 in a form suitable for use in a
〈dimension expression〉, for example \setlength{\mylength}{\CoffinHeight\ExampleCoffin}.
\CoffinTotalHeight 〈coffin〉
Calculates the total height of the 〈coffin〉 in a form suitable for use in a 〈dimension
expression〉, for example \setlength{\mylength}{\CoffinTotalHeight\ExampleCoffin}.
\CoffinWidth 〈coffin〉
Calculates the width of the 〈coffin〉 in a form suitable for use in a 〈dimension expression〉,
for example \setlength{\mylength}{\CoffinWidth\ExampleCoffin}.
9 Diagnostic functions
Diagnostic data for following the coffin-building process is available both graphically and
at the terminal. This reflects the fact that coffins are visual constructs.
8

\DisplayCoffinHandles
\MarkCoffinHandle
\ShowCoffinStructure
\DisplayCoffinHandles 〈coffin〉 {〈colour〉}
This function first calculates the intersections between all of the 〈poles〉 of the 〈coffin〉 to
give a set of 〈handles〉. It then prints the 〈coffin〉 at the current location in the source,
with the position of the 〈handles〉 marked on the coffin. The 〈handles〉 will be labelled
as part of this process: the locations of the 〈handles〉 and the labels are both printed in
the 〈colour〉 specified.
\MarkCoffinHandle 〈coffin〉
[ 〈pole1〉 , 〈pole2〉 ] {〈colour〉}
This function first calculates the 〈handle〉 for the 〈coffin〉 as defined by the intersection
of 〈pole1 〉 and 〈pole2 〉. It then marks the position of the 〈handle〉 on the 〈coffin〉. The
〈handle〉 will be labelled as part of this process: the location of the 〈handle〉 and the
label are both printed in the 〈colour〉 specified. If no 〈poles〉 are give, the default (H,l)
is used.
\ShowCoffinStructure 〈coffin〉
This function shows the structural information about the 〈coffin〉 in the terminal. The
width, height and depth of the typeset material are given, along with the location of all
of the poles of the coffin. For example, for the rotated coffin in Figure 2, the output of
\ShowCoffinStructure is:
Size of coffin \ExampleCoffin:
> ht = 72.26999pt
> dp = 0.0pt
> wd = 72.26999pt
Poles of coffin \ExampleCoffin:
> l => {0pt}{0pt}{0pt}{1000pt}
> B => {0pt}{0pt}{1000pt}{0pt}
> H => {0pt}{0pt}{1000pt}{0pt}
> T => {0pt}{0pt}{1000pt}{0pt}
> hc => {36.135pt}{0pt}{0pt}{1000pt}
> r => {72.26999pt}{0pt}{0pt}{1000pt}
> vc => {0pt}{36.135pt}{1000pt}{0pt}
> t => {0pt}{72.26999pt}{1000pt}{0pt}
> b => {0pt}{0.0pt}{1000pt}{0pt}.
}
Notice that the poles of a coffin are defined by four values: the x and y co-ordinates of a
point that the pole passes through and the x- and y-components of a vector denoting the
direction of the pole. It is the ratio between the later, rather than the absolute values,
which determines the direction of the pole.
10 Implementation
1 〈*package〉
9

\l__coffin_A_hpole_tl
\l__coffin_A_vpole_tl
\l__coffin_B_hpole_tl
\l__coffin_B_vpole_tl
\l__coffin_bound_box_grow_bool
\l__coffin_hoffset_dim
\l__coffin_voffset_dim
\__coffin_design_names:N
\Height
\Depth
\Width
\TotalHeight
\l__coffin_height_dim
\l__coffin_depth_dim
\l__coffin_width_dim
\l__coffin_totalheight_dim
2 〈@@=coffin〉
3 \ProvidesExplPackage
4 {\ExplFileName}{\ExplFileDate}{\ExplFileVersion}{\ExplFileDescription}
Key–value definitions for the alignment system. With the exception of grow-bounding-box,
all of these have to be given with a value.
5 \keys_define:nn { coffin }
6 {
7 coffin1-hpole .tl_set:N = \l__coffin_A_hpole_tl ,
8 coffin1-hpole .value_required: ,
9 coffin1-vpole .tl_set:N = \l__coffin_A_vpole_tl ,
10 coffin1-vpole .value_required: ,
11 coffin2-hpole .tl_set:N = \l__coffin_B_hpole_tl ,
12 coffin2-hpole .value_required: ,
13 coffin2-vpole .tl_set:N = \l__coffin_B_vpole_tl ,
14 coffin2-vpole .value_required: ,
15 grow-bounding-box .bool_set:N = \l__coffin_bound_box_grow_bool ,
16 grow-bounding-box .default:n = true ,
17 hoffset .dim_set:N = \l__coffin_hoffset_dim ,
18 hoffset .value_required: ,
19 voffset .dim_set:N = \l__coffin_voffset_dim ,
20 voffset .value_required:
21 }
22 \keys_set:nn { coffin }
23 {
24 coffin1-hpole = H ,
25 coffin1-vpole = l ,
26 coffin2-hpole = H ,
27 coffin2-vpole = l ,
28 grow-bounding-box = true ,
29 hoffset = 0 pt ,
30 voffset = 0 pt
31 }
(End definition for \l__coffin_A_hpole_tl and others. These variables are documented on page ??.)
Sets up design-level names for the various coffin dimensions. These are not defined
outside of this scope, and are dimensions so that they work correctly inside for example
\fp_eval:n.
32 \cs_new_protected:Npn \__coffin_design_names:N #1
33 {
34 \dim_set:Nn \l__coffin_height_dim { \coffin_ht:N #1 }
35 \dim_set:Nn \l__coffin_depth_dim { \coffin_dp:N #1 }
36 \dim_set:Nn \l__coffin_width_dim { \coffin_wd:N #1 }
37 \dim_set:Nn \l__coffin_totalheight_dim
38 { \l__coffin_height_dim + \l__coffin_depth_dim }
39 \cs_set_eq:NN \Height \l__coffin_height_dim
40 \cs_set_eq:NN \Depth \l__coffin_depth_dim
41 \cs_set_eq:NN \Width \l__coffin_width_dim
42 \cs_set_eq:NN \TotalHeight \l__coffin_totalheight_dim
10

43 }
44 \dim_new:N \l__coffin_height_dim
45 \dim_new:N \l__coffin_depth_dim
46 \dim_new:N \l__coffin_width_dim
47 \dim_new:N \l__coffin_totalheight_dim
(End definition for \__coffin_design_names:N. This function is documented on page ??.)
A lot of this is more-or-less just passing data straight through.
\NewCoffin This is a very easy conversion.
\SetHorizontalCoffin
\SetVerticalCoffin
\SetHorizontalPole
\SetVerticalPole
48 \NewDocumentCommand \NewCoffin { m }
49 { \coffin_new:N #1 }
(End definition for \NewCoffin. This function is documented on page 2.)
These are again straight-forward translations.
50 \NewDocumentCommand \SetHorizontalCoffin { m +m }
51 { \hcoffin_set:Nn #1 {#2} }
52 \NewDocumentCommand \SetVerticalCoffin { m m +m }
53 { \vcoffin_set:Nnn #1 {#2} {#3} }
(End definition for \SetHorizontalCoffin. This function is documented on page 2.)
Here, there is a need to set up the design-level names for coffin dimensions. This requires
grouping, but the coffin work has to occur outside of the group. Hence there is a bit of
expansion trickery.
54 \NewDocumentCommand \SetHorizontalPole { m m m }
55 {
56 \group_begin:
57 \__coffin_design_names:N #1
58 \use:x
59 {
60 \group_end:
61 \coffin_set_horizontal_pole:Nnn #1
62 { \exp_not:n {#2} } { \dim_eval:n {#3} }
63 }
64 }
65 \NewDocumentCommand \SetVerticalPole { m m m }
66 {
67 \group_begin:
68 \__coffin_design_names:N #1
69 \use:x
70 {
71 \group_end:
72 \coffin_set_vertical_pole:Nnn #1
73 { \exp_not:n {#2} } { \dim_eval:n {#3} }
74 }
75 }
(End definition for \SetHorizontalPole. This function is documented on page 3.)
11

\JoinCoffins The \JoinCoffins function needs to do a bit of work on the input syntax, as there are
a number of optional arguments to worry about. The idea here is that \JoinCoffins
can be used to either expand the bounding box of 〈coffin1 〉 or add 〈coffin2 〉 without any
expansion of the bounding box. There are also the two handle positions and the offset
to sort out.
76 \NewDocumentCommand \JoinCoffins
77 {
78 o
79 s
80 m
81 > { \SplitArgument { 1 } { , } } O { H , l }
82 m
83 > { \SplitArgument { 1 } { , } } O { H , l }
84 > { \SplitArgument { 1 } { , } } D ( ) { 0 pt , 0 pt }
85 }
86 {
87 \IfNoValueTF {#1}
88 {
89 \IfBooleanTF #2
90 { \coffin_attach:NnnNnnnn #3 #4 #5 #6 #7 }
91 { \coffin_join:NnnNnnnn #3 #4 #5 #6 #7 }
92 }
93 {
94 \group_begin:
95 \keys_set:nn { coffin } {#1}
96 \tl_set:Nx \l__coffin_tmp_tl
97 {
98 \group_end:
99 \bool_if:NTF \l__coffin_bound_box_grow_bool
100 { \coffin_join:NnnNnnnn }
101 { \coffin_attach:NnnNnnnn }
102 \exp_not:N #3
103 { \exp_not:o { \l__coffin_A_hpole_tl } }
104 { \exp_not:o { \l__coffin_A_vpole_tl } }
105 \exp_not:N #5
106 { \exp_not:o { \l__coffin_B_hpole_tl } }
107 { \exp_not:o { \l__coffin_B_vpole_tl } }
108 { \dim_use:N \l__coffin_hoffset_dim }
109 { \dim_use:N \l__coffin_voffset_dim }
110 }
111 \l__coffin_tmp_tl
112 }
113 }
(End definition for \JoinCoffins. This function is documented on page 5.)
\TypesetCoffin For typesetting coffins there are two optional arguments, both of which need to be split.
This is a simpler case of the code needed for \JoinCoffins.
114 \NewDocumentCommand \TypesetCoffin
115 {
12

\RotateCoffin
\ResizeCoffin
\ScaleCoffin
\CoffinDepth
\CoffinHeight
\CoffinTotalHeigth
\CoffinWidth
116 m
117 > { \SplitArgument { 1 } { , } } O { H , l }
118 > { \SplitArgument { 1 } { , } } D ( ) { 0 pt , 0 pt }
119 }
120 { \coffin_typeset:Nnnnn #1 #2 #3 }
(End definition for \TypesetCoffin. This function is documented on page 8.)
Mores straight-forward copies.
121 \NewDocumentCommand \RotateCoffin { m m }
122 { \coffin_rotate:Nn #1 {#2} }
123 \NewDocumentCommand \ResizeCoffin { m m m }
124 { \coffin_resize:Nnn #1 {#2} {#3} }
125 \NewDocumentCommand \ScaleCoffin { m m m }
126 { \coffin_scale:Nnn #1 {#2} {#3} }
(End definition for \RotateCoffin. This function is documented on page 4.)
Nothing too complex, except that the total height is set up as an expression so that it
will act correctly if prefixed with a negative sign, etc.
127 \NewDocumentCommand \CoffinDepth { m }
128 { \coffin_dp:N #1 }
129 \NewDocumentCommand \CoffinHeight { m }
130 { \coffin_ht:N #1 }
131 \NewDocumentCommand \CoffinTotalHeight { m }
132 { \__dim_eval:w \coffin_ht:N #1 + \coffin_dp:N #1 \__dim_eval_end: }
133 \NewDocumentCommand \CoffinWidth { m }
134 { \coffin_wd:N #1 }
(End definition for \CoffinDepth and others. These functions are documented on page 8.)
\DisplayCoffinHandles Displaying all of the handles is a bit easier, as there is no need to worry about the handle.
135 \NewDocumentCommand \DisplayCoffinHandles { m m }
136 { \coffin_if_exist:NT #1 { \coffin_display_handles:Nn #1 {#2} } }
(End definition for \DisplayCoffinHandles. This function is documented on page 9.)
\MarkCoffinHandle Marking a handle requires a bit of work with the input, so that the design-level interface
is “nice”.
137 \NewDocumentCommand \MarkCoffinHandle
138 { m > { \SplitArgument { 1 } { , } } O { H , l } m }
139 { \coffin_if_exist:NT #1 { \coffin_mark_handle:Nnnn #1 #2 {#3} } }
(End definition for \MarkCoffinHandle. This function is documented on page 9.)
\ShowCoffinStructure Back again to easy-to-implement functions.
140 \NewDocumentCommand \ShowCoffinStructure { m }
141 { \coffin_show_structure:N #1 }
(End definition for \ShowCoffinStructure. This function is documented on page 9.)
142 〈/package〉
13

Index
The italic numbers denote the pages where the corresponding entry is described, numbers
underlined point to the definition, all others indicate the places where it is used.
Symbols
\__coffin_design_names:N . . 32, 32, 57, 68
\__dim_eval:w . . . . . . . . . . . . . . . . . . 132
\__dim_eval_end: . . . . . . . . . . . . . . . 132
B
\bool_if:NTF . . . . . . . . . . . . . . . . . . . . 99
C
\coffin_attach:NnnNnnnn . . . . . . . 90, 101
\coffin_display_handles:Nn . . . . . . . 136
\coffin_dp:N . . . . . . . . . . . . . 35, 128, 132
\coffin_ht:N . . . . . . . . . . . . . 34, 130, 132
\coffin_if_exist:NT . . . . . . . . . . 136, 139
\coffin_join:NnnNnnnn . . . . . . . . . 91, 100
\coffin_mark_handle:Nnnn . . . . . . . . . 139
\coffin_new:N . . . . . . . . . . . . . . . . . . . 49
\coffin_resize:Nnn . . . . . . . . . . . . . . 124
\coffin_rotate:Nn . . . . . . . . . . . . . . 122
\coffin_scale:Nnn . . . . . . . . . . . . . . 126
\coffin_set_horizontal_pole:Nnn . . . . 61
\coffin_set_vertical_pole:Nnn . . . . . 72
\coffin_show_structure:N . . . . . . . . . 141
\coffin_typeset:Nnnnn . . . . . . . . . . . 120
\coffin_wd:N . . . . . . . . . . . . . . . . . 36, 134
\CoffinDepth . . . . . . . . . . . . . . 8, 127, 127
\CoffinHeight . . . . . . . . . . . . . 8, 127, 129
\CoffinTotalHeight . . . . . . . . . . . . 8, 131
\CoffinTotalHeigth . . . . . . . . . . . . . . 127
\CoffinWidth . . . . . . . . . . . . . . 8, 127, 133
\cs_new_protected:Npn . . . . . . . . . . . . 32
\cs_set_eq:NN . . . . . . . . . . . 39, 40, 41, 42
D
\Depth . . . . . . . . . . . . . . . . . . . . . 4, 32, 40
\dim_eval:n . . . . . . . . . . . . . . . . . . 62, 73
\dim_new:N . . . . . . . . . . . . . 44, 45, 46, 47
\dim_set:Nn . . . . . . . . . . . . . 34, 35, 36, 37
\dim_use:N . . . . . . . . . . . . . . . . . 108, 109
\DisplayCoffinHandles . . . . . . 9, 135, 135
E
\exp_not:N . . . . . . . . . . . . . . . . . 102, 105
\exp_not:n . . . . . . . . . . . . . . . . . . 62, 73
14
\exp_not:o . . . . . . . . . . 103, 104, 106, 107
\ExplFileDate . . . . . . . . . . . . . . . . . . . . 4
\ExplFileDescription . . . . . . . . . . . . . . 4
\ExplFileName . . . . . . . . . . . . . . . . . . . . 4
\ExplFileVersion . . . . . . . . . . . . . . . . . 4
G
\group_begin: . . . . . . . . . . . . . . 56, 67, 94
\group_end: . . . . . . . . . . . . . . . . 60, 71, 98
H
\hcoffin_set:Nn . . . . . . . . . . . . . . . . . 51
\Height . . . . . . . . . . . . . . . . . . . . 3, 32, 39
I
\IfBooleanTF . . . . . . . . . . . . . . . . . . . . 89
\IfNoValueTF . . . . . . . . . . . . . . . . . . . . 87
J
\JoinCoffins . . . . . . . . . . . . . . . . 5, 76, 76
K
\keys_define:nn . . . . . . . . . . . . . . . . . . 5
\keys_set:nn . . . . . . . . . . . . . . . . . 22, 95
L
\l__coffin_A_hpole_tl . . . . . . . . 5, 7, 103
\l__coffin_A_vpole_tl . . . . . . . . 5, 9, 104
\l__coffin_B_hpole_tl . . . . . . . 5, 11, 106
\l__coffin_B_vpole_tl . . . . . . . 5, 13, 107
\l__coffin_bound_box_grow_bool 5, 15, 99
\l__coffin_depth_dim . . 32, 35, 38, 40, 45
\l__coffin_height_dim . 32, 34, 38, 39, 44
\l__coffin_hoffset_dim . . . . . . 5, 17, 108
\l__coffin_tmp_tl . . . . . . . . . . . . 96, 111
\l__coffin_totalheight_dim 32, 37, 42, 47
\l__coffin_voffset_dim . . . . . . 5, 19, 109
\l__coffin_width_dim . . . . . 32, 36, 41, 46
M
\MarkCoffinHandle . . . . . . . . . 9, 137, 137
N
\NewCoffin . . . . . . . . . . . . . . . . . 2, 48, 48
\NewDocumentCommand . . . . . . . . . . . 48,
50, 52, 54, 65, 76, 114, 121, 123,
125, 127, 129, 131, 133, 135, 137, 140

P
\ProvidesExplPackage . . . . . . . . . . . . . . 3
R
\ResizeCoffin . . . . . . . . . . . . . 4, 121, 123
\RotateCoffin . . . . . . . . . . . . . 4, 121, 121
S
\ScaleCoffin . . . . . . . . . . . . . . 4, 121, 125
\SetHorizontalCoffin . . . . . . . . . 2, 50, 50
\SetHorizontalPole . . . . . . . . . . . 3, 54, 54
\SetVerticalCoffin . . . . . . . . . . . 2, 50, 52
\SetVerticalPole . . . . . . . . . . . . 3, 54, 65
\ShowCoffinStructure . . . . . . . 9, 140, 140
\SplitArgument . . 81, 83, 84, 117, 118, 138
15
T
\tl_set:Nx . . . . . . . . . . . . . . . . . . . . . 96
\TotalHeight . . . . . . . . . . . . . . . . 3, 32, 42
\TypesetCoffin . . . . . . . . . . . . 8, 114, 114
U
\use:x . . . . . . . . . . . . . . . . . . . . . . 58, 69
V
\vcoffin_set:Nnn . . . . . . . . . . . . . . . . 53
W
\Width . . . . . . . . . . . . . . . . . . . . . 4, 32, 41