Difference between revisions of "Command/setupframed"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \setupframed") |
|||
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"/> {{bug|backgroundcolor is not documented.}}</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 280: | Line 280: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description>Set the default parameters for {{cmd|framed}}. The {{cmd|framed}} command produces a box with (optionally) a frame, certain dimensions, a background, etc. | + | <cd:description>Set the default parameters for {{cmd|framed}}. The {{cmd|framed}} command produces a box with (optionally) a frame, certain dimensions, a background, etc. |
</cd:description> | </cd:description> | ||
− | <cd:examples><cd:example title="corner option values">This option determines whether or not the corners are round. It also allows drawing only selected corners. | + | <cd:examples><cd:example title="corner option values">This option determines whether or not the corners are round. It also allows drawing only selected corners. |
− | {| cellpadding="10" | + | {| cellpadding="10" |
| Default value: '''rectangular''' | | Default value: '''rectangular''' | ||
| <context>\setuppapersize[A5]\framed[corner=rectangular]{corner=rectangular}</context> | | <context>\setuppapersize[A5]\framed[corner=rectangular]{corner=rectangular}</context> |
Revision as of 08:43, 30 August 2020
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
The name of an instance of framed. Not needed for the \framed command itself. | |||||||||||
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 |