Difference between revisions of "Command/ setuplabeltext"
Line 1: | Line 1: | ||
<cd:commandgroup generated="yes" name="setuplabeltext" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | <cd:commandgroup generated="yes" name="setuplabeltext" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807"> | ||
− | <cd:shortdesc> | + | <cd:shortdesc>The instances of <tt>\setup<i>label</i>text</tt> are used to fill in a class of labels |
− | The instances of <tt>\setup<i>label</i>text</tt> are used | ||
</cd:shortdesc> | </cd:shortdesc> | ||
<cd:sequence> | <cd:sequence> | ||
Line 9: | Line 8: | ||
</cd:sequence> | </cd:sequence> | ||
<cd:instances> | <cd:instances> | ||
− | <cd:constant value="head"></cd:constant> | + | <cd:constant value="head">Certain sections, like the table of contents or the list of figures, have a default title head. This title can be altered with {{cmd|setupheadtext|[name=text]}}. See [[#Description]] for the list of defined section head labels.</cd:constant> |
− | <cd:constant value="label"></cd:constant> | + | <cd:constant value="label">This class holds most other labels like the '''Figure''' and '''Table''' used in float captions.</cd:constant> |
<cd:constant value="mathlabel"></cd:constant> | <cd:constant value="mathlabel"></cd:constant> | ||
<cd:constant value="taglabel"></cd:constant> | <cd:constant value="taglabel"></cd:constant> | ||
Line 36: | Line 35: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description> | + | <cd:description>In some cases ConTeXt generates text labels automatically; for example, |
+ | the word ''Figure'' is generated automatically when a caption is placed | ||
+ | under a figure. These kind of words are called label texts. Labels are | ||
+ | set with the command {{cmd|setuplabeltext}}, and retrieved with the | ||
+ | command {{cmd|labeltext}}. They follow the language set with | ||
+ | {{cmd|mainlanguage}}, not the local bits of different language that are | ||
+ | set with {{cmd|language}}. | ||
+ | |||
+ | '''NB''' The ''option parser'' for the command {{gen|setuplabeltext}} | ||
+ | is [http://www.ntg.nl/pipermail/ntg-context/2012/067585.html known] to | ||
+ | behave somewhat differently from most setups, posing minor constraints | ||
+ | on code formatting. | ||
+ | For instance the trailing comma after an assignment, otherwise employed | ||
+ | to delimit the value, will lead to an error here. | ||
+ | The final option in the list needs thus to be terminated by the closing | ||
+ | bracket. | ||
+ | |||
+ | <texcode> | ||
+ | \setuplabeltext [ | ||
+ | Nomen=nomen, | ||
+ | Est=est, | ||
+ | Omen=est, %% <= fails! | ||
+ | ] | ||
+ | \setuplabeltext [Nomen=nomen, Est=est, Omen=est] %% <= works | ||
+ | \starttext | ||
+ | \labeltext{Nomen} | ||
+ | \labeltext{Est} | ||
+ | \labeltext{Omen} | ||
+ | \stoptext | ||
+ | </texcode> | ||
+ | |||
+ | For {{cmd|setupheadtext}}, here is the list of known section heads: | ||
+ | |||
+ | {| class="wikitable" | ||
+ | ! name || text | ||
+ | |- | ||
+ | | content || Contents | ||
+ | |- | ||
+ | | tables || Tables | ||
+ | |- | ||
+ | | figures || Figures | ||
+ | |- | ||
+ | | graphics || Graphics | ||
+ | |- | ||
+ | | intermezzi || Intermezzos | ||
+ | |- | ||
+ | | index || Index | ||
+ | |- | ||
+ | | abbreviations || Abbreviations | ||
+ | |- | ||
+ | | logos || Logos | ||
+ | |- | ||
+ | | units || Units | ||
+ | |- | ||
+ | | pubs || References | ||
+ | |} | ||
</cd:description> | </cd:description> | ||
− | <cd:examples></cd:examples> | + | <cd:examples><cd:example title="Example for \setupheadtext"><context source="yes"> |
+ | \setuppapersize[A5] | ||
+ | \mainlanguage[de] | ||
+ | % default headtext is 'Einhalt' | ||
+ | \setupheadtext[de][content=Einhaltsverzeichnis] | ||
+ | |||
+ | \starttext | ||
+ | |||
+ | \completecontent | ||
+ | \chapter{The first chapter} | ||
+ | |||
+ | \stoptext | ||
+ | </context></cd:example><cd:example title="Example for \setuplabeltext">Here is an example of changing section and subsection heads. | ||
+ | <context source="yes" text="results in"> | ||
+ | % English labels | ||
+ | \setuplabeltext[en][section=My section ] % We want a space at the end of the label | ||
+ | \setuplabeltext[en][subsection=My subsection ] | ||
+ | |||
+ | % Dutch labels | ||
+ | \setuplabeltext[nl][section=Mijn hoofdstuk ] % We want a space at the end of the label | ||
+ | \setuplabeltext[nl][subsection=Mijn onderdeel ] | ||
+ | |||
+ | \def\setheadnumber#1#2{#1. #2} | ||
+ | |||
+ | \setuphead | ||
+ | [section,subsection] | ||
+ | [command=\setheadnumber, | ||
+ | before={\blank[disable]}, | ||
+ | after={\blank[disable]}] | ||
+ | |||
+ | \starttext | ||
+ | |||
+ | \section{First Thoughts} | ||
+ | \subsection{First Subsection} | ||
+ | \hairline | ||
+ | |||
+ | % Changing the language does not change the labels | ||
+ | \language[nl] | ||
+ | \section{Second Thoughts} | ||
+ | \subsection{Second Subsection} | ||
+ | \hairline | ||
+ | |||
+ | % To change the labels, change the main language. | ||
+ | \mainlanguage[nl] | ||
+ | \section{Third Thoughts} | ||
+ | \subsection{Third Subsection} | ||
+ | \hairline | ||
+ | |||
+ | % Retrieving a label explicity: | ||
+ | This is the Dutch label for sections: \labeltext{section}. | ||
+ | |||
+ | \stoptext | ||
+ | </context></cd:example></cd:examples> | ||
<cd:notes></cd:notes> | <cd:notes></cd:notes> | ||
<cd:seealso> | <cd:seealso> |
Revision as of 20:01, 30 August 2020
Contents
\setuplabeltext
Summary
Instances
\setupheadtext | Certain sections, like the table of contents or the list of figures, have a default title head. This title can be altered with \setupheadtext. See #Description for the list of defined section head labels. |
\setuplabeltext | This class holds most other labels like the Figure and Table used in float captions. |
\setupmathlabeltext | |
\setuptaglabeltext | |
\setupunittext | |
\setupoperatortext | |
\setupprefixtext | |
\setupsuffixtext | |
\setupbtxlabeltext |
Settings instance
Description
the word Figure is generated automatically when a caption is placed under a figure. These kind of words are called label texts. Labels are set with the command \setuplabeltext, and retrieved with the command \labeltext. They follow the language set with \mainlanguage, not the local bits of different language that are set with \language.
NB The option parser for the command setuplabeltext is known to behave somewhat differently from most setups, posing minor constraints on code formatting. For instance the trailing comma after an assignment, otherwise employed to delimit the value, will lead to an error here. The final option in the list needs thus to be terminated by the closing bracket.
\setuplabeltext [ Nomen=nomen, Est=est, Omen=est, %% <= fails! ] \setuplabeltext [Nomen=nomen, Est=est, Omen=est] %% <= works \starttext \labeltext{Nomen} \labeltext{Est} \labeltext{Omen} \stoptext
For \setupheadtext, here is the list of known section heads:
name | text |
---|---|
content | Contents |
tables | Tables |
figures | Figures |
graphics | Graphics |
intermezzi | Intermezzos |
index | Index |
abbreviations | Abbreviations |
logos | Logos |
units | Units |
pubs | References |
Examples
Example for \setupheadtext
\setuppapersize[A5] \mainlanguage[de] % default headtext is 'Einhalt' \setupheadtext[de][content=Einhaltsverzeichnis] \starttext \completecontent \chapter{The first chapter} \stoptext
Example for \setuplabeltext
Here is an example of changing section and subsection heads.
% English labels \setuplabeltext[en][section=My section ] % We want a space at the end of the label \setuplabeltext[en][subsection=My subsection ] % Dutch labels \setuplabeltext[nl][section=Mijn hoofdstuk ] % We want a space at the end of the label \setuplabeltext[nl][subsection=Mijn onderdeel ] \def\setheadnumber#1#2{#1. #2} \setuphead [section,subsection] [command=\setheadnumber, before={\blank[disable]}, after={\blank[disable]}] \starttext \section{First Thoughts} \subsection{First Subsection} \hairline % Changing the language does not change the labels \language[nl] \section{Second Thoughts} \subsection{Second Subsection} \hairline % To change the labels, change the main language. \mainlanguage[nl] \section{Third Thoughts} \subsection{Third Subsection} \hairline % Retrieving a label explicity: This is the Dutch label for sections: \labeltext{section}. \stoptext
results in
Notes
See also
Help from ConTeXt-Mailinglist/Forum
All issues with:
- \setupheadtext on the mailing list (all results)
- \setupheadtext on the mailing list (subject only)
- \setupheadtext on stack exchange
- \setupheadtext in ConTeXt's source
- \setuplabeltext on the mailing list (all results)
- \setuplabeltext on the mailing list (subject only)
- \setuplabeltext on stack exchange
- \setuplabeltext in ConTeXt's source
- \setupmathlabeltext on the mailing list (all results)
- \setupmathlabeltext on the mailing list (subject only)
- \setupmathlabeltext on stack exchange
- \setupmathlabeltext in ConTeXt's source
- \setuptaglabeltext on the mailing list (all results)
- \setuptaglabeltext on the mailing list (subject only)
- \setuptaglabeltext on stack exchange
- \setuptaglabeltext in ConTeXt's source
- \setupunittext on the mailing list (all results)
- \setupunittext on the mailing list (subject only)
- \setupunittext on stack exchange
- \setupunittext in ConTeXt's source
- \setupoperatortext on the mailing list (all results)
- \setupoperatortext on the mailing list (subject only)
- \setupoperatortext on stack exchange
- \setupoperatortext in ConTeXt's source
- \setupprefixtext on the mailing list (all results)
- \setupprefixtext on the mailing list (subject only)
- \setupprefixtext on stack exchange
- \setupprefixtext in ConTeXt's source