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

Navigation:

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

appName (Application Name)

Specifies the name of the application which specified the grammatical settings contained on the attributes for this element.

If an application reads these settings and does not understand the value of this attribute, then its settings may be ignored and the application's default settings used instead.

[Example: Consider the WordprocessingML below:

<w:activeWritingStyle ... w:appName="testApp"/>

The appName attribute has a value of testApp, specifying that the application called testApp specified the grammar checking rules of the given WordprocessingML document. end example]

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

checkStyle (Check Stylistic Rules With Grammar)

Specifies if the grammar content checking performed on this document included stylistic rules for the document content. If specified, applications which support this functionality shall check stylistic rules as well as grammatical ones when checking the grammatical content of this document.

[Example: Consider the WordprocessingML below:

<w:activeWritingStyle ... w:checkStyle="false"/>

The checkStyle attribute has a value of false, specifying that hosting applications shall only check grammatical rules of the given WordprocessingML document. end example]

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

dllVersion (Grammatical Check Engine Version)

Specifies the version of the engine that was used to check the grammatical content of the WordprocessingML document.

[Example: Consider the following WordprocessingML fragment:

  <w:activeWritingStyle ... w:dllVersion="131078" /> 

The dllVersion attribute specifies that the writing style DLL version used to check the writing style of is the writing style DLL version associated with the decimal number 131078. end example]

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

lang (Writing Style Language)

Specifies the language of the engine used to perform the grammatical content checking.

[Example: Consider the following WordprocessingML fragment:

  <w:activeWritingStyle w:lang="en-CA" .../> 

The lang attribute has a value of en-CA, therefore the grammatical check language is specified as English (en) and Canada (CA), resulting in use of the English (Canada) grammar checker. end example]

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

nlCheck (Natural Language Grammar Check)

Specifies whether the engine that was used to check the grammatical content of the WordprocessingML document performed natural language-based analysis.

[Example: Consider the WordprocessingML below:

  <w:activeWritingStyle ... w:nlCheck="1" /> 

The nlCheck attribute has a value of 1, specifying that the writing style DLL supported natural language analysis . end example].

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

vendorID (Grammatical Engine ID)

Specifies a value indicating a unique ID for the writing style engine that was used to check the grammatical content of the WordprocessingML document.

[Example: Consider the WordprocessingML below:

  <w:activeWritingStyle ... w:vendorID="64"/> 

The vendorId attribute has a value of 64, specifying that the grammatical checker used is identified by the decimal number 64.end example]

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

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:

image79

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:

image80

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

image81

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:

image82

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

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (String Value)

Specifies that its contents will contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>

  <w:pStyle w:val="heading1" /> 

</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>

  <w:alias w:val="SDT Title Example" />

  ...

</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

id (Relationship to Part)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID to a specified part.

The specified relationship shall match the type required by the parent element:

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer for the footerReference element
  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/header for the headerReference element
  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/font for the embedBold, embedBoldItalic, embedItalic, or embedRegular elements
  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings for the printerSettings element

[Example: Consider an XML element which has the following id attribute:

<... r:id="rId10" />

The markup specifies the associated relationship part with relationship ID rId1 contains the corresponding relationship information for the parent XML element. end example]

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

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.

image83 image84

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]

Parent Elements

autoCaptions (§2.15.1.8)

Attributes

Description

caption (Caption Used for Automatic Captioning)

Specifies the caption defined in using the caption element (§2.15.1.16) which shall be used to automatically label a given type of object inserted in a WordprocessingML document. The caption settings are linked by matching the value of this attribute with the name attribute of the corresponding caption element.

[Example: Consider the WordprocessingML below

<w:captions>
  <w:caption w:name="table" w:pos="below" w:chapNum="1" w:heading="0" w:noLabel="1" w:numFmt="upperRoman" />
  <w:autoCaptions>
    <w:autoCaption w:name="Paint.Picture"      w:caption="table" />
  </w:autoCaptions>
</w:captions>

The autoCaption element specifies through the name attribute being set equal to wfwTable that tables will automatically be labeled with the caption whose name attribute is equal to Table (specified by the caption element's attribute name having a value of Table). end example]

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

name (Identifier of Object to be Automatically Captioned)

Specifies a unique identifier which may be used to associate objects inserted into the document which are to be automatically labeled with a caption when inserted into the WordprocessingML document.

[Example: Consider the WordprocessingML below specifying that WordprocessingML tables should be labeled with the custom caption:

  <w:autoCaption w:name="wfwTables" w:caption="custom" /> 

The name attribute value of wfwTables specifies that WordprocessingML tables shall be labeled with the custom caption. end example]

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

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.

image83 image84

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]

Parent Elements

captions (§2.15.1.17)

Child Elements

Subclause

autoCaption (Single Automatic Captioning Setting)

§2.15.1.7

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

image85

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):

image86

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

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

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

First Printed Sheet

First Printed Signature

(missing picture pict-2.15.1.11-1)

Second Printed Sheet

Second Printed Signature

(missing picture pict-2.15.1.11-3)

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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):

First Printed Signature

(missing picture pict-2.15.1.12-5)

Second Printed Signature

(missing picture pict-2.15.1.12-6)

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute will contain a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of type ST_DecimalNumber:

<w:... w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

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)

image92

Second Printed Sheet

Second Printed Signature

(missing picture pict-2.15.1.13-8)

image93

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

image94

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:

image95

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

image96

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:

image97

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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:

image98

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]

Parent Elements

captions (§2.15.1.17)

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:

image98

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:

image101

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.

image98

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:

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:

image98

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:

[Example: Consider the diagram below:

(missing picture pict-2.15.1.17-15)

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]

Parent Elements

settings (§2.15.1.78)

Child Elements

Subclause

autoCaptions (Automatic Captioning Settings)

§2.15.1.8

caption (Single Caption Type Definition)

§2.15.1.16

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Value)

Specifies the set(s) of characters which should be compressed when the contents of this document are displayed.

[Example: Consider a WordprocessingML document for which only full-width punctuation characters shall have their whitespace compression applied. This requirement would be specified using the following WordprocessingML:

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

The val attribute value of compressPunctuation specifies that character compression shall be applied to full-width punctuation characters only when the document is displayed. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (String Value)

Specifies that its contents will contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>

  <w:pStyle w:val="heading1" /> 

</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>

  <w:alias w:val="SDT Title Example" />

  ...

</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

accent1 (Accent 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent1 theme color shall be used.

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

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

The accent1 attribute has a value of light1, specifying that uses of the theme color value accent1 shall be mapped to the theme color lt1. end example]

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

accent2 (Accent 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent2 theme color shall be used.

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

<w:clrSchemeMapping w:accent2="hyperlink" />

The accent2 attribute has a value of hyperlink, specifying that uses of the theme color value accent2 shall be mapped to the theme color hlink. end example]

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

accent3 (Accent3 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent3 theme color shall be used.

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

<w:clrSchemeMapping w:accent3="dark1" />

The accent3 attribute has a value of dark1, specifying that uses of the theme color value accent3 shall be mapped to the theme color dk1. end example]

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

accent4 (Accent4 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent4 theme color shall be used.

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

<w:clrSchemeMapping w:accent4="dark2" />

The accent4 attribute has a value of dark2, specifying that uses of the theme color value accent3 shall be mapped to the theme color dk2. end example]

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

accent5 (Accent5 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent5 theme color shall be used.

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

<w:clrSchemeMapping w:accent5="accent1" />

The accent5 attribute has a value of accent1, specifying that uses of the theme color value accent5 shall be mapped to the theme color accent1. end example]

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

accent6 (Accent6 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent6 theme color shall be used.

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

<w:clrSchemeMapping w:accent6="accent1" />

The accent6 attribute has a value of accent1, specifying that uses of the theme color value accent6 shall be mapped to the theme color accent1. end example]

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

bg1 (Background 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the light1 theme color shall be used.

[Example: Consider a WordprocessingML document that shall have references to the theme color bg1 mapped to the theme color lt2 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="light2" />

The bg1 attribute has a value of light2, specifying that uses of the theme color value bg1 shall be mapped to the theme color lt2. end example]

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

bg2 (Background 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the light2 theme color shall be used.

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

<w:clrSchemeMapping w:bg2="dark1" />

The bg2 attribute has a value of dark1, specifying that uses of the theme color value bg2 shall be mapped to the theme color dk1. end example]

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

followedHyperlink (Followed Hyperlink Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the followedHyperlink theme color shall be used.

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

<w:clrSchemeMapping w:followedHyperlink="hyperlink" />

The followedHyperlink attribute has a value of hyperlink, specifying that uses of the theme color value followedHyperlink shall be mapped to the theme color hyperlink. end example]

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

hyperlink (Hyperlink Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the hyperlink theme color shall be used.

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

<w:clrSchemeMapping w:hyperlink="accent1" />

The hyperlink attribute has a value of accent1, specifying that uses of the theme color value hyperlink shall be mapped to the theme color accent1. end example]

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

t1 (Text 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the t1 theme color shall be used.

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

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

The t1 attribute has a value of light1, specifying that uses of the theme color value t1 shall be mapped to the theme color lt1. end example]

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

t2 (Text 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the t2 theme color shall be used.

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

<w:clrSchemeMapping w:t2="dark1" />

The t2 attribute has a value of dark1, specifying that uses of the theme color value t2 shall be mapped to the theme color dk1. end example]

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

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:

image102

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:

image103

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute will contain a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of type ST_DecimalNumber:

<w:... w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (String Value)

Specifies that its contents will contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>

  <w:pStyle w:val="heading1" /> 

</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>

  <w:alias w:val="SDT Title Example" />

  ...

</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (String Value)

Specifies that its contents will contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>

  <w:pStyle w:val="heading1" /> 

</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>

  <w:alias w:val="SDT Title Example" />

  ...

</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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):

image106

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:

image107

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute will contain a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of type ST_DecimalNumber:

<w:... w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

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):

image108

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:

image109

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]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute will contain a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of type ST_DecimalNumber:

<w:... w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

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:

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:

Password length

Initial value for the key's high-order word

1

0xE1F0

2

0x1D0F

3

0xCC9C

4

0x84C0

5

0x110C

6

0x0E10

7

0xF1CE

8

0x313E

9

0x1872

10

0xE139

11

0xD40F

12

0x84F9

13

0x280C

14

0xA96A

15

0x4EC3

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 means that the beginning of the matrix may be unused, depending on the length of the password.

Bit 0

Bit 1

Bit 2

Bit 3

Bit 4

Bit 5

Bit 6

Last-14

0xAEFC

0x4DD9

0x9BB2

0x2745

0x4E8A

0x9D14

0x2A09

Last-13

0x7B61

0xF6C2

0xFDA5

0xEB6B

0xC6F7

0x9DCF

0x2BBF

Last-12

0x4563

0x8AC6

0x05AD

0x0B5A

0x16B4

0x2D68

0x5AD0

Last-11

0x0375

0x06EA

0x0DD4

0x1BA8

0x3750

0x6EA0

0xDD40

Last-10

0xD849

0xA0B3

0x5147

0xA28E

0x553D

0xAA7A

0x44D5

Last-9

0x6F45

0xDE8A

0xAD35

0x4A4B

0x9496

0x390D

0x721A

Last-8

0xEB23

0xC667

0x9CEF

0x29FF

0x53FE

0xA7FC

0x5FD9

Last-7

0x47D3

0x8FA6

0x0F6D

0x1EDA

0x3DB4

0x7B68

0xF6D0

Last-6

0xB861

0x60E3

0xC1C6

0x93AD

0x377B

0x6EF6

0xDDEC

Last-5

0x45A0

0x8B40

0x06A1

0x0D42

0x1A84

0x3508

0x6A10

Last-4

0xAA51

0x4483

0x8906

0x022D

0x045A

0x08B4

0x1168

Last-3

0x76B4

0xED68

0xCAF1

0x85C3

0x1BA7

0x374E

0x6E9C

Last-2

0x3730

0x6E60

0xDCC0

0xA9A1

0x4363

0x86C6

0x1DAD

Last-1

0x3331

0x6662

0xCCC4

0x89A9

0x0373

0x06E6

0x0DCC

Last

0x1021

0x2042

0x4084

0x8108

0x1231

0x2462

0x48C4

[Example: Consider a password which has been supplied - the string "Example". It is already under 15 characters, so truncation does not affect it. It is then converted to a string of single-byte characters.

end example]

[Rationale: This pre-processing step is necessary for compatibility with legacy word processing applications which hashed their password solely using this mechanism. end rationale]

Second, the byte order of the result shall be reversed [Example: 0x64CEED7E becomes 7EEDCE64. end example], and that value shall be hashed as defined by the attribute values.

[Note: The algorithm above can be stated as follows using diagrams:

(missing picture pict-2.15.1.28-19)

end note]

[Example: Consider a WordprocessingML document which specifies that applications shall not allow any modifications to this document other than the addition of comments. This requirement would be specified using the following WordprocessingML in the document settings:

<w:documentProtection w:edit="comments" w:enforcement="true" ... 
  w:cryptAlgorithmClass="hash" w:cryptAlgorithmType="typeAny"
  w:cryptAlgorithmSid="1" w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" /> 

The documentProtection element has an edit attribute value of comments, specifying that the only modification allowed should be comments, the enforcement attribute has a value of true, specifying that the document protection specified is to be enforced on the given document. Finally, in order for the hosting application to stop enforcement of the document protection applied to the document, the hosting application would have to be provided with a password that the hosting application would then hash, compare to the value of the hash attribute (9oN7nWkCAyEZib1RomSJTjmPpCY=), and if the two values matched, halt enforcement of any document protection. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

algIdExt (Cryptographic Algorithm Extensibility)

Specifies that a cryptographic algorithm which was not defined by this Office Open XML Standard has been used to generate the hash value stored with this document.

This value, when present, shall be interpreted based on the value of the algIdExtSource attribute in order to determine the algorithm used, which shall be application-defined. [Rationale: This extensibility affords the fact that with exponentially increasing computing power, documents created in the future will likely need to utilize as yet undefined hashing algorithms in order to remain secure. end rationale]

If this value is present, the cryptAlgorithmClass, cryptAlgorithmType, and cryptAlgorithmSid attribute values shall be ignored in favor of the algorithm defined by this attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:algIdExt="0000000A" 
  w:algIdExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The algIdExt attribute value of 0000000A specifies that the algorithm with hex code A shall be used as defined by the futureCryptography application. end example]

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

algIdExtSource (Algorithm Extensibility Source)

Specifies the application which defined the algorithm value specified by the algIdExt attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:algIdExt="0000000A" 
  w:algIdExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The algIdExtSource attribute value of futureCryptography specifies that the algorithm used here was published by the futureCryptography application. end example]

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

cryptAlgorithmClass (Cryptographic Algorithm Class)

Specifies the class of cryptographic algorithm used by this protection. [Note: The initial version of this Office Open XML Standard only supports a single version - hash - but future versions may expand this as necessary. end note]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmClass attribute value of hash specifies that the algorithm used for the password is a hashing algorithm. end example]

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

cryptAlgorithmSid (Cryptographic Hashing Algorithm)

Specifies the specific cryptographic hashing algorithm which shall be used along with the salt attribute and user-supplied password in order to compute a hash value for comparison.

The possible values for this attribute shall be interpreted as follows:

Value

Algorithm

1

MD2

2

MD4

3

MD5

4

SHA-1

5

MAC

6

RIPEMD

7

RIPEMD-160

8

Undefined. Shall not be used.

9

HMAC

10

Undefined. Shall not be used.

11

Undefined. Shall not be used.

12

SHA-256

13

SHA-384

14

SHA-512

Any other value

Undefined. Shall not be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmSid attribute value of 1 specifies that the SHA-1 hashing algorithm shall be used to generate a hash from the user-defined password. end example]

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

cryptAlgorithmType (Cryptographic Algorithm Type)

Specifies the type of cryptographic algorithm used by this protection. [Note: The initial version of this Office Open XML Standard only supports a single type - typeAny - but future versions may expand this as necessary. end note]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmType attribute value of typeAny specifies that any type of algorithm may have been used for the password. end example]

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

cryptProvider (Cryptographic Provider)

Specifies the cryptographic provider which was used to generate the hash value stored in this document. If the user provided a cryptographic provider which was not the system's built-in provider, then that provider shall be stored here so it can subsequently be used if available.

If this attribute is omitted, then the built-in cryptographic provider on the system shall be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProvider="Krista'sProvider"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProvider attribute value of Krista'sProvider specifies that the cryptographic provider with name "Krista's Provider" shall be used if available. end example]

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

cryptProviderType (Cryptographic Provider Type)

Specifies the type of cryptographic provider to be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderType="rsaAES"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProviderType attribute value of rsaAES specifies that the cryptographic provider type shall be an Advanced Encryption Standard provider. end example]

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

cryptProviderTypeExt (Cryptographic Provider Type Extensibility)

Specifies that a cryptographic provider type which was not defined by this Office Open XML Standard has been used to generate the hash value stored with this document.

This value, when present, shall be interpreted based on the value of the cryptProviderTypeExtSource attribute in order to determine the provider type used, which shall be application-defined. [Rationale: This extensibility affords the fact that with exponentially increasing computing power, documents created in the future will likely need to utilize as yet undefined cryptographic provider types in order to remain secure. end rationale]

If this value is present, the cryptProviderType attribute value shall be ignored in favor of the provider type defined by this attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderTypeExt="00A5691D" 
  w:cryptProvideTypeExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProviderTypeExt attribute value of 00A5691D specifies that the provider type associated with hex code A5691D shall be used as defined by the futureCryptography application. end example]

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

cryptProviderTypeExtSource (Provider Type Extensibility Source)

Specifies the application which defined the provider type value specified by the cryptProviderTypeExt attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderTypeExt="00A5691D" 
  w:cryptProvideTypeExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProvideTypeExtSource attribute value of futureCryptography specifies that the provider type used here was published by the futureCryptography application. end example]

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

cryptSpinCount (Iterations to Run Hashing Algorithm)

Specifies the number of times the hashing function shall be iteratively run (using each iteration's result as the input for the next iteration) when attempting to compare a user-supplied password with the value stored in the hash attribute. [Rationale: Running the algorithm many times increases the cost of exhaustive search attacks correspondingly. Storing this value allows for the number of iterations to be increased over time to accommodate faster hardware (and hence the ability to run more iterations in less time). end rationale]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptSpinCount="100000"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptSpinCount attribute value of 100000 specifies that the hashing function shall be run one hundred thousand times to generate a hash value for comparison with the hash attribute. end example]

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

edit (Document Editing Restrictions)

Specifies the set of editing restrictions which shall be enforced on a given WordprocessingML document, as defined by the simple type referenced below

If this attribute is omitted, the consumer shall behave as though there are no editing restrictions applied to this document; equivalent to an attribute value of none.

[Example: Consider a WordprocessingML document that contains the following WordprocessingML specifying that hosting applications shall enforce read-only protection for a given document:

<w:documentProtection w:edit="readOnly" w:enforcement="1" />

The edit attribute has a value of readOnly and a enforcement attribute with a value of 1, specifying that read-only document protection shall be enforced on the given document. end example]

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

enforcement (Enforce Document Protection Settings)

Specifies if the document protection settings shall be enforced for a given WordprocessingML document. If the value of this element is off, 0, or false, all the WordprocessingML pertaining to document protection is still preserved in the document, but is not enforced. If the value of this element is on, 1, or true, the document protection is enforced.

If this attribute is omitted, then document protection settings shall not be enforced by applications.

[Example: Consider a WordprocessingML document that contains the following WordprocessingML specifying that hosting applications shall apply read-only protection for a given document:

<w:documentProtection w:edit="readOnly" w:enforcement="1" />

The enforcement attribute has a value of 1, specifying that the document protection specified shall be enforced on the given document. end example]

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

formatting (Only Allow Formatting With Unlocked Styles)

Specifies if formatting restrictions are in effect for a given WordprocessingML document. This enables the document to restrict the types of styles that may exist in a given WordprocessingML document. Specifically, by setting this attribute's value equal to true, every style whose locked element (§2.7.3.7) has a value of true (or latent styles (§2.7.3.5) whose locked attribute is true) shall not be available for use in the application, nor should any direct formatting. Only styles with a locked value of false may be used.

If this attribute is omitted, then no formatting restrictions shall be applied, even when document protection is enforced.

[Example: Consider a WordprocessingML document that shall apply formatting protection. This requirement would be specified using the following WordprocessingML in the document settings:

<w:documentProtection w:formatting="true" w:enforcement="true" /> 

If the following definition for a style was also present in the document:

<w:style w:type="paragraph" w:styleId="Heading1">

  <w:name w:val="heading 1" /> 

  <w:locked="1" /> 

  ...

</w:style>

The formatting attribute has a value of true specifying that the applications shall not allow the style above to be added to the WordprocessingML document. This does not preclude previous uses of that style (which shall not be removed), but does prevent new uses of this style from being added. end example]

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

hash (Password Hash)

Specifies the hash value for the password stored with this document. This value shall be compared with the resulting hash value after hashing the user-supplied password using the algorithm specified by the preceding attributes and parent XML element, and if the two values match, the protection shall no longer be enforced.

If this value is omitted, then no password shall be associated with the protection, and it may be turned off without supplying any password.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The hash attribute value of 9oN7nWkCAyEZib1RomSJTjmPpCY= specifies that the user-supplied password shall be hashed using the pre-processing defined by the parent element (if any) followed by the SHA-1 algorithm (specified via the cryptAlgorithmSid attribute value of 1) and that the resulting has value must be 9oN7nWkCAyEZib1RomSJTjmPpCY= for the protection to be disabled. end example]

The possible values for this attribute are defined by the XML Schema base64Binary datatype.

salt (Salt for Password Verifier)

Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm defined by the preceding attribute values to generate the hash attribute, and which shall also be prepended to the user-supplied password before attempting to generate a hash value for comparison. A salt is a random string which is added to a user-supplied password before it is hashed in order to prevent a malicious party from pre-calculating all possible password/hash combinations and simply using those precalculated values (often referred to as a "dictionary attack").

If this attribute is omitted, then no salt shall be prepended to the user-supplied password before it is hashed for comparison with the stored hash value.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:salt="ZUdHa+D8F/OAKP3I7ssUnQ=="
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The salt attribute value of ZUdHa+D8F/OAKP3I7ssUnQ== specifies that the user-supplied password shall have this value prepended before it is run through the specified hashing algorithm to generate a resulting hash value for comparison. end example]

The possible values for this attribute are defined by the XML Schema base64Binary datatype.

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

<complexType name="CT_DocProtect">

<attribute name="edit" type="ST_DocProtect" use="optional"/>

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

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

<attributeGroup ref="AG_Password"/>

</complexType>

2.15.1.29 documentType (Document Classification)

This element specifies the classification of a given WordprocessingML document as a letter, email, or general document.

[Note: This element may be used by hosting applications to facilitate customized user interface and/or automatic formatting behaviors based on the 'type' of a given WordprocessingML document. end note]

If this element is omitted, then the document shall be classified as a general document.

