DocumentID: ECMA-376/Part4/2.9.6
Title: ECMA-376, Part4: 2.9.6 lvl (Numbering Level Override Definition)
Extracted-From: ECMA-376 Office Open XML File Formats, 1st Edition / December 2006
Warning: Coverted to HTML format by a script known to have bugs

Navigation:

Next: 2.9.7 lvl (Numbering Level Definition)
Up: 2.9 Numbering
Table of contents: Table of contents
Previous: 2.9.5 legacy (Legacy Numbering Level Properties)

`2.9.6 lvl` (Numbering Level Override Definition)

This element specifies the appearance and behavior of a specific numbering level within a given numbering level definition override defined using the lvlOverride element (§2.9.9).

A numbering level override definition is identical to a numbering level definition, except for the fact that it is defined as part of a numbering definition instance using the num element (§2.9.16) rather than as part of an abstract numbering definition using the abstractNum element (§2.9.1).

[Example: Consider a numbering definition instance which inherits its information from the abstract numbering definition with abstractNumId of 4, but should use a different set of properties for level 0 of the numbering definition. The resulting WordprocessingML would look like:

<w:num w:numId="6"> <w:abstractNumId w:val="4" /> <w:lvlOverride w:ilvl="0"> <w:lvl w:ilvl="0"> <w:start w:val="4" /> <w:lvlText w:val="%1)" /> <w:lvlJc w:val="left" /> <w:pPr> <w:ind w:left="360" w:hanging="360" /> </w:pPr> </w:lvl> </w:lvlOverride> </w:num>

This numbering definition instance overrides level 0 of the list with the specified numbering level override definition, replacing those in the abstract numbering level definition. end example]

[Note: The ability to set level overrides optimizes use of numbering in WordprocessingML as it prevents writing out redundant abstract numbering definitions if numbering sets only slightly differ.

Consider using WordprocessingML to create two numbered sets that only differ only in the appearance and style of the first numbering level. Both could use the same abstract numbering definition as long as each references a different numbering definition instance with one of the numbering definition instances leveraging a level override for the first numbering level. Below is WordprocessingML that illustrates this:

<w:num w:numId="5"> <w:abstractNumId w:val="4" /> </w:num>

end note]

Parent Elements

lvlOverride (§2.9.9)

Child Elements	Subclause
`isLgl` (Display All Levels Using Arabic Numerals)	§2.9.4
`legacy` (Legacy Numbering Level Properties)	§2.9.5
`lvlJc` (Justification)	§2.9.8
`lvlPicBulletId` (Picture Numbering Symbol Definition Reference)	§2.9.10
`lvlRestart` (Restart Numbering Level Symbol)	§2.9.11
`lvlText` (Numbering Level Text)	§2.9.12
`numFmt` (Numbering Format)	§2.9.18
`pPr` (Numbering Level Associated Paragraph Properties)	§2.9.24
`pStyle` (Paragraph Style's Associated Numbering Level)	§2.9.25
`rPr` (Numbering Symbol Run Properties)	§2.9.26
`start` (Starting Value)	§2.9.27
`suff` (Content Between Numbering Symbol and Paragraph Text)	§2.9.30

Attributes	Description
`ilvl` (Numbering Level)	Specifies the numbering level definition that is to be defined by this set of numbering properties. This override is a zero-based index of the number of list levels in the document. [Example: A value of `2` is the 3rd list level in the document. end example] [Example: Consider the following WordprocessingML for a numbering definition instance: `<w:num w:numId="6"> <w:abstractNumId w:val="4" />` `<w:lvlOverride w:ilvl="0">` `...` `</w:num>` In this example, the first numbering level definition (with an `ilvl` of `0`) within the referenced abstract numbering definition will be overridden. end example] The possible values for this attribute are defined by the `ST_DecimalNumber` simple type (§2.18.16).
`tentative` (Tentative Numbering)	Specifies that a given numbering level was been saved by a producer but was not used in the parent document. This means that this numbering level may be redefined by a future consumer without changing the actual content of the document. A value of `on`, `1`, or `true` for this attribute value specifies that the numbering level is not used in the current document's contents. A value of `off`, `0`, or `false` for this attribute value specifies that the numbering level is used in the parent document and cannot be redefined without changing its contents. This is the default value for this attribute, and is implied when this attribute is omitted. [Example: Consider the following WordprocessingML numbering level: `<w:lvl w:ilvl="0" w:tentative="on" >` `...` `</w:lvl>` This level has the `tentative` attribute set to `on`, therefore the contents of this numbering level have not been used in the document and may be redefined by a consumer as desired. end example] If this attribute is equal to `on`, `1`, or `true`, the WordprocessingML for a given document will contain the numbering level information associated with this numbering level, but the 'tentative' numbering level(s) shall not be represented in any of the hosting application's user interface pertaining to numbering levels. The possible values for this attribute are defined by the `ST_OnOff` simple type (§2.18.67).
`tplc` (Template Code)	Specifies a unique hexadecimal value which may be used to specify a location within an application's user interface in which this numbering level shall be displayed. The method by which this value is interpreted shall be application-defined. If this attribute is omitted, then this numbering may be displayed in any location chosen by the consumer. [Example: Consider the following abstract numbering definition: `<w:abstractNum w:abstractNumId="1" w:tplc="04090019">` `...` `</w:abstractNum>` In this example the `abstractNum` element with attribute `abstractNumId` equal to `1`, would appear in the area within a consumer's application user interface specified by the template code `04090019.`end example] The possible values for this attribute are defined by the `ST_LongHexNumber` simple type (§2.18.57).

Attributes

Description

ilvl (Numbering Level)

Specifies the numbering level definition that is to be defined by this set of numbering properties.

This override is a zero-based index of the number of list levels in the document. [Example: A value of 2 is the 3rd list level in the document. end example]

[Example: Consider the following WordprocessingML for a numbering definition instance:

<w:num w:numId="6"> <w:abstractNumId w:val="4" />

<w:lvlOverride w:ilvl="0">

...

</w:num>

In this example, the first numbering level definition (with an ilvl of 0) within the referenced abstract numbering definition will be overridden. end example]

The possible values for this attribute are defined by the ST_DecimalNumber simple type (§2.18.16).

tentative (Tentative Numbering)

Specifies that a given numbering level was been saved by a producer but was not used in the parent document. This means that this numbering level may be redefined by a future consumer without changing the actual content of the document.

A value of on, 1, or true for this attribute value specifies that the numbering level is not used in the current document's contents.

A value of off, 0, or false for this attribute value specifies that the numbering level is used in the parent document and cannot be redefined without changing its contents. This is the default value for this attribute, and is implied when this attribute is omitted.

[Example: Consider the following WordprocessingML numbering level:

<w:lvl w:ilvl="0" w:tentative="on" >

...

</w:lvl>

This level has the tentative attribute set to on, therefore the contents of this numbering level have not been used in the document and may be redefined by a consumer as desired. end example]

If this attribute is equal to on, 1, or true, the WordprocessingML for a given document will contain the numbering level information associated with this numbering level, but the 'tentative' numbering level(s) shall not be represented in any of the hosting application's user interface pertaining to numbering levels.

The possible values for this attribute are defined by the ST_OnOff simple type (§2.18.67).

tplc (Template Code)

Specifies a unique hexadecimal value which may be used to specify a location within an application's user interface in which this numbering level shall be displayed. The method by which this value is interpreted shall be application-defined.

If this attribute is omitted, then this numbering may be displayed in any location chosen by the consumer.

[Example: Consider the following abstract numbering definition:

<w:abstractNum w:abstractNumId="1" w:tplc="04090019">

...

</w:abstractNum>

In this example the abstractNum element with attribute abstractNumId equal to 1, would appear in the area within a consumer's application user interface specified by the template code 04090019.end example]

The possible values for this attribute are defined by the ST_LongHexNumber simple type (§2.18.57).

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_Lvl">

<sequence>

<element name="start" type="CT_DecimalNumber" minOccurs="0"/>

<element name="numFmt" type="CT_NumFmt" minOccurs="0"/>

<element name="lvlRestart" type="CT_DecimalNumber" minOccurs="0"/>

<element name="pStyle" type="CT_String" minOccurs="0"/>

<element name="isLgl" type="CT_OnOff" minOccurs="0"/>

<element name="suff" type="CT_LevelSuffix" minOccurs="0"/>

<element name="lvlText" type="CT_LevelText" minOccurs="0"/>

<element name="lvlPicBulletId" type="CT_DecimalNumber" minOccurs="0"/>

<element name="legacy" type="CT_LvlLegacy" minOccurs="0"/>

<element name="lvlJc" type="CT_Jc" minOccurs="0"/>

<element name="pPr" type="CT_PPr" minOccurs="0"/>

<element name="rPr" type="CT_RPr" minOccurs="0"/>

</sequence>

<attribute name="ilvl" type="ST_DecimalNumber" use="required"/>

<attribute name="tplc" type="ST_LongHexNumber" use="optional"/>

<attribute name="tentative" type="ST_OnOff" use="optional"/>

</complexType>

Converted to HTML format by ooxmlspec2html 0.1, a Perl script provided by OpenISO.org.