Difference between revisions of "Command/setupframed"

From Wiki
Jump to navigation Jump to search
(→‎Syntax: left->flushleft, right -> flushright)
(→‎Description: reformatted)
Line 148: Line 148:
  
 
== Description ==  
 
== Description ==  
<pre>
 
width
 
  broad: ~ \textwidth
 
  local: inherit the width from parent box
 
  fixed:
 
  fit: according to content
 
offset
 
  none=0pt: if the frame is inside another frame then
 
            frame line is doubled
 
  overlay: if the frame is inside another one then frame lines overlaped
 
  default=.25ex
 
location
 
  low=\inframed: lower framed box about: \strutdp+offset+framelinewidth
 
  depth: lower framed box about: \strutdp
 
  hanging: lower framed box about: box height (baseline is on the top)
 
empty
 
  yes: do not type contents of the box
 
rulethickness: sets the thickness of the frame border
 
</pre>
 
  
 +
{|cellpadding="10" style="border:2px solid #eeeeee"
 +
! key
 +
! possible values
 +
|-
 +
|<tt>width</tt>
 +
|<tt>broad</tt>: sets width to ~ \textwidth; <tt>local</tt>: inherit the width from parent box; <tt>fixed</tt>: ??; <tt>fit</tt>: according to content.
 +
|-
 +
|<tt>offset</tt>
 +
|<tt>none</tt> set to <em>0pt</em>, if the frame is inside another frame then frame line is <em>doubled</em>; <tt>overlay</tt> set to <em>0pt</em>, if the frame is inside another one then frame lines <em>overlaped</em>; <tt>default</tt> set to <em>.25ex</em>.
 +
|-
 +
|<tt>location</tt>
 +
|<tt>low</tt> (resembles [[cmd:inframed|\inframed]]): lower framed box about: <tt>\strutdp+offset+framelinewidth</tt>; <tt>depth</tt>: lower framed box about: <tt>\strutdp</tt>; <tt>hanging</tt>: lower framed box about: box height (baseline is on the top).
 +
|-
 +
|<tt>empty</tt>
 +
|<tt>yes</tt>: do not type contents of the box.
 +
|-
 +
|<tt>rulethickness</tt>
 +
|sets the thickness of the frame border.
 +
|}
  
 
== Example ==
 
== Example ==

Revision as of 09:15, 13 October 2010

\setupframed

Syntax

\setupframed[...,...=...,...]
height fit broad dimension
width fit broad fixed local dimension
autowidth yes no force
offset none overlay default dimension
location depth hanging high lohi low top middle bottom
option none empty
strut yes no global local
align no flushleft flushright middle normal high low lohi
bottom command
top command
frame on off none overlay
topframe on off
bottomframe on off
leftframe on off
rightframe on off
frameoffset dimension
framedepth dimension
framecorner round rectangular
frameradius dimension
framecolor name
background screen color none foreground name
backgroundscreen number
backgroundcolor name
backgroundoffset frame dimension
backgrounddepth dimension
backgroundcorner round rectangular
backgroundradius dimension
depth dimension
corner round rectangular
radius dimension
empty yes no
foregroundcolor name
foregroundstyle name
rulethickness dimension

Description

key possible values
width broad: sets width to ~ \textwidth; local: inherit the width from parent box; fixed: ??; fit: according to content.
offset none set to 0pt, if the frame is inside another frame then frame line is doubled; overlay set to 0pt, if the frame is inside another one then frame lines overlaped; default set to .25ex.
location low (resembles \inframed): lower framed box about: \strutdp+offset+framelinewidth; depth: lower framed box about: \strutdp; hanging: lower framed box about: box height (baseline is on the top).
empty yes: do not type contents of the box.
rulethickness sets the thickness of the frame border.

Example

See also