DocumentID: ECMA-376/Part4/2.15.1
Title: ECMA-376, Part4: 2.15.1 Document Settings
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

• Next: 2.15.1 Document Settings
• Up: 2.15 Settings
• Table of contents: Table of contents
• Previous: 2.15 Settings

2.15.1 Document Settings

The first group of settings stored in WordprocessingML is document settings. These settings specify all document-level properties which affect the handling of the current document.

[Example: Consider the following WordprocessingML fragment for the document settings in a WordprocessingML document:

<w:settings>
  <w:defaultTabStop w:val="720" />
  <w:characterSpacingControl w:val="dontCompress" />
</w:settings>

The settings element contains all of the document settings for this document. In this case, the two settings applied are automatic tab stop increments of 0.5" using the defaultTabStop element (§2.15.1.24), and no character level whitespace compression using the characterSpacingControl element (§2.15.1.18). end example]

2.15.1.1 activeWritingStyle (Grammar Checking Settings)

This element specifies information about the parameters of the grammar checking which was performed on the contents of the current WordprocessingML document. [Note: This information may be used as desired by applications; for example, to determine if the current grammar checking state, specified by the proofState element (§2.15.1.65) is sufficient. end note]

[Example: Consider the following WordprocessingML fragment from the document settings:

<w:activeWritingStyle w:lang="en-CA" w:vendorID="64" w:dllVersion="131078" w:nlCheck="1" w:optionSet="0" /> 

The activeWritingStyle element's lang attribute specifies that the English (Canada) language setting for grammatical and stylistic checks shall be applied; the vendorID attribute specifies information about the vendor associated with the DLL used to perform the grammatical and stylistic checks; the dllVersion attribute specifies the version of this DLL; the nlCheck attribute specifies if natural language checks were performed or not; and the optionSet element specifies that the hosting application should allow its grammar engine to check both the grammar and style of the given WordprocessingML document, if that functionality is available. end example]

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

<complexType name="CT_WritingStyle">

<attribute name="lang" type="ST_Lang" use="required"/>

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

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

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

<attribute name="checkStyle" type="ST_OnOff" use="required"/>

<attribute name="appName" type="ST_String" use="required"/>

</complexType>

2.15.1.2 alignBordersAndEdges (Align Paragraph and Table Borders with Page Border)

This element specifies that paragraph borders specified using the pBdr element (§2.3.1.24) and table borders using the tblBorders element (§2.4.37) shall be adjusted to align with extents of the page border defined using the pgBorders element (§2.6.10) if the spacing between these borders is less than or equal to 10.5 points (one character width) or less from the page border. The presence of this setting shall ensure there are no gaps of one character width or less between adjoining page and paragraph/table borders, as borders which are perfectly aligning shall not be displayed in favor of the intervening page border.

If this element is omitted, then borders shall not be automatically adjusted to prevent gaps of less than one character width. If the page border is not measured from the text extents using a value of text in the offsetFrom attribute on the pgBorders element, then it may be ignored.

[Example: Consider the following WordprocessingML fragment from the document settings:

<w:alignBordersAndEdges w:val="true"/> 

The alignBordersAndEdges element has a value of true specifying that borders shall be adjusted to prevent gaps of less than one character width. If a document has a page border specified to appear 4 points from the text extents, and within that page a paragraph border specified to appear one point from the text extents, that would normally appear like this:

If this element is present, then those gaps (which are all of three points in width) shall be adjusted to ensure that the borders align exactly and the paragraph border is suppressed:

end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.3 alwaysMergeEmptyNamespace (Do Not Mark Custom XML Elements With No Namespace As Invalid)

This element specifies whether custom XML markup specified via the customXml element which has no associated namespace shall be treated as an error and moved into a special error namespace (for the purposes of validation) when the document is opened. If this element is turned on, when an application determines that the current XML markup is in the empty namespace, those elements shall not automatically be moved into an error namespace.

If this element is not present in a WordprocessingML document than custom XML markup which has no associated namespace shall be treated as an error and moved into a special error namespace when the document is opened.

[Example: Consider a WordprocessingML document which should not automatically flag empty namespace XML as invalid. This requirement would be specified using the following WordprocessingML:

<w:alwaysMergeEmptyNamespace w:val="true"/> 

The alwaysMergeEmptyNamespace element's val attribute has a value of true specifying that custom XML markup in the empty namespace shall never be treated as an error. end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.4 alwaysShowPlaceholderText (Use Custom XML Element Names as Default Placeholder Text)

This element specifies that each custom XML element specified using the customXml element within this document shall always show some form of in-document placeholder text presentation when it contains no run content. If the placeholder element (§2.5.2.24) is present in the custom XML element's properties, then this is the placeholder text displayed and this effect has no effect. If the placeholder element is omitted, then the application shall use the name of the element to generate default placeholder text in its place.

If this element is omitted, then custom XML markup which does not contain a placeholder element within its properties shall not display any placeholder text.

[Example: Consider the following WordprocessingML fragment from the document settings:

<w:alwaysShowPlaceholderText w:val="true" />

The alwaysShowPlaceholderText element has a value of true, which specifies that placeholder text shall be generated using the element's name if no placeholder text is present. If two custom XML elements are defined as follows:

<w:customXml w:name="spec" ... >
  <w:customXmlPr>
    <w:placeholder w:val="Type the name of the specification." />
  </w:customXmlPr>
</w:customXml>
...
<w:customXml w:name="spec" ... >
</w:customXml>

The first custom XML element has placeholder text, and the second doesn't, so if this element is omitted, these two elements might be displayed as follows:

Notice that the second custom XML element has no placeholder text, and therefore is not displayed. However, when this element is present, then the application should generate default placeholder text in its place:

The application generated default placeholder text from the element name, resulting in a value of [spec] in the document. end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.5 attachedSchema (Attached Custom XML Schema)

This element specifies that the custom XML schema whose target namespace matches the value specified in the val attribute should be associated with this document when it is loaded, if such a schema is available to the hosting application. Applications may also load and utilize any additional schemas as well as those explicitly mentioned here. [Note: These custom XML schemas may then be used to validate the structure of the custom XML markup in the document, etc. end note]

If no elements of this type are present, then no custom XML schemas have been explicitly associated with the contents of this document.

[Example: Consider the following WordprocessingML fragment from the document settings:

<w:attachedSchema w:val="http://www.example.com/schema1" />

<w:attachedSchema w:val="http://www.example.com/schema2" />

The attachedSchema elements specify that two custom XML schemas with namespaces of http://www.example.com/schema1 and http://www.example.com/schema2 should be associated with the custom XML markup in the current document. end example]

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

<complexType name="CT_String">

<attribute name="val" type="ST_String" use="required"/>

</complexType>

2.15.1.6 attachedTemplate (Attached Document Template)

This element specifies the location of a document template which shall be attached to the current WordprocessingML document if it is accessible and of a format supported by an application. Specifically, this element's val attribute shall contain the file path of the associated document template.

If this element is omitted, then the document shall not have an attached document template, and applications should use their default template in its place.

[Example: Consider a WordprocessingML document which is attached to a WordprocessingML template located on the local C drive within a file whose name is c:\template.dotx. This association is specified using the following WordprocessingML:

<w:attachedTemplate w:val="c:\template.dotx" />

The attachedTemplate element contains the path to the associated template. end example]

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

<complexType name="CT_Rel">

<attribute ref="r:id" use="required"/>

</complexType>

2.15.1.7 autoCaption (Single Automatic Captioning Setting)

This element specifies what type(s) of objects shall automatically labeled with captions (§2.15.1.17), and with which captions the specified objects shall be labeled as defined in the caption element (§2.15.1.16).

[Example: Consider the diagram below illustrating a two page WordprocessingML document that has leveraged WordprocessingML to automatically label WordprocessingML tables with a specified caption when tables are inserted into the given document.

This type of automatic captioning is specified using the following WordprocessingML fragment:

<w:captions>
  <w:caption w:name="Table" w:pos="below" w:chapNum="On" w:heading="2" w:numFmt="upperCase" w:sep="8212" />
  <w:autoCaptions>
    <w:autoCaption w:name="wfwTable" w:caption="Table" />
  </w:autoCaptions>
</w:captions>

Here, the autoCaption element specifies through the name attribute being set equal to wfwTable that tables will automatically be labeled with the caption specified in the caption element whose name attribute is equal to Table, as the caption element's caption attribute has a value of Table. end example]

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

<complexType name="CT_AutoCaption">

<attribute name="name" type="ST_String" use="required"/>

<attribute name="caption" type="ST_String" use="required"/>

</complexType>

2.15.1.8 autoCaptions (Automatic Captioning Settings)

This element specifies that one or more types of objects, when inserted into a WordprocessingML document, will automatically be labeled with a specific caption defined using the caption element (§2.15.1.16).

[Example: Consider the following example illustrating a two page WordprocessingML document that has leveraged WordprocessingML to automatically label WordprocessingML tables with a specified caption.

This type of automatic captioning is specified using the following WordprocessingML fragment:

<w:captions>
  <w:caption w:name="Table" w:pos="below" w:chapNum="On" w:heading="2" w:numFmt="upperCase" w:sep="8212" />
  <w:autoCaptions>
    <w:autoCaption w:name="wfwTable" w:caption="Table" />
  </w:autoCaptions>
</w:captions>

The autoCaptions element specifies set of objects that when inserted into a WordprocessingML document will automatically be labeled with a given caption. end example]

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

<complexType name="CT_AutoCaptions">

<sequence>

<element name="autoCaption" type="CT_AutoCaption" minOccurs="1" maxOccurs="unbounded"/>

</sequence>

</complexType>

2.15.1.9 autoFormatOverride (Allow Automatic Formatting to Override Formatting Protection Settings)

This element specifies whether formatting automatically applied by an application (i.e. not explicitly applied by a use or an application) shall be allowed to override formatting protection enabled via the formatting attribute on the documentProtection element (§2.15.1.9) when those formatting operations would add formatting which has been explicitly disabled. [Example: Automatically adding superscript to the st in the string 1st. end example]

If this element is omitted, then no automatic formatting rule(s) shall be allowed to override the formatting restrictions enabled for the document.

[Example Consider a WordprocessingML document which has been protected such that a user shall not be able to directly format text within the document. Consider also that the hosting application has been constructed such that if a user enters a ampersand, then one or more alphabetical characters, then another ampersand, that the alphabetical characters are to take on italicized formatting.

If the autoFormatOverride element is omitted or set to false and document protection is enabled, the aforementioned series of events will not cause the English alphabetical characters to be italicized as the document protection preventing formatting of the document in question will supersede the formatting to take place after these events. If this operation should not be prevented when active formatting restrictions are used, this would be specified using the following WordprocessingML:

<w:autoFormatOverride w:val="true"/>

The autoFormatOverride element's val attribute is equal to on specifying that the automatic formatting behavior shall be applied regardless of the formatting restrictions in place. End Example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.10 autoHyphenation (Automatically Hyphenate Document Contents When Displayed)

This element specifies whether the content of a given WordprocessingML document should automatically be hyphenated by the hosting application before it is displayed, if the application supports this functionality.

If this element is omitted, then hyphenation shall not automatically be performed by application displaying this document.

[Example: Consider the images below illustrating a paragraph of text in a WordprocessingML document:

If the content in this document shall automatically be hyphenated when it is displayed, that requirement would be specified using the following WordprocessingML in the document settings:

<w:autoHyphenation w:val="true" />

The resulting output might look like the following (depending on the application's hyphenation algorithm and the hyphenation zone setting (§2.15.1.53):

The autoHypehenation element has its val attribute equal to true, the document is automatically hyphenated and the word sample, beginning at the end of the second line, is hyphenated automatically and thus carried over onto the third line. Conversely, when the autoHypehnation element has its val attribute equal to off, the entire word sample is carried over to the third line as it was not hyphenated automatically and could not fit onto the second line. end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.11 bookFoldPrinting (Book Fold Printing)

This element specifies if the contents of a given WordprocessingML document should be printed as signatures. Signatures are printed sheets, which depict several pages of a document that are folded and bound with other signatures to form a booklet, a set of which can be bound together to form a book like publication. Specifically, this element specifies that each page in a given WordprocessingML document should be oriented in a landscape fashion, divided in half vertically with two left margins emanating from the bisector of the page, and two right margins instantiated at the left and right side of each page.

This element is used in conjunction with the bookFoldPrintingSheets element (§2.15.1.12) to enable a WordprocessingML document to be printed such that the series of signatures printed may be folded and bound to create a booklet.

This element has no impact on the settings of printer leveraged by the hosting application. In other words, if the printer leveraged by the hosting application has been configured to print on one side of a page, including the WordprocessingML for this element has no effect.

If this element is omitted, then pages shall not be printed as signatures. If the bookFoldRevPrinting element (§2.15.1.13) is also specified, then this element shall be ignored.

[Example: Consider a four page WordprocessingML document with a 2,160 twentieths of a point (one and a half inch) left margin, and 1,440 twentieths of a point (one inch) bottom, right, and top margins using the pgMar element (§2.6.11) surrounding the text extents of the page (represented by the gray shaded area in diagrams below). These page margins are specified using the following WordprocessingML:

<w:pgMar w:top="1440" w:right="1440" w:bottom="1440" w:left="2160" />

The necessary WordprocessingML and consequential effect of setting the bookFoldPrinting element's val attribute to true versus false and the bookFoldPrintingSheets element's val attribute to 4, is depicted graphically below--diagrams not drawn to scale:

Assuming the page was already oriented in a landscape fashion, setting the bookFoldPrinting element's val attribute to true divided the page in half vertically, with two left margins emanating from the bisector of the page, and right margins instantiated at the left and right side of each page, enabling two signatures to be printed.

In addition, this element is used in conjunction with the bookFoldPrintingSheets element to enable the given WordprocessingML document to be printed such that the series of signatures printed may be folded and bound to create a booklet. Specifically, the signatures may be placed back to back, with top the bottom of each sheet aligned, and folded such that a booklet is created. end example]

[Note: This element could also be leveraged by the hosting application to notify the application to display two pages per sheets within its user interface to allow for a WYSIWYG user experience. end note]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.12 bookFoldPrintingSheets (Number of Pages Per Booklet)

This element shall be used in conjunction with the bookFoldPrinting (§2.15.1.11) and bookFoldRevPrinting (§2.15.1.13) elements to specify the number of pages to be included in each booklet when printing a series of signatures. Signatures are printed sheets, which depict several pages of a document that are to be folded and bound with other signatures to form a booklet. Booklets can be bound together to form a book like publication.

If this element is omitted, then its default behavior shall be to print the contents of the content on a single sheet. A sheet is a single piece of paper which is folded and cut to produce a book.

[Example: Consider a four page WordprocessingML document will be printed as a set of two signatures to be compiled into a single booklet. This setting would be specified using the following WordprocessingML fragment in the document settings part:

<w:bookFoldPrinting w:val="true" />

<w:bookFoldPrintingSheets w:val="4" />

The bookFoldPrintingSheets element's val attribute specifies that 4 pages shall be included in each booklet. Since each signature contains two pages and are printed such that the signatures may be placed back to back, with top the bottom of each sheet aligned, and folded such that the booklet is created, a booklet containing four pages distributed over two signatures may be created.

This setting is depicted visually using the illustration below (gray shading represents a page):

end example]

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

<complexType name="CT_DecimalNumber">

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

</complexType>

2.15.1.13 bookFoldRevPrinting (Reverse Book Fold Printing)

This element specifies if pages of a given WordprocessingML document are to be printed as signatures in reverse order. Signatures are printed sheets, which depict several pages of a document that are folded and bound with other signatures to form a booklet, a set of which can be bound together to form a book like publication. Specifically, this element specifies that each page in a given WordprocessingML document should be oriented in a landscape fashion and divided in half vertically, with two left margins emanating from the bisector of the page, and right margins instantiated at the left and right side of each page.

In addition, this element is used in conjunction with the bookFoldPrintingSheets element (§2.15.1.12) to enable given WordprocessingML document to be printed such that the series of signatures printed may be folded and bound to create a booklet.

This element has no impact on the settings of printer leveraged by the hosting application. In other words, if the printer leveraged by the hosting application has been configured to print on one side of a page, including the WordprocessingML for this element has no effect.

If this element is omitted, then pages shall not be printed as reverse book fold signatures. If the bookFoldPrinting element (§2.15.1.11) is also specified, then that element shall be ignored, and this element shall be used instead.

[Example: Consider a four page WordprocessingML document with a 2,160 twentieths of a point (one and a half inch) left margin, and 1,440 twentieths of a point (one inch) bottom, right, and top margins using the pgMar element (§2.6.11) surrounding the text extents of the page (represented by the gray shaded area in diagrams below). These page margins are specified using the following WordprocessingML:

<w:pgMar w:top="1440" w:right="1440" w:bottom="1440" w:left="2160" />

The necessary WordprocessingML and consequential effect of setting the bookFoldRevPrinting element's val attribute to true versus false and the bookFoldPrintingSheets element's val attribute to 4, is depicted graphically below--diagrams not drawn to scale:

<w: bookFoldRevPrinting w:val="false"/>	<w: bookFoldRevPrinting w:val="true"/> <w: bookFoldPrintingSheets w:val="4"/>
First Printed Sheet	First Printed Signature
(missing picture pict-2.15.1.13-7)
Second Printed Sheet	Second Printed Signature
(missing picture pict-2.15.1.13-8)

Assuming the page was already oriented in a landscape fashion, setting the bookFoldRevPrinting element's val attribute to true divided the page in half vertically, with two left margins emanating from the bisector of the page, and right margins instantiated at the left and right side of each page, enabling two signatures to be printed.

In addition, this element is used in conjunction with the bookFoldPrintingSheets element to enable the given WordprocessingML document to be printed such that the series of signatures printed may be folded and bound to create a booklet. Specifically, the signatures may be placed back to back, with top the bottom of each sheet aligned, and folded such that a booklet is created. end example]

[Note: This element could also be leveraged by the hosting application to notify the application to display two pages per sheets within its user interface to allow for a WYSIWYG user experience. end note]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.14 bordersDoNotSurroundFooter (Page Border Excludes Footer)

This element specifies that a given WordprocessingML document's page border specified using the pgBorders element (§2.6.10) should not surround contents of the footer.

If this element is omitted, then the page border shall not exclude the footer on the page. As well, this element shall be ignored if the pgBorders element has an offsetFrom attribute which is not equal to text.

[Note: If the pgBorders element has a offsetFrom attribute equal to page, the bordersDontSurroundFooter element shall be ignored as specifying the pgBorders element with a offsetFrom attribute equal to page is to specify that the positioning of borders within the document shall be calculated relative to the edge of the page and therefore irrespective of document content in the footer. end note]

[Example: Consider the following page in a WordprocessingML document:

If this WordprocessingML document is modified to leverage the behavior enabled by this element, this setting would be specified using the following WordprocessingML fragment in the document settings:

<w:bordersDontSurroundFooter w:val="true"/>

The bordersDontSurroundFooter element's val attribute is equal to true specifying that the page border shall not surround the text extents of the footer, as follows:

end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.15 bordersDoNotSurroundHeader (Page Border Excludes Header)

This element specifies that a given WordprocessingML document's page border specified using the pgBorders element (§2.6.10) should not surround contents of the header.

If this element is omitted, then the page border shall not exclude the header on the page. As well, this element shall be ignored if the pgBorders element has a offsetFrom attribute which is not equal to text.

[Note: If the pgBorders element has a offsetFrom attribute equal to page, the bordersDontSurroundHeader element shall be ignored as specifying the pgBorders element with a offsetFrom attribute equal to page is to specify that the positioning of borders within the document shall be calculated relative to the edge of the page and therefore irrespective of document content in the header. end note]

[Example: Consider the following page in a WordprocessingML document:

If this WordprocessingML document is modified to leverage the behavior enabled by this element, this setting would be specified using the following WordprocessingML fragment in the document settings:

<w:bordersDontSurroundHeader w:val="true"/>

The bordersDontSurroundHeader element's val attribute is equal to true specifying that the page border shall not surround the text extents of the header, as follows:

end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.16 caption (Single Caption Type Definition)

This element specifies the contents and positioning for captions which may be used to automatically label objects in a WordprocessingML document. A caption is a string that labels an object included in a WordprocessingML document, and typically consists of a string plus a field which numbers this item within a collection of similar objects.

[Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption:

In this diagram, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of the string Table followed by a field whose result is a decimal number. The settings which automatically produced this form of caption are specified using the following WordprocessingML fragment:

<w:captions>
  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />
</w:captions>

The caption element specifies the parameters for the resulting caption to be used to automatically label content within the WordprocessingML document. Specifically, the name and numFmt attributes specify that captions of this type inserted in the given WordprocessingML document shall consist of the string Table followed by an incrementing decimal number field. In addition, the pos attribute specifies that these captions shall be placed below the object they are used to label.

WordprocessingML is designed such that the caption element may be used in conjunction with applications to provide a dynamic captioning experience. In other words, an application may use the WordprocessingML in the example above to automatically insert a caption consisting of the string Table followed by an incrementing decimal number field below tables when tables are inserted into a WordprocessingML document as defined by the autoCaption element (§2.15.1.7). end example]

Attributes	Description
chapNum (Include Chapter Number in Field for Caption)	Specifies whether or not to display numbering associated with the most recent chapter heading in the WordprocessingML document within the caption field. A chapter heading is a paragraph of text within a WordprocessingML document that is formatted with a style that has been specified by the heading attribute to demarcate chapters in documents. Only a style with its styleID attribute equal to Heading1, Heading2, Heading3, Heading4, Heading5, Heading6, Heading7, Heading8, or Heading9 may be specified as the style used to demarcate chapters in a document. The choice of which of these heading levels shall be used to determine the current chapter number is defined by the value of the corresponding heading attribute. [Example: Heading1 is used as the chapter heading when chapNum is true and heading is 1. end example] If this attribute is omitted, then chapter numbers shall not be included in the resulting caption. [Example: Consider the diagram below: (missing picture pict-2.15.1.16-9) This diagram depicts a WordprocessingML document containing two chapters, each containing two tables labeled with captions. The Heading 2 style has been associated with chapter headings and applied to the strings: Chapter 1 - FY02 and Chapter 2 - FY03 in this document. Specifically, the style used to demarcate chapters, is the style with a styleID attribute equal to Heading2 as specified by the heading attribute value of 2 in the WordprocessingML for this caption, defined as follows: <w:caption w:name="Table" w:pos="below" w:chapNum="true" w:heading="2" w:numFmt="upperCase" w:sep="8212" />  The chapNum attribute has a value of true, specifying that the captions used to label the tables within this document will contain a symbol corresponding to the one-based index of the chapter in which it is contained. This can be seen in that the captions in Chapter 1 contain a 1, while the captions in Chapter 2 contain a 2, each corresponding with their respective chapter number. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§2.18.67).
heading (Style for Chapter Headings)	Specifies the given style that is used to demarcate chapter headings in a document. This value is used to link the chapter headings with paragraphs with a styleID attribute as follows: Value Description 1 Style with styleID of Heading1 2 Style with styleID of Heading2 3 Style with styleID of Heading3 4 Style with styleID of Heading4 5 Style with styleID of Heading5 6 Style with styleID of Heading6 7 Style with styleID of Heading7 8 Style with styleID of Heading8 9 Style with styleID of Heading9 Any other value Application-defined. May be ignored. If this attribute is omitted, then its value shall be assumed to be 1. [Example: Consider the diagram below: (missing picture pict-2.15.1.16-11) This diagram depicts a WordprocessingML document containing two chapters, each containing two tables labeled with captions. The Heading 2 style has been associated with chapter headings and applied to the strings: Chapter 1 - FY02 and Chapter 2 - FY03 in this document. Specifically, the style used to demarcate chapter headings is the style with its styleID attribute equal to Heading" as specified by the heading attribute value of 2 in the WordprocessingML below. <w:caption w:name="Table" w:pos="below" w:chapNum="On" w:heading="2" w:numFmt="upperCase" w:sep="8212" /> In other words, the WordprocessingML above may be used to label tables inserted in a given WordprocessingML document generated by an application with a caption consisting of: the string Table followed by a decimal number corresponding with the chapter number in which the table is present, a dash as defined in the sep attribute, and a capital English letter defined by the numFmt attribute corresponding with the given table's ordering within the current chapter. end example] The possible values for this attribute are defined by the ST_DecimalNumber simple type (§2.18.16).
name (Caption Type Name)	Specifies the literal string component of this caption. This value is used as follows: It is added to the field containing the chapter number and item number of this object when a caption is automatically added to the document. It is used to uniquely label this caption type, allowing it to be linked with classes of objects via the autoCaption element (§2.15.1.7) It may be used to label this caption type in a user interface. [Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption: In this diagram, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of the string Table followed by a decimal number. This caption format is specified with the following WordprocessingML: <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" /> Specifically, the name attribute specifies that the first part of the string that comprises the give caption shall consist of the string Table. end example] The possible values for this attribute are defined by the ST_String simple type (§2.18.89).
noLabel (Do Not Include Name In Caption)	Specifies if the string specified in the name attribute shall be included in the resulting caption when it is automatically added to the document. If set to true, then the label text in the name attribute is omitted when adding the caption. If this attribute is omitted, then the name shall be added to the caption. [Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption: In this diagram, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of only a decimal number. This caption format is specified using the following WordprocessingML: <w:caption w:name="Custom" w:pos="below" w:noLabel="true" w:numFmt="decimal" />  Here, the noLabel attribute is equal to true specifying that when this caption format is automatically added, it shall not include the label. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§2.18.67).
numFmt (Caption Numbering Format)	Specifies the format of the numbering which shall be included in an automatically generated caption to specify the index of this item in that collection (within the current chapter if chapNum is specified, or within the current document story). If this attribute is omitted, then its default value shall be assumed to be decimal. [Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption: In this example, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of only a decimal number. This caption format is specified using the following WordprocessingML: <w:caption w:name="Custom" w:pos="below" w:noLabel="true" w:numFmt="decimal" />  Here, the numFmt attribute is equal to decimal, specifying that a decimal number shall be included in the table caption when it is automatically inserted. End Example] The possible values for this attribute are defined by the ST_NumberFormat simple type (§2.18.66).
pos (Automatic Caption Placement)	Specifies how an automatically inserted caption shall be positioned relative to the object that it is captioning. If this attribute is omitted, then the default value shall be below. [Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption. In this diagram, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of the string Table followed by a decimal number. This caption format is specified using the following WordprocessingML: <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />  The pos attribute specifies that the given caption shall be placed below the object it is labelling. end example] The possible values for this attribute are defined by the ST_CaptionPos simple type (§2.18.8).
sep (Chapter Number/Item Index Separator)	Specifies the character which shall be used to separate the chapter number used in this caption from the caption item numbering. A caption format consists of three components: The (optional) literal string The (optional) chapter number The index of this caption within the chapter/document When the latter two items are both present, they are delimited using the chapter separator specified by this attribute. If this attribute is omitted, then its default value shall be hyphen. If the chapter number is not part of the caption format, then this parameter shall be ignored. [Example: Consider the diagram below: (missing picture pict-2.15.1.16-13) This diagram depicts a WordprocessingML document containing two chapters, each containing two tables labeled with captions. The Heading 2 style has been associated with chapter headings and applied to the strings: Chapter 1 - FY02 and Chapter 2 - FY03 in this document. Specifically, the style used to demarcate chapter headings is the style with a styleID attribute equal to Heading2 as specified by the heading attribute value of 2 in the WordprocessingML below. <w:caption w:name="Table" w:pos="below" w:chapNum="On" w:heading="2" w:numFmt="upperCase" w:sep="hyphen" /> The sep attribute value of hyphen specifies that the chapter number and caption index shall be separated by a hyphen character when displayed in the document. end example] The possible values for this attribute are defined by the ST_ChapterSep simple type (§2.18.9).

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

<complexType name="CT_Caption">

<attribute name="name" type="ST_String" use="required"/>

<attribute name="pos" type="ST_CaptionPos" use="optional"/>

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

<attribute name="heading" type="ST_DecimalNumber" use="optional"/>

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

<attribute name="numFmt" type="ST_NumberFormat" use="optional"/>

<attribute name="sep" type="ST_ChapterSep" use="optional"/>

</complexType>

2.15.1.17 captions (Caption Settings)

This element specifies the presence of information about captions in a given WordprocessingML document. This information is divided into two components:

• The child element caption defines the format for a single type of caption to be automatically added to the document.
• The child element autoCaptions defines the types of objects to which a caption format shall automatically be applied.

This information should be used to determine the captions which are automatically added to objects when they are inserted into a WordprocessingML document. [Note: This setting is typically ignored unless it is specified in an application's default template. end note]

[Example: Consider the diagram below illustrating a WordprocessingML document containing a table that has been labeled with a caption:

In this diagram, the table contained in the WordprocessingML document has been labeled by inserting a caption below the table consisting of the string Table followed by a decimal number. This automatically inserted caption format is specified using the following WordprocessingML:

<w:captions>

  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" /> 

</w:captions>

Here, the captions element specifies the presence of one or more caption formats in a given WordprocessingML document with its child element caption. Specifically, the child element caption specifies a single type of caption to be used within the WordprocessingML document. end example]

Captioning leverages fields (§2.16.5) to label objects with reference to either:

• Other captioned objects within a given document
• Other captioned objects within the same chapter in a given document (when chapter numbers are added by specifiying the chapNum attribute on the caption type.
  
  A chapter is a section of text within a WordprocessingML document that is preceded by content with a style that has been specified by to demarcate chapters in documents. Only one style may be specified as the style used for a single caption type to demarcate chapters in a document. A chapter ends immediately above the next instance of content with the style used to demarcate chapters.

[Example: Consider the diagram below:

This diagram depicts a WordprocessingML document containing two chapters, each containing two tables labeled with captions. The style associated with chapter demarcation has been applied to the strings: Chapter 1 - FY02 and Chapter 2 - FY03 in this document. Specifically, the style used to demarcate chapters is the style with its styleID attribute equal to Heading2 as specified by the heading attribute value of 2 in the WordprocessingML for the caption format:

<w:caption w:name="Table" w:pos="below" w:chapNum="On" w:heading="2" w:numFmt="upperCase" w:sep="8212" /> 

In other words, the WordprocessingML above may be used to label objects (in this case, tables) inserted in a given WordprocessingML document generated by an application with a caption consisting of: the string Table followed by a decimal number corresponding with the chapter number in which the table is present, a hyphen, and a capital English letter corresponding with the given table's index within the given chapter. end example]

[Note: WordprocessingML is designed such that the caption element may be used in conjunction with applications to provide a dynamic captioning experience. In other words, an application may use the WordprocessingML in the example above to automatically insert a caption consisting of the string Table followed by an incrementing decimal number field below tables when tables are inserted into a WordprocessingML document as defined by the autoCaption element (§2.15.1.7). End note]

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

<complexType name="CT_Captions">

<sequence>

<element name="caption" type="CT_Caption" minOccurs="1" maxOccurs="unbounded"/>

<element name="autoCaptions" type="CT_AutoCaptions" minOccurs="0" maxOccurs="1"/>

</sequence>

</complexType>

2.15.1.18 characterSpacingControl (Character-Level Whitespace Compression)

This element specifies how full-width characters in the current WordprocessingML document should be compressed to remove additional whitespace when the contents of this document are displayed, specifically by specifying the set(s) of characters which may be compressed to remove additional whitespace. [Note: The behavior of this element is functionally identical to the CSS text-justify-trim property. end note]

If this element is omitted, then the default value shall be dontCompress.

[Example: Consider the WordprocessingML below:

<w:characterSpacingControl w:val="dontCompress" />

The characterSpacingControl element has a val attribute value of dontCompress, which specifies that no character compression shall be applied to any character when the document is displayed. end example]

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

<complexType name="CT_CharacterSpacing">

<attribute name="val" type="ST_CharacterSpacing" use="required"/>

</complexType>

2.15.1.19 clickAndTypeStyle (Paragraph Style Applied to Automatically Generated Paragraphs)

This element specifies the paragraph style, specified using the style element, which shall be applied to paragraphs which are automatically created when text is inserted into a WordprocessingML document in an area of the document that has no other style associated with it. This style is referenced via the val attribute, which stores the style ID of the style (stored in the styleId attribute on the style definition).

[Guidance: Consider a WordprocessingML document opened in an application that allows users to place their cursor anywhere within the document editing canvas and enter text. The clickAndTypeStyle element should be used to specify the paragraph style to be associated with the paragraph of text entered after a user places their cursor somewhere in the blank document that results in the generation of new paragraphs. end guidance]

If this element is omitted, then the default paragraph style (the paragraph style whose default attribute is set to true), shall be used for automatically generated paragraphs. If the style whose styleId is specified using the val attribute is not a paragraph style or does not exist in the document, then the default paragraph style shall be used instead.

[Example: Consider a WordprocessingML document that has specified that paragraphs which are automatically created when text is inserted in a given area of the document which has no other style associated with it shall be associated with the paragraph style that has a styleId equal to BalloonText.

This is accomplished by specifying a clickAndTypeStyle element with a val attribute equal to the value of the ID of the desired style. This constraint would be specified using the following WordprocessingML:

<w:clickAndTypeStyle w:val="BalloonText" />

The corresponding style in the styles part would be defined as follows:

<w:style w:type="paragraph" w:styleId="BalloonText">
  ...
</w:style>

The clickAndTypeStyle element specifies the use of the paragraph style with the style ID of BalloonText. end example]

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

<complexType name="CT_String">

<attribute name="val" type="ST_String" use="required"/>

</complexType>

2.15.1.20 clrSchemeMapping (Theme Color Mappings)

This element specifies the theme color, stored in the document's Theme part to which the value of this theme color shall be mapped. This mapping enables multiple theme colors to be chained together.

[Example: Consider a WordprocessingML document that shall have the theme color value background1 mapped to the theme color light1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:bg1="light1" />

The clrSchemeMapping element's attribute background1 has a value of light1, specifying that theme color value background1 shall be mapped to the theme color light1. end example]

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

<complexType name="CT_ColorSchemeMapping">

<attribute name="bg1" type="ST_ColorSchemeIndex"/>

<attribute name="t1" type="ST_ColorSchemeIndex"/>

<attribute name="bg2" type="ST_ColorSchemeIndex"/>

<attribute name="t2" type="ST_ColorSchemeIndex"/>

<attribute name="accent1" type="ST_ColorSchemeIndex"/>

<attribute name="accent2" type="ST_ColorSchemeIndex"/>

<attribute name="accent3" type="ST_ColorSchemeIndex"/>

<attribute name="accent4" type="ST_ColorSchemeIndex"/>

<attribute name="accent5" type="ST_ColorSchemeIndex"/>

<attribute name="accent6" type="ST_ColorSchemeIndex"/>

<attribute name="hyperlink" type="ST_ColorSchemeIndex"/>

<attribute name="followedHyperlink" type="ST_ColorSchemeIndex"/>

</complexType>

2.15.1.21 consecutiveHyphenLimit (Maximum Number of Consecutively Hyphenated Lines)

This element specifies the maximum number of consecutive lines of text that can end with a hyphen when the contents of this document are displayed. Once this limit has been reached, the following line shall not be hyphenated regardless of whether or not it meets the criteria needed for hyphenation.

If this element is omitted or has its val attribute equal to 0, the given WordprocessingML document shall have no limit on the number of consecutive lines of text that may end with a hyphen.

[Example: Consider a WordprocessingML document which should automatically be hyphenated. If the contents of this document result in hyphens appearing on every line in the document, as follows:

This output may be undesirable. If the document shall have a maximum of two consecutive hyphens, this requirement is specified using the following WordprocessingML in the document settings:

<w:consecutiveHyphenLimit w:val="2" />

The consecutiveHyphenLimit element's val attribute has a value of 2 specifying that a maximum of two hyphens should be allowed, limiting the hyphenation output like this:

end example]

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

<complexType name="CT_DecimalNumber">

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

</complexType>

2.15.1.22 decimalSymbol (Radix Point for Field Code Evaluation)

This element specifies the character that shall be interpreted as the radix point when evaluating the contents of all fields in the current document.

[Rationale: When evaluating field instructions based on the contents of the current document, it is necessary to know the character which shall be treated as the radix point in order to prevent changes to the calculation of the same field instructions based on the current user's locale. This element stores the radix point which shall be used to evaluate fields in the contents of this document, irrespective of the locale of the application loading the file. end rationale]

If this element is omitted, the application shall use the default radix point of its current locale setting to evaluate field instructions. If this element's attribute value is more than a single character, then the document is non-conformant.

[Example: Consider a WordprocessingML document which should use the comma character as the radix point for all field instructions. This requirement is specified using the following WordprocessingML in the document settings:

<w:decimalSymbol w:val="," />

The decimalSymbol element's val attribute has a value of , specifying that the comma character shall be interpreted as the radix point.

For instance, the string 12.345,00 would be interpreted as a numeric value of twelve thousand three hundred and forty five. If the decimalSymbol was a period, the same string would be twelve and three hundred and forty five thousandths. end example]

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

<complexType name="CT_String">

<attribute name="val" type="ST_String" use="required"/>

</complexType>

2.15.1.23 defaultTableStyle (Default Table Style for Newly Inserted Tables)

This element specifies the table style which shall automatically be applied to the table properties of tables added to this document by an application. Note that it does not change the table style applied to tables which do not reference a style, instead, it automatically applies the style to that table via the tblStyle element (§2.4.59). This link is made by referencing the styleId attribute value of the table style which shall be used to format newly inserted tables.

If this element is omitted, then no table style shall automatically be applied to inserted tables (therefore inheriting the default table style). If the referenced style is not present or not a table style, then no table style shall automatically be applied to inserted tables.

[Example: Consider a WordprocessingML document which should use the LightShading-Accent3 style. This requirement is specified using the following WordprocessingML in the document settings:

<w:defaultTableStyle w:val="LightShading-Accent3" />

The corresponding table style must therefore exist in the styles part:

<w:style w:type="table" w:styleId="LightShading-Accent3">
  ...
</w:style>

The defaultTableStyle element's val attribute has a value of LightShading-Accent3 specifying that that style will be applied automatically to newly inserted tables. end example]

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

<complexType name="CT_String">

<attribute name="val" type="ST_String" use="required"/>

</complexType>

2.15.1.24 defaultTabStop (Distance Between Automatic Tab Stops)

This element specifies the value which shall be used as the multiplier to generate automatic tab stops in this document. Automatic tab stops refer to the tab stop locations which occur after all custom tab stops in the current paragraph have been surpassed.

If this element is omitted, then automatic tab stops should be generated at 720 twentieths of a point (0.5") intervals across the displayed page.

[Example: Consider a WordprocessingML document which should have automatic tab stops every 360 twentieths of a point (0.25 inches). This requirement is specified using the following WordprocessingML in the document settings:

<w:defaultTabStop w:val="360" />

The defaultTabStop element's val attribute has a value of 360 specifying that automatic tab stops shall occur every 1/4th of an inch across the page.

If a custom tab stop was located at 2.28", then the next three automatic tab stops would be at 2.5", 2.75" and 3.0" (the next three multiples of the default tab stop value). end example]

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

<complexType name="CT_TwipsMeasure">

<attribute name="val" type="ST_TwipsMeasure" use="required"/>

</complexType>

2.15.1.25 displayBackgroundShape (Display Background Objects When Displaying Document)

This element specifies whether the images and colors defined in the document's background using the background element (§2.2.1) shall be displayed when the document is displayed in print layout view as specified in the view element (§2.15.1.93).

If this element is omitted, then background shapes shall not be displayed when the document is displayed in print layout view.

[Example: Consider a WordprocessingML document that has a turquoise background specified for all pages and is being displayed in page layout view, as follows:

(missing picture pict-2.15.1.25-17)

If the document's background should not be displayed, that requirement would be specified using the following WordprocessingML in the document settings:

<w:displayBackgroundShape w:val="true" />

The resulting document would display the background in page layout view:

(missing picture pict-2.15.1.25-18)

end example]

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

<complexType name="CT_OnOff">

<attribute name="val" type="ST_OnOff"/>

</complexType>

2.15.1.26 displayHorizontalDrawingGridEvery (Distance between Horizontal Gridlines)

This element specifies the number of horizontal grid units defined using the drawingGridHorizontalSpacing element (§2.15.1.44) which shall be allowed between subsequent visible horizontal drawing grid lines in this document, if gridlines are being shown. [Note: The display of gridlines is an application-level setting not specified in this Office Open XML Standard. end note] The drawing grid is a grid which may be used by applications to help position floating objects in the document.

If this element is omitted, then gridlines shall be displayed for each horizontal grid unit.

[Example: Consider the image below illustrating a WordprocessingML document in which all horizontal grid units are visible (the default setting):

If the gridlines in this document shall only be displayed for every 4th horizontal drawing gridline, that requirement would be specified using the following WordprocessingML in the document settings:

<w:displayHorizontalDrawingGridEvery w:val="4" />

The resulting grid would look like the following:

The displayHorizontalDrawingGridEvery element has its val attribute equal to 4, therefore every fourth gridline is displayed in the document when the drawing grid is turned on. end example]

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

<complexType name="CT_DecimalNumber">

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

</complexType>

2.15.1.27 displayVerticalDrawingGridEvery (Distance between Vertical Gridlines)

This element specifies the number of vertical grid units defined using the drawingGridVerticalSpacing element (§2.15.1.46) which shall be allowed between subsequent vertical gridlines in this document, if gridlines are being shown. [Note: The display of gridlines is an application-level setting not specified in this Office Open XML Standard. end note] The drawing grid is a grid which may be used by applications to help position floating objects in the document.

If this element is omitted, then vertical gridlines shall not be displayed.

[Example: Consider the image below illustrating a WordprocessingML document in which all vertical grid units are visible (the default setting):

If the vertical drawing gridlines in this document shall only be displayed for every 4th gridline, that requirement would be specified using the following WordprocessingML in the document settings:

<w:displayVerticalDrawingGridEvery w:val="4" />

The resulting grid would look like the following:

The displayVerticalDrawingGridEvery element has its val attribute equal to 4, therefore every fourth vertical gridline is displayed in the document when the drawing grid is turned on. end example]

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

<complexType name="CT_DecimalNumber">

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

</complexType>

2.15.1.28 documentProtection (Document Editing Restrictions)

This element specifies the set of document protection restrictions which have been applied to the contents of a WordprocessingML document. These restrictions shall be enforced by applications editing this document when the enforcement attribute is turned on, and should be ignored (but persisted) otherwise. Document protection is a set of restrictions used to prevent unintentional changes to all or part of a WordprocessingML document - since this protection does not encrypt the document, malicious applications may circumvent its use. This protection is not intended as a security feature and may be ignored.

If this element is omitted, then no protection shall be applied to this document.

When a password is supplied via an application which shall be hashed and stored in this element, that process shall be done in two stages:

First, the password shall be hashed using the following algorithm:

• Truncate the password to 15 characters.
• Construct a new NULL-terminated string consisting of single-byte characters:
• Get the single-byte values by iterating through the Unicode characters of the truncated password. For each character, if the low byte is not equal to 0, take it. Otherwise, take the high byte.
• From now on, the single-byte character string is used.
• If the password is empty, return 0.
• Compute the high-order word of the new key:
• Initialize from the initial code array (see below), depending on the password's length. For each character in the password:
• For every bit in the character, starting with the least significant and progressing to (but excluding) the most significant, if the bit is set, XOR the key's high-order word with the corresponding word from the encryption matrix
• Compute the low-order word of the new key:
• Initialize with 0
• For each character in the password, going backwards, low-order word = (((low-order word SHR 14) AND 0x0001) OR (low-order word SHL 1) AND 0x7FFF)) XOR character
• Lastly, low-order word = (((low-order word SHR 14) AND 0x0001) OR (low-order word SHL 1) AND 0x7FFF)) XOR password length XOR 0xCE4B.

Initial code array

The initial code array contains the initial values for the key's high-order word. The initial value depends on the length of the password, as follows:

Encryption matrix

The encryption matrix contains codes used during the calculation of the key's high-order word. As described in the algorithm above, for every bit of the password's characters, if the bit is set, a corresponding value is taken from this encryption matrix and is used to XOR the key's high-order word with it. Each row in the encryption matrix corresponds to a single character from the password, and each of the seven columns corresponds to a particular bit (0-6) in this character.

The values are taken in such a way so that the last character of the password uses the last row in the encryption matrix. The next-to-last character uses the next-to-last row in the matrix, and so on. This mea