17.16.5.33 LISTNUM

Description: Computes the next value from a specific level of a numbering definition, or a specific valuefrom a specific level of a numbering definition.

The terms numbering definition and level are used as defined in 17.9. Within the context of this field, determining the numbering definition is equivalent to reading the value of the numId element (17.9.18), and determining the level is equivalent to reading to value of the ilvl element (17.9.3). [Rationale: This field is distinct from the numbering defined by the syntax in 17.9. This syntax stores the numbering as run content, rather than a paragraph property. This allows multiple numbered items to occur in a single paragraph; at locations other than the start of the paragraph, etc. end rationale]

For LISTNUM fields, the associated numbering definition is calculated using the first of the following conditions met:

  • If field-argument is NumberValue, OutlineDefault, or LegalDefault, all items with each value are
  • part of a single numbering definition.
  • If the current paragraph has numbering applied, all items within that paragraph are part of its
  • numbering definition.
  • If field-argument is present, the field belongs to the numbering definition used by level one of the
  • abstract numbering definition (17.9.1) whose name element (17.9.13) matches field-argument. If no
  • such list exists, then the field shall behave as though field-argument was omitted.
  • If field-argument has been omitted, the field belongs to the same numbering definition as the last
  • instance of a LISTNUM field or numbered paragraph present in the document.

Once the numbering definition has been determined, the level is calculated as follows:

  • If the \l switch is present, the value of that switch overrides all subsequent rules.
  • If field-argument is NumberValue, OutlineDefault, or LegalDefault:

The first instance of the field is level one. Each instance of the field which occurs at the start of the paragraph preceded only by other LISTNUM fields (or nothing) increments the level by one. [Example: A LISTNUM field with no field- argument inserted as the first item in a paragraph using level one of a numbering definition is at level two. end example] The first instance of the field which occurs after other paragraph content increments the level by one, and all subsequent LISTNUM fields belong to the same level. [Example: Consider the following paragraph content: {LISTNUM} {LISTNUM} test {LISTNUM} test2 {LISTNUM} {LISTNUM}. Within this paragraph, the first two instances of the field are levels one and two, and the third through fifth instances of the field are part of level three. end example]

  • If field-argument has any other value:

If the current paragraph has numbering applied, that paragraph numbering resets the level to one.

Each LISTNUM field which occurs at the start of the paragraph preceded only by other LISTNUM fields (or nothing) increments the level by one. [Example: A LISTNUM field with no field- argument inserted as the first item in a paragraph using level one of a numbering definition is at level two. end example] The first LISTNUM field which occurs after other paragraph content increments the level by one, and all subsequent LISTNUM fields belong to the same level. [Example: Consider the following paragraph content: {LISTNUM} {LISTNUM} test {LISTNUM} test2 {LISTNUM} {LISTNUM}. Within this paragraph, the first two instances of the field are levels one and two, and the third through fifth instances of the field are part of level three. end example]

Fields in paragraphs with no numbering applied start at the same level as the last instance of a LISTNUM field or numbered paragraph present in the document.

The XML generated for a complex field implementation shall not have the optional field value stored.

Although the value of a LISTNUM field is calculated as a consecutive-valued non-negative integer, once a value is computed, the corresponding integer is rendered in the appropriate format, as described below. In all possible display methods, the list entry value is considered to be a number, and the list to be a numbered list. There are nine levels of list, and the result style used for each is determined based on the field-argument as follows:

  • If the field-argument is NumberValue, OutlineDefault, or LegalDefault, the formatting is based
  • on the table below.
  • For any other value, the formatting is based on the abstract numbering definition (17.9.1) whose name
  • element (17.9.13) matches field-argument. If no such list exists, then the field shall behave as though
  • field-argument was omitted.
  • If field-argument has been omitted:

If the current paragraph has numbering applied, the field shall take on the format of the next level of the corresponding numbering definition. [Example: A LISTNUM field inserted into a paragraph using level one of a numbering definition is displayed in the format defined by level two of that numbering definition. end example] If not, the field takes on the numbering format of the last instance of a LISTNUM field or numbered paragraph present in the document.

The following tables describe the predefined sequences NumberValue, OutlineDefault, and LegalDefault. The formats described are used as defined by ST_NumberFormat (17.18.59).

Level

The decimal format followed immediately by “)”. [Example: “3)”, “9)”, and “15)”. end example].

The lowerLetter format followed immediately by “)”. [Example: “c)”, “i)”, and “o)”. end example].

The lowerRoman format followed immediately by “)”. [Example: “iii)”, “ix)”, and “xv)”. end example].

The decimal format surrounded by “(“ and “)”, without any intervening white space. [Example: “(3)”, “(9)”, and “(15)”. end example].

The lowerLetter format surrounded by “(“ and “)”, without any intervening white space. [Example: “(c)”, “(i)”, and “(o)”. end example].

The lowerRoman format surrounded by “(“ and “)”, without any intervening white space. [Example: “(iii)”, “(ix)”, and “(xv)”. end example].

The decimal format followed immediately by “.”. [Example: “3.”, “9.”, and “15.”. end example].

The lowerLetter format followed immediately by “.”. [Example: “c.”, “i.”, and “o.”. end example].

The lowerRoman format followed immediately by “.”. [Example: “iii.”, “ix.”, and “xv.”. end example].

Level

The upperRoman format followed immediately by “.”. [Example: “III.”, “IX.”, and “XV.”. end example].

Level

Level

2–9

The upperLetter format followed immediately by “.”. [Example: “C.”, “I.”, and “O.”. end example].

The decimal format followed immediately by “.”. [Example: “3.”, “9.”, and “15.”. end example].

The lowerLetter format followed immediately by “)”. [Example: “c)”, “i)”, and “o)”. end example].

The decimal format surrounded by “(“ and “)”, without any intervening white space. [Example: “(3)”, “(9)”, and “(15)”. end example].

The lowerLetter format surrounded by “(“ and “)”, without any intervening white space. [Example: “(c)”, “(i)”, and “(o)”. end example].

The lowerLetter format defined by ST_NumberFormat surrounded by “(“ and “)”, without any intervening white space. [Example: “(iii)”, “(ix)”, and “(xv)”. end example].

The lowerLetter format surrounded by “(“ and “)”, without any intervening white space. [Example: “(c)”, “(i)”, and “(o)”. end example].

The lowerRoman format surrounded by “(“ and “)”, without any intervening white space. [Example: “(iii)”, “(ix)”, and “(xv)”. end example].

The decimal format followed immediately by “.”. [Example: “3.”, “9.”, and “15.”. end example].

A sequence consisting of the last number from each previous level (delimited by “.” followed immediately by the next value at this level and “.” (all in the decimal format). [Example: “1.3.”, “2.4.9.”, and “1.3.7.2.15.”. end example].

Field Value: The next value, or a specific value, from the numbering definition which this instance of the LISTNUM field belongs to (as described above).

Switches: Zero or more of the following field-specific-switches.

\l
\s

[Example: When the following fields are updated:

We need to perform the following functions: LISTNUM NumberDefault \l 3 \s 1 Get
approval for the project. LISTNUM Arrange for funding. LISTNUM Hire staff.

The results are:

We need to perform the following functions: i) Get approval for the
project. ii) Arrange for funding. iii) Hire staff.

When the following fields are updated:

LISTNUM NumberDefault \l 3 \s 1
LISTNUM
LISTNUM NumberDefault
LISTNUM NumberDefault \s 3
LISTNUM
LISTNUM NumberDefault \l 1
LISTNUM
LISTNUM NumberDefault \l 1 \s 1
LISTNUM LegalDefault \1 1 \s 1
LISTNUM LegalDefault
LISTNUM LegalDefault \l 1
LISTNUM LegalDefault \s 4
LISTNUM LegalDefault

The results are:

i)
ii)
iii)
iii)
iv)
2)
3)
1)
1.1.1.
1.1.2.
2.
2.1.4.
2.1.5.

end example]

Syntax:

Last updated on