Difference between revisions of "Command/setupreferencestructureprefix"

From Wiki
Jump to navigation Jump to search
(Add category)
(Add description (description provided by Wolfgang, slightly changed))
Line 21: Line 21:
 
   <tr valign="top" class="second">
 
   <tr valign="top" class="second">
 
     <td class="cmd">[...]</td>
 
     <td class="cmd">[...]</td>
     <td>number, page, title, text or default</td>
+
     <td>number, page, title, text, default or realpage</td>
 
   </tr>
 
   </tr>
  
Line 60: Line 60:
  
 
</table>
 
</table>
 +
 +
== Description ==
 +
 +
The first (and optional) argument can be used to specify the element,
 +
which reference should be customized. When “float” is used, the setting
 +
affects all kind of floats which are created with <cmd>definefloat</cmd> but also only certain float types can be changed when the name of the float is being used,
 +
e.g. figure or table. When the layout for a heading should be changed, the name of it, e.g. chapter or section needs to be specified.
 +
 +
The second argument specifies the reference type, the values
 +
of these types are “number”, “page”, “title”, … (see above). When referring to a section
 +
or float with the <cmd>in</cmd> command, context uses the “default” type and when referring using the
 +
<cmd>at</cmd> command, it uses the “page” type.
 +
 +
With the third argument it can be controlled which prefixes (section numbers
 +
which are shown in front of a floats own counter value) are shown and
 +
how they should be formatted (see [[References]]).
  
 
== Example ==
 
== Example ==

Revision as of 16:59, 16 October 2011

\setupreferencestructureprefix

Syntax

\setupreferencestructureprefix[...][...][...,...=...,...]
[...] IDENTIFIER (float, formula, figure, SECTION (e.g. section, subsection, …), …)
[...] number, page, title, text, default or realpage
prefix yes no
prefixseparatorset IDENTIFIER
prefixconversionset IDENTIFIER
prefixset IDENTIFIER
prefixsegments SEGMENTS
prefixconnector TEXT

Description

The first (and optional) argument can be used to specify the element, which reference should be customized. When “float” is used, the setting affects all kind of floats which are created with \definefloat but also only certain float types can be changed when the name of the float is being used, e.g. figure or table. When the layout for a heading should be changed, the name of it, e.g. chapter or section needs to be specified.

The second argument specifies the reference type, the values of these types are “number”, “page”, “title”, … (see above). When referring to a section or float with the \in command, context uses the “default” type and when referring using the \at command, it uses the “page” type.

With the third argument it can be controlled which prefixes (section numbers which are shown in front of a floats own counter value) are shown and how they should be formatted (see References).

Example

\setupreferencestructureprefix [default] [prefixsegments=2:4]

See also

\definestructureseparatorset, References