Command/setupframed

From Wiki
< Command
Revision as of 08:43, 30 August 2020 by Taco (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


\setupframed

Summary

The command \setupframed is used for configuring \framed and instances of framed

Settings

\setupframed[...,...][...=...,...]
[...,...]name
cornerrectangular round number
framecornerrectangular round number
backgroundcornerrectangular round number
radiusdimension
frameradiusdimension
backgroundradiusdimension
depthdimension
framedepthdimension
backgrounddepthdimension
framecolorcolor
topframeon off small name
bottomframeon off small name
leftframeon off small name
rightframeon off small name
regionyes no
rulethicknessdimension
frameoffsetdimension
frameon off overlay small closed none
backgroundforeground color name
backgroundoffsetframe dimension
componentname
extrascommand
foregroundstylestyle command
foregroundcolorcolor
setupsname
offsetdefault overlay none dimension
widthlocal fit max broad fixed dimension
heightfit max broad dimension
minheightdimension
alignsee \setupalign
strutyes no none local global
autostrutyes no
locationheight depth high low top middle bottom line lohi hanging keep formula mathematics normal
autowidthyes no force
linesnumber
topcommand
bottomcommand
blankyes no
profilename
emptyyes no
loffsetdimension
roffsetdimension
toffsetdimension
boffsetdimension
orientationnumber
anchoringnormal up down left right top bottom name
xanchordimension
yanchordimension

OptionExplanation
The name of an instance of framed. Not needed for the \framed command itself.
corner
This option determines whether or not the corners of the frame and background are rounded. It also allows drawing only selected corners. See the example below.
rectangular square corners
round rounded corners
framecorner
This option applies only to the frame corners.
backgroundcorner
This option applies only to the background corners.
radius
background and frame corner radius, if corner=round
frameradius
frame radius, if framecorner=round
backgroundradius
background radius, if backgroundcorner=round
rulethickness
sets the thickness of the frame border.
frameoffset
Gives frame an extra offset without affecting surrounding text.
frame
This option determines whether a frame is drawn or not.
background
color a color, to be set with backgroundcolor

Bug report: backgroundcolor is not documented. (See: Bug List)
name a named background ??
backgroundoffset
Gives background an extra offset without affecting surrounding text.
offset
This is the offset around the framed content. The frame itself is controlled by frameoffset
default set to 0.25ex.
overlay set to 0pt. If the frame is inside another one then the frame lines will overlap.
none set to 0pt. If the frame is inside another frame then the frame lines are doubled.
width
Specifies the width of the frame.
local inherit the width from parent box
fit according to content
broad sets width to approximately \textwidth
fixed like fit, but with an implied autowidth=no
height
Specifies the height of the frame.
align
If the align parameter is unspecified, \framed produces a \hbox, inside which linebreaks (if any) will appear as spaces; when align is specified, \framed will produce a \vbox.
location
depth lower framed box about \strutdp.
low (resembles \inframed): lowers the framed box by about \strutdp+offset+framelinewidth.
hanging lower framed box by approx. its own height (baseline is on the top).
empty
yes do not display contents of the box.
loffset
override the left value of offset
roffset
override the right value of offset
toffset
override the top value of offset
boffset
override the bottom value of offset

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

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: