Difference between revisions of "Command/setupcaptions"

From Wiki
Jump to navigation Jump to search
 
(19 intermediate revisions by 13 users not shown)
Line 4: Line 4:
 
}}
 
}}
  
 +
== [[Help:Reference|Syntax]] (autogenerated) ==
 +
<syntax>setupcaptions</syntax>
 
== [[Help:Reference|Syntax]] ==
 
== [[Help:Reference|Syntax]] ==
 
<table cellspacing="4" cellpadding="2" class="cmd">
 
<table cellspacing="4" cellpadding="2" class="cmd">
Line 11: Line 13:
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:location|location]]</td>
 
     <td class="cmd">[[Command/keyword:location|location]]</td>
     <td>[[Command/value:top|top]] [[Command/value:bottom|bottom]] [[Command/value:none|none]] [[Command/value:high|high]] [[Command/value:low|low]] [[Command/value:middle|middle]] </td>
+
     <td>[[Command/value:top|top]] [[Command/value:bottom|bottom]] [[Command/value:none|none]] [[Command/value:high|high]] [[Command/value:low|low]] [[Command/value:middle|middle]] [[Command/value:left|left]] [[Command/value:right|right]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
Line 39: Line 41:
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:align|align]]</td>
 
     <td class="cmd">[[Command/keyword:align|align]]</td>
     <td>[[Command/value:left|left]] [[Command/value:middle|middle]] [[Command/value:right|right]] [[Command/value:no|no]] </td>
+
     <td>[[Command/value:left|left]] [[Command/value:flushleft|flushleft]] [[Command/value:middle|middle]] [[Command/value:flushright|flushright]] [[Command/value:right|right]] [[Command/value:no|no]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
Line 60: Line 62:
 
     <td class="cmd">[[Command/keyword:stopper|stopper]]</td>
 
     <td class="cmd">[[Command/keyword:stopper|stopper]]</td>
 
     <td>[[Command/value:text|text]] </td>
 
     <td>[[Command/value:text|text]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:numberstopper|numberstopper]]</td>
 +
    <td>[[Command/value:text|text]] </td>
 +
  </tr>
 +
<tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:prefix|prefix]]</td>
 +
    <td>[[Command/value:yes|yes]] [[Command/value:no|no]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
Line 66: Line 76:
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Command/keyword:prefixsegments|prefigsegments]]</td>
+
     <td class="cmd">[[Command/keyword:prefixsegments|prefixsegments]]</td>
 
     <td>[[Command/value:none|none]] [[Command/value:section|section]] ...</td>
 
     <td>[[Command/value:none|none]] [[Command/value:section|section]] ...</td>
 
   </tr>
 
   </tr>
Line 75: Line 85:
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[[Command/keyword:distance|distance]]</td>
 
     <td class="cmd">[[Command/keyword:distance|distance]]</td>
 +
    <td>[[Command/value:dimension|dimension]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:spaceafter|spaceafter]]</td>
 
     <td>[[Command/value:dimension|dimension]] </td>
 
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
Line 80: Line 94:
  
 
== Description ==
 
== Description ==
Using option <code>[way=bysection]</code> resets the numbering to 1 at each new section, but does not prefix the numbers with the section number, to do that, use the following options:
 
<code>
 
\setupcaptions[way=bysection,prefixsegments=section]
 
</code>
 
  
If one has only a small number of figures and wishes to label them sequentially from 1 to ''n'', the following works:
+
{| class=wikitable
<code>
+
|- style="vertical-align: top"
\setupcaptions[way=bytext, prefixsegments=none]
+
| {{key|location}}
</code>
+
| The first option defines the location of the caption relative to the figure itself. The option <code>[location=right]</code> e.g. puts the caption on the right of the figure. The values of the location can be combined, so that <code>[location={right,low}]</code> adjusts the caption position to be to the right of the figure and in a low vertical position.
 +
|- style="vertical-align: top"
 +
| {{key|width}}
 +
| This is the width of the figure caption. If you do not like default captions that are driven by figure (table) width, try: <code>\setupcaptions[minwidth=\textwidth, align=middle]</code>
 +
|- style="vertical-align: top"
 +
| {{key|headstyle}}
 +
| This defines the formatting of the label, i.e. usually the word ''figure'' or ''table'' and its number. For example, <code>[headstyle=\it]</code> will change it to ''italic''.
 +
|- style="vertical-align: top"
 +
| {{key|style}}
 +
| The formatting of the text of the caption, use <code>[style=\it]</code> to get an ''italic'' text. Several values can be given using curly brackets: <code>[style={\it\tfx}]</code>. Please note, that some formatting (such as font size) will affect the head as well.
 +
|- style="vertical-align: top"
 +
| {{key|number}}
 +
| The option <code>[number=no]</code> suppresses the label and figure number.
 +
|- style="vertical-align: top"
 +
| {{key|inbetween}}
 +
| The macros given here are executed after placing the figure and before placing the caption. To set the space between figure and caption to zero use <code>[inbetween=]</code>
 +
|- style="vertical-align: top"
 +
| {{key|align}}
 +
| This can change the alignment of the caption. It can lead to confusion, since ''left'' and ''right'' means ''raggedleft'' and ''raggedright''. So to align a caption ''flush left'', use <code>[align=flushleft]</code>. 
 +
|- style="vertical-align: top"
 +
| {{key|numberconversion}}
 +
| Here, it is possible to change the number of the e.g. figure. ''romannumerals'' means, well, roman numerals, the capitalized version capitalizes the number as well. In MkIV, ''numberconversion'' must be used instead of ''conversion''. Example: <code>numberconversion=Romannumerals</code>
 +
|- style="vertical-align: top"
 +
| {{key|conversion}}
 +
| This is the MkII version of ''numberconversion''.
 +
|- style="vertical-align: top"
 +
| {{key|way}}
 +
| Using option <code>[way=bysection]</code> resets the numbering to 1 at each new section, but does not prefix the numbers with the section number, to do that, use the following options: <code>\setupcaptions[way=bysection,prefixsegments=section]</code>. If one has only a small number of figures and wishes to label them sequentially from 1 to ''n'', the following works:<code>\setupcaptions[way=bytext, prefixsegments=none]</code>.
 +
Note that the word "section" in <code>[way=bysection]</code> above refers to the document sections described in the \section command. Thus you can also say <code>[way=bypart]</code> or <code>[way=bychapter]</code> etc.
 +
|- style="vertical-align: top"
 +
| {{key|stopper'''}}
 +
| MKII only. The stopper text follows the number and, if present, the ''suffix'', and precedes the caption text. It does not appear in references.
 +
|- style="vertical-align: top"
 +
| {{key|numberstopper'''}}
 +
| MKIV only. The numberstopper text follows the number and, if present, the ''suffix'', and precedes the caption text. It does not appear in references.
 +
|- style="vertical-align: top"
 +
| {{key|separator'''}}
 +
| The separator (in MKIV, ''prefixconnector'') text separates components of the number in the caption and in references when sectioned numbers are used.
 +
|- style="vertical-align: top"
 +
| {{key|suffix'''}}
 +
| The suffix text immediately follows the number in the caption and in references.
 +
|- style="vertical-align: top"
 +
| {{key|prefixsegments}}
 +
| To have a figure number such as ''Figure 2.3'', where 2 is the section number and 3 the figure number, you can use this option. Normally, you want to reset the figure number with every section as well, so that ''Figure 2.1'' follows ''Figure 1.12'' instead of ''Figure 2.13''. Therefore, you have to use <code>\setupcaptions[prefix=yes,way=bysection,prefixsegments=section]</code>.
 +
|-
 +
| {{key|spaceafter}}
 +
| Add some vertical space after the caption.
 +
|}
  
If you like to have a colon in your caption, try:
+
== Example ==
<code>
+
<context source=yes>
\setupcaptions[suffix={:}]
+
\setuppapersize[A6]
</code>
+
\setupexternalfigures[location=default]
 +
\setupcaptions[
 +
    style={\tfx\setupinterlinespace[line=10pt]},
 +
    headstyle=\rm,
 +
    numberstopper={:}]
  
If you don't like default captions that are driven by figure(table) width, try:
+
\placefigure
<code>
+
    {Oh caption, my caption!\crlf
\setupcaptions[minwidth=\textwidth, align=middle]
+
    (Apologies to Walt Whitman)}
