Difference between revisions of "Command/ startframedtext"

From Wiki
Jump to navigation Jump to search
(Created page with "Documentation for \start<i>framedtext</i> ... \stop<i>framedtext</i>")
 
Line 4: Line 4:
 
<cd:shortdesc>
 
<cd:shortdesc>
 
<!-- a short command summary goes here -->
 
<!-- a short command summary goes here -->
The instances of  <tt>\start<i>framedtext</i> ... \stop<i>framedtext</i></tt> are used for ...
+
The instances of  <tt>\start<i>framedtext</i> ... \stop<i>framedtext</i></tt> are used for wrapping frames, margins and/or backgrounds around longer blocks of text.
 
</cd:shortdesc>
 
</cd:shortdesc>
 
<cd:sequence>
 
<cd:sequence>
Line 10: Line 10:
 
   </cd:sequence>
 
   </cd:sequence>
 
<cd:instances>
 
<cd:instances>
     <cd:constant value="framedtext"></cd:constant>
+
     <cd:constant value="framedtext">Like {{cmd|framed}}, but bigger.</cd:constant>
 
   </cd:instances>
 
   </cd:instances>
 
<cd:variants>
 
<cd:variants>
Line 16: Line 16:
 
   <cd:arguments>
 
   <cd:arguments>
 
     <cd:keywords optional="yes" ordinal="1">
 
     <cd:keywords optional="yes" ordinal="1">
     <cd:keywordsdoc></cd:keywordsdoc>
+
     <cd:keywordsdoc>set a horizontal placement, like in {{cmd|setupalign}}</cd:keywordsdoc>
     <cd:constant type="left"></cd:constant>
+
     <cd:constant type="left">left-aligned box</cd:constant>
     <cd:constant type="right"></cd:constant>
+
     <cd:constant type="right">right-aligned box</cd:constant>
     <cd:constant type="middle"></cd:constant>
+
     <cd:constant type="middle">horizontally centered box</cd:constant>
     <cd:constant type="none"></cd:constant>
+
     <cd:constant type="none">whatever the surrounding default is</cd:constant>
 
     </cd:keywords>
 
     </cd:keywords>
 
     <cd:assignments list="yes" optional="yes" ordinal="2">
 
     <cd:assignments list="yes" optional="yes" ordinal="2">
Line 33: Line 33:
 
</cd:description>
 
</cd:description>
 
<cd:examples>
 
<cd:examples>
<!--  command example(s)
 
 
<cd:example title="">
 
<cd:example title="">
 +
<context source="yes">
 +
\startframedtext[width=.8\makeupwidth]
 +
  It was essential for Hasselt to have a bridge across the river Zwarte
 +
  Water. The bishop of Utrecht gave Hasselt his consent in 1486.
 +
  \blank
 +
  Other cities in the neighbourhood of Hasselt were afraid of the toll
 +
  money to be paid when crossing this bridge so they prevented the
 +
  construction.
 +
\stopframedtext
 +
\startframedtext[right][width=.8\makeupwidth]
 +
  This one is shifted to the right.
 +
\stopframedtext
 +
</context>
 
</cd:example>
 
</cd:example>
-->
 
 
</cd:examples>
 
</cd:examples>
 
<cd:notes>
 
<cd:notes>

Revision as of 09:31, 21 August 2020


\startframedtext ... \stopframedtext

Summary

The instances of \startframedtext ... \stopframedtext are used for wrapping frames, margins and/or backgrounds around longer blocks of text.

Instances

\startframedtext ... \stopframedtextLike \framed, but bigger.

Settings instance

\startFRAMEDTEXT[...][...=...,...] ... \stopFRAMEDTEXT
[...]left right middle none
...=...,...inherits from \setupframedtext

OptionExplanation
set a horizontal placement, like in \setupalign
left left-aligned box
right right-aligned box
middle horizontally centered box
none whatever the surrounding default is

Description

Examples

Example 1

\startframedtext[width=.8\makeupwidth]
  It was essential for Hasselt to have a bridge across the river Zwarte
  Water. The bishop of Utrecht gave Hasselt his consent in 1486.
  \blank
  Other cities in the neighbourhood of Hasselt were afraid of the toll
  money to be paid when crossing this bridge so they prevented the
  construction.
\stopframedtext
\startframedtext[right][width=.8\makeupwidth]
  This one is shifted to the right.
\stopframedtext

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: