Changes

Jump to navigation Jump to search
2,100 bytes added ,  14:53, 15 October 2019
no edit summary
}}
== [[Help:Reference|Syntax]] (autogenerated) ==
<syntax>setupcaptions</syntax>
== [[Help:Reference|Syntax]] ==
<table cellspacing="4" cellpadding="2" class="cmd">
<td class="cmd">[[Command/keyword:stopper|stopper]]</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 valign="top" class="first">
<tr valign="top" class="first">
<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>
</tr>
== Description ==
'''location''': 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.
'''{| class=wikitable|- style="vertical-align: top" | {{key|location}}| 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>.|- 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.|}
'''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''': 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>[styleExample =={\it\tfx}]</code>. Please note, that some formatting (such as font size) will affect the head as well. '''number''': The option <code>[numbercontext source=no]</codeyes> 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 <code>\setuppapersize[inbetween=A6]</code> '''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>\setupexternalfigures[alignlocation=flushleftdefault]</code>. \setupcaptions['''way''': Using option <code>[way style=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>{\tfx\setupcaptionssetupinterlinespace[wayline=bysection10pt]},prefixsegments headstyle=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=bytextrm, prefixsegments=none]</code>. '''suffix''': If you like to have a colon in your caption, try:<code>\setupcaptions[suffix stopper={:}]</code>
'''prefixsegments''': To have a figure number such as ''Figure 2.3''\placefigure {Oh caption, where 2 is the section number and 3 the figure number, you can use this option. Normally, you want my caption!\crlf (Apologies 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>Walt Whitman)} {\setupcaptionsexternalfigure[way=bysection,prefixsegmentscow][width=section2cm]</code>.}
<code>conversion</code> works only in MkII, with MkIV <code>numberconversion\input linden</codecontext> must be used.
== Example ==
<code>
\setupcaption[style={\tfx\setupinterlinespace[line=10pt]}, headstyle=\rm, suffix={:}]
</code>
The caption is smaller than the other text with 10pt interline spacing. The word 'figure' is switched from bold to roman regular and the suffix after figure is ':'.
== See also ==
<!-- something like {{cmd|goto}} -->
[[Category:Command/Floating|setupcaptions]]
td class="cmd">[[Command/keyword:style|style]]

Navigation menu