Command/framed

From ConTeXt wiki

\framed

Syntax

\framed[...,...=...,...]{...}
[...,...=...,...] see \setupframed
{...} text

Description

There are two variants of this command:

As its name suggests, \framed draws a frame around its argument. For example

\setuppapersize[A5]
surrounding text \framed{framed text} surrounding text

Notice that the bottom line of the frame is aligned with the baseline of text.

Framed little cousin, \inframed aligns the baseline of framed text with the baseline of surrounding text. For example,

\setuppapersize[A5]
surrounding text \inframed{framed text} surrounding text

The following example contrast the difference between framed and inframed.

\setuppapersize[A5]
\setuplayout[width=10em]
\setupalign[flushleft]

Notice the difference between
\framed{framed} and \inframed{inframed},
especially considering its effect on linespacing...

Options

The first argument of framed takes the same key-value options as \setupframed.

height Specifies the height of the frame.
  • Default value: broad
  • Most common alternative: fit
  • Other alternatives: any valid TeX dimension
width Specifies the width of the frame.
frame This option determines whether a frame is drawn or not.
Default value: on
Alternate value: off
background none color
backgroundcolor The background color. background=color must be set.
corner 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
offset sets interior padding
loffset Set left interior padding
roffset Set right interior padding
toffset Set top interior padding
boffset Set bottom interior padding
frameoffset Gives frame an extra offset without affecting surrounding text
backgroundoffset offsets boundaries of background without affecting surrounding text

Examples

A frame till the bottom of the page (by WS, 4/2011)

\setuppapersize[A8]
\starttext
  \input ward
  \blank
  \framed[width=\textwidth,height=\dimexpr\pagegoal-\pagetotal-\lineheight\relax]{}
\stoptext

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: