Difference between revisions of "Command/definepairedbox"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \definepairedbox") |
|||
(One intermediate revision by the same user not shown) | |||
Line 7: | Line 7: | ||
<cd:arguments> | <cd:arguments> | ||
<cd:keywords ordinal="1"> | <cd:keywords ordinal="1"> | ||
− | <cd:keywordsdoc></cd:keywordsdoc> | + | <cd:keywordsdoc>name of the paired box to be define</cd:keywordsdoc> |
<cd:constant type="cd:name"></cd:constant> | <cd:constant type="cd:name"></cd:constant> | ||
</cd:keywords> | </cd:keywords> | ||
<cd:keywords optional="yes" ordinal="2"> | <cd:keywords optional="yes" ordinal="2"> | ||
− | <cd:keywordsdoc></cd:keywordsdoc> | + | <cd:keywordsdoc>optional parent for inheritance</cd:keywordsdoc> |
<cd:constant type="cd:name"></cd:constant> | <cd:constant type="cd:name"></cd:constant> | ||
</cd:keywords> | </cd:keywords> | ||
Line 21: | Line 21: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description> | + | <cd:description>Using {{cmd|definepairedbox}} defines a setup command and a place command. The place command accepts two content arguments. The first argument is assumed to be a horizontal box, the second argument is vertical mode material. |
+ | |||
+ | See the example below. | ||
</cd:description> | </cd:description> | ||
− | <cd:examples></cd:examples> | + | <cd:examples><cd:example title=""><context source="yes"> |
+ | \definepairedbox[explanation] | ||
+ | |||
+ | \setupexplanation[location=left] | ||
+ | |||
+ | \placeexplanation | ||
+ | {\externalfigure[cow][width=4cm]} | ||
+ | {\starttabulate | ||
+ | \NC 1 \NC head \NC \NR | ||
+ | \NC 2 \NC legs \NC \NR | ||
+ | \NC 3 \NC tail \NC \NR | ||
+ | \stoptabulate} | ||
+ | </context></cd:example></cd:examples> | ||
<cd:notes></cd:notes> | <cd:notes></cd:notes> | ||
<cd:seealso> | <cd:seealso> | ||
<cd:commandref name="setuppairedbox" originator="system"></cd:commandref> | <cd:commandref name="setuppairedbox" originator="system"></cd:commandref> | ||
<cd:source file="pack-com.mkiv" originator="system"></cd:source> | <cd:source file="pack-com.mkiv" originator="system"></cd:source> | ||
− | <cd:wikipage originator="system" page="Category:Tables"></cd:wikipage></cd:seealso> | + | <cd:wikipage originator="system" page="Category:Tables"></cd:wikipage> |
+ | <cd:commandref name="_placepairedbox"></cd:commandref></cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Latest revision as of 14:32, 30 August 2020
Contents
\definepairedbox
Summary
The command \definepairedbox is used for defining a paired set of boxes.
Settings
\definepairedbox[...][...][...=...,...] | |
[...] | name |
[...] | name |
...=...,... | inherits from \setuppairedbox |
Option | Explanation |
---|---|
name of the paired box to be define | |
optional parent for inheritance |
Description
Using \definepairedbox defines a setup command and a place command. The place command accepts two content arguments. The first argument is assumed to be a horizontal box, the second argument is vertical mode material.
See the example below.
Examples
Example 1
\definepairedbox[explanation] \setupexplanation[location=left] \placeexplanation {\externalfigure[cow][width=4cm]} {\starttabulate \NC 1 \NC head \NC \NR \NC 2 \NC legs \NC \NR \NC 3 \NC tail \NC \NR \stoptabulate}