8.5.2 Declaring and defining number streams

You use number streams to coordinate numbering for those elements whose occurrences in your document should be numbered sequentially, or should appear with a constant prefix or suffix (or both). As a convention, the name of any number stream should end in Stream.

To declare the number streams your document should use (and as an aid to remembering which streams are used for what purpose):

[NumberStreams]
; stream name = purpose (a comment)
PartStream = Part numbers, like volume numbers
ChapterStream = Chapter title, all numbered subheads in chapter
AppendixStream = Appendix title, all numbered subheads in appendix
ListStream = Ordered lists, and ordered lists nested within them
FootnoteStream = Footnotes in text
TblFootnoteStream = Footnotes in table cells

These are the default stream names defined in subformats configuration templates. You can add names for other number streams of your own, and you can change the default names. However, if you change a default name, you must change it in every place the name is referenced.

By default, text footnotes are in one stream, and table footnotes are in another stream. If you want table footnotes numbered in the same stream as text footnotes, change the stream named in both [TblFootnoteNum] and [TblFootnoteRefNum], in format configuration template %omsyshome%\d2g\formats\d2g_subformats.ini; or override the stream name in your own version of these number subformats.

Now you need to define the properties of each of the declared number streams. Table 8-2 lists the properties and the values you can assign to those properties.

Table 8-2 Properties of number streams

Property

Default

Description

id
X

(RTF only) Stream ID to use in Word SEQ fields, preferably a single alphabetic character

counters
1

Maximum number of counters available in stream

counter types
Num

Space-delimited list of types, one for each counter, from the following list:

Num

Arabic numeral

UCRom

Uppercase Roman numeral

LCRom

Lowercase Roman numeral

UCAlpha

Uppercase letter

LCAlpha

Lowercase letter

Sym

Symbol

repeat
last

Which counter types to repeat, if there are more counters than counter types:

last

Repeat only the last counter type

all

Repeat the entire sequence of types, from the beginning

reset
none

When to restart footnote numbering:

topic

(HTML only) At the start of each topic, for all footnotes

(RTF only) At each page boundary, for all footnotes

table

At the start of each table, for table footnotes

none

Footnote numbers continue through entire document; for example, for endnotes

symbols

*

Space-delimited list of symbols to use when counter type is Sym

The value for symbols can consist of more than one character. If more are needed than are listed here, they continue with an increasing number of the last symbol listed. So if you use the default, a single asterisk, the sequence is *, **, ***, ****, and so forth. Symbols can be <u+NNNN/> for a Unicode character, where NNNN is the hexadecimal code point, as in <u+2020/> for a dagger.

For example (these are default definitions):

[ChapterStream]
id = C
counters = 8
counter types = Num
[AppendixStream]
id = A
counters = 8
counter types = UCAlpha Num
repeat = last
[ListStream]
id = L
counters = 3
counter types = Num LCAlpha LCRom

Previous Topic:  8.5.1 Understanding numbering properties

Next Topic:  8.5.3 Defining number subformats

Parent Topic:  8.5 Configuring output numbering properties

Sibling Topics:

8.5.1 Understanding numbering properties

8.5.3 Defining number subformats

8.5.4 Defining footnote numbering

8.5.5 Considering examples of numbering schemes