Difference between revisions of "Command/setupframed"
< Command
Jump to navigation
Jump to search
Line 4: | Line 4: | ||
</cd:shortdesc> | </cd:shortdesc> | ||
<cd:variants> | <cd:variants> | ||
− | <cd:command category="rules" file="pack-rul.mkiv" interfacedate=" | + | <cd:command category="rules" file="pack-rul.mkiv" interfacedate="2021-03-02T11:08" interfacefile="i-framed.xml" keywords="background" level="style" name="setupframed" variantnumber="1"> |
<cd:arguments> | <cd:arguments> | ||
<cd:keywords list="yes" optional="yes" ordinal="1"> | <cd:keywords list="yes" optional="yes" ordinal="1"> | ||
− | <cd:keywordsdoc> | + | <cd:keywordsdoc></cd:keywordsdoc> |
<cd:constant type="cd:name"></cd:constant> | <cd:constant type="cd:name"></cd:constant> | ||
</cd:keywords> | </cd:keywords> | ||
Line 111: | Line 111: | ||
<cd:paramdoc></cd:paramdoc> | <cd:paramdoc></cd:paramdoc> | ||
<cd:constant type="foreground"></cd:constant> | <cd:constant type="foreground"></cd:constant> | ||
− | <cd:constant type="color">a color, to be set with <cd:iref name="backgroundcolor"/> | + | <cd:constant type="color">a color, to be set with <cd:iref name="backgroundcolor"/></cd:constant> |
<cd:constant type="cd:name">a named background ??</cd:constant> | <cd:constant type="cd:name">a named background ??</cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 118: | Line 118: | ||
<cd:constant type="frame"></cd:constant> | <cd:constant type="frame"></cd:constant> | ||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
+ | </cd:parameter> | ||
+ | <cd:parameter name="backgroundcolor"> | ||
+ | <cd:paramdoc></cd:paramdoc> | ||
+ | <cd:constant name="cd:color"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="component"> | <cd:parameter name="component"> | ||
Line 275: | Line 279: | ||
<cd:paramdoc></cd:paramdoc> | <cd:paramdoc></cd:paramdoc> | ||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
+ | </cd:parameter> | ||
+ | <cd:parameter name="linedirection"> | ||
+ | <cd:paramdoc></cd:paramdoc> | ||
+ | <cd:constant default="yes" type="normal"></cd:constant> | ||
+ | <cd:constant type="reverse"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
</cd:assignments> | </cd:assignments> |
Revision as of 11:38, 29 October 2021
Contents
\setupframed
Summary
Settings
\setupframed[...,...][...=...,...] | |
[...,...] | name |
corner | rectangular round number |
framecorner | rectangular round number |
backgroundcorner | rectangular round number |
radius | dimension |
frameradius | dimension |
backgroundradius | dimension |
depth | dimension |
framedepth | dimension |
backgrounddepth | dimension |
framecolor | color |
topframe | on off small name |
bottomframe | on off small name |
leftframe | on off small name |
rightframe | on off small name |
region | yes no |
rulethickness | dimension |
frameoffset | dimension |
frame | on off overlay small closed none |
background | foreground color name |
backgroundoffset | frame dimension |
backgroundcolor | |
component | name |
extras | command |
foregroundstyle | style command |
foregroundcolor | color |
setups | name |
offset | default overlay none dimension |
width | local fit max broad fixed dimension |
height | fit max broad dimension |
minheight | dimension |
align | see \setupalign |
strut | yes no none local global |
autostrut | yes no |
location | height depth high low top middle bottom line lohi hanging keep formula mathematics normal |
autowidth | yes no force |
lines | number |
top | command |
bottom | command |
blank | yes no |
profile | name |
empty | yes no |
loffset | dimension |
roffset | dimension |
toffset | dimension |
boffset | dimension |
orientation | number |
anchoring | normal up down left right top bottom name |
xanchor | dimension |
yanchor | dimension |
linedirection | normal reverse |
Option | Explanation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
corner |
| ||||||||||
framecorner |
| ||||||||||
backgroundcorner |
| ||||||||||
radius |
| ||||||||||
frameradius |
| ||||||||||
backgroundradius |
| ||||||||||
rulethickness |
| ||||||||||
frameoffset |
| ||||||||||
frame |
| ||||||||||
background |
| ||||||||||
backgroundoffset |
| ||||||||||
offset |
| ||||||||||
width |
| ||||||||||
height |
| ||||||||||
align |
| ||||||||||
location |
| ||||||||||
empty |
| ||||||||||
loffset |
| ||||||||||
roffset |
| ||||||||||
toffset |
| ||||||||||
boffset |
|
Description
Set the default parameters for \framed. The \framed command produces a box with (optionally) a frame, certain dimensions, a background, etc.
Examples
corner option values
This option determines whether or not the corners are round. It also allows drawing only selected corners.
Default value: rectangular | |
Most common alternative: round | |
Other values: any number between 0 and 28 |