</code>
+
    {\externalfigure[cow][width=2cm]}
  
<code>conversion</code> is the MkII keyword whereas you must use <code>numberconversion</code>
+
\input linden
in MkIV.
+
</context>
 
 
== Example ==
 
<!-- Please fill in an example if you can -->
 
  
 
== See also ==
 
== See also ==

Latest revision as of 23:58, 18 December 2023

\setupcaptions

Syntax (autogenerated)

\setupcaptions[...,...][...=...,...]
[...,...]name
...=...,...inherits from \setupcaption


Syntax

\setupcaptions[...,...=...,...]
location top bottom none high low middle left right
width fit broad max dimension
minwidth fit dimension
headstyle normal bold slanted boldslanted type cap small... command
style normal bold slanted boldslanted type cap small... command
number yes no
inbetween command
align left flushleft middle flushright right no
numberconversion numbers characters Characters romannumerals Romannumerals
conversion numbers characters Characters romannumerals Romannumerals
way bytext bysection
separator text
stopper text
numberstopper text
prefix yes no
suffix text
prefixsegments none section ...
command command
distance dimension
spaceafter dimension

Description

location The first option defines the location of the caption relative to the figure itself. The option [location=right] e.g. puts the caption on the right of the figure. The values of the location can be combined, so that [location={right,low}] adjusts the caption position to be to the right of the figure and in a low vertical position.
width This is the width of the figure caption. If you do not like default captions that are driven by figure (table) width, try: \setupcaptions[minwidth=\textwidth, align=middle]
headstyle This defines the formatting of the label, i.e. usually the word figure or table and its number. For example, [headstyle=\it] will change it to italic.
style The formatting of the text of the caption, use [style=\it] to get an italic text. Several values can be given using curly brackets: [style={\it\tfx}]. Please note, that some formatting (such as font size) will affect the head as well.
number The option [number=no] suppresses the label and figure number.
inbetween The macros given here are executed after placing the figure and before placing the caption. To set the space between figure and caption to zero use [inbetween=]
align This can change the alignment of the caption. It can lead to confusion, since left and right means raggedleft and raggedright. So to align a caption flush left, use [align=flushleft].
numberconversion Here, it is possible to change the number of the e.g. figure. romannumerals means, well, roman numerals, the capitalized version capitalizes the number as well. In MkIV, numberconversion must be used instead of conversion. Example: numberconversion=Romannumerals
conversion This is the MkII version of numberconversion.
way Using option [way=bysection] resets the numbering to 1 at each new section, but does not prefix the numbers with the section number, to do that, use the following options: \setupcaptions[way=bysection,prefixsegments=section]. If one has only a small number of figures and wishes to label them sequentially from 1 to n, the following works:\setupcaptions[way=bytext, prefixsegments=none].

Note that the word "section" in [way=bysection] above refers to the document sections described in the \section command. Thus you can also say [way=bypart] or [way=bychapter] etc.

stopper MKII only. The stopper text follows the number and, if present, the suffix, and precedes the caption text. It does not appear in references.
numberstopper MKIV only. The numberstopper text follows the number and, if present, the suffix, and precedes the caption text. It does not appear in references.
separator The separator (in MKIV, prefixconnector) text separates components of the number in the caption and in references when sectioned numbers are used.
suffix The suffix text immediately follows the number in the caption and in references.
prefixsegments To have a figure number such as Figure 2.3, where 2 is the section number and 3 the figure number, you can use this option. Normally, you want to reset the figure number with every section as well, so that Figure 2.1 follows Figure 1.12 instead of Figure 2.13. Therefore, you have to use \setupcaptions[prefix=yes,way=bysection,prefixsegments=section].
spaceafter Add some vertical space after the caption.

Example

\setuppapersize[A6]
\setupexternalfigures[location=default]
\setupcaptions[
    style={\tfx\setupinterlinespace[line=10pt]}, 
    headstyle=\rm, 
    numberstopper={:}]

\placefigure
    {Oh caption, my caption!\crlf
     (Apologies to Walt Whitman)}
    {\externalfigure[cow][width=2cm]}

\input linden

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: