8.5.3 Defining number format components

To apply number streams, numeric or alphabetic counters, prefixes, suffixes, and other repeating properties to output formats, you must define number format components in terms of these properties. As a convention, the name of any number format component should end in Num. Table 8-3 lists the properties and the values you can assign to number format components.

Table 8-3 Properties of number format components

Property

Description

stream

Name of number stream to use (see §8.5.2 Defining number streams), or none for no stream (for example, for bulleted lists)

counter

Numeric ID of counter to increment, 0 to not increment any counters

position

Where to display the number in relation to the text:

start

As a prefix to the text (default)

end

As a suffix to the text (usually for equations)

start

Value to restart counter with (usually 0 or 1), default is to continue numbering

keep

Space-delimited list of counters to leave alone; default is to reset all higher-numbered counters in the stream

name

Name to use in <name/> token, if not defined in [NumberFormatsText] in the language file; see §8.5 Configuring output numbering properties

form

Text plus any or all of the following building blocks:

<name/>

For the text name associated with the format in [NumberFormatsText] in a language file; see §39.1.6 Understanding how language templates are organized

<counter1/>,
<counter2/>,
...

To Identify which of the counters to display

<tab/>

(RTF only) Each tab advances by the amount in [WordOptions]AnumTabWidth (see §15.3.3 Converting autonumbered formats)

(HTML only) Adds a space

<spc/>

For a space, used to preserve trailing spaces; for HTML, becomes &nbsp;

<format>

For a character format, reset at the end of the autonumber or earlier by a <­/­format>; typographic tags are valid; see §8.1.5 Including typographic tags and character formats

<u+NNNN/>

For a Unicode character, where NNNN is the hexadecimal code point, as in <u+2020/> for a dagger

The <name/> building block is for a text label that becomes part of the output number string. Text labels are defined in each of the language configuration files; see §8.9 Localizing output headings, labels, and names. For example, in d2g_lang_en.ini, the default labels are as follows:

[NumberFormatsText]
; number format name = text to use in numbering string for <name/>
ChapterNum = Chapter
TableNum = Table
FigureNum = Figure
EquationNum = Equation

If you use different format names, the default text values do not apply, and you must specify those values explicitly. Or change the format names in the language configuration file; see §8.9 Localizing output headings, labels, and names.

You can mix format tags and typographic tags in the same format component definition; however, best practice is to assign the typographic tags to the format itself. See §8.1.5 Including typographic tags and character formats.

Note:  Do not try to assign more than one <format> tag to a format component.

Previous Topic:  8.5.2 Defining number streams

Next Topic:  8.5.4 Defining footnote numbering

Parent Topic:  8.5 Configuring output numbering properties

Sibling Topics:

8.5.1 Understanding numbering properties

8.5.2 Defining number streams

8.5.4 Defining footnote numbering

8.5.5 Considering examples of numbering schemes

Table of ContentsIndex