Command/setupcaptions

From Wiki
Revision as of 14:50, 2 July 2012 by Esteis (talk | contribs) (Make the example visible)
Jump to navigation Jump to search

\setupcaptions

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
suffix text
prefixsegments none section ...
command command
distance 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].
suffix If you like to have a colon in your caption, try:\setupcaptions[suffix={:}]
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[way=bysection,prefixsegments=section].

Example

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

\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: