DocumentID: ECMA-376/Part4/2.3.3 Title: ECMA-376, Part4: 2.3.3 Run Content 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
The final level of the document hierarchy is run content, which is defined as the set of elements which can be contained as the contents of a particular run in a document.
[Note: Types of run content in WordprocessingML include:
end note]
[Example: Consider the following run within a WordprocessingML document:
<w:r>
<w:rPr>
<w:b/>
<w:i/>
</w:rPr>
<w:t>quick</w:t>
</w:r>
The run content consists of a single string of run text inside the t element, which reads quick. end example]
This element specifies that a break shall be placed at the current location in the run content. A break is a special character which is used to override the normal line breaking that would be performed based on the normal layout of the document's contents. [Example: Normal breaking for English would occur only after a breaking space or optional hyphen character. end example]
The behavior of this break character (the location where text shall be restarted after this break) shall be determined by its type and clear attribute values, described below.
[Example: Consider the following sentence in a WordprocessingML document:
This is a simple sentence.
Normally, just as shown above, this sentence would be displayed on a single line as it is not long enough to require line breaking (given the width of the current page). However, if a text wrapping break character (a typical line break) were inserted after the word is, as follows:
<w:r>
<w:t>This is</w:t>
<w:br/>
<w:t xml:space="preserve"> a simple sentence.</w:t>
</w:r>
This would imply that this break shall be treated as a simple line break, and break the line after that word:
This is
a simple sentence.
The break character forced the following text to be restarted on the next available line in the document. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
clear (Restart Location For Text Wrapping Break) |
Specifies the location which shall be used as the next available line when the break's If this break is not of type textWrapping, then this attribute shall be ignored. If this attribute is omitted, then its value shall be assumed to be none if needed. [Example: Consider a text wrapping break character which should force the restart location to the next line which spans the full width of the text extents of the page (there are no floating objects which interrupt the line). This line break is of type textWrapping, since it shall only advance to the next line, but the
This break shall therefore not use the next available line, but rather the next available line ignoring all lines which do not span the full text width. end example] The possible values for this attribute are defined by the ST_BrClear simple type (§2.18.5). |
|
type (Break Type) |
Specifies the type of the current break. The break type determines the next location where text shall be placed after this manual break is applied to the text contents (see possible values for details). If this attribute is omitted, then it shall be assumed to be of type textWrapping. [Example: Consider a manual break which shall advance the text to the next text column in the document, rather than just the next available line. This break would therefore be specified as follows:
The The possible values for this attribute are defined by the ST_BrType simple type (§2.18.6). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Br">
<attribute name="type" type="ST_BrType" use="optional"/>
<attribute name="clear" type="ST_BrClear" use="optional"/>
</complexType>
This element specifies that the parent VML object is a representation of an embedded control at the current location in the document. This element shall be used to associate the VML data with the appropriate embedded control settings and properties when the document is displayed.
If the embedded control is not present, cannot be loaded due to application settings, or is not supported, then the VML data shall be used to provide an image representation of the control at the appropriate location in the document.
[Example: Consider a run which consists of an embedded control. That run would be specified using the following WordprocessingML:
<w:r>
<w:pict>
...
<w:control r:id="rId99" w:shapeid="shape01" ... />
</w:pict>
</w:r>
The control element indicates that the parent VML object contains the positioning and last known image representation of an embedded control, whose settings and properties are stored on this element. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
id (Embedded Control Properties Relationship Reference) Namespace: .../officeDocument/2006/relationships |
Specifies the relationship ID for the relationship which contains the properties for this embedded control. This property bag is contained in a separate part within the Word Open XML package. The relationship explicitly targeted by this attribute shall be of type http://schemas.openxmlformats.org/officeDocument/2006/relationships/control or the document shall be conisdered non-conformant. If this attribute is omitted, then the embedded control shall be given no property bag when instantiated. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The The possible values for this attribute are defined by the ST_RelationshipId simple type (§7.8.2.1). |
|
name (Unique Name for Embedded Control) |
Specifies a unique name for this embedded control. This name shall be unique across all controls in this document. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The The possible values for this attribute are defined by the ST_String simple type (§2.18.89). |
|
shapeid (Associated VML Data Reference) |
Specifies the shape ID for a shape which shall be used to define the presentation and location of this embedded control within the document if the control is floating using the VML syntax. [Note: This positioning data is sufficient to display the control in any case where:
end note] This shape ID reference is resolved by looking for a VML shape element (§6.1.2.19) whose If this attribute is omitted, then this embedded control shall be displayed inline in the current location in the parent run. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The 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_Control">
<attribute name="name" type="ST_String" use="optional"/>
<attribute name="shapeid" type="ST_String" use="optional"/>
<attribute ref="r:id" use="optional"/>
</complexType>
This element specifies that the parent embedded object is a representation of an embedded control at the current location in the document. This element shall be used to associate the appropriate embedded control settings and properties when the document is displayed.
If the embedded control is not present, cannot be loaded due to application settings, or is not supported, then a suitable placeholder image shall be used to provide a representation of the presence of an embedded control at the appropriate location in the document.
[Example: Consider a run which consists of an embedded control. That run would be specified using the following WordprocessingML:
<w:r>
<w:object>
...
<w:control r:id="rId99" w:shapeid="shape01" ... />
</w:object>
</w:r>
The control element indicates that the parent embedded object is an embedded control, whose settings and properties are stored on this element and the (optional) target of the relationship specified using the id attribute. end example]
|
Parent Elements |
|
object (§2.3.3.19) |
|
Attributes |
Description |
|---|---|
|
id (Embedded Control Properties Relationship Reference) Namespace: .../officeDocument/2006/relationships |
Specifies the relationship ID for the relationship which contains the properties for this embedded control. This property bag is contained in a separate part within the Word Open XML package. The relationship explicitly targeted by this attribute shall be of type http://schemas.openxmlformats.org/officeDocument/2006/relationships/control or the document shall be conisdered non-conformant. If this attribute is omitted, then the embedded control shall be given no property bag when instantiated. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The The possible values for this attribute are defined by the ST_RelationshipId simple type (§7.8.2.1). |
|
name (Unique Name for Embedded Control) |
Specifies a unique name for this embedded control. This name shall be unique across all controls in this document. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The The possible values for this attribute are defined by the ST_String simple type (§2.18.89). |
|
shapeid (Associated VML Data Reference) |
Specifies the shape ID for a shape which shall be used to define the presentation and location of this embedded control within the document if the control is floating using the VML syntax. [Note: This positioning data is sufficient to display the control in any case where:
end note] This shape ID reference is resolved by looking for a VML shape element (§6.1.2.19) whose If this attribute is omitted, then this embedded control shall be displayed inline in the current location in the parent run. [Example: Consider the following WordprocessingML markup for an embedded control in a document:
The 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_Control">
<attribute name="name" type="ST_String" use="optional"/>
<attribute name="shapeid" type="ST_String" use="optional"/>
<attribute ref="r:id" use="optional"/>
</complexType>
This element specifies that a carriage return shall be placed at the current location in the run content. A carriage return is the equivalent of Unicode character 000D, and is used to end the current line of text in WordprocessingML.
The behavior of a carriage return in run content shall be identical to a break character with null type and clear attributes, which shall end the current line and find the next available line on which to continue.
[Example: Consider the following sentence in a WordprocessingML document:
This is another simple sentence.
Normally, just as shown above, this sentence would be displayed on a single line as it is not long enough to require line breaking (given the width of the current page). However, if a carriage return were inserted after the word another, as follows:
<w:r>
<w:t>This is another</w:t>
<w:cr/>
<w:t xml:space="preserve"> simple sentence.</w:t>
</w:r>
This would imply that this carriage return character shall force a line break, and break the line after that word:
This is another
simple sentence.
The carriage return character forced the following text to be restarted on the next available line in the document. end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs) . [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The long day format date block shall use a date picture of DDDD, retrieving the long day format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a long date: </w:t>
<w:dayLong />
</w:r>
This run specifies that a long day format date block shall be placed after the text string literal This is a long date: in the document. Assuming that the host application's primary editing language is French (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a long date: mercredi
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs) . [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The short day format date block shall use a date picture of DD, retrieving the short day format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a short date: </w:t>
<w:dayShort />
</w:r>
This run specifies that a short day format date block shall be placed after the text string literal This is a short date: in the document. Assuming that the host application's primary editing language is English (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a short date: 12
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies that this run contains literal text which shall be displayed in the document. The delText element shall be used for all text runs which are part of a region of text that is contained in a deleted region using the del element (§2.13.5.12).
[Example: Consider a paragraph of WordprocessingML content which reads This is deleted text, where the words deleted text are part of a deleted region of the document. This paragraph would therefore be represented as follows:
<w:p>
<w:r>
<w:t xml:space="preserve">This is </w:t>
</w:r>
<w:del>
<w:r>
<w:delText>deleted text</w:delText>
</w:r>
</w:del>
</w:p>
The deleted text is contained in a delText node, while the regular text is contained in a t node. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
space (Content Contains Significant Whitespace) Namespace: http://www.w3.org/XML/1998/namespace |
Specifies how white space should be handled for the contents of this element using the W3C space preservation rules. [Example: Consider the following run contained within a WordprocessingML document:
Although there are three spaces on each side of the text content in the run, that whitespace has not been specifically marked as significant, therefore it is removed when this run is added to the document. end example] The possible values for this attribute are defined by the type in the namespace. |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Text">
<simpleContent>
<extension base="ST_String">
<attribute ref="xml:space" use="optional"/>
</extension>
</simpleContent>
</complexType>
This element specifies that the field has been changed and the results shall be updated on open in a conforming consumer.
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
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:
The 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>
This element specifies that a DrawingML object is located at this position in the run's contents. The layout properties of this DrawingML object are specified using the WordprocessingML Drawing syntax (§5.5).
[Example: Consider a run which consists of a picture which is in line with the text in that paragraph (i.e. on the line and affects the line height). That run would be specified using the following WordprocessingML:
<w:r>
<w:drawing>
<wp:inline>
...
</wp:inline>
</w:drawing>
</w:r>
The drawing element indicates that a DrawingML object and its WordprocessingML Drawing positioning data are located at the current position in the run (e.g. a picture or a chart). end example]
|
Parent Elements |
|
Child Elements |
Subclause |
|---|---|
|
anchor (Anchor for Floating DrawingML Object) |
|
|
inline (Inline DrawingML Object) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Drawing">
<choice minOccurs="1" maxOccurs="unbounded">
<element ref="wp:anchor" minOccurs="0"/>
<element ref="wp:inline" minOccurs="0"/>
</choice>
</complexType>
This element specifies the font size which shall be applied to the phonetic guide text in the contents of this run when displayed.
If this element disagrees with the run properties on the phonetic guide text rt element (§2.3.3.23), then those properties shall be ignored and this element shall determine the size of the phonetic guide text.
[Example: Consider a run of phonetic guide text which shall have an explicit font size of 13.5 points. This constraint is specified using the following WordprocessingML:
<w:rubyPr>
...
<w:hps w:val="27"/>
...
</w:rubyPr>
The hps property is 27 half-points for the ruby text in this run, so the phonetic guide text will be displayed in 13.5 point font size. end example]
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
Attributes |
Description |
|---|---|
|
val (Half Point Measurement) |
Specifies a positive measurement specified in half-points (1/144 of an inch). The contents of this attribute value are interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML fragment:
The value of the However, consider the following fragment:
In this case, the value in the 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_HpsMeasure simple type (§2.18.48). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_HpsMeasure">
<attribute name="val" type="ST_HpsMeasure" use="required"/>
</complexType>
This element specifies the font size which shall be applied to the base text of this phonetic guide text when displayed. If this element disagrees with the run properties on the phonetic guide base text rubyBase element (§2.3.3.26), then this property shall be ignored and the sz element (§2.3.2.36) in that run shall determine the size of the phonetic guide base text.
[Example: Consider a run of phonetic guide base text which shall have an explicit font size of 30 points. This constraint is specified using the following WordprocessingML:
<w:rubyPr>
...
<w:hpsBaseText w:val="60"/>
...
</w:rubyPr>
The hpsBaseText property is 60 half-points for the base text in this phonetic guide, so the phonetic guide base text will be displayed in 30 point font size. end example]
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
Attributes |
Description |
|---|---|
|
val (Half Point Measurement) |
Specifies a positive measurement specified in half-points (1/144 of an inch). The contents of this attribute value are interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML fragment:
The value of the However, consider the following fragment:
In this case, the value in the 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_HpsMeasure simple type (§2.18.48). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_HpsMeasure">
<attribute name="val" type="ST_HpsMeasure" use="required"/>
</complexType>
This element specifies the distance which shall be left between the phonetic guide base text and the phonetic guide text when this phonetic guide text is displayed.
[Example: Consider a run of phonetic guide text which shall have 10 points between the phonetic guide base text and the phonetic guide text. This constraint is specified using the following WordprocessingML:
<w:rubyPr>
...
<w:hpsRaise w:val="20"/>
...
</w:rubyPr>
The hpsRaise property is 20 half-points for the phonetic guide, so the phonetic guide text will be displayed 10 points above the phonetic guide base text. end example]
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
Attributes |
Description |
|---|---|
|
val (Half Point Measurement) |
Specifies a positive measurement specified in half-points (1/144 of an inch). The contents of this attribute value are interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML fragment:
The value of the However, consider the following fragment:
In this case, the value in the 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_HpsMeasure simple type (§2.18.48). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_HpsMeasure">
<attribute name="val" type="ST_HpsMeasure" use="required"/>
</complexType>
This element specifies that this position delimited the end of a page when this document was last saved by an application which paginates its content.
[Guidance: This element shall be used by applications to specify the locations of page breaks within a document when it is saved as WordprocessingML, in order to allow other applications (e.g. assistive software) to utilize this information when reading the document. end guidance]
[Example: Consider a run which consists of the text This is the end of the page, where the word end was the last word on a page. If the application saving this file had paginated this content, that information may be saved with the file as follows:
<w:r>
<w:t>This is the end</w:t>
<w:lastRenderedPageBreak/>
<w:t xml:space="preserve"> of the page</w:t>
</w:r>
The lastRenderedPageBreak element indicates that there was a page break resulting from pagination of this content, which occurred between the word end and the word of. end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the language which shall be for this phonetic guide.
[Example: Consider a run of phonetic guide text which is using Japanese as it language. This constraint is specified using the following WordprocessingML:
<w:rubyPr>
...
<w:lid w:val="ja-JP"/>
...
</w:rubyPr>
The lid property is ja-JP for the phonetic guide, so the phonetic guide is specified to be Japanese. end example]
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
Attributes |
Description |
|---|---|
|
val (Language Code) |
Specifies an ISO 639-1 letter code or 4 digit hexadecimal code for a specific language. This code is interpreted in the context of the parent XML element. [Example: Consider an object which shall specify the English(Canada) language. That object would use the ISO 639-1 letter code of en-CA to specify this language. 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_Lang">
<attribute name="val" type="ST_Lang" use="required"/>
</complexType>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs) . [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The long month format date block shall use a date picture of MMMM, retrieving the long month format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a long date: </w:t>
<w:monthLong />
</w:r>
This run specifies that a long month format date block shall be placed after the text string literal This is a long date: in the document. Assuming that the host application's primary editing language is French (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a long date: avril
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs). [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The short month format date block shall use a date picture of MM, retrieving the short month format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a short date: </w:t>
<w:monthShort />
</w:r>
This run specifies that a short month format date block shall be placed after the text string literal This is a short date: in the document. Assuming that the host application's primary editing language is English (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a short date: 04
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies a location within a document where the specified parent image shall be treated as a static placeholder for an embedded movie. The specified movie file's contents should be displayed when requested at this location in the document. The location of the embedded movie to be displayed when supported shall be specified by the relationship whose Id attribute matches the id attribute on this element.
If the relationship type of the relationship specified by this element is not http://schemas.openxmlformats.org/officeDocument/2006/movie, or is not present, then the document shall be considered non-conformant. If an application cannot process external content of the content type specified by the targeted part, then it may be ignored.
[Example: Consider a WordprocessingML document which contains a VML shape holding the static image for a movie:
<v:shape id="_x0000_s1026" ... >
<w:movie r:id="rIdMovie" />
<v:imagedata r:id="rId5" r:pict="rId6" o:title="" o:movie="7168" />
</v:shape>
The movie element specifies that the part targeted by the relationship with an ID of rIdMovie shall be imported at the beginning of the document. Examining the contents of the corresponding relationship part item, we can see the targets for that relationship:
<Relationships ... >
...
<Relationship Id="rIdMovie" TargetMode="Internal" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/movie" Target="movie.mov" />
...
</Relationships>
The corresponding relationship part item shows that the movie file is located next to the main document and is named movie.mov. end example]
|
Parent Elements |
|
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:
[Example: Consider an XML element which has the following
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>
This element specifies that a non breaking hyphen character shall be placed at the current location in the run content. A non breaking hyphen is the equivalent of Unicode character 002D (the hyphen-minus), however it shall not be used as a valid line breaking character for the current line of text when displaying this WordprocessingML content.
The behavior of a non breaking hyphen in run content shall be to display using the same glyph as the hyphen-minus character, however without being a valid line breaking position (unlike the hyphen-minus character).
[Example: Consider the following sentence in a WordprocessingML document:
This makes a very very very wordy and deliberately overcomplicated sentence.
Normally, just as shown above, this sentence not would be displayed on a single line as it is long enough to require line breaking (given the width of the current page). However, if a hyphen minus were inserted after the letter s in sentence, as follows:
<w:r>
<w:t>This makes a very very very wordy and deliberately overcomplicated s-entence.</w:t>
</w:r>
This would allow a break at that position, and break the word after that character:
This makes a very very very wordy and deliberately overcomplicated s-entence.
If this was not desired, the non breaking hyphen character could be specified as follows:
<w:r>
<w:t>This makes a very very very wordy and deliberately overcomplicated s</w:t>
<w:nonBreakHyphen/>
<w:t>entence.</w:t>
</w:r>
This would display a hyphen character, but would not allow the text to break at that location:
This makes a very very very wordy and deliberately overcomplicated s-entence.
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies that an embedded object is located at this position in the run's contents. The layout properties of this embedded object are specified using the VML syntax (§6.1).
[Example: Consider a run which consists of an embedded object which is in line with the text in that paragraph (i.e. on the line and affects the line height). That run would be specified using the following WordprocessingML:
<w:r>
<w:object>
...
</w:object>
</w:r>
The object element indicates that an embedded object and its VML positioning data are located at the current position in the run (e.g. an embedded object). end example]
|
Parent Elements |
|
Child Elements |
Subclause |
|---|---|
|
Any element from the urn:schemas-microsoft-com:vml namespace |
|
|
Any element from the urn:schemas-microsoft-com:office:office namespace |
|
|
control (Inline Embedded Control) |
|
Attributes |
Description |
|---|---|
|
dxaOrig (Original Image Width) |
Specifies the original (natural) width of the image representation of the current control within the document. Some vector image formats do not store a native size within their format, and this attribute shall only be used in those cases to store this information, so that the image may be appropriately restored as needed. If this element is excluded, then the natural size of the image as stored in its format shall be used. [Example: Consider the following WordprocessingML for an embedded object:
The The possible values for this attribute are defined by the ST_TwipsMeasure simple type (§2.18.105). |
|
dyaOrig (Original Image Height) |
Specifies the original (natural) height of the image representation of the current control within the document. Some vector image formats do not store a native size within their format, and this attribute shall only be used in those cases to store this information, so that the image may be appropriately restored as needed. If this element is excluded, then the natural size of the image as stored in its format shall be used. [Example: Consider the following WordprocessingML for an embedded object:
The 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_Object">
<complexContent>
<extension base="CT_PictureBase">
<sequence>
<element name="control" type="CT_Control" minOccurs="0"/>
</sequence>
<attribute name="dxaOrig" type="ST_TwipsMeasure" use="optional"/>
<attribute name="dyaOrig" type="ST_TwipsMeasure" use="optional"/>
</extension>
</complexContent>
</complexType>
This element specifies the presence of a page number block at the current location in the run content. A page number block is a non-editable region of text which shall display the current page using ascending decimal numbers. [Note: The page number block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the PAGENUM field is used in its place. end note]
A page number block shall be displayed using ascending decimal numbers, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is the current page: </w:t>
<w:pgNum />
</w:r>
This run specifies that a page number block shall be placed after the text string literal This is the curent page: in the document. Assuming that this content is on the first page, this run would be displayed as follows:
This is the current page: 1
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies that an object is located at this position in the run's contents. The layout properties of this object are specified using the VML syntax (§6.1).
[Example: Consider a run which consists of an object specified using VML. That run would be specified using the following WordprocessingML:
<w:r>
<w:pict>
...
</w:pict>
</w:r>
The pict element indicates that an object specified in VML is located at the current position in the run (e.g. a floating embedded control). end example]
|
Parent Elements |
|
Child Elements |
Subclause |
|---|---|
|
Any element from the urn:schemas-microsoft-com:vml namespace |
|
|
Any element from the urn:schemas-microsoft-com:office:office namespace |
|
|
control (Floating Embedded Control) |
|
|
movie (Embedded Video) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Picture">
<complexContent>
<extension base="CT_PictureBase">
<sequence maxOccurs="1">
<element name="movie" type="CT_Rel" minOccurs="0"/>
<element name="control" type="CT_Control" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
This element specifies that an absolute position tab character shall be placed at the current location in the run content. An absolute position tab is a character which is used to advance the position on the current line of text when displaying this WordprocessingML content, using the following logic:
Regardless of any number of custom tab stops defined using the tabs element (§2.3.1.38) , the absolute position tab character shall advance to the position specified by its alignment and relativeTo attributes. The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the defaultTabStop element (§2.15.1.24).
If the alignment location specified by the positional tab cannot be found on the current line, because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.
[Example: Consider a paragraph which contains two custom tab stops at 1.5" and 3.5", respectively. These two tab stops would be contained within a tabs element defining the set of tab stops of the paragraph as follows:
<w:pPr>
<w:tabs>
<w:tab w:val="left" w:pos="2160" />
<w:tab w:val="left" w:pos="5040" />
</w:tabs>
</w:pPr>
If a positional tab character was added to a run in this paragraph starting at 1" inside the margin and was defined as follows:
<w:ptab w:alignment="center" w:relativeTo="margin" />
This positional tab would then ignore the next custom tab stop and the indents on the current paragraph defined using the ind element (§2.3.1.12) and would advance to the center of the line with respect to the text margins, moving to a new line if needed. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
alignment (Positional Tab Stop Alignment) |
Specifies the location of the positional tab stop on the line, as well as the alignment which shall be applied to text subsequent to the current positional tab stop. [Example: Consider a positional tab stop in a WordprocessingML document who shall move to the left edge of the text margins and whose subsequent text should be left aligned. This positional tab stop would be defined as follows:
The alignment attribute specifies that this absolute position tab stop shall align on the left edge of the line relative to the margin. end example] The possible values for this attribute are defined by the ST_PTabAlignment simple type (§2.18.78). |
|
leader (Tab Leader Character) |
Specifies the character which shall be used to fill in the space created by a positional tab. This character shall be repeated as required to completely fill the tab spacing generated by the positional tab character. [Example: Consider a positional tab stop which should be preceded by a sequence of underscore characters, as follows: ______________Text at the positional tab stop This tab stop would have a The possible values for this attribute are defined by the ST_PTabLeader simple type (§2.18.79). |
|
relativeTo (Positional Tab Base) |
Specifies the extents which shall be used to calculate the absolute positioning of this positional tab character. [Example: Consider a positional tab stop in a WordprocessingML document that should have a resulting position that is centered on the text margins, ignoring both any custom tab stops and any text indents on the paragraph. This positional tab stop would be defined as follows:
The The possible values for this attribute are defined by the ST_PTabRelativeTo simple type (§2.18.80). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_PTab">
<attribute name="alignment" type="ST_PTabAlignment" use="required"/>
<attribute name="relativeTo" type="ST_PTabRelativeTo" use="required"/>
<attribute name="leader" type="ST_PTabLeader" use="required"/>
</complexType>
This element specifies the presence of the guide text within a phonetic guide at the current location in the document.
The contents of the guide text run are specified in the child r element (§2.3.2.23).
[Example: Consider the following two runs, each containing a phonetic guide:
(missing graphic misc-2.3.3.23-1)
The guide text run would be specified using the following WordprocessingML:
<w:rt>
...
<w:r>
<w:t>tō</w:t>
</w:r>
</w:rt>
The guide text is contained in a run within the rt element. end example]
|
Parent Elements |
|
ruby (§2.3.3.24) |
|
Child Elements |
Subclause |
|---|---|
|
bookmarkEnd (Bookmark End) |
|
|
bookmarkStart (Bookmark Start) |
|
|
commentRangeEnd (Comment Anchor Range End) |
|
|
commentRangeStart (Comment Anchor Range Start) |
|
|
customXmlDelRangeEnd (Custom XML Markup Deletion End) |
|
|
customXmlDelRangeStart (Custom XML Markup Deletion Start) |
|
|
customXmlInsRangeEnd (Custom XML Markup Insertion End) |
|
|
customXmlInsRangeStart (Custom XML Markup Insertion Start) |
|
|
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End) |
|
|
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start) |
|
|
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End) |
|
|
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start) |
|
|
del (Deleted Run Content) |
|
|
ins (Inserted Run Content) |
|
|
moveFrom (Move Source Run Content) |
|
|
moveFromRangeEnd (Move Source Location Container - End) |
|
|
moveFromRangeStart (Move Source Location Container - Start) |
|
|
moveTo (Move Destination Run Content) |
|
|
moveToRangeEnd (Move Destination Location Container - End) |
|
|
moveToRangeStart (Move Destination Location Container - Start) |
|
|
oMath (Office Math) |
|
|
oMathPara (Math Paragraph) |
|
|
permEnd (Range Permission End) |
|
|
permStart (Range Permission Start) |
|
|
proofErr (Proofing Error Anchor) |
|
|
r (Text Run) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_RubyContent">
<group ref="EG_RubyContent" minOccurs="0" maxOccurs="unbounded"/>
</complexType>
This element specifies the presence of a phonetic guide at the current location in the document. A phonetic guide (often called ruby text) is a run of content with base text which appears at the normal baseline location for text in this run, with phonetic guide text displayed above it in the document. The resulting construct is called a phonetic guide as it is typically used to map words in one language to another phonetically.
The base text is stored in the rubyBase element (§2.3.3.26) and the guide text is stored in the rt element (§2.3.3.23).
[Example: Consider the following two runs, each containing a phonetic guide:
The first run would be specified using the following WordprocessingML:
<w:r>
<w:ruby>
<w:rubyPr>
...
</w:rubyPr>
<w:rt>
...
<w:r>
<w:t>tō</w:t>
</w:r>
</w:rt>
<w:rubyBase>
...
<w:r>
<w:t>東</w:t>
</w:r>
</w:rubyBase>
</w:ruby>
</w:r>
The base text is contained in a run within the rubyBase element, and the guide text is contained in a run within the rt element. end example]
|
Parent Elements |
|
Child Elements |
Subclause |
|---|---|
|
rt (Phonetic Guide Text) |
|
|
rubyBase (Phonetic Guide Base Text) |
|
|
rubyPr (Phonetic Guide Properties) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Ruby">
<sequence>
<element name="rubyPr" type="CT_RubyPr"/>
<element name="rt" type="CT_RubyContent"/>
<element name="rubyBase" type="CT_RubyContent"/>
</sequence>
</complexType>
This element specifies the alignment setting which shall be used to determine the placement of phonetic guide text with respect to the base text when this phonetic guide is displayed.
[Example: Consider a run of phonetic guide text which shall have the ruby text positioned to the far left of the base text. This constraint is specified using the following WordprocessingML:
<w:rubyPr>
...
<w:rubyAlign w:val="left"/>
...
</w:rubyPr>
The rubyAlign property is left for the phonetic guide, so the ruby text will be displayed on the left side of the base text. end example]
|
Parent Elements |
|
rubyPr (§2.3.3.27) |
|
Attributes |
Description |
|---|---|
|
val (Phonetic Guide Text Alignment Value) |
Specifies the type of alignment to be applied to the phonetic guide text. [Example: Consider a run of phonetic guide text which shall have the ruby text positioned to the far right of the base text. This constraint is specified using the following WordprocessingML:
The value of the val attribute is right for the phonetic guide, so the ruby text will be displayed on the right side of the base text. end example] The possible values for this attribute are defined by the ST_RubyAlign simple type (§2.18.82). |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_RubyAlign">
<attribute name="val" type="ST_RubyAlign" use="required"/>
</complexType>
This element specifies the presence of the base text within a phonetic guide at the current location in the document.
The contents of the base text run are specified in the child r element (§2.3.2.23).
[Example: Consider the following two runs, each containing a phonetic guide:
(missing graphic misc-2.3.3.26-1)
The base text run would be specified using the following WordprocessingML:
<w:rubyBase>
...
<w:r>
<w:t>東</w:t>
</w:r>
</w:rubyBase>
The base text is contained in a run within the rubyBase element. end example]
|
Parent Elements |
|
ruby (§2.3.3.24) |
|
Child Elements |
Subclause |
|---|---|
|
bookmarkEnd (Bookmark End) |
|
|
bookmarkStart (Bookmark Start) |
|
|
commentRangeEnd (Comment Anchor Range End) |
|
|
commentRangeStart (Comment Anchor Range Start) |
|
|
customXmlDelRangeEnd (Custom XML Markup Deletion End) |
|
|
customXmlDelRangeStart (Custom XML Markup Deletion Start) |
|
|
customXmlInsRangeEnd (Custom XML Markup Insertion End) |
|
|
customXmlInsRangeStart (Custom XML Markup Insertion Start) |
|
|
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End) |
|
|
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start) |
|
|
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End) |
|
|
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start) |
|
|
del (Deleted Run Content) |
|
|
ins (Inserted Run Content) |
|
|
moveFrom (Move Source Run Content) |
|
|
moveFromRangeEnd (Move Source Location Container - End) |
|
|
moveFromRangeStart (Move Source Location Container - Start) |
|
|
moveTo (Move Destination Run Content) |
|
|
moveToRangeEnd (Move Destination Location Container - End) |
|
|
moveToRangeStart (Move Destination Location Container - Start) |
|
|
oMath (Office Math) |
|
|
oMathPara (Math Paragraph) |
|
|
permEnd (Range Permission End) |
|
|
permStart (Range Permission Start) |
|
|
proofErr (Proofing Error Anchor) |
|
|
r (Text Run) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_RubyContent">
<group ref="EG_RubyContent" minOccurs="0" maxOccurs="unbounded"/>
</complexType>
This element specifies a set of properties which determine the behavior and appearance of a phonetic guide within the document.
[Example: Consider the following two runs, each containing a phonetic guide:
(missing graphic misc-2.3.3.27-1)
The properties for both of these phonetic guides are as follows:
<w:r>
<w:ruby>
<w:rubyPr>
<w:rubyAlign w:val="distributeSpace" />
<w:hps w:val="16" />
<w:hpsRaise w:val="20" />
<w:hpsBaseText w:val="22" />
<w:lid w:val="ja-JP" />
</w:rubyPr>
...
</w:ruby>
</w:r>
The phonetic guide properties specify that the guide text shall be:
As well, the phonetic guide properties specify that the base text shall be:
end example]
|
Parent Elements |
|
ruby (§2.3.3.24) |
|
Child Elements |
Subclause |
|---|---|
|
dirty (Invalidated Field Cache) |
|
|
hps (Phonetic Guide Text Font Size) |
|
|
hpsBaseText (Phonetic Guide Base Text Font Size) |
|
|
hpsRaise (Distance Between Phonetic Guide Text and Phonetic Guide Base Text) |
|
|
lid (Language ID for Phonetic Guide) |
|
|
rubyAlign (Phonetic Guide Text Alignment) |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_RubyPr">
<sequence>
<element name="rubyAlign" type="CT_RubyAlign"/>
<element name="hps" type="CT_HpsMeasure"/>
<element name="hpsRaise" type="CT_HpsMeasure"/>
<element name="hpsBaseText" type="CT_HpsMeasure"/>
<element name="lid" type="CT_Lang"/>
<element name="dirty" type="CT_OnOff" minOccurs="0"/>
</sequence>
</complexType>
This element specifies that an optional hyphen character shall be placed at the current location in the run content. An optional hyphen is a character which may be used as a valid line breaking character for the current line of text when displaying this WordprocessingML content, using the following logic:
[Note: This character is typically used to mark locations where a word may optionally be hyphenated without causing the hyphen character to be displayed unnecessarily. end note]
[Example: Consider the following sentence in a WordprocessingML document:
This sentence needs to be long enough to cause some kind of line breaking.
Normally, just as shown above, this sentence not would be displayed on a single line as it is long enough to require line breaking (given the width of the current page). However, if an optional hyphen were inserted after the letter r in breaking, as follows:
<w:r>
<w:t>This sentence needs to be long enough to cause some kind of line br</w:t>
<w:softHyphen/>
<w:t>eaking.</w:t>
</w:r>
This would allow a break at that position, and when that location is the point of the line break, would insert a hyphen-minus in the word after that character:
This sentence needs to be long enough to cause some kind of line breaking.
If this was not the point of the line break, then no character would be displayed at that location:
This sentence should not be long enough to cause line breaking.
The sentence now does not break at that location, so no hyphen appears in the word breaking. end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a symbol character at the current location in the run's content. A symbol character is a special character within a run's content which does not use any of the run fonts specified in the rFonts element (§2.3.2.24) (or by the style hierarchy).
Instead, this character shall be determined by pulling the character with the hexadecimal value specified in the char attribute from the font specified in the font attribute.
[Example: Consider a run containing the following run content:
This is a symbol character:(missing symbol)
The last character in that run is a symbol character from the Wingdings font, and the run is specified as follows:
<w:r>
<w:rPr>
<w:rFonts w:ascii="Courier New" w:hAnsi="Courier New" />
</w:rPr>
<w:t>This is a symbol character:</w:t>
<w:sym w:font="Wingdings" w:code="F03A" />
</w:r>
The resulting symbol is the specified using the sym element, and consists of character code 003A formatted as Wingdings, even though the run properties specify the Courier New font. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
char (Symbol Character Code) |
Specifies the hexadecimal code for the Unicode character value of the symbol. When this value is stored in the char attribute, it may be stored in either of the following two formats: Directly in its Unicode character value from the font glyph In a Unicode character value created by adding F000 to the actual character value, shifting the character value of this character into the Unicode private use area. [Note: The use of the latter syntax allows for interoperability with legacy word processing formats, as they used this technique to store the fact that a particular character or set of characters came from a font which was not Unicode compliant, and therefore any font matching performed on this range (if the specified font was not present) would be undesirable, as the resulting glyphs and their appearance could not be predicted. end note] [Example: Consider a run with a single symbol character defined as follows:
The symbol character shall use the font defined in its The possible values for this attribute are defined by the ST_ShortHexNumber simple type (§2.18.86). |
|
font (Symbol Character Font) |
Specifies a font which shall be used to format this symbol character. [Example: Consider a run with a single symbol character defined as follows:
Although the run specifies that its contents shall use the Arial Black 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_Sym">
<attribute name="font" type="ST_String"/>
<attribute name="char" type="ST_ShortHexNumber"/>
</complexType>
This element specifies that this run contains literal text which shall be displayed in the document. The t element shall be used for all text runs which is not:
[Example: Consider a paragraph of WordprocessingML content which reads This is text. This paragraph would therefore be represented as follows:
<w:p>
<w:r>
<w:t>This is text</w:t>
</w:r>
</w:p>
The text is contained in a t node. end example]
|
Parent Elements |
|
Attributes |
Description |
|---|---|
|
space (Content Contains Significant Whitespace) Namespace: http://www.w3.org/XML/1998/namespace |
Specifies how white space should be handled for the contents of this element using the W3C space preservation rules. [Example: Consider the following run contained within a WordprocessingML document:
Although there are three spaces on each side of the text content in the run, that whitespace has not been specifically marked as significant, therefore it is removed when this run is added to the document. end example] The possible values for this attribute are defined by the type in the namespace. |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Text">
<simpleContent>
<extension base="ST_String">
<attribute ref="xml:space" use="optional"/>
</extension>
</simpleContent>
</complexType>
This element specifies that a tab character shall be placed at the current location in the run content. An tab is a character which is used to advance the position on the current line of text when displaying this WordprocessingML content, using the following logic:
[Example: Consider a paragraph which contains two custom tab stops at 1.5" and 3.5", respectively. These two tab stops would be contained within a tabs element defining the set of tab stops of the paragraph as follows:
<w:pPr>
<w:tabs>
<w:tab w:val="left" w:pos="2160" />
<w:tab w:val="left" w:pos="5040" />
</w:tabs>
</w:pPr>
If a tab character was added to a run in this paragraph and appeared 1.4" along the line after all preceding content was laid out, then this tab would move the position to 1.5". If the tab character appeared 1.6" along the line after all preceding content was laid out, then this tab would move the position to 3.5". In both cases, the tab advanced to the next custom tab stop. end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs). [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The long year format date block shall use a date picture of YYYY, retrieving the long year format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a long date: </w:t>
<w:yearLong />
</w:r>
This run specifies that a long year format date block shall be placed after the text string literal This is a long date: in the document. Assuming that the host application's primary editing language is English (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a long date: 2006
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>
This element specifies the presence of a date block at the current location in the run content. A date block is a non-editable region of text which shall display the current date filtered through the specified date picture (see following paragraphs). [Note: The date block is a legacy construct used for compatibility with older word processors, and should not be produced unless it was consumed while reading a document -- it is recommended that the DATE field is used in its place. end note]
A date block shall be displayed using the primary editing language of the host application, regardless of the languages specified in the parent run's lang property (§2.3.2.18).
The short year format date block shall use a date picture of YY, retrieving the short year format for the primary editing language.
[Example: Consider a WordprocessingML run with the following run content:
<w:r>
<w:t xml:space="preserve">This is a short date: </w:t>
<w:yearShort />
</w:r>
This run specifies that a short year format date block shall be placed after the text string literal This is a short date: in the document. Assuming that the host application's primary editing language is French (Canada) and today's date is 04/12/2006 (a Wednesday), this run would be displayed as follows:
This is a short date: 06
end example]
|
Parent Elements |
The following XML Schema fragment defines the contents of this element:
<complexType name="CT_Empty"/>