[Example: Consider a set of WordprocessingML documents which should be classified as 'letters'. This classification would be specified using the following WordprocessingML in the document settings of these documents:

<w:documentType w:val="letter" /> 

The documentType element's val attribute is equal to letter, specifying that the hosting application shall apply the behaviors it has specified for letters to the given WordprocessingML document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Document Classification Value)

Specifies the classification of the document based on the types defined in the referenced simple type definition.

[Example: Consider a WordprocessingML document which should be classified as an e-mail message. This classification would be specified using the following WordprocessingML in the document settings:

<w:documentType w:val="eMail" /> 

The val attribute is equal to eMail, specifying that the hosting application may apply e-mail behaviors (if any) to this document. end example]

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

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

<complexType name="CT_DocType">

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

</complexType>

2.15.1.30 docVar (Single Document Variable)

This element specifies the parameters of a single document variable. A document variable is a storage location for arbitrary customer data in name/value pairs that will be persisted in a given WordprocessingML document. Specifically, this element specifies through its name and val attributes the name and value pair for a given document variable.

[Note: This mechanism is maintained for legacy compatibility only, and should be avoided in favor of the custom XML data support defined in this Office Open XML Standard. end note]

[Example: Consider the following WordprocessingML fragment specifying a document variable named example and containing the value example value:

<w:docVars>

  <w:docVar w:name="example" w:val="example value" />

</w:docVars>

The docVar element defines a single document variable, named example using the name attribute, and assigned the value example value through the val attribute. end example]

Parent Elements

docVars (§2.15.1.31)

Attributes

Description

name (Document Variable Name)

Specifies the name of the parent document variable.

[Example: Consider the following WordprocessingML fragment specifying a document variable:

<w:docVars>

  <w:docVar w:name="example name" w:val="example value" />

</w:docVars>

The name attribute specifies that the name of the document variable is example name. end example]

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

val (Document Variable Value)

Specifies the value of the parent document variable.

[Example: Consider the following WordprocessingML fragment specifying a document variable:

<w:docVars>

  <w:docVar w:name="example name" w:val="Tristan Davis" />

</w:docVars>

The val attribute specifies that the value of the document variable is Tristan Davis. end example]

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

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

<complexType name="CT_DocVar">

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

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

</complexType>

2.15.1.31 docVars (Document Variables)

This element specifies the presence of document variables in a WordprocessingML. A document variable is a storage location for arbitrary customer data in name/value pairs that will be persisted in a given WordprocessingML document.

[Note: This mechanism is maintained for legacy compatibility only, and should be avoided in favor of the custom XML data support defined in this Office Open XML Standard. end note]

[Example: Consider the following WordprocessingML specifying three document variables:

<w:docVars>

  <w:docVar ... />
  <w:docVar ... />
  <w:docVar ... />
</w:docVars>

The docVars element contains three child elements each defining a single document variable in this document. end example]

Parent Elements

settings (§2.15.1.78)

Child Elements

Subclause

docVar (Single Document Variable)

§2.15.1.30

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

<complexType name="CT_DocVars">

<sequence>

<element name="docVar" type="CT_DocVar" minOccurs="0" maxOccurs="unbounded"/>

</sequence>

</complexType>

2.15.1.32 doNotAutoCompressPictures (Do Not Automatically Compress Images)

This element specifies that pictures in this document shall not automatically be compressed when saving the document in order to reduce the overall size of the resulting WordprocessingML document.

If this element is omitted, applications may perform basic compression on images before saving the contents of the document.

[Example: Consider a WordprocessingML document which should never have its images compressed before they are saved. This requirement would be specified using the following WordprocessingML:

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

The doNotAutoCompressPictures element's val attribute has a value of true specifying that images shall not be automatically compressed when the document is saved. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.33 doNotDemarcateInvalidXml (Do Not Show Visual Indicator For Invalid Custom XML Markup)

This element specifies whether a visual cue should be displayed around content contained in a WordprocessingML document which is contained with custom XML markup specified via the customXml element when an application determines that the current XML markup (or its contents) violate the constraints of the attached XML schema(s).

If this element is not present in a WordprocessingML document visual cues shall be displayed on content contained in custom XML markup in a WordprocessingML document which is considered to be invalid based on the associated XML schema(s).

[Example: Consider a WordprocessingML document which should show no visual indication of invalid custom XML markup. This requirement would be specified using the following WordprocessingML:

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

The doNotDemarcateInvalidXml element's val attribute has a value of true specifying the display of any visual indication of invalid custom XML markup shall be suppressed for this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.34 doNotDisplayPageBoundaries (Do Not Display Visual Boundary For Header/Footer or Between Pages)

This element specifies whether applications displaying this document should display the contents of the header and footer when displaying the document in print layout view (§2.15.1.93) or should collapse those areas as well as the whitespace on all displayed pages so that the text extents are directly following one another. [Rationale: Collapsing the ends of pages makes it easier to read the contents of the document, since the text flows between pages without whitespace, while maintaining the WYSIWYG functionality of print layout view for the document's main content. end rationale]

If this element is omitted, then all pages should be shown at their full size (including whitespace and headers/footers) when they are displayed in print layout view.

[Example: Consider the images below illustrating two pages in a WordprocessingML document:

image113

If document shall automatically have whitespace between pages removed when it is displayed, that requirement would be specified using the following WordprocessingML in the document settings:

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

The resulting output might look like the following:

image114

The doNotDisplayPageBoundaries element has its val attribute equal to true, therefore the document is automatically displayed with whitespace between text extents on following pages compressed, allowing the pages to be viewed more easily. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.35 doNotEmbedSmartTags (Remove Smart Tags When Saving)

This element specifies if any smart tags specified using the smartTag element shall be removed from the contents of this document before it is resaved. This setting shall also prevent the addition of new smart tags to the content of the document.

If this element is omitted, then smart tags shall not be removed from the file when it is saved.

[Example: Consider a WordprocessingML document which should never be saved with smartTag elements in its contents. This requirement is specified using the following WordprocessingML fragment in the document settings:

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

The doNotEmbedSmartTags element's val attribute has a value of true specifying that smart tags shall never be saved in the contents of this document. For example, if a run formerly looked like this:

<w:p>
  <w:r>
    <w:t xml:space="preserve">Hello</w:t>
  </w:r>
  <w:smartTag ... >
    <w:r>
      <w:t>world<w:t>
    </w:r>
  </w:smartTag>
</w:p>

The presence of this element specifies that the SmartTag element shall be removed, and applications may then choose to combine duplicated runs as desired. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.36 doNotHyphenateCaps (Do Not Hyphenate Words in ALL CAPITAL LETTERS)

This element specifies whether or not words comprised of all capital letters shall be hyphenated within a given document when automatic hyphenation is specified via the autoHyphenation element (§2.15.1.10).

If this element is omitted, then words in ALL CAPITAL LETTERS shall be hyphenated when the document is hyphenated.

[Example: Consider a document which is automatically hyphenated containing the following paragraph of content:

image115

If words in ALL CAPITAL LETTERS shall not be hyphenated, this requirement would be specified by adding the following WordprocessingML to the document settings part:

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

The resulting content would not be hyphenated:

image116

The doNotHyphenateCaps element val set to true, specifying that the first line of text to end with the word SHORT as the word HYPHENATION had to be moved to the second line since it could not fit in its entirety on the first line.

Conversely, setting the doNotHyphenateCaps element val set to off (the default) caused the first line of text to contain a hyphenated portion of the word HYPHENATION as hyphenation of words comprised of all capital letters is permitted. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.37 doNotIncludeSubdocsInStats (Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics)

This element specifies if document content contained in text boxes, footnotes, and endnotes shall be excluded when an application calculates a given document's statistics when these values are calculated and/or displayed by an application.

[Note: Some examples of document statistics that an application may chose to calculate are: number of words, number of characters, number of paragraphs, number of pages, number of lines, and so on. end note]

[Example: Consider a WordprocessingML that specifies that it shall not include these document stories when its contents are used to calculate document statistics. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The doNotIncludeSubdocsInStats element's val attribute has a value of true specifying that only the contents of the main document story should be used when calculating document statistics. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.38 doNotShadeFormData (Do Not Show Visual Indicator For Form Fields)

This element specifies whether a visual cue should be displayed around form fields contained in a WordprocessingML document specified via the FORMTEXT, FORMCHECKBOX, or FORMDROPDOWN fields.

If this element is not present in a WordprocessingML document visual cues should be displayed on form fields contained in the document.

[Example: Consider a WordprocessingML document which should no visual indication of form fields. This requirement would be specified using the following WordprocessingML:

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

The doNotShadeFormData element's val attribute has a value of true specifying the display of any visual indication of form fields shall be suppressed for this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.39 doNotTrackFormatting (Do Not Track Formatting Revisions When Tracking Revisions)

This element specifies that applications shall not track revisions made to the formatting of this WordprocessingML document when the trackRevisions element (§2.15.1.90) is turned on.

If this element is omitted, then revisions to formatting shall be generated by changes to the contents of this document when the trackRevisions element is turned on.

[Example: Consider a WordprocessingML document containing the text run Example that shall have revisions tracked. Example WordprocessingML from Document 1 is given below:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
    </w:p>
  </w:body>
</w:document>

If the word text was added to the end of this document and bolded, the resulting WordprocessingML would be output as follows:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
      <w:ins ... >
        <w:r>
          <w:rPr>
            <w:b/>
            <w:rPrChange ... >
              <w:rPr/>
            <w:rPrChange>
          </w:rPr>
          <w:t>text</w:t>
        </w:r>
      </w:ins>
    </w:p>
  </w:body>
</w:document>

If changes to formatting were turned off using the following WordprocessingML syntax in the document settings:

<w:settings>
  <w:trackRevisions w:val="true" />
  <w:doNotTrackFormatting w:val="true" />
  ...
</w:settings>

The same revision (the word text was added to the end of this document and bolded) would result in the following markup:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
      <w:ins ... >
        <w:r>
          <w:rPr>
            <w:b/>
          </w:rPr>
          <w:t>text</w:t>
        </w:r>
      </w:ins>
    </w:p>
  </w:body>
</w:document>

The doNotTrackFormatting element's val attribute was set to true, therefore the changes to the formatting of the document were not tracked as revisions in the document's WordprocessingML. Specifically, applying bold formatting to the text was not tracked as a revision with the rPrChange (§2.13.5.32) element. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.40 doNotTrackMoves (Do Not Use Move Syntax When Tracking Revisions)

This element specifies that applications shall not track revisions made to this WordprocessingML document as moves when the trackRevisions element (§2.15.1.90) is turned on, even when that syntax is appropriate. Instead, applications should use a standard insertion and deletion annotation syntax. Existing moves shall not be modified. [Rationale: This element is provided to enable interoperability with earlier word processing applications which do not understand moves. end rationale]

If this element is omitted, then move annotations may be generated by changes to the contents of this document when the trackRevisions element is turned on as appropriate.

[Example: Consider a WordprocessingML that specifies that it shall not have additional moves added to its contents. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The doNotTrackMoves element's val attribute has a value of true specifying that insertion/deletion annotations shall be used rather than moves when revisions are tracked in this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.41 doNotUseMarginsForDrawingGridOrigin (Do Not Use Margins for Drawing Grid Origin)

This element specifies that the top-left corner of the page shall not be used as the origin for the drawing grid. The drawing grid is a virtual grid which may be used by applications to specify where drawing objects shall be positioned on a page when inserted (i.e. to ensure objects are aligned, etc.). If this element is present the grid shall start at the top-left edge of the page and not the text extents.

If this element is omitted, then the gridlines shall start at the topmost edge of the text extents.

[Example: Consider a WordprocessingML document whose drawing grid shall begin at the top left edge of the page. This requirement would be specified using the following WordprocessingML markup in the document settings:

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

The doNotUseMarginsForDrawingGridOrigin element's val attribute is equal to true specifying that the document's drawing grid shall begin from the top left corner of the page, rather than the top left corner of the text extents. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.42 doNotValidateAgainstSchema (Do Not Validate Custom XML Markup Against Schemas)

This element specifies that applications shall not validate the custom XML markup in this document against the applicable custom XML schema(s), even when those schemas are available. The application should silently behave as if it was unable to provide this functionality.

If this element is omitted, then applications which support this functionality should attempt to validate the custom XML contents against any available related custom XML schema(s).

[Example: Consider a WordprocessingML document which should not have its custom XML content validated even by applications which support this operation. This requirement is specified using the following WordprocessingML in the document settings:

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

The doNotValidateAgainstSchema element's val attribute has a value of true specifying that the custom XML markup in this document shall not be validated. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.43 drawingGridHorizontalOrigin (Drawing Grid Horizontal Origin Point)

This element specifies the distance from of the left edge of the page which shall be used as the origin for the horizontal gridlines used by the drawing grid. The drawing grid is a virtual grid which may be used by applications to specify where drawing objects shall be positioned on a page when inserted (i.e. to ensure objects are aligned, etc.). Since the grid always covers the entire page when the doNotUseMarginsForDrawingGridOrigin element (§2.15.1.41) is specified, this element shall only affect the starting edge of the first horizontal gridline displayed (i.e. it only adjusts the grid by the modulus of the value against the width of one grid unit).

If this element is omitted, then the gridlines shall start at the leftmost edge of the page. If the doNotUseMarginsForDrawingGridOrigin element is not specified, then this element is ignored.

[Example: Consider a WordprocessingML document whose drawing grid shall begin three inches (4320 twentieths of a point) before the left edge of the page. This requirement would be specified using the following WordprocessingML markup in the document settings:

<w:settings>
  ...
<w:dontuseMarginsForDrawingGridOrigin w:val="true" />
<w:drawingGridHorizontalOrigin w:val="4320" />
  ...
</w:settings>

The drawingGridHorizontalOrigin element's val attribute is equal to 4320 specifying that the horizontal edge of the document's drawing grid shall begin three inches (4320 twentieths of a point) from the left edge of the page, since the dontUseMarginsForDrawingGridOrigin element's val attribute is equal to true. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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.44 drawingGridHorizontalSpacing (Drawing Grid Horizontal Grid Unit Size)

This element specifies the width of horizontal grid units in this document. 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 each horizontal grid unit shall be 180 twentieths of a point (0.125") in width.

[Example: Consider the image below illustrating a WordprocessingML document in which all horizontal grid units are each 144 twentieths of a point wide (and all are showing):

image117

If the gridlines in this document shall only be displayed for every half an inch, that requirement would be specified using the following WordprocessingML in the document settings:

<w:drawingGridHorizontalSpacing w:val="720" />

The resulting grid would look like the following:

image118

The drawingGridHorizontalSpacing element has its val attribute equal to 720, therefore every horizontal gridline has a width of one half of an inch (720 twentieths of a point). end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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.45 drawingGridVerticalOrigin (Drawing Grid Vertical Origin Point)

This element specifies the distance from of the top edge of the page which shall be used as the origin for the vertical gridlines used by the drawing grid. The drawing grid is a virtual grid which may be used by applications to specify where drawing objects shall be positioned on a page when inserted (i.e. to ensure objects are aligned, etc.). Since the grid always covers the entire page when the doNotUseMarginsForDrawingGridOrigin element (§2.15.1.41) is specified, this element shall only affect the starting edge of the first vertical gridline displayed (i.e. it only adjusts the grid by the modulus of the value against the width of one grid unit).

If this element is omitted, then the gridlines shall start at the topmost edge of the page. If the doNotUseMarginsForDrawingGridOrigin element is not specified, then this element is ignored.

[Example: Consider a WordprocessingML document whose drawing grid shall begin one inch (1440 twentieths of a point) before the top edge of the page. This requirement would be specified using the following WordprocessingML markup in the document settings:

<w:settings>
  ...
<w:dontuseMarginsForDrawingGridOrigin w:val="true" />
<w:drawingGridVerticallOrigin w:val="1440" />
  ...
</w:settings>

The drawingGridVerticalOrigin element's val attribute is equal to 1440 specifying that the vertical edge of the document's drawing grid shall begin one inch (1440 twentieths of a point) from the top edge of the page, since the dontUseMarginsForDrawingGridOrigin element's val attribute is equal to true. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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.46 drawingGridVerticalSpacing (Drawing Grid Vertical Grid Unit Size)

This element specifies the width of vertical grid units in this document. 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 each vertical grid unit shall be 180 twentieths of a point (0.125") in width.

[Example: Consider the image below illustrating a WordprocessingML document in which all vertical grid units are each 144 twentieths of a point high (and all are showing):

image117

If the vertical gridlines in this document shall only be displayed for every half an inch, that requirement would be specified using the following WordprocessingML in the document settings:

<w:drawingGridVerticalSpacing w:val="720" />

The resulting grid would look like the following:

image119

The drawingGridVerticalSpacing element has its val attribute equal to 720, therefore every vertical gridline has a height of one half of an inch (720 twentieths of a point). end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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.47 forceUpgrade (Upgrade Document on Open)

This element specifies that the contents of this document may be upgraded and that the resulting document shall not have its functionality limited to only those functions compatible with earlier word processing applications. The only actions required as part of upgrading the document are:

[Note: The remaining operations which shall be performed as part of upgrading the document are application-defined and outside the scope of this Office Open XML Standard. end note]

[Example: Consider a WordprocessingML document that specifies that it shall automatically be upgraded when it is opened by an application. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The forceUpgrade element's val attribute has a value of true specifying that this document shall be upgraded by any application which supports this operation. end example]

Parent Elements

settings (§2.15.1.78)

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

<complexType name="CT_Empty"/>

2.15.1.48 formsDesign (Structured Document Tag Placeholder Text Should be Resaved)

This element specifies that the document was last saved while the placeholder text of all structured document tags in this document were being edited. This means that the placeholder text currently displayed in all structured document tags which are displaying the showingPlcHdr element (§2.5.2.38) shall be committed to the corresponding glossary document entry as specified using the docPart element (§2.12.5) when this document is opened, in order to ensure that the most recent placeholder text is stored in the glossary document entry. If the current placeholder text cannot be saved as a glossary document entry, then it should be modified as needed before saving.

If this element is omitted, then the placeholder text in this document should not automatically be resaved when the document is opened.

[Example: Consider a WordprocessingML document that specifies that its placeholder text should be resaved to the glossary document when the file is opened. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The formsDesign element's val attribute has a value of true specifying that this document should be resaved to its glossary document by any application which supports this operation. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.49 gutterAtTop (Position Gutter At Top of Page)

This element specifies that a given WordprocessingML document's gutter shall be positioned at the top of the document's pages when the document is displayed. A gutter is the white space formed by the inner margins of two pages facing one another; such as the white space between the text on pages of a book when the book is opened.

If this element is omitted, then the gutter shall not be positioned at the top of the page. If the mirrorMargins (§2.15.1.57), bookFoldPrinting (§2.15.1.11), bookFoldRevPrinting (§2.15.1.13), or printTwoOnOne (§2.15.1.64) elements are used within a given document, the gutterAtTop element shall not be used. Rather, the gutter shall be positioned automatically as necessary to enable the printing and page layout capabilities of these settings.

[Example: Consider a one page WordprocessingML document with a 1,440 twentieths of a point (one inch) top margin and gutter, and a 720 twentieths of a point (one half of an inch) header. Consider also, that the gutter shall exist at the top of the document's pages. This requirement is specified using the following WordprocessingML in the section properties:

<w:pgMar w:top="1440" ... w:header="720" ... w:gutter="1440" />

And the following WordprocessingML in the document settings:

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

The resulting document's pages would have the gutter positioned as follows:

(missing picture pict-2.15.1.49-22)

The gutterAtTop element's val attribute is equal to on, specifying that the gutter shall appear at the top of each page. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.50 hdrShapeDefaults (Default Properties for VML Objects in Header and Footer)

This element specifies the default parameters for object using the ' (§6.1) inserted in the header and footer of a WordprocessingML document. The definition and semantics of these parameters is described in the VML - Office Drawing subclause (§6.2) of this Office Open XML Standard.

If this element is omitted, then no default properties are applied to VML objects in the header and footer of this document.

[Example: Consider a WordprocessingML document whose document settings contain the following markup:

<w:hdrShapeDefaults>
  <o:shapedefaults v:ext="edit" spidmax="2050" fillcolor="none [3207]" strokecolor="none [3041]">
    <v:fill color="none [3207]" />
    <v:stroke color="none [3041]" weight="3pt" />
    <v:shadow on="t" type="perspective" color="none [1607]" opacity=".5" offset="1pt" offset2="1pt" />
  </o:shapedefaults>
  <o:shapelayout v:ext="edit">
    <o:idmap v:ext="edit" data="2" />
  </o:shapelayout>
</w:hdrShapeDefaults>

The hdrShapeDefaults element specifies a set of shape defaults which shall be applied to the set of all shapes present in the header and footer of this document. end example]

Parent Elements

settings (§2.15.1.78)

Child Elements

Subclause

Any element from the urn:schemas-microsoft-com:office:office namespace

§6.2

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

<complexType name="CT_ShapeDefaults">

<choice maxOccurs="unbounded">

<any processContents="lax" namespace="urn:schemas-microsoft-com:office:office" minOccurs="0" maxOccurs="unbounded"/>

</choice>

</complexType>

2.15.1.51 hideGrammaticalErrors (Do Not Display Visual Indication of Grammatical Errors)

This element specifies whether a visual cue should be displayed around run content contained in a WordprocessingML document which has been flagged as a possible grammatical error using the proofErr element (§2.13.8.1) or via the application's own grammar engine.

If this element is not present in a WordprocessingML document, visual cues shall be displayed on content contained in a WordprocessingML document which is considered to contain grammatical errors.

[Example: Consider a WordprocessingML document which should show no visual indication of grammatical errors. This requirement would be specified using the following WordprocessingML:

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

The hideGrammaticalErrors element's val attribute has a value of true specifying the display of any visual indication of grammatical errors shall be suppressed for this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.52 hideSpellingErrors (Do Not Display Visual Indication of Spelling Errors)

This element specifies whether a visual cue should be displayed around run content contained in a WordprocessingML document which has been flagged as a possible spelling error using the proofErr element (§2.13.8.1) or via the application's own spelling engine.

If this element is not present in a WordprocessingML document, visual cues shall be displayed on content contained in a WordprocessingML document which is considered to contain spelling errors.

[Example: Consider a WordprocessingML document which should show no visual indication of spelling errors. This requirement would be specified using the following WordprocessingML:

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

The hideSpellingErrors element's val attribute has a value of true specifying the display of any visual indication of spelling errors shall be suppressed for this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.53 hyphenationZone (Hyphenation Zone)

This element specifies the hyphenation zone which shall be used when automatically or manually hyphenating the contents of this document. The hyphenation zone is the amount of whitespace which may be left at the end of a line (or added to justified lines) before hyphenation should be attempted on the next word in the document (in order to reduce the amount of whitespace on the line). A smaller hyphenation zone should reduce the raggedness of the right edge of a given document's body text, as more words will be hyphenated. Conversely, a larger hyphenation zone should increase the raggedness of the right edge of a given document's text, as fewer words will be hyphenated.

If this element is omitted, then a default hyphenation zone of 360 twentieths of a point (0.25") shall be applied when performing hyphenation on this document.

[Example: Consider the images below illustrating a paragraph of text in a WordprocessingML document which was automatically hyphenated with the default hyphenation zone:

image121

If document shall instead be hyphenated using a hyphenation zone of one-half of an inch, that requirement would be specified using the following WordprocessingML in the document settings:

<w:hyphenationZone w:val="720" />

The resulting output would only hyphenate words when the remaining line whitespace was less than half an inch, and would look like the following:

image122

The hyphenationZone element has its val attribute equal to 720, therefore lines in the document are hyphenated when the remaining line spacing is less than 72o twentieths of a point (0.5"), resulting in fewer hyphens. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Measurement in Twentieths of a Point)

Specifies a positive measurement value, specified in twentieths of a point. This value is interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML element with a val attribute containing a positive measurement in twentieths of a point:

<w:... w:val="720" />

The val attribute has a value of 720, specifying that this measurement value is 720 twentieths of a point (0.5"). This value is interpreted by the parent element as needed. end example]

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

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.54 ignoreMixedContent (Ignore Mixed Content When Validating Custom XML Markup)

This element specifies that applications should ignore all text content which is not contained within a leaf custom XML markup element when validating the contents of the custom XML markup in this document against one or more attached custom XML schema(s). A leaf element is a custom XML element which has no child custom XML elements (it is a leaf in the custom XML tree).

If this element is omitted, then text content in leaf elements shall not be ignored when validating the custom XML markup against one or more custom XML schema(s).

[Example: Consider a WordprocessingML document which should not have its custom XML content validated even by applications which support this operation. This requirement is specified using the following WordprocessingML in the document settings:

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

The doNotValidateAgainstSchema element's val attribute has a value of true specifying that the custom XML markup in this document shall not be validated. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.55 linkStyles (Automatically Update Styles From Document Template)

This element specifies that styles in the given document shall be updated to match the styles in the attached template specified using the attachedTemplate element (§2.15.1.6) when the document is opened by a hosting application. This setting enables the styles contained in documents with attached templates to stay synchronized with the styles used in the attached template.

If this element is omitted, then styles shall not be updated based on the document template regardless of its availability. If the attached template cannot be located or is not a valid file, then this setting should be silently ignored.

[Example: Consider a WordprocessingML document which should always update its styles with those defined in the document's attached template. This requirement would be specified using the following WordprocessingML in the document settings:

<w:settings>
  <w:linkStyles w:val="true" />
  <w:attachedTemplate r:id="rId10" />
  ...
</w:settings>

The linkStyles element has a val attribute value of true, specifying that applications should attempt to locate the document template referenced by the relationship specified in the attachedTemplate element and update the document's styles with the styles from that template. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.56 listSeparator (List Separator for Field Code Evaluation)

This element specifies the character that shall be interpreted as a list item separator 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 list separator in order to prevent changes to the calculation of the same field instructions based on the current user's locale. This element stores the list separator 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 list separator 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 semicolon character as the list separator for all field instructions. This requirement is specified using the following WordprocessingML in the document settings:

<w:listSeparator w:val=";" />

The listSeparator element's val attribute has a value of ; specifying that the semicolon character shall be interpreted as a list item separator.

For instance, the string 10;20,5 would be interpreted as having two values - 10 and 20,5. If the listSeparator was a comma, the same string would be interpreted as 10;20 and 5. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (String Value)

Specifies that its contents will contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>

  <w:pStyle w:val="heading1" /> 

</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>

  <w:alias w:val="SDT Title Example" />

  ...

</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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.57 mirrorMargins (Mirror Page Margins)

This element specifies that the left and right margins defined in the section properties shall be swapped on facing pages.

[Guidance: This setting is generally used when printing on both sides of pages and binding them like a book. end guidance]

[Example: Consider a graphical representation (below) of a three page WordprocessingML document with a left margin of 1" and a right margin of 2".

If the mirrorMargins element is present in the document settings with its val attribute equal to true, as follows:

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

The resulting pages will have mirrored margins as follows (un this representation, the gray rectangles representing the text extents on each page):

image123

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.58 noLineBreaksAfter (Custom Set of Characters Which Cannot End a Line)

This element specifies the set of characters which shall be restricted from ending a line for runs of text which shall be subject to custom line breaking logic using the kinsoku element (§2.3.1.16) when the contents of the document are displayed. This constraint shall only apply to text which has been flagged in the language of this rule via the lang element (§2.3.2.18) or automatic detection methods outside the scope of this Office Open XML Standard.

If this element is omitted, then no custom set of characters shall be used to restrict the characters which may end a line when using the kinsoku element.

[Example: Consider a paragraph of WordprocessingML text displayed as follows, with the dollar symbol $ was flagged as Japanese content using the following WordprocessingML in the run properties:

<w:r>
  <w:rPr>
    <w:lang w:eastAsia="ja-JP" />
  </w:rPr>
  <w:t>$</w:t>
</w:r>

image124

This text is displayed and the resulting first line ends with the dollar sign symbol. If this character shall not be used to end a line, that requirement would be specified as follows in the document settings:

<w:noLineBreaksAfter w:lang="ja-JP" w:val="$" />

The noLineBreaksAfter element's val attribute has a value of ja-JP, specifying that all dollar signs in this document which are marked as Japanese text shall not be allowed to end a line. This means that the dollar sign character must therefore be moved to the next line as it can no longer be the last character on a line:

image125

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

lang (Language For Which Custom Line Breaking Rule Applies)

Specifies the language of text for which the parent custom line breaking rule shall be applied. Applications supporting this functionality shall support custom line breaking for the following four languages:

  • Chinese (Traditional)
  • Chinese (Simplified)
  • Japanese
  • Korean

Applications may also support custom line breaking rules for other languages, but this is not required.

[Example: Consider a WordprocessingML document which shall have a custom line breaking rule for Japanese. That requirement would be specified as follows in the document settings:

<w:... w:lang="ja-JP" w:val="$" />

The lang attribute has a value of ja-JP, specifying that the rules shall be applied to Japanese text. end example]

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

val (Characters For Custom Line Breaking Rule)

Specifies the set of characters which shall be included in the custom line breaking rule.

[Example: Consider a WordprocessingML document which shall have a custom line breaking rule for Japanese. That requirement would be specified as follows in the document settings:

<w:... w:lang="ja-JP" w:val="$" />

The val attribute has a value of $, specifying that the dollar sign character is the only restricted character for Japanese text. end example]

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

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

<complexType name="CT_Kinsoku">

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

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

</complexType>

2.15.1.59 noLineBreaksBefore (Custom Set Of Characters Which Cannot Begin A Line)

This element specifies the set of characters which shall be restricted from beginning a new line for runs of text which shall be subject to custom line breaking logic using the kinsoku element (§2.3.1.16) when the contents of the document are displayed. This constraint shall only apply to text which has been flagged in the language of this rule via the lang element (§2.3.2.18) or automatic detection methods outside the scope of this Office Open XML Standard.

If this element is omitted, then no custom set of characters shall be used to restrict the characters which may end a line when using the kinsoku element.

[Example: Consider a paragraph of WordprocessingML text displayed as follows, with the dollar symbol $ was flagged as Korean content using the following WordprocessingML in the run properties:

<w:r>
  <w:rPr>
    <w:lang w:eastAsia="ko-KR" />
  </w:rPr>
  <w:t>$</w:t>
</w:r>

image126

This text is displayed and the resulting second line begins with the dollar sign symbol. If this character shall not be used to begin a line, that requirement would be specified as follows in the document settings:

<w:noLineBreaksBefore w:lang="ko-KR" w:val="$" />

The noLineBreaksBefore element's val attribute has a value of ko-KR, specifying that all dollar signs in this document which are marked as Korean text shall not be allowed to begin a line. This means that the previous word character must therefore be moved to the next line as the dollar sign can no longer be the first character on a line:

image127

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

lang (Language For Which Custom Line Breaking Rule Applies)

Specifies the language of text for which the parent custom line breaking rule shall be applied. Applications supporting this functionality shall support custom line breaking for the following four languages:

  • Chinese (Traditional)
  • Chinese (Simplified)
  • Japanese
  • Korean

Applications may also support custom line breaking rules for other languages, but this is not required.

[Example: Consider a WordprocessingML document which shall have a custom line breaking rule for Japanese. That requirement would be specified as follows in the document settings:

<w:... w:lang="ja-JP" w:val="$" />

The lang attribute has a value of ja-JP, specifying that the rules shall be applied to Japanese text. end example]

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

val (Characters For Custom Line Breaking Rule)

Specifies the set of characters which shall be included in the custom line breaking rule.

[Example: Consider a WordprocessingML document which shall have a custom line breaking rule for Japanese. That requirement would be specified as follows in the document settings:

<w:... w:lang="ja-JP" w:val="$" />

The val attribute has a value of $, specifying that the dollar sign character is the only restricted character for Japanese text. end example]

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

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

<complexType name="CT_Kinsoku">

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

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

</complexType>

2.15.1.60 noPunctuationKerning (Never Kern Punctuation Characters)

This element specifies that punctuation characters shall not be kerned in the current document when kerning is enabled on a run using the kern element (§2.3.2.17). Kerning refers to a process by which a hosting application shall reduce the spacing of adjacent characters and/or punctuation to improve the visual appearance of text. Well kerned text has a similar amount of blank space between each pair of characters and/or each set of a character and punctuation symbol. When kerning is enabled, Latin text shall always be kerned, and this option shall control whether punctuation characters are also kerned.

If this element is omitted, then punctuation characters shall be kerned when kerning is enabled on a given run.

[Example: Consider a WordprocessingML document that shall not kern punctuation even when kerning is enabled on a given run. This requirement is specified using the following WordprocessingML in the document settings:

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

The noPunctuationKerning element's val attribute has a value of true, specifying that punctuation characters shall not be kerned in this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.61 printFormsData (Only Print Form Field Content)

This element specifies that printing the contents of this document shall only print the contents of WordprocessingML form fields defined using the FORMTEXT, FORMCHECKBOX, and FORMDROPDOWN field codes in their current locations on the page - all other document contents shall be suppressed.

[Rationale: This setting is typically used to allow duplication of paper forms in electronic WordprocessingML document form, allowing the resulting online document to be printed into the correct locations on the existing paper form. end rationale]

If this element is omitted, then the contents of the entire document (not just form fields) should be printed according to the normal print settings.

[Example: Consider a WordprocessingML document which has form fields in the top right and bottom left corners of the first page, as follows (with the text box form fields shaded in grey):

image128

If the only content which shall be printed on the page are the form fields' contents, this requirement is specified using the following WordprocessingML in the document settings:

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

The printFormsData element's val attribute as a value of true, specifying that only form field data shall be printed, resulting in output as follows when printed:

image129

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.62 printFractionalCharacterWidth (Print Fractional Character Widths)

This element specifies the contents of this document shall be printed with fractional character widths. Fractional character widths exist when the spacing between characters is not constant (i.e. a proportional font face is used).

[Note: Fractional character widths are generally used in conjunction with large font sizes to prevent characters from running together or having too much space between one another. end note]

[Example: Consider a WordprocessingML document which should be printed using fractional character widths as needed. This requirement is specified using the following WordprocessingML markup in the document settings:

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

The printFractionalCharacterWidth element's val attribute is equal to true, specifying that fractional character widths may be used as necessary. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.63 printPostScriptOverText (Print PostScript Codes With Document Text)

This element specifies that the PostScript codes specified in WordprocessingML documents containing PRINT fields shall be included in foreground (on the same Z-order as text) with the data printed in the contents of a given WordprocessingML document.

[Note: This setting is maintained to ensure compatibility of legacy word processing documents. The PRINT field should not be used in lieu of newer technologies in this Office Open XML Standard. end note]

If this element is omitted, then the contents of PRINT fields shall be printed behind text (i.e. in the background).

[Example: Consider a WordprocessingML document containing PRINT fields whose PostScript code shall be printed in the foreground of the WordprocessingML document. This requirement is specified using the following WordprocessingML in the document settings:

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

The printPostScriptOverText element's val attribute is equal to true specifying that the PostScript codes shall be treated as results for the main text level of the document (i.e. not behind that text). end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.64 printTwoOnOne (Print Two Pages Per Sheet)

This element specifies whether two pages should be printed on one sheet of paper when this document is printed. Specifically, this element specifies that each page displayed for the contents in a given WordprocessingML document should be the page size specified in the section settings divided in half with two top margins originating from the bisector of the page, and bottom margins instantiated at the top and bottom of each page.

If this element is omitted, then pages should be displayed and printed as one per sheet.

[Example: Consider a one section document with a 2,160 twentieths of a point (one and a half inch) top margin, and 1,440 twentieths of a point (one inch) bottom, right, and left margins surrounding the document editing canvas (represented by the gray shaded area in diagrams below). This page setup is represented in WordprocessingML using the following fragment:

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

The resulting printed pages would appear as follows:

image130

If a document should be displayed and printed as though two pages were printed on a single sheeting, this requirement would be specified using the following WordprocessingML:

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

The printTwoOnOne element's val attribute is equal to true specifying that pages should be printed two to a sheet, resulting in the following printout given these page margins:

image131

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.65 proofState (Spelling and Grammatical Checking State)

This element specifies if the grammar and spell checking engines of the last application to process this document completed checking the grammar and spelling of a the document before the document was last saved. Applications which modify the document contents without checking spelling or grammar should reset these states as needed.

[Note: If this element specifies that an application's grammar and spell checking engines completed checking the grammar and spelling of the document when the document was last saved, then subsequent applications may elect to not run their grammar and spell checking engines when the given WordprocessingML document is loaded.

This may increase the speed with which the hosting application loads the file, and does not compromise the state of the grammar or spell checking of the document, as all errors have already been found and flagged with the proofErr element (§2.13.8.1) as the document has not been edited, only loaded, since it was last saved. end note]

[Example: Consider a WordprocessingML document that is saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings:

<w:proofState w:spelling="clean" w:grammar="clean" />

The proofState element's attributes spelling and grammar attribute both have the value clean specifying that the hosting application's grammar and spell checking engines completed checking both the grammar and spelling of the given document when it was last saved. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

grammar (Grammatical Checking State)

Specifies if an application's grammar checking engine completed checking the grammatical content of the document when it was last saved.

If this attribute is omitted, then its value is assumed to be dirty (not complete).

[Example: Consider a WordprocessingML document saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings:

<w:proofState w:spelling="clean" w:grammar="clean" />

The grammar attribute has the value clean specifying that the hosting application's grammar checking engine completed checking the grammar of the given document when it was last saved. end example]

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

spelling (Spell Checking State)

Specifies if an application's spell checking engine completed checking the spelling of the document when it was last saved.

If this attribute is omitted, then its value is assumed to be dirty (not complete).

[Example: Consider a WordprocessingML document saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings:

<w:proofState w:spelling="clean" w:grammar="clean" />

The spelling attribute has the value clean specifying that the hosting application's spell checking engine completed checking the spelling of the given document when it was last saved. end example]

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

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

<complexType name="CT_Proof">

<attribute name="spelling" type="ST_Proof" use="optional"/>

<attribute name="grammar" type="ST_Proof" use="optional"/>

</complexType>

2.15.1.66 readModeInkLockDown (Freeze Document Layout)

This element specifies the exact set of page and text sizing parameters which shall be used to display the contents of a WordprocessingML document. [Rationale: This setting is typically used for documents that have been annotated using ink. This setting freezes the document's presentation such that the ink annotations shall exist at the same position of the WordprocessingML document irrespective of the monitor on which the WordprocessingML document is rendered. end rationale]

This element shall only affect the display of WordprocessingML documents as follows:

[Example: Consider a WordprocessingML document that shall be displayed using virtual pages when its contents are displayed. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0"/> 

The readModeInkLockDown element has w and h attribute values which specify the width and height of the virtual pages to be used to render the given WordprocessingML document. Finally, the fontSz attribute specifies the scaling to be applied to text within the given WordprocessingML document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

actualPg (Use Actual Pages, Not Virtual Pages)

Specifies if applications shall render this WordprocessingML document with actual pages, not virtual pages. Actual pages are pages rendered as they will be printed.

A value of true specifies that the given WordprocessingML document's pages will be rendered as they are printed, and the w, h, and fontSz attributes shall be ignored. A value of false specifies that the given WordprocessingML document's pages shall be rendered as virtual pages using the other attributes on this element.

[Example: Consider a WordprocessingML document that shall be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The actualPage attribute is equal to 0 specifying that the given WordprocessingML document shall be rendered by conforming hosting applications using virtual pages. end example]

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

fontSz (Font Size Scaling)

Specifies the percentage that text in a given WordprocessingML document shall be scaled by before it is displayed on a virtual page. The attribute's value stores the percentage specified as an integer who units correspond to the percentage that text runs shall be scaled to [Example: 200 means a scale to 200% end example].

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that shall be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The fontSz attribute is equal to 95 specifying that the text in the WordprocessingML document shall be displayed at 95% of its normal size when it is displayed on a virtual page. end example]

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

h (Virtual Page Height)

Specifies the height of the virtual pages which shall be used in this document. This value is specified in pixels.

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that shall be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The h attribute is equal to 986 specifying that virtual pages in this document shall be 986 pixels high. end example]

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

w (Virtual Page Width)

Specifies the width of the virtual pages which shall be used in this document. This value is specified in pixels.

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that shall be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The w attribute is equal to 692 specifying that virtual pages in this document shall be 692 pixels wide. end example]

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

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

<complexType name="CT_ReadingModeInkLockDown">

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

<attribute name="w" type="ST_PixelsMeasure" use="required"/>

<attribute name="h" type="ST_PixelsMeasure" use="required"/>

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

</complexType>

2.15.1.67 removeDateAndTime (Remove Date and Time from Annotations)

This element specifies that the date and time information shall be removed from all annotations which are present in the current document when it is saved. Annotations store this information in the date attribute on the annotation's XML element.

If this element is omitted, then date information shall not be removed when the document is saved. If the removePersonalInformation element is not turned on, then this setting shall be ignored.

[Example: Consider a WordprocessingML document that shall not save date and time information on annotations in the document content. This state is specified using the following WordprocessingML in the document settings:

<w:settings>
  ...
  <w:removePersonalInformation w:val="true" />
  <w:removeDateAndTime w:val="true" />
  ...
</w:settings>

The removeDateAndTime element's val attribute has a value of true specifying that all annotations in the document shall have and date and time information removed before they are saved by omitting their date attributes. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.68 removePersonalInformation (Remove Personal Information from Document Properties)

This element specifies that hosting applications shall remove all personal information of document authors upon saving a given WordprocessingML document. The definition and extent of personal information is not defined by this Office Open XML Standard.

If this element is omitted, then personal information shall not be removed when the document is saved.

[Example: Consider a WordprocessingML document that shall not save personal information in the document. This state is specified using the following WordprocessingML in the document settings:

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

The removePersonalInformation element's val attribute has a value of true specifying that applications shall remove any personal information when saving this file. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.69 revisionView (Visibility of Annotation Types)

This element specifies which forms of annotations shall be visible for a WordprocessingML document when it is displayed. This setting shall not affect whether annotations are added or persisted, it shall only affect the display of the annotations which exist in the document's contents (persisted or in memory).

If this element is omitted, then all forms of annotations shall be visible.

[Example: Consider the WordprocessingML below specifying that only formatting and ink annotations within a given WordprocessingML document shall be displayed when the document is opened:

<w:revisionView w:markup="false" w:comments="false" w:insDel="false" />

The revisionView element specifies that the visibility of the markup region, comments and content additions/deletions shall be suppressed by setting a value of false. Since the formatting and inkAnnotation attributes are omitted, they inherit the default of true and shall be displayed. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

comments (Display Comments)

Specifies if comments should be included when the contents of this document are displayed.

If this attribute is omitted, then comments shall be displayed when annotations are visible based on application-level settings.

[Example: Consider the WordprocessingML below specifying that comments shall be displayed:

<w:revisionView w:comments="true" />

The comments attribute has a value of true, specifying that comments shall be rendered when the document's annotations are displayed. end example]

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

formatting (Display Formatting Revisions)

Specifies if revisions to properties (i.e. formatting revisions) should be included when the contents of this document are displayed.

If this attribute is omitted, then formatting revisions shall be displayed when annotations are visible based on application-level settings.

[Example: Consider the WordprocessingML below specifying that formatting revisions shall be displayed:

<w:revisionView w:formatting="true" />

The formatting attribute has a value of true, specifying that formatting revisions shall be rendered when the document's annotations are displayed. end example]

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

inkAnnotations (Display Ink Annotations)

Specifies if ink annotations, specified in VML syntax (§6.1), should be included when the contents of this document are displayed.

If this attribute is omitted, then ink annotations shall be displayed when annotations are visible based on application-level settings.

[Example: Consider the WordprocessingML below specifying that ink annotations shall be displayed:

<w:revisionView w:inkAnnotations="true" />

The inkAnnotations attribute has a value of true, specifying that ink annotations shall be rendered when the document's annotations are displayed. end example]

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

insDel (Display Content Revisions)

Specifies if revisions to content (i.e. insertions, deletions, and moves) should be included when the contents of this document are displayed.

If this attribute is omitted, then insertions, deletions, and moves shall be displayed when annotations are visible based on application-level settings.

[Example: Consider the WordprocessingML below specifying that insertions, deletions, and moves shall be displayed:

<w:revisionView w:insDel="true" />

The insDel attribute has a value of true, specifying that insertions, deletions, and moves shall be rendered when the document's annotations are displayed. end example]

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

markup (Display Visual Indicator Of Markup Area)

Specifies if the application shall visually indicate any additional non-printing area used to display annotations when the annotations in this document are displayed.

If this attribute is omitted, then any additional non-printing area shall be indicated when they are visible based on application-level settings.

[Example: Consider the WordprocessingML below specifying that no visual indicator shall be displayed for non-printing regions holding annotations:

<w:revisionView w:markup="false" />

The markup attribute has a value of false, specifying that nothing shall be rendered indicating when a non-printing region is added when the document's annotations are displayed. end example]

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

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

<complexType name="CT_TrackChangesView">

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

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

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

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

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

</complexType>

2.15.1.70 rsid (Single Session Revision Save ID)

This element specifies the revision save ID that was associated with a single editing session for a document. An editing session is a span of time that begins and ends with any event that produces an editable file, such as a save or an e-mail send, and contains no such event. When revision save IDs are added to a document, they shall follow these rules:

[Note: A revision save ID should be treated as unique within the context of all documents with the same rsidRoot value. Although in practice it is possible for two independent sessions to result in the same value, this outcome is extremely rare as the values are based on the current time. However, the meaning of two revision save IDs is not defined for documents with a different rsidRoot. Applications may use this information as desired. end note]

[Example: Consider the following fragments from two WordprocessingML documents' document settings:

Document 1

Document 2

<w:rsids>

  <w:rsidRoot w:val="00464813"/>

  <w:rsid w:val="00455AAB" />

  <w:rsid w:val="00464813" />

  <w:rsid w:val="00996E03" />

</w:rsids>

<w:rsids>

  <w:rsidRoot w:val="00464813"/>

  <w:rsid w:val="00455AAB" />

  <w:rsid w:val="00464813" />

  <w:rsid w:val="00473403" />

  <w:rsid w:val="0048414E" />

</w:rsids>

The rsid elements are identical for the first three editing sessions for both documents, indicating that these documents, although they are now separate, originated from the same document. The documents were then separated and the first was saved once afterwards; and the second, twice. end example]

Parent Elements

rsids (§2.15.1.72)

Attributes

Description

val (Long Hexadecimal Number Value)

Specifies a number value specified as a four digit hexadecimal number), whose contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following value for an attribute of type ST_LongHexNumber: 00BE2C6C.

This value is valid, as it contains four hexadecimal digits, each an encoding of an octet of the actual decimal number value. It may therefore be interpreted as desired in the context of the parent XML element, 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_LongHexNumber">

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

</complexType>

2.15.1.71 rsidRoot (Original Document Revision Save ID)

This element specifies the revision save ID which was associated with the first editing session for this document. [Note: This information shall be identical between any number of copies of the same document, as they all originate from the same original editing session. Applications may use this information as desired. end note]

If this element is omitted, then the original document revision save ID is unknown.

[Example: Consider the following fragments from two WordprocessingML documents' document settings:

Document 1

Document 2

<w:rsids>

  <w:rsidRoot w:val="00464813"/>

  <w:rsid w:val="00455AAB" />

  <w:rsid w:val="00464813" />

  <w:rsid w:val="00996E03" />

</w:rsids>

<w:rsids>

  <w:rsidRoot w:val="00464813"/>

    <w:rsid w:val="00455AAB" />

    <w:rsid w:val="00464813" />

    <w:rsid w:val="00473403" />

    <w:rsid w:val="0048414E" />

</w:rsids>

The rsidRoot element's val attribute has a value of 00464813 for both documents, indicating that these documents, although they are now separate, originated from the same document. This information may be used as desired. end example]

Parent Elements

rsids (§2.15.1.72)

Attributes

Description

val (Long Hexadecimal Number Value)

Specifies a number value specified as a four digit hexadecimal number), whose contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following value for an attribute of type ST_LongHexNumber: 00BE2C6C.

This value is valid, as it contains four hexadecimal digits, each an encoding of an octet of the actual decimal number value. It may therefore be interpreted as desired in the context of the parent XML element, 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_LongHexNumber">

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

</complexType>

2.15.1.72 rsids (Listing of All Revision Save ID Values)

This element specifies the set of revision save ID values for the current document. Revision save ID values refer to four digit hexadecimal values which uniquely identify an editing session in the life of the current document. An editing session is the period of time between two subsequent save operations by an application.

[Guidance: The set of revision save IDs stored with a document only supplies information about the editing session in which document components were last saved, which may be used by applications in any manner desired. end guidance]

If this element is omitted, then no information is available about the set of revision save ID values for this document.

[Example: Consider a WordprocessingML document with the following information present in its document settings:

<w:rsids>
  <w:rsidRoot w:val="00464813" />
  <w:rsid w:val="00455AAB" />
  <w:rsid w:val="00464813" />
  <w:rsid w:val="00473403" />
</w:rsids>

The rsids element contains four child elements, specifying that the document was edited over four distinct editing sessions (i.e. it was saved three times). end example]

Parent Elements

settings (§2.15.1.78)

Child Elements

Subclause

rsid (Single Session Revision Save ID)

§2.15.1.70

rsidRoot (Original Document Revision Save ID)

§2.15.1.71

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

<complexType name="CT_DocRsids">

<sequence>

<element name="rsidRoot" type="CT_LongHexNumber" minOccurs="0" maxOccurs="1"/>

<element name="rsid" type="CT_LongHexNumber" minOccurs="0" maxOccurs="unbounded"/>

</sequence>

</complexType>

2.15.1.73 saveFormsData (Only Save Form Field Content)

This element specifies that saving the contents of this document shall only save the contents of WordprocessingML form fields defined using the FORMTEXT, FORMCHECKBOX, and FORMDROPDOWN field codes in a comma-delimited text format which does not conform to this Office Open XML Standard (i.e. it is a one-way export from a WordprocessingML document).

[Rationale: This setting is typically used to allow duplication of paper forms in electronic WordprocessingML document form, allowing the resulting content to be extracted as a comma-delimited text file. end rationale]

If this element is omitted, then the contents of the entire document (not just form fields) should be saved according to the definition of WordprocessingML in this Office Open XML Standard.

[Example: Consider a WordprocessingML document which has form fields in the top right and bottom left corners of the first page, as follows (with the text box form fields shaded in grey):

image128

If the only content which shall be saved are the form fields' contents, this requirement is specified using the following WordprocessingML in the document settings:

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

The saveFormsData element's val attribute as a value of true, specifying that only form field data shall be saved, resulting in output as follows in a text file:

one,two

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.74 saveInvalidXml (Allow Saving Document As XML File When Custom XML Markup Is Invalid)

This element specifies that this document should be capable of being saved into a format consisting of a single XML file (not defined by this Office Open XML Standard) when its contents are invalid based on the custom XML markup contained in the document. This setting has no effect on documents that do not contain custom XML markup, or that do contain custom XML markup but do not have a schema attached. [Guidance: Because this setting specifies behavior when saving to an alternative file format not defined by this Office Open XML Standard, this behavior is optional. end guidance]

If this element is omitted, then applications should not allow this document to be saved into a single XML file when its contents are invalid based on the custom XML markup contained in the document. If the doNotValidateAgainstSchema element (§2.15.1.42) is set, then the XML is never "invalid" and this property is ignored.

[Example: Consider a WordprocessingML document which should be saved into a single XML file even when its custom XML content is marked invalid by applications which support this operation. This requirement is specified using the following WordprocessingML in the document settings:

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

The saveInvalidXml element's val attribute has a value of true specifying that the content in this document can be saved regardless of its validation status. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.75 savePreviewPicture (Generate Thumbnail For Document On Save)

This element specifies if a document's Thumbnail part should be generated for the contents of the first page of this document when saved by application which support document thumbnail generation.

If this element is omitted, then applications may choose to save a thumbnail, however, that behavior is not required. If this element is specified, a thumbnail must be produced if that functionality is supported.

[Example: Consider a WordprocessingML document that specifies that a document thumbnail shall always be created when it is saved. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The savePreviewPicture element's val attribute has a value of true specifying that a document thumbnail should be generated each time this document is saved. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.76 saveThroughXslt (Custom XSL Transform To Use When Saving As XML File)

This element specifies the location of a custom XSL transform which shall be used when this document is saved as a single XML file (in a format not defined by this Office Open XML Standard). [Guidance: Because this setting specifies behavior when saving to an alternative file format not defined by this Office Open XML Standard, this behavior is optional. end guidance]

If this element is omitted, then no custom XSL transform shall be used when saving this file as a single XML file. If the useXSLTWhenSaving element (§2.15.1.92) is omitted or set to false, then this transform shall not be applied when the document is saved as a single XML file.

[Example: Consider a XML document that shall have the XSL transform applied when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:useXSLTWhenSaving w:val="on"/> 

<w:saveThroughXslt r:id="rId5" />

The useXSLTWhenSaving element's val is set to on indicating that applications shall apply the XSLT specified by the relationship targeted by the id attribute of the saveThroughXslt element, located at rId5, when saving as a single XML file. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

id (XSL Transformation Location)

Namespace: .../officeDocument/2006/relationships

Specifies an explicit relationship to the location of the XSL Transformation which shall be applied.

The relationship targeted by this element shall be of type http://schemas.openxmlformats.org/officeDocument/2006/relationships/transform, or this document shall be declared invalid.

[Example: Consider a XML document that shall have the XSL transform located at c:\Example Transform.xslt applied when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:saveThroughXslt r:id="rId5" />

The saveThroughXslt element specifies that the relationship located at rId5 shall be used when saving as a single XML file in this case, that relationship shall target c:\Example Transform.xslt. end example]

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

solutionID (Local Identifier for XSL Transform)

Specifies a string identifier which may be used to locate the XSL transform to be applied. The semantics of this attribute are not defined by this Office Open XML Standard - applications may use this information in any application-defined manner to resolve the location of the XSL transform to apply.

If this attribute is omitted, then no local identifier is specified for the XSL transform. If both this and the xslt attributes are present, then this data shall be used first, and the latter shall only be used if this information cannot be used successfully.

[Example: Consider a XML document that shall have the XSL transform identified by mySolution applied to when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:saveThroughXslt w:solutionID="mySolution" />

The solutionID attribute has a value of mySolution indicating that applications shall apply the XSLT identified by this value (if known) when saving as a single XML file. end example]

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

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

<complexType name="CT_SaveThroughXslt">

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

<attribute name="solutionID" type="ST_String" use="optional"/>

</complexType>

2.15.1.77 saveXmlDataOnly (Only Save Custom XML Markup)

This element specifies that the contents of this document shall be saved as an XML file containing only the custom XML markup in this document in its regular form. The resulting document will not conform to this Office Open XML Standard (i.e. this is an export-only save option for a WordprocessingML document).

[Rationale: This setting is typically used to extract custom XML markup from a WordprocessingML document for further processing by XML-enabled applications. end rationale]

If this element is omitted, then the contents of the entire document (not just custom XML markup) should be saved according to the definition of WordprocessingML in this Office Open XML Standard.

[Example: Consider a WordprocessingML document which should be saved as an XML file containing only its custom XML markup. This requirement is specified using the following WordprocessingML fragment in the document settings:

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

The saveXmlDataOnly element's val attribute has a value of true specifying that only custom XML shall be saved into a regular XML file when saving this document. For example, the document body formerly looked like this:

<w:body>
  <w:p>
    <w:customXml w:element="root" w:namespaceuri="urn:example">
      <w:r>
        <w:t>Hello world<w:t>
      </w:r>
    </w:customXml>
  </w:p>
</w:body>

The presence of this element specifies that the resulting document only contains the custom Xml markup, resulting in the following:

<ns0:root xmlns:ns0="urn:example">Hello world</ns0:root>

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.78 settings (Document Settings)

This element specifies the settings that are applied to a WordprocessingML document. This element is the root element of the Document Settings part in a WordprocessingML document.

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

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

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

Parent Elements

Root element of WordprocessingML Document Settings part

Child Elements

Subclause

activeWritingStyle (Grammar Checking Settings)

§2.15.1.1

alignBordersAndEdges (Align Paragraph and Table Borders with Page Border)

§2.15.1.2

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

§2.15.1.3

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

§2.15.1.4

attachedSchema (Attached Custom XML Schema)

§2.15.1.5

attachedTemplate (Attached Document Template)

§2.15.1.6

autoFormatOverride (Allow Automatic Formatting to Override Formatting Protection Settings)

§2.15.1.9

autoHyphenation (Automatically Hyphenate Document Contents When Displayed)

§2.15.1.10

bookFoldPrinting (Book Fold Printing)

§2.15.1.11

bookFoldPrintingSheets (Number of Pages Per Booklet)

§2.15.1.12

bookFoldRevPrinting (Reverse Book Fold Printing)

§2.15.1.13

bordersDoNotSurroundFooter (Page Border Excludes Footer)

§2.15.1.14

bordersDoNotSurroundHeader (Page Border Excludes Header)

§2.15.1.15

captions (Caption Settings)

§2.15.1.17

characterSpacingControl (Character-Level Whitespace Compression)

§2.15.1.18

clickAndTypeStyle (Paragraph Style Applied to Automatically Generated Paragraphs)

§2.15.1.19

clrSchemeMapping (Theme Color Mappings)

§2.15.1.20

compat (Compatibility Settings)

§2.15.3.9

consecutiveHyphenLimit (Maximum Number of Consecutively Hyphenated Lines)

§2.15.1.21

decimalSymbol (Radix Point for Field Code Evaluation)

§2.15.1.22

defaultTableStyle (Default Table Style for Newly Inserted Tables)

§2.15.1.23

defaultTabStop (Distance Between Automatic Tab Stops)

§2.15.1.24

displayBackgroundShape (Display Background Objects When Displaying Document)

§2.15.1.25

displayHorizontalDrawingGridEvery (Distance between Horizontal Gridlines)

§2.15.1.26

displayVerticalDrawingGridEvery (Distance between Vertical Gridlines)

§2.15.1.27

documentProtection (Document Editing Restrictions)

§2.15.1.28

documentType (Document Classification)

§2.15.1.29

docVars (Document Variables)

§2.15.1.31

doNotAutoCompressPictures (Do Not Automatically Compress Images)

§2.15.1.32

doNotDemarcateInvalidXml (Do Not Show Visual Indicator For Invalid Custom XML Markup)

§2.15.1.33

doNotDisplayPageBoundaries (Do Not Display Visual Boundary For Header/Footer or Between Pages)

§2.15.1.34

doNotEmbedSmartTags (Remove Smart Tags When Saving)

§2.15.1.35

doNotHyphenateCaps (Do Not Hyphenate Words in ALL CAPITAL LETTERS)

§2.15.1.36

doNotIncludeSubdocsInStats (Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics)

§2.15.1.37

doNotShadeFormData (Do Not Show Visual Indicator For Form Fields)

§2.15.1.38

doNotTrackFormatting (Do Not Track Formatting Revisions When Tracking Revisions)

§2.15.1.39

doNotTrackMoves (Do Not Use Move Syntax When Tracking Revisions)

§2.15.1.40

doNotUseMarginsForDrawingGridOrigin (Do Not Use Margins for Drawing Grid Origin)

§2.15.1.41

doNotValidateAgainstSchema (Do Not Validate Custom XML Markup Against Schemas)

§2.15.1.42

drawingGridHorizontalOrigin (Drawing Grid Horizontal Origin Point)

§2.15.1.43

drawingGridHorizontalSpacing (Drawing Grid Horizontal Grid Unit Size)

§2.15.1.44

drawingGridVerticalOrigin (Drawing Grid Vertical Origin Point)

§2.15.1.45

drawingGridVerticalSpacing (Drawing Grid Vertical Grid Unit Size)

§2.15.1.46

embedSystemFonts (Embed Common System Fonts)

§2.8.2.7

embedTrueTypeFonts (Embed TrueType Fonts)

§2.8.2.8

endnotePr (Document-Wide Endnote Properties)

§2.11.4

evenAndOddHeaders (Different Even/Odd Page Headers and Footers)

§2.10.1

footnotePr (Document-Wide Footnote Properties)

§2.11.11

forceUpgrade (Upgrade Document on Open)

§2.15.1.47

formsDesign (Structured Document Tag Placeholder Text Should be Resaved)

§2.15.1.48

gutterAtTop (Position Gutter At Top of Page)

§2.15.1.49

hdrShapeDefaults (Default Properties for VML Objects in Header and Footer)

§2.15.1.50

hideGrammaticalErrors (Do Not Display Visual Indication of Grammatical Errors)

§2.15.1.51

hideSpellingErrors (Do Not Display Visual Indication of Spelling Errors)

§2.15.1.52

hyphenationZone (Hyphenation Zone)

§2.15.1.53

ignoreMixedContent (Ignore Mixed Content When Validating Custom XML Markup)

§2.15.1.54

linkStyles (Automatically Update Styles From Document Template)

§2.15.1.55

listSeparator (List Separator for Field Code Evaluation)

§2.15.1.56

mailMerge (Mail Merge Settings)

§2.14.20

mathPr (Math Properties)

§7.1.2.62

mirrorMargins (Mirror Page Margins)

§2.15.1.57

noLineBreaksAfter (Custom Set of Characters Which Cannot End a Line)

§2.15.1.58

noLineBreaksBefore (Custom Set Of Characters Which Cannot Begin A Line)

§2.15.1.59

noPunctuationKerning (Never Kern Punctuation Characters)

§2.15.1.60

printFormsData (Only Print Form Field Content)

§2.15.1.61

printFractionalCharacterWidth (Print Fractional Character Widths)

§2.15.1.62

printPostScriptOverText (Print PostScript Codes With Document Text)

§2.15.1.63

printTwoOnOne (Print Two Pages Per Sheet)

§2.15.1.64

proofState (Spelling and Grammatical Checking State)

§2.15.1.65

readModeInkLockDown (Freeze Document Layout)

§2.15.1.66

removeDateAndTime (Remove Date and Time from Annotations)

§2.15.1.67

removePersonalInformation (Remove Personal Information from Document Properties)

§2.15.1.68

revisionView (Visibility of Annotation Types)

§2.15.1.69

rsids (Listing of All Revision Save ID Values)

§2.15.1.72

saveFormsData (Only Save Form Field Content)

§2.15.1.73

saveInvalidXml (Allow Saving Document As XML File When Custom XML Markup Is Invalid)

§2.15.1.74

savePreviewPicture (Generate Thumbnail For Document On Save)

§2.15.1.75

saveSubsetFonts (Subset Fonts When Embedding)

§2.8.2.15

saveThroughXslt (Custom XSL Transform To Use When Saving As XML File)

§2.15.1.76

saveXmlDataOnly (Only Save Custom XML Markup)

§2.15.1.77

schemaLibrary (Embedded Custom XML Schema Supplementary Data)

§8.2.2

shapeDefaults (Default Properties for VML Objects in Main Document)

§2.15.1.79

showEnvelope (Show E-Mail Message Header)

§2.15.1.80

showXMLTags (Show Visual Indicators for Custom XML Markup Start/End Locations)

§2.15.1.81

smartTagType (Supplementary Smart Tag Information)

§2.15.1.82

strictFirstAndLastChars (Use Strict Kinsoku Rules for Japanese Text)

§2.15.1.83

styleLockQFSet (Prevent Replacement of Styles Part)

§2.15.1.84

styleLockTheme (Prevent Modification of Themes Part)

§2.15.1.85

stylePaneFormatFilter (Suggested Filtering for List of Document Styles)

§2.15.1.86

stylePaneSortMethod (Suggested Sorting for List of Document Styles)

§2.15.1.87

summaryLength (Percentage of Document to Use When Generating Summary)

§2.15.1.88

themeFontLang (Theme Font Languages)

§2.15.1.89

trackRevisions (Track Revisions to Document)

§2.15.1.90

uiCompat97To2003 (Disable Features Incompatible With Earlier Word Processing Formats)

§2.15.3.54

updateFields (Automatically Recalculate Fields on Open)

§2.15.1.91

useXSLTWhenSaving (Save Document as XML File through Custom XSL Transform)

§2.15.1.92

view (Document View Setting)

§2.15.1.93

writeProtection (Write Protection)

§2.15.1.94

zoom (Magnification Setting)

§2.15.1.95

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

<complexType name="CT_Settings">

<sequence>

<element name="writeProtection" type="CT_WriteProtection" minOccurs="0"/>

<element name="view" type="CT_View" minOccurs="0"/>

<element name="zoom" type="CT_Zoom" minOccurs="0"/>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<element name="activeWritingStyle" type="CT_WritingStyle" minOccurs="0" maxOccurs="unbounded"/>

<element name="proofState" type="CT_Proof" minOccurs="0"/>

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

<element name="attachedTemplate" type="CT_Rel" minOccurs="0"/>

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

<element name="stylePaneFormatFilter" type="CT_ShortHexNumber" minOccurs="0"/>

<element name="stylePaneSortMethod" type="CT_ShortHexNumber" minOccurs="0"/>

<element name="documentType" type="CT_DocType" minOccurs="0"/>

<element name="mailMerge" type="CT_MailMerge" minOccurs="0"/>

<element name="revisionView" type="CT_TrackChangesView" minOccurs="0"/>

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

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

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

<element name="documentProtection" type="CT_DocProtect" minOccurs="0"/>

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

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

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

<element name="defaultTabStop" type="CT_TwipsMeasure" minOccurs="0"/>

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

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

<element name="hyphenationZone" type="CT_TwipsMeasure" minOccurs="0"/>

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

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

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

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

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

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

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

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

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

<element name="drawingGridHorizontalSpacing" type="CT_TwipsMeasure" minOccurs="0"/>

<element name="drawingGridVerticalSpacing" type="CT_TwipsMeasure" minOccurs="0"/>

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

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

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

<element name="drawingGridHorizontalOrigin" type="CT_TwipsMeasure" minOccurs="0"/>

<element name="drawingGridVerticalOrigin" type="CT_TwipsMeasure" minOccurs="0"/>

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

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

<element name="characterSpacingControl" type="CT_CharacterSpacing" minOccurs="0"/>

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

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

<element name="noLineBreaksAfter" type="CT_Kinsoku" minOccurs="0"/>

<element name="noLineBreaksBefore" type="CT_Kinsoku" minOccurs="0"/>

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

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

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

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

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

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

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

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

<element name="saveThroughXslt" type="CT_SaveThroughXslt" minOccurs="0"/>

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

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

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

<element name="hdrShapeDefaults" type="CT_ShapeDefaults" minOccurs="0"/>

<element name="footnotePr" type="CT_FtnDocProps" minOccurs="0"/>

<element name="endnotePr" type="CT_EdnDocProps" minOccurs="0"/>

<element name="compat" type="CT_Compat" minOccurs="0"/>

<element name="docVars" type="CT_DocVars" minOccurs="0"/>

<element name="rsids" type="CT_DocRsids" minOccurs="0"/>

<element ref="m:mathPr" minOccurs="0" maxOccurs="1"/>

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

<element name="attachedSchema" type="CT_String" minOccurs="0" maxOccurs="unbounded"/>

<element name="themeFontLang" type="CT_Language" minOccurs="0" maxOccurs="1"/>

<element name="clrSchemeMapping" type="CT_ColorSchemeMapping" minOccurs="0"/>

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

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

<element name="forceUpgrade" type="CT_Empty" minOccurs="0" maxOccurs="1"/>

<element name="captions" type="CT_Captions" minOccurs="0" maxOccurs="1"/>

<element name="readModeInkLockDown" type="CT_ReadingModeInkLockDown" minOccurs="0"/>

<element name="smartTagType" type="CT_SmartTagType" minOccurs="0" maxOccurs="unbounded"/>

<element ref="sl:schemaLibrary" minOccurs="0" maxOccurs="1"/>

<element name="shapeDefaults" type="CT_ShapeDefaults" minOccurs="0"/>

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

<element name="decimalSymbol" type="CT_String" minOccurs="0" maxOccurs="1"/>

<element name="listSeparator" type="CT_String" minOccurs="0" maxOccurs="1"/>

</sequence>

</complexType>

2.15.1.79 shapeDefaults (Default Properties for VML Objects in Main Document)

This element specifies the default parameters for object using the VML syntax (§6.1) inserted in the body (the main document story, comments, footnotes, and endnotes) of the WordprocessingML document. The definition and semantics of these parameters is described in the VML - Office Drawing subclause (§6.2) of this Office Open XML Standard.

If this element is omitted, then no default properties are applied to VML objects in the body of this document.

[Example: Consider a WordprocessingML document whose document settings contain the following markup:

<w:shapeDefaults>
  <o:shapedefaults v:ext="edit" spidmax="1026" />
  <o:shapelayout v:ext="edit">
    <o:idmap v:ext="edit" data="1" />
  </o:shapelayout>
</w:shapeDefaults>

The shapeDefaults element specifies a set of shape defaults which shall be applied to the set of all shapes present in the body document. end example]

Parent Elements

settings (§2.15.1.78)

Child Elements

Subclause

Any element from the urn:schemas-microsoft-com:office:office namespace

§6.2

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

<complexType name="CT_ShapeDefaults">

<choice maxOccurs="unbounded">

<any processContents="lax" namespace="urn:schemas-microsoft-com:office:office" minOccurs="0" maxOccurs="unbounded"/>

</choice>

</complexType>

2.15.1.80 showEnvelope (Show E-Mail Message Header)

This element specifies that an e-mail message header shall be displayed when this document is opened, if an e-mail header is supported by the application opening the file.

If this element is omitted, then applications shall not display the e-mail message header automatically when this file is opened, even if one is available in the application opening the file.

[Example: Consider a WordprocessingML document which should show an e-mail message header when opened. This requirement is specified using the following WordprocessingML in the document settings:

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

The showEnvelope element's val attribute has a value of true specifying that an e-mail message header shall be displayed when the document is viewed, whenever such functionality is available. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.81 showXMLTags (Show Visual Indicators for Custom XML Markup Start/End Locations)

This element specifies that some visual indicator shall be provided for the start and end locations of custom XML markup present in this document, if any.

If this element is omitted, then applications should not provide any visual indicator of the locations of custom XML markup start/end tags.

[Example: Consider a WordprocessingML document which should show a visual indicator to the location of custom XML markup elements. This requirement is specified using the following WordprocessingML in the document settings:

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

The showXMLTags element's val attribute has a value of true specifying that custom XML markup should have a visual indicator in the document when displayed. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.82 smartTagType (Supplementary Smart Tag Information)

This element specifies optional supplementary information about one or more smart tags (§2.5.1.9) used in the current WordprocessingML document. This supplementary data is linked to the smart tag to which it applies via its name and namespaceuri attributes.

[Example: Consider a smart tag which has supplementary information defined as using the following WordprocessingML:

<w:smartTagType w:name="companyName" w:namespaceuri="urn:smartTagExample" w:url="http://www.contoso.com/smartTag" >

The name and namespaceuri attributes specify that the smart tag to which this data shall be companyName in the urn:smartTagExample namespace. The supplementary data is an associated URL of http://www.contoso.com/smartTag. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

name (Smart Tag Name)

Specifies the name of the smart tag within the document for which supplementary data is provided.

[Example: Consider a smart tag which has a name of companyName. This name would be referenced using the following WordprocessingML:

<w:smartTagType w:name="companyName" ... >

The name attribute specifies that the name for this smart tag shall be companyName. end example]

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

namespaceuri (Smart Tag Namespace)

Specifies the namespace URI of the smart tag for which supplementary data is provided.

If this attribute is omitted, the URI shall be assumed to be null (no associated URI).

[Example: Consider a smart tag which shall have a namespace URI of urn:smartTagExample. This namespace would be referenced using the following WordprocessingML:

<w:smartTagType w:namespaceuri="urn:smartTagExample" />

The namespaceuri attribute specifies that the namespace for the smart tag to which this data applies shall be urn:smartTagExample. end example]

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

url (Smart Tag Supplementary URL)

Specifies a URL provided for a particular smart tag type in this document. [Note: This URL is typically used to provide access to a URL for additional updates to this smart tag type as requested by the smart tag provider. end note]

If this attribute is omitted, then no supplementary URL is provided for this type.

[Example: Consider a smart tag which shall have a supplementary URL of http://www.contoso.com/smartTag. This URL would be specified using the following WordprocessingML:

<w:smartTagType ... w:url="http://www.contoso.com/smartTag" />

The url attribute specifies that the supplementary data for the smart tag to which this data applies shall be http://www.contoso.com/smartTag. end example]

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

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

<complexType name="CT_SmartTagType">

<attribute name="namespaceuri" type="ST_String"/>

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

<attribute name="url" type="ST_String"/>

</complexType>

2.15.1.83 strictFirstAndLastChars (Use Strict Kinsoku Rules for Japanese Text)

This element specifies that the strict set of Kinsoku rules shall be applied to Japanese text in this document when the kinsoku element (§2.3.1.16) is applied to that text. The resulting line breaking rules are provided on the kinsoku element.

If this element is omitted, then standard rules shall apply to Japanese text when the kinsoku element is applied to that text.

[Example: Consider a WordprocessingML document that specifies that strict Kinsoku rules shall be applied to Japanese text. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The strictFirstAndLastChars element's val attribute has a value of true specifying that a document shall apply the strict set of invalid characters for the start and end of a line. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.84 styleLockQFSet (Prevent Replacement of Styles Part)

This element specifies whether applications shall prevent the replacement of the complete set of styles stored in the Styles part when editing this document. This setting should not preclude the editing or removal of individual styles, instead, it should only prevent the removal and replacement of the entire styles part in a single operation (either through a user interface or a programmatic operation).

If this element is omitted, then applications may allow the replacement of the entire styles part in this document.

[Example: Consider a WordprocessingML document that specifies that applications shall prevent the replacement of the entire styles part. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The styleLockQFSet element's val attribute has a value of true specifying that individual style changes should be allowed, but the styles data shall not be replaced as a whole via a single operation. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.85 styleLockTheme (Prevent Modification of Themes Part)

This element specifies whether applications shall prevent the modification of the document's theme information stored in the Theme part when editing this document. This setting should not preclude the use of the theme information, instead, it should only prevent the modification of the theme part in a single operation (either through a user interface or a programmatic operation).

If this element is omitted, then applications may allow the replacement or modification of the theme part in this document.

[Example: Consider a WordprocessingML document that specifies that applications shall prevent the modification of the theme part. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The styleLockTheme element's val attribute has a value of true specifying that theme data shall not be modified when modifying the contents of this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.86 stylePaneFormatFilter (Suggested Filtering for List of Document Styles)

This element specifies a set of suggested filters which should be applied to the list of document styles in this application if the styles are displayed in a user interface.

The val attribute of this element contains a bitmask of the following filtering options:

Value

Description

0x0001

Specifies that all styles present in the styles part should be displayed in the list of document styles.

0x0002

Specifies that only styles with the customStyle attribute should be displayed in the list of document styles.

0x0004

Specifies that all latent styles should be displayed in the list of document styles.

0x0008

Specifies that only styles used in the document should be displayed in the list of document styles.

0x0010

Undefined. Shall not be used.

0x0020

Specifies that heading styles (styles with a styleId of Heading1 to Heading9) should be displayed in the list of document styles when the previous style is used in the document and/or is present in the styles part.

0x0040

Specifies that numbering styles should be displayed in the list of document styles.

0x0080

Specifies that table styles should be displayed in the list of document styles.

0x0100

Specifies that all unique forms of run-level direct formatting should be displayed in the list of document styles as though they were each a unique style.

0x0200

Specifies that all unique forms of paragraph-level direct formatting should be displayed in the list of document styles as though they were each a unique style.

0x0400

Specifies that all unique forms of direct formatting of numbering data should be displayed in the list of document styles as though they were each a unique style.

0x0800

Specifies that all unique forms of direct formatting of tables should be displayed in the list of document styles as though they were each a unique style.

0x1000

Specifies that a style should be present which removes all formatting and styles from text.

0x2000

Specifies that heading styles with a styleId of Heading1 to Heading3 should always be displayed in the list of document styles.

0x4000

Specifies that styles should only be shown the semiHidden element (§2.7.3.16) is false and the hidden element (§2.7.3.4) is false.

0x8000

Specifies that primary names for styles should not be shown if an alternate name using the name element (§2.7.3.9) exists.

Any other value

Undefined. Shall not be used.

If this element is omitted, then all settings defined by this element are turned off.

[Example: Consider a document with the following value in its document settings:

<w:stylePaneFormatFilter w:val="2002" />

The stylePaneFormatFilter element's settings specify two suggested filter options for the list of document styles:

end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Two Digit Hexadecimal Value)

Specifies a value specified as a two digit hexadecimal number), whose contents are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:tblPr>

  <w:tblLook w:val="0010" /> 

</w:tblPr>

The value of 0010 is interpreted in the context of the parent element. end example]

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

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

<complexType name="CT_ShortHexNumber">

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

</complexType>

2.15.1.87 stylePaneSortMethod (Suggested Sorting for List of Document Styles)

This element specifies a suggested sorting which should be applied to the list of document styles in this application if the styles are displayed in a user interface.

The val attribute of this element specifies one of the following sorting options:

Value

Description

0x0000

Specifies that styles which are visible should be sorted by their names.

0x0001

Specifies that styles which are visible should be sorted by their UI priority using the uiPriority element (§2.7.3.19).

0x0002

Specifies that styles which are visible should be sorted by the default sorting of the host application.

0x0003

Specifies that styles which are visible should be sorted by the font which they apply.

0x0004

Specifies that styles which are visible should be sorted by the style on which they are based using the basedOn element (§2.7.3.3).

0x0005

Specifies that styles which are visible should be sorted by their style types (i.e. character, linked, paragraph).

Any other value

Undefined. Shall not be used.

If this element is omitted, then styles which are visible should be sorted by the default sorting of the host application.

[Example: Consider a document with the following value in its document settings:

<w:stylePaneSortMethod w:val="0005" />

The stylePaneFormatFilter element's val attribute specifies that styles which are visible should be sorted by their style types (i.e. character, linked, paragraph) via a value of 0005. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Two Digit Hexadecimal Value)

Specifies a value specified as a two digit hexadecimal number), whose contents are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:tblPr>

  <w:tblLook w:val="0010" /> 

</w:tblPr>

The value of 0010 is interpreted in the context of the parent element. end example]

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

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

<complexType name="CT_ShortHexNumber">

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

</complexType>

2.15.1.88 summaryLength (Percentage of Document to Use When Generating Summary)

This element specifies the size for automatic document summaries performed on the content of a WordprocessingML document. An automatic document summary is a subset of text contained in a document deemed by the hosting application to summarize the content of the WordprocessingML document. The val attribute of this element specifies the size of an automatic document summary to be performed on a given WordprocessingML document as a percentage of the total size of the given WordprocessingML document. Performing an automatic document summary is a runtime operation outside the scope of this Office Open XML Standard.

If this element is omitted, then applications may summarize this document to any desired size.

[Example: Consider a WordprocessingML document whose automatic document summary shall be ten percent of the size of the given WordprocessingML document. This requirement would be specified using the following WordprocessingML in the document settings part:

<w:summaryLength w:val="10" /> 

The summaryLength element's val attribute is equal to 10 specifying that any automatic document summary shall be ten percent of the size of the document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute will contain a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of type ST_DecimalNumber:

<w:... w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

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.89 themeFontLang (Theme Font Languages)

This element specifies the language which shall be used to determine the appropriate theme fonts in the document's Theme part which map to the major/minor theme fonts.

These mappings are performed as follows:

If this element is omitted, then the default fonts for each region as specified by the latin, ea, and cs elements (§5.1.5.3.7; §5.1.5.3.3; §5.1.5.3.1) should be used.

[Example: Consider a document with the following WordprocessingML in its document settings:

<w:themeFontLang w:val="ja-JP" />

The themeFontLang element's val attribute has a value of ja-JP, specifying that the theme fonts used for Latin text shall be the theme fonts for Japanese. If the following content was present in the theme part:

...
<a:majorFont>
  ...
  <a:font script="Jpan" typeface="MS Mincho"/>
  ...
</a:majorFont>
... 

Then this setting would specify that uses of the majorAscii and majorHAnsi theme font enumerations shall be mapped to the MS Mincho font. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

bidi (Complex Script Language)

Specifies the language which shall be used when processing the contents of this run which use complex script characters, as determined by the Unicode character values of the run content.

If this attribute is omitted, then the languages for the contents of this run using complex script characters shall be automatically determined based on their contents using any appropriate method.

[Example: Consider a run which contains complex script characters in its contents. If those contents should be interpreted as Hebrew, that requirement would be specified as follows in the resulting WordprocessingML:

<w:r>

  <w:rPr>

    <w:lang w:bidi="he-IL" />

  </w:rPr>

</w:r>

The resulting run specifies that any complex script contents shall be spell and grammar checked using a Hebrew dictionary and grammar engine, if one is available. end example]

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

eastAsia (East Asian Language)

Specifies the language which shall be used when processing the contents of this run which use East Asian characters, as determined by the Unicode character values of the run content.

If this attribute is omitted, then the languages for the contents of this run using East Asian characters shall be automatically determined based on their contents using any appropriate method.

[Example: Consider a run which contains East Asian characters in its contents. If those contents should be interpreted as Korean, that requirement would be specified as follows in the resulting WordprocessingML:

<w:r>

  <w:rPr>

    <w:lang w:bidi="ko-KR" />

  </w:rPr>

</w:r>

The resulting run specifies that any complex script contents shall be spell and grammar checked using a Korean dictionary and grammar engine, if one is available. end example]

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

val (Latin Language)

Specifies the language which shall be used to check spelling and grammar (if requested) when processing the contents of this run which use Latin characters, as determined by the Unicode character values of the run content.

If this attribute is omitted, then the languages for the contents of this run using Latin characters shall be automatically determined based on their contents using any appropriate method.

[Example: Consider a run which contains Latin characters in its contents. If those contents should be interpreted as English (Canada), that requirement would be specified as follows in the resulting WordprocessingML:

<w:r>

  <w:rPr>

    <w:lang w:bidi="en-CA" />

  </w:rPr>

</w:r>

The resulting run specifies that any complex script contents shall be spell and grammar checked using a English (Canada) dictionary and grammar engine, if one is available. end example]

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

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

<complexType name="CT_Language">

<attribute name="val" type="ST_Lang" use="optional"/>

<attribute name="eastAsia" type="ST_Lang" use="optional"/>

<attribute name="bidi" type="ST_Lang" use="optional"/>

</complexType>

2.15.1.90 trackRevisions (Track Revisions to Document)

This element specifies that applications shall track revisions made to the WordprocessingML document. Revisions are changes to a WordprocessingML document which are recorded such that they can be viewed independently, accepted or removed, and reverted if needed. When revisions are tracked, the resulting WordprocessingML markup in the Revisions subclause of this document describes the necessary syntax.

If this element is omitted, then revisions shall not be generated by changes to the contents of this document.

[Example: Consider a WordprocessingML document containing the text run Example that shall not have revisions tracked. Example WordprocessingML from Document 1 is given below:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
    </w:p>
  </w:body>
</w:document>

And the corresponding document settings:

<w:settings>
  <w:trackRevisions w:val="false"/>
  ...
</w:settings>

If the word text was added to the end of this document and bolded without revisions tracked, the resulting WordprocessingML would be output as follows:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
      <w:r>
        <w:rPr>
          <w:b/>
        </w:rPr>
        <w:t>text</w:t>
      </w:r>
    </w:p>
  </w:body>
</w:document>

And the corresponding document settings:

<w:settings>
  <w:trackRevisions w:val="false"/>
  ...
</w:settings>

Finally, assume the same insertion and formatting took place when the trackRevisions element's val attribute was set to on, the resulting WordprocessingML would be output as follows:

<w:document>
  <w:body>
    <w:p>
      <w:r>
        <w:t>Example</w:t>
      </w:r>
      <w:ins ... >
        <w:r>
          <w:rPr>
            <w:b/>
            <w:rPrChange ... >
              <w:rPr/>
            <w:rPrChange>
          </w:rPr>
          <w:t>text</w:t>
        </w:r>
      </w:ins>
    </w:p>
  </w:body>
</w:document>

And the corresponding document settings:

<w:settings>
  <w:trackRevisions w:val="true"/>
  ...
</w:settings>

The trackRevisions element's val attribute was set to true, therefore the changes to the content of the document were inserted using the appropriate annotation elements in the document's WordprocessingML. Specifically, inserting the text Text to the right of the existing text was tracked as a revision with the ins element. In addition, applying bold formatting to the text was tracked as a revision with the rPrChange element. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.91 updateFields (Automatically Recalculate Fields on Open)

This element specifies whether the fields contained in this document should automatically have their field result recalculated from the field codes when this document is opened by an application which supports field calculations. [Note: Some fields are always recalculated (e.g. the page numbering), therefore this element only affects fields which are typically not automatically recalculated on opening the document. Also note that this setting shall not supersede any document protection (§2.15.1.28) or write protection (§2.15.1.94) settings. end note]

If this element is omitted, then fields should not automatically be recalculated on opening this document.

[Example: Consider a WordprocessingML document that specifies that applications should attempt to automatically recalculate fields from their field codes upon opening this document. This requirement would be specified using the following WordprocessingML in the document settings part:

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

The updateFields element's val attribute has a value of true specifying that all fields should automatically be recalculated when opening this document. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.92 useXSLTWhenSaving (Save Document as XML File through Custom XSL Transform)

This element specifies that this document should be saved through the custom XSLT transform defined by the saveThroughXslt element (§2.15.1.76) in this document when it is saved as a single XML file (not defined by this Office Open XML Standard). [Guidance: Because this setting specifies behavior when saving to an alternative file format not defined by this Office Open XML Standard, this behavior is optional. end guidance]

If the saveXmlDataOnly element (§2.15.1.77) is specified, then the single XML file to be transformed is the custom XML markup of the document, otherwise, it a format outside the scope of this Office Open XML Standard. If the XSL transform specified by the saveThroughXslt element is not present, then this setting should be ignored.

If this element is omitted, then this document should not be saved through a custom XSL transform when it is saved as a single XML file.

[Example: Consider a WordprocessingML document which should be saved through a custom XSL transform when it is saved as a single XML file. This requirement is specified using the following WordprocessingML in the document settings:

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

The useXSLTWhenSaving element's val attribute has a value of true specifying that the content in this document should be saved as a single XML file through the custom XSLT specified by the saveThroughXslt element. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (On/Off Value)

Specifies a binary value for the property defined by the parent XML element.

A value of on, 1, or true specifies that the property shall be explicitly applied. This is the default value for this attribute, and is implied when the parent element is present, but this attribute is omitted.

A value of off, 0, or false specifies that the property shall be explicitly turned off.

[Example: For example, consider the following on/off property:

<w:... w:val="off"/>

The val attribute explicitly declares that the property is turned off. end example]

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

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.93 view (Document View Setting)

This element specifies the manner in which the contents of this document should be displayed when opened by an application.

If this element is omitted, then an application may view the document in any desired default state.

[Example: Consider a WordprocessingML document that shall be displayed on the screen in the same form as it will be printed. This requirement would be specified using the following WordprocessingML in the document settings:

<w:view w:val="print" /> 

The view element's val attribute is equal to print specifying that the given WordprocessingML document shall be rendered as it will be printed. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

val (Document View Setting Value)

Specifies the view which shall be used to render the contents of a WordprocessingML document.

Applications may omit support for one or more of the views defined by the ST_View simple type (referenced below). If a WordprocessingML document containing an unsupported view is loaded by an application, it shall fall back to its default view (equivalent to use of the enumeration value none).

[Example: Consider a WordprocessingML document that shall be rendered in a view meant to mimic how the document would look in a web browser (i.e. without a fixed page width). This requirement would be specified using the following WordprocessingML in the document settings:

<w:view w:val="web" /> 

The val attribute is equal to web specifying that the given WordprocessingML document shall be rendered in a view mimicking web page display. end example]

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

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

<complexType name="CT_View">

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

</complexType>

2.15.1.94 writeProtection (Write Protection)

This element specifies the write protection settings which have been applied to a WordprocessingML document. Write protection refers to a mode in which the document's contents cannot be edited, and the document cannot be resaved using the same file name. This setting is independent of the documentProtection (§2.15.1.28) element, but like document protection, this setting is not intended as a security feature and may be ignored.

When present, the write protection shall result in one of two write protection behaviors:

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

[Example: Consider a WordprocessingML document that can be opened but only in a write protected state unless a password is provided, in which case the file would be opened in an editable state. This requirement would be specified using the following WordprocessingML in the document settings:

<w:writeProtection w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" /> 

The writeProtection element is present which specifies that write protection shall be turned on for this document. Since the password attribute is equal to 9oN7nWkCAyEZib1RomSJTjmPpCY= the given WordprocessingML document can only be opened in a write protected state unless a password which matches the hash value 9oN7nWkCAyEZib1RomSJTjmPpCY=is provided; in which case the file would be opened in an editable state. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

algIdExt (Cryptographic Algorithm Extensibility)

Specifies that a cryptographic algorithm which was not defined by this Office Open XML Standard has been used to generate the hash value stored with this document.

This value, when present, shall be interpreted based on the value of the algIdExtSource attribute in order to determine the algorithm used, which shall be application-defined. [Rationale: This extensibility affords the fact that with exponentially increasing computing power, documents created in the future will likely need to utilize as yet undefined hashing algorithms in order to remain secure. end rationale]

If this value is present, the cryptAlgorithmClass, cryptAlgorithmType, and cryptAlgorithmSid attribute values shall be ignored in favor of the algorithm defined by this attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:algIdExt="0000000A" 
  w:algIdExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The algIdExt attribute value of 0000000A specifies that the algorithm with hex code A shall be used as defined by the futureCryptography application. end example]

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

algIdExtSource (Algorithm Extensibility Source)

Specifies the application which defined the algorithm value specified by the algIdExt attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:algIdExt="0000000A" 
  w:algIdExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The algIdExtSource attribute value of futureCryptography specifies that the algorithm used here was published by the futureCryptography application. end example]

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

cryptAlgorithmClass (Cryptographic Algorithm Class)

Specifies the class of cryptographic algorithm used by this protection. [Note: The initial version of this Office Open XML Standard only supports a single version - hash - but future versions may expand this as necessary. end note]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmClass attribute value of hash specifies that the algorithm used for the password is a hashing algorithm. end example]

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

cryptAlgorithmSid (Cryptographic Hashing Algorithm)

Specifies the specific cryptographic hashing algorithm which shall be used along with the salt attribute and user-supplied password in order to compute a hash value for comparison.

The possible values for this attribute shall be interpreted as follows:

Value

Algorithm

1

MD2

2

MD4

3

MD5

4

SHA-1

5

MAC

6

RIPEMD

7

RIPEMD-160

8

Undefined. Shall not be used.

9

HMAC

10

Undefined. Shall not be used.

11

Undefined. Shall not be used.

12

SHA-256

13

SHA-384

14

SHA-512

Any other value

Undefined. Shall not be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmSid attribute value of 1 specifies that the SHA-1 hashing algorithm shall be used to generate a hash from the user-defined password. end example]

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

cryptAlgorithmType (Cryptographic Algorithm Type)

Specifies the type of cryptographic algorithm used by this protection. [Note: The initial version of this Office Open XML Standard only supports a single type - typeAny - but future versions may expand this as necessary. end note]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptAlgorithmType attribute value of typeAny specifies that any type of algorithm may have been used for the password. end example]

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

cryptProvider (Cryptographic Provider)

Specifies the cryptographic provider which was used to generate the hash value stored in this document. If the user provided a cryptographic provider which was not the system's built-in provider, then that provider shall be stored here so it can subsequently be used if available.

If this attribute is omitted, then the built-in cryptographic provider on the system shall be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProvider="Krista'sProvider"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProvider attribute value of Krista'sProvider specifies that the cryptographic provider with name "Krista's Provider" shall be used if available. end example]

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

cryptProviderType (Cryptographic Provider Type)

Specifies the type of cryptographic provider to be used.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderType="rsaAES"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProviderType attribute value of rsaAES specifies that the cryptographic provider type shall be an Advanced Encryption Standard provider. end example]

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

cryptProviderTypeExt (Cryptographic Provider Type Extensibility)

Specifies that a cryptographic provider type which was not defined by this Office Open XML Standard has been used to generate the hash value stored with this document.

This value, when present, shall be interpreted based on the value of the cryptProviderTypeExtSource attribute in order to determine the provider type used, which shall be application-defined. [Rationale: This extensibility affords the fact that with exponentially increasing computing power, documents created in the future will likely need to utilize as yet undefined cryptographic provider types in order to remain secure. end rationale]

If this value is present, the cryptProviderType attribute value shall be ignored in favor of the provider type defined by this attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderTypeExt="00A5691D" 
  w:cryptProvideTypeExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProviderTypeExt attribute value of 00A5691D specifies that the provider type associated with hex code A5691D shall be used as defined by the futureCryptography application. end example]

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

cryptProviderTypeExtSource (Provider Type Extensibility Source)

Specifies the application which defined the provider type value specified by the cryptProviderTypeExt attribute.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptProviderTypeExt="00A5691D" 
  w:cryptProvideTypeExtSource="futureCryptography"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptProvideTypeExtSource attribute value of futureCryptography specifies that the provider type used here was published by the futureCryptography application. end example]

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

cryptSpinCount (Iterations to Run Hashing Algorithm)

Specifies the number of times the hashing function shall be iteratively run (using each iteration's result as the input for the next iteration) when attempting to compare a user-supplied password with the value stored in the hash attribute. [Rationale: Running the algorithm many times increases the cost of exhaustive search attacks correspondingly. Storing this value allows for the number of iterations to be increased over time to accommodate faster hardware (and hence the ability to run more iterations in less time). end rationale]

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptSpinCount="100000"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The cryptSpinCount attribute value of 100000 specifies that the hashing function shall be run one hundred thousand times to generate a hash value for comparison with the hash attribute. end example]

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

hash (Password Hash)

Specifies the hash value for the password stored with this document. This value shall be compared with the resulting hash value after hashing the user-supplied password using the algorithm specified by the preceding attributes and parent XML element, and if the two values match, the protection shall no longer be enforced.

If this value is omitted, then no password shall be associated with the protection, and it may be turned off without supplying any password.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:cryptAlgorithmClass="hash" 
  w:cryptAlgorithmType="typeAny" 
  w:cryptAlgorithmSid="1"
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The hash attribute value of 9oN7nWkCAyEZib1RomSJTjmPpCY= specifies that the user-supplied password shall be hashed using the pre-processing defined by the parent element (if any) followed by the SHA-1 algorithm (specified via the cryptAlgorithmSid attribute value of 1) and that the resulting has value must be 9oN7nWkCAyEZib1RomSJTjmPpCY= for the protection to be disabled. end example]

The possible values for this attribute are defined by the XML Schema base64Binary datatype.

recommended (Recommend Write Protection in User Interface)

Specifies that applications should provide user interface recommending that the user open this document in write protected state. If the user chooses to do so, the document shall be write protected, otherwise, it shall be opened fully editable.

If this attribute is omitted, then user interface recommending that the user open this document in write protected state should not be provided. If the password attribute is also specified, then this setting shall be ignored.


[Example: Consider a WordprocessingML document which specifies that applications shall recommend write protection to this document. This requirement would be specified using the following WordprocessingML in the document settings:

<w:writeProtection w:recommended="true" /> 

The recommended attribute has a value of true specifying that the applications shall hash any password provided, and if it matches this hash value, may only then halt enforcement of write protection. end example]

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

salt (Salt for Password Verifier)

Specifies the salt which was prepended to the user-supplied password before it was hashed using the hashing algorithm defined by the preceding attribute values to generate the hash attribute, and which shall also be prepended to the user-supplied password before attempting to generate a hash value for comparison. A salt is a random string which is added to a user-supplied password before it is hashed in order to prevent a malicious party from pre-calculating all possible password/hash combinations and simply using those precalculated values (often referred to as a "dictionary attack").

If this attribute is omitted, then no salt shall be prepended to the user-supplied password before it is hashed for comparison with the stored hash value.

[Example: Consider a WordprocessingML document with the following information stored in one of its protection elements:

<w:... w:salt="ZUdHa+D8F/OAKP3I7ssUnQ=="
  w:hash="9oN7nWkCAyEZib1RomSJTjmPpCY=" />

The salt attribute value of ZUdHa+D8F/OAKP3I7ssUnQ== specifies that the user-supplied password shall have this value prepended before it is run through the specified hashing algorithm to generate a resulting hash value for comparison. end example]

The possible values for this attribute are defined by the XML Schema base64Binary datatype.

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

<complexType name="CT_WriteProtection">

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

<attributeGroup ref="AG_Password"/>

</complexType>

2.15.1.95 zoom (Magnification Setting)

This element specifies the magnification level which should be applied to a document when it is displayed by an application. The zoom level is specified with the use of two attributes stored on this element:

If both attributes are present, then the percent attribute shall be treated as a 'cached' value and only used when the value none is specified for the val attribute.

If this element is omitted, then applications may display the document in any desired magnification setting.

[Example: Consider a WordprocessingML document that is to have its zoom level at seventy one percent when it is displayed. This requirement would be specified using the following WordprocessingML fragment in the document settings:

<w:zoom w:percent="71" /> 

The zoom element's percent attribute has a value of 71, specifying that the given document shall have its zoom level set to seventy one percent when it is displayed. end example]

Parent Elements

settings (§2.15.1.78)

Attributes

Description

percent (Zoom Percentage)

Specifies the zoom percentage that should be applied when a given WordprocessingML document is rendered by conforming hosting applications. This value is the zoom percentage specified as an integer whose units correspond to the zoom percentage.

If this attribute is omitted, then applications may use any desired default percentage for the magnification.

If the val attribute instantiated in addition to the percent attribute, then the percent attribute shall be treated as a cached value and only used when the value none is specified for the val attribute. If the value specified exceeds the maximum zoom level available in a conforming hosting application, the conforming hosting application shall display the document using its maximum zoom level. Correspondingly, if the value specified is less than the minimum zoom level available in the conforming hosting application, the conforming hosting application shall display the document using its minimum zoom level.

[Example: Consider a WordprocessingML document that is to have its zoom level at fifty percent when rendered by conforming hosting applications. This requirement would be specified using the following WordprocessingML:

<w:zoom w:percent="50" /> 

The percent attribute has a value of 50, specifying that the given WordprocessingML document shall to have its zoom level set to fifty percent when it is displayed. end example]

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

val (Zoom Type)

Specifies the type of zoom which shall be applied to a given document on open.

If this attribute is not present, then the document shall be displayed as though the value had been set to none, and should rely on the value of the percent attribute for the actual zoom percentage.

[Example: Consider a WordprocessingML document that should be visible without any horizontal scrolling when it is displayed. This requirement would be specified using the following WordprocessingML:

<w:zoom w:val="bestFit" w:percent="90" />

The val attribute is equal to the value bestFit specifying that an application shall dynamically calculate the magnification needed such that the given document shall be visible on the horizontal plane of the document with no horizontal scrolling required to see any part of the WordprocessingML document's pages.

Since both attributes are present, the percent attribute shall be treated as a 'cached' value and ignored. end example]

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

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

<complexType name="CT_Zoom">

<attribute name="val" type="ST_Zoom" use="optional"/>

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

</complexType>


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