3,899
edits
Changes
Jump to navigation
Jump to search
Command/setupreferenceformat (view source)
Revision as of 13:18, 5 September 2020
, 13:18, 5 September 2020Created page with "Documentation for \setupreferenceformat"
<cd:commandgroup name="setupreferenceformat" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setupreferenceformat</tt> is used for configuring referencing commands.
</cd:shortdesc>
<cd:variants>
<cd:command category="references" file="strc-ref.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-references.xml" level="style" name="setupreferenceformat" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="label">
<cd:paramdoc>Label inserted before the <cd:iref name="left"/>. Mutually exclusive with <cd:iref name="text"/></cd:paramdoc>
<cd:constant type="*"></cd:constant>
<cd:constant type="cd:name">a defined label text</cd:constant>
</cd:parameter>
<cd:parameter name="left">
<cd:paramdoc>left side of reference output.</cd:paramdoc>
<cd:constant type="cd:command">can also be a string</cd:constant>
</cd:parameter>
<cd:parameter name="right">
<cd:paramdoc>right side of reference output</cd:paramdoc>
<cd:constant type="cd:command">can also be a string</cd:constant>
</cd:parameter>
<cd:parameter name="type">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="default">like {{cmd|in}}</cd:constant>
<cd:constant type="text">like {{cmd|about}}</cd:constant>
<cd:constant type="title"></cd:constant>
<cd:constant type="number">like {{cmd|in}}</cd:constant>
<cd:constant type="page">like {{cmd|at}}</cd:constant>
<cd:constant type="realpage"></cd:constant>
</cd:parameter>
<cd:parameter name="setups">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="autocase">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes">perform capitalisation on <cd:iref name="text"/> or <cd:iref name="label"/>.</cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="text">
<cd:paramdoc>Text inserted before the <cd:iref name="left"/>. Mutually exclusive with <cd:iref name="label"/></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>Formatting style</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Configures a new referencing command. See {{cmd|definereferenceformat}} for example usage.
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definereferenceformat" originator="system"></cd:commandref>
<cd:source file="strc-ref.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:References"></cd:wikipage>
<cd:commandref name="in"></cd:commandref>
<cd:commandref name="at"></cd:commandref>
<cd:commandref name="about"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setupreferenceformat</tt> is used for configuring referencing commands.
</cd:shortdesc>
<cd:variants>
<cd:command category="references" file="strc-ref.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-references.xml" level="style" name="setupreferenceformat" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="label">
<cd:paramdoc>Label inserted before the <cd:iref name="left"/>. Mutually exclusive with <cd:iref name="text"/></cd:paramdoc>
<cd:constant type="*"></cd:constant>
<cd:constant type="cd:name">a defined label text</cd:constant>
</cd:parameter>
<cd:parameter name="left">
<cd:paramdoc>left side of reference output.</cd:paramdoc>
<cd:constant type="cd:command">can also be a string</cd:constant>
</cd:parameter>
<cd:parameter name="right">
<cd:paramdoc>right side of reference output</cd:paramdoc>
<cd:constant type="cd:command">can also be a string</cd:constant>
</cd:parameter>
<cd:parameter name="type">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="default">like {{cmd|in}}</cd:constant>
<cd:constant type="text">like {{cmd|about}}</cd:constant>
<cd:constant type="title"></cd:constant>
<cd:constant type="number">like {{cmd|in}}</cd:constant>
<cd:constant type="page">like {{cmd|at}}</cd:constant>
<cd:constant type="realpage"></cd:constant>
</cd:parameter>
<cd:parameter name="setups">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="autocase">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes">perform capitalisation on <cd:iref name="text"/> or <cd:iref name="label"/>.</cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="text">
<cd:paramdoc>Text inserted before the <cd:iref name="left"/>. Mutually exclusive with <cd:iref name="label"/></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>Formatting style</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>Configures a new referencing command. See {{cmd|definereferenceformat}} for example usage.
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definereferenceformat" originator="system"></cd:commandref>
<cd:source file="strc-ref.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:References"></cd:wikipage>
<cd:commandref name="in"></cd:commandref>
<cd:commandref name="at"></cd:commandref>
<cd:commandref name="about"></cd:commandref></cd:seealso>
</cd:commandgroup>
