Open Document Format for Office
Applications (OpenDocument) v1.1
OASIS Standard, 1 Feb 2007
Specification URIs:
This Version:
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.odt
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.pdf
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.html.zip
Previous Version:
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt
http://www.oasis-open.org/committees/download.php/19274/OpenDocument-v1.0ed2-cs1.pdf

Latest Version:
http://docs.oasis-open.org/office/v1.1/OpenDocument-v1.1.odt
http://docs.oasis-open.org/office/v1.1/OpenDocument-v1.1.pdf
http://docs.oasis-open.org/office/v1.1/OpenDocument-v1.1.html.zip
Latest Approved Version:
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.odt
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.pdf
http://docs.oasis-open.org/office/v1.1/OS/OpenDocument-v1.1.html.zip
Technical Committee:
OASIS Open Document Format for Office Applications (OpenDocument) TC
Chair:
Michael Brauer, Sun Microsystems, Inc.
Editors:
Patrick Durusau, IndividualMichael Brauer, Sun Microsystems, Inc.
Lars Oppermann, Sun Microsystems, Inc.
Related Work:
This specification supersedes OASIS OpenDocument v1.0.
Declared XML Namespaces:
A list of XML namespaces declared by this specification is available in section 1.3.
Abstract:
This is the specification of the Open Document Format for Office Applications(OpenDocument) format, an open, XML-based file format for office applications, based on
OpenOffice.org XML [OOo].

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 1 of 738

Status:This document was last revised or approved by the membership of OASIS on the above
date. The level of approval is also listed above. Check the current location noted above
for possible later revisions of this document. This document is updated periodically on no
particular schedule.
Technical Committee members should send comments on this specification to theTechnical Committee's email list. Others should send comments to the TechnicalCommittee by using the "Send A Comment" button on the Technical Committee's web
page atwww.oasis-open.org/committees/office.
For information on whether any patents have been disclosed that may be essential to
implementing this specification, and any offers of patent licensing terms, please refer tothe Intellectual Property Rights section of the Technical Committee web page(www.oasis-open.org/committees/office/ipr.php.
The non-normative errata page for this specification is located at www.oasisopen.org/committees/office.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 2 of 738

Notices
Copyright © OASIS® 2002–2007. All Rights Reserved. OASIS trademark, IPR and other policies
apply.
All capitalized terms in the following text have the meanings assigned to them in the OASISIntellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the
OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works
that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
published, and distributed, in whole or in part, without restriction of any kind, provided that theabove copyright notice and this section are included on all such copies and derivative works.
However, this document itself may not be modified in any way, including by removing the
copyright notice or references to OASIS, except as needed for the purpose of developing any
document or deliverable produced by an OASIS Technical Committee (in which case the rules
applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required totranslate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its
successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASISDISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims thatwould necessarily be infringed by implementations of this OASIS Committee Specification or
OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness togrant patent licenses to such patent claims in a manner consistent with the IPR Mode of the
OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim ofownership of any patent claims that would necessarily be infringed by implementations of thisspecification by a patent holder that is not willing to provide a license to such patent claims in amanner consistent with the IPR Mode of the OASIS Technical Committee that produced thisspecification. OASIS may include such claims on its website, but disclaims any obligation to doso.
OASIS takes no position regarding the validity or scope of any intellectual property or other rightsthat might be claimed to pertain to the implementation or use of the technology described in thisdocument or the extent to which any license under such rights might or might not be available;neither does it represent that it has made any effort to identify any such rights. Information on
OASIS' procedures with respect to rights in any document or deliverable produced by an OASISTechnical Committee can be found on the OASIS website. Copies of claims of rights madeavailable for publication and any assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of such proprietary rights byimplementers or users of this OASIS Committee Specification or OASIS Standard, can beobtained from the OASIS TC Administrator. OASIS makes no representation that any information
or list of intellectual property rights will at any time be complete, or that any claims in such list are,in fact, Essential Claims.
The names "OASIS", “OpenDocument”, “Open Document Format” and “ODF” are trademarks of
OASIS, the owner and developer of this specification, and should be used only to refer to theorganization and its official outputs. OASIS welcomes reference to, and implementation and use
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 3 of 738

of, specifications, while reserving the right to enforce its marks against misleading uses. Pleasesee http://www.oasis-open.org/who/trademark.php for above guidance.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 4 of 738

Table of Contents
1 Introduction........................................................................................................ ........................33
1.1 Introduction........................................................................................................ .................33
1.2 Notation................................................................................................... ...........................33
1.3 Namespaces............................................................................................................... ........33
1.4 Relax-NG Schema................................................................................................... ...........35
1.5 Document Processing and Conformance.................................................. .........................36
1.6 White-Space Processing and EOL Handling..................................................................... ..37
1.7 MIME Types and File Name Extensions........................................................ .....................37
2 Document Structure............................................................................................... ....................39
2.1 Document Roots................................................................................................. ................392.1.1 Document Root Element Content Models............................................................. .......40
2.1.2 Document Root Attributes........................................................................................ ....41
2.2 Document Metadata......................................................................................................... ...422.2.1 Pre-Defined vs. Custom Metadata....................................................................... ........422.2.2 Sample Metadata........................................................................................................ .43
2.3 Body Element and Document Types.......................................................................... .........432.3.1 Text Documents.................................................................................. ........................44
2.3.2 Drawing Documents............................................................................ ........................46
2.3.3 Presentation Documents.................................................................... .........................47
2.3.4 Spreadsheet Documents.......................................................................... ...................48
2.3.5 Chart Documents..................................................................................................... ....49
2.3.6 Image Documents.............................................................................. .........................49
2.4 Application Settings............................................................................................................ .50
2.4.1 Sequence of Settings............................................................................................... ....50
2.4.2 Base Settings............................................................................................................... 51
2.4.3 Index Access of Sequences.............................................................. ..........................52
2.4.4 Map Entry............................................................................................. .......................52
2.4.5 Name Access of Sequences...................................................................................... ..53
2.4.6 Cursor Position Setting............................................................................... .................53
2.5 Scripts.......................................................................................................................... .......54
2.5.1 Script.................................................................................................... .......................54
2.6 Font Face Declarations............................................................................................ ...........55
2.7 Styles................................................................................................................. .................55
2.7.1 Location of Styles ............................................................................ ...........................56

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 5 of 738

2.8 Page Styles and Layout............................................................................. .........................58
3 Metadata Elements.............................................................................................. ......................59
3.1 Pre-Defined Metadata Elements.......................................................................... ...............59
3.1.1 Generator........................................................................................... .........................59
3.1.2 Title......................................................................................................................... .....59
3.1.3 Description................................................................................................................ ...59
3.1.4 Subject........................................................................................................................ .60
3.1.5 Keywords......................................................................................................... ............60
3.1.6 Initial Creator ....................................................................................... .......................60
3.1.7 Creator........................................................................................................................ .60
3.1.8 Printed By................................................................................................. ...................60
3.1.9 Creation Date and Time............................................................................................ ...61
3.1.10 Modification Date and Time...................................................................... .................61
3.1.11 Print Date and Time............................................................................................ .......61
3.1.12 Document Template............................................................................. .....................61
3.1.13 Automatic Reload.............................................................................. ........................62
3.1.14 Hyperlink Behavior.............................................................................................. .......63
3.1.15 Language.............................................................................................................. .....64
3.1.16 Editing Cycles............................................................................................ ................64
3.1.17 Editing Duration.................................................................................... .....................65
3.1.18 Document Statistics....................................................................................... ............65
3.2 User-defined Metadata............................................................................ ...........................67
3.3 Custom Metadata............................................................................................................... .68
4 Text Content.............................................................................................................................. .69
4.1 Headings, Paragraphs and Basic Text Structure......................................... .......................69
4.1.1 Headings............................................................................................ .........................69
4.1.2 Paragraphs................................................................................................... ...............70
4.1.3 Common Paragraph Elements Attributes.......................................... ..........................70
4.2 Page Sequences.............................................................................................................. ...71
4.2.1 Page.......................................................................................................... ..................72
4.3 Lists............................................................................................................. .......................73
4.3.1 List Block................................................................................................... ..................73
4.3.2 List Item............................................................................................................ ...........74
4.3.3 List Header............................................................................................. .....................76
4.3.4 Numbered Paragraphs........................................................................ ........................76
4.4 Text Sections....................................................................................................... ...............77
4.4.1 Section Attributes...................................................................................................... ...78

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 6 of 738

4.4.2 Section Source..................................................................................... .......................79
4.4.3 DDE Source............................................................................................................. ....80
4.5 Page-bound graphical content...................................................................... ......................81
4.6 Change Tracking..................................................................................... ...........................81
4.6.1 Tracked Changes.................................................................................... ....................81
4.6.2 Changed Regions.......................................................................................... ..............81
4.6.3 Insertion............................................................................................................... ........82
4.6.4 Deletion............................................................................................. ..........................82
4.6.5 Format Change........................................................................................................ ....84
4.6.6 Change Info.................................................................................................. ...............84
4.6.7 Change Marks......................................................................................... ....................85
4.7 Soft Page Break............................................................................................................ ......85
4.8 Text Declarations.................................................................................................... ............85
5 Paragraph Elements Content..................................................................................... ................87
5.1 Basic Text Content............................................................................................................ ..87
5.1.1 White-space Characters................................................................................ ..............87
5.1.2 Soft Hyphens, Hyphens, and Non-breaking Blanks............................... ......................89
5.1.3 Attributed Text........................................................................................ .....................90
5.1.4 Hyperlinks.......................................................................................................... ..........90
5.2 Bookmarks and References................................................................................................ 93
5.2.1 Bookmarks......................................................................................... .........................93
5.2.2 References................................................................................................ ..................93
5.3 Notes.......................................................................................................... ........................95
5.3.1 Note Element..................................................................................................... ..........95
5.4 Ruby........................................................................................................ ...........................97
5.5 Text Annotation............................................................................................................ .......97
5.6 Index Marks..................................................................................................... ...................98
5.7 Change Tracking and Change Marks........................................................ .........................98
5.8 Inline graphics and text-boxes.................................................................. ..........................98
6 Text Fields..................................................................................................... ............................99
6.1 Common Characteristics of Field Elements......................................................... ...............99
6.2 Document Fields................................................................................................... ............100
6.2.1 Date Fields.................................................................................... ............................100
6.2.2 Time Fields................................................................................................... .............101
6.2.3 Page Number Fields.................................................................................... ..............103
6.2.4 Page Continuation Text...................................................................... .......................104
6.2.5 Sender Fields............................................................................................................ .105

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 7 of 738

6.2.6 Author Fields............................................................................................................. .108
6.2.7 Chapter Fields................................................................................... ........................1086.2.8 File Name Fields................................................................................................. .......109
6.2.9 Document Template Name Fields........................................................ .....................110
6.2.10 Sheet Name Fields.............................................................................. ....................111
6.3 Variable Fields............................................................................................. .....................111
6.3.1 Declaring Simple Variables................................................................................ ........112
6.3.2 Setting Simple Variables.................................................................................... ........112
6.3.3 Displaying Simple Variables..................................................................................... ..113
6.3.4 Simple Variable Input Fields................................................................. .....................114
6.3.5 Declaring User Variables......................................................................... ..................115
6.3.6 Displaying User Variables............................................................................... ...........115
6.3.7 User Variable Input Fields....................................................................................... ...116
6.3.8 Declaring Sequence Variables............................................................................. ......117
6.3.9 Using Sequence Fields.................................................................................. ............118
6.3.10 Expression Fields........................................................................... .........................1196.3.11 Text Input Fields.................................................................................... ..................120
6.4 Metadata Fields...................................................................................... ..........................120
6.4.1 Initial Creator..................................................................................... ........................121
6.4.2 Document Creation Date..................................................................... ......................121
6.4.3 Document Creation Time.................................................................................... .......121
6.4.4 Document Description...................................................................... .........................121
6.4.5 User-Defined Document Information.................................................. .......................122
6.4.6 Print Time................................................................................................ ..................122
6.4.7 Print Date.............................................................................................................. .....123
6.4.8 Printed By.............................................................................................. ....................123
6.4.9 Document Title................................................................................ ..........................123
6.4.10 Document Subject............................................................................ .......................123
6.4.11 Document Keywords.......................................................................................... ......124
6.4.12 Document Revision Number......................................................................... ...........124
6.4.13 Document Edit Duration..................................................................................... ......124
6.4.14 Document Modification Time.............................................................. .....................124
6.4.15 Document Modification Date............................................................................ ........125
6.4.16 Document Modified By..................................................................................... ........125
6.4.17 Document Statistics Fields....................................................................................... 125
6.5 Database Fields.................................................................................................. ..............126
6.5.1 Database Field Data Source............................................................................. .........127

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 8 of 738

6.5.2 Displaying Database Content................................................................................... ..128
6.5.3 Selecting the Next Database Row.................................................... .........................128
6.5.4 Selecting a Row Number......................................................................... ..................129
6.5.5 Displaying the Row Number....................................................................................... 130
6.5.6 Display Current Database and Table......................................................... ................131
6.6 More Fields..................................................................................................... ..................131
6.6.1 Page Variable Fields........................................................................................... .......131
6.6.2 Placeholders.................................................................................................. ............132
6.6.3 Conditional Text Fields....................................................................... .......................133
6.6.4 Hidden Text Field..................................................................................................... ..135
6.6.5 Reference Fields....................................................................................................... .136
6.6.6 Script Fields.................................................................................................... ...........138
6.6.7 Macro Fields.............................................................................................. ................139
6.6.8 Hidden Paragraph Fields........................................................................ ...................140
6.6.9 DDE Connection Fields............................................................................................. .141
6.6.10 Measure Fields..................................................................................... ...................141
6.6.11 Table Formula Field......................................................................................... ........142
6.7 Common Field Attributes....................................................................... ...........................142
6.7.1 Variable Value Types and Values.............................................................. ................142
6.7.2 Fixed................................................................................................................... .......144
6.7.3 Variable Name............................................................................................... ............145
6.7.4 Description ........................................................................................................... .....145
6.7.5 Display........................................................................................................... ............145
6.7.6 Formula.............................................................................................. .......................146
6.7.7 Formatting Style..................................................................................................... ....147
6.7.8 Number Formatting Style............................................................................... ............147
7 Text Indices........................................................................................................................ ......149
7.1 Index Marks.................................................................................................. ....................149
7.1.1 Table of Content Index Marks............................................................................... .....149
7.1.2 User-Defined Index Marks........................................................................... ..............150
7.1.3 Alphabetical Index Mark............................................................................................. 151
7.1.4 Bibliography Index Mark.................................................................. ..........................153
7.2 Index Structure................................................................................................................ ..154
7.2.1 Index Source................................................................................. ............................154
7.2.2 Index Body Section....................................................................................... .............155
7.2.3 Index Title Section................................................................................. ....................155
7.3 Table Of Content............................................................................................................. ..155

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 9 of 738

7.3.1 Table of Content Source.................................................................................. ..........156
7.3.2 Table of Content Entry Template............................................................... ................158
7.4 Index of Illustrations.......................................................................................... ................159
7.4.1 Index of Illustration Source................................................................ ........................160
7.4.2 Illustration Index Entry Template............................................................................... .161
7.5 Index of Tables........................................................................................... ......................162
7.5.1 Table Index Source.................................................................................................. ..162
7.5.2 Table Index Entry Template............................................................................... ........163
7.6 Index of Objects..................................................................................................... ...........163
7.6.1 Object Index Source............................................................................... ...................163
7.6.2 Object Index Entry Template............................................................. ........................165
7.7 User-Defined Index............................................................................................. ..............165
7.7.1 User-Defined Index Source........................................................... ............................165
7.7.2 User-Defined Index Entry Template...................................................................... .....167
7.8 Alphabetical Index....................................................................................................... ......168
7.8.1 Alphabetical Index Source..................................................................... ....................168
7.8.2 Auto Mark File............................................................................................................ 172
7.8.3 Alphabetical Index Entry Template................................................... .........................172
7.9 Bibliography............................................................................................... .......................173
7.9.1 Bibliography Index Source....................................................................... ..................173
7.9.2 Bibliography Entry Template........................................................................ ..............174
7.10 index source styles......................................................................................................... .174
7.10.1 Index source style......................................................................................... ...........175
7.11 Index title template............................................................................................... ...........175
7.12 Index Template Entries................................................................................... ................175
7.12.1 Chapter Information.................................................................................... .............176
7.12.2 Entry Text......................................................................................... .......................176
7.12.3 Page Number.............................................................................. ............................176
7.12.4 Fixed String............................................................................................................. .177
7.12.5 Bibliography Information..................................................................... .....................177
7.12.6 Tab Stop................................................................................................... ...............178
7.12.7 Hyperlink Start and End........................................................................... ................179
7.12.8 Example of an Index Entry Configuration........................................................... ......180
8 Tables................................................................................................................. .....................182
8.1 Basic Table Model................................................................................. ...........................182
8.1.1 Table Element................................................................................ ...........................182
8.1.2 Table Row .................................................................................... ............................186

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 10 of 738

8.1.3 Table Cell ...................................................................................... ...........................188
8.2 Advanced Table Model............................................................................ .........................193
8.2.1 Column Description ......................................................................... .........................193
8.2.2 Header Columns.................................................................................................. ......195
8.2.3 Column Groups.............................................................................. ...........................1958.2.4 Header Rows................................................................................................. ............196
8.2.5 Row Groups.......................................................................................................... .....196
8.2.6 Subtables ............................................................................................................. .....197
8.3 Advanced Tables.......................................................................................... ....................200
8.3.1 Referencing Table Cells................................................................. ...........................200
8.3.2 Linked Tables....................................................................................... .....................2028.3.3 Scenario Tables................................................................................................... ......2048.3.4 Shapes............................................................................................. .........................206
8.4 Advanced Table Cells .................................................................................... ..................207
8.4.1 Linked Table Cells.................................................................................. ...................207
8.4.2 Cell Annotation .............................................................................. ...........................208
8.4.3 Detective................................................................................................................ ....208
8.4.4 Detective Operation................................................................................... ................208
8.4.5 Highlighted Range............................................................................... ......................209
8.5 Spreadsheet Document Content............................................................................. ..........211
8.5.1 Document Protection.............................................................................. ...................211
8.5.2 Calculation Settings.................................................................................. .................211
8.5.3 Table Cell Content Validations............................................................................ .......214
8.5.4 Label Ranges............................................................................................................ .218
8.5.5 Named Expressions................................................................................................... 219
8.6 Database Ranges......................................................................................... ....................2218.6.1 Database Range ............................................................................................... ........222
8.6.2 Database Source SQL ................................................................................... ...........225
8.6.3 Database Source Table ............................................................................ ................225
8.6.4 Database Source Query................................................................... .........................226
8.6.5 Sort ............................................................................................................... ............227
8.6.6 Sort By .......................................................................................................... ............228
8.6.7 Subtotal Rules ................................................................................. .........................229
8.6.8 Subtotal Sort Groups .......................................................................... ......................230
8.6.9 Subtotal Rule ........................................................................................ ....................231
8.6.10 Subtotal Field ................................................................................................ ..........232
8.7 Filters.................................................................................................................. ..............233

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 11 of 738

8.7.1 Table Filter............................................................................................................. ....233
8.7.2 Filter And............................................................................................. ......................234
8.7.3 Filter Or .................................................................................................................. ...235
8.7.4 Filter Condition ...................................................................................................... ....235
8.8 Data Pilot Tables........................................................................................................... ....237
8.8.1 Data Pilot Table..................................................................................... ....................237
8.8.2 Source Cell Range................................................................................................. ....242
8.8.3 Source Service.................................................................................. ........................2438.8.4 Data Pilot Field................................................................................ ..........................244
8.8.5 Data Pilot Level..................................................................................................... .....246
8.8.6 Data Pilot Subtotals............................................................................ .......................247
8.8.7 Data Pilot Subtotal................................................................................... ..................247
8.8.8 Data Pilot Members............................................................................... ....................248
8.8.9 Data Pilot Member....................................................................................... ..............248
8.8.10 Data Pilot Display Info......................................................................................... .....249
8.8.11 Data Pilot Sort Info.............................................................................................. .....250
8.8.12 Data Pilot Layout Info........................................................................................... ....2518.8.13 Data Pilot Field Reference........................................................................ ...............252
8.8.14 Data Pilot Groups.......................................................................... ..........................254
8.8.15 Data Pilot Group................................................................................. .....................2568.8.16 Data Pilot Group Member...................................................................... ..................257
8.9 Consolidation................................................................................................ ....................257
8.10 DDE Links............................................................................................................. ..........259
8.11 Change Tracking in Spreadsheets....................................................................... ...........259
8.11.1 Tracked Changes.............................................................................. ......................259
8.11.2 Insertion......................................................................................................... ..........260
8.11.3 Dependencies................................................................................................... .......261
8.11.4 Dependence..................................................................................... .......................261
8.11.5 Deletions............................................................................................................. .....262
8.11.6 Cell Content Deletion................................................................................. ..............262
8.11.7 Change Deletion...................................................................................... ................262
8.11.8 Deletion....................................................................................... ............................263
8.11.9 Cut Offs............................................................................................ .......................264
8.11.10 Insertion Cut Off.................................................................................................... .265
8.11.11 Movement Cut Off................................................................................................. .265
8.11.12 Movement.................................................................................................... ..........266
8.11.13 Target Range Address, Source Range Address........................................ ............267

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 12 of 738

8.11.14 Change Track Cell.................................................................................... .............268
8.11.15 Cell Content Change............................................................................................ ..269
8.11.16 Cell Address.................................................................................. ........................270
8.11.17 Previous........................................................................................................... ......270
8.11.18 Common Change Tracking Attributes............................................................ ........270
9 Graphic Content....................................................................................................... ................272
9.1 Enhanced Page Features for Graphical Applications............................................ ............272
9.1.1 Handout Master....................................................................................... ..................272
9.1.2 Layer Sets................................................................................................................ ..273
9.1.3 Layer...................................................................................................................... ....274
9.1.4 Drawing Pages................................................................................. .........................275
9.1.5 Presentation Notes................................................................................ ....................278
9.2 Drawing Shapes........................................................................................................... .....279
9.2.1 Rectangle....................................................................................... ...........................279
9.2.2 Line..................................................................................................................... .......280
9.2.3 Polyline................................................................................................... ...................281
9.2.4 Polygon............................................................................................................... .......282
9.2.5 Regular Polygon................................................................................ ........................283
9.2.6 Path......................................................................................................... ..................285
9.2.7 Circle................................................................................................. ........................286
9.2.8 Ellipse......................................................................................................... ...............288
9.2.9 Connector................................................................................................... ...............289
9.2.10 Caption............................................................................................... .....................2939.2.11 Measure............................................................................................................... ....294
9.2.12 Control...................................................................................................... ...............295
9.2.13 Page Thumbnail...................................................................................................... .296
9.2.14 Grouping........................................................................................................ ..........297
9.2.15 Common Drawing Shape Attributes................................................................... ......298
9.2.16 Common Shape Attributes for Text and Spreadsheet Documents..........................302
9.2.17 Common Drawing Shape Content..................................................... ......................305
9.2.18 Common Shape Attribute Groups.................................................................... ........305
9.2.19 Glue Points............................................................................................ ..................305
9.2.20 Title and Description................................................................................ ................307
9.2.21 Event Listeners.......................................................................................... ..............308
9.3 Frames.............................................................................................................................. 308
9.3.1 Text Box............................................................................................ ........................311
9.3.2 Image............................................................................................ ............................313

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 13 of 738

9.3.3 Objects............................................................................................... .......................314
9.3.4 Applet.............................................................................................. ..........................316
9.3.5 Plugins.............................................................................................................. .........318
9.3.6 Parameters................................................................................................... .............319
9.3.7 Floating Frame.............................................................................. ............................319
9.3.8 Contour.............................................................................................................. ........320
9.3.9 Hyperlinks....................................................................................................... ...........321
9.3.10 Client Side Image Maps.................................................................................... .......323
9.4 3D Shapes....................................................................................................... .................327
9.4.1 Scene................................................................................................ ........................327
9.4.2 Light................................................................................................................... ........331
9.4.3 Cube............................................................................................................. .............332
9.4.4 Sphere......................................................................................................... ..............333
9.4.5 Extrude................................................................................................... ...................334
9.4.6 Rotate.......................................................................................................... ..............334
9.5 Custom Shape................................................................................................. .................335
9.5.1 Enhanced Geometry........................................................................................ ..........336
9.5.2 Enhanced Geometry - Extrusion Attributes..................................................... ...........339
9.5.3 Enhanced Geometry - Path Attributes............................................. ..........................345
9.5.4 Enhanced Geometry - Text Path Attributes.................................... ...........................349
9.5.5 Enhanced Geometry – Equation................................................................... .............350
9.5.6 Enhanced Geometry - Handle Attributes....................................... ............................352
9.6 Presentation Shapes................................................................................................... ......356
9.6.1 Common Presentation Shape Attributes............................................................. .......356
9.7 Presentation Animations................................................................................. ..................358
9.7.1 Sound.................................................................................................... ....................359
9.7.2 Show Shape..................................................................................... .........................360
9.7.3 Show Text.............................................................................................................. ....363
9.7.4 Hide Shape.................................................................................................... ............364
9.7.5 Hide Text................................................................................................ ...................364
9.7.6 Dim............................................................................................................ ................364
9.7.7 Play....................................................................................................................... .....365
9.7.8 Effect groups.................................................................................... .........................365
9.8 SMIL Presentation Animations............................................................................... ...........365
9.8.1 Recommended Usage Of SMIL....................................................................... ..........366
9.8.2 Document Dependent SMIL Animation Attribute Values..................................... .......367
9.8.3 SMIL Presentation Animation Attributes......................................... ...........................369

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 14 of 738

9.9 Presentation Events.............................................................................................. ............372
9.10 Presentation Text Fields......................................................................... ........................375
9.10.1 Header Field.......................................................................................... ..................375
9.10.2 Footer Field............................................................................................................. .375
9.10.3 Date and Time Field...................................................................... ..........................375
9.11 Presentation Document Content.................................................................... .................376
9.11.1 Presentation Declarations................................................................................ ........376
9.11.2 Header field declaration.............................................................................. .............376
9.11.3 Footer field declaration.................................................................... ........................376
9.11.4 Date and Time field declaration........................................................... ....................377
9.11.5 Presentation Settings........................................................................................ .......377
9.11.6 Show Definitions...................................................................................... ................381
10 Chart Content.............................................................................................................. ...........383
10.1 Introduction to Chart Documents......................................................... ...........................383
10.2 Chart................................................................................................................. ..............383
10.3 Title, Subtitle and Footer................................................................................. ................387
10.3.1 Title................................................................................................................... .......387
10.3.2 Subtitle................................................................................................................ .....388
10.3.3 Footer................................................................................................... ...................388
10.4 Legend................................................................................................................. ...........388
10.5 Plot Area....................................................................................................... ..................390
10.5.1 3D Plot Area.................................................................................... ........................392
10.6 Wall............................................................................................................................. ....392
10.7 Floor............................................................................................................................. ...393
10.8 Axis................................................................................................................... ..............394
10.8.1 Grid................................................................................................................... .......395
10.9 Series.......................................................................................................................... ....396
10.9.1 Domain................................................................................................. ...................398
10.10 Categories................................................................................................................... ..398
10.11 Data Point................................................................................................. ....................398
10.12 Mean Value......................................................................................................... ..........399
10.13 Error Indicator........................................................................................... ....................400
10.14 Regression Curves........................................................................... ............................400
10.14.1 Stock Chart Markers.................................................................................. ............401
11 Form Content...................................................................................................... ...................402
11.1 Form........................................................................................................ .......................403
11.1.1 Action.................................................................................................................... ...404

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 15 of 738

11.1.2 Target Frame................................................................................................... ........404
11.1.3 Method................................................................................................................. ....405
11.1.4 Encoding Type............................................................................................... ..........405
11.1.5 Allow Deletes............................................................................................ ...............405
11.1.6 Allow Inserts.................................................................................... ........................406
11.1.7 Allow Updates................................................................................................ ..........406
11.1.8 Apply Filter..................................................................................................... ..........406
11.1.9 Command Type...................................................................................... .................406
11.1.10 Command................................................................................................. .............407
11.1.11 Data Source.................................................................................................... .......407
11.1.12 Master Fields....................................................................................... ..................407
11.1.13 Detail Fields............................................................................................. ..............408
11.1.14 Escape Processing................................................................................. ...............408
11.1.15 Filter.................................................................................................................... ...408
11.1.16 Ignore Result................................................................................. ........................408
11.1.17 Navigation Mode........................................................................................ ............409
11.1.18 Order............................................................................................. ........................409
11.1.19 Tabbing Cycle.............................................................................................. ..........409
11.1.20 Connection Resource...................................................................... ......................410
11.2 XForms Model.................................................................................... ............................410
11.2.1 XForms Model.................................................................................... .....................411
11.3 Controls............................................................................................... ...........................411
11.3.1 Text............................................................................................. ............................412
11.3.2 Text Area................................................................................................... ..............412
11.3.3 Password....................................................................................................... ..........413
11.3.4 File................................................................................................................... ........414
11.3.5 Formatted Text.................................................................................... ....................414
11.3.6 Number............................................................................................................. .......416
11.3.7 Date And Time.................................................................................................... .....417
11.3.8 Fixed Text........................................................................................................ ........419
11.3.9 Combo Box..................................................................................................... .........419
11.3.10 List Box........................................................................................................ ..........421
11.3.11 Button............................................................................................... .....................422
11.3.12 Image................................................................................................................... ..424
11.3.13 Check Box......................................................................................... ....................424
11.3.14 Radio Button............................................................................................ ..............426
11.3.15 Frame.................................................................................................. ..................427

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 16 of 738

11.3.16 Image Frame..................................................................................... ....................427
11.3.17 Hidden............................................................................................. ......................427
11.3.18 Grid................................................................................................................ ........428
11.3.19 Value Range............................................................................................ ..............429
11.3.20 Generic Control................................................................................................... ...431
11.4 Common Form and Control Attributes.................................................. ..........................431
11.4.1 Name........................................................................................................... ............431
11.4.2 Control Implementation........................................................................................ ....432
11.4.3 Bind to XForms.............................................................................................. ..........432
11.5 Common Control Attributes....................................................................................... ......432
11.5.1 Button Type.................................................................................... .........................432
11.5.2 Control ID.................................................................................... ............................433
11.5.3 Current Selected............................................................................................. .........434
11.5.4 Value and Current Value...................................................................................... ....434
11.5.5 Disabled.............................................................................................................. .....435
11.5.6 Dropdown......................................................................................... .......................436
11.5.7 For.......................................................................................................... .................436
11.5.8 Image Data............................................................................................... ...............437
11.5.9 Label............................................................................................................... .........437
11.5.10 Maximum Length.................................................................................. .................437
11.5.11 Printable................................................................................................................ .438
11.5.12 Read only........................................................................................................... ....439
11.5.13 Selected........................................................................................................... ......439
11.5.14 Size................................................................................................................... .....439
11.5.15 Tab Index........................................................................................................... ....440
11.5.16 Tab Stop................................................................................................ ................441
11.5.17 Target Frame................................................................................................ .........441
11.5.18 Target Location.............................................................................................. ........442
11.5.19 Title................................................................................................................ ........442
11.5.20 Visual Effect..................................................................................................... ......443
11.5.21 Relative Image Position..................................................................... ....................443
11.5.22 Database Binding Attributes.................................................................................. .444
11.6 Event Listeners.......................................................................................... .....................446
11.7 Properties........................................................................................................................ 448
11.7.1 Property Set................................................................................................... ..........448
11.7.2 Property................................................................................................. ..................448
11.7.3 List Property......................................................................................................... ....449

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 17 of 738

12 Common Content..................................................................................................... ..............452
12.1 Annotation............................................................................................................... ........452
12.1.1 Creator.................................................................................................................. ...453
12.1.2 Creation Date and Time...................................................................................... .....453
12.1.3 Creation Date and Time String...................................................... ..........................453
12.2 Number Format........................................................................................................... ....453
12.2.1 Prefix and Suffix.......................................................................... ............................453
12.2.2 Format Specification.................................................................................. ..............454
12.2.3 Letter Synchronization in Number Formats....................................................... .......454
12.3 Change Tracking Metadata..................................................................................... ........455
12.4 Event Listener Tables............................................................................. ........................455
12.4.1 Event Listener.................................................................................................. ........456
12.4.2 Event Types..................................................................................................... ........457
12.5 Mathematical Content................................................................................... ..................458
12.6 DDE Connections................................................................................ ...........................459
12.6.1 Container for DDE Connection Declarations...................................................... ......459
12.6.2 Declaring DDE Connections for Text Fields......................................................... ....459
12.6.3 Declaring DDE Connections for Tables .......................................... ........................461
13 SMIL Animations................................................................................................... .................463
13.1 Basic Animation Elements...................................................................... ........................463
13.1.1 Animate.......................................................................................... .........................463
13.1.2 Set......................................................................................................... ..................463
13.1.3 Animate Motion................................................................................................ ........463
13.1.4 Animate Color.............................................................................................. ............464
13.1.5 Animate Transform.................................................................................... ..............465
13.1.6 Transition Filter........................................................................................... .............466
13.2 Animation Model Attributes....................................................................... ......................467
13.3 Common Animation Attributes................................................................ ........................467
13.3.1 Animation Target Attributes............................................................. ........................468
13.3.2 Animation Function Attributes.................................................................. ................468
13.4 Animation Timing.......................................................................................... ..................471
13.4.1 Animation Timing Attributes......................................................................... ............471
13.4.2 Parallel Animations.................................................................................. ................475
13.4.3 Sequential Animations........................................................................... ..................475
13.4.4 Iterative Animations........................................................................... ......................475
13.5 Media Elements.......................................................................................... ....................476
13.5.1 Audio............................................................................................. ..........................476

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 18 of 738

13.6 Special Elements....................................................................................... .....................477
13.6.1 Command.................................................................................................... ............477
14 Styles........................................................................................................... ..........................479
14.1 Style Element....................................................................................................... ...........479
14.1.1 Style Mappings................................................................................ ........................483
14.2 Default Styles....................................................................................................... ...........485
14.3 Page Layout........................................................................................................ ............485
14.3.1 Header and Footer Styles....................................................................... .................486
14.4 Master Pages.......................................................................................................... ........487
14.4.1 Headers and Footers................................................................................ ...............489
14.4.2 Presentation Notes............................................................................. .....................491
14.5 Table Templates............................................................................................ .................493
14.5.1 Row and Column Styles...................................................................................... .....494
14.6 Font Face Declaration.............................................................................................. .......496
14.6.1 CSS2/SVG Font Descriptors................................................................................. ...496
14.6.2 Name........................................................................................................... ............500
14.6.3 Adornments......................................................................................... ....................500
14.6.4 Font Family Generic.................................................................... ............................500
14.6.5 Font Pitch.................................................................................... ............................501
14.6.6 Font Character Set........................................................................ ..........................501
14.7 Data Styles................................................................................................................. .....501
14.7.1 Number Style............................................................................................. ..............501
14.7.2 Currency Style................................................................................. ........................505
14.7.3 Percentage Style.................................................................................................... ..507
14.7.4 Date Style............................................................................................ ....................508
14.7.5 Time Style.......................................................................................................... ......513
14.7.6 Boolean Style.................................................................................................... .......517
14.7.7 Text Style.......................................................................................................... .......517
14.7.8 Common Data Style Elements........................................................................ .........518
14.7.9 Common Data Style Attributes............................................................................ .....519
14.7.10 Transliteration........................................................................................... .............522
14.7.11 Common Data Style Child Element Attributes..................................................... ...523
14.8 Text Styles................................................................................................... ...................525
14.8.1 Text Styles................................................................................................... ............525
14.8.2 Paragraph Styles............................................................................. ........................525
14.8.3 Section Styles......................................................................................... .................526
14.8.4 Ruby Style............................................................................................................... .526

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 19 of 738

14.9 Enhanced Text Styles................................................................................. ....................526
14.9.1 Line Numbering Configuration............................................................ .....................526
14.9.2 Notes Configuration Element..................................................................... ..............530
14.9.3 Bibliography Configuration......................................................................... ..............533
14.10 List Style............................................................................................ ...........................535
14.10.1 Common List-Level Style Attributes........................................................ ...............536
14.10.2 Number Level Style............................................................................................. ...537
14.10.3 Bullet Level Style....................................................................... ............................538
14.10.4 Image Level Style......................................................................... .........................540
14.10.5 List Level Style Example............................................................................ ............541
14.11 Outline Style.......................................................................................................... ........541
14.11.1 Outline Level Style................................................................................ .................542
14.12 Table Styles............................................................................................ ......................543
14.12.1 Table Styles............................................................................................ ...............543
14.12.2 Table Column Styles....................................................................................... .......544
14.12.3 Table Row Styles..................................................................................... ..............544
14.12.4 Table Cell Styles....................................................................................... .............544
14.13 Graphic Styles......................................................................................................... ......545
14.13.1 Graphic and Presentation Styles....................................................................... .....545
14.13.2 Drawing Page Style................................................................................................ 545
14.14 Enhanced Graphic Style Elements.......................................................................... ......546
14.14.1 Gradient....................................................................................................... ..........546
14.14.2 SVG Gradients..................................................................................................... ..549
14.14.3 Hatch................................................................................................. ....................552
14.14.4 Fill Image............................................................................................... ................554
14.14.5 Opacity Gradient........................................................................................ ............555
14.14.6 Marker........................................................................................... ........................556
14.14.7 Stroke Dash................................................................................................. ..........557
14.15 Presentation Page Layouts....................................................................... ....................559
14.15.1 Presentation Placeholder............................................................................. ..........559
14.16 Chart Styles...................................................................................... ............................560
15 Formatting Properties...................................................................................................... .......561
15.1 Simple and Complex Formatting Properties................................................................. ...561
15.1.1 Simple Formatting Properties.......................................................... ........................561
15.1.2 Complex Formatting Properties............................................................. ..................562
15.1.3 Processing Rules for Formatting Properties.................................... ........................562
15.2 Page Layout Formatting Properties............................................................................ .....562

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 20 of 738

15.2.1 Page Size....................................................................................... .........................563
15.2.2 Page Number Format............................................................................ ..................563
15.2.3 Paper Tray................................................................................................... ............564
15.2.4 Print Orientation............................................................................................. ..........564
15.2.5 Margins........................................................................................................... .........564
15.2.6 Border.............................................................................................................. ........565
15.2.7 Border Line Width......................................................................................... ...........565
15.2.8 Padding....................................................................................... ............................565
15.2.9 Shadow.............................................................................................................. ......565
15.2.10 Background................................................................................ ...........................565
15.2.11 Columns....................................................................................... .........................566
15.2.12 Register-truth............................................................................................. ............566
15.2.13 Print................................................................................................... ....................566
15.2.14 Print Page Order.......................................................................................... ..........567
15.2.15 First Page Number............................................................................................... ..567
15.2.16 Scale.................................................................................................................. ....567
15.2.17 Table Centering................................................................................. ....................568
15.2.18 Maximum Footnote Height............................................................................... ......568
15.2.19 Writing Mode............................................................................... ..........................569
15.2.20 Footnote Separator..................................................................................... ...........569
15.2.21 Layout Grid....................................................................................... .....................570
15.2.22 Layout Grid Base Height............................................................................ ............570
15.2.23 Layout Grid Ruby Height.............................................................................. ..........571
15.2.24 Layout Grid Lines........................................................................................... ........571
15.2.25 Layout Grid Color........................................................................................... ........571
15.2.26 Layout Grid Ruby Below............................................................ ............................571
15.2.27 Layout Grid Print....................................................................................... .............572
15.2.28 Layout Grid Display.......................................................................................... ......572
15.3 Header Footer Formatting Properties............................................................................ ..572
15.3.1 Fixed and Minimum heights......................................................................... ............573
15.3.2 Margins........................................................................................................... .........573
15.3.3 Border.............................................................................................................. ........573
15.3.4 Border Line Width......................................................................................... ...........573
15.3.5 Padding....................................................................................... ............................574
15.3.6 Background................................................................................... ..........................574
15.3.7 Shadow.............................................................................................................. ......574
15.3.8 Dynamic Spacing........................................................................................... ..........574

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 21 of 738

15.4 Text Formatting Properties................................................................. ............................575
15.4.1 Font Variant........................................................................................... ..................575
15.4.2 Text Transformations............................................................................................ ...575
15.4.3 Color.......................................................................................................... ..............576
15.4.4 Window Font Color................................................................................ ..................576
15.4.5 Text Outline....................................................................................... ......................576
15.4.6 Line-Through Type....................................................................... ...........................576
15.4.7 Line-Through Style................................................................................................. ..577
15.4.8 Line-Through Width................................................................................. ................577
15.4.9 Line-Through Color......................................................................................... .........577
15.4.10 Line-Through Text......................................................................... ........................578
15.4.11 Line-Through Text Style...................................................................................... ...578
15.4.12 Text Position.............................................................................................. ............578
15.4.13 Font Name................................................................................................... ..........579
15.4.14 Font Family.............................................................................................. ..............579
15.4.15 Font Family Generic.............................................................................................. .580
15.4.16 Font Style........................................................................................................... ....581
15.4.17 Font Pitch............................................................................................................... 581
15.4.18 Font Character Set..................................................................... ...........................582
15.4.19 Font Size.............................................................................................................. ..582
15.4.20 Relative Font Size......................................................................................... .........583
15.4.21 Script Type........................................................................................................... ..584
15.4.22 Letter Spacing..................................................................................................... ...584
15.4.23 Language......................................................................................................... ......584
15.4.24 Country................................................................................................ ..................585
15.4.25 Font Style........................................................................................................... ....585
15.4.26 Font Relief...................................................................................... .......................586
15.4.27 Text Shadow................................................................................................... .......586
15.4.28 Underlining Type............................................................................................. .......587
15.4.29 Underlining Style.......................................................................................... ..........587
15.4.30 Underling Width..................................................................................... ................588
15.4.31 Underline Color............................................................................................ ..........588
15.4.32 Font Weight........................................................................................ ...................588
15.4.33 Text Underline Word Mode........................................................................... .........589
15.4.34 Text Line-Through Word Mode..................................................................... .........589
15.4.35 Letter Kerning.................................................................................... ....................590
15.4.36 Text Blinking......................................................................................... .................590

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 22 of 738

15.4.37 Text Background Color........................................................................... ...............590
15.4.38 Text Combine................................................................................... .....................590
15.4.39 Text Combine Start and End Characters............................................. ..................591
15.4.40 Text Emphasis............................................................................................. ..........591
15.4.41 Text Scale.......................................................................................................... ....592
15.4.42 Text Rotation Angle......................................................................... ......................592
15.4.43 Text Rotation Scale.................................................................... ...........................592
15.4.44 Hyphenation..................................................................................................... ......592
15.4.45 Hyphenation Remain Char Count..................................................... .....................593
15.4.46 Hyphenation Push Char Count................................................... ...........................593
15.4.47 Hidden or Conditional Text......................................................... ...........................593
15.5 Paragraph Formatting Properties......................................................................... ...........594
15.5.1 Fixed Line Height........................................................................................... ..........594
15.5.2 Minimum Line Height................................................................................ ...............595
15.5.3 Line Distance.............................................................................................. .............595
15.5.4 Font-Independent Line Spacing.................................................................. .............595
15.5.5 Text Align............................................................................................................. ....595
15.5.6 Text Align of Last Line....................................................................... ......................596
15.5.7 Justify Single Word..................................................................................... .............596
15.5.8 Keep Together............................................................................................. ............597
15.5.9 Widows.......................................................................................................... ..........597
15.5.10 Orphans........................................................................................................ .........597
15.5.11 Tab Stops......................................................................................... .....................597
15.5.12 Tab Stop Distance............................................................................. ....................601
15.5.13 Hyphenation Keep....................................................................... ..........................601
15.5.14 Maximum Hyphens................................................................................. ...............601
15.5.15 Drop Caps................................................................................. ............................602
15.5.16 Register True ............................................................................................ ............603
15.5.17 Left and Right Margins.................................................................................... .......603
15.5.18 Text Indent........................................................................................................ .....604
15.5.19 Automatic Text Indent................................................................................... .........604
15.5.20 Top and Bottom Margins........................................................... ............................605
15.5.21 Margins........................................................................................................ ..........605
15.5.22 Break Before and Break After.................................................................... ............605
15.5.23 Paragraph Background Color...................................................... ..........................606
15.5.24 Paragraph Background Image.................................................................. .............606
15.5.25 Border........................................................................................................... .........609

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 23 of 738

15.5.26 Border Line Width...................................................................................... ............609
15.5.27 Padding.................................................................................................................. 610
15.5.28 Shadow............................................................................................................ ......611
15.5.29 Keep with Next.................................................................................................. .....612
15.5.30 Line Numbering............................................................................ .........................612
15.5.31 Line Number Start Value...................................................................................... ..612
15.5.32 Text Autospace................................................................................................ ......612
15.5.33 Punctuation Wrap.................................................................................. ................613
15.5.34 Line Break................................................................................. ............................613
15.5.35 Vertical Alignment........................................................................................ ..........613
15.5.36 Writing Mode............................................................................... ..........................614
15.5.37 Automatic Writing Mode....................................................................................... ..614
15.5.38 Snap To Layout...................................................................................................... 615
15.5.39 Page Number......................................................................................................... 615
15.5.40 Background Transparency.............................................................................. .......615
15.6 Ruby Text Formatting Properties............................................................. .......................615
15.6.1 Ruby Position..................................................................................................... ......616
15.6.2 Ruby Alignment........................................................................... ............................616
15.7 Section Formatting Properties..................................................................................... ....616
15.7.1 Section Background............................................................................................. ....617
15.7.2 Margins........................................................................................................... .........617
15.7.3 Columns.......................................................................................... ........................617
15.7.4 Column Specification................................................................................ ...............618
15.7.5 Column Separator.................................................................................................. ..620
15.7.6 Protect................................................................................................. ....................621
15.7.7 Don't Balance Text Columns......................................................... ..........................621
15.7.8 Writing Mode.................................................................................. .........................622
15.7.9 Notes Configuration................................................................................. ................622
15.8 Table Formatting Properties.......................................................................................... ..622
15.8.1 Table Width...................................................................................... .......................622
15.8.2 Table Alignment................................................................................................ .......623
15.8.3 Table Left and Right Margin................................................................................. ....623
15.8.4 Table Top and Bottom Margin......................................................... ........................624
15.8.5 Table Margins.............................................................................................. ............624
15.8.6 Page Number.............................................................................. ............................624
15.8.7 Break Before and Break After....................................................................... ...........624
15.8.8 Table Background and Background Image........................................................ ......624

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 24 of 738

15.8.9 Table Shadow.................................................................................................. ........624
15.8.10 Keep with Next.................................................................................................. .....625
15.8.11 May Break Between Rows........................................................................ .............625
15.8.12 Border Model Property................................................................................ ...........625
15.8.13 Writing Mode............................................................................... ..........................626
15.8.14 Display...................................................................................................... .............626
15.9 Column Formatting Properties..................................................................... ...................626
15.9.1 Column Width.............................................................................................. ............626
15.9.2 Optimal Table Column Width............................................................................ .......627
15.9.3 Break Before and Break After....................................................................... ...........627
15.10 Table Row Formatting Properties................................................................................. .627
15.10.1 Row Height........................................................................................ ....................627
15.10.2 Optimal Table Row Height....................................................................... ..............628
15.10.3 Row Background......................................................................... ..........................628
15.10.4 Break Before and Break After.................................................................... ............628
15.10.5 Keep Together.......................................................................................... .............628
15.11 Table Cell Formatting Properties.................................................................................. .629
15.11.1 Vertical Alignment........................................................................................ ..........629
15.11.2 Text Align Source........................................................................ ..........................629
15.11.3 Direction.................................................................................... ............................630
15.11.4 Vertical Glyph Orientation................................................................... ...................630
15.11.5 Cell Shadow....................................................................................................... ....630
15.11.6 Cell Background........................................................................... .........................631
15.11.7 Cell Border...................................................................................................... .......631
15.11.8 Diagonal Lines....................................................................................... ................631
15.11.9 Border Line Width...................................................................................... ............632
15.11.10 Padding............................................................................................................... .632
15.11.11 Wrap Option............................................................................... .........................632
15.11.12 Rotation Angle............................................................................... ......................632
15.11.13 Rotation Align.......................................................................... ............................633
15.11.14 Cell Protect....................................................................................... ...................633
15.11.15 Print Content............................................................................................... .........633
15.11.16 Decimal places............................................................................ ........................634
15.11.17 Repeat Content............................................................................................... .....634
15.11.18 Shrink To Fit.................................................................................. ......................634
15.12 List-Level Style Properties......................................................................................... ....635
15.13 Stroke Properties...................................................................................... ....................637

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 25 of 738

15.13.1 Stroke Style................................................................................. ..........................637
15.13.2 Dash................................................................................................... ...................638
15.13.3 Multiple Dashes................................................................................ .....................638
15.13.4 Width................................................................................................ .....................638
15.13.5 Color........................................................................................................ ..............638
15.13.6 Start Marker................................................................................................. ..........638
15.13.7 End Marker............................................................................................ ................639
15.13.8 Start Marker Width............................................................................................. ....639
15.13.9 End Marker Width......................................................................................... .........639
15.13.10 Start Marker Center........................................................................ .....................639
15.13.11 End Marker Center.................................................................... ..........................640
15.13.12 Opacity............................................................................................................... ..640
15.13.13 Line Join...................................................................................... ........................640
15.14 Fill Properties................................................................................................ ................640
15.14.1 Fill Style............................................................................................ .....................641
15.14.2 Color........................................................................................................ ..............641
15.14.3 Secondary Fill Color........................................................................................... ....642
15.14.4 Gradient....................................................................................................... ..........642
15.14.5 Gradient Step Count............................................................................ ..................642
15.14.6 Hatch................................................................................................. ....................642
15.14.7 Solid Hatch.................................................................................... ........................643
15.14.8 Fill Image............................................................................................... ................643
15.14.9 Fill Image Rendering Style........................................................................ .............643
15.14.10 Fill Image Size............................................................................... ......................643
15.14.11 Fill Image Tile Reference Point................................................................. ...........644
15.14.12 Fill Image Tile Translation............................................................................ ........645
15.14.13 None and Linear Opacity............................................................. ........................645
15.14.14 Gradient Opacity..................................................................................... .............645
15.14.15 Fill Rule......................................................................................................... .......645
15.14.16 Symbol color......................................................................................... ...............646
15.15 Text Animation Properties..................................................................................... ........646
15.15.1 Animation.......................................................................................................... .....646
15.15.2 Animation Direction........................................................................................... .....647
15.15.3 Animation Start Inside..................................................................................... .......647
15.15.4 Animation Stop Inside............................................................................... .............647
15.15.5 Animation Repeat............................................................................. .....................647
15.15.6 Animation Delay.............................................................................................. .......648

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 26 of 738

15.15.7 Animation Steps.................................................................................................. ...648
15.16 Text and Text Alignment Properties................................................................... ...........648
15.16.1 Auto Grow Width and Height......................................................... ........................648
15.16.2 Fit To Size............................................................................................................ ..649
15.16.3 Fit To Contour................................................................................................. .......649
15.16.4 Text Area Vertical Align................................................................ .........................649
15.16.5 Text Area Horizontal Align.............................................................. .......................649
15.16.6 Word Wrap........................................................................................... .................650
15.16.7 List Styles.................................................................................... ..........................650
15.17 Color Properties............................................................................................ ................650
15.17.1 Color Mode ........................................................................................ ...................650
15.17.2 Color Inversion................................................................................................... ....651
15.17.3 Adjust Luminance............................................................................... ...................651
15.17.4 Adjust Contrast.................................................................................... ..................651
15.17.5 Adjust Gamma............................................................................................... ........651
15.17.6 Adjust Red............................................................................................ .................652
15.17.7 Adjust Green.................................................................................................... ......652
15.17.8 Adjust Blue............................................................................................................ .652
15.17.9 Adjust Opacity.................................................................................................... ....652
15.18 Shadow Properties................................................................................................ ........652
15.18.1 Shadow............................................................................................................ ......653
15.18.2 Offset.......................................................................................................... ...........653
15.18.3 Color........................................................................................................ ..............653
15.18.4 Opacity.................................................................................................................. .653
15.19 Connector Properties.................................................................................. ..................654
15.19.1 Start Line Spacing................................................................................................. .654
15.19.2 End Line Spacing............................................................................................. ......654
15.20 Measure Properties................................................................................................. ......654
15.20.1 Line Distance........................................................................................... ..............654
15.20.2 Guide Overhang.......................................................................... ..........................655
15.20.3 Guide Distance.................................................................................. ....................655
15.20.4 Start Guide............................................................................................................ .655
15.20.5 End Guide....................................................................................................... .......655
15.20.6 Placing........................................................................................................ ...........656
15.20.7 Parallel............................................................................................................. ......656
15.20.8 Text Alignment................................................................................................. ......656
15.20.9 Unit.................................................................................................... ....................657

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 27 of 738

15.20.10 Show Unit.................................................................................. ..........................657
15.20.11 Decimal Places....................................................................................... .............657
15.21 Caption Properties................................................................................ ........................657
15.21.1 Type................................................................................................................... ....658
15.21.2 Angle Type......................................................................................................... ....658
15.21.3 Angle.......................................................................................... ...........................658
15.21.4 Gap................................................................................................................ ........659
15.21.5 Escape Direction................................................................................................ ....659
15.21.6 Escape............................................................................................................... ....659
15.21.7 Line Length.............................................................................................. ..............660
15.21.8 Fit Line Length....................................................................................... ................660
15.22 3D Geometry Properties..................................................................... ..........................660
15.22.1 Horizontal Segments............................................................................................. .660
15.22.2 Vertical Segments............................................................................................... ...660
15.22.3 Edge Rounding...................................................................................... ................661
15.22.4 Edge Rounding Mode........................................................................ ....................661
15.22.5 Back Scale........................................................................................................ .....661
15.22.6 Depth...................................................................................................... ...............661
15.22.7 Backface Culling....................................................................................... .............662
15.22.8 End Angle........................................................................................... ...................662
15.22.9 Close Front........................................................................................... .................662
15.22.10 Close Back.............................................................................. ............................662
15.23 3D Lighting Properties............................................................................................... ....663
15.23.1 Mode.................................................................................................................. ....663
15.23.2 Normals Kind........................................................................................ .................663
15.23.3 Normals Direction............................................................................... ...................663
15.24 3D Texture Properties........................................................................................ ...........664
15.24.1 Generation Mode................................................................................... ................664
15.24.2 Kind............................................................................................. ..........................664
15.24.3 Filter.................................................................................................................... ...665
15.24.4 Mode.................................................................................................................. ....665
15.25 3D Material Properties........................................................................ ..........................665
15.25.1 Colors................................................................................................ ....................665
15.25.2 Shininess.............................................................................................. .................666
15.26 3D Shadow Properties............................................................................. .....................666
15.26.1 Shadow............................................................................................................ ......666
15.27 Frame Formatting Properties...................................................................... ..................666

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 28 of 738

15.27.1 Frame Widths........................................................................................ ................666
15.27.2 Frame Heights...................................................................................... .................667
15.27.3 Maximum Width and Height................................................................................. ..667
15.27.4 Left and Right Margins.................................................................................... .......668
15.27.5 Top and Bottom Margins........................................................... ............................668
15.27.6 Margins........................................................................................................ ..........668
15.27.7 Print Content.................................................................................................. ........668
15.27.8 Protect............................................................................................... ....................668
15.27.9 Horizontal Position................................................................................... ..............669
15.27.10 Horizontal Relation........................................................................................... ....670
15.27.11 Vertical Position.................................................................................. .................671
15.27.12 Vertical Relation............................................................................................. ......672
15.27.13 Frame Anchor........................................................................................... ...........673
15.27.14 Border........................................................................................................ ..........673
15.27.15 Border Line Width.................................................................................... ............673
15.27.16 Padding............................................................................................................... .673
15.27.17 Shadow......................................................................................................... .......674
15.27.18 Background............................................................................. ............................674
15.27.19 Columns.................................................................................... ..........................674
15.27.20 Editable......................................................................................................... .......674
15.27.21 Wrapping........................................................................................... ..................674
15.27.22 Dynamic Wrap Threshold................................................................ ....................675
15.27.23 Paragraph-only Wrapping...................................................................... ..............675
15.27.24 Contour Wrapping................................................................................................ 676
15.27.25 Contour Wrapping Mode.................................................................................. ....676
15.27.26 Run Through................................................................................................. .......676
15.27.27 Flow with Text............................................................................................ ..........677
15.27.28 Overflow behavior.................................................................................... ............677
15.27.29 Mirroring............................................................................................................... 677
15.27.30 Clipping......................................................................................................... .......678
15.27.31 Wrap Influence on Position....................................................................... ...........678
15.27.32 Writing Mode............................................................................. ..........................679
15.28 Floating Frame Formatting Properties......................................................................... ..679
15.28.1 Display Scrollbar....................................................................................... .............679
15.28.2 Display Border................................................................................ .......................680
15.28.3 Margins........................................................................................................ ..........680
15.28.4 Object Formatting Properties..................................................................... ............680

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 29 of 738

15.28.5 Visible Area......................................................................................................... ...680
15.28.6 Draw Aspect.................................................................................. ........................681
15.29 Chart Formatting Properties................................................................................. .........681
15.29.1 Scale Text.......................................................................................................... ....682
15.30 Chart Subtype Properties................................................................................. .............682
15.30.1 Three-dimensional Charts......................................................... ............................682
15.30.2 Chart Depth................................................................................... ........................682
15.30.3 Chart Symbol.......................................................................................... ...............683
15.30.4 Chart Symbol Size............................................................................. ....................683
15.30.5 Bar Chart Properties............................................................................. .................684
15.30.6 Stock Chart Properties...................................................................................... .....684
15.30.7 Line Chart Properties................................................................................. ............685
15.30.8 Pie Chart Properties.............................................................................................. .686
15.30.9 Lines........................................................................................................ ..............686
15.30.10 Solid Charts Bars...................................................................................... ...........686
15.30.11 Stacked Chart Bars.......................................................................................... ....686
15.31 Chart Axes Properties....................................................................................... ............687
15.31.1 Linked Data Formats..................................................................... ........................687
15.31.2 Visibility........................................................................................................ ..........687
15.31.3 Scaling........................................................................................................ ...........687
15.31.4 Tick Marks............................................................................................ .................688
15.31.5 Labels..................................................................................................... ...............689
15.32 Common Chart Properties...................................................................... ......................689
15.32.1 Stacked Text...................................................................................................... ....690
15.32.2 Rotation Angle................................................................................. ......................690
15.32.3 Data Labels.......................................................................................................... ..690
15.33 Statistical Properties............................................................................ .........................691
15.33.1 Mean Value......................................................................................................... ...691
15.33.2 Error Category................................................................................. ......................691
15.34 Plot Area Properties........................................................................................ ..............693
15.34.1 Series Source..................................................................................... ...................693
15.35 Regression Curve Properties....................................................................... .................693
15.35.1 Regression Type............................................................................................... .....694
15.36 Presentation Page Attributes....................................................................................... ..694
15.36.1 Transition Type....................................................................................... ...............695
15.36.2 Transition Style..................................................................................... .................695
15.36.3 Transition Speed................................................................................................ ....697

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 30 of 738

15.36.4 Transition Type or Family........................................................... ...........................698
15.36.5 Transition Subtype.................................................................................... .............698
15.36.6 Transition Direction...................................................................................... ..........698
15.36.7 Fade Color................................................................................................. ............698
15.36.8 Page Duration............................................................................................... .........699
15.36.9 Page Visibility...................................................................................................... ...699
15.36.10 Sound............................................................................................ ......................699
15.36.11 Background Size............................................................................................ ......699
15.36.12 Background Objects Visible................................................................... ..............700
15.36.13 Background Visible............................................................................. .................700
15.36.14 Display Header............................................................................ ........................700
15.36.15 Display Footer................................................................................................ ......700
15.36.16 Display Page Number........................................................................... ...............701
15.36.17 Display Date And Time.................................................................... ....................701
16 Data Types and Schema Definitions................................................................ ......................702
16.1 Data Types.................................................................................................................... ..702
16.2 Other Definitions......................................................................................... ....................707
16.3 Relax-NG Schema Suffix................................................................................. ...............708
17 Packages........................................................................................................ .......................709
17.1 Introduction................................................................................................... ..................709
17.2 Zip File Structure........................................................................................................ .....709
17.3 Encryption........................................................................................................ ...............710
17.4 MIME Type Stream........................................................................................ .................710
17.5 Usage of IRIs Within Packages............................................................ ..........................711
17.6 Preview Image............................................................................................ ....................711
17.7 Manifest File.................................................................................................................. ..711
17.7.1 Relax-NG Schema............................................................................................. ......712
17.7.2 Manifest Root Element................................................................. ...........................712
17.7.3 File Entry............................................................................................................... ...712
17.7.4 Encryption Data................................................................................ .......................713
17.7.5 Algorithm....................................................................................... ..........................714
17.7.6 Key Derivation......................................................................................................... .715
17.7.7 Relax-NG Schema Suffix................................................................................. ........717
Appendix A. Strict Relax NG Schema..................................................................... ....................718
Appendix B. References............................................................................................................ ..720
Appendix C. MIME Types and File Name Extensions (Non Normative)......................................722
Appendix D. Core Features Sets (Non Normative)................................................................... ...724

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 31 of 738

Appendix E. Accessibility Guidelines (Non Normative).......................................................... ......729
E.1. Title, Description and Caption of Graphical Elements............................................ ..............729
E.2. Hyperlink Titles........................................................................................... .........................729
E.3. Tables in Presentations............................................................................ ...........................730
E.4. Further Guidelines...................................................................................... .........................730
Appendix F. Bidirectional (BiDi) Scripts,Numeric Digits Presentation and Calendars (NonNormative)....................................................................................................... ...........................731
Appendix G. Changes From Previous Specification Versions (Non Normative)..........................733
G.1. Changes from “Open Office Specification 1.0 Committee Draft 1”......................................733
G.2. Changes from “Open Document Format for Office Applications (OpenDocument) 1.0
Committee Draft 2”................................................................................................................ ......733
G.3. Changes from “Open Document Format for Office Applications (OpenDocument) v1.0”....734
G.4. Changes from “Open Document Format for Office Applications (OpenDocument) v1.0
(Second Edition)”............................................................................................ ............................734
Appendix H. Acknowledgments (Non Normative)....................................................................... .737

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 32 of 738

1 Introduction
1.1 Introduction
This document defines an XML schema for office applications and its semantics. The schema issuitable for office documents, including text documents, spreadsheets, charts and graphicaldocuments like drawings or presentations, but is not restricted to these kinds of documents.
The schema provides for high-level information suitable for editing documents. It defines suitable
XML structures for office documents and is friendly to transformations using XSLT or similar XMLbased tools.
Chapter 1 contains the introduction to the OpenDocument format. The structure of documentsthat conform to the OpenDocument specification is explained in chapter 2. Chapter 3 described
the meta information that can be contained in such documents. Chapters 4 and 5 describe theirtext and paragraph content. Text Fields are described in chapter 6, text indices in chapter 7.
Chapter 8 describes the table content of a document in OpenDocument format, chapter 9 its
graphical content, chapter 10 its chart content, and chapter 11 its form content. Content that iscommon to all documents is described in chapter 12. The integration of SMIL animation markup
into the OpenDocument schema is described in chapter 13. Chapter 14 explains style information
content, chapter 15 specifies formatting properties that are can be used within styles. The datatypes used by the OpenDocument schema are described in chapter 16.
The OpenDocument format makes use of a package concept. These packages are described inchapter 17.

1.2 Notation
Within this specification, the key words "shall", "shall not", "should", "should not" and "may" areto be interpreted as described in Annex H of [ISO/IEC Directives] if they appear in bold letters.

1.3 Namespaces
Table 1 lists the namespaces that are defined by the OpenDocument format and their default
prefixes. For more information about XML namespaces, please refer to the Namespaces in XML
specification [xml-names].
Table 1: XML Namespaces defined by the OpenDocument schema
PrefixDescription

Namespace

officeFor all common pieces of informationthat are not contained in another,more specific namespace.

urn:oasis:names:tc:opendocument:xmlns:
office:1.0

meta

For elements and attributes that
describe meta information.

urn:oasis:names:tc:opendocument:xmlns:
meta:1.0

configFor elements and attributes that
describe application specific settings.

urn:oasis:names:tc:opendocument:xmlns:
config:1.0

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 33 of 738

Prefix

Description

Namespacetext

For elements and attributes that may
occur within text documents and text
parts of other document types, suchas the contents of a spreadsheet cell.

urn:oasis:names:tc:opendocument:xmlns:
text:1.0

table

For elements and attributes that may
occur within spreadsheets or withintable definitions of a text document.

urn:oasis:names:tc:opendocument:xmlns:
table:1.0

drawing

For elements and attributes that
describe graphic content.

urn:oasis:names:tc:opendocument:xmlns:
drawing:1.0

presentation For elements and attributes that
describe presentation content.

urn:oasis:names:tc:opendocument:xmlns:
presentation:1.0

dr3d

For elements and attributes that
describe 3D graphic content.

urn:oasis:names:tc:opendocument:xmlns:
dr3d:1.0

anim

For elements and attributes that
describe animation content.

urn:oasis:names:tc:opendocument:xmlns:
animation:1.0

chart

For elements and attributes that
describe chart content.

urn:oasis:names:tc:opendocument:xmlns:
chart:1.0

form

For elements and attributes that
describe forms and controls.

urn:oasis:names:tc:opendocument:xmlns:
form:1.0

scriptFor elements and attributes that
represent scripts or events.

urn:oasis:names:tc:opendocument:xmlns:
script:1.0

style

For elements and attributes that
describe the style and inheritancemodel used by the OpenDocument
format as well as some common
formatting attributes.

urn:oasis:names:tc:opendocument:xmlns:
style:1.0

numberFor elements and attributes that
describe data style information.

urn:oasis:names:tc:opendocument:xmlns:
data style:1.0

manifest

For elements and attribute containedin the package manifest.

urn:oasis:names:tc:opendocument:xmlns:
manifest:1.0

Table 2 lists the namespaces that are defined by the OpenDocument format, but containelements and attributes whose semantics are compatible to elements and attributes from otherspecifications.
Table 2: XML Namespaces defined by the OpenDocument schema that include elements andattributes that are compatible to elements and attributes of other standards.
PrefixDescription

Namespacefo

For attributes that are compatible toattributes defined in [XSL].

urn:oasis:names:tc:opendocument:xmlns:
xsl-fo-compatible:1.0

svg

For elements and attributes that arecompatible to elements or attributes
defined in [SVG].

urn:oasis:names:tc:opendocument:xmlns:
svg-compatible:1.0

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 34 of 738

Prefix
smil

Description

Namespace

For attributes that are compatible toattributes defined in [SMIL20].

urn:oasis:names:tc:opendocument:xmlns:
smil-compatible:1.0

Table 3 lists the namespaces that are imported into the OpenDocument format and their default
prefixes.
Table 3: XML Namespaces used by the OpenDocument schema
PrefixDescription

Namespacedc

The Dublin Core Namespace (see[DCMI]).

http://purl.org/dc/elements/1.1/

xlink

The XLink namespace (see [XLink]).

http://www.w3.org/1999/xlink

math

MathML Namespace (see [MathML])

http://www.w3.org/1998/Math/MathML

xformsThe XForms namespace (see[XForms]).

http://www.w3.org/2002/xforms

1.4 Relax-NG Schema
The normative XML Schema for the OpenDocument format is embedded within this specification.
It can be obtained from the specification document by concatenating all schema fragments
contained in chapters 1 to 16. All schema fragments have a gray background color and line
numbers.
The schema language used within this specification is Relax-NG (see [RNG]). The attributedefault value feature specified in [RNG-Compat] is used to provide attribute default values.
The schema provided in this specification permits arbitrary content within meta information
elements and formatting properties elements as described in section 1.5. Appendix A contains aschema that restricts the content within these elements to the attributes and elements defined inthis specification.
Prefix for the normative Relax-NG schema:
1
2
3
4
5

<?xml version="1.0" encoding="UTF-8"?><!-OASIS OpenDocument v1.1
OASIS Standard, 1 Feb 2007
Relax-NG Schema

6
7

$Id$

8
9
10
11

© 2002-2007 OASIS Open© 1999-2007 Sun Microsystems, Inc.
-->

12
13
14
15

<grammar
xmlns="http://relaxng.org/ns/structure/1.0"
xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"

16
17

datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"

18
19
20
21

xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
xmlns:config="urn:oasis:names:tc:opendocument:xmlns:config:1.0"

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 35 of 738

22
23
24
25
26
27
28
29
30
31
32

xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0"
xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
xmlns:anim="urn:oasis:names:tc:opendocument:xmlns:animation:1.0"

33
34
35
36
37

xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:math="http://www.w3.org/1998/Math/MathML"
xmlns:xforms="http://www.w3.org/2002/xforms"

38
39
40
41
42

xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
xmlns:smil="urn:oasis:names:tc:opendocument:xmlns:smil-compatible:1.0">

1.5 Document Processing and Conformance
Documents that conform to the OpenDocument specification may contain elements and attributes
not specified within the OpenDocument schema. Such elements and attributes must not be part ofa namespace that is defined within this specification and are called foreign elements andattributes.
Conforming applications either shall read documents that are valid against the OpenDocument
schema if all foreign elements and attributes are removed before validation takes place, or shallwrite documents that are valid against the OpenDocument schema if all foreign elements andattributes are removed before validation takes place.
Conforming applications that read and write documents may preserve foreign elements andattributes.
In addition to this, conforming applications should preserve meta information and the content ofstyles. This means:•

The various <style:*-properties> elements (see section 15) may have arbitrary
attributes attached and may have arbitrary element content. All attributes attached to theseelements and elements contained within these elements should be preserved (see section
15.1.3);•elements contained within the <office:meta> element may have arbitrary element content
and should be preserved (see section 2.2.1).

Foreign elements may have an office:process-content attribute attached that has thevalue true or false. If the attribute's value is true, or if the attribute does not exist, theelement's content should be processed by conforming applications. Otherwise conforming
applications should not process the element's content, but may only preserve its content. If theelement's content should be processed, the document itself shall be valid against the
OpenDocument schema if the unknown element is replaced with its content only.
Conforming applications shall read documents containing processing instructions and shouldpreserve them.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 36 of 738

There are no rules regarding the elements and attributes that actually have to be supported by
conforming applications, except that applications should not use foreign elements and attributes
for features defined in the OpenDocument schema. See also appendix D.
43
44
45
46
47
48
49

<define name="office-process-content"><optional><attribute name="office:process-content" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

1.6 White-Space Processing and EOL Handling
In conformance with the W3C XML specification [XML1.0], optional white-space characters thatare contained in elements that have element content (in other words that must contain elements
only but not text) are ignored. This applies to the following white-space and end-of-line (EOL)[UNICODE] characters:•

HORIZONTAL TABULATION (0x0009)•

LINE FEED (0x000A)•CARRIAGE RETURN (0x000D)•SPACE (0x0020)

For any other element, white-spaces are preserved by default. Unless otherwise stated, there isno special processing for any of the four white-space characters. For some elements, different
white-space processing may take place, for example the paragraph element.
The XML specification also requires that any of the four white-space characters that is containedin an attribute value is normalized to a SPACE character.
One of the following characters may be used to represent line ends:•

LINE FEED•CARRIAGE RETURN•

The sequence of the characters CARRIAGE RETURN and LINE FEED

Conforming to the XML specification, all the possible line ends are normalized to a single LINE
FEED character.
As a consequence of the white-space and EOL processing rules, any CARRIAGE RETURN
characters that are contained either in the text content of an element or in an attribute value must
be encoded by the character entity &#x0D;. The same applies to the HORIZONTALTABULATION and LINE FEED characters if they are contained in an attribute value.

1.7 MIME Types and File Name Extensions
Appendix C contains a list of MIME types and file name extensions to be used for office
documents that conform to this specification and that are contained in a package (see section
2.1). This MIME types and extensions either have been registered following the procedures
described in [RFC2048], or a registration is in progress.
Office documents that conform to this specification but are not contained in a package should
use the MIME type text/xml.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 37 of 738

Only MIME types and extensions that have been registered according to [RFC2048] should used
for office documents that conform to this specification. The MIME types and extensions listed inappendix C should be used where appropriate.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 38 of 738

2 Document StructureThis chapter introduces the structure of the OpenDocument format. The chapter contains thefollowing sections:•

Document Roots•

Document Metadata•

Body Element and Document Types•

Application Settings•

Scripts•

Font Face Declarations•

Styles•Page Styles and Layout

In the OpenDocument format, each structural component is represented by an element, withassociated attributes. The structure of a document in OpenDocument format applies to all
document types. There is no difference between a text document, a spreadsheet or a drawing,apart from the content. Also, all document types may contain different styles. Document content
that is common to all document types can be exchanged from one type of document to another.

2.1 Document Roots
A document root element is the primary element of a document in OpenDocument format. It
contains the entire document. All types of documents, for example, text documents,
spreadsheets, and drawing documents use the same types of document root elements.
The OpenDocument format supports the following two ways of document representation:•

As a single XML document.

•

As a collection of several subdocuments within a package (see section 17), each of which
stores part of the complete document. Each subdocument has a different document root andstores a particular aspect of the XML document. For example, one subdocument contains thestyle information and another subdocument contains the content of the document. All types of
documents, for example, text and spreadsheet documents, use the same document andsubdocuments definitions.

There are four types of subdocuments, each with different root elements. Additionally, the single
XML document has its own root element, for a total of five different supported root elements. The
root elements are summarized in the following table:
Root Element

Subdocument Content

Subdoc. Name in
Package<office:document>

Complete office document in a single
XML document.

n/a<office:document-content>

Document content and automaticstyles used in the content.

content.xml

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 39 of 738

Root Element

Subdocument Content

Subdoc. Name in
Package<office:document-styles>

Styles used in the document content
styles.xml
and automatic styles used in the styles
themselves.

<office:document-meta>

Document meta information, such as
the author or the time of the last saveaction.

meta.xml<office:document-settings> Application-specific settings, such as settings.xml
the window size or printer information.
The definitions of the root elements described in the table above are analogous to the definition of<office:document>, except that the child element specification is suitably restricted.
50
51
52
53
54
55
56
57
58

<start><choice><ref name="office-document"/><ref name="office-document-content"/><ref name="office-document-styles"/><ref name="office-document-meta"/><ref name="office-document-settings"/></choice></start>2.1.1 Document Root Element Content Models
The content models of the five root elements is summarized in the following table. Note that
<office:document> may contain all supported top-level elements. None of the four
subdocument root elements contain the complete data, but four combined do.
Root Element<office:document>

meta­ app. script font styledata sett.
decls




<office:document-content>










<office:document-styles><office:document-meta><office:document-settings>



auto
style


mast body
style















The <office:document> root contains a complete document:
59
60
61
62
63
64
65
66
67
68
69

<define name="office-document"><element name="office:document"><ref name="office-document-attrs"/><ref name="office-document-common-attrs"/><ref name="office-meta"/><ref name="office-settings"/><ref name="office-scripts"/><ref name="office-font-face-decls"/><ref name="office-styles"/><ref name="office-automatic-styles"/><ref name="office-master-styles"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 40 of 738

70
71
72

<ref name="office-body"/></element></define>

The <office:document-content> root contains only the document content, along with theautomatic styles needed for the document content:
73
74
75
76
77
78
79
80
81

<define name="office-document-content"><element name="office:document-content"><ref name="office-document-common-attrs"/><ref name="office-scripts"/><ref name="office-font-face-decls"/><ref name="office-automatic-styles"/><ref name="office-body"/></element></define>

The <office:document-styles> root contains all named styles of a document, along with theautomatic styles needed for the named styles:
82
83
84
85
86
87
88
89
90

<define name="office-document-styles"><element name="office:document-styles"><ref name="office-document-common-attrs"/><ref name="office-font-face-decls"/><ref name="office-styles"/><ref name="office-automatic-styles"/><ref name="office-master-styles"/></element></define>

The <office:document-meta> root contains the meta information about a document.
91
92
93
94
95
96

<define name="office-document-meta"><element name="office:document-meta"><ref name="office-document-common-attrs"/><ref name="office-meta"/></element></define>

The <office:document-settings> root contains application specific settings to be applied
when processing this document.
97
98
99
100
101
102

<define name="office-document-settings"><element name="office:document-settings"><ref name="office-document-common-attrs"/><ref name="office-settings"/></element></define>

2.1.2 Document Root Attributes
VersionAll root elements take an office:version attribute, which indicates which version of thisspecification it complies with. The version number is in the format revision.version. If the file
has a version known to an XML processor, it may validate the document. Otherwise, it is optional
to validate the document, but the document must be well formed.
103
104
105

<define name="office-document-common-attrs" combine="interleave"><optional><attribute name="office:version">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 41 of 738

106
107
108
109

<ref name="string"/></attribute></optional></define>

MIME TypeThe <office:document> element takes an office:mimetype attribute, which indicates thetype of document (text, spreadsheet etc.). This attribute is especially important for flat XML files,
where this is the only way the type of document can be detected (in a package, the MIME type isalso present in a separate file, see section 17.4). Its values are the MIME types that are used forthe packaged variant of office documents (see section 1.7).
110
111
112
113
114

<define name="office-document-attrs" combine="interleave"><attribute name="office:mimetype"><ref name="string"/></attribute></define>

2.2 Document Metadata
Metadata is general information about a document. In the OpenDocument format, all of themetadata elements are contained in an <office:meta> element, usually located at start of the
document. Metadata elements may be omitted or occur multiple times. It is application-specific
how to update multiple instances of the same elements.
115
116
117
118
119
120
121

<define name="office-meta"><optional><element name="office:meta"><ref name="office-meta-content"/></element></optional></define>

122
123
124
125

<define name="office-meta-content"><ref name="anyElements"/></define>

126
127
128
129
130
131

<define name="office-meta-content-strict"><zeroOrMore><ref name="office-meta-data"/></zeroOrMore></define>

2.2.1 Pre-Defined vs. Custom Metadata
In the OpenDocument schema the metadata is comprised of pre-defined metadata elements,
user defined metadata, as well as custom metadata elements. The pre-defined metadata
elements have defined semantics. They should be processed and updated by editing
applications. They can be referenced from within the document through the use of suitable text
fields.
User-defined metadata is a more generic mechanism which specifies a triplet of name, type, andvalue. Supporting applications can present these value to the user, making use of the supplied
data type. The user-defined metadata can be referenced from within the document through theuse of suitable text fields.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 42 of 738

Custom metadata are arbitrary elements inside <office:meta>. Since their semantics is notdefined in this specification, conforming applications in general cannot process or display thisdata. Applications should preserve this data when editing the document.

2.2.2 Sample Metadata
Example: Sample metadata of a document in OpenDocument format<office:meta><dc:title>Title of the document</dc:title><dc:description>Description/Comment for the document</dc:description><meta:initial-creator>User Name</meta:initial-creator><meta:creation-date>1999-10-18T12:34:56</meta:creation-date><dc:creator>User Name</dc:creator><dc:date>1999-10-19T15:16:17</dc:date><meta:printed-by>User Name</meta:printed-by><meta:print-date>1999-10-20T16:17:18</meta:print-date><dc:subject>Description of the document</dc:subject><meta:editing-duration>PT5H10M10S</meta:editing-duration><meta:keyword>First keyword</meta:keyword><meta:keyword>Second keyword</meta:keyword><meta:keyword>Third keyword</meta:keyword><meta:template xlink:type="simple"
xlink:href="file:///c|/office52/share/template/german/finance/budget.vor"
xlink:title="Template name"meta:date="1999-10-15T10:11:12" /><meta:auto-reload
xlink:type="simple"
xlink:href="file:///..."
meta:delay="P60S" /><dc:language>de-DE</dc:language><meta:user-defined meta:name="Field 1"
meta:value-type="string">Value 1</meta:user-defined><meta:user-defined meta:name="Field 2"
meta:value-type="float">1.234</meta:user-defined></office:meta>

2.3 Body Element and Document Types
The document body contains an element to indicate which type of content this document contains.
Currently supported document types are:•text documents•

drawing documents•

presentation documents•

spreadsheet documents•

chart documents•

image documents

All document types share the same content elements, but different document types place different
restrictions on which elements may occur, and in what combinations. The document content istypically framed by a prelude and epilogue, which contain additional information for a specific typeof document, like form data or variable declarations.
132<define name="office-body">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 43 of 738

133
134
135
136

<element name="office:body"><ref name="office-body-content"/></element></define>

2.3.1 Text Documents
The content of text documents mainly consists of a sequence containing any number ofparagraphs, tables, indices, text frames, text sections, and graphical elements. Additionally, a text
document may contain forms, change tracking information and variable declarations. Each ofthese is defined in the document prelude, and may be referenced from the document content.
137
138
139
140
141
142
143
144
145
146

<define name="office-body-content" combine="choice"><element name="office:text"><ref name="office-text-attlist"/><ref name="office-text-content-prelude"/><zeroOrMore><ref name="office-text-content-main"/></zeroOrMore><ref name="office-text-content-epilogue"/></element></define>

Text Document Content Model
The text document prelude contains the document's form data, change tracking information, andvariable declarations. To allow office applications to implement functionality that usually isavailable in spreadsheets for text documents, it may also contain elements that implement
enhanced table features. See also section 2.3.4.
147
148
149
150
151
152

<define name="office-text-content-prelude"><ref name="office-forms"/><ref name="text-tracked-changes"/><ref name="text-decls"/><ref name="table-decls"/></define>

The main document content contains any sequence of text content elements, which includes
paragraphs (and headings), text sections (and indices), tables, and graphical shapes. As analternative, a text document may contain of a single page sequence.
It is not required that a text document contains a paragraph. A text document may consist of asequence frames only.
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

<define name="office-text-content-main"><choice><zeroOrMore><ref name="text-content"/></zeroOrMore><group><ref name="text-page-sequence"/><zeroOrMore><choice><ref name="draw-a"/><ref name="shape"/></choice></zeroOrMore></group></choice></define>

169

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 44 of 738

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

<define name="text-content"><choice><ref name="text-h"/><ref name="text-p"/><ref name="text-list"/><ref name="text-numbered-paragraph"/><ref name="table-table"/><ref name="draw-a"/><ref name="text-section"/><ref name="text-soft-page-break"/><ref name="text-table-of-content"/><ref name="text-illustration-index"/><ref name="text-table-index"/><ref name="text-object-index"/><ref name="text-user-index"/><ref name="text-alphabetical-index"/><ref name="text-bibliography"/><ref name="shape"/><ref name="change-marks"/></choice></define>

There are no text documents specific epilogue elements, but the epilogue may contain elementsthat implement enhanced table features. See also section 2.3.4.
191
192
193

<define name="office-text-content-epilogue"><ref name="table-functions"/></define>

Global Text Documents
There is a common use case for large documents to be edited in separate entities, such that there
is a 'global' document, containing several linked constituent subdocuments. This can be
implemented by using linked text sections (see section 4.4). To facilitate an editing application
adapting the user interface to better support the notion of 'global' document with constituent parts(as opposed to a document with arbitrary linked content), the text:global flag can be used. If
set to true, it informs applications that linked sections in this document have part-of semantics.
The actual XML representation of the sections does not change.
194
195
196
197
198
199
200

<define name="office-text-attlist" combine="interleave"><optional><attribute name="text:global" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Use Soft Page Breaks
The text:use-soft-page-breaks attribute specifies whether the document contains soft
page breaks.
A soft page break is a page break that a has been included by a page oriented processor at a
position where the document itself does not include a page break (e.g. by using the fo:breakbefore and fo:break-after formatting properties described in section 15.5.2).
Soft page breaks are specified by the <text:soft-page-break> elements described in
sections 4.7 and 5.1.1:Soft Page breaks.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 45 of 738

The use of the <text:soft-page-break> elements is always optional. An application
generating the format may include the element if it has computed a paginated layout. A
consuming application may handle the element while computing the layout, but it shall notdepend on its existence. Soft page breaks are only supported within text documents.
A generating application that stores soft page breaks shall indicate this by setting the text:usepage-breaks attribute to true. A generating application that does not store soft page breaks
shall indicate that by omitting this attribute, or by setting it to false.
An application that does not support pagination and soft page-breaks, that modifies an
OpenDocument file, which includes soft page-breaks, shall at least set the text:use-pagebreaks attribute to false (or remove it). It should also remove the text:soft-page-breakelements from the document but is not required to do so.
An application that computes a paginated layout of a document should provide a facility to turn onexport of soft page breaks for the purposes of consistent page breaks and for proper conversion
to digital talking book formats (such as [DAISY]).
For <text:soft-page-break> elements that appear within table rows, the maximum numberof <text:soft-page-break> elements that appear within the single table cells determines thenumber of page breaks that appear within the table row. The <text:soft-page-break>elements contained in each cell determine the positions where these page breaks appear within
the cell content.
Similarly, <text:soft-page-break> elements that appear within text boxes and other content
displayed outside the text flow, do not start a new page, but only indicate where the text-box's
content breaks between two pages.
201
202
203
204
205
206
207

<define name="office-text-attlist" combine="interleave"><optional><attribute name="text:use-soft-page-breaks" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

2.3.2 Drawing Documents
The content of drawing document consists of a sequence of draw pages.
208
209
210
211
212
213
214
215

<define name="office-body-content" combine="choice"><element name="office:drawing"><ref name="office-drawing-attlist"/><ref name="office-drawing-content-prelude"/><ref name="office-drawing-content-main"/><ref name="office-drawing-content-epilogue"/></element></define>

216
217
218
219

<define name="office-drawing-attlist"><empty/></define>

Drawing Document Content Model
The drawing document prelude may contain text declarations only. To allow office applications to
implement functionality that usually is available in spreadsheets for drawing documents, it may
also contain elements that implement enhanced table features. See also section 2.3.4.
220<define name="office-drawing-content-prelude">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 46 of 738

221
222
223

<ref name="text-decls"/><ref name="table-decls"/></define>

The main document content contains a sequence of draw pages.
224
225
226
227
228

<define name="office-drawing-content-main"><zeroOrMore><ref name="draw-page"/></zeroOrMore></define>

There are no drawing documents specific epilogue elements, but the epilogue may containelements that implement enhanced table features. See also section 2.3.4.
229
230
231

<define name="office-drawing-content-epilogue"><ref name="table-functions"/></define>

2.3.3 Presentation Documents
The content of presentation document consists of a sequence of draw pages.
232
233
234
235
236
237
238
239

<define name="office-body-content" combine="choice"><element name="office:presentation"><ref name="office-presentation-attlist"/><ref name="office-presentation-content-prelude"/><ref name="office-presentation-content-main"/><ref name="office-presentation-content-epilogue"/></element></define>

240
241
242
243

<define name="office-presentation-attlist"><empty/></define>

Presentation Document Content Model
The presentation document prelude equals the one of a drawing document, but may contain some
additional declarations. See also section 2.3.2.
244
245
246
247
248

<define name="office-presentation-content-prelude"><ref name="text-decls"/><ref name="table-decls"/><ref name="presentation-decls"/></define>

The main document content contains a sequence of draw pages.
249
250
251
252
253

<define name="office-presentation-content-main"><zeroOrMore><ref name="draw-page"/></zeroOrMore></define>

The epilogue of presentation documents may contain presentation settings. Additionally, it may
contain elements that implement enhanced table features. See also section 2.3.4.
254
255
256
257

<define name="office-presentation-content-epilogue"><ref name="presentation-settings"/><ref name="table-functions"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 47 of 738

2.3.4 Spreadsheet Documents
The content of spreadsheet documents mainly consists of a sequence of tables. Additionally, a
spreadsheet document may contain forms, change tracking information and various kinds ofdeclarations that simplify the usage of spreadsheet tables and their analysis. Each of these arecontained in either the document prelude, or the document epilogue.
258
259
260
261
262
263
264
265

<define name="office-body-content" combine="choice"><element name="office:spreadsheet"><ref name="office-spreadsheet-attlist"/><ref name="office-spreadsheet-content-prelude"/><ref name="office-spreadsheet-content-main"/><ref name="office-spreadsheet-content-epilogue"/></element></define>

Spreadsheet Document Content Model
The spreadsheet document prelude contains the document's form data, change tracking
information, calculation setting for formulas, validation rules for cell content and declarations forlabel ranges.
266
267
268
269
270
271
272

<define name="office-spreadsheet-content-prelude"><optional><ref name="table-tracked-changes"/></optional><ref name="text-decls"/><ref name="table-decls"/></define>

273
274
275
276
277
278
279
280
281
282
283
284

<define name="table-decls"><optional><ref name="table-calculation-settings"/></optional><optional><ref name="table-content-validations"/></optional><optional><ref name="table-label-ranges"/></optional></define>

The main document is a list of tables.
285
286
287
288
289

<define name="office-spreadsheet-content-main"><zeroOrMore><ref name="table-table"/></zeroOrMore></define>

The epilogue of spreadsheet documents contains declarations for named expressions, databaseranges, data pilot tables, consolidation operations and DDE links.
290
291
292

<define name="office-spreadsheet-content-epilogue"><ref name="table-functions"/></define>

293
294
295
296
297
298

<define name="table-functions"><optional><ref name="table-named-expressions"/></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 48 of 738

299
300
301
302
303
304
305
306
307
308
309
310

<ref name="table-database-ranges"/></optional><optional><ref name="table-data-pilot-tables"/></optional><optional><ref name="table-consolidation"/></optional><optional><ref name="table-dde-links"/></optional></define>

2.3.5 Chart Documents
The content of chart documents mainly consists of a chart element.
311
312
313
314
315
316
317
318

<define name="office-body-content" combine="choice"><element name="office:chart"><ref name="office-chart-attlist"/><ref name="office-chart-content-prelude"/><ref name="office-chart-content-main"/><ref name="office-chart-content-epilogue"/></element></define>

319
320
321
322

<define name="office-chart-attlist"><empty/></define>

Chart Document Content Model
To allow office applications to implement functionality that usually is available in spreadsheets forthe table that may be contained in a chart, the chart document prelude may contain elements that
implement enhanced table features. See also section 2.3.4.
323
324
325
326

<define name="office-chart-content-prelude"><ref name="text-decls"/><ref name="table-decls"/></define>

The main document is a chart element only.
327
328
329

<define name="office-chart-content-main"><ref name="chart-chart"/></define>

There are no chart documents specific epilogue elements, but the epilogue may contain elementsthat implement enhanced table features. See also section 2.3.4.
330
331
332

<define name="office-chart-content-epilogue"><ref name="table-functions"/></define>

2.3.6 Image Documents
The content of an image document is a frame element only. The frame element must contain asingle image element.
333
334<define name="office-body-content" combine="choice"><element name="office:image">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 49 of 738

335
336
337
338
339
340

<ref name="office-image-attlist"/><ref name="office-image-content-prelude"/><ref name="office-image-content-main"/><ref name="office-image-content-epilogue"/></element></define>

341
342
343
344

<define name="office-image-attlist"><empty/></define>

Image Document Content Model
The image document prelude is empty.
345
346
347

<define name="office-image-content-prelude"><empty/></define>

The main document content contains a frame only.
348
349
350

<define name="office-image-content-main"><ref name="draw-frame"/></define>

There are no image documents specific epilogue elements.
351
352
353

<define name="office-image-content-epilogue"><empty/></define>

2.4 Application Settings
Application settings are contained in a <office:settings> element.
354
355
356
357
358
359
360
361
362

<define name="office-settings"><optional><element name="office:settings"><oneOrMore><ref name="config-config-item-set"/></oneOrMore></element></optional></define>

The settings for office applications may be divided into several categories each represented by a<config:config-item-set> element. For instance the following two categories may exist:•

Document settings, for example default printer.

•

View settings, for example zoom level.

2.4.1 Sequence of Settings
The <config:config-item-set> element is a container element for all types of setting
elements. The settings can be contained in the element is any order.
363
364
365
366

<define name="config-config-item-set"><element name="config:config-item-set"><ref name="config-config-item-set-attlist"/><ref name="config-items"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 50 of 738

367
368

</element></define>

369
370
371
372
373
374
375
376
377
378
379

<define name="config-items"><oneOrMore><choice><ref name="config-config-item"/><ref name="config-config-item-set"/><ref name="config-config-item-map-named"/><ref name="config-config-item-map-indexed"/></choice></oneOrMore></define>

Config Name
The config:name attribute identifies the name of the setting container. For top level<config:config-item-set> elements, that are elements that are direct children of the<office:settings> element, the name should be preceded by a namespace prefix that
identifies the application the settings belong to.
380
381
382
383
384

<define name="config-config-item-set-attlist" combine="interleave"><attribute name="config:name"><ref name="string"/></attribute></define>

Example:<office:settings><config:config-item-set xmlns:ooo="http://www.openoffice.org/...";
config:name="ooo:view-settings"><config:config-item config:name="ViewAreaTop"
config:type="int">0</config:config-item></config:config-item-set></office:settings>

2.4.2 Base Settings
The <config:config-item> element contains all base settings. The value of the setting isstored in the element.
385
386
387
388
389
390

<define name="config-config-item"><element name="config:config-item"><ref name="config-config-item-attlist"/><text/></element></define>

Config Name
The config:name attribute identifies the name of the setting.
391
392
393
394
395

<define name="config-config-item-attlist" combine="interleave"><attribute name="config:name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 51 of 738

Config TypeThe config:type attribute identifies the data type of setting.
396
397
398
399
400
401
402
403
404
405
406
407
408
409

<define name="config-config-item-attlist" combine="interleave"><attribute name="config:type"><choice><value>boolean</value><value>short</value><value>int</value><value>long</value><value>double</value><value>string</value><value>datetime</value><value>base64Binary</value></choice></attribute></define>

2.4.3 Index Access of Sequences
The <config:config-item-map-indexed> element is a container element for sequences.
The order specifies the index of the elements
410
411
412
413
414
415
416
417

<define name="config-config-item-map-indexed"><element name="config:config-item-map-indexed"><ref name="config-config-item-map-indexed-attlist"/><oneOrMore><ref name="config-config-item-map-entry"/></oneOrMore></element></define>

Config Name
The config:name attribute identifies the name of the setting sequence.
418
419
420
421
422

<define name="config-config-item-map-indexed-attlist" combine="interleave"><attribute name="config:name"><ref name="string"/></attribute></define>

2.4.4 Map Entry
The <config:config-item-map-entry> element represents an entry in an indexed or
named settings sequence. It is a container element for all types of setting elements.
423
424
425
426
427
428

<define name="config-config-item-map-entry"><element name="config:config-item-map-entry"><ref name="config-config-item-map-entry-attlist"/><ref name="config-items"/></element></define>

Config Name
The config:name attribute identifies the name of the setting sequence.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 52 of 738

429
430
431
432
433
434
435

<define name="config-config-item-map-entry-attlist" combine="interleave"><optional><attribute name="config:name"><ref name="string"/></attribute></optional></define>

2.4.5 Name Access of Sequences
The <config:config-item-map-named> element is a container element for sequences,where each setting in the sequence is identified by its name.
436
437
438
439
440
441
442
443

<define name="config-config-item-map-named"><element name="config:config-item-map-named"><ref name="config-config-item-map-named-attlist"/><oneOrMore><ref name="config-config-item-map-entry"/></oneOrMore></element></define>

Config Name
The config:name attribute identifies the name of the setting sequence.
444
445
446
447
448

<define name="config-config-item-map-named-attlist" combine="interleave"><attribute name="config:name"><ref name="string"/></attribute></define>

2.4.6 Cursor Position Setting
A common view setting for editing applications is the position where the text cursor was whilesaving the document. For WYSIWYG applications, this usually will be a position within aparagraph only. For applications that provide an XML based view of the document, the cursor
position could be also between arbitrary elements, or even within tags.
To represent a text cursor position within a document, a processing instruction with PITarget
opendocument (see §2.6 of [XML1.0]) should be used. The name of the cursor position
processing instruction, cursor-position, shall follow the PITarget opendocument. The
processing instruction may have arbitrary application specific attributes, for instance to connect
the cursor position with a certain view of the document, where the views themselves are specified
as application specific settings. The syntax for these attributes shall be the same as for attributes
within XML start tags.
Where a text cursor position is not sufficient to recreate a document view, applications may use
arbitrary document specific settings in addition to the cursor position processing instruction. They
may also use arbitrary document specific settings if the cursor position is not a text cursor
position, but for instance a selection of drawing objects.
Example: cursor position processing instruction<text:p>This is<?opendocument cursor-position view-id="view1"?> an
example.</text:p>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 53 of 738

2.5 Scripts
A document may contain several scripts in different scripting languages. Each script isrepresented by a <office:script> element. All these script elements are contained in a single<office:scripts> element.
Scripts do not imply a scripting language or an object model. A script can for instance operate on
the Document Object Model (DOM) composed from the XML representation of a document in
OpenDocument format (see [DOM2]), or on an application specific API.
Scripts cannot modify a document while the document is loading. However, some events arecalled immediately after the document is loaded.
In addition to <office:script> elements, the <office:scripts> element may also containan <office:event-listeners> element which contains the events assigned to the document
itself. Examples for these are events called when the document is opened or closed. See section
12.4 for more information on the <office:event-listeners> element.
449
450
451
452
453
454
455
456
457
458
459
460

<define name="office-scripts"><optional><element name="office:scripts"><zeroOrMore><ref name="office-script"/></zeroOrMore><optional><ref name="office-event-listeners"/></optional></element></optional></define>

2.5.1 Script
The <office:script> element contains script language specific content. In most situations,the element contains the source code of the script, but it may also contain a compiled version of
the script or a link to some external script code.
461
462
463
464
465
466
467
468

<define name="office-script"><element name="office:script"><ref name="office-script-attlist"/><mixed><ref name="anyElements"/></mixed></element></define>

Script Language
The attribute script:language specifies the language of the script by its name. Since script
language names are application specific, the name should be preceded by a namespace prefix.
469
470
471
472
473

<define name="office-script-attlist"><attribute name="script:language"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 54 of 738

2.6 Font Face Declarations
A document in OpenDocument format may contain font face declarations. A font face declaration
provides information about the fonts used by the author of a document, so that these fonts or
fonts that are very close to these fonts may be located on other systems. See section 14.6 fordetails.
474
475
476
477
478
479
480
481
482

<define name="office-font-face-decls"><optional><element name="office:font-face-decls"><zeroOrMore><ref name="style-font-face"/></zeroOrMore></element></optional></define>

2.7 Styles
The OpenDocument format supports the following types of styles:•

Common styles
Most office applications support styles within their user interface. Within this specification, theXML representations of such styles are referred to as styles. When a differentiation from theother types of styles is required, they are referred to as common styles. The term common
indicates that this is the type of style that an office application user considers to be a style.

•

Automatic styles
An automatic style contains formatting properties that, in the user interface view of adocument, are assigned to an object such as a paragraph. The term automatic indicates thatthe style is generated automatically. In other words, formatting properties that are immediately
assigned to a specific object are represented by an automatic style. This way, a separation ofcontent and layout is achieved.

•

Master styles
A master style is a common style that contains formatting information and additional content
that is displayed with the document content when the style is applied. An example of a masterstyle are master pages. Master pages can be used in graphical applications. In this case, theadditional content is any drawing shapes that are displayed as the background of the draw
page. Master pages can also be used in text documents. In this case, the additional content is
the headers and footers. Please note that the content that is contained within master styles isadditional content that influences the representation of a document but does not change thecontent of a document.

As far as the office application user is concerned, all types of styles are part of the document.
They represent the output device-independent layout and formatting information that the author ofa document has used to create or edit the document. The assumption is that the author of the
document wants this formatting and layout information to be preserved when the document isreloaded or displayed on any device, because this is common practice for documents created byword processors.
This type of style information differs from [CSS2] or [XSLT] style sheets that are used to display adocument. An additional style sheet for CSS, XSLT, and so on, is required to display a documentin OpenDocument format on a certain device. This style sheet must take into account the styles inthe document as well as the requirements and capabilities of the output device. The ideal case isthat this style sheet depends on the output device only.
See section 14 for more information on styles.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 55 of 738

2.7.1 Location of Styles
Common and automatic styles have the same XML representation, but they are contained within
two distinct container elements, as follows:

483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531

•

<office:styles> for common styles•<office:automatic-styles> for automatic styles•

Master styles are contained within a container element of its own:•

<office:master-styles><define name="office-styles"><optional><element name="office:styles"><interleave><ref name="styles"/><zeroOrMore><ref name="style-default-style"/></zeroOrMore><optional><ref name="text-outline-style"/></optional><zeroOrMore><ref name="text-notes-configuration"/></zeroOrMore><optional><ref name="text-bibliography-configuration"/></optional><optional><ref name="text-linenumbering-configuration"/></optional><zeroOrMore><ref name="draw-gradient"/></zeroOrMore><zeroOrMore><ref name="svg-linearGradient"/></zeroOrMore><zeroOrMore><ref name="svg-radialGradient"/></zeroOrMore><zeroOrMore><ref name="draw-hatch"/></zeroOrMore><zeroOrMore><ref name="draw-fill-image"/></zeroOrMore><zeroOrMore><ref name="draw-marker"/></zeroOrMore><zeroOrMore><ref name="draw-stroke-dash"/></zeroOrMore><zeroOrMore><ref name="draw-opacity"/></zeroOrMore><zeroOrMore><ref name="style-presentation-page-layout"/></zeroOrMore></interleave></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 56 of 738

532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562

</optional></define><define name="office-automatic-styles"><optional><element name="office:automatic-styles"><interleave><ref name="styles"/><zeroOrMore><ref name="style-page-layout"/></zeroOrMore></interleave></element></optional></define><define name="office-master-styles"><optional><element name="office:master-styles"><interleave><zeroOrMore><ref name="style-master-page"/></zeroOrMore><optional><ref name="style-handout-master"/></optional><optional><ref name="draw-layer-set"/></optional></interleave></element></optional></define>

563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593

<define name="styles"><interleave><zeroOrMore><ref name="style-style"/></zeroOrMore><zeroOrMore><ref name="text-list-style"/></zeroOrMore><zeroOrMore><ref name="number-number-style"/></zeroOrMore><zeroOrMore><ref name="number-currency-style"/></zeroOrMore><zeroOrMore><ref name="number-percentage-style"/></zeroOrMore><zeroOrMore><ref name="number-date-style"/></zeroOrMore><zeroOrMore><ref name="number-time-style"/></zeroOrMore><zeroOrMore><ref name="number-boolean-style"/></zeroOrMore><zeroOrMore><ref name="number-text-style"/></zeroOrMore></interleave>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 57 of 738

594</define>

The following examples illustrate the different types of OpenDocument styles.
Example: OpenDocument styles<office:document ...>
<office:styles>...
</office:styles><office:automatic-styles>...
</office:automatic-styles><office:master-styles>...
</office:master-styles></office:document>

2.8 Page Styles and Layout
The style and layout of the pages in a document is determined by:•Page Layouts•

Master Pages

A page layout describes the physical properties or geometry of a page, for example, page size,
margins, header height, and footer height.
A master page is a template for pages in a document. It contains a reference to a page layout
which specifies the physical properties of the page and can also contain static content that isdisplayed on all pages in the document that use the master page. Examples of static content areheaders, footers, or background graphics.
If a text or spreadsheet document is displayed in a paged layout, the master pages are
instantiated to generate a sequence of pages containing the document content. When a masterpage is instantiated, an empty page is generated with the properties of the page master and thestatic content of the master page. The body of the page is then filled with content. If multiple
pages in a document use the same master page, the master page can be instantiated several
times within the document.
In text and spreadsheet documents, a master page can be assigned to paragraph and table styles
using a style:master-page-name attribute. Each time the paragraph or table style is applied
to text, a page break is inserted before the paragraph or table. The page that starts at the page
break position uses the specified master page.
In drawings and presentations, master pages can be assigned to drawing pages using astyle:parent-style-name attribute.
Note: The OpenDocument paging methodology differs significantly from the methodology used in[XSL]. In XSL, headers and footers are contained within page sequences that also contain the
document content. In the OpenDocument format, headers and footers are contained in pagestyles. With either approach, the content of headers and footers can be changed or omitted
without affecting the document content.
Page layouts are described in section 14.3. Master pages are described in section 14.4.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 58 of 738

3 Metadata Elements
The metadata elements borrow heavily upon the metadata standards developed by the Dublin
Core Metadata Initiative (http://www.dublincore.org). Metadata elements drawn directly from the
Dublin Core work use its namespace prefix (see section 1.3).

3.1 Pre-Defined Metadata Elements
There is a set of pre-defined metadata elements which should be processed and updated by theapplications. Metadata elements may be omitted or occur multiple times. It is application-specific
how to update multiple instances of the same elements.

3.1.1 Generator
The <meta:generator> element contains a string that identifies the application or tool that wasused to create or last modify the XML document. This string should match the definition for useragents in the HTTP protocol a specified in section 14.43 of [RFC2616]. The generator string
should allow product versions to differ between all released versions of a user agent, for instanceby including build ids or patch level information.
Conforming applications may use the generator string to work around bugs that exist or existed incertain applications, but shall not deliberately implement a different behavior depending on acertain generator string.
If the application that created the document could not provide an identifier string, the application
does not export this element. If another application modifies the document and it cannot provide a
unique identifier, it shall not export the original identifier belonging to the application that createdthe document.
595
596
597
598
599

<define name="office-meta-data" combine="choice"><element name="meta:generator"><ref name="string"/></element></define>

3.1.2 Title
The <dc:title> element specifies the title of the document.
600
601
602
603
604

<define name="office-meta-data" combine="choice"><element name="dc:title"><ref name="string"/></element></define>

3.1.3 Description
The <dc:description> element contains a brief description of the document.
605
606
607
608
609

<define name="office-meta-data" combine="choice"><element name="dc:description"><ref name="string"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 59 of 738

3.1.4 Subject
The <dc:subject> element specifies the subject of the document.
610
611
612
613
614

<define name="office-meta-data" combine="choice"><element name="dc:subject"><ref name="string"/></element></define>

3.1.5 Keywords
The <meta:keyword> element contains a keyword pertaining to the document. The metadata
can contain any number of <meta:keyword> elements, each element specifying one keyword.
615
616
617
618
619

<define name="office-meta-data" combine="choice"><element name="meta:keyword"><ref name="string"/></element></define>

3.1.6 Initial Creator
The <meta:initial-creator> element specifies the name of the person who created the
document initially.
620
621
622
623
624

<define name="office-meta-data" combine="choice"><element name="meta:initial-creator"><ref name="string"/></element></define>

3.1.7 Creator
The <dc:creator> element specifies the name of the person who last modified the document.
The name of this element was chosen for compatibility with the Dublin Core, but this definition of"creator" used here differs from Dublin Core, which defines creator as "An entity primarily
responsible for making the content of the resource." In OpenDocument terminology, the lastperson to modify the document is primarily responsible for making the content of the document.
625
626
627
628
629
630
631
632

<define name="office-meta-data" combine="choice"><ref name="dc-creator"/></define><define name="dc-creator"><element name="dc:creator"><ref name="string"/></element></define>

3.1.8 Printed By
The <meta:printed-by> element specifies the name of the last person who printed the
document.
633
634
635
636

<define name="office-meta-data" combine="choice"><element name="meta:printed-by"><ref name="string"/></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 60 of 738

637</define>

3.1.9 Creation Date and TimeThe <meta:creation-date> element specifies the date and time when the document was
created initially.
To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss.
638
639
640
641
642

<define name="office-meta-data" combine="choice"><element name="meta:creation-date"><ref name="dateTime"/></element></define>

3.1.10 Modification Date and TimeThe <dc:date> element specifies the date and time when the document was last modified.
To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss.
The name of this element was chosen for compatibility with the Dublin Core.
643
644
645
646
647
648
649
650

<define name="office-meta-data" combine="choice"><ref name="dc-date"/></define><define name="dc-date"><element name="dc:date"><ref name="dateTime"/></element></define>

3.1.11 Print Date and TimeThe <meta:print-date> element specifies the date and time when the document was lastprinted.
To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss.
651
652
653
654
655

<define name="office-meta-data" combine="choice"><element name="meta:print-date"><ref name="dateTime"/></element></define>

3.1.12 Document Template
The <meta:template> element contains a URL for the document template that was used tocreate the document. The URL is specified as an XLink.
This element conforms to the XLink Specification. See [XLink].
The attributes that may be associated with the <meta:template> element are:•Template location•

Template title•

Template modification date and time

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 61 of 738

Template Location
An xlink:href attribute specifies the location of the document template.

Template Title
The xlink:title attribute specifies the name of the document template.

Template Modification Date and TimeThe meta:date attribute specifies the date and time when the template was last modified, prior
to being used to create the current document.
To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss.
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682

<define name="office-meta-data" combine="choice"><element name="meta:template"><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional><optional><attribute name="xlink:title"><ref name="string"/></attribute></optional><optional><attribute name="meta:date"><ref name="dateTime"/></attribute></optional></element></define>

3.1.13 Automatic Reload
The <meta:auto-reload> element specifies whether a document is reloaded or replaced byanother document after a certain period of time has elapsed.
The attributes that may be associated with the <meta:auto-reload> element are:•Reload URL•

Reload delay

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 62 of 738

Reload URL
If a loaded document should be replaced by another document after a certain period of time, the<meta:auto-reload> element is presented as an XLink. An xlink:href attribute identifies
the URL of the replacement document.

Reload Delay
The meta:delay attribute specifies the reload delay.
To conform with the duration data type of [xmlschema-2], the format of the value of this attributeis PnYnMnDTnHnMnS. See §3.2.6 of [xmlschema-2] for more detailed information on this duration
format.
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711

<define name="office-meta-data" combine="choice"><element name="meta:auto-reload"><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:show" a:defaultValue="replace"><value>replace</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onLoad"><value>onLoad</value></attribute></optional><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></optional><optional><attribute name="meta:delay"><ref name="duration"/></attribute></optional></element></define>

3.1.14 Hyperlink Behavior
The <meta:hyperlink-behaviour> element specifies the default behavior for hyperlinks inthe document.
The only attribute that may be associated with the <meta:hyperlink-behaviour> element is:•

Target frame

Target Frame
The meta:target-frame-name attribute specifies the name of the default target frame inwhich to display a document referenced by a hyperlink.
This attribute can have one of the following values:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 63 of 738

•_self : The referenced document replaces the content of the current frame.

•_blank : The referenced document is displayed in a new frame.

•_parent : The referenced document is displayed in the parent frame of the current frame.

•_top : The referenced document is displayed in the topmost frame, that is the frame that
contains the current frame as a child or descendent but is not contained within another frame.

•

A frame name : The referenced document is displayed in the named frame. If the named
frame does not exist, a new frame with that name is created.

To conform with the XLink Specification, an additional xlink:show attribute is attached to the<meta:hyperlink-behaviour> element. If the value of the meta:target-frame-nameattribute is _blank, the xlink:show attribute value is new. If the value of the meta:targetframe-name attribute is any of the other value options, the value of the xlink:show attribute is
replace.
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728

<define name="office-meta-data" combine="choice"><element name="meta:hyperlink-behaviour"><optional><attribute name="office:target-frame-name"><ref name="targetFrameName"/></attribute></optional><optional><attribute name="xlink:show"><choice><value>new</value><value>replace</value></choice></attribute></optional></element></define>

3.1.15 Language
The <dc:language> element specifies the default language of the document.
The manner in which the language is represented is similar to the language tag described in[RFC3066]. It consists of a two or three letter Language Code taken from the ISO 639 standard
optionally followed by a hyphen (-) and a two-letter Country Code taken from the ISO 3166
standard.
729
730
731
732
733

<define name="office-meta-data" combine="choice"><element name="dc:language"><ref name="language"/></element></define>

3.1.16 Editing Cycles
The <meta:editing-cycles> element specifies the number of editing cycles the document
has been through.
The value of this element is incremented every time the document is saved. The element contains
the number of editing cycles as text.
734<define name="office-meta-data" combine="choice">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 64 of 738

735
736
737
738

<element name="meta:editing-cycles"><ref name="nonNegativeInteger"/></element></define>

3.1.17 Editing Duration
The <meta:editing-duration> element specifies the total time spent editing the document.
The duration is represented in the duration data type of [xmlschema-2], that is PnYnMnDTnHnMnS.
See §3.2.6 of [xmlschema-2] for more detailed information on this duration format.
739
740
741
742
743

<define name="office-meta-data" combine="choice"><element name="meta:editing-duration"><ref name="duration"/></element></define>

3.1.18 Document Statistics
The <meta:document-statistic> element specifies the statistics of the document, forexample, the page count, word count, and so on. The statistics are specified as attributes of the<meta:document-statistic> element and the statistics that are exported with the document
depend on the document type and the application used to create the document.
Document
Type

744
745
746

Document Statistics Attributes

Text

meta:page-countmeta:table-countmeta:draw-countmeta:image-countmeta:object-countmeta:ole-object-countmeta:paragraph-countmeta:word-countmeta:character-countmeta:row-countmeta:frame-countmeta:sentence-countmeta:syllable-countmeta:non-whitespace-character-countSpreadsheet

meta:page-countmeta:table-countmeta:image-countmeta:cell-countmeta:object-countGraphic

meta:page-countmeta:image-countmeta:object-count<define name="office-meta-data" combine="choice"><element name="meta:document-statistic"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 65 of 738

747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808

<attribute name="meta:page-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:table-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:draw-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:image-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:ole-object-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:object-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:paragraph-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:word-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:character-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="frame-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="sentence-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="syllable-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="non-whitespace-character-count"><ref name="nonNegativeInteger"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 66 of 738

809
810
811
812
813
814
815
816
817
818
819
820
821
822

</attribute></optional><optional><attribute name="meta:row-count"><ref name="nonNegativeInteger"/></attribute></optional><optional><attribute name="meta:cell-count"><ref name="nonNegativeInteger"/></attribute></optional></element></define>

3.2 User-defined Metadata
The <meta:user-defined> element specifies any additional user-defined metadata for the
document. Each instance of this element can contain one piece of user-defined metadata. The
element contains:•

A meta:name attribute, which identifies the name of the metadata element.

•

An optional meta:value-type attribute, which identifies the type of the metadata element.
The allowed meta types are float, date, time, boolean and string (see also section
6.7.1).

•The value of the element, which is the metadata in the format described in section 6.7.1 asvalue of the office:value attributes for the various data types.

The default type for meta-data elements is string.
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849

<define name="office-meta-data" combine="choice"><element name="meta:user-defined"><attribute name="meta:name"><ref name="string"/></attribute><choice><group><attribute name="meta:value-type"><value>float</value></attribute><ref name="double"/></group><group><attribute name="meta:value-type"><value>date</value></attribute><ref name="dateOrDateTime"/></group><group><attribute name="meta:value-type"><value>time</value></attribute><ref name="duration"/></group><group><attribute name="meta:value-type"><value>boolean</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 67 of 738

850
851
852
853
854
855
856
857
858
859
860
861
862

</attribute><ref name="boolean"/></group><group><attribute name="meta:value-type"><value>string</value></attribute><ref name="string"/></group><text/></choice></element></define>

3.3 Custom Metadata
In addition to the pre-defined metadata elements, applications should also preserve any additional
content found inside the <office:meta> element. As there is no semantics specified for suchforeign content, applications need not process this information other than to preserve it when
editing the document.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 68 of 738

4 Text Content
4.1 Headings, Paragraphs and Basic Text StructureThis section describes the XML elements and attributes that are used to represent heading andparagraph components in a text document.
The elements <text:h> and <text:p> represent headings and paragraphs, respectively, andare collectively referred to as paragraph elements. All text content in an OpenDocument file
must be contained in either of these elements.

4.1.1 Headings
Headings define the chapter structure for a document. A chapter or subchapter begins with aheading and extends to the next heading at the same or higher level.
863
864
865
866
867
868
869
870
871
872
873
874

<define name="text-h"><element name="text:h"><ref name="heading-attrs"/><ref name="paragraph-attrs"/><optional><ref name="text-number"/></optional><zeroOrMore><ref name="paragraph-content"/></zeroOrMore></element></define>

Heading Level
The text:outline-level attribute associated with the heading element determines the levelof the heading, starting with 1. Headings without a level attribute are assumed to be at level 1.
875
876
877
878
879

<define name="heading-attrs" combine="interleave"><attribute name="text:outline-level"><ref name="positiveInteger"/></attribute></define>

Heading Numbering
Header numbering can be changed by additional attributes, similar to those on list items (seesection 4.3.2, below). The numbering of headers can be restarted by setting the text:restartnumbering attribute to true.
880
881
882
883
884
885
886

<define name="heading-attrs" combine="interleave"><optional><attribute name="text:restart-numbering" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 69 of 738

Start Value
The attribute text:start-value may be used to restart the numbering of headers of thecurrent header's level, by setting a new value for the numbering.
887
888
889
890
891
892
893

<define name="heading-attrs" combine="interleave"><optional><attribute name="text:start-value"><ref name="nonNegativeInteger"/></attribute></optional></define>

Suppress Header Numbering
It is sometimes desired to have a specific heading which should not be numbered. This
corresponds to unnumbered list headers in lists (see sections 4.3). To facilitate this, an optional
attribute text:is-list-header can be used. If true, the given header will not be numbered,even if an explicit list-style is given.
894
895
896
897
898
899
900

<define name="heading-attrs" combine="interleave"><optional><attribute name="text:is-list-header" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Formatted Heading Number
If a heading has a numbering applied, the text of the formatted number can be included in a<text:number> element. This text can be used by applications that do not support numbering ofheadings, but it will be ignored by applications that support numbering.
901
902
903
904
905

<define name="text-number"><element name="text:number"><ref name="string"/></element></define>

4.1.2 Paragraphs
Paragraphs are the basic unit of text.
906
907
908
909
910
911
912
913

<define name="text-p"><element name="text:p"><ref name="paragraph-attrs"/><zeroOrMore><ref name="paragraph-content"/></zeroOrMore></element></define>

4.1.3 Common Paragraph Elements Attributes
The paragraph elements have text:style-name, text:class-names and text:condstyle-name attributes. These attributes must reference paragraph styles.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 70 of 738

A text:style-name attribute references a paragraph style, while a text:cond-style-nameattribute references a conditional-style, that is, a style that contains conditions and maps to otherstyles (see section 14.1.1). If a conditional style is applied to a paragraph, the text:stylename attribute contains the name of the style that was the result of the conditional styleevaluation, while the conditional style name itself is the value of the text:cond-style-nameattribute. This XML structure simplifies [XSLT] transformations because XSLT only has toacknowledge the conditional style if the formatting attributes are relevant. The referenced style
can be a common style or an automatic style.
A text:class-names attribute takes a whitespace separated list of paragraph style names. The
referenced styles are applied in the order they are contained in the list. If both, text:stylename and text:class-names are present, the style referenced by the text:style-nameattribute is as the first style in the list in text:class-names. If a conditional style is specified
together with a style:class-names attribute, but without the text:style-name attribute,then the first style in the style list is used as the value of the missing text:style-name attribute.
Conforming applications should support the text:class-names attribute and also shouldpreserve it while editing.
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930

<define name="paragraph-attrs"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><optional><attribute name="text:class-names"><ref name="styleNameRefs"/></attribute></optional><optional><attribute name="text:cond-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Example: Styles and conditional styles<text:p text:style-name="Heading 1">"Heading 1" is not a conditional style.
</text:p><text:p text:style-name="Numbering 1" text:cond-style-name="Text body">"Text body" is a conditional style. If it is contained in a numberedparagraph, it maps to "Numbering 1". This is assumed in this example.
</text:p>

A paragraph may have an ID. This ID can be used to reference the paragraph from otherelements.
931
932
933
934
935

<define name="paragraph-attrs" combine="interleave"><optional><ref name="text-id"/></optional></define>

4.2 Page Sequences
A page sequence element <text:page-sequence> specifies a sequence of master pages thatare instantiated in exactly the same order as they are referenced in the page sequence. If a text

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 71 of 738

document contains a page sequence, it will consist of exactly as many pages as specified.
Documents with page sequences do not have a main text flow consisting of headings andparagraphs as is the case for documents that do not contain a page sequence. Text content isincluded within text boxes for documents with page sequences. The only other content that ispermitted are drawing objects.
Example: Page Sequence<style:automatic-style><style:page-layout name="pm1"><!-- portrait page --></style:page-layout><style:page-layout name="pm2"><!-- landscape page --></style:page-layout></style:automatic-style>...
<style:master-styles><style:master-page name="portrait" style:page-layout-name="pm1"/><style:master-page name="landscape" style:page-layout-name="pm2"/></style:master-styles>...
<office:body><text:page-sequence><text:page text:master-page-name="portrait"/><text:page text:master-page-name="portrait"/><text:page text:master-page-name="landscape"/><text:page text:master-page-name="landscape"/><text:page text:master-page-name="portrait"/></text:page-sequence><draw:frame ...>
<draw:text-box ...>
<text:p>Example text.</text:p>...
</draw:text-box></draw:frame></office:body>
936
937
938
939
940
941
942

<define name="text-page-sequence"><element name="text:page-sequence"><oneOrMore><ref name="text-page"/></oneOrMore></element></define>

4.2.1 Page
The <text:page> element specifies a single page within a page sequence.
943
944
945
946
947
948

<define name="text-page"><element name="text:page"><ref name="text-page-attlist"/><empty/></element></define>

Master Page Name
The text:master-page-name attribute specifies the master page that is instantiated.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 72 of 738

949
950
951
952
953

<define name="text-page-attlist"><attribute name="text:master-page-name"><ref name="styleNameRef"/></attribute></define>

4.3 Lists
The OpenDocument format supports list structures, similar to those found in [HTML4]. A list is aparagraph-level element, which contains an optional list header, followed by a sequence of list
items. The list header and each list item contains a sequence of paragraph or list elements. Lists
can be nested.
Lists may be numbered. The numbering may be restarted with a specific numbering at each list
item. Lists may also continue numbering from other lists, allowing the user to merge several lists
into a single, discontinuous list. Note that whether the list numbering is displayed depends on asuitable list style being used.
In addition to this structural information, lists can have list styles associated with them, whichcontain the relevant layout information, such as•

the type of list item label, such as bullet or number,•list item label width and distance,•bullet character or image (if any),•

number format for the bullet numbering (if any),•

paragraph indent for list items.

4.3.1 List Block
A list is represented by the <text:list> element. It contains an optional list header, followed byany number of list items.
Every list has a list level, which is determined by the nesting of the <text:list> elements. If alist is not contained within another list, the list level is 1. If the list in contained within another list,
the list level is the list level of the list in which is it contained incremented by one. If a list is
contained in a table cell or text box, the list level returns to 1, even though the table or textbox
itself may be nested within another list.
The attributes that may be associated with the list element are:

954
955
956
957
958
959
960
961
962
963
964

•

Style name•Continue numbering<define name="text-list"><element name="text:list"><ref name="text-list-attr"/><optional><ref name="text-list-header"/></optional><zeroOrMore><ref name="text-list-item"/></zeroOrMore></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 73 of 738

Style Name
The optional text:style-name attribute specifies the name of the list style that is applied to
the list.
If this attribute is not included and therefore no list style is specified, one of the following actions istaken:•

If the list is contained within another list, the list style defaults to the style of the surrounding
list.

•

If there is no list style specified for the surrounding list, but the list contains paragraphs thathave paragraph styles attached specifying a list style, this list style is used for any of theseparagraphs.

•

A default list style is applied to any other paragraphs.

To determine which formatting properties are applied to a list, the list level and list style name aretaken into account. See section 14.10 for more information on list formatting properties.
965
966
967
968
969
970
971

<define name="text-list-attr" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Continue Numbering
By default, the first list item in a list starts with the number specified in the list style. The continue
numbering attribute can be used to continue the numbering from the preceding list.
This attribute can be used with the <text:list> element and can have a value of true or
false.
If the value of the attribute is true and the numbering style of the preceding list is the same as
the current list, the number of the first list item in the current list is the number of the last item inthe preceding list incremented by one.
972
973
974
975
976
977
978

<define name="text-list-attr" combine="interleave"><optional><attribute name="text:continue-numbering"><ref name="boolean"/></attribute></optional></define>

4.3.2 List Item
List items contain the textual content of a list. A <text:list-item> element can containparagraphs, headings, lists or soft page breaks. A list item cannot contain tables.
979
980
981
982
983
984
985

<define name="text-list-item"><element name="text:list-item"><ref name="text-list-item-attr"/><ref name="text-list-item-content"/></element></define><define name="text-list-item-content">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 74 of 738

986
987
988
989
990
991
992
993
994
995
996
997

<optional><ref name="text-number"/></optional><zeroOrMore><choice><ref name="text-p"/><ref name="text-h"/><ref name="text-list"/><ref name="text-soft-page-break"/></choice></zeroOrMore></define>

The first line in a list item is preceded by a bullet or number, depending on the list style assigned
to the list. If a list item starts another list immediately and does not contain any text, no bullet or
number is displayed.
The only attribute that may be associated with the <text:list-item> element is:•

Start value

Start Value
The numbering of the current list can be restarted at a certain number. The text:start-value
attribute is used to specify the number with which to restart the list.
This attribute can only be applied to items in a list with a numbering list style. It restarts thenumbering of the list at the current item.
998
999
1000
1001
1002
1003
1004

<define name="text-list-item-attr" combine="interleave"><optional><attribute name="text:start-value"><ref name="nonNegativeInteger"/></attribute></optional></define>

Formatted Number
If a list item has a numbering applied, the text of the formatted number can be included in a<text:number> element. This text can be used by applications that do not support numbering,but it will be ignored by applications that support numbering. See also section 4.1.1.
Example: Lists and sublists<text:list text:style-name="List 1"><text:list-item><text:p>This is the first list item</text:p><text:p>This is a continuation of the first list item.</text:p></text:list-item><text:list-item><text:p>This is the second list item.
It contains a sub list.</text:p><text:list><text:list-item><text:p>This is a sub list item.</text:p></text:list-item><text:list-item><text:p>This is a sub list item.</text:p></text:list-item><text:list-item><text:p>This is a sub list item.</text:p></text:list-item></text:list>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 75 of 738

</text:list-item><text:list-item><text:p>This is the third list item</text:p></text:list-item></text:list>

4.3.3 List Header
A list header is a special kind of list item. It contains one or more paragraphs that are displayed
before a list. The paragraphs are formatted like list items but they do not have a preceding
number or bullet. The list header is represented by the list header element.
1005
1006
1007
1008
1009

<define name="text-list-header"><element name="text:list-header"><ref name="text-list-item-content"/></element></define>

4.3.4 Numbered Paragraphs
In some instances, it is desirable to specify a list not as a structural element comprising of several
list items, but to determine on a per-paragraph level whether the paragraph is numbered, and atwhich level. To facilitate this, the <text:numbered-paragraph> element allows the numberingof an individual paragraph, as if it was part of a list at a specified level.
Numbered paragraphs may use the same continuous numbering properties that list items use,
and thus form an equivalent, alternative way of specifying lists. A list in <text:list>
representation could be converted into a list in <text:numbered-paragraph> representationand vice versa.
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021

<define name="text-numbered-paragraph"><element name="text:numbered-paragraph"><ref name="text-numbered-paragraph-attr"/><optional><ref name="text-number"/></optional><choice><ref name="text-p"/><ref name="text-h"/></choice></element></define>

A numbered paragraph can be assigned a list level. A numbered paragraph is equivalent to a list
nested to the given level, containing one list item with one paragraph. If no level is given, thenumbered paragraph is interpreted as being on level 1.
1022
1023
1024
1025
1026
1027
1028

<define name="text-numbered-paragraph-attr" combine="interleave"><optional><attribute name="text:level" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

As a numbered paragraph combines the functionality of a (possibly nested) list with a single list
item, it can also use the attributes of those elements.
1029
1030

<define name="text-numbered-paragraph-attr" combine="interleave"><ref name="text-list-attr"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 76 of 738

1031
1032
1033
1034

</define><define name="text-numbered-paragraph-attr" combine="interleave"><ref name="text-list-item-attr"/></define>

The text of a formatted number can be included in a <text:number> element. This text can beused by applications that do not support numbering, but it will be ignored by applications that
support numbering. See also section 4.1.1.

4.4 Text Sections
A text section is a named region of paragraph-level text content. Sections start and end on
paragraph boundaries and can contain any number of paragraphs.
Sections have two uses in the OpenDocument format: They can be used to assign certain
formatting properties to a region of text. They can also be used to group text that is automaticallyacquired from some external data source.
In addition to Sections can contain regular text content or the text can be contained in another fileand linked to the section. Sections can also be write-protected or hidden.
Sections can have settings for text columns, background color or pattern, and notes configuration.
These settings form the section style, which is represented in a <style:style> element. See
section 14.8.3 for details.
The formatting properties for sections are explained in section 15.7.
Sections support two ways of linking to external content. If a section is linked to anotherdocument, the link can be through one of the following:•

A resource identified by an XLink, represented by a text:section-source element•

Dynamic Data Exchange (DDE), represented by a office:dde-source element

Linking information for external content is contained in the section element's first child. A sectionthat links to external content contains the full representation of the data source, so that processors
need to understand the linking information only if they wish to update the contents of the section.
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047

<define name="text-section"><element name="text:section"><ref name="text-section-attr"/><choice><ref name="text-section-source"/><ref name="text-section-source-dde"/><empty/></choice><zeroOrMore><ref name="text-content"/></zeroOrMore></element></define>

Note: List items may not contain sections. Thus, lists may only be wholly contained within section
elements. If it is desired to achieve the effect of overlapping lists and sections, or of sections
contained within lists, the lists must be split into several lists, each of which would then be wholly
contained within a section. When splitting the list, suitable attributes for continuous numbering
should be set such that display and behavior are the same as with the original list not interrupted
by sections.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 77 of 738

4.4.1 Section Attributes
Text indices, described in chapter 7, may be considered a special kind of text section, as theyshare the same general structure as well as certain attributes. These are combined in thefollowing definition:
1048
1049
1050

<define name="text-section-attr" combine="interleave"><ref name="sectionAttr"/></define>

The remaining attributes in this section are specific to the <text:section> element.

Section Style
The text:style-name attribute refers to a section style.
1051
1052
1053
1054
1055
1056
1057

<define name="sectionAttr" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Section Name
Every section must have a name that uniquely identifies the section. The text:name attributecontains the name of the section.
1058
1059
1060
1061
1062

<define name="sectionAttr" combine="interleave"><attribute name="text:name"><ref name="string"/></attribute></define>

Protected Sections
A section can be protected, which means that a user can not edit the section. The
text:protected attribute indicates whether or not a section is protected. The user interface
must enforce the protection attribute if it is enabled.
1063
1064
1065
1066
1067
1068
1069

<define name="sectionAttr" combine="interleave"><optional><attribute name="text:protected"><ref name="boolean"/></attribute></optional></define>

A user can use the user interface to reset the protection flag, unless the section is further
protected by a password. In this case, the user must know the password in order to reset theprotection flag. The text:protection-key attribute specifies the password that protects thesection. To avoid saving the password directly into the XML file, only a hash value of thepassword is stored.
1070
1071
1072
1073
1074

<define name="sectionAttr" combine="interleave"><optional><attribute name="text:protection-key"><ref name="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 78 of 738

1075
1076

</optional></define>

Hidden Sections and Conditional Sections
Sections can be hidden based on a condition or they can be hidden unconditionally.
The text:display attribute specifies whether or not the section is hidden. The value of this
attribute can be:•true, the section is displayed. This is the default setting.

•none, the section is hidden unconditionally.

•

condition, the section is hidden under the condition specified in the text:condition
attribute.

The text:condition attribute specifies the condition under which the section is hidden. The
condition is encoded as a string. If the value of text:display is condition, thetext:condition attribute must be present.
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095

<define name="text-section-attr" combine="interleave"><choice><attribute name="text:display"><choice><value>true</value><value>none</value></choice></attribute><group><attribute name="text:display"><value>condition</value></attribute><attribute name="text:condition"><ref name="string"/></attribute></group><empty/></choice></define>

4.4.2 Section Source
The <text:section-source> element indicates that the enclosed section is a linked section. If
this element is used, it must be the first element in the <text:section> element.
1096
1097
1098
1099
1100

<define name="text-section-source"><element name="text:section-source"><ref name="text-section-source-attr"/></element></define>

The attributes that may be associated with the <text:section-source> attribute are:•

Section source URL•

Name of linked section•

Filter name

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 79 of 738

Section Source URL
These attributes identify the document or section to which the section is linked. The name of thetarget section is identified by the local part of the URL, following the hash mark. The xlink:href
attribute is implied because <text:section-source> elements may also link to internal
sections.
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117

<define name="text-section-source-attr" combine="interleave"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:show" a:defaultValue="embed"><value>embed</value></attribute></optional></optional></define>

Name of Linked Section
If the link targets a section of a document, the attribute text:section name contains the nameof the target section. If the attribute is not present, the link targets the entire document.
1118
1119
1120
1121
1122
1123
1124

<define name="text-section-source-attr" combine="interleave"><optional><attribute name="text:section-name"><ref name="string"/></attribute></optional></define>

Filter Name
The text:filter-name attribute specifies which filter type was used to import the link target.
The value of this attribute is implementation dependent.
1125
1126
1127
1128
1129
1130
1131

<define name="text-section-source-attr" combine="interleave"><optional><attribute name="text:filter-name"><ref name="string"/></attribute></optional></define>

4.4.3 DDE Source
If sections are linked via DDE, their linking information is represented by <office:ddesource> elements. It contains attributes that specify the application, topic and item of the DDE
connection. Note that because the section contains the XML rendition of the DDE link's content,
this information only needs to be processed if updated data from the DDE link are desired.
See section 12.6 for the use of DDE connections.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 80 of 738

1132
1133
1134

<define name="text-section-source-dde"><ref name="office-dde-source"/></define>

4.5 Page-bound graphical content
Within text documents, images, embedded objects and other drawing objects appear at the levelof a paragraph if they are anchored to a page rather than to a paragraph or a character position
within a paragraph. See section 9.2 for details on drawing objects, and section 9.2.16 for theiranchoring.

4.6 Change Tracking
This section describes how changes in text documents can be represented.

4.6.1 Tracked Changes
All tracked changes to text documents are stored in a list. The list contains an element for eachchange made to the document. If the <text:tracked-changes> element is absent, change
tracking is not enabled.
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144

<define name="text-tracked-changes"><optional><element name="text:tracked-changes"><ref name="text-tracked-changes-attr"/><zeroOrMore><ref name="text-changed-region"/></zeroOrMore></element></optional></define>

Track Changes
This attribute determines whether or not user agents should track and record changes for thisdocument.
1145
1146
1147
1148
1149
1150
1151

<define name="text-tracked-changes-attr" combine="interleave"><optional><attribute name="text:track-changes" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

4.6.2 Changed Regions
For every changed region of a document, there is one entry in the list of tracked changes. This
entry contains a list of all changes that were applied to the region. The start and end of this region
are marked by the start and end elements that are described in the next section.
1152
1153
1154
1155
1156
1157

<define name="text-changed-region"><element name="text:changed-region"><ref name="text-changed-region-attr"/><ref name="text-changed-region-content"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 81 of 738

Change ID
Every element has an ID. The elements that mark the start and end of a region use this ID to
identify the region to which they belong.
1158
1159
1160
1161
1162

<define name="text-changed-region-attr" combine="interleave"><attribute name="text:id"><ref name="ID"/></attribute></define>

4.6.3 Insertion
The <text:insertion> element contains the information that is required to identify any
insertion of content. This content can be a piece of text within a paragraph, a whole paragraph, ora whole table. The inserted content is part of the text document itself and is marked by a change
start and a change end element.
1163
1164
1165
1166
1167

<define name="text-changed-region-content" combine="choice"><element name="text:insertion"><ref name="office-change-info"/></element></define>

Example: Insertion of text
<text:tracked-changes><text:changed-region text:id="c001"><text:insertion><office:change-info><dc:creator>Michael Brauer</dc:creator><dc:date>1999-05-18T12:56:04</dc:date></office:change-info></text:insertion></text:changed-region></text:tracked-changes><text:p>This is the original text<text:change-start text:change-id="c001"/>,
but this has been added<text:change-end text:change-id="c001"/>.
</text:p>4.6.4 Deletion
A <text:deletion> element contains content that was deleted while change tracking was
enabled. The position where the text was deleted is marked by the change position element.
If part of a paragraph was deleted, the text that was deleted is contained in this element as aparagraph element. If the deleted text is reinserted into the document, the paragraph is joined withthe paragraph where the deletion took place.
1168
1169
1170
1171
1172
1173
1174
1175

<define name="text-changed-region-content" combine="choice"><element name="text:deletion"><ref name="office-change-info"/><zeroOrMore><ref name="text-content"/></zeroOrMore></element></define>

Example: Deletion of text

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 82 of 738

<text:tracked-changes><text:changed-region text:id="c002"><text:deletion><office:change-info><dc:creator>Michael Brauer</dc:creator><dc:date>1999-05-18T12:56:04</dc:date></office:change-info><text:p>, but this has been deleted</text:p></text:deletion></text:changed-region></text:tracked-changes><text:p>This is the original text<text:change text:region-id="c002"/>.
</text:p>This example shows:•

Deleted text = , but this has been deletedThis text is contained in the <text:p> element within the <text:deletion> element.

•

Current text = This is the original text.
This text is contained in the <text:p> element at the end of the example.

•

Original text before deletion took place = This is the original text, but thishas been deleted.

Note that the deleted text, like all text in the OpenDocument format, is contained in a paragraphelement. To reconstruct the original text, this paragraph is merged with its surrounding. In otherwords, a deletion consisting of only a single word would be represented as a paragraph containing
the word.
To reconstruct the text before the deletion took place, do:•

If the change mark is inside a paragraph, insert the text content of the <text:deletion> element
as if the beginning <text:p> and final </text:p> tags were missing.

•If the change mark is inside a header, proceed as above, except adapt the end tags to match
their new counterparts.

•

Otherwise, simply copy the text content of the <text:deletion> element in place of the change
mark.

Example: Given the following change:<text:changed-region text:id="example"><text:deletion><office:change-info>...</office:change-info><text:p>Hello</text:p><text:p>World!</text:p></text:deletion></text:changed-region>

The first (and most common) case occurs if a change mark is inside a regular paragraph:<text:p>abc<text:change text:id="example/>def</text:p>

To reconstruct the original text, the two <text:p> elements are copied to replace the change mark,except the beginning and ending tags are missing:<text:p>abcHello</text:p><text:p>World!def</text:p>

If the change mark occurred inside a header, the same procedure is followed, except the copied
tags are adapted to make sure we still have well-formed XML.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 83 of 738

<text:h>abc<text:change text:id="example/>def</text:h>becomes:<text:h>abcHello</text:h><text:h>World!def</text:h>

The third case occurs when a change occurs outside of a paragraph. In this case, the deleted text
is simply copied verbatim.
<text:p>abcdef</text:p><text:change text:id="example/><text:p>ghijkl</text:p>This becomes:<text:p>abcdef</text:p><text:p>Hello</text:p><text:p>World!</text:p><text:p>ghijkl</text:p>

If, in the first two cases, the deletion contains complete paragraphs, then additional empty
paragraphs must be put into the <text:deletion> element to achieve the desired result.
The change that took place from<text:p>abc</text:p><text:h>Hello</text:h><text:h>World!</text:h><text:p>def</text:p>to<text:p>abc<text:change text:id="example/>def</text:p>would be represented as:<text:changed-region text:id="example"><text:deletion><office:change-info>...</office:change-info><text:p/><text:h>Hello</text:h><text:h>World!</text:h><text:p/></text:deletion></text:changed-region>

4.6.5 Format Change
A format change element represents any change in formatting attributes. The region where thechange took place is marked by a change start and a change end element.
1176
1177
1178
1179
1180

<define name="text-changed-region-content" combine="choice"><element name="text:format-change"><ref name="office-change-info"/></element></define>

Note: A format change element does not contain the actual changes that took place.

4.6.6 Change Info
The change info element contains meta information who made the change and when. It is also
used for spreadsheet documents, and thus described in a section 12.3 (Change Tracking
Metadata).

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 84 of 738

4.6.7 Change Marks
There are three elements that mark the start and the end of a changed region, as follows:•

Change start element – <text:change-start>
This element marks the start of a region with content where text has been inserted or theformat has been changed.

•

Change end element – <text:change-end>
This element marks the end of a region with content where text has been inserted or theformat has been changed.

•

Change position element – <text:change>
This element marks a position in an empty region where text has been deleted.

All three elements have an attribute that specifies the ID of the region to which they belong.
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198

<define name="change-marks"><choice><element name="text:change"><ref name="change-mark-attr"/></element><element name="text:change-start"><ref name="change-mark-attr"/></element><element name="text:change-end"><ref name="change-mark-attr"/></element></choice></define><define name="change-mark-attr"><attribute name="text:change-id"><ref name="IDREF"/></attribute></define>

4.7 Soft Page BreakThe <text:soft-page-break> element represents a soft page break.
See section 2.3.1:Use Soft Page BreaksUse Soft Page Breaks for details regarding soft page
breaks.
1199
1200
1201
1202
1203

<define name="text-soft-page-break"><element name="text:soft-page-break"><empty/></element></define>

4.8 Text Declarations
Several text elements need per-document declarations before they can be used. For example,
variable fields require that the variables used are being declared at the beginning of the
document. These declarations are collected at the beginning of a text document. All suchdeclarations are optional. The detailed description for each declaration can be found in theappropriate chapter.
The supported text declarations are:•variable declarations – These declarations are used for variable fields. (cf. section 6.3.1).

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 85 of 738

1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236

•

user field declarations – These declarations are used for user-defined fields (cf. section 6.3.5).

•

sequence declarations – These declarations are used for sequence fields (cf. section 6.3.8).

•

DDE connections – These declarations are used for DDE fields and DDE sections (cf. sections
6.6.9 and 4.4.3, respectively).

•

auto mark file – This declaration is used for generation of alphabetical indices (cf. section
7.8.2).

<define name="text-decls"><optional><element name="text:variable-decls"><zeroOrMore><ref name="text-variable-decl"/></zeroOrMore></element></optional><optional><element name="text:sequence-decls"><zeroOrMore><ref name="text-sequence-decl"/></zeroOrMore></element></optional><optional><element name="text:user-field-decls"><zeroOrMore><ref name="text-user-field-decl"/></zeroOrMore></element></optional><optional><element name="text:dde-connection-decls"><zeroOrMore><ref name="text-dde-connection-decl"/></zeroOrMore></element></optional><optional><ref name="text-alphabetical-index-auto-mark-file"/></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 86 of 738

5 Paragraph Elements Content
5.1 Basic Text Content
Paragraph element's children make up the text content of any document. All text contained in aparagraph element or their children is text content, with few exceptions detailed later. This should
significantly ease transformations into other formats, since transformations may ignore any childelements of paragraph elements and only process their text content, and still obtain a faithfulrepresentation of text content.
Text content elements that do not contain in-line text children are:•(foot- and end-)notes (see section 5.3)
Foot- and endnotes contain text content, but are typically displayed outside the main text
content, e.g., at the end of a page or document.

•rubies (see section 5.4)
Ruby texts are usually displayed above or below the main text.

•

annotations (see section 5.5)
Annotations are typically not displayed.

1237
1238
1239

<define name="paragraph-content" combine="choice"><text/></define>

5.1.1 White-space Characters
If the paragraph element or any of its child elements contains white-space characters, they arecollapsed. Leading white-space characters at the paragraph start as well as trailing white-spacecharacters at the paragraph end are ignored. In detail, the following conversions take place:
The following [UNICODE] characters are normalized to a SPACE character:•

HORIZONTAL TABULATION (0x0009)•

CARRIAGE RETURN (0x000D)•

LINE FEED (0x000A)•

SPACE (0x0020)

In addition, these characters are ignored if the preceding character is a white-space character.
The preceding character can be contained in the same element, in the parent element, or in thepreceding sibling element, as long as it is contained within the same paragraph element and theelement in which it is contained processes white-space characters as described above. Whitespace characters at the start or end of the paragraph are ignored, regardless whether they arecontained in the paragraph element itself, or in a child element in which white-space characters
are collapsed as described above.
These white-space processing rules shall enable authors to use white-space characters to
improve the readability of the XML source of an OpenDocument document in the same way as
they can use them in HTML.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 87 of 738

White-space processing takes place within the following elements:•<text:p>•<text:h>•<text:span>•<text:a>•<text:ref-point>•<text:ref-point-start>•<text:ref-point-end>•<text:bookmark>•<text:bookmark-start>•<text:bookmark-end>

Note: In [XSL], white-space processing of a paragraph of text can be enabled by attaching an
fo:white-space="collapse" attribute to the <fo:block> element that corresponds to theparagraph element.

, in other words they are processed in the same way that [HTML4] processes them.

Space Character
In general, consecutive white-space characters in a paragraph are collapsed. For this reason,
there is a special XML element used to represent the [UNICODE] character SPACE (0x0020).
This element uses an optional attribute called text:c to specify the number of SPACE
characters that the element represents. A missing text:c attribute is interpreted as meaning asingle SPACE character.
This element is required to represent the second and all following SPACE characters in asequence of SPACE characters. It is not an error if the character preceding the element is not awhite-space character, but it is good practice to use this element for the second and all following
SPACE characters in a sequence. This way, an application recognizes a single space character
without recognizing this element.
1240
1241
1242
1243
1244
1245
1246
1247
1248

<define name="paragraph-content" combine="choice"><element name="text:s"><optional><attribute name="text:c"><ref name="nonNegativeInteger"/></attribute></optional></element></define>

Tab Character
The <text:tab> element represents the [UNICODE] tab character HORIZONTALTABULATION (0x0009) in a heading or paragraph. A <text:tab> element reserves space fromthe current position up to the next tab-stop, as defined in the paragraph's style information.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 88 of 738

1249
1250
1251
1252
1253

<define name="paragraph-content" combine="choice"><element name="text:tab"><ref name="text-tab-attr"/></element></define>

To determine which tab-stop a tab character will advance to requires layout information. To makeit easier for non-layout oriented processors to determine this information, applications may
generate a text:tab-ref attribute as a hint that associates a tab character with a tab-stop in thecurrent paragraph style. It contains the number of the tab-stop that the tab character refers to. The
position 0 has a special meaning and signifies the start margin of the paragraph.
1254
1255
1256
1257
1258
1259
1260

<define name="text-tab-attr"><optional><attribute name="text:tab-ref"><ref name="nonNegativeInteger"/></attribute></optional></define>

Note: The text:tab-ref attribute is only a hint to help non-layout oriented processors to determine
the tab/tab-stop association. Layout oriented processors should determine the tab positions solely
based on the style information.

Line Breaks
The <text:line-break> element represents a line break in a heading or paragraph.
1261
1262
1263
1264
1265

<define name="paragraph-content" combine="choice"><element name="text:line-break"><empty/></element></define>

Soft Page BreakThe <text:soft-page-break> element represents a soft page break within a heading orparagraph.
See section 2.3.1:Use Soft Page BreaksUse Soft Page Breaks for details regarding soft page
breaks.
1266
1267
1268

<define name="paragraph-content" combine="choice"><ref name="text-soft-page-break"/></define>

5.1.2 Soft Hyphens, Hyphens, and Non-breaking Blanks
Soft hyphens, hyphens, and non-breaking blanks are represented by [UNICODE] characters.
The [UNICODE] character...
SOFT HYPHEN (00AD)

Represents...
soft hyphens

NON-BREAKING HYPHEN (2011) non-breaking hyphens
NO-BREAK SPACE (00A0)

non-breaking blanks

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 89 of 738

5.1.3 Attributed Text
The <text:span> element represents portions of text that are attributed using a certain text
style or class. The content of this element is the text that uses the text style.
The name of the a text style or text class is the value of a text:style-name or text:classnames attributes, respectively, attached to the <text:span> element. These attributes mustrefer to text styles or classes.
A text:style-name attribute references a single text style. A text:class-names attribute takes awhitespace separated list of text style names. The referenced text styles are applied in the order
they are contained in the list. If both, text:style-name and text:class-names are present,
the style referenced by the text:style-name attribute is treated as the first style in the list in
text:class-names. Conforming application should support the text:class-names attributeand also should preserve it while editing.
<text:span> elements can be nested.
White-space characters contained in this element are collapsed.
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285

<define name="paragraph-content" combine="choice"><element name="text:span"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><optional><attribute name="text:class-names"><ref name="styleNameRefs"/></attribute></optional><zeroOrMore><ref name="paragraph-content"/></zeroOrMore></element></define>

Example: Text style in OpenDocument documents:<text:p>
The last word of this sentence is<text:span text:style-name="emphasize">emphasized</text:span>.
</text:p>5.1.4 Hyperlinks
Hyperlinks in text documents are represented by a <text:a> element.
This element also contains an event table element, <office:event-listeners>, whichcontains the events assigned to the hyperlink. See section 12.4 for more information on the event
table element.
1286
1287
1288
1289
1290
1291
1292
1293

<define name="paragraph-content" combine="choice"><element name="text:a"><ref name="text-a-attlist"/><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="paragraph-content"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 90 of 738

1294
1295
1296

</zeroOrMore></element></define>

The attributes that may be associated with the <text:a> element are:
•

Name

•

Link location•

Target frame•

Text styles

Name
A hyperlink can have a name, but it is not essential. The office:name attribute specifies thename of the hyperlink if one exists. This name can serve as a target for some other hyperlinks.
1297
1298
1299
1300
1301
1302
1303

<define name="text-a-attlist" combine="interleave"><optional><attribute name="office:name"><ref name="string"/></attribute></optional></define>

Title
The office:title attribute specifies a short accessible description for hint text.
See appendix E for guidelines how to use this attribute.
1304
1305
1306
1307
1308
1309
1310

<define name="text-a-attlist" combine="interleave"><optional><attribute name="office:title"><ref name="string"/></attribute></optional></define>

Link Location
The xlink:href attribute specifies the URL for the target location of the link.
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325

<define name="text-a-attlist" combine="interleave"><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 91 of 738

Target Frame
The office:target-frame-name attribute specifies the target frame of the link. This attribute
can have one of the following values:•_self – The referenced document replaces the content of the current frame.

•_blank – The referenced document is displayed in a new frame.

•_parent – The referenced document is displayed in the parent frame of the current frame.

•_top – The referenced document is displayed in the uppermost frame, that is the frame that
contains the current frame as a child or descendent but is not contained within another frame.

•

A frame name – The referenced document is displayed in the named frame. If the named
frame does not exist, a new frame with that name is created.

To conform with the XLink Specification, an additional xlink:show attribute is attached to the<text:a> element. If the value of the attribute is _blank, the xlink:show attribute value isnew. If the value of the attribute is any of the other value options, the value of the xlink:show
attribute is replace. See [XLink].
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340

<define name="text-a-attlist" combine="interleave"><optional><attribute name="office:target-frame-name"><ref name="targetFrameName"/></attribute></optional><optional><attribute name="xlink:show"><choice><value>new</value><value>replace</value></choice></attribute></optional></define>

Text Styles
Every hyperlink has two text styles as follows:

1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352

•

If the link location of the hyperlink was not visited, the text style specifies by the
text:style-name attribute is applied to the text of the hyperlink.

•

If the link location of the hyperlink was already visited, the text style specified by the
text:visited-style-name attribute is applied to the text of the hyperlink<define name="text-a-attlist" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><optional><attribute name="text:visited-style-name"><ref name="styleNameRef"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 92 of 738

5.2 Bookmarks and References
5.2.1 Bookmarks
Bookmarks can either mark a text position or a text range. A text range can start at any text
position and end at another text position. In particular, a bookmark can start in the middle of one
paragraph and end in the middle of another paragraph. The XML element used to represent a
bookmark varies depending on the type of bookmark, as follows:•<text:bookmark> – to mark one text position•<text:bookmark-start> – to mark the start position in a text range•<text:bookmark-end> – to mark the end position in a text range

For every <text:bookmark-start> element, there must be a <text:bookmark-end>
element in the same text flow using the same text:name attribute, and vice versa. The<text:bookmark-start> element must precede the <text:bookmark-end> element.
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371

<define name="paragraph-content" combine="choice"><choice><element name="text:bookmark"><attribute name="text:name"><ref name="string"/></attribute></element><element name="text:bookmark-start"><attribute name="text:name"><ref name="string"/></attribute></element><element name="text:bookmark-end"><attribute name="text:name"><ref name="string"/></attribute></element></choice></define>

Example: Bookmarks<text:p><text:bookmark text:name="Mark 1"/>There is a text mark in front of thisparagraph.
<text:bookmark-start text:name="Mark 2"/>In front of this paragraph thereisthe start of a bookmark.
</text:p><text:p>This bookmark ends
<text:bookmark-end text:name="Mark 2"/>amid this sentence.
</text:p>5.2.2 References
The representation of references is modeled on the XML representation of bookmarks. There are
two types of reference marks, as follows:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 93 of 738

•

A point reference
A point reference marks a particular position in text and is represented by a single<text:reference-mark> element.

•

A range reference
A range reference marks a range of characters in text and is represented by two elements;<text:reference-mark-start> to mark the start of the range and <text:referencemark-end> to mark the end of the range.

Every reference is identified by its name, which must be unique. In a range reference, the startand end elements must use the same reference name.

Point References
The <text:reference-mark> element represents a point reference.
1372
1373
1374
1375
1376
1377
1378

<define name="paragraph-content" combine="choice"><element name="text:reference-mark"><attribute name="text:name"><ref name="string"/></attribute></element></define>

Range References
The <text:reference-mark-start> and <text:reference-mark-end> elements
represent a range reference.
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392

<define name="paragraph-content" combine="choice"><choice><element name="text:reference-mark-start"><attribute name="text:name"><ref name="string"/></attribute></element><element name="text:reference-mark-end"><attribute name="text:name"><ref name="string"/></attribute></element></choice></define>

In the OpenDocument schema, three elements are used to represent references instead of one
element because references represented as a single XML element:•

Cannot support overlapping references•

Do not interact well with other elements

Take the following example:
Example: Overlapping range references<text:p><text:reference-mark-start text:name="first"/>This is an<text:reference-mark-start text:name="second"/>example of a sentence<text:reference-mark-end text:name="first"/>with overlapping
references.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 94 of 738

<text:reference-mark-end text:name="second"/></text:p>

The example paragraph shows two references that cover the following text:
reference “first”“This is an example of a sentence”

reference “second” “example of a sentence with overlapping references.”
This overlapping structure cannot be represented using a single reference element to contain thereferenced text. Similarly, a reference spanning multiple paragraphs creates the same situation as
two overlapping XML elements, as does character formatting either starts or ends, but not both,within the referenced text.

5.3 Notes
Notes consist of a <text:note> element which occurs in the text stream at the position to which
the note is anchored. How notes are numbered and rendered is determined by <text:notesconfiguration> element, which occurs inside the <office:styles> section.

5.3.1 Note Element
The note element represents text notes which are attached to a certain text position. A common
implementation of this concept are the footnotes and endnotes found in most word processors. A
note contains a note citation element and a note body elements, which contains the note'scontent.
In OpenDocument documents, notes are represented in a similar fashion to footnotes in [XSL]. In
XSL, the first child of the note element contains the citation in the form of an <fo:inline>
element. The OpenDocument schema uses the same structure but introduces a <text:notecitation> element. The second child contains the note body, just as in XSL.
Additionally, OpenDocument features <text:notes-configuration> elements. To achieve asimilar effect to the note configuration in XSL, every note citation element must be formatted
appropriately.
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415

<define name="paragraph-content" combine="choice"><element name="text:note"><ref name="text-note-class"/><optional><attribute name="text:id"><ref name="string"/></attribute></optional><element name="text:note-citation"><optional><attribute name="text:label"><ref name="string"/></attribute></optional><text/></element><element name="text:note-body"><zeroOrMore><ref name="text-content"/></zeroOrMore></element></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 95 of 738

Note Class
Each note belongs to a class which determines how the note is expected to be rendered.
Currently, two note classes are supported: Footnotes and endnotes.
1416
1417
1418
1419
1420
1421
1422
1423

<define name="text-note-class"><attribute name="text:note-class"><choice><value>footnote</value><value>endnote</value></choice></attribute></define>

Footnote Reference ID
The footnote reference ID is used by references to footnotes to identify the footnote that isreferenced.

Note Citation Element
The <text:note-citation> element contains the formatted note citation element, either as aformatted number or a string.

Note Label
Note citation elements can be labeled or numbered. If they are numbered, the number is chosen
and formatted automatically according to the notes configuration element. If they are labeled, theuser must supply a label for every note he/she inserts into the document. This label is stored in
the text:label attribute of the <text:note-citation> element.

Note Body
The <text:note-body> element contains the actual content of the footnote. It does not haveany attributes.
The schema allows for the inclusion of notes into the note body. While this may be reasonable forsome future note types, it is not reasonable for footnotes and endnotes. Conforming applications
may or may not support such nested notes.

Footnote example<text:p>This paragraph contains a footnote<text:note text:note-class="footnote" text:id="ftn001"><text:note-citation>1</text:note-citation><text:note-body><text:p>This footnote has a generated sequence number</text:p></text:note-body></text:note>.
</text:p><text:p>This paragraph contains a footnote<text:note text:note-class="footnote" text:id="ftn002">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 96 of 738

<text:note-citation text:label="*">*</text:note-citation><text:note-body><text:p>This footnote has a fixed citation</text:p></text:note-body></text:note>, too</text:p>

5.4 Ruby
A ruby is additional text that is displayed above or below some base text. The purpose of ruby isto annotate the base text or provide information about its pronunciation.
There are two elements that can be contained in the <text:ruby> element:•

Ruby base•

Ruby text

The <text:ruby-base> element contains the text that is to be annotated. It contains any
paragraph element content, like text spans. The element's text:style-name attributereferences a ruby style that specifies further formatting attributes of the ruby. See section 14.8.4
for details.
The <text:ruby-text > element contains the annotation text. It may contain only plain text.
The element's text:style-name attribute references a text style that specifies further
formatting attributes used for the text.
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443

<define name="paragraph-content" combine="choice"><element name="text:ruby"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><element name="text:ruby-base"><ref name="paragraph-content"/></element><element name="text:ruby-text"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><text/></element></element></define>

5.5 Text Annotation
The OpenDocument format allows annotation to appear within a paragraph element. See section
12.1 for details on annotations.
1444
1445
1446

<define name="paragraph-content" combine="choice"><ref name="office-annotation"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 97 of 738

5.6 Index Marks
Index marks are used to mark text areas for inclusion into text indices. They are similar in
structure to bookmarks and references. They are discussed in detail section 7.1, together with text
indices.

5.7 Change Tracking and Change Marks
Paragraphs may also contain change tracking marks. These have already been explained in thechapter on change tracking (section 4.6), and are referenced here for completeness.
1447
1448
1449

<define name="paragraph-content" combine="choice"><ref name="change-marks"/></define>

5.8 Inline graphics and text-boxes
Within text documents, images, embedded objects and other drawing objects may be anchored toa paragraph, to a character, or as a character. If they are anchored to a paragraph, they appear
within a paragraph at an arbitrary position. If they are anchored to or as a character, they appear
within a paragraph at exactly the character position they are anchored to or as. See section 9.2 fordetails on drawing objects, and section 9.2.16 for their anchoring.
1450
1451
1452
1453
1454
1455

<define name="paragraph-content" combine="choice"><choice><ref name="shape"/><ref name="draw-a"/></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 98 of 738

6 Text Fields
OpenDocument text documents or OpenDocument text content embedded in other types of
documents can contain variable text elements called fields. There are several different types offield, each of which implements a different type of variable text element. Fields are mostcommonly used for:•Page numbers
A page number field displays the number of the page it appears on. This field is useful forfooters. For every page on which the footer appears, the field assumes the current page
number so that all pages are numbered correctly.

•

Creation dates
A creation date field displays the date on which the current document was created. This field
is useful for document templates. Every document created using the template contains thedate when it was created.

•

Number ranges
A number range field allows the user to number certain elements, for example, images ortables. A number range field displays its own position in relation to the other number range
fields for the same range. Therefore, if an image and its associated number range field are
moved within a document, the fields are automatically updated to reflect the new order.

This section describes how fields are represented in the OpenDocument file format.

6.1 Common Characteristics of Field Elements
Each field type is represented by a corresponding element type. A field in a document is encoded
as a single element of the appropriate type. The content of the element is the textual
representation of the current field value as it would be displayed or printed. Therefore, ignoring all
field elements and displaying only the textual content of the elements provides an approximate
text-only version of the document.
The value of a field is usually stored in an attribute. It is necessary to store the value so that thepresentation of the field can be recomputed if necessary, for example, if the user decides tochange the formatting style of the field. It is also necessary to store the presentation style of theelement content, to facilitate easy processing of the XML document. For example, if complete
processing of a field is impossible or undesirable, the application can ignore the field and use only
the content in this situation. For string values, if the value is identical to the presentation, the value
attribute is omitted to avoid duplicate storage of information.
For fields that can store different types of content, for example, numbers, strings, or dates, avalue type is stored in addition to the actual value. The value and value type attributes are
explained later in section 6.7.1. If more information is needed to restore a field, it is stored inadditional attributes.
The most common attributes of field elements are:•Fixed fields
Many fields have a variant where the content does not change after the initial value isassigned. These fields are generally marked by the attribute text:fixed. See section 6.7.2
for more information on this attribute.

•

Formatting style
Several field types, particularly those representing number, date, or time data, contain aformatting style. In the OpenDocument format, this formatting style is represented by a

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 99 of 738

style:data-style-name attribute. Since the user can change the presentation style forfields, applications must be able to recompute a new representation of the field content at any
time. See section 6.7.7 for more information on this attribute.

6.2 Document Fields
OpenDocument fields can display information about the current document or about a specific partof the current document, such as the author, the current page number, or the document creation
date. These fields are collectively referred to as document fields.
Document fields are often fixed. A field can be marked fixed to indicate that its content ispreserved, rather than re-evaluated, when the document is edited. For example, a date fieldshows the current date. If the date field is marked fixed, the value of the field is preserved during
subsequent edits and always reflects the original date on which the field was inserted into the
document. If the field is not marked fixed, its value changes whenever the document is edited. In
the same way, the author field can show the original author or the last author of a document,
depending on whether the field is marked fixed or not.
The group of document fields includes:•

Date and time fields•

Page number fields•

Sender and author fields•

Chapter fields•

File name fields•

Document template fields

6.2.1 Date Fields
Date fields display the current date. The date can be adjusted to display a date other than thecurrent date. For example, the date can be changed on a document that was edited late at night
so that it displays the date of the following day or several days later.
This element contains the presentation of the date field value, depending on the data stylespecified. The default date is the current date. The value of this element can be preserved using
the text:fixed attribute described in section 6.7.2.
1456
1457
1458
1459
1460
1461

<define name="paragraph-content" combine="choice"><element name="text:date"><ref name="text-date-attlist"/><text/></element></define>

The attributes that may be associated with the <text:date> element are:

1462

•

Date value•

Date adjustment•

Fixed (see section 6.7.2)•

Formatting style (see section 6.7.7). The formatting style must be a date data style, seesection 14.7 for more information.

<define name="text-date-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 100 of 738

1463
1464
1465
1466
1467

<interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave></define>

Date Value
The text:date-value attribute specifies a particular date value. For example, if the date field ismarked fixed, this attribute can be used to specify the date on which the field was marked as
fixed. This attribute can also be used to specify a future date. Some applications support date andtime in addition to date-only values.
The date value should conform with the date formats described in §3.2.7 and §3.2.9 of[xmlschema-2]. If no value is specified, the current date is assumed, even if the field is marked
fixed.
1468
1469
1470
1471
1472
1473
1474

<define name="text-date-attlist" combine="interleave"><optional><attribute name="text:date-value"><ref name="dateOrDateTime"/></attribute></optional></define>

Date Adjustment
The value of a date field can be adjusted by a certain time period, which is specified using the
text:date-adjust attribute. If the time period is negative, it gets subtracted from the value ofthe date field, yielding a date before the current date.
The value of this attribute must conform to the time period format described in §3.2.6 of[xmlschema-2]. The value can be preceded by an optional minus sign to indicate a negative time
duration.
1475
1476
1477
1478
1479
1480
1481

<define name="text-date-attlist" combine="interleave"><optional><attribute name="text:date-adjust"><ref name="duration"/></attribute></optional></define>

6.2.2 Time Fields
Time fields display the current time. They are very similar to the date fields described in section
6.2.1, supporting the same attributes except that for time fields, they are called text:timevalue and text:time-adjust attributes.
This element contains the presentation of the time field value, depending on the data stylespecified. The default time is the current time. The value of this element can be preserved using
the text:fixed attribute described in section 6.7.2.
1482
1483
1484
1485
1486
1487

<define name="paragraph-content" combine="choice"><element name="text:time"><ref name="text-time-attlist"/><text/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 101 of 738

The attributes that may be associated with the <text:time> element are:

1488
1489
1490
1491
1492
1493

•

Time value•

Time adjustment•

Fixed (see section 6.7.2)•

Formatting style (see section 6.7.7). The formatting style must be a time data style, seesection 14.7 for more information.

<define name="text-time-attlist" combine="interleave"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave></define>

Time Value
The text:time-value attribute records the time at which the document was last edited.
Some applications support date and time in addition to date-only values.
The value of this attribute must conform with either the “dateTime” or “time” data types describedin §3.2.7 and §3.2.8 of [xmlschema-2]. If no value is specified, the current time is assumed, even
if the field is marked fixed.
1494
1495
1496
1497
1498
1499
1500

<define name="text-time-attlist" combine="interleave"><optional><attribute name="text:time-value"><ref name="timeOrDateTime"/></attribute></optional></define>

Time Adjustment
The value of a time field can be adjusted by a certain time period, which is specified using the
text:time-adjust attribute.
The value of this attribute must conform to the time period format described in §3.2.6 of[xmlschema-2]. The value can be preceded by an optional minus sign to indicate a negative time
duration. Positive values adjust the time to a time in the future, while negative values adjust thetime to a time in the past. The duration is truncated to full minutes.
1501
1502
1503
1504
1505
1506
1507

<define name="text-time-attlist" combine="interleave"><optional><attribute name="text:time-adjust"><ref name="duration"/></attribute></optional></define>

Example: Time adjust attributes and their effects
If the attribute text:time-adjust="PTM15", the time field displays a time which is 15
minutes later than the actual time specified by the time field value.
If the attribute text:time-adjust="-PTH1", the time field displays a time which is one
hour before the actual time specified by the time field value.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 102 of 738

6.2.3 Page Number Fields
Page number fields display the current page number. These fields are particularly useful inheaders and footers. E.g., if a page number field is inserted into a footer, the current page number
is displayed on every page on which the footer appears.
The attributes that may be associated with the <text:page-number> element are:

1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519

•

Page adjustment•

Display previous or following page numbers•

Fixed (see section 6.7.2)•

Formatting style (see section 6.7.8)
Page numbers can be formatted according to the number format described in section 2.9. If anumber style is not specified, the page numbers are formatted according to the number styledefined in the current page style.

<define name="paragraph-content" combine="choice"><element name="text:page-number"><ref name="text-page-number-attlist"/><text/></element></define><define name="text-page-number-attlist" combine="interleave"><interleave><ref name="common-field-num-format-attlist"/><ref name="common-field-fixed-attlist"/></interleave></define>

Note: To display the total number of pages in a document, use the<text:page-count/> field described in section 6.4.17.

Page Adjustment
The value of a page number field can be adjusted by a specified number, allowing the display ofpage numbers of following or preceding pages. The adjustment amount is specified using the
text:page-adjust attribute. When this attribute is used, the application:
1. Adds the value of the attribute to the current page number.
2. Checks to see if the resulting page exists.
3. If the page exists, the number of that page is displayed.
4. If the page does not exist, the value of the page number field remains empty and no number isdisplayed.
1520
1521
1522
1523
1524
1525
1526

<define name="text-page-number-attlist" combine="interleave"><optional><attribute name="text:page-adjust"><ref name="integer"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 103 of 738

Display Previous or Following Page Numbers
The text:select-page attribute is used to display the number of the previous or the following
page rather than the number of the current page.
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537

<define name="text-page-number-attlist" combine="interleave"><optional><attribute name="text:select-page"><choice><value>previous</value><value>current</value><value>next</value></choice></attribute></optional></define>

Note: To display the current page number on all pages except the first or last
page, use a combination of the text:select page and text:page adjust
attributes.
Example: Displaying the current page number on all pages except the first page
<text:page-number text:select-page="previous"
text:page-adjust="1"style:num-format="1"/>6.2.4 Page Continuation Text
In some publications, a continuation reminder is printed at the bottom of the page in addition to
the page number. To include a continuation reminder, use the <text:page-continuation>
element.
1538
1539
1540
1541
1542
1543

<define name="paragraph-content" combine="choice"><element name="text:page-continuation"><ref name="text-page-continuation-attlist"/><text/></element></define>

The attributes associated with the <text:page-continuation> element are:•Previous or following page•

String value

Previous or Following Page
This attribute specifies whether to check for a previous or next page and if the page exists, thecontinuation text is printed.
1544
1545
1546
1547
1548
1549
1550
1551

<define name="text-page-continuation-attlist" combine="interleave"><attribute name="text:select-page"><choice><value>previous</value><value>next</value></choice></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 104 of 738

String Value
This attribute specifies the continuation text to display. If this attribute is omitted, the element
content is used.
1552
1553
1554
1555
1556
1557
1558

<define name="text-page-continuation-attlist" combine="interleave"><optional><attribute name="text:string-value"><ref name="string"/></attribute></optional></define>

6.2.5 Sender Fields
There are several fields which contain information about the sender of the current document, forexample, name and email address. The information about the sender is taken from the
OpenDocument user information dialog. If a sender field is marked fixed using the text:fixedattribute, the original sender information in the sender fields is preserved. (cf. section 6.7.2)
Otherwise, the information is updated each time the file is edited, causing the fields to change
value when the document is edited by a different user.

First Name
This element represents the first name of the sender.
1559
1560
1561
1562
1563
1564

<define name="paragraph-content" combine="choice"><element name="text:sender-firstname"><ref name="common-field-fixed-attlist"/><text/></element></define>

Last Name
This element represents the last name of the sender.
1565
1566
1567
1568
1569
1570

<define name="paragraph-content" combine="choice"><element name="text:sender-lastname"><ref name="common-field-fixed-attlist"/><text/></element></define>

InitialsThis element represents the initials of the sender.
1571
1572
1573
1574
1575
1576

<define name="paragraph-content" combine="choice"><element name="text:sender-initials"><ref name="common-field-fixed-attlist"/><text/></element></define>

Title
This element represents the title of the sender.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 105 of 738

1577
1578
1579
1580
1581
1582

<define name="paragraph-content" combine="choice"><element name="text:sender-title"><ref name="common-field-fixed-attlist"/><text/></element></define>

Position
This element represents the position of the sender.
1583
1584
1585
1586
1587
1588

<define name="paragraph-content" combine="choice"><element name="text:sender-position"><ref name="common-field-fixed-attlist"/><text/></element></define>

Email AddressThis element represents the email address of the sender.
1589
1590
1591
1592
1593
1594

<define name="paragraph-content" combine="choice"><element name="text:sender-email"><ref name="common-field-fixed-attlist"/><text/></element></define>

Private Telephone NumberThis element represents the private telephone number of the sender.
1595
1596
1597
1598
1599
1600

<define name="paragraph-content" combine="choice"><element name="text:sender-phone-private"><ref name="common-field-fixed-attlist"/><text/></element></define>

Fax NumberThis element represents the facsimile number of the sender.
1601
1602
1603
1604
1605
1606

<define name="paragraph-content" combine="choice"><element name="text:sender-fax"><ref name="common-field-fixed-attlist"/><text/></element></define>

Company Name
This element represents the name of the company that employs the sender.
1607
1608
1609
1610

<define name="paragraph-content" combine="choice"><element name="text:sender-company"><ref name="common-field-fixed-attlist"/><text/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 106 of 738

1611
1612

</element></define>

Office Telephone NumberThis element represents the office telephone number of the sender.
1613
1614
1615
1616
1617
1618

<define name="paragraph-content" combine="choice"><element name="text:sender-phone-work"><ref name="common-field-fixed-attlist"/><text/></element></define>

StreetThis element represents the street name of the address of the sender.
1619
1620
1621
1622
1623
1624

<define name="paragraph-content" combine="choice"><element name="text:sender-street"><ref name="common-field-fixed-attlist"/><text/></element></define>

City
This element represents the city name of the address of the sender.
1625
1626
1627
1628
1629
1630

<define name="paragraph-content" combine="choice"><element name="text:sender-city"><ref name="common-field-fixed-attlist"/><text/></element></define>

Postal CodeThis element represents the postal code of the address of the sender.
1631
1632
1633
1634
1635
1636

<define name="paragraph-content" combine="choice"><element name="text:sender-postal-code"><ref name="common-field-fixed-attlist"/><text/></element></define>

CountryThis element represents the country of the address of the sender.
1637
1638
1639
1640
1641
1642

<define name="paragraph-content" combine="choice"><element name="text:sender-country"><ref name="common-field-fixed-attlist"/><text/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 107 of 738

State or ProvinceThis element represents the state or province of the address of the sender, if applicable.
1643
1644
1645
1646
1647
1648

<define name="paragraph-content" combine="choice"><element name="text:sender-state-or-province"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.2.6 Author Fields
There are two elements available to display the author of a document. One element displays thefull name of the author and the other element displays the initials of the author.
The value of author fields can be fixed using the text:fixed attribute. Marking an author fieldas fixed preserves the original field content. Otherwise, the field content changes each time thedocument is updated, to reflect the last author of the document.

Name of the Author
This element represents the full name of the author.
1649
1650
1651
1652
1653
1654

<define name="paragraph-content" combine="choice"><element name="text:author-name"><ref name="common-field-fixed-attlist"/><text/></element></define>

Initials of the Author
This element represents the initials of the author.
1655
1656
1657
1658
1659
1660

<define name="paragraph-content" combine="choice"><element name="text:author-initials"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.2.7 Chapter Fields
Chapter fields display one of the following:•

The name of the current chapter•

The number of the current chapter•

Both the name and number of the current chapter

If the chapter field is placed inside a header or footer, it displays the current chapter name ornumber on every page.
1661
1662
1663
1664
1665

<define name="paragraph-content" combine="choice"><element name="text:chapter"><ref name="text-chapter-attlist"/><text/></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 108 of 738

1666</define>

The attributes that may be associated with the <text:chapter> element are:•

Display•

Outline level

Display
The text:display attribute specifies the information that the chapter field should display.
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677

<define name="text-chapter-attlist" combine="interleave"><attribute name="text:display"><choice><value>name</value><value>number</value><value>number-and-name</value><value>plain-number-and-name</value><value>plain-number</value></choice></attribute></define>

Example: If the current chapter number is 2.4, the chapter title is Working with Tables, the prefix
is [, and suffix is ], the possible display options and results are as follows:
Value of text:display
attribute

Field content displayed

number

[2.4]

name

Working with Tables

number-and-name[2.4] Working with Tables

plain-number

2.4

plain-number-and-name

2.4 Working with Tables

Outline Level
This attribute is used to specify the outline level to use. The chapter field displays the chapter
number or title up to the specified outline level.
1678
1679
1680
1681
1682

<define name="text-chapter-attlist" combine="interleave"><attribute name="text:outline-level"><ref name="nonNegativeInteger"/></attribute></define>

6.2.8 File Name Fields
File name fields display the name of the file that is currently being edited.
The attributes that may be associated with the <text:file-name> element are:•

Display•

Fixed

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 109 of 738

1683
1684
1685
1686
1687
1688

<define name="paragraph-content" combine="choice"><element name="text:file-name"><ref name="text-file-name-attlist"/><text/></element></define>

Display
The text:display attribute specifies how much of the file name to display. The following
display options are allowed:•

The full file name including the path and the extension•

The file path only•

The file name only•

The file name and the extension

The filename might be an IRI, either because an IRI has been used to retrieve the file, or theapplication internally uses IRIs and therefore converts even system specific paths into an IRI. If
this is the case, and if the path, the name or the extension cannot be evaluated from the IRI, thenthe IRI should be displayed unmodified.
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700

<define name="text-file-name-attlist" combine="interleave"><optional><attribute name="text:display"><choice><value>full</value><value>path</value><value>name</value><value>name-and-extension</value></choice></attribute></optional></define>

Fixed File Name Fields
If a file name field is fixed, its value does not change when the file is edited.
1701
1702
1703

<define name="text-file-name-attlist" combine="interleave"><ref name="common-field-fixed-attlist"/></define>

6.2.9 Document Template Name Fields
The document template name field displays information about the document template in use,such as the template title or the file name.
The only attribute that may be associated with the <text:template-name> element is:
•
1704
1705
1706
1707
1708

Display<define name="paragraph-content" combine="choice"><element name="text:template-name"><ref name="text-template-name-attlist"/><text/></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 110 of 738

1709</define>

DisplayThis attribute specifies which information about the document template to display. The following
display options are allowed:•

The full file name including the path and the extension•

The file path only•

The file name only•

The file name and the extension•

The title•

The area of the document template

The latter two values can be used for template dialogs. The values are a superset of the display
values available for the <text:file-name> element.
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723

<define name="text-template-name-attlist"><optional><attribute name="text:display"><choice><value>full</value><value>path</value><value>name</value><value>name-and-extension</value><value>area</value><value>title</value></choice></attribute></optional></define>

6.2.10 Sheet Name Fields
For Spreadsheet documents, sheet name fields display the name of the sheet that is currently
being edited.
1724
1725
1726
1727
1728

<define name="paragraph-content" combine="choice"><element name="text:sheet-name"><text/></element></define>

6.3 Variable Fields
OpenDocument text documents can contain variables, which are processed or displayed using
variable fields. A variable is a name/value pair. The variable name is used throughout the
document to identify a particular variable, and therefore variable names cannot be reused for
different types of variables. Most variable fields support different value types, such as numbers,
dates, strings, and so on. In the OpenDocument file format, a variable must be declared at the
beginning of a document.
There are three types of variables:•

Simple variables

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 111 of 738

Simple variables, usually called variables, can take different values at different positions
throughout a document. Simple variables can be set using either setter or input fields. Setter
fields contain an expression, which is used to compute the new value of the variable. Input
fields prompt the user for the new value. Simple variables can be used to display different text
in recurring elements, such as headers or footers.
•

User variables
User variables have the same value throughout a document. If a user variable is set
anywhere within the document, all fields in the document that display the user variable havethe same value. In the office application user interface, a user variable can be set at any
occurrence of a user field, or by using user variable input fields. In the OpenDocument fileformat, the value of the user variable can only be set after the variable is declared.

•

Sequence variables
Sequence variables are used to number certain items in an OpenDocument text document,
for example, images or tables.

Expression and text input fields are also variable fields, but they are not associated with any
particular variables. Since their functionality is closely related to that of the variable fields, they arealso described in this section of the manual.
Variables must be declared before they can be used. The variable declarations are collected incontainer elements for the particular variable type. The OpenDocument code for declaring
variables is described in sections 6.3.1, 6.3.5 and 6.3.8.

6.3.1 Declaring Simple Variables
Simple variables are declared using <text:variable-decl> elements. The declaration
specifies the name and the value type of the variable.
To specify the name and value type of the simple variable, the following attributes are attached to
the <text:variable-decl> element:•

text:name
The name of the variable must be unique. The name cannot already be used for any othertype of variable. See section 6.7.3 for information on using this attribute.

•

office:value-type
See section 6.7.1 for information on using this attribute.

1729
1730
1731
1732
1733
1734

<define name="text-variable-decl"><element name="text:variable-decl"><ref name="common-field-name-attlist"/><ref name="common-value-type-attlist"/></element></define>

6.3.2 Setting Simple Variables
Simple variables can be set using variable setter elements. This element contains thepresentation of the value of the variable, which can be empty if the text:display attribute is set
to none.
The attributes that may be associated with the <text:variable-set> element are:•text:name

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 112 of 738

This attribute specifies the name of the variable to set. It must match the name of a variable
that has already been declared. See section 6.7.3 for information on using this attribute.
•

text:formulaThis attribute contains the formula to compute the value of the variable field. If the formulaequals the content of the field element, this attribute can be omitted. See section 6.7.6 for
information on using this attribute.

•

office:value-type and the appropriate value attribute
See section 6.7.1 for information on using these attributes.
Note: A simple variable should not contain different value types at different places in adocument. However, an implementation may allow the use of different value types for different
instances of the same variable. In the case of the numeric value types float, percentage,
and currency, the value is automatically converted to the different value type. For value
types that are stored internally as numbers, such as date, time, and boolean types, thevalues are reinterpreted as numbers of the respective types. If a variable is used for bothstring and non-string types, the behavior is undefined, therefore this practice is notrecommended.

•

text:display
This attribute can be used to specify whether or not to display the value of the<text:variable-set> element. If the text:display attribute is set to value, the valueof the variable is displayed. If the attribute is set to none, the value is not displayed. See
section 6.7.5 for information on using this attribute.

•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746

<define name="paragraph-content" combine="choice"><element name="text:variable-set"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-formula-attlist"/><ref name="common-value-and-type-attlist"/><ref name="common-field-display-value-none-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.3 Displaying Simple Variables
The <text:variable-get> element reads and displays the value of a simple variable. The
value of this element is the value of the last preceding <text:variable-set> element with an
identical text:name attribute. The element determines how the value of the variable ispresented, in accordance with the chosen formatting style.
The attributes that may be associated with the <text:variable-get> element are:•text:name

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 113 of 738

This attribute specifies the name of the variable to display. The name must match the nameof a preceding <text:variable-del> element. See section 6.7.3 for information on using
this attribute.
•

text:display
This attribute can be used to specify whether to display the formula for a simple variable or
the computed value of the variable. See section 6.7.5 for information on using this attribute.

•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

1747
1748
1749
1750
1751
1752
1753
1754
1755
1756

<define name="paragraph-content" combine="choice"><element name="text:variable-get"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-display-value-formula-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.4 Simple Variable Input Fields
As an alternative to setting simple variables using formulas in variable setter elements, the user
can be prompted for variable values. To do this, use the <text:variable-input> element.
This element contains the presentation of the variable's value according to the chosen formatting
style. The presentation can be empty if the text:display attribute is set to none.
The attributes that may be associated with the <text:variable-input> element are:•text:name
This attribute specifies the name of the variable to display. It must match the name of avariable that was already declared. See section 6.7.3 for information on using this attribute.

•

text:description
This optional attribute contains a brief message that is presented to users when they areprompted for input. The message should give users enough information about the variable or
the use of the value within the document to enable them to choose an appropriate value. See
section 6.7.4 for information on using this attribute.

•

office:value-type and the appropriate value attribute
See section 6.7.1 for information on using these attributes.

•

text:display
This attribute can be used to specify whether to display or hide the value of the variablethrough the variable input field. See section 6.7.5 for information on using this attribute.

•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 114 of 738

1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768

<define name="paragraph-content" combine="choice"><element name="text:variable-input"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-description-attlist"/><ref name="common-value-type-attlist"/><ref name="common-field-display-value-none-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.5 Declaring User Variables
User variables contain values that are displayed using appropriate fields. Unlike simple variables,
user variables have the same value throughout a document. For this reason, the value of user
variables is stored in the variable declaration itself.
The attributes that may be associated with the <text:user-field-del> element are:•text:name
This attribute specifies the name of the variable to be declared. The name must be unique. It
cannot already be used for any other type of variable including simple and sequencevariables. See section 6.7.3 for information on using this attribute.

•

text:formulaThis attribute contains the formula to compute the value of the user variable field. If theformula is the same as the content of the field element, this attribute can be omitted. See
section 6.7.6 for information on using this attribute.

•

office:value-type and the appropriate value attribute
See section 6.7.1 for information on using these attributes.

1769
1770
1771
1772
1773
1774
1775
1776
1777

<define name="text-user-field-decl"><element name="text:user-field-decl"><ref name="common-field-name-attlist"/><optional><ref name="common-field-formula-attlist"/></optional><ref name="common-value-and-type-attlist"/></element></define>

6.3.6 Displaying User Variables
The content of user variables can be displayed using <text:user-field-get> elements.
The attributes that may be associated with the <text:user-field-get> element are:•text:name
This attribute specifies the name of the variable to display. The name must match the nameof a preceding <text:user-field-del> element. See section 6.7.3 for information on
using this attribute.

•

text:display

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 115 of 738

This attribute can be used to specify whether to:–

Display the formula used to compute the value of the user variable.

–

Display the value of the user variable.

–

Hide the user variable fields.
•

See section 6.7.5 for information on using this attribute.

Note: Since the office application user interfaces usually allow users to edit a user field
variable by clicking on any user field, a hidden <text:user-field-get> element can beused as an anchor to allow easy access to a particular user field variable.
•

style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

1778
1779
1780
1781
1782
1783
1784
1785
1786
1787

<define name="paragraph-content" combine="choice"><element name="text:user-field-get"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-display-value-formula-none-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.7 User Variable Input Fields
An alternative method of setting user variables is to use input fields, similar to the input fields for
simple variables. A user variable can be set in this way using the <text:user-field-input>
element. Since the value of a user field variable is stored in the <text:user-field-del>element, the <text:user-field-input> element does not contain the value and value typeattributes from the <text:variable-input> field.
The presentation can be empty if the text:display attribute is set to none.
The attributes that may be associated with the <text:user-field-input> element are:•text:name
This attribute specifies the name of the variable to set. It must match the name of a variable
that has already been declared. See section 6.7.3 for information on using this attribute.

•

text:description
This optional attribute contains a brief message that is presented to users when they areprompted for input. The message should give users enough information about the variable or
the use of the value within the document, to enable them to choose an appropriate value. See
section 6.7.4 for information on using this attribute.

•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 116 of 738

1788
1789
1790
1791
1792
1793
1794
1795
1796
1797

<define name="paragraph-content" combine="choice"><element name="text:user-field-input"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-description-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.8 Declaring Sequence Variables
Sequence variables are used to number items within an OpenDocument text document.
Sequence variables are most commonly used for sequential numbering. However, expression
formulas can be included in sequence fields to support more advanced sequences. See section
6.3.9 for more information on Using Sequence Fields and their uses.
Sequence variables are declared using the <text:sequence-del> element.
To facilitate chapter-specific numbering, attributes can be attached to a sequence variable tospecify a chapter level and a separation character. The attributes that may be associated with the<text:sequence-del> element are:•text:name
This attribute specifies the name of the variable to be declared. The name must be unique. It
cannot already be used for any other type of variable including simple and user variables. See
section 6.7.3 for information on using this attribute.

•

text:display-outline-level
See section 6.3.8:Outline Level for information about this attribute.

•

text:separation-character
See section 6.3.8:Separation Character for information about this attribute.

1798
1799
1800
1801
1802
1803
1804
1805

<define name="text-sequence-decl"><element name="text:sequence-decl"><ref name="text-sequence-decl-attlist"/></element></define><define name="text-sequence-decl-attlist" combine="interleave"><ref name="common-field-name-attlist"/></define>

Outline Level
Sequences can be numbered by chapter. To use this feature, use the text:displayoutline-level attribute to specify an outline level that determines which chapters to reference
for the chapter-specific numbering. All chapters that are at or below the specified outline level
reset the value of the sequence to zero, the default value. Also, the chapter number of the lastchapter at or below the specified outline level is prefixed to the sequence number. Choosing an
outline level of zero results in a straight sequence of all sequence elements for that sequencevariable.
1806
1807
1808

<define name="text-sequence-decl-attlist" combine="interleave"><attribute name="text:display-outline-level"><ref name="nonNegativeInteger"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 117 of 738

1809
1810

</attribute></define>

Separation Character
If sequences are numbered by chapter, this attribute is used to choose a character to separate
the chapter number from the sequence number.
If the value of the text:display-outline-level attribute is a non-zero value, a separation
character may be specified. The default separation character is ".".Otherwise, if the value oftext:display-outline-level is zero, this attribute must be omitted.
1811
1812
1813
1814
1815
1816
1817

<define name="text-sequence-decl-attlist" combine="interleave"><optional><attribute name="text:separation-character"><ref name="character"/></attribute></optional></define>

Example: Sequence variable
The sequence variable 3.7.36#5 with a value of 5 is declared using:
AttributeValue

text:display-outline-level 3
text:separation-character#

6.3.9 Using Sequence Fields
Once a sequence variable is declared, it can be used in sequence fields throughout the
document. Most sequence fields simply increment and display the sequence variable. However,sequence fields can also assume a new start value at any given position in a document. This startvalue is computed using a formula which is contained in the sequence field. If a sequence field
without a start value is added, the office application software automatically inserts an expressionof the type variable+1.
Sequence fields are most commonly used for simple counting sequences. However, the ability toprovide arbitrary expressions supports more complex sequences. To form a sequence of evennumbers, all sequence elements for that particular variable need to contain a formula
incrementing the value by two, for example, variable+2. A sequence with a starting value of 1
and all subsequent elements using the formula variable*2 yields all powers of two. Since
different sequence elements for the same sequence variable may contain different formulas,
complex sequences may be constructed.
The attributes that may be associated with the <text:sequence> element are:•text:name
This attribute specifies the name of the variable that the field is to display. It must match thename of a sequence variable that was already declared. See section 6.7.3 for information on
using this attribute.

•

text:formula

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 118 of 738

This optional attribute contains a formula to compute the value of the sequence field. If this
attribute is omitted, an expression containing the content of the element is used. See section
6.7.6 for information on using this attribute.
•style:num-format and style:num-letter-sync
These attributes specify the numbering style to use. If a numbering style is not specified, thenumbering style is inherited from the page style. See section 6.7.8 for information on these
attributes.

•

text:ref-name
See the section 6.3.9:Reference Name for more information about this attribute.

1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828

<define name="paragraph-content" combine="choice"><element name="text:sequence"><interleave><ref name="common-field-name-attlist"/><ref name="common-field-formula-attlist"/><ref name="common-field-num-format-attlist"/><ref name="text-sequence-ref-name"/></interleave><text/></element></define>

Reference Name
Sequence fields can be the target of references, as implemented using reference fields. See
section 6.6.5 for more information about reference fields. To enable a reference field to identify aparticular sequence field, the sequence field must contain an additional attribute containing aname. No two sequence fields can have the same reference name.
If the sequence field is not the target of a reference, this attribute can be omitted.
1829
1830
1831
1832
1833
1834
1835

<define name="text-sequence-ref-name"><optional><attribute name="text:ref-name"><ref name="string"/></attribute></optional></define>

6.3.10 Expression Fields
Expression fields contain expressions that are evaluated and the resulting value is displayed. The
value of the expression is formatted according to the chosen formatting style.
The attributes that may be associated with the <text:expression> element are:•text:formulaThis attribute contains the actual expression used to compute the value of the expression
field. See section 6.7.6 for information on using this attribute.

•

office:value-type and the appropriate value attribute
See section 6.7.1 for information on using these attributes.

•

text:display

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 119 of 738

Use this attribute to specify one of the following:–

To display the value of the field.

–

To display the formula used to compute the value.

See section 6.7.5 for information on using this attribute.
•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848

<define name="paragraph-content" combine="choice"><element name="text:expression"><interleave><ref name="common-field-formula-attlist"/><optional><ref name="common-value-and-type-attlist"/></optional><ref name="common-field-display-value-formula-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.3.11 Text Input Fields
A text input field is a variable field. From the point of view of the user interface, a text input field issimilar to the <text:variable-input> and <text:user-field-input> fields. However,
the text input field does not change the value of any variables.
The only attribute that may be associated with the <text:text-input> element is:•

text:description
This attribute contains a brief message that is presented to users when they are prompted for
input. The message should give users enough information about the purpose of the field andhow it is used within the document, to enable them to choose an appropriate value. See
section 6.7.4 for information on using this attribute.

1849
1850
1851
1852
1853
1854

<define name="paragraph-content" combine="choice"><element name="text:text-input"><ref name="common-field-description-attlist"/><text/></element></define>

6.4 Metadata Fields
Metadata fields display meta information about the document, such as, the document creation
date or the time at which the document was last printed. The names of the metadata field
elements correspond to the metadata elements described in Chapter 3.
All metadata field elements can be marked as fixed using the text:fixed attribute. (Cf. section
6.7.2)
Several metadata fields display a date or a time. The elements for these fields require an
associated text:date-value or a text:time-value attribute, and optionally, they can also

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 120 of 738

have a style:data-style-name attribute. See section 6.7.1 for more information on these
attributes.

6.4.1 Initial CreatorThis element represents the name of the author who created the original document.
1855
1856
1857
1858
1859
1860

<define name="paragraph-content" combine="choice"><element name="text:initial-creator"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.4.2 Document Creation Date
This element represents the date on which the document was created.
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874

<define name="paragraph-content" combine="choice"><element name="text:creation-date"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:date-value"><ref name="dateOrDateTime"/></attribute></optional></interleave><text/></element></define>

6.4.3 Document Creation Time
This element represents the time at which the document was created.
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888

<define name="paragraph-content" combine="choice"><element name="text:creation-time"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:time-value"><ref name="timeOrDateTime"/></attribute></optional></interleave><text/></element></define>

6.4.4 Document Description
This element contains a brief description of the document.
1889
1890
1891

<define name="paragraph-content" combine="choice"><element name="text:description"><ref name="common-field-fixed-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 121 of 738

1892
1893
1894

<text/></element></define>

6.4.5 User-Defined Document Information
This element contains user-defined information about the document. It displays the information
provided within a <meta:user-defined> element that has the same name.
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931

<define name="paragraph-content" combine="choice"><element name="text:user-defined"><interleave><ref name="common-field-fixed-attlist"/><attribute name="text:name"><ref name="string"/></attribute><ref name="common-field-data-style-name-attlist"/><optional><attribute name="office:value"><ref name="double"/></attribute></optional><optional><attribute name="office:date-value"><ref name="dateOrDateTime"/></attribute></optional><optional><attribute name="office:time-value"><ref name="duration"/></attribute></optional><optional><attribute name="office:boolean-value"><ref name="boolean"/></attribute></optional><optional><attribute name="office:string-value"><ref name="string"/></attribute></optional></interleave><text/></element></define>

6.4.6 Print Time
This element represents the time at which the document was last printed.
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941

<define name="paragraph-content" combine="choice"><element name="text:print-time"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:time-value"><ref name="time"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 122 of 738

1942
1943
1944
1945

</interleave><text/></element></define>

6.4.7 Print Date
This element represents the date on which the document was last printed.
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959

<define name="paragraph-content" combine="choice"><element name="text:print-date"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:date-value"><ref name="date"/></attribute></optional></interleave><text/></element></define>

6.4.8 Printed By
This element represents name of the last person who printed the document.
1960
1961
1962
1963
1964
1965

<define name="paragraph-content" combine="choice"><element name="text:printed-by"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.4.9 Document Title
This element represents the title of the document.
1966
1967
1968
1969
1970
1971

<define name="paragraph-content" combine="choice"><element name="text:title"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.4.10 Document Subject
This element represents the subject of the document.
1972
1973
1974
1975
1976
1977

<define name="paragraph-content" combine="choice"><element name="text:subject"><ref name="common-field-fixed-attlist"/><text/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 123 of 738

6.4.11 Document Keywords
This element contains a list of keywords used to describe the document.
1978
1979
1980
1981
1982
1983

<define name="paragraph-content" combine="choice"><element name="text:keywords"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.4.12 Document Revision NumberThis element contains the document revision number. When the document is created, the revision
number is set to 1. Each time the document is saved, the document revision number isincremented.
1984
1985
1986
1987
1988
1989

<define name="paragraph-content" combine="choice"><element name="text:editing-cycles"><ref name="common-field-fixed-attlist"/><text/></element></define>

Note: Since the <text:editing-cycles> field can not be formatted, therevision number can be read from the element content. Therefore, no extra
attribute is needed.

6.4.13 Document Edit Duration
Every time a document is edited, the office application records the duration between the time thedocument is opened and the time the document is closed. It then adds the duration to an internalcounter, thereby keeping track of the total time that has been spent editing the document.
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003

<define name="paragraph-content" combine="choice"><element name="text:editing-duration"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:duration"><ref name="duration"/></attribute></optional></interleave><text/></element></define>

6.4.14 Document Modification Time
This element represents the time at which the document was last modified.
This element displays the information from the <dc:date> element. The name was chosen to
avoid confusion with <text:date> fields.
2004
2005
2006

<define name="paragraph-content" combine="choice"><element name="text:modification-time"><interleave>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 124 of 738

2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017

<ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:time-value"><ref name="time"/></attribute></optional></interleave><text/></element></define>

6.4.15 Document Modification Date
This element represents the date on which the document was last modified.
This element displays the information from the <dc:date> element. The name was chosen to
avoid confusion with <text:date> fields.
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031

<define name="paragraph-content" combine="choice"><element name="text:modification-date"><interleave><ref name="common-field-fixed-attlist"/><ref name="common-field-data-style-name-attlist"/><optional><attribute name="text:date-value"><ref name="date"/></attribute></optional></interleave><text/></element></define>

6.4.16 Document Modified By
This element represents the name of the person who last modified the document.
2032
2033
2034
2035
2036
2037

<define name="paragraph-content" combine="choice"><element name="text:creator"><ref name="common-field-fixed-attlist"/><text/></element></define>

6.4.17 Document Statistics Fields
These fields display how many objects of a certain type a document contains. They can be used
to display the number of•pages,•

paragraphs,•

words,•

characters,•

tables,

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 125 of 738

2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052

•

images, or•embedded objects.

<define name="paragraph-content" combine="choice"><element><choice><name>text:page-count</name><name>text:paragraph-count</name><name>text:word-count</name><name>text:character-count</name><name>text:table-count</name><name>text:image-count</name><name>text:object-count</name></choice><ref name="common-field-num-format-attlist"/><text/></element></define>

6.5 Database Fields
Documents can reference databases and display database information as text content. To display
database information, the OpenDocument schema uses a group of text fields, collectively called
database fields. Office applications may use database tables from SQL servers, therefore
database fields can be used to access any SQL database, provided that the appropriate drivers
are available.
A database may contain the following components:•

Tables, which store the actual data.

•

Queries, which extract a subset of data from one or more tables.

•

Forms, which present the data.

•

Reports, which summarize the database content.

Database forms and reports are not relevant to text content, therefore they are not discussed inthis chapter. From the point of view of embedding database information in OpenDocument text
documents, queries and tables are considered the same. Therefore for the remainder of thissection, the phrase database table refers to both database tables and database queries.
Database fields alone do not retrieve information from a database. In addition to the databasefields, a set of database rows is also added to the document. When new data is added to the
document, all database fields belonging to the added database table are updated. Using the officeapplication user interface, database rows can be added in one of the following ways:•

Manually, using a data source browser and the data to fields function.

•

Using the Form Letter menu item on the File menu. This menu item adds each row in thechosen data set into a newly created copy of the form letter.

To display data from a database table use the <text:database-display> element. The<text:database-select> and <text:database-next> elements can be used todetermine which row within the current selection should be displayed. The current row number fora particular table can be displayed using the <text:database-row-number> element. Finally,
the <text:database-name> field displays the name of the most recently used database, whichis the address book file database by default.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 126 of 738

6.5.1 Database Field Data Source
A database field's source can either be the name of a database, or an IRI containing databaseconnection resource data. If the source is a database name, then this name is used by all of theoffice application components to identify a database. All database fields contain a database nameor connection resource, and most database fields also contain the name of a database table,
which must be stored in the database. An additional attribute determines whether the databasetable refers to an SQL table, an OpenDocument query, or the result of a SQL command.
2053
2054
2055
2056

<define name="common-field-database-table"><ref name="common-field-database-table-attlist"/><ref name="common-field-database-name"/></define>

Database Name
The text:database-name attribute specifies the source database by its name.
2057
2058
2059
2060
2061
2062
2063

<define name="common-field-database-name" combine="choice"><optional><attribute name="text:database-name"><ref name="string"/></attribute></optional></define>

Connection Resource
The <form:connection-resource> element specifies the source database by an [XLink]. Its
xlink:href attribute either references a file containing a database, or it contains information on
how to make a connection to a database, for instance a [JDBC] URL. See also section 11.1.20.
2064
2065
2066

<define name="common-field-database-name" combine="choice"><ref name="form-connection-resource"/></define>

Database Table Name
The text:table-name attribute specifies a table within the source database.
2067
2068
2069
2070
2071

<define name="common-field-database-table-attlist" combine="interleave"><attribute name="text:table-name"><ref name="string"/></attribute></define>

Database TypeThe text:table-type attribute determines whether the database table refers to an SQL table,
an OpenDocument query, or the result of a SQL command.
2072
2073
2074
2075
2076
2077
2078
2079

<define name="common-field-database-table-attlist" combine="interleave"><optional><attribute name="text:table-type"><choice><value>table</value><value>query</value><value>command</value></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 127 of 738

2080
2081
2082

</attribute></optional></define>

6.5.2 Displaying Database Content
The <text:database-display> element displays data from a database. When a new data set
is added to a document, all fields that display data from that database table update their content.
The attributes that may be associated with the <text:database-display> element are:•text:database-name, text:table-name and text:table-type
These attributes specify the database and database table that this field uses.

•

text:database-column-name
See section 6.5.2:Column Name for information about this attribute.

•style:data-style-name
If the column specifies a numeric, Boolean, date, or time value, the data is formatted
according to the appropriate data style. If no data style is specified, the data style assigned tothis column in is used. See section 6.7.7 for more information about using this attribute.

2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094

<define name="paragraph-content" combine="choice"><element name="text:database-display"><ref name="text-database-display-attlist"/><text/></element></define><define name="text-database-display-attlist" combine="interleave"><ref name="common-field-database-table"/></define><define name="text-database-display-attlist" combine="interleave"><ref name="common-field-data-style-name-attlist"/></define>

Column Name
The text:column-name attribute specifies the column from which to display the data. The valueof this attribute must be a column contained in the specified database.
2095
2096
2097
2098
2099

<define name="text-database-display-attlist" combine="interleave"><attribute name="text:column-name"><ref name="string"/></attribute></define>

6.5.3 Selecting the Next Database Row
The <text:database-next> element changes the row in the current selection which is used
for display in all following <text:database-display> fields. The next row from the current
selection is chosen if it satisfies a given condition. If the next row is wanted regardless of any
condition, the condition may be omitted or set to true.
The attributes that may be associated with the <text:database-next> are:•text:database-name, text:table-name and text:table-type

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 128 of 738

These attributes specify the database and the database table that this field uses.
•

text:condition
See section 6.5.3:Condition for information about this attribute.

2100
2101
2102
2103
2104
2105
2106
2107

<define name="paragraph-content" combine="choice"><element name="text:database-next"><ref name="text-database-next-attlist"/></element></define><define name="text-database-next-attlist" combine="interleave"><ref name="common-field-database-table"/></define>

Condition
The text:condition attribute specifies the condition expression. The expression is evaluatedand if the result interpreted as a Boolean value is true, the next row is used as the new current
row. Database field values can be used in the expression by enclosing in square brackets the
database name, the table name, and the column name, separated by dots.
If the text:condition attribute is not present, it is assumes that the formula true, meaningthat the next row is selected unconditionally.
2108
2109
2110
2111
2112
2113
2114

<define name="text-database-next-attlist" combine="interleave"><optional><attribute name="text:condition"><ref name="formula"/></attribute></optional></define>

Example:text:formula='ooo-w:[address book file.address.FIRSTNAME] == "Julie"'This example specifies a condition that is true if the current row from an address book databasetable is the address for a person named Julie. If the condition shown in this example is used in a<text:database-next> element, the following happens:•

The <text:database-display> elements display the data from the first row of the current
selection.

•

If the FIRSTNAME column of the current row reads Julie, the current row is changed.
Otherwise, nothing happens.

•

If the first row is Julie, the following <text:database-display> elements display datafrom the second row. Otherwise, they display data from the first row.

See section 6.7.6 for more information on the formula syntax of a text:condition attribute,which is the same as that of the text:formula attribute.

6.5.4 Selecting a Row Number
The <text:database-row-select> element selects a specific row from the current selection.
As with the <text:database-row-next> element, a condition can be specified so that thegiven row is only selected if the condition is true.
The attributes that may be associated with the <text:database-row-select> are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 129 of 738

•

text:database-name, text:table-name and text:table-type
These attributes determine the database and the database table that this field uses.

•

text:condition
This attribute specifies the condition expression. See section 6.5.3 for a full explanation of
how to use this attribute.

•

text:row-number
See the following section 6.5.4:Selecting the Row Number about this attribute.

2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129

<define name="paragraph-content" combine="choice"><element name="text:database-row-select"><ref name="text-database-row-select-attlist"/></element></define><define name="text-database-row-select-attlist" combine="interleave"><ref name="common-field-database-table"/></define><define name="text-database-row-select-attlist" combine="interleave"><optional><attribute name="text:condition"><ref name="formula"/></attribute></optional></define>

Selecting the Row NumberThis attribute specifies the row number to select when a condition is true.
2130
2131
2132
2133
2134
2135
2136

<define name="text-database-row-select-attlist" combine="interleave"><optional><attribute name="text:row-number"><ref name="nonNegativeInteger"/></attribute></optional></define>

6.5.5 Displaying the Row Number
The <text:database-row-number> element displays the current row number for a given
table. Note that the element displays the actual row number from the database and not the row
number of the current selection that is used as an attribute value in the <text:database-rowselect> element.
The attributes that may be associated with the <text:database-row-number> are:•text:database-name, text:table-name and text:table-type
These attributes determine the database and the database table that this field uses.

•

style:num-format and style:num-letter-sync
These attributes determine how the number should be formatted. See section 6.7.8 for more
information on how to use these attributes.

•

text:value

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 130 of 738

This attribute specifies the current row number. The number changes when new data isadded to the current document.
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150

<define name="paragraph-content" combine="choice"><element name="text:database-row-number"><interleave><ref name="common-field-database-table"/><ref name="common-field-num-format-attlist"/><optional><attribute name="text:value"><ref name="nonNegativeInteger"/></attribute></optional></interleave><text/></element></define>

6.5.6 Display Current Database and Table
Office applications may keeps track of the last database and table that was used in the document.
In other words, the table that is used by the last field that was inserted into the document. The<text:database-name> element displays the database and table name of the most recently
used table.
The attributes that may be associated with the <text:database-name> element are:•text:database-name, text:table-name and text:table-type
These attributes determine the database and the database table that this field uses.

2151
2152
2153
2154
2155
2156

<define name="paragraph-content" combine="choice"><element name="text:database-name"><ref name="common-field-database-table"/><text/></element></define>

6.6 More Fields
6.6.1 Page Variable Fields
Page variables allow an alternative page numbering scheme to be defined. There is only one
page variable, and it is set by any set page variable field in the document. The value of the pagevariable is increased on each page, in the same way as regular page numbers.

Setting Page Variable Fields
To set a page variable field, use the <text:variable-page-set> element.
2157
2158
2159
2160
2161
2162

<define name="paragraph-content" combine="choice"><element name="text:page-variable-set"><ref name="text-set-page-variable-attlist"/><text/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 131 of 738

Turning Page Variables On or Off
At the beginning of a document, the page variable is inactive. The text:active attribute can beused to disable a page variable after it was used in the document.
2163
2164
2165
2166
2167
2168
2169

<define name="text-set-page-variable-attlist" combine="interleave"><optional><attribute name="text:active"><ref name="boolean"/></attribute></optional></define>

Page Variable Adjustment
The text:page-adjust attribute determines the page adjustment. The value of the active pagevariable is the current page number plus the closest page adjustment value that was previously
set.
2170
2171
2172
2173
2174
2175
2176

<define name="text-set-page-variable-attlist" combine="interleave"><optional><attribute name="text:page-adjust"><ref name="integer"/></attribute></optional></define>

Displaying Page Variable Fields
The <text:variable-page-get> element displays the value of the page variable. The field
can be formatted in the same way as regular page number fields.
2177
2178
2179
2180
2181
2182

<define name="paragraph-content" combine="choice"><element name="text:page-variable-get"><ref name="text-get-page-variable-attlist"/><text/></element></define>

The attributes that may be associated with the <text:get-page-variable> element are:•style:num-format and style:num-letter-sync
These attributes determine how the number should be formatted. See section 6.7.8 for more
information on how to use these attributes.

2183
2184
2185

<define name="text-get-page-variable-attlist" combine="interleave"><ref name="common-field-num-format-attlist"/></define>

6.6.2 Placeholders
The OpenDocument format uses placeholder fields to indicate locations in a document where theuser must fill in some information. For example in a letter template, a section of the document canbe reserved for the address of the recipient. A placeholder field displays text informing the user
about the purpose of the placeholder and sometimes includes a description. Placeholder fields
can represent different text elements, such as text or tables.
This element contains some brief text which is displayed with the placeholder.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 132 of 738

2186
2187
2188
2189
2190
2191

<define name="paragraph-content" combine="choice"><element name="text:placeholder"><ref name="text-placeholder-attlist"/><text/></element></define>

The attributes that may be associated with the <text:placeholder> element are:•Placeholder type•

Placeholder description

Placeholder Type
There are five different types of placeholder, representing the five possible types of content: text,
tables, text boxes, images, or objects. The text:placeholder-type attribute represents thecontent type. This attribute is mandatory and it indicates which type of text content the placeholder
represents. The value of the attribute can be text, text-box, image, table, or object.
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202

<define name="text-placeholder-attlist" combine="interleave"><attribute name="text:placeholder-type"><choice><value>text</value><value>table</value><value>text-box</value><value>image</value><value>object</value></choice></attribute></define>

Placeholder Description
In addition to the brief text stored in the element content, may be associated atext:description attribute with the placeholder element. This attribute is optional. The
purpose of the attribute is to contain a more elaborate description of the purpose of theplaceholder than the description stored in the element content. See section 6.7.4 for information
on using the text:description attribute.
2203
2204
2205

<define name="text-placeholder-attlist" combine="interleave"><ref name="common-field-description-attlist"/></define>

6.6.3 Conditional Text Fields
Text fields can be used to display one text or another, depending on a condition. Conditional text
fields are given a condition and two text strings. If the condition is true, one of the text strings is
displayed. If the condition is false, the other text string is displayed.
2206
2207
2208
2209
2210
2211

<define name="paragraph-content" combine="choice"><element name="text:conditional-text"><ref name="text-conditional-text-attlist"/><text/></element></define>

The attributes that may be associated with the <text:conditional-text> element are:•Condition

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 133 of 738

•

Text to display if the condition is true•

Text to display if the condition is false•

Current condition

The text:condition attribute contains a Boolean expression. Depending on the result, thevalue of the text:display-if-true or text:display-if-false attribute is displayed.
2212
2213
2214
2215
2216

<define name="text-conditional-text-attlist" combine="interleave"><attribute name="text:condition"><ref name="formula"/></attribute></define>

Text to Display if the Condition is True
The text:string-value-if-true attribute contains the text string to display if the conditionis true.
2217
2218
2219
2220
2221

<define name="text-conditional-text-attlist" combine="interleave"><attribute name="text:string-value-if-true"><ref name="string"/></attribute></define>

Text to Display if the Condition is False
The text:string-value-if-false attribute contains the text string to display if the condition
is false.
2222
2223
2224
2225
2226

<define name="text-conditional-text-attlist" combine="interleave"><attribute name="text:string-value-if-false"><ref name="string"/></attribute></define>

Current Value and Condition
The text:current-value attribute contains the evaluation result of the condition given by theexpression in the text:condition attribute. Explicitly giving the result allows applications todelay evaluating the result until necessary. This attribute is valuable for the following reasons:

2227
2228
2229
2230
2231
2232
2233

•

If the expression is costly to evaluate, for example, the expression contains references toseveral databases.

•

To allow transformations to correctly display the state of the document without having to parseand evaluate the condition.

<define name="text-conditional-text-attlist" combine="interleave"><optional><attribute name="text:current-value"><ref name="boolean"/></attribute></optional></define>

Note: The value of this attribute is overwritten with a new value as soon as theapplication evaluates the expression. This attribute has no function other than toease transformation or initially display the document.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 134 of 738

6.6.4 Hidden Text Field
The hidden text field is closely related to the conditional text field. It displays fixed text, except
when the condition is true when it does not display anything.
2234
2235
2236
2237
2238
2239

<define name="paragraph-content" combine="choice"><element name="text:hidden-text"><ref name="text-hidden-text-attlist"/><text/></element></define>

The attributes that may be associated with the <text:hidden-text> element are:•Condition

•

Text

•

Is hidden

Condition
The text:condition attribute contains a Boolean expression. If the expression evaluates totrue, the text is hidden.
2240
2241
2242
2243
2244

<define name="text-hidden-text-attlist" combine="interleave"><attribute name="text:condition"><ref name="formula"/></attribute></define>

Text
The text:string-value attribute specifies the text to display if the condition is false.
2245
2246
2247
2248
2249

<define name="text-hidden-text-attlist" combine="interleave"><attribute name="text:string-value"><ref name="string"/></attribute></define>

Is Hidden
The text:is-hidden attribute specifies whether or not the field is currently visible. The purposeof this attribute is similar to that of the text:current-value attribute in the text:condition
field. Recording the result allows transformations to correctly represent the document without
having to parse the condition expression or evaluate the condition when loading the document.
2250
2251
2252
2253
2254
2255
2256

<define name="text-hidden-text-attlist" combine="interleave"><optional><attribute name="text:is-hidden"><ref name="boolean"/></attribute></optional></define>

Note: The value of this attribute is overwritten with a new value as soon as theapplication evaluates the expression. This attribute has no function other than toease transformation or initially display the document.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 135 of 738

6.6.5 Reference Fields
The OpenDocument format uses four types of reference field and each type is represented by its
own element. The reference field types are based on the type of element they refer to; notes,
bookmarks, references, and sequences. Every reference contains a reference format which
determines what information about the referenced target is displayed. For example, references
can display:•

The page number of the referenced target•

The chapter number of the referenced target•

Wording indicating whether the referenced target is above or below the reference field

In addition, each reference field must identify its target which is usually done using a nameattribute. Bookmarks and references are identified by the name of the respective bookmark or
reference. Footnotes, endnotes, and sequences are are assigned names by the application used
to create the OpenDocument file format automatically.
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288

<define name="paragraph-content" combine="choice"><element><choice><name>text:reference-ref</name><name>text:bookmark-ref</name></choice><interleave><ref name="text-common-ref-content"/><ref name="text-ref-content"/></interleave></element></define><define name="paragraph-content" combine="choice"><element name="text:note-ref"><interleave><ref name="text-common-ref-content"/><ref name="text-note-ref-content"/><ref name="text-ref-content"/></interleave></element></define><define name="paragraph-content" combine="choice"><element name="text:sequence-ref"><interleave><ref name="text-common-ref-content"/><ref name="text-sequence-ref-content"/></interleave></element></define><define name="text-common-ref-content" combine="interleave"><text/></define>

The attributes that may be associated with the reference field elements are:•

Reference name•

Reference format

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 136 of 738

Reference Name
The text:ref-name attribute identifies the referenced element. Since bookmarks andreferences have a name, this name is used by the respective reference fields. Footnotes,
endnotes, and sequences are are identified by a name that is usually generated automatically.
2289
2290
2291
2292
2293
2294
2295

<define name="text-common-ref-content" combine="interleave"><optional><attribute name="text:ref-name"><ref name="string"/></attribute></optional></define>

Note ClassFor <text:note-ref> elements, the text:note-class attribute determines whether the fieldreferences a foot- or an endnote.
2296
2297
2298

<define name="text-note-ref-content" combine="interleave"><ref name="text-note-class"/></define>

Reference Format
The text:reference-format attribute determines what information about the reference isdisplayed. If the reference format is not specified, the page format is used as the default.
All types of reference fields support the following values for this attribute formats:•page, which displays the number of the page on which the referenced item appears.

•

chapter, which displays the number of the chapter in which the referenced item appears.

•

direction, which displays whether the referenced item is above or below the reference
field.

•

text, which displays the text of the referenced item.

References to sequence fields support the following three additional values:

2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312

•

category-and-value, which displays the name and value of the sequence.

•

caption, which displays the caption in which the sequence is used.

•value, which displays the value of the sequence.

<define name="text-ref-content" combine="interleave"><optional><attribute name="text:reference-format"><choice><value>page</value><value>chapter</value><value>direction</value><value>text</value></choice></attribute></optional></define><define name="text-sequence-ref-content" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 137 of 738

2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325

<attribute name="text:reference-format"><choice><value>page</value><value>chapter</value><value>direction</value><value>text</value><value>category-and-value</value><value>caption</value><value>value</value></choice></attribute></optional></define>

Example: Different reference formats and displays
The following table shows all possible reference formats and the resulting reference display thatcan be used to refer to the table itself. The left column lists the value of the text:referenceformat attribute and the right column
Reference format

Reference display

page

138

chapter

3.7.27

text

Table 2: Examples of reference
formats

directionabove

category-and-value Table 1
captionExamples of reference formats

value

1

6.6.6 Script Fields
A script field stores scripts or sections of scripts. The field can be used to store and edit scriptsthat are attached to the document. The primary purpose of this field is to provide an equivalent to
the <script> element in [HTML4], so that the content of a <script> element in HTML can beimported, edited, and exported using an office application software.
The source code for the script can be stored in one of the following ways:•

The <text:script> element contains the source code.

•

The source code is stored in an external file. Use the xlink:href attribute to specify thelocation of the source file.

The element should have either a xlink:href attribute or content, but not both.
2326
2327
2328
2329
2330
2331
2332

<define name="paragraph-content" combine="choice"><element name="text:script"><interleave><choice><group><attribute name="xlink:href"><ref name="anyURI"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 138 of 738

2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349

</attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional></group><text/></choice><optional><attribute name="script:language"><ref name="string"/></attribute></optional></interleave></element></define>

Script URL
The xlink:href attribute specifies the location of the file that contains the script source code.
The script field should have either an URL attribute or content, but not both.

Script Language
The script:language attribute specifies the language in which the script source code iswritten, for example, JavaScript.

6.6.7 Macro Fields
The macro field contains the name of a macro that is executed when the field is activated. The
field also contains a description that is displayed as the field content.
The only attribute that may be associated with the <text:execute-macro> element is:
•
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362

Macro name<define name="paragraph-content" combine="choice"><element name="text:execute-macro"><optional><attribute name="text:name"><ref name="string"/></attribute></optional><optional><ref name="office-event-listeners"/></optional><text/></element></define>

Macro Name
The text:name attribute specifies the macro to invoke when the field is activated.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 139 of 738

6.6.8 Hidden Paragraph Fields
The hidden paragraph field has a similar function to the hidden text field. However, the hidden
paragraph field does not have any content. It hides the paragraph in which it is contained. This
allows a paragraph of formatted text to be hidden or displayed depending on whether a conditionis true or false.
Hidden paragraph fields are often used together with form letters. For example, if a condition
depends on a database field, a hidden paragraph field can be used to selectively include
paragraphs in the form letter depending on the database content. Multiple paragraph fields can becontained one paragraph. The paragraph is displayed if the condition associated with at least one
hidden paragraph field is false. Alternatively, the conditions associated with several hidden
paragraph fields can be combined into a single condition for a single field using logical operations
on the conditions.
Note: Unlike most fields, this field does not display text, but it affects the entire
paragraph in which it is contained.
The attributes that may be associated with the <text:hidden-paragraph> element are:

2363
2364
2365
2366
2367
2368

•

Condition•

Is hidden<define name="paragraph-content" combine="choice"><element name="text:hidden-paragraph"><ref name="text-hidden-paragraph-attlist"/><text/></element></define>

Condition
The text:condition attribute contains a Boolean expression. If the condition is true, theparagraph is hidden. If the condition is false, the paragraph is displayed.
2369
2370
2371
2372
2373

<define name="text-hidden-paragraph-attlist" combine="interleave"><attribute name="text:condition"><ref name="formula"/></attribute></define>

Is Hidden
The text:is-hidden attribute records whether the paragraph is currently visible or not. It has
the same purpose as the corresponding attribute of the hidden text field, namely to allow correct
display of the paragraph without having to evaluate the condition first. The value of this attribute isoverwritten with a new value as soon as the application evaluates the expression.
Note: This attribute has no function other than to ease transformation or initiallydisplay the document.
2374
2375
2376
2377
2378
2379
2380

<define name="text-hidden-paragraph-attlist" combine="interleave"><optional><attribute name="text:is-hidden"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 140 of 738

6.6.9 DDE Connection Fields
A DDE field allows information from a DDE connection to be displayed. The only parameterrequired for the DDE field is the name of the DDE connection that supplies the data to this field.
This DDE connection element specifies the actual DDE field that appears in the text body.
The field element contains the content of the most recent data that was received from the DDE
connection. This may be used to render the document if the DDE connection cannot be accessed.
See section 12.6 for the use of DDE connections.
2381
2382
2383
2384
2385
2386
2387
2388

<define name="paragraph-content" combine="choice"><element name="text:dde-connection"><attribute name="text:connection-name"><ref name="string"/></attribute><text/></element></define>

The only attribute that may be associated with the <text:dde-connection> element is:•

DDE connection name

DDE Connection Name
The text:name attribute specifies the name of the DDE connection to which the field refers.

6.6.10 Measure Fields
Within the text contained in measure drawing objects (see section 9.2.11), a <text:measure>field displays the current measure. The draw:kind attribute specifies which part of the measure
is displayed. It my have one of the following values:

2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400

•

value: The measure's value is displayed, for instance “12”•unit: The measure's unit is displayed, for instance “inch”•

gap: A gap or blank is displayed if and only if the measure text's writing direction isperpendicular to the measure line. The purpose of this value is add some space between themeasure line and the text if the text is displayed perpendicular to the measure line.

<define name="paragraph-content" combine="choice"><element name="text:measure"><attribute name="text:kind"><choice><value>value</value><value>unit</value><value>gap</value></choice></attribute><text/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 141 of 738

6.6.11 Table Formula Field
The table formula field is a legacy from previous versions of current office applications. It should
not be used in new documents. It stores a formula to be used in tables, a function that is better
performed by the table:formula attribute of the table cell.
Note: This element should not be used in new documents.
The table formula field can take the following attributes:•

text:formulaThis attribute contains the actual expression used to compute the value of the table formula
field. See section 6.7.6 for information on using this attribute.

•

text:display
Use this attribute to specify one of the following:–

To display the value of the field.

–

To display the formula used to compute the value.

See section 6.7.5 for information on using this attribute.
•style:data-style-nameThis attribute specifies the data style to use to format a numeric, Boolean, or date/time
variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for
information on using this attribute.

2401
2402
2403
2404
2405
2406
2407
2408
2409
2410

<define name="paragraph-content" combine="choice"><element name="text:table-formula"><interleave><ref name="common-field-formula-attlist"/><ref name="common-field-display-value-formula-attlist"/><ref name="common-field-data-style-name-attlist"/></interleave><text/></element></define>

6.7 Common Field Attributes
The attributes described in this section can be used with several field elements.

6.7.1 Variable Value Types and Values
Variables and most variable fields have a current value. Every variable has a value type that mustbe specified when the field supports multiple value types. The value type is specified using theoffice:value-type attribute.
2411
2412
2413
2414
2415

<define name="common-value-type-attlist"><attribute name="office:value-type"><ref name="valueType"/></attribute></define>

Depending on the value type, the value itself is written to different value attributes. The supported
value types, their respective value attributes, and how the values are encoded are described in
the following table:
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 142 of 738

Value Type

Value Attribute(s)Encoded as...

Exampleoffice:value

Numeric value"12.345"

percentage office:value

Numeric value"0.50"

float

currency

office:value andoffice:currency

Numeric value andcurrency symbol

"100"
"USD"

date

office:date-value

Date value as specified in §3.2.9of [xmlschema-2], or date andtime value as specified in §3.2.7
of [xmlschema-2]"2003-04-17"

timeoffice:time-value

Duration, as specified in §3.2.6 of "PT03H30M00S"[xmlschema-2]

booleanoffice:boolean-value true or false

stringoffice:string-value

Strings"true""abc def"

The OpenDocument concept of field values and value types and their encoding in XML ismodeled on the corresponding XML for table cell attributes. See section 8.1.3 for information ontable cells and their attributes.
The definition of the entity %value-attlist; is as follows:
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449

<define name="common-value-and-type-attlist"><choice><group><attribute name="office:value-type"><value>float</value></attribute><attribute name="office:value"><ref name="double"/></attribute></group><group><attribute name="office:value-type"><value>percentage</value></attribute><attribute name="office:value"><ref name="double"/></attribute></group><group><attribute name="office:value-type"><value>currency</value></attribute><attribute name="office:value"><ref name="double"/></attribute><optional><attribute name="office:currency"><ref name="string"/></attribute></optional></group><group><attribute name="office:value-type"><value>date</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 143 of 738

2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482

</attribute><attribute name="office:date-value"><ref name="dateOrDateTime"/></attribute></group><group><attribute name="office:value-type"><value>time</value></attribute><attribute name="office:time-value"><ref name="duration"/></attribute></group><group><attribute name="office:value-type"><value>boolean</value></attribute><attribute name="office:boolean-value"><ref name="boolean"/></attribute></group><group><attribute name="office:value-type"><value>string</value></attribute><optional><attribute name="office:string-value"><ref name="string"/></attribute></optional></group></choice></define>

6.7.2 Fixed
The text:fixed attribute specifies whether or not the value of a field element is fixed. If thevalue of a field is fixed, the value of the field element to which this attribute is attached ispreserved in all future edits of the document. If the value of the field is not fixed, the value of the
field may be replaced by a new value when the document is edited.
This attribute can be used with:

2483
2484
2485
2486
2487
2488
2489

•

Date fields•

Time fields•

Page number fields•

All sender fields•

All author fields<define name="common-field-fixed-attlist"><optional><attribute name="text:fixed"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 144 of 738

6.7.3 Variable Name
Use the text:name attribute to specify the name of a variable when it is being declared, set, or
displayed a variable. This attribute can be used with any of the following elements:•<text:variable-del>•<text:variable-set>•<text:variable-get>•<text:variable-input>•<text:user-field-del>•<text:user-field-get>•<text:user-field-input>•<text:sequence-del>•<text:sequence>

When this attribute is being used to specify the name of a variable to display, a variable of theappropriate type with the same name must already have been declared.
2490
2491
2492
2493
2494

<define name="common-field-name-attlist"><attribute name="text:name"><ref name="variableName"/></attribute></define>

6.7.4 Description
The text:description attribute contains a brief message that is displayed when users areprompted for input. This attribute can be used with any of the following elements:

2495
2496
2497
2498
2499
2500
2501

•

<text:placeholder>•<text:variable-input>•<text:user-field-input>•<text:text-input><define name="common-field-description-attlist"><optional><attribute name="text:description"><text/></attribute></optional></define>

6.7.5 Display
The text:display attribute supports up to three values as follows:•

valueThis value displays the value of the field. Some fields do not support this value. In thesecases, the text:display attribute only takes the values value or none, and value or
formula, respectively.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 145 of 738

•formulaThis value allows the display of the formula rather than the value of the field. Some fields do
not support this value. In these cases, the text:display attribute only takes the values
value or none, and value or formula, respectively.

•

none
Several variable fields support this value, which hides the field content. This allows variables
to be set in one part of the document and displayed in another part of the document.

This attribute can be used with any of the following elements:

2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532

•

<text:variable-set>•<text:variable-get>•<text:variable-input>•<text:user-field-get>•<text:expression><define name="common-field-display-value-none-attlist"><optional><attribute name="text:display"><choice><value>value</value><value>none</value></choice></attribute></optional></define><define name="common-field-display-value-formula-none-attlist"><optional><attribute name="text:display"><choice><value>value</value><value>formula</value><value>none</value></choice></attribute></optional></define><define name="common-field-display-value-formula-attlist"><optional><attribute name="text:display"><choice><value>value</value><value>formula</value></choice></attribute></optional></define>

6.7.6 Formula
The text:formula attribute contains the formula or expression used to compute the value ofthe field. This attribute can be used with any of the following elements:•<text:variable-set>•<text:user-field-del>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 146 of 738

•<text:sequence>•<text:expression>

The formula should start with a namespace prefix that indicates the syntax and semantic usedwithin the formula.
2533
2534
2535
2536
2537
2538
2539

<define name="common-field-formula-attlist"><optional><attribute name="text:formula"><ref name="formula"/></attribute></optional></define>

6.7.7 Formatting Style
The style:data-style-name attribute refers to the data style used to format the numericvalue. For general information about styles, see Chapter 14. For more information about datastyles, see section 14.7.
For string variables this attribute must be omitted. Otherwise, this attribute is required.
The name must match the name of a data style.
This attribute can be used with any of the following elements:

2540
2541
2542
2543
2544
2545
2546

•

<text:date>•<text:time>•<text:page-number>•<text:variable-set>•<text:variable-get>•<text:variable-input>•<text:user-field-get>•<text:user-field-input>•<text:expression><define name="common-field-data-style-name-attlist"><optional><attribute name="style:data-style-name"><ref name="styleNameRef"/></attribute></optional></define>

6.7.8 Number Formatting Style
Numbers that are used for number sequences such as page numbers or sequence fields can beformatted according to the number styles described in section 12.2. The number styles supported
are as follows:•

Numeric: 1, 2, 3, ...

•Alphabetic: a, b, c, ... or A, B, C, ...

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 147 of 738

•Roman: i, ii, iii, iv, ... or I, II, III, IV,...
Note: The value of this attribute can be any of the [XSLT] number format keys 1,
i, I, a, or A.

Alphabetic number styles need an additional attribute to determine how to display numbers thatcannot be represented by a single letter. The OpenDocument format supports:•

Synchronized letter numbering, where letters are used multiple times, for example aa, bb, cc,
and so on.

•

Non-synchronized letter numbering, for example aa, ab, ac, and so on.

See section 12.2 for more information.
2547
2548
2549
2550
2551

<define name="common-field-num-format-attlist"><optional><ref name="common-num-format-attlist"/></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 148 of 738

7 Text Indices
OpenDocument text documents may contain automatically generated indices. An index generally
contains a sorted list of all items of a certain types, where the sorting (document position,alphabetical, etc.) and the type of items (chapter headings, tables, etc.) are determined by the
specific type of index.

7.1 Index Marks
There are three types of index marks that correspond to the three types of index that make use ofindex marks. The three types of index marks are:•Table of content index marks•

User-defined index marks•

Alphabetical index marks

The XML code for index marks is similar to the code for Bookmarks and References. The
following are some basic rules about index marks:•

Each index mark is represented by a start and an end element.

•

Both elements use an ID attribute to match the appropriate start and end elements.

•

The start and end elements for an index mark must be contained in the same paragraph, withthe start element occurring first.

•

The attributes associated with the index mark are attached to the start element.

•

The text between the start and end elements is the text the index entry.

•

The formatting attributes for index marks can overlap.

7.1.1 Table of Content Index Marks
The <text:toc-mark-start> element marks the start of a table of content index entry. The ID
specified by the text:id attribute must be unique except for the matching index mark end
element. There must be an end element to match the start element located in the same
paragraph, with the start element appearing first.
2552
2553
2554
2555
2556

<define name="paragraph-content" combine="choice"><element name="text:toc-mark-start"><ref name="text-toc-mark-start-attrs"/></element></define>

The attributes associated with the <text:toc-mark-start> element are:

2557
2558
2559

•

A text:id attribute to allow the start and end elements to be matched.

•

A text:outline-level attribute to specify the outline level of the resulting table of content
index entry.

<define name="text-toc-mark-start-attrs"><ref name="text-id"/><ref name="text-outline-level"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 149 of 738

2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572

</define><define name="text-outline-level"><optional><attribute name="text:outline-level"><ref name="positiveInteger"/></attribute></optional></define><define name="text-id"><attribute name="text:id"><ref name="string"/></attribute></define>

The <text:toc-mark-end> element marks the end of a table of contents index entry. There
must be a start element with the same text:id value to match the end element located in thesame paragraph, with the start element appearing first.
2573
2574
2575
2576
2577

<define name="paragraph-content" combine="choice"><element name="text:toc-mark-end"><ref name="text-id"/></element></define>

Table of content index marks also have a variant that does not enclose the text to be indexed.
This is represented using the <text:toc-mark> element which contains a text:stringvalue attribute for the text of the index entry. In this situation, a text:id attribute is notnecessary because there are no start and end elements to match.
2578
2579
2580
2581
2582
2583
2584
2585

<define name="paragraph-content" combine="choice"><element name="text:toc-mark"><attribute name="text:string-value"><ref name="string"/></attribute><ref name="text-outline-level"/></element></define>

7.1.2 User-Defined Index Marks
The <text:user-index-mark-start> element marks the start of a user-defined index entry.
The ID specified by the text:id attribute must be unique except for the matching index markend element. There must be an end element to match the start element located in the same
paragraph, with the start element appearing first.
2586
2587
2588
2589
2590
2591
2592

<define name="paragraph-content" combine="choice"><element name="text:user-index-mark-start"><ref name="text-id"/><ref name="text-outline-level"/><ref name="text-index-name"/></element></define>

The <text:user-index-mark-end> element marks the end of the user-defined index entry.
There must be a start element with the same text:id value to match the end element located in
the same paragraph, with the start element appearing first.
2593
2594
2595
2596

<define name="paragraph-content" combine="choice"><element name="text:user-index-mark-end"><ref name="text-id"/><ref name="text-outline-level"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 150 of 738

2597
2598

</element></define>

User index marks also have a variant that does not enclose the text to be indexed. This isrepresented by the <text:user-index-mark> element which contains a text:stringvalue attribute for the text of the index entry. In this situation, the text:id attribute is notnecessary because there are no start and end elements to match.
2599
2600
2601
2602
2603
2604
2605
2606
2607

<define name="paragraph-content" combine="choice"><element name="text:user-index-mark"><attribute name="text:string-value"><ref name="string"/></attribute><ref name="text-outline-level"/><ref name="text-index-name"/></element></define>

Name of User Index
There can be more than one user-defined index. In this case, the user index must be named
using the text:index-name attribute. This attribute determines to which user-defined index anindex mark belongs. If no name is given, the default user-defined index is used.
2608
2609
2610
2611
2612

<define name="text-index-name"><attribute name="text:index-name"><ref name="string"/></attribute></define>

7.1.3 Alphabetical Index MarkThe <text:alpha-index-mark-start> element marks the start of an alphabetical index
entry. There are two optional attributes that may contain keys for alphabetical entries, whichallows structuring of entries. There is also a Boolean attribute that determines if this entry isintended to be the main entry, if there are several equal entries.
The ID specified by the text:id attribute must be unique except for the matching index mark end
element. There must be an end element to match the start element located in the same
paragraph, with the start element appearing first.
2613
2614
2615
2616
2617
2618

<define name="paragraph-content" combine="choice"><element name="text:alphabetical-index-mark-start"><ref name="text-id"/><ref name="text-alphabetical-index-mark-attrs"/></element></define>

The attributes associated with the <text:toc-mark-start> element are:•A text:id attribute to allow the start and end elements to be matched.

•

Additional keys•

Main entry

The <text:alpha-index-mark-end> element marks the end of an alphabetical index entry.
There must be a start element with the same text:id value to match the end element located in thesame paragraph, with the start element appearing first.
2619<define name="paragraph-content" combine="choice">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 151 of 738

2620
2621
2622
2623

<element name="text:alphabetical-index-mark-end"><ref name="text-id"/></element></define>

Alphabetical index marks also have a variant that does not enclose the text to be indexed. This isrepresented using the <text:alpha-index-mark> element which contains a text:stringvalue attribute for the text of the index entry. In this situation, a text:id attribute is notnecessary because there are no start and end elements to match.
2624
2625
2626
2627
2628
2629
2630
2631

<define name="paragraph-content" combine="choice"><element name="text:alphabetical-index-mark"><attribute name="text:string-value"><ref name="string"/></attribute><ref name="text-alphabetical-index-mark-attrs"/></element></define>

Additional Keys
The text:key1 and text:key2 attributes specify additional keys for the alphabetical index
mark. If only one key is used, it must be contained in the text:key1 attribute.
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643

<define name="text-alphabetical-index-mark-attrs" combine="interleave"><optional><attribute name="text:key1"><ref name="string"/></attribute></optional><optional><attribute name="text:key2"><ref name="string"/></attribute></optional></define>

Phonetic Keys
For ideographic languages, there sometimes is no obvious or common sorting of the language's
characters. One common scheme to facilitate an alphabetical index in such languages is to sortaccording to a phonetic description of the search time. To achieve this in the OpenDocument fileformat, there are additional attributes for the string value and the two keys for phonetic
descriptions. The original value and key attributes are for display, but if phonetic variants arepresent, they should be used for sorting the index.
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657

<define name="text-alphabetical-index-mark-attrs" combine="interleave"><optional><attribute name="text:string-value-phonetic"><ref name="string"/></attribute></optional><optional><attribute name="text:key1-phonetic"><ref name="string"/></attribute></optional><optional><attribute name="text:key2-phonetic"><ref name="string"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 152 of 738

2658
2659
2660

</attribute></optional></define>

Main Entry
If there are several index marks for the same entry, one of these entries may be declared as themain entry using the text:main-entry attribute.
2661
2662
2663
2664
2665
2666
2667

<define name="text-alphabetical-index-mark-attrs" combine="interleave"><optional><attribute name="text:main-entry" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

7.1.4 Bibliography Index MarkThe <text:bibliography-mark> element contains the text and information for a bibliographyindex entry. It supports attributes for each type of bibliographical data that a bibliography index
may contain.
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704

<define name="paragraph-content" combine="choice"><element name="text:bibliography-mark"><attribute name="text:bibliography-type"><ref name="text-bibliography-types"/></attribute><zeroOrMore><attribute><choice><name>text:identifier</name><name>text:address</name><name>text:annote</name><name>text:author</name><name>text:booktitle</name><name>text:chapter</name><name>text:edition</name><name>text:editor</name><name>text:howpublished</name><name>text:institution</name><name>text:journal</name><name>text:month</name><name>text:note</name><name>text:number</name><name>text:organizations</name><name>text:pages</name><name>text:publisher</name><name>text:school</name><name>text:series</name><name>text:title</name><name>text:report-type</name><name>text:volume</name><name>text:year</name><name>text:url</name><name>text:custom1</name><name>text:custom2</name><name>text:custom3</name><name>text:custom4</name><name>text:custom5</name>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 153 of 738

2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739

<name>text:isbn</name><name>text:issn</name></choice><ref name="string"/></attribute></zeroOrMore><text/></element></define><define name="text-bibliography-types"><choice><value>article</value><value>book</value><value>booklet</value><value>conference</value><value>custom1</value><value>custom2</value><value>custom3</value><value>custom4</value><value>custom5</value><value>email</value><value>inbook</value><value>incollection</value><value>inproceedings</value><value>journal</value><value>manual</value><value>mastersthesis</value><value>misc</value><value>phdthesis</value><value>proceedings</value><value>techreport</value><value>unpublished</value><value>www</value></choice></define>

7.2 Index Structure
An index consists of two parts: The index source, and the index body. Both of these are containedin an element of their own, which in turn form the two child elements for the index element itself.
The index source is specific to the type of index it is being used for. It contains the informationnecessary to generate the index content. An index source has no graphical rendition.
The index body is the same for all types of indices. It contains the text generated from theinformation in the index source. The text contained in an index body is in no way special ordifferent from text used elsewhere in this specification.
The content of the index body can be regenerated at any time from the information contained in
the index source and the remainder of the document. One could say that the index source
contains all the logical information about an index, while the index body contains the rendition of
the index. A tool extracting structure information about a document might look only at the index
source, while a rendering program might look only at an index body.

7.2.1 Index Source
An index source element contains the information necessary to generate the index body. In
addition to a set of flags that determine which information to include in an index, the index source
contains a set of index templates. Such a template determines how an item to be contained in theindex is to be rendered.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 154 of 738

For example, a table of content might look as follows:
1 Introduction............................................................................ .........................7
1.1 Namespaces............................................................................... .................7
1.2 Relax-NG Schema Prefix........................................................... ..................8
An index source for this index would contain flags indicating that chapter headers at least up tolevel 2 are to be included. The contained index templates would define that an entry consists ofthe chapter number, a space, the chapter name, a tab (with a '.' leader) and the page number.
The various index templates are described together with their index elements. The index
templates elements in use are described in section 7.12.
The different index source elements are described together with their corresponding index
elements.

7.2.2 Index Body Section
The index body contains the current textual rendition of the index. The format is the same as forregular text within this specification, e.g., text sections, except that it also allows index title
sections.
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752

<define name="text-index-body"><element name="text:index-body"><zeroOrMore><ref name="index-content-main"/></zeroOrMore></element></define><define name="index-content-main"><choice><ref name="text-content"/><ref name="text-index-title"/></choice></define>

7.2.3 Index Title Section
The index title is usually contained in a section of its own. The reason for this enclosure is toenable the popular layout of having an index title across the entire page, but having the index itself
in a two column layout.
2753
2754
2755
2756
2757
2758
2759
2760

<define name="text-index-title"><element name="text:index-title"><ref name="sectionAttr"/><zeroOrMore><ref name="index-content-main"/></zeroOrMore></element></define>

7.3 Table Of Content
A table of contents provides the user with a guide through the content of the document. It is
typically found at the beginning of a document, contains the chapter headings with their respective
page numbers. An example for a table of content may be found at the beginning of this document.
The items that can be listed in a table of content are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 155 of 738

•

Headers (as defined by the outline structure of the document), up to a selectable level•

Table of content index marks•

Paragraphs formatted with a set of selectable paragraph styles

The table of contents is represented by the <text:table-of-content> element. The<text:table-of-content> element supports the same style (and class) attributes as a text
section (see section 4.4).
2761
2762
2763
2764
2765
2766
2767

<define name="text-table-of-content"><element name="text:table-of-content"><ref name="sectionAttr"/><ref name="text-table-of-content-source"/><ref name="text-index-body"/></element></define>

7.3.1 Table of Content Source
The <text:table-of-content-source> element specifies how the table of contents isgenerated. It specifies how the entries are gathered.
The <text:table-of-content-source> element contains

2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781

•

an optional template for the index title•

optional templates for index entries, one per level•

optionally a list of styles to be used for gathering index entries<define name="text-table-of-content-source"><element name="text:table-of-content-source"><ref name="text-table-of-content-source-attlist"/><optional><ref name="text-index-title-template"/></optional><zeroOrMore><ref name="text-table-of-content-entry-template"/></zeroOrMore><zeroOrMore><ref name="text-index-source-styles"/></zeroOrMore></element></define>

The attributes that may be associated with the <text:table-of-content-source> element
are:•Outline level•

Use outline•

Use index marks•

Use index source styles•

Index source•

Relative tab stop position

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 156 of 738

Outline Level
The text:outline-level attribute specifies which outline levels are used when generating thetable of contents.
The value of this attribute must be an integer greater than zero. If this attribute is omitted, alloutline levels are used by default.
2782
2783
2784
2785
2786
2787
2788
2789
2790

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:outline-level"><choice><ref name="positiveInteger"/></choice></attribute></optional></define>

Use Outline
The text:use-outline-level attribute determines whether headings are used to generateindex entries. If the value is true, the table of contents includes entries generated from headings.
The text:outline-level attribute specifies up to which level headings are being included.
See section 7.1 for more information on index marks.
2791
2792
2793
2794
2795
2796
2797

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:use-outline-level" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Use Index Marks
The text:use-index-marks attribute determines whether or not index marks are used togenerate index entries. If the value is true, the table of contents includes entries generated fromtable of content index marks. The text:outline-level attribute specifies up to which levelindex marks are being included. See section 7.1 for more information on index marks.
2798
2799
2800
2801
2802
2803
2804

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:use-index-marks"><ref name="boolean"/></attribute></optional></define>

Use Index Source Styles
The text:use-index-source-styles attribute determines whether or not index entries are
generated for paragraph formatted using certain paragraph styles. If the value is true, the tableof contents includes an entry for every paragraph formatted with one of the styles specified in a<text:index-source-style> element. The text:outline-level attribute specifies up towhich level index source styles are being included.
2805
2806
2807

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:use-index-source-styles">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 157 of 738

2808
2809
2810
2811

<ref name="boolean"/></attribute></optional></define>Index Scope
The text:index-scope attribute determines whether the table-of-content is generated for thewhole document, or only for the current chapter.
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:index-scope"><choice><value>document</value><value>chapter</value></choice></attribute></optional></define>

Relative Tab-Stop Position
The text:relative-tab-stop-position attribute determines whether the position of tab
stops is relative to the left margin or to the left indent as determined by the paragraph style. This isuseful for copying the same entry configuration for all outline levels because with relative tab stop
positions the tabs do not need to be adjusted to the respective paragraph format.
2822
2823
2824
2825
2826
2827
2828

<define name="text-table-of-content-source-attlist" combine="interleave"><optional><attribute name="text:relative-tab-stop-position"><ref name="boolean"/></attribute></optional></define>

7.3.2 Table of Content Entry Template
The <text:table-of-content-entry-template> element determines the format of anindex entry for a particular outline level. For each table of content, there must not be more than
one element for any outline level. (See below.)
2829
2830
2831
2832
2833

<define name="text-table-of-content-entry-template"><element name="text:table-of-content-entry-template"><ref name="text-table-of-content-entry-template-attlist"/><zeroOrMore><ref name="text-table-of-content-children"/>

2834
2835
2836
2837

</zeroOrMore></element></define>

A table of content entry template supports the following kinds of text elements:•

Chapter and Page Number•

Reference Text•

Text Span

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 158 of 738

2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848

•

Tab

•

Hyperlink start and end<define name="text-table-of-content-children"><choice><ref name="text-index-entry-chapter"/><ref name="text-index-entry-page-number"/><ref name="text-index-entry-text"/><ref name="text-index-entry-span"/><ref name="text-index-entry-tab-stop"/><ref name="text-index-entry-link-start"/><ref name="text-index-entry-link-end"/></choice></define>

The attributes that may be associated associate with the <text:table-of-content-entrytemplate> element are:● Template outline level● Paragraph styleTemplate Outline Level
This attribute specifies to which outline level the entry configuration applies. Outline levels must be
unique for the template elements in one index source.
2849
2850
2851
2852
2853
2854

<define name="text-table-of-content-entry-template-attlist"
combine="interleave"><attribute name="text:outline-level"><ref name="positiveInteger"/></attribute></define>

Paragraph Style
The text:style-name attribute specifies the paragraph style to use for this template.
2855
2856
2857
2858
2859
2860

<define name="text-table-of-content-entry-template-attlist"
combine="interleave"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></define>

7.4 Index of Illustrations
The index of illustrations lists all images and graphics in the current document or chapter. The
index entries can be derived from the caption of the illustration or the name of the illustration.
The attribute that may be attached to the <text:illustration-index> element is:•

text:style-nameThis attribute specifies the section style to use for the index of illustrations.

2861
2862
2863
2864

<define name="text-illustration-index"><element name="text:illustration-index"><ref name="sectionAttr"/><ref name="text-illustration-index-source"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 159 of 738

2865
2866
2867

<ref name="text-index-body"/></element></define>

7.4.1 Index of Illustration Source
The <text:illustration-index-source> element specifies how the index of illustrations isgenerated.
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878

<define name="text-illustration-index-source"><element name="text:illustration-index-source"><ref name="text-illustration-index-source-attrs"/><optional><ref name="text-index-title-template"/></optional><optional><ref name="text-illustration-index-entry-template"/></optional></element></define>

The attributes that may be associated with a <text:illustration-index-source> element
are:•

Use caption•

Caption sequence name•

Caption sequence format•

Index scopeThis attribute specifies whether the index applies to the entire document or only the thecurrent chapter.

•

text:relative-tab-stop-position
This attribute specifies whether the position of tab stops are interpreted relative to the left
margin or the left indent.

2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900

<define name="text-illustration-index-source-attrs" combine="interleave"><ref name="text-index-scope-attr"/></define><define name="text-index-scope-attr"><optional><attribute name="text:index-scope" a:defaultValue="document"><choice><value>document</value><value>chapter</value></choice></attribute></optional></define><define name="text-illustration-index-source-attrs" combine="interleave"><ref name="text-relative-tab-stop-position-attr"/></define><define name="text-relative-tab-stop-position-attr"><optional><attribute name="text:relative-tab-stop-position"
a:defaultValue="true"><ref name="boolean"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 160 of 738

2901
2902

</optional></define>

Use Caption
Each object contained in a text document has a name. In addition, images also have a caption.
The image caption or the image name can be gathered for the index of illustrations.
2903
2904
2905
2906
2907
2908
2909

<define name="text-illustration-index-source-attrs" combine="interleave"><optional><attribute name="text:use-caption" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Caption Sequence Name
Captions are associated with a sequence name. If the text:use-caption attribute is set totrue, this attribute must be used to specify the sequence with which the captions are associated.
If this attribute is omitted, the default sequence for the object type is used, for example thesequence “Illustration” is used for illustrations.
2910
2911
2912
2913
2914
2915
2916

<define name="text-illustration-index-source-attrs" combine="interleave"><optional><attribute name="text:caption-sequence-name"><ref name="string"/></attribute></optional></define>

Caption Sequence Format
If the entries for the index of illustrations are obtained from the image captions, this attribute must
be used to specify the format for the entries.
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927

<define name="text-illustration-index-source-attrs" combine="interleave"><optional><attribute name="text:caption-sequence-format"><choice><value>text</value><value>category-and-value</value><value>caption</value></choice></attribute></optional></define>

7.4.2 Illustration Index Entry Template
The illustration index entry template element determines the format of an index entry for aparticular outline level.
2928
2929
2930
2931
2932

<define name="text-illustration-index-entry-template"><element name="text:illustration-index-entry-template"><ref name="text-illustration-index-entry-content"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 161 of 738

2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943

<define name="text-illustration-index-entry-content"><ref name="text-illustration-index-entry-template-attrs"/><zeroOrMore><choice><ref name="text-index-entry-page-number"/><ref name="text-index-entry-text"/><ref name="text-index-entry-span"/><ref name="text-index-entry-tab-stop"/></choice></zeroOrMore></define>

The attribute that may be associated with the <text:illustration-index-entrytemplate> element is:•

Paragraph style

Paragraph Style
This attribute identifies the paragraph style to use for this template.
2944
2945
2946
2947
2948

<define name="text-illustration-index-entry-template-attrs"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></define>

7.5 Index of Tables
The index of tables lists all of the tables in the current document or chapter. It works in exactly thesame way as the index of illustrations.
2949
2950
2951
2952
2953
2954
2955

<define name="text-table-index"><element name="text:table-index"><ref name="sectionAttr"/><ref name="text-table-index-source"/><ref name="text-index-body"/></element></define>

7.5.1 Table Index Source
The <text:table-index-source> element specifies how the index of tables is generated.
The attributes that may be associated with this element are the same as those that can beassociated with the <text:illustration-index-source> element. See section 7.4.1 fordetailed information about these attributes.
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966

<define name="text-table-index-source"><element name="text:table-index-source"><ref name="text-illustration-index-source-attrs"/><optional><ref name="text-index-title-template"/></optional><optional><ref name="text-table-index-entry-template"/></optional></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 162 of 738

7.5.2 Table Index Entry Template
The table index entry template element determines the format of an index entry for a particularoutline level.
The attributes that may be associated with this element are the same as those that can beassociated with the <text:illustration-index-entry-template> element. See section
7.4.2 for detailed information about these attributes.
2967
2968
2969
2970
2971

<define name="text-table-index-entry-template"><element name="text:table-index-entry-template"><ref name="text-illustration-index-entry-content"/></element></define>

7.6 Index of Objects
The index of objects lists all of the objects in the current document or chapter. It gathers its entries
from the known object types.
2972
2973
2974
2975
2976
2977
2978

<define name="text-object-index"><element name="text:object-index"><ref name="sectionAttr"/><ref name="text-object-index-source"/><ref name="text-index-body"/></element></define>

7.6.1 Object Index Source
The <text:object-index-source> element determines which object types to include in theindex of objects. It also supports the standard index source attributes.
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989

<define name="text-object-index-source"><element name="text:object-index-source"><ref name="text-object-index-source-attrs"/><optional><ref name="text-index-title-template"/></optional><optional><ref name="text-object-index-entry-template"/></optional></element></define>

The attributes that may be associated with the <text:object-index-source> element are:•Use attributes, text:use-*-objects•

Index scope (see section 7.4.1)
This attribute specifies whether the index applies to the entire document or only the thecurrent chapter.

•

Relative tab stop position (see section 7.4.1)
This attribute specifies whether the position of tab stops are interpreted relative to the left
margin or the left indent.

2990
2991

<define name="text-object-index-source-attrs" combine="interleave"><ref name="text-index-scope-attr"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 163 of 738

2992
2993
2994
2995

</define><define name="text-object-index-source-attrs" combine="interleave"><ref name="text-relative-tab-stop-position-attr"/></define>

Use Attributes
The text:use-*-objects attributes specify which types of objects to include in the index ofobjects. There is an attribute for each type of object as follows:•

text:use-spreadsheet-objects•

text:use-draw-objects•

text:use-chart-objects•

text:use-math-objects

Other objects are included or omitted using the following attribute:
•
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030

text:use-other-objects<define name="text-object-index-source-attrs" combine="interleave"><optional><attribute name="text:use-spreadsheet-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define><define name="text-object-index-source-attrs" combine="interleave"><optional><attribute name="text:use-math-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define><define name="text-object-index-source-attrs" combine="interleave"><optional><attribute name="text:use-draw-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define><define name="text-object-index-source-attrs" combine="interleave"><optional><attribute name="text:use-chart-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define><define name="text-object-index-source-attrs" combine="interleave"><optional><attribute name="text:use-other-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 164 of 738

7.6.2 Object Index Entry Template
The object index entry template element determines the format of an index entry for a particularoutline level.
3031
3032
3033
3034
3035

<define name="text-object-index-entry-template"><element name="text:object-index-entry-template"><ref name="text-illustration-index-entry-content"/></element></define>

The attributes that may be associated with this element are the same as those that can beassociated with the <text:illustration-index-entry-template> element. See section
7.4.2 for detailed information about these attributes.

7.7 User-Defined Index
A user-defined index combines the capabilities of the indexes discussed earlier in this chapter. A
user-defined index can gather entries from the following sources:•

Index marks•

Paragraphs formatted using particular paragraph styles•

Tables, images, or objects•

Text frames

The <text:user-index> element represents a user-defined index.
3036
3037
3038
3039
3040
3041
3042

<define name="text-user-index"><element name="text:user-index"><ref name="sectionAttr"/><ref name="text-user-index-source"/><ref name="text-index-body"/></element></define>

7.7.1 User-Defined Index Source
The <text:user-index-source> element can contain several attributes that determine how
the index entries are gathered. It also supports an attribute that determines how the outline levelsof the index entries are gathered.
The paragraph formats that are used as index marks are encoded in <text:index-sourcestyles> elements, just like in <text:table-of-content-source> elements.
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055

<define name="text-user-index-source"><element name="text:user-index-source"><ref name="text-user-index-source-attr"/><optional><ref name="text-index-title-template"/></optional><zeroOrMore><ref name="text-user-index-entry-template"/></zeroOrMore><zeroOrMore><ref name="text-index-source-styles"/></zeroOrMore></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 165 of 738

3056</define>

The attributes that may be associated with <text:user-index-source> elements are:•Use attributes, text:use-*•

Copy outline level•

Index scope (see section 7.4.1)
This attribute specifies whether the index applies to the entire document or only to the current
chapter.

•Index name
In order to support several user-defined indexes with different contents, user index marks
have a text:index-name attribute. The same attribute can be used with a <text:userindex-source> element to specify which index marks apply to the current index.

•

Relative tab stop position (see section 7.4.1)
This attribute specifies whether the position of tab stops are interpreted relative to the left
margin or the left indent.

3057
3058
3059
3060
3061
3062
3063

<define name="text-user-index-source-attr" combine="interleave"><ref name="text-index-scope-attr"/><ref name="text-relative-tab-stop-position-attr"/><attribute name="text:index-name"><ref name="string"/></attribute></define>

Use Attributes
The text:use-* attributes specify which entries to include in the user-defined index. The
following attributes exist:

3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078

•

text:use-index-marks•

text:use-graphics•

text:use-tables•

text:use-floating-frames•

text:use-objects<define name="text-user-index-source-attr" combine="interleave"><optional><attribute name="text:use-index-marks" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="text:use-graphics" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="text:use-tables" a:defaultValue="false"><ref name="boolean"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 166 of 738

3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091

</optional><optional><attribute name="text:use-floating-frames"
a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="text:use-objects" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Copy Outline Levels
This attribute can have a value of true or false.
If the value is true, the entries are gathered at the outline level of the source element to which
they refer.
If the value is false, all index entries gathered are at the top outline level. For example, if animage appears in section 1.2.3, the entry for the image is located at outline level 3.
3092
3093
3094
3095
3096
3097
3098
3099

<define name="text-user-index-source-attr" combine="interleave"><optional><attribute name="text:copy-outline-levels"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

7.7.2 User-Defined Index Entry Template
User index entry templates support entry elements for chapter number, page number, entry text,
text spans, and tab stops.
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113

<define name="text-user-index-entry-template"><element name="text:user-index-entry-template"><ref name="text-user-index-entry-template-attrs"/><zeroOrMore><choice><ref name="text-index-entry-chapter"/><ref name="text-index-entry-page-number"/><ref name="text-index-entry-text"/><ref name="text-index-entry-span"/><ref name="text-index-entry-tab-stop"/></choice></zeroOrMore></element></define>

The attributes that may be associated with the <text:user-index-entry-template>elements are:•Template outline level•

Paragraph style

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 167 of 738

Template Outline Level
The text:outline-level attribute specifies to which outline level this entry configuration
applies.
All <text:outline-level> elements that are contained in the same parent element mustspecify different outline levels.
3114
3115
3116
3117
3118

<define name="text-user-index-entry-template-attrs" combine="interleave"><attribute name="text:outline-level"><ref name="positiveInteger"/></attribute></define>

Paragraph Style
The text:style-name attribute specifies the paragraph style to use for the template.
3119
3120
3121
3122
3123

<define name="text-user-index-entry-template-attrs" combine="interleave"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></define>

7.8 Alphabetical Index
An alphabetical index gathers its entries solely from index marks.
3124
3125
3126
3127
3128
3129
3130

<define name="text-alphabetical-index"><element name="text:alphabetical-index"><ref name="sectionAttr"/><ref name="text-alphabetical-index-source"/><ref name="text-index-body"/></element></define>

7.8.1 Alphabetical Index Source
The <text:alphabetical-index-source> element specifies how the alphabetical index isgenerated.
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141

<define name="text-alphabetical-index-source"><element name="text:alphabetical-index-source"><ref name="text-alphabetical-index-source-attrs"/><optional><ref name="text-index-title-template"/></optional><zeroOrMore><ref name="text-alphabetical-index-entry-template"/></zeroOrMore></element></define>

The attributes that may be associated with <text:alphabetical-index-source> elements
are:•Ignore case•

Main entry style name

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 168 of 738

•Alphabetical separators•

Combine entries attributes•

Use keys as entries•

Capitalize entries•

Comma separated entries•

Sort language, country and algorithm•

Index scope (see section 7.4.1)
This attribute specifies whether the index applies to the entire document or only to the current
chapter.

•

Relative tab stop position (see section 7.4.1)
This attribute specifies whether the position of tab stops are interpreted relative to the left
margin or the left indent.

3142
3143
3144
3145

<define name="text-alphabetical-index-source-attrs" combine="interleave"><ref name="text-index-scope-attr"/><ref name="text-relative-tab-stop-position-attr"/></define>

Ignore Case
The text:ignore-case attribute determines whether or not the capitalization of words isignored. If the value is true, the capitalization is ignored and entries that are identical except forcharacter case are listed as the same entries. If the value is false, the capitalization of words is
not ignored.
3146
3147
3148
3149
3150
3151
3152

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:ignore-case" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Main Entry Style Name
The text:main-entry-style-name attribute determines the character style to use for main
entries. Sub entries are formatted using the default character style determined by the paragraphstyle of the entries.
3153
3154
3155
3156
3157
3158
3159

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:main-entry-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Alphabetical Separators
The text:alphabetical-separators attribute determines whether or not entries beginningwith the same letter are grouped and separated from the entries beginning with the next letter,and so on.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 169 of 738

The value of this attribute can be true or false.
If the value is true, all entries beginning with the same letter are grouped together. The index
contains headings for each section, for example, A for all entries starting with the letter A, B for all
entries starting with the letter B, and so on.
3160
3161
3162
3163
3164
3165
3166

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:alphabetical-separators" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Combining Entries
There are several options for dealing with the common situation where there are multiple index
entries for the same word or phrase, as follows:

3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184

•

Multiple entries for the same word can be combined into a single entry using the
text:combine-entries attribute.

•

The pages referenced by a combined entry can be formatted as:–

As a range of numbers separated by a dash using the text:combine-entries-withdash attribute–

As the start number with a pp label, or the appropriate label for the chosen language,
using the text:combine-entries-with-pp attribute<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:combine-entries" a:defaultValue="true"><ref name="boolean"/></attribute></optional><optional><attribute name="text:combine-entries-with-dash"a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="text:combine-entries-with-pp" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Example: Combining index entries
An index mark for the word “XML” occurs on pages 45, 46, 47, and 48. The entries can beformatted as follows:
Entry formatted as

ResultSeparate entries

XML 45
XML 46
etc.

Simple combined entries

XML 45, 46, 47, 48

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 170 of 738

Entries combined with dashXML 45-48

Entries combined with pp

XML 45pp

Use Keys as Entries
In addition to a keyword, index marks can have up to two keys. If the value of this attribute istrue, the keys are used as additional entries. If the value of this attribute is false, the keys areused as sub entries.
3185
3186
3187
3188
3189
3190
3191

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:use-keys-as-entries" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Capitalize Entries
The text:capitalize-entries attribute determines whether or not the entries in the index
are to be capitalized.
3192
3193
3194
3195
3196
3197
3198

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:capitalize-entries" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Comma Separated Entries
The text:comma-separated attribute specifies how to treat multiple index entries. Instead oflisting each index entry on a separate line, multiple entries can be listed on a single line separated
by a comma. If the value of this attribute is true, multiple entries are listed on a single line
separated by a comma. By default, the value of this attribute is false and each index entry isdisplayed on a separate line.
3199
3200
3201
3202
3203
3204
3205

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:comma-separated" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Sort country, Language, and Algorithm
If index entries are to be sorted, these attributes can be used to specify the sorting. The attributes
country and language specify the sorting locale. For some locales, there are multiple sorting
algorithms in use. In this case, the algorithm attribute can be used to specify an algorithm by
name.
3206
3207
3208
3209

<define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="fo:language"><ref name="languageCode"/>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 171 of 738

3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226

</attribute></optional></define><define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="fo:country"><ref name="countryCode"/></attribute></optional></define><define name="text-alphabetical-index-source-attrs" combine="interleave"><optional><attribute name="text:sort-algorithm"><ref name="string"/></attribute></optional></define>

7.8.2 Auto Mark File
The alphabetical index supports a so-called auto mark file. Such a file contains a list of terms, andeach occurrence of such a term is to be included in the alphabetical index. The alphabetical index
mark file is declared as part of the text declarations (see section 4.8). The declaration element inan XLink, which points to the resource containing the list of terms.
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238

<define name="text-alphabetical-index-auto-mark-file"><element name="text:alphabetical-index-auto-mark-file"><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional></element></define>

7.8.3 Alphabetical Index Entry Template
Alphabetical indexes support three levels; one level for the main index entry, and up to two
additional levels for keys associated with the index entries. Alphabetical indexes also use an entry
template for the alphabetical separator.
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252

<define name="text-alphabetical-index-entry-template"><element name="text:alphabetical-index-entry-template"><ref name="text-alphabetical-index-entry-template-attrs"/><zeroOrMore><choice><ref name="text-index-entry-chapter"/><ref name="text-index-entry-page-number"/><ref name="text-index-entry-text"/><ref name="text-index-entry-span"/><ref name="text-index-entry-tab-stop"/></choice></zeroOrMore></element></define>

The attributes that may be associated with the <text:alphabetical-index-entrytemplate> elements are:
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 172 of 738

•

Template outline level•

Paragraph styleTemplate Outline Level
This attribute specifies whether the template applies to:•

One of the three levels 1,2,or 3

or
•
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263

The alphabetical separator<define name="text-alphabetical-index-entry-template-attrs"
combine="interleave"><attribute name="text:outline-level"><choice><value>1</value><value>2</value><value>3</value><value>separator</value></choice></attribute></define>

Paragraph Style
The text:style-name attribute specifies the paragraph style to use for the template.
3264
3265
3266
3267
3268
3269

<define name="text-alphabetical-index-entry-template-attrs"
combine="interleave"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></define>

7.9 Bibliography
A bibliography index gathers its entries from bibliography index marks. The<text:bibliography> element represents a bibliography.
3270
3271
3272
3273
3274
3275
3276

<define name="text-bibliography"><element name="text:bibliography"><ref name="sectionAttr"/><ref name="text-bibliography-source"/><ref name="text-index-body"/></element></define>

7.9.1 Bibliography Index Source
The <text:bibliography-source> element specifies how the bibliography is generated.
3277
3278
3279
3280
3281
3282

<define name="text-bibliography-source"><element name="text:bibliography-source"><optional><ref name="text-index-title-template"/></optional><zeroOrMore>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 173 of 738

3283
3284
3285
3286

<ref name="text-bibliography-entry-template"/></zeroOrMore></element></define>

7.9.2 Bibliography Entry Template
Bibliography entry templates support entry elements for bibliography data, text spans, and tab
stops. There is one entry template element for each type of entry.
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298

<define name="text-bibliography-entry-template"><element name="text:bibliography-entry-template"><ref name="text-bibliography-entry-template-attrs"/><zeroOrMore><choice><ref name="text-index-entry-span"/><ref name="text-index-entry-tab-stop"/><ref name="text-index-entry-bibliography"/></choice></zeroOrMore></element></define>

The attributes that may be associated with the <text:bibliography-entry-template>elements are:•Bibliography type•

Paragraph style

Bibliography Type
This attribute specifies to which type of bibliographical entry the template applies. This attributemust be unique among all <text:bibliography-type> elements within the same parent
element.
3299
3300
3301
3302
3303

<define name="text-bibliography-entry-template-attrs" combine="interleave"><attribute name="text:bibliography-type"><ref name="text-bibliography-types"/></attribute></define>

Paragraph Style
The text:style-name attribute specifies the paragraph style to use for this template.
3304
3305
3306
3307
3308

<define name="text-bibliography-entry-template-attrs" combine="interleave"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></define>

7.10 index source styles
Some indices can gather index entries from paragraphs formatted using certain paragraph styles.
The <text:index-source-styles> element contains all of the <text:index-sourcestyle> elements for a particular outline level. The text:outline-levels attribute determinesat which outline level to list the index entries gathered from the respective paragraph styles. Therecan only be one <text:index-source-style> element for each outline level.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 174 of 738

3309
3310
3311
3312
3313
3314
3315
3316
3317
3318

<define name="text-index-source-styles"><element name="text:index-source-styles"><attribute name="text:outline-level"><ref name="positiveInteger"/></attribute><zeroOrMore><ref name="text-index-source-style"/></zeroOrMore></element></define>

7.10.1 Index source style
All paragraphs formatted using the style or class specified in the <text:index-sourcestyle> element are included in the index.
3319
3320
3321
3322
3323
3324
3325
3326

<define name="text-index-source-style"><element name="text:index-source-style"><attribute name="text:style-name"><ref name="styleName"/></attribute><empty/></element></define>

7.11 Index title template
The <text:index-title-template> element determines the style and content of the index
title. There can only be one <text:index-title-template> element contained in a<text:table-of-content-source> element.
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336

<define name="text-index-title-template"><element name="text:index-title-template"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><text/></element></define>

7.12 Index Template Entries
There are eight types of index entries, as follows:•

Chapter information•

Entry text•

Page number•

Fixed string•

Bibliography information•

Tab stop•

Hyperlink start and end

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 175 of 738

7.12.1 Chapter Information
The <text:index-entry-chapter> element displays the chapter number of the index entry.
The character style for the chapter number can be included in the index entry element as atext:style-name attribute.
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346

<define name="text-index-entry-chapter"><element name="text:index-entry-chapter"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><ref name="text-index-entry-chapter-attrs"/></element></define>

Note: This element can only display the chapter number. To display the chapter
name, the <text:index-entry-text> elements must be used.

Display Chapter Format
The text:display attribute displays either the chapter number, the chapter name, or both.
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357

<define name="text-index-entry-chapter-attrs"><optional><attribute name="text:display" a:defaultValue="number"><choice><value>name</value><value>number</value><value>number-and-name</value></choice></attribute></optional></define>

7.12.2 Entry Text
The <text:index-entry-text> element displays the text of the index entry, for example, thechapter name if the entry is derived from a header or the phrase contained in the index mark if theentry is derived from an index mark. The character style for the entry text can be included in theindex entry element as a text:style-name attribute.
3358
3359
3360
3361
3362
3363
3364
3365
3366

<define name="text-index-entry-text"><element name="text:index-entry-text"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></element></define>

7.12.3 Page Number
The <text:index-entry-page-number> element displays the page number on which theindex entry is located. The character style for the page number can be included in the index entry
element as a text:style-name attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 176 of 738

3367
3368
3369
3370
3371
3372
3373
3374
3375

<define name="text-index-entry-page-number"><element name="text:index-entry-page-number"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></element></define>

7.12.4 Fixed String
The <text:index-entry-span> element represents a fixed string within an index entry. The
character style for the entry text can be included in the index entry element as a text:stylename attribute. Unlike the <text:span> element, the <text:index-entry-span> element
does not have any child elements.
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385

<define name="text-index-entry-span"><element name="text:index-entry-span"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><text/></element></define>

7.12.5 Bibliography Information
The <text:index-entry-bibliography> element introduces bibliography data into index
entry templates.
3386
3387
3388
3389
3390

<define name="text-index-entry-bibliography"><element name="text:index-entry-bibliography"><ref name="text-index-entry-bibliography-attrs"/></element></define>

The attributes that may be associated with the <text:index-entry-bibliography> elementare:•text:style-name attribute•

text:bibliography-data-field attribute

Text Style Name
The text:style-name attribute determines the style for display of the entry.
3391
3392
3393
3394
3395
3396
3397

<define name="text-index-entry-bibliography-attrs" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 177 of 738

Bibliography Data Field Identifier
The text:bibliography-data-field attribute determines which part of the bibliography
data field will be displayed.
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435

<define name="text-index-entry-bibliography-attrs" combine="interleave"><attribute name="text:bibliography-data-field"><choice><value>address</value><value>annote</value><value>author</value><value>bibliography-type</value><value>booktitle</value><value>chapter</value><value>custom1</value><value>custom2</value><value>custom3</value><value>custom4</value><value>custom5</value><value>edition</value><value>editor</value><value>howpublished</value><value>identifier</value><value>institution</value><value>isbn</value><value>issn</value><value>journal</value><value>month</value><value>note</value><value>number</value><value>organizations</value><value>pages</value><value>publisher</value><value>report-type</value><value>school</value><value>series</value><value>title</value><value>url</value><value>volume</value><value>year</value></choice></attribute></define>

7.12.6 Tab Stop
The <text:index-entry-tab-stop> element represents a tab stop within an index entry. It
also contains the position information for the tab stop.
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445

<define name="text-index-entry-tab-stop"><element name="text:index-entry-tab-stop"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional><ref name="text-index-entry-tab-stop-attrs"/></element></define>

The attributes that may be associated with the <text:index-entry-tab-stop> element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 178 of 738

•style:leader-char•style:type•style:position

Leader CharThe style:leader-char attribute specifies the leader character.
3446
3447
3448
3449
3450
3451
3452

<define name="text-index-entry-tab-stop-attrs" combine="interleave"><optional><attribute name="style:leader-char"><ref name="character"/></attribute></optional></define>

Tab Type and Position
The style:type attribute specifies the tab stop type. The <text:index-entry-tab-stop>element only supports two types of tab: left and right.
If the value of this attribute is left, the style:position attribute must also be used.
Otherwise, this attribute must be omitted. The style:position attribute specifies the positionof the tab. Depending on the value of the text:relative-tab-stop-position attribute in
the <text:index-entry-config> element, the position of the tab is interpreted as being
relative to the left margin or the left indent.
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467

<define name="text-index-entry-tab-stop-attrs" combine="interleave"><choice><attribute name="style:type"><value>right</value></attribute><group><attribute name="style:type"><value>left</value></attribute><attribute name="style:position"><ref name="length"/></attribute></group></choice></define>

7.12.7 Hyperlink Start and End
The <text:index-entry-link-start> and <text:index-entry-link-end> elements
mark the start and end of a hyperlink index entry. The character style for the hyperlink can be
included in the index entry element as a text:style-name attribute.
3468
3469
3470
3471
3472
3473
3474
3475

<define name="text-index-entry-link-start"><element name="text:index-entry-link-start"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 179 of 738

3476
3477
3478
3479
3480
3481
3482
3483
3484
3485

</define><define name="text-index-entry-link-end"><element name="text:index-entry-link-end"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></element></define>

7.12.8 Example of an Index Entry Configuration
The following is an example of the XML code for a table of contents called Table of Content withthe following characteristics:•

It uses the top two outline levels.

•

Each entry consists of the chapter number, a closing parenthesis, the chapter title, a tab stop,and the page number.

•

For the top outline level, the page number is formatted using a style called Bold.

•

For the second outline level, a bracket is used instead of a closing parenthesis.
Example: Table of Content<text:table-of-content><text:table-of-content-source
text:outline-level="2"
text:use-index-marks="false"
text:index-scope="document"><text:index-title-template text:style-name="Index 1">
Table of Content</text:index-title-template><text:index-entry-template
text:outline-level="1"
text:style-name="Contents 1"><text:index-entry-chapter text:display="number"/><text:index-entry-span>) </text:index-entry-span><text:index-entry-text/><text:index-entry-tab-stop style:type="right"/><text:index-entry-page-number text:style-name="bold"/></text:index-entry-template><text:index-entry-template
text:outline-level="2"
text:style-name="Contents 2"><text:index-entry-chapter text:display="number"/><text:index-entry-span>] </text:index-entry-span><text:index-entry-text/><text:index-entry-tab-stop style:type="right"/><text:index-entry-page-number/></text:index-entry-template></text:table-of-content-source><text:table-of-content-body>[... header ...]
<text:p text:style-name="[...]">1) Chapter<text:tab-stop/><text:span stylename="bold"> 1 </text:span>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 180 of 738

</text:p><text:p text:style-name="[...]">1.1] Subchapter<text:tab-stop/>1</text:p>[... more entries ...]</text:table-of-content-body></text:table-of-content>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 181 of 738

8 Tables
This chapter describes the table structure that is used for tables that are embedded within text
documents and for spreadsheets.

8.1 Basic Table Model
The structure of OpenDocument tables is similar to the structure of [HTML4] or [XSL] tables, andlike these tables, they can be nested.
The representation of tables is based on a grid of rows and columns. Rows take precedence overcolumns. The table is divided into rows and the rows are divided into cells. Each column includes
a column description, but this description does not contain any cells.
Table rows may be empty, and different rows might contain a different number of table cells. This
is not an error, but applications might resolve this in different ways. Spreadsheet applications
typically operate on large tables that have a fixed application dependent row and column number,but may have an unused area. Only the used area of the table is saved in files. When loading atable with empty or incomplete rows into a spreadsheet application, empty rows typically introduce
a default row (just as in an empty sheet), and incomplete rows are filled with empty cells (just likein an empty sheet).
All other applications typically have fixed size tables. Incomplete rows are basically rendered as if
they had the necessary number of empty cells, and the same applies to empty rows. Empty cells
typically occupy the space of an empty paragraph.
Rows and columns appear in row groups and column groups. These groups specify whether or
not to repeat a row or column on the next page.

8.1.1 Table Element
The table element is the root element for tables.
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507

<define name="table-table"><element name="table:table"><ref name="table-table-attlist"/><optional><ref name="table-table-source"/></optional><optional><ref name="office-dde-source"/></optional><optional><ref name="table-scenario"/></optional><optional><ref name="office-forms"/></optional><optional><ref name="table-shapes"/></optional><ref name="table-columns-and-groups"/><ref name="table-rows-and-groups"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 182 of 738

The content models for tables is rather complex. The details are explained in the section 8.2. For
the moment, it can be assumed that table element's content are columns and row elements.
3508
3509
3510
3511
3512
3513
3514
3515

<define name="table-columns-and-groups"><oneOrMore><choice><ref name="table-table-column-group"/><ref name="table-columns-no-group"/></choice></oneOrMore></define>

3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535

<define name="table-columns-no-group"><choice><group><ref name="table-columns"/><optional><ref name="table-table-header-columns"/><optional><ref name="table-columns"/></optional></optional></group><group><ref name="table-table-header-columns"/><optional><ref name="table-columns"/></optional></group></choice></define>

3536
3537
3538
3539
3540
3541
3542
3543
3544

<define name="table-columns"><choice><ref name="table-table-columns"/><oneOrMore><ref name="table-table-column"/></oneOrMore></choice></define>

3545
3546
3547
3548
3549
3550
3551
3552
3553

<define name="table-rows-and-groups"><oneOrMore><choice><ref name="table-table-row-group"/><ref name="table-rows-no-group"/></choice></oneOrMore></define>

3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566

<define name="table-rows-no-group"><choice><group><ref name="table-rows"/><optional><ref name="table-table-header-rows"/><optional><ref name="table-rows"/></optional></optional></group><group>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 183 of 738

3567
3568
3569
3570
3571
3572
3573

<ref name="table-table-header-rows"/><optional><ref name="table-rows"/></optional></group></choice></define>

3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585

<define name="table-rows"><choice><ref name="table-table-rows"/><oneOrMore><optional><ref name="text-soft-page-break"/></optional><ref name="table-table-row"/></oneOrMore></choice></define>

Table Name
The table:name attribute specifies the name of a table.
3586
3587
3588
3589
3590
3591
3592

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:name"><ref name="string"/></attribute></optional></define>

Table Style
The table:style-name attribute references a table style, i.e., an <style:style> element oftype “table”. The table style describes the formatting properties of the table, such as width andbackground color. The table style can be either an automatic or common style.
3593
3594
3595
3596
3597
3598
3599

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Example: Table Style<style:style style:name="Table 1" style:family="table"><style:table-properties style:width="12cm"
fo:background-color="light-grey"/></style:style><table:table table:name="Table 1" table:style-name="Table 1">...
</table:table>

Protected
The table:protected attribute specifies whether or not a table is protected from editing. If thetable is protected, the table:protection-key attribute can specify a password to prevent a
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 184 of 738

user from resetting the protection flag to enable editing. If a table is protected, all of the tableelements and the cell elements with a style:cell-protect attribute set to true areprotected.
To avoid saving the password directly into the XML file, only a hash value of the password isstored within the table:protection-key attribute.
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:protected" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="table:protection-key"><text/></attribute></optional></define>

Print
The table:print attribute specifies if a table is printed. It takes a Boolean value. If its value istrue, the table is printed, if its value is false, the table is not printed. The default value is true.
The table:print attribute will be overwritten by the table:display attribute described in
section 15.8.14. That is, if the table is not displayed, it also will not be printed.
If the table is printed, the table range that actually is printed can be specified by table:printranges attribute (see section 8.1.1:Print Ranges). If this attribute is not existing, the used area ofthe table will be printed.
3612
3613
3614
3615
3616
3617
3618

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:print" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Print Ranges
The table:print-ranges attribute specifies the print ranges of the table, i.e., the cells thatshould be printed. It contains a list of cell addresses or cell range addresses as described in
section 8.3.1.
3619
3620
3621
3622
3623
3624
3625

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:print-ranges"><ref name="cellRangeAddressList"/></attribute></optional></define>

Soft Page Breaks
The <text:soft-page-break> element represents a soft page break between two table rows.
It may appear in front of <table:table-row> elements.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 185 of 738

See section 2.3.1:Use Soft Page BreaksUse Soft Page Breaks for details regarding soft page
breaks.

8.1.2 Table Row
The <table:table-row> element represents a row in a table. It content are elements thatspecify the cells of the table row.
The <table:table-row> element is similar to the [XSL] <fo:table-row> element.
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636

<define name="table-table-row"><element name="table:table-row"><ref name="table-table-row-attlist"/><oneOrMore><choice><ref name="table-table-cell"/><ref name="table-covered-table-cell"/></choice></oneOrMore></element></define>

Number of Rows Repeated
The table:number-rows-repeated attribute specifies the number of rows to which a row
element applies. If two or more rows are adjoining, and have the same content and properties,
and do not contain vertically merged cells, they may be described by a single <table:tablerow> element that has a table:number-rows-repeated attribute with a value greater than 1.
3637
3638
3639
3640
3641
3642
3643

<define name="table-table-row-attlist" combine="interleave"><optional><attribute name="table:number-rows-repeated" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Row Style
A table row style stores the formatting properties of a table row, such as height and backgroundcolor. A row style is defined by a <style:style> element with a family attribute value oftable-row. The table row style can be either an automatic or a common style. It is referenced by
the table row's table:style-name attribute.
3644
3645
3646
3647
3648
3649
3650

<define name="table-table-row-attlist" combine="interleave"><optional><attribute name="table:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Default Cell Style
The table:default-cell-style-name attribute specifies a default cell style. Cells containedin the row that don't have a table:style-style name attribute use this default cell style.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 186 of 738

The attribute is applied to cells that are defined by a <table:table-cell> element. It is
typically not applied to table cells that spreadsheet application may display in addition to thosedefined in the document.
3651
3652
3653
3654
3655
3656
3657

<define name="table-table-row-attlist" combine="interleave"><optional><attribute name="table:default-cell-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Visibility
The table:visibility attribute specifies whether the row is visible, filtered, or collapsed.
Filtered and collapsed rows are not visible. Filtered rows are invisible, because a filter is applied tothe table that does not select the table row. Collapsed rows have been made invisible by invisible
in the UI directly.
3658
3659
3660
3661
3662
3663
3664

<define name="table-table-row-attlist" combine="interleave"><optional><attribute name="table:visibility" a:defaultValue="visible"><ref name="table-visibility-value"/></attribute></optional></define>

3665
3666
3667
3668
3669
3670
3671
3672

<define name="table-visibility-value"><choice><value>visible</value><value>collapse</value><value>filter</value></choice></define>

Example: Table with three rows and three columns
This example shows the OpenDocument code for a table with three rows and three columns. The
first two rows of the table have a blue background.
<style:style style:name="Table 1" style:family="table"><style:table-properties style:width="12cm"
fo:background-color="light-grey"/></style:style><style:style style:name="Col1" style:family="table-column"><style:table-column-properties style:column-width="2cm"/></style:style><style:style style:name="Col2" style:family="table-column"><style:table-column-properties style:column-width="4cm"/></style:style><style:style style:name="Col3" style:family="table-column"><style:table-column-properties style:column-width="6cm"/></style:style><style:style style:name="Row1" style:family="table-row"><style:table-row-properties fo:background-color="blue"/></style:style><table:table table:name="Table 1" table:style-name="Table 1"><table:table-columns><table:table-column table:style-name="Col1"/><table:table-column table:style-name="Col2"/><table:table-column table:style-name="Col3"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 187 of 738

</table:table-columns><table:table-rows><table:table-row table:style-name="Row1">...
</table:table-row><table:table-row table:style-name="Row1">...
</table:table-row><table:table-row>...
</table:table-row><table:table-rows></table:table>

8.1.3 Table Cell
The <table:table-cell> and <table:covered-table-cell> elements specify thecontent of a table cells. They are contained in table row elements. A table cell can containparagraphs and other text content as well as sub tables. Table cells may be empty.
The <table:table-cell> element is very similar to the table cell elements of [XSL] and[HTML4], and the rules regarding cells that span several columns or rows that exist in HTML and
XSL apply to the OpenDocument specification as well. This means that there are no<table:table-cell> elements in the row/column grid for positions that are covered by amerged cell, that is, that are covered by a cell that spans several columns or rows. The<table:covered-table-cell> element exists to be able to specify cells for such positions . It
has to appear wherever a position in the row/column grid is covered by a cell that spans severalrows or columns. Its position in the grid is calculated by a assuming a column and row span of 1
for all cells regardless whether they are specified by a <table:table-cell> or a<table:covered-table-cell> element. The <table:covered-table-cell> is especiallyused by spreadsheet applications, where it is a common use case that a covered cell contains
content.
3673
3674
3675
3676
3677
3678
3679

<define name="table-table-cell"><element name="table:table-cell"><ref name="table-table-cell-attlist"/><ref name="table-table-cell-attlist-extra"/><ref name="table-table-cell-content"/></element></define>

3680
3681
3682
3683
3684
3685
3686

<define name="table-covered-table-cell"><element name="table:covered-table-cell"><ref name="table-table-cell-attlist"/><ref name="table-table-cell-content"/></element></define>

3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699

<define name="table-table-cell-content"><optional><ref name="table-cell-range-source"/></optional><optional><ref name="office-annotation"/></optional><optional><ref name="table-detective"/></optional><zeroOrMore><ref name="text-content"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 188 of 738

3700
3701

</zeroOrMore></define>

Number of Cells Repeated
The table:number-columns-repeated attribute specifies the number of successive columns
in which a cell is repeated. It can be used to describe two or more adjoining cells with a single cellelement, if they meet the following conditions:•

The cells contain the same content and properties.

•

The cells are not merged horizontally or vertically.

In this case, a table:number-columns-repeated attribute must be used to specify the
number of successive columns in which the cell is repeated. This attribute is specified with either
the <table:table-cell> element or the <table:covered-table-cell> element.
3702
3703
3704
3705
3706
3707
3708

<define name="table-table-cell-attlist" combine="interleave"><optional><attribute name="table:number-columns-repeated" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Number of Rows and Columns Spanned
These attributes specify the number of rows and columns that a cell spans. These attributes canbe used with the <table:table-cell> element only.
When a cell covers another cell because of a column or row span value greater than one, a<table:covered-table-cell> element must appear in the table to represent the covered
cell.
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720

<define name="table-table-cell-attlist-extra" combine="interleave"><optional><attribute name="table:number-columns-spanned" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional><optional><attribute name="table:number-rows-spanned" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Cell Style
A table cell style stores the formatting properties of a cell, such as the following:•

Background color•

Number format•

Vertical alignment•

Borders

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 189 of 738

The table cell style can be either an automatic or a common style. The style is specified with atable:style-name attribute. If a cell does not have a cell style assigned, the application checks
if a the current row has a default cell style assigned. If the current row does not have a default cell
assigned style as well, the application checks if the current column has a default cell styleassigned.
3721
3722
3723
3724
3725
3726
3727

<define name="table-table-cell-attlist" combine="interleave"><optional><attribute name="table:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Cell Content Validation
The table:content-validation-name attribute specifies if a cell contains a validity check.
The value of this attribute is the name of a <table:content-validation> element. If theattribute is not present, the cell may have arbitrary content.
3728
3729
3730
3731
3732
3733
3734

<define name="table-table-cell-attlist" combine="interleave"><optional><attribute name="table:content-validation-name"><ref name="string"/></attribute></optional></define>

See section 8.5.3 for more information on cell content validation and the <table:cellcontent-validation> element.

FormulaFormulas allow calculations to be performed within table cells. Every formula should begin with anamespace prefix specifying the syntax and semantics used within the formula. Typically, theformula itself begins with an equal (=) sign and can include the following components:•

Numbers.

•

Text.

•

Named ranges.

•

Operators.

•

Logical operators.

•

Function calls.

•

Addresses of cells that contain numbers. The addresses can be relative or absolute, seesection 8.3.1. Addresses in formulas start with a “[“ and end with a “]”. See sections 8.3.1 and8.3.1 for information about how to address a cell or cell range.

The following is an example of a simple formula:=sum([.A1:.A5])
This formula calculates the sum of the values of all cells in the range “.A1:.A5”. The function is“sum”. The parameters are marked by a “(“ at the start and a “)” at the end. If a function contains
more than one parameter, the parameters are separated by a “;”.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 190 of 738

The following is a variation of the formula shown above:=sum([.A1];[.A2];[.A3];[.A4];[.A5])
The result of this formula is the same. The components used in the formula depend on theapplication being used.
The table:formula attribute contains a formula for a table cell.
3735
3736
3737
3738
3739
3740
3741

<define name="table-table-cell-attlist" combine="interleave"><optional><attribute name="table:formula"><ref name="string"/></attribute></optional></define>

In addition to this, the calculated value of the formula is available as well. One of the following
attributes represents the current value of the cell:•

office:value•

office:date-value•

office:time-value•

office:boolean-value•

office:string-value

MatrixWhen an application is performing spreadsheet calculations, a connected range of cells that
contains values is called a matrix. If the cell range contains m rows and n columns, the matrix iscalled an m x n matrix. The smallest possible matrix is a 1 x 2 or 2 x 1 matrix with two adjacentcells. To use a matrix in a formula, include the cell range address of the matrix in the formula. In amatrix formula, only special matrix operations are possible.
The number of rows and columns that a matrix spans are represented by the table:numbermatrix-rows-spanned and table:number-matrix-columns-spanned attributes, which
are attached to the cell elements.
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753

<define name="table-table-cell-attlist-extra" combine="interleave"><optional><attribute name="table:number-matrix-columns-spanned"><ref name="positiveInteger"/></attribute></optional><optional><attribute name="table:number-matrix-rows-spanned"><ref name="positiveInteger"/></attribute></optional></define>

Value TypeThe table:value-type attribute specifies the type of value that can appear in a cell. It may
contain one of the following values:•

float, percentage or currency (numeric types)

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 191 of 738

3754
3755
3756
3757
3758

•

date

•

time

•

boolean•string<define name="table-table-cell-attlist" combine="interleave"><optional><ref name="common-value-and-type-attlist"/></optional></define>

Cell Current Numeric Value
The office:value attribute specifies the current numeric value of a cell. This attribute is only
evaluated for cells that contain the following data types:
•

float

•

percentage•

currency

Cell Current Currency
The tableoffice:currency attribute specifies the current currency value of a cell. The valueof this attribute is usually currency information such as DEM or EUR. This attribute is only
evaluated for cells whose data type is currency.

Cell Current Date Value
The office:date-value attribute specifies the current date value of a cell. This attribute is only
evaluated for cells whose data type is date.
Some application support date and time values in addition to dates.

Cell Current Time Value
The office:time-value attribute specifies the current time value of a cell. This attribute is only
evaluated for cells whose data type is time.

Cell Current Boolean Value
The office:boolean-value attribute specifies the current Boolean value of a cell. This
attribute is only evaluated for cells whose data type is boolean.

Cell Current String Value
The office:string-value attribute specifies the current string value of a cell. This attribute is
only evaluated for cells whose data type is string.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 192 of 738

Table Cell Protection
The table:protected attribute protects the table cells. Users can not edit the content of a cellthat is marked as protected.
3759
3760
3761
3762
3763
3764
3765

<define name="table-table-cell-attlist" combine="interleave"><optional><attribute name="table:protect" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

This attribute is not related to the table:protected attribute for table elements (see section
8.1.1) and the table:cell-protect attribute for table cell styles (see section 15.11.14).

8.2 Advanced Table Model
8.2.1 Column Description
Every column in a table has a column description element <table:table-column>. It is similar
to the [XSL] <fo:table-column> element, and its primary use is to reference a table column
style that for instance specifies the table column's width.
3766
3767
3768
3769
3770
3771

<define name="table-table-column"><element name="table:table-column"><ref name="table-table-column-attlist"/><empty/></element></define>

Number of Columns Repeated
The table:number-columns-repeated attribute specifies the number of columns to which acolumn description applies. If two or more columns are adjoining, and have the same properties,
this attribute allows to describe them with a single <table:table-column> element.
3772
3773
3774
3775
3776
3777
3778

<define name="table-table-column-attlist" combine="interleave"><optional><attribute name="table:number-columns-repeated" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Column Style
A table column style stores the formatting properties of a table column, such as width andbackground color. It is specified by a <style:style> element with a family attribute value oftable-column and can be either an automatic or a common style. The style of a column is
specified using a table:style-name attribute.
3779
3780
3781
3782
3783
3784

<define name="table-table-column-attlist" combine="interleave"><optional><attribute name="table:style-name"><ref name="styleNameRef"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 193 of 738

3785</define>

Visibility
The table:visibility attribute specifies whether the column is visible, filtered, or collapsed.
See section 8.1.2 for more details.
3786
3787
3788
3789
3790
3791
3792

<define name="table-table-column-attlist" combine="interleave"><optional><attribute name="table:visibility" a:defaultValue="visible"><ref name="table-visibility-value"/></attribute></optional></define>

Default Cell Style
The table:default-cell-style-name attribute specifies the default cell style. Cells that
don't have a table:style-style name attribute use this style when there is no default cellstyle specified for the cell's row as well.
The attribute is applied to cells that are defined by a <table:table-cell> element. It is
typically not applied to table cells that spreadsheet application may display in addition to thosedefined in the document.
3793
3794
3795
3796
3797
3798
3799

<define name="table-table-column-attlist" combine="interleave"><optional><attribute name="table:default-cell-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Example: Table with three columns
This example shows the OpenDocument code for a table with three columns.
<style:style style:name="Table 1" style:family="table"><style:table-properties style:width="12cm"
fo:background-color="light-grey"/></style:style><style:style style:name="Col1" style:family="table-column"><style:table-column-properties style:column-width="2cm"/></style:style><style:style style:name="Col2" style:family="table-column"><style:table-column-properties style:column-width="4cm"/></style:style><style:style style:name="Col3" style:family="table-column"><style:table-column-properties style:column-width="6cm"/></style:style><table:table table:name="Table 1" table:style-name="Table 1"><table:table-columns><table:table-column table:style-name="Col1"/><table:table-column table:style-name="Col2"/><table:table-column table:style-name="Col3"/></table:table-columns>...
</table:table>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 194 of 738

8.2.2 Header Columns
For accessibility purposes, header information is needed. Therefore, any columns designated asheaders by the author must be tagged as such by encapsulating them within a <table:tableheader-columns> element. Using style information only to designate header columns is
insufficient.
If a table does not fit on a single page, table columns that are included in a <table:tableheader-columns> element are automatically repeated on every page. A table must not containmore than one <table:table-header-columns> element, and a <table:tablecolumns> must not follow another <table:table-columns> element, with the only exceptionof tables that contain grouped columns (see 8.2.3). Such tables may contain more than one<table:table-header-columns> element, provided that they are contained in different
column groups and the columns contained in the elements are adjacent.
Applications that do not support header columns have to process header column descriptions thesame way as non header column descriptions.
The <table:table-header-columns> and <table:table-columns> element are very
similar to [HTML4]'s <THEAD> and <TBODY> elements for rows.
3800
3801
3802
3803
3804
3805
3806

<define name="table-table-header-columns"><element name="table:table-header-columns"><oneOrMore><ref name="table-table-column"/></oneOrMore></element></define>

3807
3808
3809
3810
3811
3812
3813
3814

<define name="table-table-columns"><element name="table:table-columns"><oneOrMore><ref name="table-table-column"/></oneOrMore></element></define>

8.2.3 Column Groups
Adjacent table columns can be grouped with the <table:table-column-group> element.
Every group can contain a new group, columns, and column headers. A column group can bevisible or hidden. Column groups can for instance used by spreadsheet applications to groupcolumns that are summarized, so that the individual columns that contribute to the sum can bemade invisible easily, but the sum remains visible.
If a set of header columns and a column group overlap, the header column group breaks thecolumn header set. That is, the <table:table-column-group> may contain<table:table-header-columns> elements, but not vice versa.
3815
3816
3817
3818
3819
3820

<define name="table-table-column-group"><element name="table:table-column-group"><ref name="table-table-column-group-attlist"/><ref name="table-columns-and-groups"/></element></define>

Display
The table:display attribute specifies whether or not the group is visible.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 195 of 738

3821
3822
3823
3824
3825
3826
3827

<define name="table-table-column-group-attlist" combine="interleave"><optional><attribute name="table:display" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

8.2.4 Header Rows
For accessibility purposes, header information is needed. Therefore, any rows designated asheaders by the author must be tagged as such by encapsulating them within a <table:tableheader-rows> element. Using style information only to designate header rows is insufficient.
If a table does not fit on a single page, table rows that are included in a <table:tableheader-rows> element are automatically repeated on every page. A table must not containmore than one <table:table-header-rows> element. The one exception to this is a tablethat contains grouped rows (see 8.2.5). Such a table may contain more than one<table:table-header-rows> element, provided that they are contained in different row
groups and the rows contained in the elements are adjacent.
Applications that do not support header rows have to process header rows the same way as nonheader rows.
The <table:table-header-rows> and <table:table-rows> element are very similar to[HTML4]'s <THEAD> and <TBODY> elements.
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837

<define name="table-table-header-rows"><element name="table:table-header-rows"><oneOrMore><optional><ref name="text-soft-page-break"/></optional><ref name="table-table-row"/></oneOrMore></element></define>

3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848

<define name="table-table-rows"><element name="table:table-rows"><oneOrMore><optional><ref name="text-soft-page-break"/></optional><ref name="table-table-row"/></oneOrMore></element></define>

8.2.5 Row Groups
Adjacent table rows can be grouped with the <table:table-row-group> element. Everygroup can contain a new group, rows, and row headers. A row group can be visible or hidden.
Row groups can for instance used by spreadsheet applications to group rows that aresummarized, so that the individual rows that contribute to the sum can be made invisible easily,
but the sum remains visible.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 196 of 738

If a set of header rows and a row group overlap, the header row group breaks the row header set.
That is, the <table:table-row-group> may contain <table:table-header-rows>
elements, but not vice versa.
3849
3850
3851
3852
3853
3854

<define name="table-table-row-group"><element name="table:table-row-group"><ref name="table-table-row-group-attlist"/><ref name="table-rows-and-groups"/></element></define>

Display
The table:display attribute specifies whether or not the group is visible.
3855
3856
3857
3858
3859
3860
3861

<define name="table-table-row-group-attlist" combine="interleave"><optional><attribute name="table:display" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

8.2.6 Subtables
If a table cell only contains a single table but no paragraphs or other content, this table can be
specified as subtable. It then occupies the whole cell and no other content can appear in this cell.
The borders of a subtable merge with the borders of the cell that it resides in. A subtable does notcontain any formatting properties. A subtable is essentially a container for some additional tablerows that integrate seamlessly with the parent table.
A nested table is turned into a subtable with the attribute table:is-subtable that is attachedto the table element. A nested table that is not a specified to be a subtable appears as a tablewithin a table, that is, it has borders distinct from those of the parent cell and respects the paddingof the parent cell.
3862
3863
3864
3865
3866
3867
3868

<define name="table-table-attlist" combine="interleave"><optional><attribute name="table:is-sub-table" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Example of Representation of subtable
In the OpenDocument schema, this table can be represented in either of the ways detailed in
Sample 1 and Sample 2.
A1
A2

B1
.B2.A1C1.B2.B1.B2.A2
Sample 1
Using cells that span several rows, the table is specified as follows:<style:style style:name="Table 1" style:family="table"><style:table-properties style:width="12cm"

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 197 of 738

fo:background-color="light-grey"/></style:style><style:style style:name="Col1" style:family="table-column"><style:table-column-properties style:column-width="2cm"/></style:style><style:style style:name="Col2" style:family="table-column"><style:table-column-properties style:column-width="4cm"/></style:style><style:style style:name="Col3" style:family="table-column"><style:table-column-properties style:column-width="6cm"/></style:style><style:style style:name="Row1" style:family="table-row"><style:table-row-properties fo:background-color="grey"/></style:style><style:style style:name="Cell1" style:family="table-cell"><style:table-cell-properties fo:background-color="grey"/></style:style><table:table table:name="Table 1" table:style-name="Table 1"><table:table-columns><table:table-column table:style-name="Col1"/><table:table-column table:style-name="Col2"/><table:table-column table:style-name="Col3"/></table:table-columns><table:table-header-rows><table:table-row table:style-name="Row1"><table:table-cell><text:p text:style="Table Caption">
A1</text:p></table:table-cell><table:table-cell><text:p text:style="Table Caption">
B1</text:p></table:table-cell><table:table-cell><text:p text:style="Table Caption">
C1</text:p></table:table-cell></table:table-row></table:table-header-rows><table:table-rows><table:table-row><table:table-cell table:number-rows-spanned="2"table:style-name="Cell1"><text:p text:style="Table Body">
A2</text:p></table:table-cell><table:table-cell><text:p text:style="Table Body">.B2.A1</text:p></table:table-cell><table:table-cell><text:p text:style="Table Body">.B2.B1</text:p></table:table-cell></table:table-row><table:table-row>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 198 of 738

<table:covered-table-cell/><table:table-cell table:number-columns-spanned="2"><text:p text:style="Table Body">.B2.A2</text:p></table:table-cell><table:covered-table-cell/></table:table-row></table:table-rows></table:table>

Sample 2
Using sub tables, the table is specified as follows:<style:style style:name="Table 1" style:family="table"><style:table-properties fo:width="12cm" fo:background-color="lightgrey"/></style:style><style:style style:name="Col1" style:family="table-column"><style:table-column-properties style:column-width="2cm"/></style:style><style:style style:name="Col2" style:family="table-column"><style:table-column-properties style:column-width="4cm"/></style:style><style:style style:name="Col3" style:family="table-column"><style:table-column-properties style:column-width="6cm"/></style:style><style:style style:name="Row1" style:family="table-row"><style:table-row-properties fo:background-color="grey"/></style:style><style:style style:name="Cell1" style:family="table-cell"><style:table-cell-properties fo:background-color="grey"/></style:style><table:table table:name="Table 1" table:style-name="Table 1"><table:table-columns><table:table-column table:style-name="Col1"/><table:table-column table:style-name="Col2"/><table:table-column table:style-name="Col3"/></table:table-columns><table:table-header-rows><table:table-row table:style-name="Row1"><table:table-cell><text:p text:style="Table Caption">
A1</text:p></table:table.cell><table:table-cell><text:p text:style="Table Caption">
B1</text:p></table:table-cell><table:table-cell><text:p text:style="Table Caption">
C1</text:p></table:table-cell></table:table-row></table:table-header-rows><table:table-rows><table:table-row><table:table-cell table:style-name="Cell1">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 199 of 738

<text:p text:style="Table Body">
A2</text:p></table:table-cell><table:table-cell table:number-columns-spanned="2"><table:table is-subtable="true"><table:table-columns><table:table-column table:style-name="Col2"/><table:table-column table:style-name="Col3"/></table:table-columns><table:rows><table:row><table:table-cell><text:p text:style="Table Body">.B2.A1</text:p></table:table-cell><table:table-cell><text:p text:style="Table Body">.B2.B1</text:p></table:table-cell></table:table-row><table:table-row><table:table-celltable:number-columns-spanned="2"><text:p text:style="Table Body">.B2.A2</text:p></table:table-cell><table:covered-table-cell/></table:table-row></table:table-rows></table:table></table:table-cell><table:covered-table-cell/></table:table-row></table:table-rows></table:table>

8.3 Advanced Tables
8.3.1 Referencing Table Cells
To reference table cells so called cell addresses are used. The structure of a cell address is asfollows:
1. The name of the table.
2. A dot (.).
3. An alphabetic value representing the column. The letter A represents column 1, B represents
column 2, and so on. AA represents column 27, AB represents column 28, and so on.
4. A numeric value representing the row. The number 1 represents the first row, the number 2
represents the second row, and so on.
This means that A1 represents the cell in column 1 and row 1. B1 represents the cell in column 2
and row 1. A2 represents the cell in column 1 and row 2.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 200 of 738

For example, in a table with the name SampleTable the cell in column 34 and row 16 isreferenced by the cell address SampleTable.AH16. In some cases it is not necessary to provide
the name of the table. However, the dot must be present. When the table name is not required,
the address in the previous example is .AH16.
The structure of the address of a cell in a subtable is as follows:
1. The address of the cell that contains the subtable.
2. A dot (.).
3. The address of the cell in the subtable.
For example, to reference the cell in column 1 and row 1 in a subtable that is called Subtable,
and that is in column 34 and row 16 of the table SampleTable, the address is
SampleTable.AH16.A1.
If the name of the table contains blanks, dots (.) or apostrophes ('), the name must be quoted withapostrophes ('). Any apostrophes in the name must be escaped by doubling ('').
E.g. 'Tom''s Table'.A1 for the cell A1 in the table named Tom's Table.

Absolute and relative cell addressing
Cells can be referenced by using either absolute addresses or relative addresses. When an
operation is performed on a table cell, for example when a formula is copied, absolute cellreferences do not change; In contrast to this, relative cell references are adapted to the addressof target cell of the copy operation. The previous example uses relative addressing.
To create an absolute address, a dollar sign ($) has to be placed before each table name, column
reference, and row reference. For example, the absolute address of the previous example is$SampleTable.$AH$16. Absolute and relative references can be mixed within a single celladdress. For example, SampleTable.AH$16 refers to a relative table and column, but to an
absolute row. Absolute addresses must contain a table name. The differentiation between
absolute and relative addressing is only necessary in some situations. Where a differentiation is
not required, a cell reference without the dollar signs is used.
3869
3870
3871
3872
3873
3874

<define name="cellAddress"><data type="string"><param name="pattern">($?([^\. ']+|'([^']|'')+'))?\.$?[A-Z]+$?[09]+</param></data></define>

Cell Range Address
A cell range is a number of adjacent cells forming a rectangular shape. The rectangle stretchesfrom the cell on the top left to the cell on the bottom right.
A cell range address references a cell range. It is constructed as follow:
1. The address of the cell at the top left of the range.
2. A colon (:).
3. The address of the cell at the bottom right of the range.
For example, the address .A1:.B2 references the cell range of cells from column 1 and row 1 tocolumn 2 and row 2. The smallest range one can specify is a single cell. In this case, the range
address is the same as the cell address.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 201 of 738

3875
3876
3877
3878
3879
3880

<define name="cellRangeAddress"><data type="string"><param name="pattern">($?([^\. ']+|'([^']|'')+'))?\.$?[A-Z]+$?[09]+(:($?([^\. ']+|'([^']|'')+'))?\.$?[A-Z]+$?[0-9]+)?</param></data></define>

Cell Range Address List
A cell range address list is a list of cell ranges and cell addresses. Each item in the list is
separated by a space. If table names used in the list contain a blank character, the table namehas to be quoted within apostrophes (').
3881
3882
3883
3884

<define name="cellRangeAddressList"><!-- Value is a space separated list of "cellRangeAddress" patterns --><data type="string"/></define>

8.3.2 Linked Tables
If a table is linked to an original table, the information about the source table is contained in a<table:table-source> element. The attributes that may be associated with the<table:table-source> element are:

3885
3886
3887
3888
3889
3890
3891

•

Mode

•

Table name

•

URL

•

Filter name•

Filter options•

Refresh delay<define name="table-table-source"><element name="table:table-source"><ref name="table-table-source-attlist"/><ref name="table-linked-source-attlist"/><empty/></element></define>

Mode
The table:mode attribute specifies what data should be copied from the source table to thedestination table. If the attribute's value is “copy-all” formulas and styles are copied. If theattribute's value is “copy-results-only”, only formula results and non calculated cell content will becopied.
3892
3893
3894
3895
3896
3897
3898
3899
3900

<define name="table-table-source-attlist" combine="interleave"><optional><attribute name="table:mode" a:defaultValue="copy-all"><choice><value>copy-all</value><value>copy-results-only</value></choice></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 202 of 738

3901</define>

Table Name
The table:table-name attribute specifies the name of the table in the original document. If thetable name is not specified, the first table in the document is used.
3902
3903
3904
3905
3906
3907
3908

<define name="table-table-source-attlist" combine="interleave"><optional><attribute name="table:table-name"><ref name="string"/></attribute></optional></define>

URL
The original table is specified by a an XLink, where the xlink:href attribute specifies the URLof the document containing the original table.
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923

<define name="table-linked-source-attlist" combine="interleave"><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></define>

Filter Name
The table:filter-name attribute specifies the file type of the document containing the original
table. The value of this attribute is application-specific.
3924
3925
3926
3927
3928
3929
3930

<define name="table-linked-source-attlist" combine="interleave"><optional><attribute name="table:filter-name"><ref name="string"/></attribute></optional></define>

Filter Options
The table:filter-options attribute specifies optional settings about the file type. The valueof this attribute is application-specific.
3931
3932
3933
3934
3935

<define name="table-linked-source-attlist" combine="interleave"><optional><attribute name="table:filter-options"><ref name="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 203 of 738

3936
3937

</optional></define>

Refresh Delay
The table:refresh-delay attribute specifies the time delay between refresh actions for thelinked table.
3938
3939
3940
3941
3942
3943
3944

<define name="table-linked-source-attlist" combine="interleave"><optional><attribute name="table:refresh-delay"><ref name="duration"/></attribute></optional></define>

8.3.3 Scenario Tables
A scenario is an area of a table where data from other, so called scenario tables, is linked totemporarily. If several scenarios are defined for the same area, an user might choose between the
scenarios. Whether a scenario table is visible itself is controlled by table's style. Only one scenario
table can be active per table.
A table that contains a <table:scenario> represents a scenario table. The name of the table
and the name of the scenario are the same. The scenario is displayed in the regular tablepreceding the scenario table. If a scenario table is existing for a table, a scenario is displayed onthat table automatically. These means the the existence of a scenario table implies the existenceof a scenario.
The attributes that may be associated with this element are:

3945
3946
3947
3948
3949
3950

•

Scenario Ranges•

Is Active•

Display Border•

Border Color•

Copy Back•

Copy Styles•

Copy Formulas•

Comment•

Protected<define name="table-scenario"><element name="table:scenario"><ref name="table-scenario-attlist"/><empty/></element></define>

Scenario Ranges
The table:scenario-ranges attribute specifies the table range that is displayed as a
scenario. The value of this attribute is a list of cell range addresses.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 204 of 738

3951
3952
3953
3954
3955

<define name="table-scenario-attlist" combine="interleave"><attribute name="table:scenario-ranges"><ref name="cellRangeAddressList"/></attribute></define>

Is Active
The table:is-active attribute specifies whether or not the scenario that belongs to thescenario table is active.
3956
3957
3958
3959
3960

<define name="table-scenario-attlist" combine="interleave"><attribute name="table:is-active"><ref name="boolean"/></attribute></define>

Display Border
The table:display-border attribute specifies whether or not to display a border around thescenario that belongs to the scenario table.
3961
3962
3963
3964
3965
3966
3967

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:display-border" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Border Color
The table:border-color attribute specifies the color of the border that is displayed aroundthe scenario that belongs to the scenario table.
3968
3969
3970
3971
3972
3973
3974

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:border-color"><ref name="color"/></attribute></optional></define>

Copy Back
The table:copy-back attribute specifies whether or not data is copied back into the scenario
table if another scenario is activated.
3975
3976
3977
3978
3979
3980
3981

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:copy-back" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 205 of 738

Copy Styles
The table:copy-styles attribute specifies whether or not styles are copied from the scenario
table to the destination table together with the data.
3982
3983
3984
3985
3986
3987
3988

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:copy-styles" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Copy Formulas
The table:copy-formulas attribute specifies whether or not formulas are copied from thescenario table to the destination table. The value of this attribute can be true or false. If thevalue is true, the formulas are copied. If the value is false, only the values resulting from theformulas are copied.
3989
3990
3991
3992
3993
3994
3995

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:copy-formulas" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Comment
The table:comment attribute contains a comment about the scenario.
3996
3997
3998
3999
4000
4001
4002

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:comment"><ref name="string"/></attribute></optional></define>

Protected
The table:protected attribute specifies whether or not the data that is displayed within the
scenario is protected from being edited. The attribute is only evaluated if the table on which thescenario displayed is also protected (see section 8.1.1).
4003
4004
4005
4006
4007
4008
4009

<define name="table-scenario-attlist" combine="interleave"><optional><attribute name="table:protected"><ref name="boolean"/></attribute></optional></define>

8.3.4 Shapes
The <table:shapes> element contains all graphic shapes with an anchor on the table thiselement is a child of. It is a container element and does not have any associated attributes.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 206 of 738

4010
4011
4012
4013
4014
4015
4016

<define name="table-shapes"><element name="table:shapes"><oneOrMore><ref name="shape"/></oneOrMore></element></define>

8.4 Advanced Table Cells
8.4.1 Linked Table Cells
A cell range can be linked to a database range or named range of another file. In this case theinformation about the original database range or named range is contained in a <table:cellrange-source> element that is contained in the element of the first cell of the range. The
attributes that may be associated with this element are:

4017
4018
4019
4020
4021
4022
4023

•

Name

•

Last size

•

URL

•

Filter name•

Filter options•

Refresh delay<define name="table-cell-range-source"><element name="table:cell-range-source"><ref name="table-table-cell-range-source-attlist"/><ref name="table-linked-source-attlist"/><empty/></element></define>

Name
The table:name attribute specifies the name of the source database range or named range.
4024
4025
4026
4027
4028

<define name="table-table-cell-range-source-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

Last Size
The table:last-column-spanned and table:last-row-spanned attributes specify thelast known size of the range. If the size of the range is changed since the last operation, thevalues of these attributes are incorrect.
4029
4030
4031
4032
4033
4034

<define name="table-table-cell-range-source-attlist" combine="interleave"><attribute name="table:last-column-spanned"><ref name="positiveInteger"/></attribute><attribute name="table:last-row-spanned"><ref name="positiveInteger"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 207 of 738

4035
4036

</attribute></define>

URL, Filter Name, Filter Options and Refresh Delay
The attributes xlink:href, xlink:type, xlink:actuate, table:filter-name andtable:filter-options are the same as for linked tables. See section 8.3.2 for details.

8.4.2 Cell Annotation
The OpenDocument format allows annotation to appear within table cells. See section 12.1 fordetails on annotations.

8.4.3 Detective
The <table:detective> element has two purposes. One the one hand, it contains information
about relations that exist between table cells because of formulas and that should be highlighted
in the UI. On the other hand, the element contains information about cells that are highlighted
currently in the UI either because of the relations mentioned above or because of error conditions.
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046

<define name="table-detective"><element name="table:detective"><zeroOrMore><ref name="table-highlighted-range"/></zeroOrMore><zeroOrMore><ref name="table-operation"/></zeroOrMore></element></define>

The elements that can be contained in the <table:detective> element are:•Detective Operation•

Highlighted range

8.4.4 Detective Operation
The <table:operation> element specifies that certain relations that exist between the cell theelement is a child of and other cells should be made visible or invisible in the UI. One and thesame detective operation can be applied multiple times to the same cell. In this case, the second
operation is applied to the resulting cells of the first operation and so on. This means that an
operation not necessarily is applied to the cell the operation is defined in, but also to other cells,
and that it therefor can interact with operations defined in other cells. This especially applies tooperations that make relations invisible. To get a determinate behavior, operations have an index
and are applied in the order of that index. The attributes associated with the<table:operation> element are:

4047
4048
4049
4050
4051

•

Name

•

Index

<define name="table-operation"><element name="table:operation"><ref name="table-operation-attlist"/><empty/></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 208 of 738

4052</define>

Name
The table:name attribute specifies the name of the detective operation. Possible names aretrace-dependents , remove-dependents, trace-precedents, remove-precedents
and trace-errors. trace-dependents and remove-dependents displays or hides cells
that use the value of the current cell in their formula. Trace-precedents and removeprecedents displays or hides cells whose value is used in the formula of the current cell.
Trace-errors displays cells that cause an error while calculating the result of the current cell's
formula.
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063

<define name="table-operation-attlist" combine="interleave"><attribute name="table:name"><choice><value>trace-dependents</value><value>remove-dependents</value><value>trace-precedents</value><value>remove-precedents</value><value>trace-errors</value></choice></attribute></define>

Index
The table:index attribute specifies the the order in which detective operations are applied.
4064
4065
4066
4067
4068

<define name="table-operation-attlist" combine="interleave"><attribute name="table:index"><ref name="nonNegativeInteger"/></attribute></define>

8.4.5 Highlighted Range
The <table:highlighted-range> element specifies a cell range that is highlighted in the UI
either because of detective operations described above or because it contains an error or invaliddata.
The information contained in this element is not guaranteed to be up to date but reflects the statethat at the time the detective operations or error conditions have been calculated.
The attributes that can be associated with the <table:highlighted-range> element are:
● Cell Range Address● Direction● Contains Error● Marked Invalid
4069
4070
4071
4072
4073
4074

<define name="table-highlighted-range"><element name="table:highlighted-range"><choice><group><ref name="table-highlighted-range-attlist"/></group>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 209 of 738

4075
4076
4077
4078
4079
4080
4081

<group><ref name="table-highlighted-range-attlist-invalid"/></group></choice><empty/></element></define>

Cell Range Address
The table:cell-range-address attribute contains the address of a range that is highlighted
currently.
4082
4083
4084
4085
4086
4087
4088

<define name="table-highlighted-range-attlist" combine="interleave"><optional><attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

Direction
The table:direction attribute specifies the direction of the relation between this cell and thehighlighted range. The direction for instance might be visualized by an arrow.
4089
4090
4091
4092
4093
4094
4095
4096
4097

<define name="table-highlighted-range-attlist" combine="interleave"><attribute name="table:direction"><choice><value>from-another-table</value><value>to-another-table</value><value>from-same-table</value></choice></attribute></define>

Contains Error
The table:contains-error attribute specifies whether or not the cell range contains an error.
4098
4099
4100
4101
4102
4103
4104

<define name="table-highlighted-range-attlist" combine="interleave"><optional><attribute name="table:contains-error" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Marked Invalid
The table:marked-invalid attribute specifies whether or not the current cell is marked
invalid. This attribute cannot be used together with any other attributes.
4105
4106
4107
4108
4109

<define name="table-highlighted-range-attlist-invalid" combine="interleave"><attribute name="table:marked-invalid"><ref name="boolean"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 210 of 738

8.5 Spreadsheet Document Content
8.5.1 Document Protection
The structure of a spreadsheet document may be protected by using the table:structureprotected attribute, so that users can not insert, delete, move or rename the tables in the
document. The optional table:protection-key attribute may be used to specify a password
that prevents users from resetting the table protection flag to allow editing. To avoid saving the
password directly into the XML file, only a hash value of the password is stored.
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121

<define name="office-spreadsheet-attlist" combine="interleave"><optional><attribute name="table:structure-protected" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="table:protection-key"><ref name="string"/></attribute></optional></define>

8.5.2 Calculation Settings
Spreadsheet documents contain settings that affect the calculation of formulas, for example thenull date or iteration settings. These settings must be saved in the document in the<table:calculation-settings> element.
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132

<define name="table-calculation-settings"><element name="table:calculation-settings"><ref name="table-calculation-setting-attlist"/><optional><ref name="table-null-date"/></optional><optional><ref name="table-iteration"/></optional></element></define>

The attributes that may be associated with the <table:calculation-settings> element are:•Case sensitive•

Precision as shown•

Search criteria must apply to whole cell•

Automatic find labels•

Use regular expression•

Null year•

Null date•

Iteration

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 211 of 738

Case Sensitive
The table:case-sensitive attribute specifies whether or not to distinguish between upperand lower case when comparison operators are applied to cell content.
4133
4134
4135
4136
4137
4138
4139

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:case-sensitive" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Precision as Shown
The table:precision-as-shown attribute specifies whether to perform a calculation using therounded values displayed in the spreadsheet or using all of the digits in a number. If the value of
this attribute is true, calculation are performed using the rounded values displayed in the
spreadsheet. If the value of this attribute is false, calculations are performed using all of thedigits in the number, but the result is still displayed as a rounded number.
4140
4141
4142
4143
4144
4145
4146

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:precision-as-shown" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Search Criteria Must Apply to Whole Cell
The table:search-criteria-must-apply-to-whole-cell attribute specifies whether or
not the specified search criteria, according to the regular expression used, must apply to the entire
cell contents.
4147
4148
4149
4150
4151
4152
4153
4154

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:search-criteria-must-apply-to-whole-cell"
a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Automatic Find Labels
The table:automatic-find-labels attribute specifies whether or not to automatically findthe labels of rows and columns.
4155
4156
4157
4158
4159
4160
4161

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:automatic-find-labels" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 212 of 738

Use Regular Expressions
The table:use-regular-expressions attribute specifies whether regular expressions areenabled for character string comparisons and when searching.
4162
4163
4164
4165
4166
4167
4168
4169

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:use-regular-expressions"a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Null Year
The table:null-year attribute specifies the start year for year values that contain only twodigits. All two digit year values are interpreted as a year that equals or follows the start year.
4170
4171
4172
4173
4174
4175
4176

<define name="table-calculation-setting-attlist" combine="interleave"><optional><attribute name="table:null-year" a:defaultValue="1930"><ref name="positiveInteger"/></attribute></optional></define>

Null Date
The <table:null-date> element specifies the null date. The null date is the date that resultsin the value “0” if a date value is converted into a numeric value. The null date is specified in theelement's table:date-value attribute. Commonly used values are 12/30/1899,
01/01/1900, and 01/01/1904
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192

<define name="table-null-date"><element name="table:null-date"><optional><attribute name="table:value-type" a:defaultValue="date"><ref name="valueType"/></attribute></optional><optional><attribute name="table:date-value"
a:defaultValue="1899-12-30"><ref name="date"/></attribute></optional><empty/></element></define>

Iteration
The <table:iteration> element enables formulas with iterative (or cyclic) references to be
calculated after a specific number of iterations. Formulas with iterative references are repeateduntil the problem is solved. If this iterative calculations are not enabled, a formula with an iterativereference in a table causes an error message.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 213 of 738

Iterative calculations are enabled and disabled with the table:status attribute. If iterative
calculations are enabled, the table:steps attribute specifies the maximum number of iterations
allowed. The table:maximum-difference attribute specifies the maximum difference allowed
between two calculation results. The iteration is stopped if the result is less than the value of this
attribute.
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216

<define name="table-iteration"><element name="table:iteration"><optional><attribute name="table:status" a:defaultValue="disable"><choice><value>enable</value><value>disable</value></choice></attribute></optional><optional><attribute name="table:steps" a:defaultValue="100"><ref name="positiveInteger"/></attribute></optional><optional><attribute name="table:maximum-difference"
a:defaultValue="0.001"><ref name="double"/></attribute></optional><empty/></element></define>

8.5.3 Table Cell Content Validations
Table cell content validations specify validation rules for the content of table cells. The<table:content-validation> element specifies such a validation rule. All validation rulesthat exist in a document are contained <table:content-validations> element. The
validation rules themselves are named and referenced from the table cell by its name.
4217
4218
4219
4220
4221
4222
4223

<define name="table-content-validations"><element name="table:content-validations"><oneOrMore><ref name="table-content-validation"/></oneOrMore></element></define>

4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239

<define name="table-content-validation"><element name="table:content-validation"><ref name="table-validation-attlist"/><optional><ref name="table-help-message"/></optional><optional><choice><ref name="table-error-message"/><group><ref name="table-error-macro"/><optional><ref name="office-event-listeners"/></optional></group>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 214 of 738

4240
4241
4242
4243

</choice></optional></element></define>

The attributes that may be associated with the <table:content-validation> element are:● Name● Condition● Base cell address● Allow empty cell
● Display list

Name
The table:name attribute specifies the name of the content validation. It is used to reference thevalidation rule from the cell the rule should applied to. The name is created automatically by theapplication.
4244
4245
4246
4247
4248

<define name="table-validation-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

Condition
The table:condition attribute specifies the condition that must evaluate to “true” for all cells
the validation rule is applied to. The value of this attribute should be a namespace prefix, followed
by a Boolean expression.
A typical syntax of the expression may be similar to the XPath syntax. The following are valid
conditions:•

Condition ::= ExtendedTrueCondition | TrueFunction 'and'
TrueCondition•

TrueFunction ::= cell-content-is-whole-number() | cell-content-isdecimal-number() | cell-content-is-date() | cell-content-is-time() |cell-content-is-text()•

ExtendedTrueCondition ::= ExtendedGetFunction | cell-content-textlength() Operator Value•

TrueCondition ::= GetFunction | cell-content() Operator Value•

GetFunction ::= cell-content-is-between(Value, Value) | cellcontent-is-not-between(Value, Value)•

ExtendedGetFunction ::= cell-content-text-length-is-between(Value,
Value) | cell-content-text-length-is-not-between(Value, Value) |cell-content-is-in-list( StringList )•Operator ::= '<' | '>' | '<=' | '>=' | '=' | '!='•

Value ::= NumberValue | String | Formula

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 215 of 738

4249
4250
4251
4252
4253
4254
4255

•

StringList ::= StringList ';' String | String•

A Formula is a formula without an equals (=) sign at the beginning. See section 8.1.3 formore information.

•

A String comprises one or more characters surrounded by quotation marks.

•

A NumberValue is a whole or decimal number. It must not contain comma separators fornumbers of 1000 or greater.

<define name="table-validation-attlist" combine="interleave"><optional><attribute name="table:condition"><ref name="string"/></attribute></optional></define>

Base Cell Address
The table:base-cell-address attribute specifies the address of the base cell for relative
addresses in formulas that occur within a condition. This attribute is only necessary when thecondition contains a formula. The value of this attribute must be an absolute cell address that
contains a table name.
4256
4257
4258
4259
4260
4261
4262

<define name="table-validation-attlist" combine="interleave"><optional><attribute name="table:base-cell-address"><ref name="cellAddress"/></attribute></optional></define>

Allow Empty Cell
The table:allow-empty-cell attribute specifies whether or not a cell can be empty.
4263
4264
4265
4266
4267
4268
4269

<define name="table-validation-attlist" combine="interleave"><optional><attribute name="table:allow-empty-cell" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Display List
The table:display-list attribute specifies whether a list of values that occurs within acondition is displayed in the UI wile entering a cell value. The value of this attribute can be none,
unsorted or sort-ascending.

4270
4271
4272

•

none: the list values are not displayed.

•

unsorted: the list values are displayed in the order they occur in the condition.

•sort-ascending: the list values are displayed in ascending order.

<define name="table-validation-attlist" combine="interleave"><optional><attribute name="table:display-list" a:defaultValue="unsorted">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 216 of 738

4273
4274
4275
4276
4277
4278
4279
4280

<choice><value>none</value><value>unsorted</value><value>sort-ascending</value></choice></attribute></optional></define>

Help Message
The <table:help-message> element specifies a message to display if a user selects the cell.
The element has an optional table:title attribute that specifies a title of the help message. It
further has an optional table:display attribute that can be used to suppress the display of themessage.
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297

<define name="table-help-message"><element name="table:help-message"><optional><attribute name="table:title"><ref name="string"/></attribute></optional><optional><attribute name="table:display" a:defaultValue="false"><ref name="boolean"/></attribute></optional><zeroOrMore><ref name="text-p"/></zeroOrMore></element></define>

Error Message
The <table:error-message> element specifies a message to display if a user tries to enter
invalid content into a cell i.e., content where the validation rule's condition evaluates to “false”. The
element has an optional table:title attribute that specifies a title of the help message. It
further has an optional table:display attribute that can be used to suppress the display of themessage. The table:message-type attribute, that can take the values stop, warning, orinformation, specifies whether the message should be displayed as error (stop), warning(warning) or information only (information). In case the message is displayed as error, theoperation that caused the validation check (for instance a cursor travel to leave the cell) is
stopped.
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310

<define name="table-error-message"><element name="table:error-message"><optional><attribute name="table:title"><ref name="string"/></attribute></optional><optional><attribute name="table:display" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 217 of 738

4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323

<attribute name="table:message-type" a:defaultValue="stop"><choice><value>stop</value><value>warning</value><value>information</value></choice></attribute></optional><zeroOrMore><ref name="text-p"/></zeroOrMore></element></define>

Error Macro
As an alternative to displaying a message, a macro might be called if a cell contains invalid
content. The macro in this case is specified by an <office:event-listeners> element as
specified in section 12.4. The event name must be one that specifies an event that is called on
invalid user input.
In addition to the <office:event-listeners> element, the <table:error-macro>element specifies whether the macro should be executed or not.
4324
4325
4326
4327
4328
4329
4330
4331
4332

<define name="table-error-macro"><element name="table:error-macro"><optional><attribute name="table:execute" a:defaultValue="true"><ref name="boolean"/></attribute></optional></element></define>

8.5.4 Label Ranges
Label ranges can be used to assign names to rows and columns, or to parts of rows and columns,
where the names themselves are specified as the content of table cells. More precisely, the label
range element <table:label-range> specifies a label cell range which contain the labels, anddata cell range which specifies the rows or columns whose content is referenced by the labels.
There are two types of label ranges.
•

Label ranges for columns•

Label ranges for rows.

The data cell range should have the same height and vertical position like the label cell range if
row labels are specified, or should have the same width and horizontal position like the label
range if column labels are specified. For information on defining a cell range, see section 8.3.1.
Labels can be used within formula like any other name. All label ranges that exist in a document
are contained within a single <table:label-ranges> element.
4333
4334
4335
4336
4337
4338

<define name="table-label-ranges"><element name="table:label-ranges"><zeroOrMore><ref name="table-label-range"/></zeroOrMore></element>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 218 of 738

4339</define>

4340
4341
4342
4343
4344
4345
4346

<define name="table-label-range"><element name="table:label-range"><ref name="table-label-range-attlist"/><empty/></element></define>

Label Cell Range Address
The table:label-cell-range-address attribute specifies the cell range address of thelabels.
4347
4348
4349
4350
4351

<define name="table-label-range-attlist" combine="interleave"><attribute name="table:label-cell-range-address"><ref name="cellRangeAddress"/></attribute></define>

Data Cell Range Address
The table:data-cell-range-address attribute specifies the cell range address of the data.
4352
4353
4354
4355
4356

<define name="table-label-range-attlist" combine="interleave"><attribute name="table:data-cell-range-address"><ref name="cellRangeAddress"/></attribute></define>

Orientation
The table:orientation attribute specifies the orientation of the label range. This attribute canhave a value of column or row.
4357
4358
4359
4360
4361
4362
4363
4364

<define name="table-label-range-attlist" combine="interleave"><attribute name="table:orientation"><choice><value>column</value><value>row</value></choice></attribute></define>

8.5.5 Named Expressions
The named expressions element <table:named-expressions> contains a collection of
assignments of names to expressions, so that the names can be use to refer to the expression.
The following expression can get names:

4365
4366
4367
4368

•

cell ranges.

•

Other expressions, for example, parts of a formula.

<define name="table-named-expressions"><element name="table:named-expressions"><zeroOrMore><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 219 of 738

4369
4370
4371
4372
4373
4374

<ref name="table-named-range"/><ref name="table-named-expression"/></choice></zeroOrMore></element></define>

4375

Named Range
The named range element <table:named-range> specifies a cell range that has a nameassigned. For information on defining a cell range, see section 8.3.1.
The table:name attribute specifies the name of the range, and the table:cell-rangeaddress attribute its address. The address can be either absolute or relative. If the cell range
address is relative, the table:base-cell-address attribute must exist additionally. It specifies
the base cell address for the cell range. This address must be absolute. Therefore a table namein the address is required, but the dollar signs that indicate an absolute address can be omitted.
An additional table:range-usable-as attribute specifies whether the name of the range canbe used within the specification of a print range, a filter, a repeating row, or a repeat column. The
value of this attribute can be either:•none, or•a space-separated list that consists of any of the values print-range, filter, repeatrow or repeat-column.

4376
4377
4378
4379
4380
4381

<define name="table-named-range"><element name="table:named-range"><ref name="table-named-range-attlist"/><empty/></element></define>

4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408

<define name="table-named-range-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute><attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute><optional><attribute name="table:base-cell-address"><ref name="cellAddress"/></attribute></optional><optional><attribute name="table:range-usable-as" a:defaultValue="none"><choice><value>none</value><list><oneOrMore><choice><value>print-range</value><value>filter</value><value>repeat-row</value><value>repeat-column</value></choice></oneOrMore></list>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 220 of 738

4409
4410
4411
4412

</choice></attribute></optional></define>

Named Expression
The named expression element <table:named-expression> contains an expression with a
name, for example, a part of a formula.
The table:name attribute specifies the name of the expression, and the table:expression
attribute the expression itself. The expressions do not support the equal (=) sign as the firstcharacter. If the expression contains a named range or another named expression, the named
range or named expression must be specified first, before the containing expression. If theexpression contains a relative cell range address, the table:base-cell-address attributemust exist additionally. It specifies the base cell address for the cell range. This address must be
absolute. Therefore a table name in the address is required, but the dollar signs that indicate anabsolute address can be omitted.
4413
4414
4415
4416
4417
4418

<define name="table-named-expression"><element name="table:named-expression"><ref name="table-named-expression-attlist"/><empty/></element></define>

4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432

<define name="table-named-expression-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute><attribute name="table:expression"><ref name="string"/></attribute><optional><attribute name="table:base-cell-address"><ref name="cellAddress"/></attribute></optional></define>

Example: Named expressions element with a named range and a named expression<table:named-expressions><table:named-range table:name="sample1" table:cell-range-address=".C4"
table:base-cell-address="sampletable.F1" table:area-type="none"/><table:named-range table:name="sample2"
table:cell-range-address=".$D$3:.$K$8"
table:area-type="print-range filter"/><table:named-expression table:name="sample3"
table:expression="sum([.A1:.B3])"/></table:named-expressions>

8.6 Database Ranges
A database range is a named area in a table where database operations, but also some otherkind of operations like filtering and sorting, can be performed. The Database Ranges element<table:database-ranges> contains a collection of all database ranges defined in adocument.
4433<define name="table-database-ranges">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 221 of 738

4434
4435
4436
4437
4438
4439

<element name="table:database-ranges"><zeroOrMore><ref name="table-database-range"/></zeroOrMore></element></define>

8.6.1 Database Range
The <table:database-range> defines a single database range.
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460

<define name="table-database-range"><element name="table:database-range"><ref name="table-database-range-attlist"/><optional><choice><ref name="table-database-source-sql"/><ref name="table-database-source-table"/><ref name="table-database-source-query"/></choice></optional><optional><ref name="table-filter"/></optional><optional><ref name="table-sort"/></optional><optional><ref name="table-subtotal-rules"/></optional></element></define>

Database Range Name
The table:name attribute specifies the name of the database range on which to perform
operations. Within a single document, only one database range is allowed to have no name. This
database range is usually automatically created by the application and is used to filter or sort data
in a cell ranges without the user explicitly creating a database range.
4461
4462
4463
4464
4465
4466
4467

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:name"><ref name="string"/></attribute></optional></define>

Is Selection
The table:is-selection attribute specifies whether the database range includes a complete
database, or a selection of records from a database only.
4468
4469
4470
4471
4472
4473
4474

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:is-selection" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 222 of 738

On Update Keep Styles
The table:on-update-keep-styles attribute specifies the behavior if the database range isupdated. If the attribute value is “true”, the cell styles that are assigned to the cells in the first nonlabel row of the database range are used for all rows with in the database range. If the attributevalue is “false”, all cells in the database range get the default cell style of the document assigned.
4475
4476
4477
4478
4479
4480
4481

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:on-update-keep-styles" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

On Update Keep Size
The table:on-update-keep-size attribute specifies the behavior of the database range if thesize of the data in the data source changes. If the attribute value is true, the range retains its size.
If the attribute value is false, the range does not retain its size.
4482
4483
4484
4485
4486
4487
4488

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:on-update-keep-size" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Has Persistent Data
The table:has-persistent-data attribute specifies whether the current data in a databaserange is saved when the document itself is saved.
4489
4490
4491
4492
4493
4494
4495

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:has-persistent-data" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Orientation
The table:orientation attribute specifies the orientation of the database range. The valuesof this attribute are row and column. The orientation is for instance used when sorting databaseranges (see 8.6.5). If the orientation is row, the sorting takes places for rows, otherwise forcolumns.
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:orientation" a:defaultValue="row"><choice><value>column</value><value>row</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 223 of 738

Contains Header
The table:contains-header attribute specifies whether or not the the content of thedatabase range's first row or column should be used to specify labels. If the attribute's value istrue, the content of the first cell within a row or column can be used to reference the whole row
or column within many spreadsheet operations, for instance from within data pilots.
4506
4507
4508
4509
4510
4511
4512

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:contains-header" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Display Filter Buttons
The table:display-filter-buttons buttons attribute specifies whether or not to display
filter buttons. Filter buttons are list box controls displayed in the label cells whose list entries are
the values that exist in the labeled row or column. Selecting one of these entries equals applying afilter to the database range that selects all row or columns where the cells in the labeled row orcolumn have the selected value.
4513
4514
4515
4516
4517
4518
4519
4520

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:display-filter-buttons"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Target Range Address
The table:target-range-address attribute specifies the cell range address of the databaserange. A differentiation between absolute and relative addresses is not possible. Therefore, atable name must be specified in the address and dollar signs are ignored.
4521
4522
4523
4524
4525

<define name="table-database-range-attlist" combine="interleave"><attribute name="table:target-range-address"><ref name="cellRangeAddress"/></attribute></define>

Refresh Delay
The table:refresh-delay attribute specifies a time delay between automatic refresh actions.
4526
4527
4528
4529
4530
4531
4532

<define name="table-database-range-attlist" combine="interleave"><optional><attribute name="table:refresh-delay"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 224 of 738

8.6.2 Database Source SQL
The <table:database-source-sql> element describes an SQL database that contains thesource data of the database range.
4533
4534
4535
4536
4537
4538

<define name="table-database-source-sql"><element name="table:database-source-sql"><ref name="table-database-source-sql-attlist"/><empty/></element></define>

Database Name
A table:database-name attribute specifies the name of the SQL database where the data isimported from.
4539
4540
4541
4542
4543

<define name="table-database-source-sql-attlist" combine="interleave"><attribute name="table:database-name"><ref name="string"/></attribute></define>

SQL Statement
An table:sql-statement attribute specifies the SQL statement to use when importing datafrom an SQL database.
4544
4545
4546
4547
4548

<define name="table-database-source-sql-attlist" combine="interleave"><attribute name="table:sql-statement"><ref name="string"/></attribute></define>

Parse SQL Statement
A table:parse-sql-statement attribute specifies whether or not the application will parse
SQL statements.
4549
4550
4551
4552
4553
4554
4555

<define name="table-database-source-sql-attlist" combine="interleave"><optional><attribute name="table:parse-sql-statement" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

8.6.3 Database Source Table
The database source table element <table:database-source-table> specifies that thesource data of the database range is stored in a database table.
4556
4557
4558
4559
4560
4561

<define name="table-database-source-query"><element name="table:database-source-table"><ref name="table-database-source-table-attlist"/><empty/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 225 of 738

Database Name
The table:database-name name attribute specifies the name of the database where the data
is imported from.
4562
4563
4564
4565
4566

<define name="table-database-source-table-attlist" combine="interleave"><attribute name="table:database-name"><ref name="string"/></attribute></define>

Table Name
A table:database-table-name attribute specifies the database table that data is imported
from.
4567
4568
4569
4570
4571

<define name="table-database-source-table-attlist" combine="interleave"><attribute name="table:database-table-name"><ref name="string"/></attribute></define>

8.6.4 Database Source Query
The database source query element <table:database-source-query> specifies that thesource data of the database range is is the result of a database query.
4572
4573
4574
4575
4576
4577

<define name="table-database-source-table"><element name="table:database-source-query"><ref name="table-database-source-query-attlist"/><empty/></element></define>

Database Name
A table:database-name attribute specifies the name of the database that data is imported
from.
4578
4579
4580
4581
4582

<define name="table-database-source-query-attlist" combine="interleave"><attribute name="table:database-name"><ref name="string"/></attribute></define>

Query Name
A table:query-name attribute specifies the query to perform on the database whose data is
being imported.
4583
4584
4585
4586
4587

<define name="table-database-source-query-attlist" combine="interleave"><attribute name="table:query-name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 226 of 738

8.6.5 Sort
The sort element <table:sort> describes the sort keys that should be applied to a databaserange.
4588
4589
4590
4591
4592
4593
4594
4595

<define name="table-sort"><element name="table:sort"><ref name="table-sort-attlist"/><oneOrMore><ref name="table-sort-by"/></oneOrMore></element></define>

Bind Styles to Content
The table:bind-styles-to-content attribute specifies whether or not cells retain their styleattributes after a sort operation.
4596
4597
4598
4599
4600
4601
4602

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:bind-styles-to-content" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Target Range Address
If the optional table:target-range-address attribute is present, the result of the sort iscopied into the specified cell range rather than in the source cell range specified by the databaserange. A differentiation between absolute and relative addresses is not possible. Therefore, atable name has to exist in the address and dollar signs are ignored.
4603
4604
4605
4606
4607
4608
4609

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:target-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

Case Sensitive
The table:case-sensitive attribute specifies whether or not the sort operation is casesensitive.
4610
4611
4612
4613
4614
4615
4616

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:case-sensitive" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Language
The table:language attribute specifies the natural language in which the comparison will
occur.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 227 of 738

4617
4618
4619
4620
4621
4622
4623

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:language"><ref name="languageCode"/></attribute></optional></define>

Country
The table:country attribute specifies the country specific rules to be used in string
comparisons for a particular natural language.

4624
4625
4626
4627
4628
4629
4630

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:country"><ref name="countryCode"/></attribute></optional></define>

Algorithm
The table:algorithm attribute specifies the algorithm used to compare sort keys. The
attribute's value is a an application but also language and country specific sort algorithm name like“phonetic (alphanumeric first)”. To avoid name clashed between different applications, the nameshould start with a namespace prefix
4631
4632
4633
4634
4635
4636
4637

<define name="table-sort-attlist" combine="interleave"><optional><attribute name="table:algorithm"><ref name="string"/></attribute></optional></define>

8.6.6 Sort By
The sort by element <table:sort-by> specifies a key or field to sort, the data type of this field,
and how to sort it.
4638
4639
4640
4641
4642
4643

<define name="table-sort-by"><element name="table:sort-by"><ref name="table-sort-by-attlist"/><empty/></element></define>

Field Number
The table:field-number number attribute specifies the row or column number to sort by. It isthe number of a row or column within the database range.
4644
4645
4646
4647

<define name="table-sort-by-attlist" combine="interleave"><attribute name="table:field-number"><ref name="nonNegativeInteger"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 228 of 738

4648</define>

Data TypeThe table:data-type attribute specifies the data type of the field to be sorted. Its value can be
text, number, automatic or the name of user defined sort order. If the attribute value is
automatic, the application must determine what type of data is in the field. User defined sortorders are for instance lists of names of months. Specifying user defined sort orders is application
specific.
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660

<define name="table-sort-by-attlist" combine="interleave"><optional><attribute name="table:data-type" a:defaultValue="automatic"><choice><value>text</value><value>number</value><value>automatic</value><ref name="string"/></choice></attribute></optional></define>

Order
The table:order attribute specifies whether to sort the data in ascending or descending order.
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670

<define name="table-sort-by-attlist" combine="interleave"><optional><attribute name="table:order" a:defaultValue="ascending"><choice><value>ascending</value><value>descending</value></choice></attribute></optional></define>

8.6.7 Subtotal Rules
The subtotal rules element <table:subtotal-rules> specifies that provisional results (called
subtotals) should be calculated for a database range. It contains information about the row orcolumn provisional results should be calculated for, and also how these results are calculated. To
calculate provisional results, the cell values of a row or column a grouped by their value, that is, allcells with the same content in the same field form a group. A provisional result is calculated anddisplayed at the end of each group.
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681

<define name="table-subtotal-rules"><element name="table:subtotal-rules"><ref name="table-subtotal-rules-attlist"/><optional><ref name="table-sort-groups"/></optional><zeroOrMore><ref name="table-subtotal-rule"/></zeroOrMore></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 229 of 738

Bind Styles To Content
The table:bind-styles-to-content attribute specifies whether or not cells retain their styleafter a subtotal calculation. This attribute is only evaluated if the table:sort-groups element
is present.
4682
4683
4684
4685
4686
4687
4688

<define name="table-subtotal-rules-attlist" combine="interleave"><optional><attribute name="table:bind-styles-to-content" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Case Sensitive
The table:case-sensitive attribute specifies whether or not the case of characters isimportant when comparing entries, for example, when sorting groups.
4689
4690
4691
4692
4693
4694
4695

<define name="table-subtotal-rules-attlist" combine="interleave"><optional><attribute name="table:case-sensitive" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Page Breaks On Group Change
The table:page-breaks-on-group-change on group change attribute specifies whether or
not to insert a page break after the subtotal for each group.
4696
4697
4698
4699
4700
4701
4702
4703

<define name="table-subtotal-rules-attlist" combine="interleave"><optional><attribute name="table:page-breaks-on-group-change"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

8.6.8 Subtotal Sort Groups
The optional sort groups element <table:sort-groups> specifies that columns or rows are
sorted before grouping them, and how to sort them. It belongs to the subtotal rules element, seesection 8.6.7.
4704
4705
4706
4707
4708
4709

<define name="table-sort-groups"><element name="table:sort-groups"><ref name="table-sort-groups-attlist"/><empty/></element></define>

Data TypeThe table:data-type attribute specifies the data type of the column or row group to sort. See
section 8.6.6 for details.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 230 of 738

4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721

<define name="table-sort-groups-attlist" combine="interleave"><optional><attribute name="table:data-type" a:defaultValue="automatic"><choice><value>text</value><value>number</value><value>automatic</value><ref name="string"/></choice></attribute></optional></define>

Order
The table:order attribute specifies whether to sort the group data in ascending or descendingorder. See section 8.6.6 for details.
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731

<define name="table-sort-groups-attlist" combine="interleave"><optional><attribute name="table:order" a:defaultValue="ascending"><choice><value>ascending</value><value>descending</value></choice></attribute></optional></define>

8.6.9 Subtotal Rule
The subtotal rule element <table:subtotal-rule> describes how to calculate the subtotals
for a certain row or column. The rule contains the group field number, which specifies the column
group for which the rule is used, and one or more subtotal fields, which specify a row a column
where subtotals should be calculated as well as the function to use for the calculation.
4732
4733
4734
4735
4736
4737
4738
4739

<define name="table-subtotal-rule"><element name="table:subtotal-rule"><ref name="table-subtotal-rule-attlist"/><zeroOrMore><ref name="table-subtotal-field"/></zeroOrMore></element></define>

Group By Field Number
The table:group-by-field-number attribute specifies the field, for example, a column, thatis to be grouped. It is the number of a row or column within the database range.
4740
4741
4742
4743
4744

<define name="table-subtotal-rule-attlist" combine="interleave"><attribute name="table:group-by-field-number"><ref name="nonNegativeInteger"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 231 of 738

8.6.10 Subtotal Field
The subtotal field element <table:subtotal-field> contains the field number and thefunction that is used to calculate a provisional result.
4745
4746
4747
4748
4749
4750

<define name="table-subtotal-field"><element name="table:subtotal-field"><ref name="table-subtotal-field-attlist"/><empty/></element></define>

Field Number
The table:field-number attribute specifies the row or column a subtotal should be calculatedfor. It is the number of a row or column within the database range.
4751
4752
4753
4754
4755

<define name="table-subtotal-field-attlist" combine="interleave"><attribute name="table:field-number"><ref name="nonNegativeInteger"/></attribute></define>

Function
The table:function attribute specifies what kind of subtotals to calculate. The following are
possible values for this attribute: auto, average, count, countnums, max, min, product,
stdev, stdevp, sum, var and varp.
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774

<define name="table-subtotal-field-attlist" combine="interleave"><attribute name="table:function"><choice><value>auto</value><value>average</value><value>count</value><value>countnums</value><value>max</value><value>min</value><value>product</value><value>stdev</value><value>stdevp</value><value>sum</value><value>var</value><value>varp</value><ref name="string"/></choice></attribute></define>

Example: Subtotal field<table:database-range table:rangeposition="sampletable.A1:sampletable.G20" table:name="sample"><table:database-source-table table:database-name="sampleDB"
table:table-name="sampleTable"/><table:filter ...>...
</table:filter><table:sort><table:sort-by table:field-number=1/></table:sort>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 232 of 738

<table:subtotal-rules><table:sort-groups/><table:subtotal-rule table:column-group "3"><table:subtotal-field table:field-number="1"
table:function="sum"/></table:subtotal-rule></table:subtotal-rules></table:database-range>

8.7 Filters
Filters specify that only rows that match certain conditions should be visible

8.7.1 Table Filter
The table filter element <table:filter> describes how the data contained in a database range
or data pilot tables is filtered. The condition specified in the element are applied to all rows
specified in the database range or the data pilot table. Rows where the condition does notevaluate to true are made invisible.
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784

<define name="table-filter"><element name="table:filter"><ref name="table-filter-attlist"/><choice><ref name="table-filter-condition"/><ref name="table-filter-and"/><ref name="table-filter-or"/></choice></element></define>

Target Range Address
If the optional table:target-range-address attribute is present, the result of the filter iscopied into the specified cell range but all table rows remain visible. If the attribute is not present,
the rows that do not match the filter conditions are not displayed. A differentiation between
absolute and relative addresses is not possible. Therefore, a table name has to exist in theaddress and dollar signs are ignored.
4785
4786
4787
4788
4789
4790
4791

<define name="table-filter-attlist" combine="interleave"><optional><attribute name="table:target-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

Condition Source
The table:condition-source attribute specifies whether the condition is contained in thefilter or encoded in a table range. If the value is self the condition is specified by the <table:filter>
element's child elements. If the value is cell-range the condition is encoded into the cell range
specified by the table:condition-source-range-address attribute.
4792
4793
4794
4795

<define name="table-filter-attlist" combine="interleave"><optional><attribute name="table:condition-source" a:defaultValue="self"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 233 of 738

4796
4797
4798
4799
4800
4801

<value>self</value><value>cell-range</value></choice></attribute></optional></define>

Condition Source Range Address
The table:condition-source-range-address attribute specifies a cell range that contains
encoded conditions. The first row of the cell range has to contain the labels of the columns whose
content should be filtered. The following rows contain conditions that have to evaluate to true forthe cells contained in the columns. The conditions in each row are connected by an “and”
operation, while the rows are connected by an “or” operation. This means that a row is of thesource table is displayed if there is at least one row in the condition range where all conditions
evaluate to true if they are applied to the columns specified in the first row of the condition range.
Example: If the condition source range is E1:F3 (shown yellow) and the source range is A1:C3(shown green), only rows 2 and 3 are displayed.
A

B

C

D

E

F

1

1

3

4

A

B

2

1

5

6

=1

=5

3

2

8

9

>=2

G

G

I

Row 2 is displayed because the cell in column A has the value 1 and the cell in column B thevalue 5, so all conditions of the 2nd row of the condition range evaluate to true. Row 3 is displayed
because the cell in column A is larger or equal than 2, and therefor the only condition in the the 3rd
row of the condition range evaluates to true.
4802
4803
4804
4805
4806
4807
4808

<define name="table-filter-attlist" combine="interleave"><optional><attribute name="table:condition-source-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

Display Duplicates
The table:display-duplicates attribute specifies whether or not to display duplicate
matches in the result.
4809
4810
4811
4812
4813
4814
4815

<define name="table-filter-attlist" combine="interleave"><optional><attribute name="table:display-duplicates" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

8.7.2 Filter And
The <table:filter-and> element specifies that the logical operator AND is applied to theconditions specified by the element's child elements.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 234 of 738

4816
4817
4818
4819
4820
4821
4822
4823
4824
4825

<define name="table-filter-and"><element name="table:filter-and"><oneOrMore><choice><ref name="table-filter-or"/><ref name="table-filter-condition"/></choice></oneOrMore></element></define>

8.7.3 Filter Or
The <table:filter-or> element specifies that the logical operator OR is applied to theconditions specified by the element's child elements.
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835

<define name="table-filter-or"><element name="table:filter-or"><oneOrMore><choice><ref name="table-filter-and"/><ref name="table-filter-condition"/></choice></oneOrMore></element></define>

8.7.4 Filter Condition
The table <table:filter-condition> element describes a single condition to apply in a filter
operation.
4836
4837
4838
4839
4840
4841

<define name="table-filter-condition"><element name="table:filter-condition"><ref name="table-filter-condition-attlist"/><empty/></element></define>

Field Number
The field number attribute table:field-number specifies which field to use for the condition. A
field number is the number of a row or column in the source range of the filter.
4842
4843
4844
4845
4846

<define name="table-filter-condition-attlist" combine="interleave"><attribute name="table:field-number"><ref name="nonNegativeInteger"/></attribute></define>

Value
The table:value attribute specifies a value for the filter condition.
4847
4848
4849
4850
4851

<define name="table-filter-condition-attlist" combine="interleave"><attribute name="table:value"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 235 of 738

Operator
The operator attribute table:operator specifies what operator to use in the filter condition.
This means that each cell contained in the columns specified by the field number (i.e., thetable:field-number attribute) is compared with the value (i.e., the table:value attribute)
using the given operator. The result of this comparison is the result of the filter sub-conditions
specified by the <table:filter-condition> element.
The operators may or may not make use of regular expressions. The operators that use regularexpressions are the following:•match (matches)•!match (does not match)

In both case, the table:value attribute contains the regular expression that the table cells haveto match or must not match.
The relational operators that do not use regular expressions are:•= (Equal to)•!= (Not equal to)•< (Less than)•> (Greater than)•<= (Less than or equal to)•>= (Greater than or equal to)

In addition, operators “empty”, “!empty”, “bottom values”, “top values”, “bottom percent”, and “toppercent” can be used. To filter for example the lowest and highest percentage values, the latter
two operators can be used.
4852
4853
4854
4855
4856

<define name="table-filter-condition-attlist" combine="interleave"><attribute name="table:operator"><ref name="string"/></attribute></define>

Case Sensitive
The table:case-sensitive case sensitive attribute determines whether a filter condition iscase sensitive.
4857
4858
4859
4860
4861
4862
4863

<define name="table-filter-condition-attlist" combine="interleave"><optional><attribute name="table:case-sensitive" a:defaultValue="false"><ref name="string"/></attribute></optional></define>

Data TypeThe table:data-type attribute specifies whether comparison shall take place as text or as
numeric values.
4864<define name="table-filter-condition-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 236 of 738

4865
4866
4867
4868
4869
4870
4871
4872
4873

<optional><attribute name="table:data-type" a:defaultValue="text"><choice><value>text</value><value>number</value></choice></attribute></optional></define>

Example:Representation of a filter<filter><filter-or><filter-and><filter-condition table:field-number=1 table:operator="="table:value="Doe"/><filter-condition table:field-number=2 table:operator="="table:value="John"/></filter-and><filter-and><filter-condition table:field-number=1 table:operator="="table:value="Burns"/><filter-condition table:field-number=2 table:operator="="table:value="Michael"/></filter-and></filter-or></filter>

8.8 Data Pilot Tables
Data pilot tables allow it to analyze and evaluate data contained in spreadsheet tables. The data
pilot tables element <table:data-pilot-tables> contains the collection of all data pilot
tables within a document.
4874
4875
4876
4877
4878
4879
4880

<define name="table-data-pilot-tables"><element name="table:data-pilot-tables"><zeroOrMore><ref name="table-data-pilot-table"/></zeroOrMore></element></define>

8.8.1 Data Pilot Table
The <table:data-pilot-table> specifies a single data pilot table. Within data pilot tables, allcombinations of values that exist in selected columns are collected, and for each of these
combinations a formula is applied to the cells of other columns.
Example: Given is the following source table
A

B

C

D

1 Article

City

Country

AmountPrice

2 Main Unit Hamburg Germany

1

12

3 Monitor

Hamburg Germany

215

4 Printer

Paris

4

13

France

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 237 of 738

5 Monitor

Paris

France2

14

6 Main Unit Paris

France1

12

7 Monitor

Hamburg Germany

2

10

8 Printer

Paris

2

16

France

The following data pilot table groups the source table by the columns “County”, “City” and “Article”
and calculates the sum of the “Amount” as well as of the “Price” columns for each combinations ofvalues of these three columns. The values of the Country and City columns are shown incolumns, while the ones of the Article columns are shown in rows.
ArticleCountry

City

Data

FranceParis

Sum - Amount

1

2

6

9

Sum - Price

12

14

29

55

1

4

5

12

25

37

Total sum - Amount

2

6

6

14

Total sum - Price

24

39

29

92

Germany

Hamburg Sum - Amount
Sum - Price

Main Unit Monitor Printer Total

The columns that are used for grouping (here “County”, “City” and “Article”) are called category
columns. The columns for which a formula is calculated based on the value combinations of thecategory columns (here “Amount” and “Price”) are called data columns. The individual values thatexists within a category column are called members.
In general, the behavior of a data pilot is specified by fields, where each field has a name and a socalled orientation. The category columns are specified by fields with the orientation “row” or“column” and the data columns are specified by fields that have the orientation “data”. In theabove example, “Article” is a field with the orientation column, while “Country” and “City” are fields
with the orientation row. “Amount” and “Price” are fields with “data” orientation.
A third kind of fields are data layout fields. Data layout fields are not connected to a column in thesource table, but have the only the purpose to change the layout of the data pilot table. In theexample, “Data” is a data layout field.
The order in which fields are specified is of relevance. It specified the order in which the data of
category columns is grouped and results are displayed. The data pilot table below displays how
the data pilot table changes if for instance the data layout field is specified before the category
column fields.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 238 of 738

Example: A data pilot with a modified layout
ArticleData

CountryCity

Sum - AmountFranceParis

Main Unit Monitor Printer Total
1

2

Germany Hamburg

1

4France

12

14

12

25

Total sum - Amount

2

6

6

14

Total sum - Price

24

39

29

92

Sum - Price

Paris

Germany Hamburg

6

9
5

29

55
37

The attributes associated with the data pilot table element are:

4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897

•

Data pilot table name•Application data•

Grand total•

Ignore empty rows•

Identify categories•

Target range address•Show Filter Button•

Drill Down On Double Click<define name="table-data-pilot-table"><element name="table:data-pilot-table"><ref name="table-data-pilot-table-attlist"/><optional><choice><ref name="table-database-source-sql"/><ref name="table-database-source-table"/><ref name="table-database-source-query"/><ref name="table-source-service"/><ref name="table-source-cell-range"/></choice></optional><oneOrMore><ref name="table-data-pilot-field"/></oneOrMore></element></define>

Data Pilot Table Source
The source of the data pilot table is either stored in a database, that is, a database table itself, a
SQL query or a named query, or it is a cell range located within the same document. It can also
be provided by an external component in an implementation dependent way.
The source of the data pilot table is specified by one of the following elements that are containedin the <table:data-pilot-table> element:•<table:database-source-sql> (see section 8.6.2)

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 239 of 738

•<table:database-source-table> (see section 8.6.3)•<table:database-source-query> (see section 8.6.4)•<table:source-cell-range> (see section 8.8.2)•<table:source-service> (see section 8.8.3)

Data Pilot Table Name
The table:name attribute specifies the name of the data pilot table.
4898
4899
4900
4901
4902

<define name="table-data-pilot-table-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

Application Data
The table:application-data attribute specifies extra information about the data pilot table,
which can be used by the application, for instance within macros. This data does not influence thebehavior of the data pilot.
4903
4904
4905
4906
4907
4908
4909

<define name="table-data-pilot-table-attlist" combine="interleave"><optional><attribute name="table:application-data"><ref name="string"/></attribute></optional></define>

Grand Total
The table:grand-total attribute specifies whether a grand total column, row, or both should
be displayed in addition to values calculated for each combination of values in the category
columns. In the above example, grand totals are enabled. They are displayed in the row andcolumn labeled “Total”.
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921

<define name="table-data-pilot-table-attlist" combine="interleave"><optional><attribute name="table:grand-total" a:defaultValue="both"><choice><value>none</value><value>row</value><value>column</value><value>both</value></choice></attribute></optional></define>

Ignore Empty Rows
The table:ignore-empty-rows attribute specifies whether or not empty rows in the source
range should be ignored.
4922
4923

<define name="table-data-pilot-table-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 240 of 738

4924
4925
4926
4927
4928

<attribute name="table:ignore-empty-rows" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Identify Categories
The table:identify-categories attribute specifies whether rows that do not contain a value
in one of the category columns should use the value of the nearest ancestor row that has a value,or whether such rows should be moved into a group (or category) of its own. If the attribute's value
is false, empty values form a category of its own.
4929
4930
4931
4932
4933
4934
4935

<define name="table-data-pilot-table-attlist" combine="interleave"><optional><attribute name="table:identify-categories" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Target Range Address
The table:target-range-address attribute specifies where the target range of the data pilot
table output, that is, where the data pilot table is displayed. A differentiation between absolute andrelative addresses is not possible, that is, the address is interpreted as an absolute address even
if it contains dollar signs. The range address must contain a table name.
4936
4937
4938
4939
4940

<define name="table-data-pilot-table-attlist" combine="interleave"><attribute name="table:target-range-address"><ref name="cellRangeAddress"/></attribute></define>

Buttons
Within a data pilot table, some cells might be displayed as buttons to allow interactive operations
on the table like changing the order of columns. The table:buttons attribute specifies all cells
which should be displayed this way. Its value is a list of cell-addresses. A differentiation between
absolute and relative addresses is not possible, that is, the addresses are interpreted as absoluteaddresses even if they contain dollar signs. All addresses must contain a table name.
In the examples above, button cells are displayed with a gray background.
4941
4942
4943
4944
4945
4946
4947

<define name="table-data-pilot-table-attlist" combine="interleave"><optional><attribute name="table:buttons"><ref name="cellRangeAddressList"/></attribute></optional></define>

Show Filter Button
The table:show-filter-button attribute specifies whether a filter button is shown in the UI
within the Data Pilot. A filter button displays a filter dialog if pushed.
4948
4949

<define name="table-data-pilot-table-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 241 of 738

4950
4951
4952
4953
4954

<attribute name="table:show-filter-button" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Drill Down On Double Click
The table:drill-down-on-double-click attribute specifies how the data pilot table reacts
on a double click into the data pilot table. If the attribute's value is false, a double click on amember label or the empty area next to it starts the edit mode of the table cell, like for cells
outside of the data pilot table. This can then be used to rename group fields or members. If theattribute's value is true, a double click on a member label or the empty area next to it shows or
hides details for that member. A double click elsewhere in a data pilot table has no effect.
4955
4956
4957
4958
4959
4960
4961
4962

<define name="table-data-pilot-table-attlist" combine="interleave"><optional><attribute name="table:drill-down-on-double-click"a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

8.8.2 Source Cell Range
If the source of a data pilot table is a cell range, the <table:source-cell-range> element
contains information about the cell range and how the data pilot table gets the data from therange. Before the source data is processed by the data pilot data, a filter may be applied to it. Thisfilter has to be specified by a <table:filter> child element.
4963
4964
4965
4966
4967
4968
4969
4970

<define name="table-source-cell-range"><element name="table:source-cell-range"><ref name="table-source-cell-range-attlist"/><optional><ref name="table-filter"/></optional></element></define>

The only attribute that may be associated with the source cell range element is:•

Cell range address

Cell Range Address
The table:cell-range-address attribute specifies the cell range containing the source data.
The source cell range's address must be absolute. Therefore, the cell range address must containa table name and dollar signs are ignored.
4971
4972
4973
4974
4975

<define name="table-source-cell-range-attlist" combine="interleave"><attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 242 of 738

8.8.3 Source Service
The source of a data pilot table can be “service”, that is, it can be provided by an external
component. The source service element <table:source-service> contains information about
the service which is used to create the data pilot table.
4976
4977
4978
4979
4980
4981

<define name="table-source-service"><element name="table:source-service"><ref name="table-source-service-attlist"/><empty/></element></define>

The attributes that may be associated with this element are:•Service name•Source name•Object name•Source user name•Source password

Service Name
The table:name attribute specifies the name of the service. The value of this attribute is
implementation specific.
4982
4983
4984
4985
4986

<define name="table-source-service-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

Source Name
The table:source-name attribute specifies a source name that is passed to the service
implementation. Its value is application and service specific.
4987
4988
4989
4990
4991

<define name="table-source-service-attlist" combine="interleave"><attribute name="table:source-name"><ref name="string"/></attribute></define>

Object Name
The table:object-name attribute specifies the name of the object in the source which contains
the data and is passed to the service implementation. Its value is application and service specific.
4992
4993
4994
4995
4996

<define name="table-source-service-attlist" combine="interleave"><attribute name="table:object-name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 243 of 738

Source User Name
The table:user-name attribute specifies the user name required to access the source. It ispassed to the service implementation. Its value is application and service specific.
4997
4998
4999
5000
5001
5002
5003

<define name="table-source-service-attlist" combine="interleave"><optional><attribute name="table:user-name"><ref name="string"/></attribute></optional></define>

Source Password
The table:password attribute specifies the password required to access the source. It ispassed to the service implementation. Its value is application and service specific.
5004
5005
5006
5007
5008
5009
5010

<define name="table-source-service-attlist" combine="interleave"><optional><attribute name="table:password"><ref name="string"/></attribute></optional></define>

8.8.4 Data Pilot Field
A data pilot table's fields are specified by <table:data-pilot-field> elements.
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024

<define name="table-data-pilot-field"><element name="table:data-pilot-field"><ref name="table-data-pilot-field-attlist"/><optional><ref name="table-data-pilot-level"/></optional><optional><ref name="table-data-pilot-field-reference"/></optional><optional><ref name="table-data-pilot-groups"/></optional></element></define>

The attributes that may be associated with the data pilot field element are:•Source field name•

Orientation•

Is data layout field•

Function•

Used hierarchy

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 244 of 738

Source Field Name
For fields that specify category or data columns, the table:source-field-name attribute
specifies the name or label of the column the field is connected to. If the source of the data pilot
table is for instance a cell range, then the attribute's value has to be the column's label.
There can be multiple <table:data-pilot-field> elements with the same value for this
attribute.
5025
5026
5027
5028
5029

<define name="table-data-pilot-field-attlist" combine="interleave"><attribute name="table:source-field-name"><ref name="string"/></attribute></define>

Orientation
The table:orientation attribute specifies the orientation of the source field. If the value isdata, then the field specifies a data column. If the value is row or column, then the field
specifies a category column. The value hidden is used for fields that have a corresponding
column in the data pilot's source, but are not visible within the data pilot table. The value page
indicates that an automatic filter (i.e., one that allows to choose one of the values that arecontained in the column) should be generated for the corresponding column. In this case, anadditional field with row, column or data orientation has to exist for the column.
If the attribute value is page, the table:selected-page attribute can be used to specify which
value is selected for the filter.
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049

<define name="table-data-pilot-field-attlist" combine="interleave"><choice><attribute name="table:orientation"><choice><value>row</value><value>column</value><value>data</value><value>hidden</value></choice></attribute><group><attribute name="table:orientation"><value>page</value></attribute><attribute name="table:selected-page"><ref name="string"/></attribute></group></choice></define>

Is Data Layout Field
The table:is-data-layout-field attribute specifies whether a field is a data layout field(see section 8.8.1). Data layout fields usually don't have a name.
5050
5051
5052
5053
5054
5055

<define name="table-data-pilot-field-attlist" combine="interleave"><optional><attribute name="table:is-data-layout-field" a:defaultValue="false"><ref name="string"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 245 of 738

5056</define>

Function
The table:function attribute specifies the function which is applied to the cell values of data
columns. It is only evaluated if the value of the table:orientation attribute is data.
Possible values for this attribute are: auto, average, count, countnums, max, min, product,
stdev, stdevp, sum, var and varp. For category columns the attribute's value auto can beused that specifies that no function is applied at all.
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077

<define name="table-data-pilot-field-attlist" combine="interleave"><optional><attribute name="table:function"><choice><value>auto</value><value>average</value><value>count</value><value>countnums</value><value>max</value><value>min</value><value>product</value><value>stdev</value><value>stdevp</value><value>sum</value><value>var</value><value>varp</value><ref name="string"/></choice></attribute></optional></define>

Used Hierarchy
If the data pilot source is provided by an external component or service, the data contained within
category columns may not only grouped by its value, but it may be further divided into sub-groups
or hierarchies. A date value for instance might be grouped by•“year”, “month” and “day of month”, or•“year”, “week” and “day of week”

If an external components supports hierarchies, it has to assign unique numbers to it. These
numbers can be used in the table:used-hierarchy attribute to select the hierarchy thatshould be applied to the source field. The value means that no hierarchy should be applied at all.
5078
5079
5080
5081
5082
5083
5084

<define name="table-data-pilot-field-attlist" combine="interleave"><optional><attribute name="table:used-hierarchy" a:defaultValue="-1"><ref name="integer"/></attribute></optional></define>

8.8.5 Data Pilot Level
The data pilot level element <table:data-pilot-level> contains additional information
about a data pilot field.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 246 of 738

5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104

<define name="table-data-pilot-level"><element name="table:data-pilot-level"><ref name="table-data-pilot-level-attlist"/><optional><ref name="table-data-pilot-subtotals"/></optional><optional><ref name="table-data-pilot-members"/></optional><optional><ref name="table-data-pilot-display-info"/></optional><optional><ref name="table-data-pilot-sort-info"/></optional><optional><ref name="table-data-pilot-layout-info"/></optional></element></define>

The attribute that may be associated associate with the data pilot level element is:•Show empty

Show Empty
The table:show-empty attribute specifies whether or not fields that don't have any members
should be displayed. If this attribute is not present, the application might or might not display suchfields.
5105
5106
5107
5108
5109
5110
5111

<define name="table-data-pilot-level-attlist" combine="interleave"><optional><attribute name="table:show-empty"><ref name="boolean"/></attribute></optional></define>

8.8.6 Data Pilot Subtotals
The data pilot subtotals element <table:data-pilot-subtotals> contains information about
the provisional results that are displayed for every member of a field and the function used to
calculate the result. Several provisional results can be calculated simultaneously. If the element is
not present, the application might or might not display provisional results.
5112
5113
5114
5115
5116
5117
5118

<define name="table-data-pilot-subtotals"><element name="table:data-pilot-subtotals"><zeroOrMore><ref name="table-data-pilot-subtotal"/></zeroOrMore></element></define>

8.8.7 Data Pilot Subtotal
The data pilot subtotal element <table:data-pilot-subtotal> contains information about asingle provision result calculation.
5119<define name="table-data-pilot-subtotal">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 247 of 738

5120
5121
5122
5123
5124

<element name="table:data-pilot-subtotal"><ref name="table-data-pilot-subtotal-attlist"/><empty/></element></define>

The attribute that may be associated associate with the data pilot subtotal element is:•

Function

Function
The table:function attribute specifies the function used for the subtotal. Possible functions
are auto, average, count, countnums, max, min, product, stdev, stdevp, sum, var and
varp.
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143

<define name="table-data-pilot-subtotal-attlist" combine="interleave"><attribute name="table:function"><choice><value>auto</value><value>average</value><value>count</value><value>countnums</value><value>max</value><value>min</value><value>product</value><value>stdev</value><value>stdevp</value><value>sum</value><value>var</value><value>varp</value><ref name="string"/></choice></attribute></define>

8.8.8 Data Pilot Members
For category columns, it can be controlled whether certain members themselves or the
information displayed for a certain member actually is displayed or not. The <table:datapilot-members> element contains such information.
5144
5145
5146
5147
5148
5149
5150

<define name="table-data-pilot-members"><element name="table:data-pilot-members"><zeroOrMore><ref name="table-data-pilot-member"/></zeroOrMore></element></define>

8.8.9 Data Pilot Member
The data pilot member element <table:data-pilot-member> specifies which information isdisplayed for a certain member.
5151
5152
5153
5154

<define name="table-data-pilot-member"><element name="table:data-pilot-member"><ref name="table-data-pilot-member-attlist"/><empty/>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 248 of 738

5155
5156

</element></define>

The attributes that may be associated with the data pilot member element are:•Member name•

Display•Show details

Member Name
The table:name attribute specifies the value for which display information is specified.
5157
5158
5159
5160
5161

<define name="table-data-pilot-member-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

Display
The table:display attribute specifies whether or not a data pilot member is visible at all. If this
attribute is not present, the application might or might not display the member.
5162
5163
5164
5165
5166
5167
5168

<define name="table-data-pilot-member-attlist" combine="interleave"><optional><attribute name="table:display"><ref name="boolean"/></attribute></optional></define>

Show Details
The table:show-details attribute specifies whether additional fields are displayed for amember. This attribute changes the behavior of a data pilot only if there are several fields with theorientation row or column. If this is the case, and if the attribute's value is false for a field withrow or column orientation that is not the last field with this orientation, then no members are
displayed for all following fields with the same orientation. Instead of this, the data displayed forthese fields will be summarized.
5169
5170
5171
5172
5173
5174
5175

<define name="table-data-pilot-member-attlist" combine="interleave"><optional><attribute name="table:show-details"><ref name="boolean"/></attribute></optional></define>

8.8.10 Data Pilot Display Info
The <table:data-pilot-display-info> element restricts the number rows that are
displayed for a category field to a specific number of values of a data field.
5176
5177
5178

<define name="table-data-pilot-display-info"><element name="table:data-pilot-display-info"><ref name="table-data-pilot-display-info-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 249 of 738

5179
5180
5181

<empty/></element></define>

Enabled
The table:enabled attribute specifies whether the <table:data-pilot-display-info>
element is evaluated or not.
5182
5183
5184
5185
5186

<define name="table-data-pilot-display-info-attlist" combine="interleave"><attribute name="table:enabled"><ref name="boolean"/></attribute></define>

Data Field
The table:data-field attribute specifies the data field whose values are taken into account.
5187
5188
5189
5190
5191

<define name="table-data-pilot-display-info-attlist" combine="interleave"><attribute name="table:data-field"><ref name="string"/></attribute></define>

Member CountThe table:member-count attribute specifies how many values from the top or from the bottomof data field's column are shown.
5192
5193
5194
5195
5196

<define name="table-data-pilot-display-info-attlist" combine="interleave"><attribute name="table:member-count"><ref name="nonNegativeInteger"/></attribute></define>

Display Member Mode
The table:display-member-mode attribute specifies whether the values specified bytable:member-count should be taken from the top or from the bottom of a data field's column.
5197
5198
5199
5200
5201
5202
5203
5204

<define name="table-data-pilot-display-info-attlist" combine="interleave"><attribute name="table:display-member-mode"><choice><value>from-top</value><value>from-bottom</value></choice></attribute></define>

8.8.11 Data Pilot Sort Info
The <table:data-pilot-sort-info> element specifies how the members of a category field
are sorted.
5205
5206
5207

<define name="table-data-pilot-sort-info"><element name="table:data-pilot-sort-info"><ref name="table-data-pilot-sort-info-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 250 of 738

5208
5209
5210

<empty/></element></define>

Sort Mode
The table:sort-mode attribute describes how to sort the members of a single data pilot field. If
the mode is data, then the members of the current category field a sorted according to theirvalues in the data field specified by the table:data-field attribute. If the mode is manual, theuser can sort the members in the field manually. If the mode is name, the members in the field aresorted by their name.
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229

<define name="table-data-pilot-sort-info-attlist" combine="interleave"><choice><group><attribute name="table:sort-mode"><value>data</value></attribute><attribute name="table:data-field"><ref name="string"/></attribute></group><attribute name="table:sort-mode"><choice><value>none</value><value>manual</value><value>name</value></choice></attribute></choice></define>

Sort Order
The table:sort-order attribute specifies whether to sort the members ascending ordescending.
5230
5231
5232
5233
5234
5235
5236
5237

<define name="table-data-pilot-sort-info-attlist" combine="interleave"><attribute name="table:order"><choice><value>ascending</value><value>descending</value></choice></attribute></define>

8.8.12 Data Pilot Layout Info
The <table:data-pilot-layout-info> element describes how to layout the field.
5238
5239
5240
5241
5242
5243

<define name="table-data-pilot-layout-info"><element name="table:data-pilot-layout-info"><ref name="table-data-pilot-layout-info-attlist"/><empty/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 251 of 738

Layout Mode
The table:layout-mode attribute describes how to layout the field. It may have the following
values:

5244
5245
5246
5247
5248
5249
5250
5251
5252

•

tabular-layout: Tabular layout mode is the layout, where each member's name is on thesame row as the first member from the following field. Subtotals are always shown below amember's data in this mode.

•

outline-subtotals-top: In outline layout mode, the members from the following fieldstart in the row below a member's name, like in traditional database reports. Subtotals areshown at the top (in the same row as the member's name). When the subtotals take up morethan one row (manually selected, or because there are several data fields), they are always
shown below the member's data, regardless of the setting.

•outline-subtotals-bottom: Like outline-subtotals-top, except that subtotals areshown at the bottom (below the member's data, as in tabular layout mode).

<define name="table-data-pilot-layout-info-attlist" combine="interleave"><attribute name="table:layout-mode"><choice><value>tabular-layout</value><value>outline-subtotals-top</value><value>outline-subtotals-bottom</value></choice></attribute></define>

Add empty lines
If the attribute table:add-empty-lines has the value true, an empty row is inserted in thedata pilot table after the data (including the subtotals) for each member of the field.
5253
5254
5255
5256
5257

<define name="table-data-pilot-layout-info-attlist" combine="interleave"><attribute name="table:add-empty-lines"><ref name="boolean"/></attribute></define>

8.8.13 Data Pilot Field Reference
The <table:data-pilot-field-reference> element describes data which can be used tomodify the displayed values of data fields.
5258
5259
5260
5261
5262

<define name="table-data-pilot-field-reference"><element name="table:data-pilot-field-reference"><ref name="table-data-pilot-field-reference-attlist"/></element></define>

Reference Field
The table:field-name attribute references a category field whose members influence thedisplayed values of the data field the <table:data-pilot-field-reference> is part of.
5263
5264
5265
5266

<define name="table-data-pilot-field-reference-attlist" combine="interleave"><attribute name="table:field-name"><ref name="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 252 of 738

5267</define>

Reference Member TypeThe table:member-type attribute specifies the member of the referenced category field,
whose value within the current data field has to be taken into account. If its value is next
(previous) then the value of the data field for the next (previous) visible member of thereferenced category field will be taken into account. If its value is named, then thetable:member-name specifies the member whose value within the data field is taken into
account.
For previous and next, empty members are skipped.
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285

<define name="table-data-pilot-field-reference-attlist" combine="interleave"><choice><group><attribute name="table:member-type"><value>named</value></attribute><attribute name="table:member-name"><ref name="string"/></attribute></group><attribute name="table:member-type"><choice><value>previous</value><value>next</value></choice></attribute></choice></define>

Reference TypeThe table:type attribute specifies the how the referenced category field influences thedisplayed values of the data field. It may have one of the following values:•

none: This value means that the results in the data fields are displayed unmodified.

•member-difference: From each result, the value calculated for the category field member
specified by the table:member-type and table:member-name attributes is subtracted.

•

member-percentage: Each result is divided by the value calculated for the category field
member specified by the table:member-type and table:member-name attributes.
Division by zero results in an error. Empty results are shown as “0”. If the table:membertype attribute has the value previous, “1” is displayed as first value. If thetable:member-type attribute has the value next, “1” is displayed as last value.

•

member-percentage-difference: From each result, the value calculated for the category
field member specified by the table:member-type and table:member-name attributes is
subtracted, and the result is divided by this value again. Division by zero results in an error.
Otherwise, the rules for member-difference apply.

•

running-total: Each result is added to the sum of the results for preceding members in
the referenced category field, in the reference field's sort order, and the total sum is shown.

•row-percentage: Each result is divided by the total result for its row in the data pilot table. If
there are several data fields, the total for the result's data field is used. If there are subtotals

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 253 of 738

with manually selected summary functions, the total is calculated with the data field'ssummary function. Division by zero results in an error.

5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300

•

column-percentage: Same as row-percentage, but the total for the result's column is
used.

•

total-percentage: Same as row-percentage, but the grand total for the result's data
field is used.

•

index: The row and column totals and the grand total are calculated as described above, andthen are used to calculate the following expression: (original result * grand total ) / ( row total *column total ).Division by zero results in an error.

<define name="table-data-pilot-field-reference-attlist" combine="interleave"><attribute name="table:type"><choice><value>none</value><value>member-difference</value><value>member-percentage</value><value>member-percentage-difference</value><value>running-total</value><value>row-percentage</value><value>column-percentage</value><value>total-percentage</value><value>index</value></choice></attribute></define>

8.8.14 Data Pilot Groups
The <table:data-pilot-groups> element specifies that a data pilot field is a group field. A
group field allows grouping of other fields. For example, if a data pilot table contains a column
field with the name “city” which has the members “Berlin”, “Munich”, “Frankfurt”, “Hamburg”,“London”, “Manchester”, “Hastings” and “Liverpool”, then one may want to group the cities by theircountries. To do so, a group field with name “city2” could be added to the data pilot table, that
contains two groups called “England” and “Germany”. Each group here contains a list of thenames of its members. In this example, the group “England” would contain “London”,“Manchester”, “Hastings” and “Liverpool”. The group “Germany” would contain “Berlin”, “Munich”,“Frankfurt” and “Hamburg”.
Grouping may also take place for numeric or date values.
5301
5302
5303
5304
5305
5306
5307
5308

<define name="table-data-pilot-groups"><element name="table:data-pilot-groups"><ref name="table-data-pilot-groups-attlist"/><oneOrMore><ref name="table-data-pilot-group"/></oneOrMore></element></define>

Source Field Name
The table:source-field-name attribute references the field containing the data that isgrouped, if this data differs from the data that is referenced by the field itself.
5309
5310
5311

<define name="table-data-pilot-groups-attlist" combine="interleave"><attribute name="table:source-field-name"><ref name="string"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 254 of 738

5312
5313

</attribute></define>

Start
If numeric or date values are grouped, the table:date-start and table:start attributes
specify the start value for the grouping. All values that are lower than the start value are containedin a single group, while values that are equal to or higher than the start value are grouped as
specified by the table:grouped-by and table:step attributes.
If the attribute's value is auto, the lowest value of the field is taken as start value.
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329

<define name="table-data-pilot-groups-attlist" combine="interleave"><choice><attribute name="table:date-start"><choice><ref name="dateOrDateTime"/><value>auto</value></choice></attribute><attribute name="table:start"><choice><ref name="double"/><value>auto</value></choice></attribute></choice></define>

End
If numeric or date values are grouped, the table:date-end and table:end attributes specify
the end value for the grouping. All values that are higher than the end value are contained in asingle group, while values that are equal to or lower than the end value are grouped as specified
by the table:grouped-by and table:step attributes.
If the attribute's value is auto, the highest value of the field is taken as end value.
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345

<define name="table-data-pilot-groups-attlist" combine="interleave"><choice><attribute name="table:date-end"><choice><ref name="dateOrDateTime"/><value>auto</value></choice></attribute><attribute name="table:end"><choice><ref name="double"/><value>auto</value></choice></attribute></choice></define>

Step
The table:step attribute specifies the grouping of numeric values, by specifying the distance
between the groups. For example, if the table:start attribute for the grouping has the value 5, andOpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 255 of 738

the table:step attribute has the value 2, all values that are equal to or higher than 5, but also lower
than 7 are in one group. All values that are equal to or higher than 7, but also lower than 9 are in
next group, and so on, until the end value is reached.
5346
5347
5348
5349
5350

<define name="table-data-pilot-groups-attlist" combine="interleave"><attribute name="table:step"><ref name="double"/></attribute></define>

Grouped By
The table:grouped-by attribute specifies the grouping of the date values. Date values can begrouped by seconds, minutes, hours, days, months, quarters or years. It date values are for
instance grouped by minutes, all dates or times that are within the same minute are within one
group. That, is if the dates 2004-08-27T12:34:46, 2004-08-27T12:34:56 and 2004-0827T12:35:46 are given, the first two would be within one group, while the last date would be agroup of its own.
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363

<define name="table-data-pilot-groups-attlist" combine="interleave"><attribute name="table:grouped-by"><choice><value>seconds</value><value>minutes</value><value>hours</value><value>days</value><value>months</value><value>quarters</value><value>years</value></choice></attribute></define>

8.8.15 Data Pilot GroupIf grouping takes place by specifying the member names, then the <table:data-pilotgroup> element specifies the member names of a single group.
5364
5365
5366
5367
5368
5369
5370
5371

<define name="table-data-pilot-group"><element name="table:data-pilot-group"><ref name="table-data-pilot-group-attlist"/><oneOrMore><ref name="table-data-pilot-group-member"/></oneOrMore></element></define>

Name
The table:name attribute specifies the name of the group.
5372
5373
5374
5375
5376

<define name="table-data-pilot-group-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 256 of 738

8.8.16 Data Pilot Group Member
The <table:data-pilot-group-member> element specifies the name of a single groupmember.
5377
5378
5379
5380
5381

<define name="table-data-pilot-group-member"><element name="table:data-pilot-group-member"><ref name="table-data-pilot-group-member-attlist"/></element></define>

Name
The table:name attribute specifies the name of the member.
5382
5383
5384
5385
5386

<define name="table-data-pilot-group-member-attlist" combine="interleave"><attribute name="table:name"><ref name="string"/></attribute></define>

8.9 Consolidation
A consolidation combines data from several independent table ranges. A new table range iscalculated by applying a mathematical function to all cells in the source table ranges that have thesame relative address within these ranges. A consolidation is defined by the<table:consolidation> element.
5387
5388
5389
5390
5391
5392

<define name="table-consolidation"><element name="table:consolidation"><ref name="table-consolidation-attlist"/><empty/></element></define>

The attributes that may be associated with this element are:•Function•

Source cell range addresses•

Target cell address•

Use label•

Link to source data

Function
The table:function attribute contains the function which is used to consolidate the data.
Possible functions are auto, average, count, countnums, max, min, product, stdev,
stdevp, sum, var and varp.
5393
5394
5395
5396
5397
5398
5399

<define name="table-consolidation-attlist" combine="interleave"><attribute name="table:function"><choice><value>auto</value><value>average</value><value>count</value><value>countnums</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 257 of 738

5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411

<value>max</value><value>min</value><value>product</value><value>stdev</value><value>stdevp</value><value>sum</value><value>var</value><value>varp</value><ref name="string"/></choice></attribute></define>

Source Cell Range Addresses
The table:source-cell-range-addresses attribute contains a list of cell range addresses
that specify the source cell ranges.
5412
5413
5414
5415
5416

<define name="table-consolidation-attlist" combine="interleave"><attribute name="table:source-cell-range-addresses"><ref name="cellRangeAddressList"/></attribute></define>

Target Cell Address
The table:target-cell-address attribute contains the target cell address.
5417
5418
5419
5420
5421

<define name="table-consolidation-attlist" combine="interleave"><attribute name="table:target-cell-address"><ref name="cellAddress"/></attribute></define>

Use Label
The table:use-label attribute specifies whether or not labels should be used by the
consolidation for rows, columns or both. Possible values are none, column, row and both. Iflabels are used for rows or columns, the mathematical functions is applied to cells with equallylabeled rows or columns rather than to cells with the same relative cell address.
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433

<define name="table-consolidation-attlist" combine="interleave"><optional><attribute name="table:use-labels" a:defaultValue="none"><choice><value>none</value><value>row</value><value>column</value><value>both</value></choice></attribute></optional></define>

Link to Source Data
The table:link-to-source-data attribute specifies whether the data in the consolidationtable range should be linked to the source data, so that it is automatically updated if any changes
are made to the source data.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 258 of 738

5434
5435
5436
5437
5438
5439
5440

<define name="table-consolidation-attlist" combine="interleave"><optional><attribute name="table:link-to-source-data" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

8.10 DDE Links
The <table:dde-links> container element stores all DDE links within a spreadsheet
document. Every link contains the DDE Source and the data of the last connection. See section
12.6.3 for details.
See section 12.6 for the use of DDE connections.
5441
5442
5443
5444
5445
5446
5447

<define name="table-dde-links"><element name="table:dde-links"><oneOrMore><ref name="table-dde-link"/></oneOrMore></element></define>

8.11 Change Tracking in Spreadsheets
Within spreadsheet documents, changes to tables can be tracked. This section describes how
this change tracking information is represented.
Change tracking of tables is not supported for text documents.

8.11.1 Tracked Changes
All changes that have been applied to a spreadsheet document are stored in a list. The list
contains an element for each change made to the document. To track the changes to a
spreadsheet document, the <table:tracked-changes> element must be present.
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460

<define name="table-tracked-changes"><element name="table:tracked-changes"><ref name="table-tracked-changes-attlist"/><zeroOrMore><choice><ref name="table-cell-content-change"/><ref name="table-insertion"/><ref name="table-deletion"/><ref name="table-movement"/></choice></zeroOrMore></element></define>

Track Changes
The table:track-changes attribute specifies whether or not the change tracking is enabled.
5461
5462
5463

<define name="table-tracked-changes-attlist" combine="interleave"><optional><attribute name="table:track-changes" a:defaultValue="false">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 259 of 738

5464
5465
5466
5467

<ref name="boolean"/></attribute></optional></define>

8.11.2 Insertion
The <table:insertion> element contains the information that is required to identify any
insertion of content. This content can be one or more rows, one or more columns, or a table.
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480

<define name="table-insertion"><element name="table:insertion"><ref name="table-insertion-attlist"/><ref name="common-table-change-attlist"/><ref name="office-change-info"/><optional><ref name="table-dependencies"/></optional><optional><ref name="table-deletions"/></optional></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

Acceptance State (see section 8.11.18)•

Rejecting Change ID (see section 8.11.18)

•

Type

•

Position

•

Count

•

Table

Type
The table:type attribute specifies the type of the insertion. It can be row, column or table.
5481
5482
5483
5484
5485
5486
5487
5488
5489

<define name="table-insertion-attlist" combine="interleave"><attribute name="table:type"><choice><value>row</value><value>column</value><value>table</value></choice></attribute></define>

Position
The table:position attribute specifies the position where the insertion was made in the table.
Depending on the insertion type, It is either the number of a row, a column or a table.
5490
5491

<define name="table-insertion-attlist" combine="interleave"><attribute name="table:position">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 260 of 738

5492
5493
5494

<ref name="integer"/></attribute></define>

Count
The table:count attribute specifies the count of inserted rows, columns or tables.
5495
5496
5497
5498
5499
5500
5501

<define name="table-insertion-attlist" combine="interleave"><optional><attribute name="table:count" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Table
The table:table attribute specifies the number of the table where the insertion took place. This
attribute only exists for column and row insertions.
5502
5503
5504
5505
5506
5507
5508

<define name="table-insertion-attlist" combine="interleave"><optional><attribute name="table:table"><ref name="integer"/></attribute></optional></define>

Example: Insertion of text in a cell<table:tracked-changes><table:insertion table:id="c001" table:acceptance-state="pending"table:type="column" table:position="5"><office:change-info><dc:creator>Sascha Ballach</dc:creator><dc:date>1999-55-18T12:56:04</dc:date></office:change-info></table:insertion></table:tracked-changes>

8.11.3 Dependencies
The <table:dependencies> element contains the information on which other tracked changes
a tracked change depends. Every element of the tracked-changes can contain a<table:dependencies> element.
5509
5510
5511
5512
5513
5514
5515

<define name="table-dependencies"><element name="table:dependencies"><oneOrMore><ref name="table-dependency"/></oneOrMore></element></define>

8.11.4 Dependence
The <table:dependency> element contains the information about one change action on which
the parent element depends. The change action on which the current depends is referenced by an
id.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 261 of 738

5516
5517
5518
5519
5520
5521
5522
5523

<define name="table-dependency"><element name="table:dependency"><attribute name="table:id"><ref name="string"/></attribute><empty/></element></define>

8.11.5 Deletions
The <table:deletions> element contains all deletions which are performed while tracking asingle change to a table.
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533

<define name="table-deletions"><element name="table:deletions"><oneOrMore><choice><ref name="table-cell-content-deletion"/><ref name="table-change-deletion"/></choice></oneOrMore></element></define>

8.11.6 Cell Content Deletion
The <table:cell-content-deletion> element specifies that a cell content has been
deleted. It contains the address of the effected cell and its former content. If a text:id attributeis present, it specifies the id of a previously tracked change for the cell that gets deleted by thecurrent change.
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548

<define name="table-cell-content-deletion"><element name="table:cell-content-deletion"><optional><attribute name="table:id"><ref name="string"/></attribute></optional><optional><ref name="table-cell-address"/></optional><optional><ref name="table-change-track-table-cell"/></optional></element></define>

8.11.7 Change Deletion
The <table:change-deletion> element specified the id of a previously tracked change thatgets deleted by the current change.
5549
5550
5551
5552
5553
5554

<define name="table-change-deletion"><element name="table:change-deletion"><optional><attribute name="table:id"><ref name="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 262 of 738

5555
5556
5557
5558

</optional><empty/></element></define>

8.11.8 Deletion
A <table:deletion> element contains content that was deleted while change tracking was
enabled. The content of a cell that was deleted is either contained in the<table:dependencies>, or in the <table:deletions> element.
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574

<define name="table-deletion"><element name="table:deletion"><ref name="table-deletion-attlist"/><ref name="common-table-change-attlist"/><ref name="office-change-info"/><optional><ref name="table-dependencies"/></optional><optional><ref name="table-deletions"/></optional><optional><ref name="table-cut-offs"/></optional></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

Acceptance State (see section 8.11.18)•

Rejecting Change ID (see section 8.11.18)

•

Type

•

Position

•

Table

•

Multi Deletion Spanned

Type
The table:type attribute specifies the type of the deletion. It can be row, column or table.
5575
5576
5577
5578
5579
5580
5581
5582
5583

<define name="table-deletion-attlist" combine="interleave"><attribute name="table:type"><choice><value>row</value><value>column</value><value>table</value></choice></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 263 of 738

Position
The table:position attribute specifies the position where the deletion was made in the table.
Depending on the deletion type, It is either the number of a row, a column or a table.
5584
5585
5586
5587
5588

<define name="table-deletion-attlist" combine="interleave"><attribute name="table:position"><ref name="integer"/></attribute></define>

Table
The table:table attribute specifies the number of the table where the deletion took place. This
attribute only exists for column and row deletions.
5589
5590
5591
5592
5593
5594
5595

<define name="table-deletion-attlist" combine="interleave"><optional><attribute name="table:table"><ref name="integer"/></attribute></optional></define>

Multi Deletion Spanned
If multiple columns or rows were deleted simultaneously, each deleted row or column gets its own<table:deletion> element. The element of the first deleted row or column in this case has tocarry a table:multi-deletion-spanned attribute that specifies the total number of deleted
rows or columns.
5596
5597
5598
5599
5600
5601
5602

<define name="table-deletion-attlist" combine="interleave"><optional><attribute name="table:multi-deletion-spanned"><ref name="integer"/></attribute></optional></define>

8.11.9 Cut Offs
A <table:cut-offs> element contains information about previously tracked insertions or
movements where parts of the new content created by this operation now gets deleted. An
example for this might be a cell range that has previously been moved and that now overlaps witha row that gets deleted.
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615

<define name="table-cut-offs"><element name="table:cut-offs"><choice><oneOrMore><ref name="table-movement-cut-off"/></oneOrMore><group><ref name="table-insertion-cut-off"/><zeroOrMore><ref name="table-movement-cut-off"/></zeroOrMore></group></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 264 of 738

5616
5617

</element></define>

8.11.10 Insertion Cut Off
The <table:insertion-cut-off> element contains the information where a insertion wasdeleted and which.
5618
5619
5620
5621
5622
5623

<define name="table-insertion-cut-off"><element name="table:insertion-cut-off"><ref name="table-insertion-cut-off-attlist"/><empty/></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

position

Id
The table:id attribute contains the id of the insertion where parts of now get deleted.
5624
5625
5626
5627
5628

<define name="table-insertion-cut-off-attlist" combine="interleave"><attribute name="table:id"><ref name="string"/></attribute></define>

Position
The table:position attribute specifies the number of the row or column within the insertion
that gets deleted.
5629
5630
5631
5632
5633

<define name="table-insertion-cut-off-attlist" combine="interleave"><attribute name="table:position"><ref name="integer"/></attribute></define>

8.11.11 Movement Cut Off
The <table:movement-cut-off> element contains the information where a movement wasdeleted and which.
5634
5635
5636
5637
5638
5639

<define name="table-movement-cut-off"><element name="table:movement-cut-off"><ref name="table-movement-cut-off-attlist"/><empty/></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

start position, end position, position

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 265 of 738

Start Position, End Position, Position
The table:start-position, table:end-position and table:position attributes
specify the position within the movement that gets deleted. If a single row or column gets deleted,
the table:position attribute contains its number. If multiple rows or columns get deleted, thetable:start-position and table:end-position attributes contain the number of the first(inclusive) and last (exclusive) deleted rows or columns.
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654

<define name="table-movement-cut-off-attlist" combine="interleave"><choice><attribute name="table:position"><ref name="integer"/></attribute><group><attribute name="table:start-position"><ref name="integer"/></attribute><attribute name="table:end-position"><ref name="integer"/></attribute></group></choice></define>

Example: Deletion of a column which do not contain content<table:tracked-changes><table:deletion table:id="c002" table:acceptance-state="pending"table:type="column" table:position="9"><office:change-info><dc:creator>Sascha Ballach</dc:creator><dc:date>1999-05-18T12:56:04</dc:creator></office:change-info></table:deletion></table:tracked-changes>

8.11.12 Movement
A <table:movement> element contains the information that is required to identify any
movement of content. This content can be a cell content or a cell range content.
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668

<define name="table-movement"><element name="table:movement"><ref name="common-table-change-attlist"/><ref name="table-source-range-address"/><ref name="table-target-range-address"/><ref name="office-change-info"/><optional><ref name="table-dependencies"/></optional><optional><ref name="table-deletions"/></optional></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

Acceptance State (see section 8.11.18)

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 266 of 738

•

Rejecting Change ID (see section 8.11.18)

8.11.13 Target Range Address, Source Range Address
The <table:source-range-address> and <table:target-range-address> specify thesource and target cell address or cell range address of a movement.
5669
5670
5671
5672
5673
5674

<define name="table-source-range-address"><element name="table:source-range-address"><ref name="common-table-range-attlist"/><empty/></element></define>

5675
5676
5677
5678
5679
5680
5681

<define name="table-target-range-address"><element name="table:target-range-address"><ref name="common-table-range-attlist"/><empty/></element></define>

5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693

<define name="common-table-range-attlist" combine="interleave"><choice><group><ref name="common-table-cell-address-attlist"/></group><group><ref name="common-table-cell-range-address-attlist"/></group></choice></define>

The attributes that may be associated with these elements are either•

Column, Row, and Table, or•Start column, End column, Start row, End row, Start table, and End table

Column, Row, and Table
If the range address is a cell address then the three attributes table:column, table:row andtable:table specify the column, row and table number of the cell.
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704

<define name="common-table-cell-address-attlist" combine="interleave"><attribute name="table:column"><ref name="integer"/></attribute><attribute name="table:row"><ref name="integer"/></attribute><attribute name="table:table"><ref name="integer"/></attribute></define>

Start Column, End Column, Start Row, End Row, Start Table, and End Table
If the range address is a cell range address instead of a cell address, the attributes
table:start-column, table:end-column, table:start-row, table:end-row,

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 267 of 738

table:start-table and table:end-table specify the start and end columns, rows andtables of the range. Start and end numbers both are inclusive.
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724

<define name="common-table-cell-range-address-attlist" combine="interleave"><attribute name="table:start-column"><ref name="integer"/></attribute><attribute name="table:start-row"><ref name="integer"/></attribute><attribute name="table:start-table"><ref name="integer"/></attribute><attribute name="table:end-column"><ref name="integer"/></attribute><attribute name="table:end-row"><ref name="integer"/></attribute><attribute name="table:end-table"><ref name="integer"/></attribute></define>

Example: Moving a cell<table:tracked-changes><table:movement table:id="ct1"><table:source-range-address table:column="0" table:row="0"
table:table="0"/><table:target-range-address table:column="1" table:row="1"
table:table="0"/><office:change-info><dc:creator>Michael Brauer</dc:creator><dc:date>2003-12-29T11:46:13,21"</dc:date></office:change-info></table:movement></table:tracked-changes>

8.11.14 Change Track Cell
The <table:change-track-table-cell> element contains all information of a table cellwhich are needed inside the change tracking elements. The element is very similar to a<table:table-cell> element, but contains some additional information.
5725
5726
5727
5728
5729
5730
5731
5732

<define name="table-change-track-table-cell" combine="interleave"><element name="table:change-track-table-cell"><ref name="table-change-track-table-cell-attlist"/><zeroOrMore><ref name="text-p"/></zeroOrMore></element></define>

Cell Address
If the cell is a formula cell, the table:cell-address attribute is required and specifies theoriginal address of the cell used in calculations.
5733
5734

<define name="table-change-track-table-cell-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 268 of 738

5735
5736
5737
5738
5739

<attribute name="table:cell-address"><ref name="cellAddress"/></attribute></optional></define>

Matrix Covered
If the cell is a matrix cell and not the base of the matrix the, table:matrix-covered attribute isnecessary and its value has to be true to indicate that the cell is contained in a matrix.
5740
5741
5742
5743
5744
5745
5746

<define name="table-change-track-table-cell-attlist" combine="interleave"><optional><attribute name="table:matrix-covered" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Formulas and Values
The change track table cells additionally supports the attributes table:formula,table:number-matrix-rows-spanned, table:number-matrix-columns-spanned,
office:value-type, office:value, office:date-value, office:time-value andoffice:string-value as described in section 8.1.3.
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766

<define name="table-change-track-table-cell-attlist" combine="interleave"><optional><attribute name="table:formula"><ref name="string"/></attribute></optional><optional><attribute name="table:number-matrix-columns-spanned"><ref name="positiveInteger"/></attribute></optional><optional><attribute name="table:number-matrix-rows-spanned"><ref name="positiveInteger"/></attribute></optional><optional><ref name="common-value-and-type-attlist"/></optional></define>

8.11.15 Cell Content Change
A <table:cell-content-change> element contains the information that is required to identify
changes of the cell content.
5767
5768
5769
5770
5771
5772
5773

<define name="table-cell-content-change"><element name="table:cell-content-change"><ref name="common-table-change-attlist"/><ref name="table-cell-address"/><ref name="office-change-info"/><optional><ref name="table-dependencies"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 269 of 738

5774
5775
5776
5777
5778
5779
5780

</optional><optional><ref name="table-deletions"/></optional><ref name="table-previous"/></element></define>

The attributes that may be associated with this element are:•ID (see section 8.11.18)•

Acceptance State (see section 8.11.18)•

Rejecting Change ID (see section 8.11.18)

8.11.16 Cell Address
The <table:cell-address> element contains the address of cell that is changed. Unlike othercell addresses, the address consists of the row, column and table number of the cell. This allows
specifying addresses that are outside the valid cell address range, for instance have a negative
column number.
5781
5782
5783
5784
5785
5786

<define name="table-cell-address"><element name="table:cell-address"><ref name="common-table-cell-address-attlist"/><empty/></element></define>

The attributes that may be associated with this element are:•Column, Row, and Table number (see section 8.11.13)

8.11.17 Previous
The table:previous element contains the previous cell content which is overwritten by thecurrent change. If a text:id attribute is present, it specifies the id of a previously tracked change
for the cell that gets changed again by the current change.
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796

<define name="table-previous"><element name="table:previous"><optional><attribute name="table:id"><ref name="string"/></attribute></optional><ref name="table-change-track-table-cell"/></element></define>

8.11.18 Common Change Tracking Attributes
Id
The table:id attribute specifies the id of the tracked change.
5797
5798

<define name="common-table-change-attlist" combine="interleave"><attribute name="table:id">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 270 of 738

5799
5800
5801

<ref name="string"/></attribute></define>

Acceptance state
The table:acceptance-state attribute specifies whether the tracked change has been
accepted or rejected already, or whether an acceptance or rejection is still pending.
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812

<define name="common-table-change-attlist" combine="interleave"><optional><attribute name="table:acceptance-state" a:defaultValue="pending"><choice><value>accepted</value><value>rejected</value><value>pending</value></choice></attribute></optional></define>

Rejecting Change Id
If the table:rejecting-change-id attribute is present, then the current change has been
made to the table to implement the rejection of another previously tracked change. The attribute's
value is the id of this previously tracked change that has been rejected.
5813
5814
5815
5816
5817
5818
5819

<define name="common-table-change-attlist" combine="interleave"><optional><attribute name="table:rejecting-change-id"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 271 of 738

9 Graphic Content
This chapter provides the specification for the core elements of graphic applications like drawing
or presentation applications, and for graphical objects contained in non-graphical applications, likeword processor or spreadsheet applications.

9.1 Enhanced Page Features for Graphical Applications
9.1.1 Handout MasterFor applications that support printing handout pages, this element is a template for automaticallygenerating the handout pages. The element <style:handout-master> can contain any typesof shapes. The most useful shape is the <draw:page-thumbnail>, which is replaced by actual
pages from the document. The <style:handout-master> element is contained in the<office:master-styles> element. The <office:master-styles> must not contain morethan one <style:handout-master> element.
5820
5821
5822
5823
5824
5825
5826
5827
5828

<define name="style-handout-master"><element name="style:handout-master"><ref name="common-presentation-header-footer-attlist"/><ref name="style-handout-master-attlist"/><zeroOrMore><ref name="shape"/></zeroOrMore></element></define>

The attributes that may be associated with the <style:handout-master> element are:•Presentation Page Layout (placeholder objects)•

Page Layout (page size, margins etc.)•

Page Style•

Header Declaration•

Footer Declaration•

Date and Time Declaration

Presentation Page Layout
The attribute presentation:presentation-page-layout-name links to a<style:presentation-page-layout> element. See section 14.15 for information on thepresentation page layout element. This attribute is optional.
5829
5830
5831
5832
5833
5834
5835

<define name="style-handout-master-attlist" combine="interleave"><optional><attribute name="presentation:presentation-page-layout-name"><ref name="styleNameRef"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 272 of 738

Page Layout
The style:page-layout-name attribute specifies a page layout which contains the sizes,
border and orientation of the handout master page. See section 14.3 for details on page layouts.
5836
5837
5838
5839
5840

<define name="style-handout-master-attlist" combine="interleave"><attribute name="style:page-layout-name"><ref name="styleNameRef"/></attribute></define>

Page Style
The attribute draw:style-name assigns an additional formatting attributes to a handout masterpage by assigning a drawing page style. This attribute is optional. The fixed family for page styles
is drawing-page.
5841
5842
5843
5844
5845
5846
5847

<define name="style-handout-master-attlist" combine="interleave"><optional><attribute name="draw:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Header Declaration
The presentation:use-header-name attribute specifies the name of the header fielddeclaration (see section 9.11.2) that is used for all header fields (see section 9.10.1) that are
displayed on the handout master page. See also section 9.1.4.

Footer Declaration
The presentation:use-footer-name attribute specifies the name of the footer fielddeclaration (see section 9.11.3) that is used for all footer fields (see section 9.10.2) that are
displayed on the handout master page. See also section 9.1.4.

Date and Time Declaration
The presentation:use-date-time-name attribute specifies the name of the date-time fielddeclaration (see section 9.11.4) that is used for all date-time fields (see section 9.10.3) that are
displayed on the handout master page. See also section 9.1.4.

9.1.2 Layer Sets
The element <draw:layer-set> may be contained in the master styles of graphicalapplications. It defines a set of layers. Layers group drawing objects. Drawing objects may be
assigned to these layers with the help of their draw:layer-name attribute.
5848
5849
5850
5851
5852
5853
5854

<define name="draw-layer-set"><element name="draw:layer-set"><zeroOrMore><ref name="draw-layer"/></zeroOrMore></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 273 of 738

9.1.3 Layer
The <draw:layer> element defines a single layer.
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865

<define name="draw-layer"><element name="draw:layer"><ref name="draw-layer-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional></element></define>

The <draw:layer element> may contain the following elements:•

Title (short accessible name). Use the <svg:title> child element as described in section
9.2.20.

•Long description (in support of accessibility). Use the <svg:desc> child element as
described in section 9.2.20.

Name
Each element <draw:layer> is defined and referenced by its name that is contained in thedraw:name attribute . Each drawing object inside a drawing or presentation document can be
assigned to a layer. Layers virtually group the object. Each object that is assigned to a layer
inherits the settings of the layer.
5866
5867
5868
5869
5870

<define name="draw-layer-attlist" combine="interleave"><attribute name="draw:name"><ref name="string"/></attribute></define>

Protection
The draw:protected attribute specifies whether the drawing objects contain in the layer areprotected from being modified.
5871
5872
5873
5874
5875
5876
5877

<define name="draw-layer-attlist" combine="interleave"><optional><attribute name="draw:protected" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Display
The draw:display attribute specifies whether the drawing objects contain in the layer are visibleon the screen and/or printed.
5878
5879
5880
5881
5882

<define name="draw-layer-attlist" combine="interleave"><optional><attribute name="draw:display" a:defaultValue="always"><choice><value>always</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 274 of 738

5883
5884
5885
5886
5887
5888
5889

<value>screen</value><value>printer</value><value>none</value></choice></attribute></optional></define>

9.1.4 Drawing Pages
The element <draw:page> is a container for content in a drawing or presentation document.
Drawing pages are used for the following:•Forms (see section 11.1)•

Drawings (see section 9.2)•

Frames (see section 9.3)•

Presentation Animations (see section 9.7)•

Presentation Notes (see section 9.1.5)

A master page must be assigned to each drawing page.
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910

<define name="draw-page"><element name="draw:page"><ref name="common-presentation-header-footer-attlist"/><ref name="draw-page-attlist"/><optional><ref name="office-forms"/></optional><zeroOrMore><ref name="shape"/></zeroOrMore><optional><choice><ref name="presentation-animations"/><ref name="animation-element"/></choice></optional><optional><ref name="presentation-notes"/></optional></element></define>

The attributes that may be associated with the <draw:page> element are:•Page name•

Page style•

Master page•

Presentation page layout•

Header declaration•

Footer declaration•

Date and time declaration

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 275 of 738

•ID

The elements that my be included in the <draw:page> element are:
•

Forms

•

Shapes•Animations•

Presentation notes

Page Name
The draw:name attribute specifies the name of a drawing page. This attribute is optional; if it isused, the name must be unique. If it is not used, the application may generate a unique name.
5911
5912
5913
5914
5915
5916
5917

<define name="draw-page-attlist" combine="interleave"><optional><attribute name="draw:name"><ref name="string"/></attribute></optional></define>

Page Style
The attribute draw:style-name assigns an additional formatting attributes to a drawing pageby assigning a drawing page style. This attribute is optional. The fixed family for page styles isdrawing-page.
For pages inside a presentation document, attributes from Presentation Page Attributes can also
be used.
5918
5919
5920
5921
5922
5923
5924

<define name="draw-page-attlist" combine="interleave"><optional><attribute name="draw:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Master Page
Each drawing page must have one master page assigned to it. The master page:•Defines properties such as the size and borders of the drawing page•

Serves as a container for shapes that are used as a common backgroundThe draw:master-page-name attribute specifies the name of the master page assigned to thedrawing page. This attribute is required.
5925
5926
5927
5928
5929

<define name="draw-page-attlist" combine="interleave"><attribute name="draw:master-page-name"><ref name="styleNameRef"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 276 of 738

Presentation Page Layout
If the drawing page was created using a presentation page layout, the attributepresentation:presentation-page-layout-name links to the corresponding<style:presentation-page-layout> element. See section 14.15 for information on thepresentation page layout element. This attribute is optional.
5930
5931
5932
5933
5934
5935
5936

<define name="draw-page-attlist" combine="interleave"><optional><attribute name="presentation:presentation-page-layout-name"><ref name="styleNameRef"/></attribute></optional></define>

Header Declaration
The presentation:use-header-name attribute specifies the name of the header fielddeclaration (see section 9.11.2) that is used for all header fields (see section 9.10.1) that are
displayed on the page.
5937
5938
5939
5940
5941
5942
5943

<define name="common-presentation-header-footer-attlist" combine="interleave"><optional><attribute name="presentation:use-header-name"><ref name="string"/></attribute></optional></define>

Footer Declaration
The presentation:use-footer-name attribute specifies the name of the footer fielddeclaration (see section 9.11.3) that is used for all footer fields (see section 9.10.2) that are
displayed on the page.
5944
5945
5946
5947
5948
5949
5950

<define name="common-presentation-header-footer-attlist" combine="interleave"><optional><attribute name="presentation:use-footer-name"><ref name="string"/></attribute></optional></define>

Date and Time Declaration
The presentation:use-date-time-name attribute specifies the name of the date-time fielddeclaration (see section 9.11.4) that is used for all date-time fields (see section 9.10.3) that are
displayed on the page.
5951
5952
5953
5954
5955
5956
5957

<define name="common-presentation-header-footer-attlist" combine="interleave"><optional><attribute name="presentation:use-date-time-name"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 277 of 738

ID
The draw:id attribute assigns a unique ID to a drawing page.
5958
5959
5960
5961
5962
5963
5964

<define name="draw-page-attlist" combine="interleave"><optional><attribute name="draw:id"><ref name="ID"/></attribute></optional></define>

Navigation Order
The draw:nav-order attribute defines a logical navigation sequence for the graphical elements
included in the page. Its value is a sequence of unique IDREFs. If this optional attribute is present,
it must include all graphic elements not contained within a <draw:g> element. This attributeshould reflect the intentional ordering of graphics as set by the document author.
5965
5966
5967
5968
5969
5970
5971

<define name="draw-page-attlist" combine="interleave"><optional><attribute name="draw:nav-order"><ref name="IDREFS"/></attribute></optional></define>

9.1.5 Presentation Notes
Each drawing page element in a presentation can have an additional presentation notes page,
which contains a preview of the corresponding drawing page and additional graphic shapes. A
notes page is described by the <presentation:notes> element, that may be contained in the<draw:page> element. See section 14.4.2 for more information about this element.
Example: Drawing page<office:automatic-styles><style:style style:name="gg3434" style:family="drawing-page"><style:drawing-page-properties presentation:page-duration="5s"></style:style><style:style style:name="titledia"
style:family="presentation-page-layout"><presentation:placeholder presentation:object="title"
svg:x="20%" svg:y="10%"svg:width="80%" svg:height="10%"/><presentation:placeholder presentation:object="subtitle"
svg:x="20%" svg:y="30%"
svg:width="80%" svg:height="60%" /></style:style></office:automatic-styles>...
<office:body><draw:page office:name="Page 1"
draw:style-name="gg3434"
draw:master-page-name="home"presentation:page-layout-name="titledia"><draw:rect .../>
presentation:notes><draw:text ...>this is a note</draw:text></presentation:notes></draw:page></office:body>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 278 of 738

9.2 Drawing Shapes
This section describes drawing shapes that might occur within all kind of applications.
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992

<define name="shape"><choice><ref name="draw-rect"/><ref name="draw-line"/><ref name="draw-polyline"/><ref name="draw-polygon"/><ref name="draw-regular-polygon"/><ref name="draw-path"/><ref name="draw-circle"/><ref name="draw-ellipse"/><ref name="draw-g"/><ref name="draw-page-thumbnail"/><ref name="draw-frame"/><ref name="draw-measure"/><ref name="draw-caption"/><ref name="draw-connector"/><ref name="draw-control"/><ref name="dr3d-scene"/><ref name="draw-custom-shape"/></choice></define>

9.2.1 Rectangle
The <draw:rect> element represents a rectangular drawing shape.
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014

<define name="draw-rect"><element name="draw:rect"><ref name="draw-rect-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:rect> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16.

•

Round corners

The elements that may be contained in the <draw:rect> element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 279 of 738

•

Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Round Corners
The attribute draw:corner-radius specifies the radius of the circle used to round off thecorners of the rectangle.
6015
6016
6017
6018
6019
6020
6021

<define name="draw-rect-attlist" combine="interleave"><optional><attribute name="draw:corner-radius"><ref name="nonNegativeLength"/></attribute></optional></define>

Example: Rectangular drawing shape<draw:rect svg:x="2cm" svg:y="3cm" svg:width="10cm" svg:height="20cm"
svg:transform="rotate(45)" draw:style-name="object-with-shadow">

9.2.2 LineThe <draw:line> element represents a line.
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041

<define name="draw-line"><element name="draw:line"><ref name="draw-line-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:line> element are:•Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position– see section 9.2.16.

•

Start point•

End point

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 280 of 738

The elements that may be contained in the <draw:line> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Start Point
The start point attributes svg:x1 and svg:y1 specify the start coordinates of the line.
6042
6043
6044
6045
6046
6047
6048
6049

<define name="draw-line-attlist" combine="interleave"><attribute name="svg:x1"><ref name="coordinate"/></attribute><attribute name="svg:y1"><ref name="coordinate"/></attribute></define>

End Point
The end point attributes svg:x2 and svg:y2 specify the end coordinates of the line.
6050
6051
6052
6053
6054
6055
6056
6057

<define name="draw-line-attlist" combine="interleave"><attribute name="svg:x2"><ref name="coordinate"/></attribute><attribute name="svg:y2"><ref name="coordinate"/></attribute></define>

9.2.3 Polyline
The <draw:polyline> element represents a polyline drawing shape.
Some implementations may ignore the size attribute, and instead determine the size of a shapeexclusively from the shape data (i.e., polygon vertices).
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073

<define name="draw-polyline"><element name="draw:polyline"><ref name="common-draw-points-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 281 of 738

6074
6075
6076
6077
6078
6079
6080

</optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:polyline> element are:•

Position, Size, View box, Style, Layer, Z-Index, ID, Caption ID and Transformation – seesection 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Points

The elements that may be contained in the <draw:polyline> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

PointsThe draw:points attribute stores a sequence of points, which are connected by straight lines.
Each point consists of two coordinates. The coordinates are separated by a comma and thepoints are separated by white spaces.
6081
6082
6083
6084
6085

<define name="common-draw-points-attlist"><attribute name="draw:points"><ref name="points"/></attribute></define>

9.2.4 Polygon
The <draw:polygon> element represents a polygon. A polygon is a closed set of straight lines.
Some implementations may ignore the size attribute, and instead determine the size of a shapeexclusively from the shape data (i.e., polygon vertices).
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098

<define name="draw-polygon"><element name="draw:polygon"><ref name="common-draw-points-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 282 of 738

6099
6100
6101
6102
6103
6104
6105
6106
6107
6108

</optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:polygon> element are:•

Position, Size, View box, Style, Layer, Z-Index, ID, Caption ID and Transformation – seesection 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Points – see section 9.2.3

The elements that may be contained in the <draw:polygon> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

9.2.5 Regular Polygon
The <draw:regular-polygon> element represents a regular polygon. A regular polygon is apolygon that is specified by its number of edges (that is equal to the number of its corners), rather
than by arbitrary points.
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130

<define name="draw-regular-polygon"><element name="draw:regular-polygon"><ref name="draw-regular-polygon-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:polygon> element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 283 of 738

•Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Concave•

Corners•

Sharpness

The elements that may be contained in the <draw:regular-polygon> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Concave
The draw:concave attribute specifies whether the polygon is convex or concave. For a convex
polygon, the polygon corners are located on a single ellipse which has its center in the center ofthe polygon. In a concave polygon, two such ellipses are required, and corners that are locatednext to each other are located on different ellipses. An example for a convex polygon is ahexagon. An example for a concave polygon is a star. For concave polygons, an additional
draw:sharpness attribute is required.
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143

<define name="draw-regular-polygon-attlist" combine="interleave"><choice><attribute name="draw:concave"><value>false</value></attribute><group><attribute name="draw:concave"><value>true</value></attribute><ref name="draw-regular-polygon-sharpness-attlist"/></group></choice></define>

Corners
The draw:corners attribute specifies the number of polygon corners.
6144
6145
6146
6147
6148

<define name="draw-regular-polygon-attlist" combine="interleave"><attribute name="draw:corners"><ref name="positiveInteger"/></attribute></define>

Sharpness
For concave attributes, the draw:sharpness attribute specifies the radius of the ellipse on which
the inner polygon corners are located. The value is a percentage, where 0% means that all
corners are located on a single ellipse, while 100% means that the inner corners are located at

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 284 of 738

the center point of the polygon. In general, if r is the radius of the polygon, and s is the sharpness,the inner corners a located on a ellipse that's radius is r(100-s)/100.
6149
6150
6151
6152
6153

<define name="draw-regular-polygon-sharpness-attlist"><attribute name="draw:sharpness"><ref name="percent"/></attribute></define>

9.2.6 Path
The <draw:path> element represents a path. A path is a shape with a user-defined outline. The
shape is built using multiple drawing actions such as:•

moveto – set a new current point•

lineto – draw a straight line•

curveto – draw a curve using a cubic Bézier

•arc – draw an elliptical or circular arc•

closepath – close the current shape by drawing a line to the last moveto

Compound paths are paths with subpaths, each subpath consisting of a single moveto followed by
one or more line or curve operations. Compound paths can be used for effects such as holes inobjects.
Some implementations may ignore the size attribute, and instead determine the size of a shapeexclusively from the shape data (i.e., polygon vertices).
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176

<define name="draw-path"><element name="draw:path"><ref name="common-draw-path-data-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:path> element are:•

Position, Size, View box, Style, Layer, Z-Index, ID, Caption ID and Transformation – seesection 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Path data

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 285 of 738

The elements that may be contained in the <draw:path> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Path Data
The syntax for the attribute svg:d is described in §8 of the Scalable Vector Graphics (SVG) 1.1
Specification [SVG].
Some implementations may only supports a subset of the SVG path specification, for instance no
mixtures of open and closed curves for one shape, or no elliptical arc command.
6177
6178
6179
6180
6181

<define name="common-draw-path-data-attlist"><attribute name="svg:d"><ref name="pathData"/></attribute></define>

9.2.7 Circle
The <draw:circle> element represents a circular drawing shape.
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204

<define name="draw-circle"><element name="draw:circle"><ref name="draw-circle-attlist"/><ref name="common-draw-circle-ellipse-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:circle> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Center point

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 286 of 738

•Radius•Kind•

Start angle•

End angle

The elements that may be contained in the <draw:circle> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Center Point
The center point attributes svg:cx and svg:cy specify the coordinates of the center point of thecircle. If these optional attributes are not set, the position and size attributes are used to create
them.
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214

<define name="common-draw-circle-ellipse-attlist" combine="interleave"><optional><attribute name="svg:cx"><ref name="coordinate"/></attribute><attribute name="svg:cy"><ref name="coordinate"/></attribute></optional></define>

Radius
The svg:r attribute specifies the radius of the circle. If this optional attribute are not set, theposition and size attributes are used to create circle.
6215
6216
6217
6218
6219
6220
6221

<define name="draw-circle-attlist" combine="interleave"><optional><attribute name="svg:r"><ref name="length"/></attribute></optional></define>

Kind
The draw:kind attribute specifies the appearance of the circle.
•

full specifies a full circle or ellipse, like.

•

section specifies a section of a circle or ellipse, like•cut specifies a circle or ellipse with a cut, like

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

.

.

1 February 2007
Page 287 of 738

•
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233

arc specifies a circle or ellipse arc, like.

<define name="common-draw-circle-ellipse-attlist" combine="interleave"><optional><attribute name="draw:kind" a:defaultValue="full"><choice><value>full</value><value>section</value><value>cut</value><value>arc</value></choice></attribute></optional></define>

Start Angle
For circles where the draw:kind attribute value is section, cut or arc, the svg:startangle attribute specifies the start angle of the section, cut, or arc.
6234
6235
6236
6237
6238
6239
6240

<define name="common-draw-circle-ellipse-attlist" combine="interleave"><optional><attribute name="draw:start-angle"><ref name="double"/></attribute></optional></define>

End Angle
For circles where the draw:kind attribute value is section, cut or arc, the svg:end-angle
attribute specifies the end angle of the section, cut, or arc.
6241
6242
6243
6244
6245
6246
6247

<define name="common-draw-circle-ellipse-attlist" combine="interleave"><optional><attribute name="draw:end-angle"><ref name="double"/></attribute></optional></define>

9.2.8 Ellipse
The <draw:ellipse> element represents an ellipse.
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262

<define name="draw-ellipse"><element name="draw:ellipse"><ref name="common-draw-circle-ellipse-attlist"/><ref name="draw-ellipse-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 288 of 738

6263
6264
6265
6266
6267
6268
6269
6270

<ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:ellipse> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Center point, Kind, Start angle, End angle – see section 9.2.7•

Radius

The elements that may be contained in the <draw:ellipse> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Radius
The svg:rx and svg:rx attribute specify the horizontal and vertical radius of the ellipse. If these
optional attributes are not set, the position and size attributes are used to create the ellipse.
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280

<define name="draw-ellipse-attlist" combine="interleave"><optional><attribute name="svg:rx"><ref name="length"/></attribute><attribute name="svg:ry"><ref name="length"/></attribute></optional></define>

9.2.9 Connector
The <draw:connector> element represents a series of lines that are connected to the glue
points of two other shapes.
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290

<define name="draw-connector"><element name="draw:connector"><ref name="draw-connector-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 289 of 738

6291
6292
6293
6294
6295
6296
6297
6298
6299
6300

</optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:connector> element are:•Style, Layer, Z-Index, ID and Caption ID – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16

•

Type

•

Start position•

Start shape•

Start glue point•

End position•

End shape•

End glue point•

Line skew

The elements that may be contained in the <draw:connector> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Type
The draw:type attribute specifies how the connection between two points is rendered. The valueof this attribute can be standard, lines, line, or curve.

6301

•

standard: a standard connector escapes the two connecting objects with straight lines andconnects them with a straight perpendicular line.

•

lines: a lines connector escapes the two connecting objects with straight lines and connects
them with a straight (not necessarily perpendicular) line.

•

line: a line connector draws one straight line between the two escape points of theconnected objects.

•

curve: a curve connector draws a single curved line between the two escape points of theconnected objects.

<define name="draw-connector-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 290 of 738

6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312

<optional><attribute name="draw:type" a:defaultValue="standard"><choice><value>standard</value><value>lines</value><value>line</value><value>curve</value></choice></attribute></optional></define>

Start Position
The start position attributes svg:x1 and svg:y1 specify the start position of a connector.
If the start position is connected to a shape, these attributes are optional because the start
position defaults to the corresponding glue point on the target shape.
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="svg:x1"><ref name="coordinate"/></attribute><attribute name="svg:y1"><ref name="coordinate"/></attribute></optional></define>

Start ShapeThe draw:start-shape attribute identifies the drawing shape to which the start of thisconnector is connected by its name.
If a shape is connected to the start of a connector, the start position defaults to the corresponding
glue point on the target shape.
6323
6324
6325
6326
6327
6328
6329

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="draw:start-shape"><ref name="IDREF"/></attribute></optional></define>

Start Glue Point
The draw:start-glue-point attribute identifies the glue point in the start shape of theconnector by its number. See section 9.2.19 for details on glue points.
If this attribute is not set and the start of the connector is connected to a shape, the application
may choose the glue point. If the start of the connector is not connected to a shape, this attributeis ignored.
6330
6331
6332
6333
6334

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="draw:start-glue-point"><ref name="nonNegativeInteger"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 291 of 738

6335
6336

</optional></define>

End Position
The end position attributes svg:x2 and svg:y2 specify the end position of a connector.
If the end position is connected to a shape, these attributes are optional because the end position
defaults to the corresponding glue point on the target shape.
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="svg:x2"><ref name="coordinate"/></attribute><attribute name="svg:y2"><ref name="coordinate"/></attribute></optional></define>

End Shape
The draw:end-shape attribute identifies the drawing shape to which the end of the connector isconnected by its name.
If a shape is connected to the end of a connector, the end position defaults to the corresponding
glue point on the target shape.
6347
6348
6349
6350
6351
6352
6353

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="draw:end-shape"><ref name="IDREF"/></attribute></optional></define>

End Glue Point
The draw:end-glue-point attribute identifies the glue point in the end shape of the connector
by its number. See section 9.2.19 for details on glue points.
If this attribute is not set and the end of the connector is connected to a shape, the application
may choose the glue point. If the end of the connector is not connected to a shape, this attribute isignored.
6354
6355
6356
6357
6358
6359
6360

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="draw:end-glue-point"><ref name="nonNegativeInteger"/></attribute></optional></define>Line Skew
The draw:line-skew attribute controls the generation of the lines that connect the start and end
points. Depending on the type of connector, this can vary from one to three distances that movethe connector lines relative to their normal position.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 292 of 738

6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375

<define name="draw-connector-attlist" combine="interleave"><optional><attribute name="draw:line-skew"><list><ref name="length"/><optional><ref name="length"/><optional><ref name="length"/></optional></optional></list></attribute></optional></define>

9.2.10 Caption
The <draw:caption> element represents a rectangular drawing shape with an additional set oflines. It can be used as a description for a fixed point inside a drawing.
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397

<define name="draw-caption"><element name="draw:caption"><ref name="draw-caption-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:caption> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Caption point•

Round corners

The elements that may be contained in the <draw:caption> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 293 of 738

•

Text – see section 9.2.17.

Caption Point
The caption point attributes draw:caption-point-x and draw:caption-point-y specify
the position of the point that is captioned. A set of lines are rendered from the caption area.
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407

<define name="draw-caption-attlist" combine="interleave"><optional><attribute name="draw:caption-point-x"><ref name="coordinate"/></attribute><attribute name="draw:caption-point-y"><ref name="coordinate"/></attribute></optional></define>

Round Corners
The draw:corner-radius attribute specifies the radius of the circle used to round off thecorners of the caption.
6408
6409
6410
6411
6412
6413
6414

<define name="draw-caption-attlist" combine="interleave"><optional><attribute name="draw:corner-radius"><ref name="nonNegativeLength"/></attribute></optional></define>

9.2.11 Measure
The <draw:measure> element represents a shape that is used to measure distances indrawings.
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434

<define name="draw-measure"><element name="draw:measure"><ref name="draw-measure-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:measure> element are:•Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 294 of 738

•

Text anchor, table background, draw end position – see section 9.2.16•

Start position•

End position

The elements that may be contained in the <draw:measure> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

Start Position
The attributes svg:x1 and svg:y1 specify the start point of the measured distance.
6435
6436
6437
6438
6439
6440
6441
6442

<define name="draw-measure-attlist" combine="interleave"><attribute name="svg:x1"><ref name="coordinate"/></attribute><attribute name="svg:y1"><ref name="coordinate"/></attribute></define>

Draw End Position
The attributes svg:x2 and svg:y2 specify the end point of the measured distance.
6443
6444
6445
6446
6447
6448
6449
6450

<define name="draw-measure-attlist" combine="interleave"><attribute name="svg:x2"><ref name="coordinate"/></attribute><attribute name="svg:y2"><ref name="coordinate"/></attribute></define>

9.2.12 Control
The <draw:control> element represents a shape that is linked to a control inside an<office:forms> element (see section 11.1).
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462

<define name="draw-control"><element name="draw:control"><ref name="draw-control-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 295 of 738

6463
6464
6465
6466
6467
6468

</optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:control> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16•

Control

The elements that may be contained in the <draw:control> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Glue points – see section 9.2.19.

Control
The attributes draw:control attribute specifies the control within a form (see section 11.5.2)
that is linked to the control shape.
6469
6470
6471
6472
6473

<define name="draw-control-attlist" combine="interleave"><attribute name="draw:control"><ref name="IDREF"/></attribute></define>

9.2.13 Page Thumbnail
The <draw:page-thumbnail> element represents a rectangular area that displays thethumbnail of a drawing page.
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489

<define name="draw-page-thumbnail"><element name="draw:page-thumbnail"><ref name="draw-page-thumbnail-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="presentation-shape-attlist"/><ref name="common-draw-shape-with-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional></element></define>

The attributes that may be associated with the <draw:page-thumbnail> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 296 of 738

•

Presentation class – see section 9.6.1•

Page number

The elements that may be contained in the <draw:page-thumbnail> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

Page Number
The draw:page-number attribute specifies the number of the page that is displayed as athumbnail. For thumbnails on notes pages, the value of this attribute is fixed to the drawing pageof the notes page. For thumbnails on handout master pages, the value of this attribute is the orderin which the pages are previewed on the handout. For example, on a handout page with 4
thumbnails, the thumbnail with the lowest page number displays the first page when printing thefirst handout page and the fifth page when printing the second handout page and so on.
6490
6491
6492
6493
6494
6495
6496

<define name="draw-page-thumbnail-attlist"><optional><attribute name="draw:page-number"><ref name="positiveInteger"/></attribute></optional></define>

9.2.14 Grouping
The <draw:g> element represents a group of drawing shapes.
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522

<define name="draw-g"><element name="draw:g"><ref name="draw-g-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-name-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-text-spreadsheet-shape-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><zeroOrMore><ref name="shape"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:g> element are:•Style, Z-Index, ID and Caption ID – see section 9.2.15.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 297 of 738

•

Text anchor, table background, draw end position – see section 9.2.16•

Position

The elements that may be contained in the <draw:g> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Drawing shapes.

Position
For group shapes that are contained in text documents and anchored as character, the svg:yattribute specifies the vertical position of the shape.
6523
6524
6525
6526
6527
6528
6529

<define name="draw-g-attlist" combine="interleave"><optional><attribute name="svg:y"><ref name="coordinate"/></attribute></optional></define>

9.2.15 Common Drawing Shape Attributes
The attributes described in this section are common to all drawing shapes.

Name
The attribute draw:name assigns a name to the drawing shape.
6530
6531
6532
6533
6534
6535
6536

<define name="common-draw-name-attlist" combine="interleave"><optional><attribute name="draw:name"><ref name="string"/></attribute></optional></define>

Caption-ID
The draw:caption-id attribute establishes a relationship between a drawing objects and its
caption. It takes a value of type IDREF. The value for draw:caption-id attribute is the target
ID assigned to the <draw:text-box> (see section 9.3.1) used to represent the corresponding
caption.
When a caption is assigned by a user agent, an id must be assigned to the element containing thetext used to caption a drawing element. The drawing element being captioned must then be
assigned the draw:caption-id attribute with an IDREF equivalent to the id <draw:textbox> containing the captioning text, thus establishing a relationship between the captioned text
and the object captioned as needed for accessibility. Removing the caption should result inremoving the draw:caption-id attribute of the object that was being captioned.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 298 of 738

If the user agent supports a platform which provides a draw:caption-id relationship in its
accessibility API, this relationship for captions should be used to fulfill the relationship.
See appendix E for guidelines how to use this attribute.
6537
6538
6539
6540
6541
6542
6543

<define name="common-draw-caption-id-attlist" combine="interleave"><optional><attribute name="draw:caption-id"><ref name="IDREF"/></attribute></optional></define>

Position
The position attributes svg:x and svg:y specify the x and y coordinates of the start position of
the drawing shape.
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555

<define name="common-draw-position-attlist"><optional><attribute name="svg:x"><ref name="coordinate"/></attribute></optional><optional><attribute name="svg:y"><ref name="coordinate"/></attribute></optional></define>

Size
The attributes svg:width and svg:height specify the width and height of the drawing shape.
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567

<define name="common-draw-size-attlist"><optional><attribute name="svg:width"><ref name="length"/></attribute></optional><optional><attribute name="svg:height"><ref name="length"/></attribute></optional></define>

Transformation
The draw:transform attribute specifies a list of transformations that can be applied to a
drawing shape.
The value of this attribute is a list of transform definitions, which are applied to the drawing shapein the order in which they are listed. The transform definitions in the list must be separated by awhite space and/or a comma. The types of transform definitions available include:•

matrix(<a> <b> <c> <d> <e> <f>), which specifies a transformation in the form of atransformation matrix of six values. matrix(a,b,c,d,e,f) is the equivalent of applying thetransformation matrix [a b c d e f].

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 299 of 738

6568
6569
6570
6571
6572
6573
6574

•

translate(<tx> [<ty>]), which specifies a translation by tx and ty.

•

scale(<sx> [<sy>]), which specifies a scale operation by sx and sy. If <sy> is notprovided, it is assumed to be equal to <sx>.

•rotate(<rotate-angle>), which specifies a rotation by <rotate-angle> about theorigin of the shapes coordinate system.

•

skewX(<skew-angle>), which specifies a skew transformation along the X axis.

•

skewY(<skew-angle>), which specifies a skew transformation along the Y axis.

<define name="common-draw-transform-attlist"><optional><attribute name="draw:transform"><ref name="string"/></attribute></optional></define>

View Box
The svg:viewBox attribute establishes a user coordinate system inside the physical coordinate
system of the shape specified by the position and size attributes. This user coordinate system isused by the svg:points attribute and the <draw:path> element.
The syntax for using this attribute is the same as the [SVG] syntax. The value of the attribute are
four numbers separated by white spaces, which define the left, top, right, and bottom dimensionsof the user coordinate system.
Some implementations may ignore the view box attribute. The implied coordinate system then has
its origin at the left, top corner of the shape, without any scaling relative to the shape.
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584

<define name="common-draw-viewbox-attlist"><attribute name="svg:viewBox"><list><ref name="integer"/><ref name="integer"/><ref name="integer"/><ref name="integer"/></list></attribute></define>

Style
The draw:style-name and presentation:style-name attributes specify a style for thedrawing shape. If draw:style-name is used, the shape is a regular graphic shape. If
presentation:style-name is used, the shape is a presentation shape as described in section
9.6.
The value of both attributes is the name of a <style:style> element. If the draw:stylename attribute is used, the style must have a family value of graphic. If thepresentation:style-name is used, the style must have a family value of presentation.
The formatting properties of the specified style and its optional parent styles are used to format
the shape. See also section 14.13.1.
The draw:class-names and presentation:class-names attributes take a whitespace
separated list of either graphic or presentation style names. The referenced styles are applied in
the order they are contained in the list. If both, draw:style-name and draw:class-names, or
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 300 of 738

both presentation:style-name and presentation:class-names are present, the stylereferenced by the style-name attribute is treated as the first style in the list in the class-names
attribute. Conforming application should support the class-names attribute and also shouldpreserve it while editing.
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612

<define name="common-draw-style-name-attlist"><choice><group><optional><attribute name="draw:style-name"><ref name="styleNameRef"/></attribute></optional><optional><attribute name="draw:class-names"><ref name="styleNameRefs"/></attribute></optional></group><group><optional><attribute name="presentation:style-name"><ref name="styleNameRef"/></attribute></optional><optional><attribute name="presentation:class-names"><ref name="styleNameRefs"/></attribute></optional></group></choice></define>

Text Style
The draw:text-style-name attribute specifies a style for the drawing shape that is used toformat the text that can be added to this shape.
The value of this attribute is the name of a <style:style> element with a family value ofparagraph.
6613
6614
6615
6616
6617
6618
6619

<define name="common-draw-text-style-name-attlist"><optional><attribute name="draw:text-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Layer
The attribute draw:layer can assign each shape to a layer. The value of this attribute must be
the name of a layer inside the layer-set of the document.
6620
6621
6622
6623
6624

<define name="common-draw-layer-name-attlist"><optional><attribute name="draw:layer"><data type="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 301 of 738

6625
6626

</optional></define>ID
The draw:id attribute assigns an unique ID to a drawing shape that can be used to reference theshape.
6627
6628
6629
6630
6631
6632
6633

<define name="common-draw-id-attlist"><optional><attribute name="draw:id"><ref name="ID"/></attribute></optional></define>

Z-Index
Drawing shapes are rendered in a specific order. In general, the shapes are rendered in the orderin which they appear in the XML document. To change the order, use the svg:z-index attribute.
This attribute is optional.
6634
6635
6636
6637
6638
6639
6640

<define name="common-draw-z-index-attlist"><optional><attribute name="draw:z-index"><ref name="nonNegativeInteger"/></attribute></optional></define>

9.2.16 Common Shape Attributes for Text and Spreadsheet
Documents
The attributes described in this section are common to all drawing shapes contained in text andspreadsheet documents.

End Position
If a drawing shape is included in a spreadsheet document and if the anchor of the shape is in acell, then the attributes table:end-cell-address, table:end-x and table:end-y specify
the end position of the shape and the size attributes are ignored. The end position is specified
using the cell address of the cell in which the end position is located, and the x and y coordinatesof the end position relative to the top left edge of the cell.
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653

<define name="common-text-spreadsheet-shape-attlist" combine="interleave"><optional><attribute name="table:end-cell-address"><ref name="cellAddress"/></attribute></optional><optional><attribute name="table:end-x"><ref name="coordinate"/></attribute></optional><optional><attribute name="table:end-y">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 302 of 738

6654
6655
6656
6657

<ref name="coordinate"/></attribute></optional></define>

Table BackgroundIf a drawing shape is included in a spreadsheet document, then the table:table-background
attribute specifies whether or not the shape is in the table background. If the attribute is notexisting, the shape is included in the foreground of the table.
6658
6659
6660
6661
6662
6663
6664

<define name="common-text-spreadsheet-shape-attlist" combine="interleave"><optional><attribute name="table:table-background"><ref name="boolean"/></attribute></optional></define>

Text Anchor
Within text documents, the anchor type attribute text:anchor-type specifies how a frame isbound to the text document. The anchor position is the point at which a frame is bound to a text
document. The anchor position depends on the anchor type as explained in the following table.
If the value of the The anchor position is...
text:anchortype attribute is
...
page

The page that has thesame physical page
number as the value of the
text:anchor-pagenumber attribute that is
attached to the drawing
shape element. If notext:anchor-pagenumber attribute is given,
the anchor position is thepage at which thecharacter behind thedrawing object element
appears.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

The drawing shapeelement appears ...

Notes

Either•

The physical page
number is theAt the start of thenumber assigned to
document body,the page if all pages
outside any paragraph in the document areor frame, provided acounted starting
text:anchorwith page 1.
page-number
attribute is given.

Or•

Inside any paragraphelement that is notcontained in a header,footer, footnote, ortext box, if atext:anchorpage-number
attribute is not given.

1 February 2007
Page 303 of 738

6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681

If the value of the The anchor position is...
text:anchortype attribute is...

The drawing shapeelement appears ...

frame

The parent text box thatthe current drawing shapeelement is contained in.

In the element
representing the text box
to which the drawing
object is bound. For
example, if an image isbound to a text box, theimage element is locatedin the text box element.

paragraph

The paragraph that thecurrent drawing shapeelement is contained in.

At the start of theparagraph element.

char

The character after thedrawing shape element.

Just before the character.

as-charThere is no anchor
position. The drawing
shape behaves like acharacter.

At the position where thecharacter appears in the
document.

Notes<define name="common-text-spreadsheet-shape-attlist" combine="interleave"><ref name="common-text-anchor-attlist"/></define><define name="common-text-anchor-attlist" combine="interleave"><optional><attribute name="text:anchor-type"><choice><value>page</value><value>frame</value><value>paragraph</value><value>char</value><value>as-char</value></choice></attribute></optional></define>

Anchor Page Number
Within text documents, the text:anchor-page-number attribute specifies the physical page
number of an anchor if the drawing object is bound to a page.
6682
6683
6684
6685
6686
6687
6688

<define name="common-text-anchor-attlist" combine="interleave"><optional><attribute name="text:anchor-page-number"><ref name="positiveInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 304 of 738

9.2.17 Common Drawing Shape Content
Most drawing shapes may contain text content. The text content may contain paragraphs (seesection 4.1.2) as well as lists (see section 4.3).
6689
6690
6691
6692
6693
6694
6695
6696

<define name="draw-text"><zeroOrMore><choice><ref name="text-p"/><ref name="text-list"/></choice></zeroOrMore></define>

9.2.18 Common Shape Attribute Groups
The following defined attributes are common for all shapes that supports styles and no text.
6697
6698
6699
6700
6701
6702
6703
6704
6705

<define name="common-draw-shape-with-styles-attlist"><ref name="common-draw-z-index-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-draw-transform-attlist"/><ref name="common-draw-name-attlist"/><ref name="common-text-spreadsheet-shape-attlist"/></define>

The following defined attributes are common for all shapes that supports styles and text.
6706
6707
6708
6709

<define name="common-draw-shape-with-text-and-styles-attlist"><ref name="common-draw-shape-with-styles-attlist"/><ref name="common-draw-text-style-name-attlist"/></define>

9.2.19 Glue Points
Glue points are designated points on the area of a drawing object to which a connector shape canconnect. Most drawing objects have four standard glue points at the four edges of the object.
Additional glue points may be added to a drawing object by inserting one or more <draw:gluepoint> elements into a drawing object element. A <draw:glue-point> element creates asingle user-defined glue point if placed inside a drawing object element, for example, a<draw:rectangle> element.
6710
6711
6712
6713
6714
6715

<define name="draw-glue-point"><element name="draw:glue-point"><ref name="draw-glue-point-attlist"/><empty/></element></define>ID
The draw:id attribute contains the id of the glue point. The id a number and is used inside thedraw:start-glue-point and draw:end-glue-point attributes of a <draw:connector>
element. The Ids 0 to 3 are reserved for the 4 standard glue points that most drawing objects
have. The glue points are numbered clockwise, starting at the top left corner of the shape.
6716
6717

<define name="draw-glue-point-attlist" combine="interleave"><attribute name="draw:id">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 305 of 738

6718
6719
6720

<ref name="nonNegativeInteger"/></attribute></define>

Position
The svg:x and svg:y attributes specifies the position of the glue point. The coordinates areeither percentage values relative to the drawing objects center or, if the draw:align attribute is also
specified, absolute distance values relative to the edge specified with the draw:align attribute.
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734

<define name="draw-glue-point-attlist" combine="interleave"><attribute name="svg:x"><choice><ref name="distance"/><ref name="percent"/></choice></attribute><attribute name="svg:y"><choice><ref name="distance"/><ref name="percent"/></choice></attribute></define>

Align
The attribute draw:align specifies the alignment behavior of the glue point if the drawing object
is resized and the shape edge to which the glue point's position relates. A missing vertical or
horizontal position in the attribute's value means that the glue point is horizontally or vertically
centered.
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750

<define name="draw-glue-point-attlist" combine="interleave"><optional><attribute name="draw:align"><choice><value>top-left</value><value>top</value><value>top-right</value><value>left</value><value>center</value><value>right</value><value>bottom-left</value><value>bottom-right</value></choice></attribute></optional></define>

Escape Direction
The attribute draw:escape-direction specifies the direction in which the connection line
escapes from the drawing object if a connector connects to the glue point. The value horizontalmeans the the connection line may escape to the left or to the right, the value vertical meansthat the connection line may escape up or down. The value auto means that the connection line
may escape in all four directions.
6751
6752

<define name="draw-glue-points-attlist" combine="interleave"><attribute name="draw:escape-direction">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 306 of 738

6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763

<choice><value>auto</value><value>left</value><value>right</value><value>up</value><value>down</value><value>horizontal</value><value>vertical</value></choice></attribute></define>

9.2.20 Title and Description
The <svg:title> and <svg:desc> elements specify text-only description strings for graphicalobjects as specified in §5.4 of [SVG].
The <svg:title> element is used as a short accessible name.
6764
6765
6766
6767
6768

<define name="svg-title"><element name="svg:title"><text/></element></define>

The <svg:desc> element is used for the long description in support of accessibility.
6769
6770
6771
6772
6773

<define name="svg-desc"><element name="svg:desc"><text/></element></define>

See appendix E for guidelines how to use these elements.
The <svg:title> and <svg:desc> elements can be used with the following drawing shapeelements:•<draw:rect>•<draw:line>•<draw:polyline>•<draw:polygon>•<draw:regular-polygon>•<draw:path>•<draw:circle>•<draw:ellipse>•<draw:g>•<draw:page-thumbnail>•<draw:frame>•<draw:measure>•<draw:caption>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 307 of 738

•<draw:connector>•<draw:control>•<dr3d:scene>•<draw:custom-shape>

It is further supported by layers (see section 9.1.3) and client side image maps (see section
9.3.10).

9.2.21 Event Listeners
Drawing shapes may have event listeners attached. The event listeners that are attached to, forexample, a text box or an image, are represented by an event listener element as described in
section 12.4. This element is contained within the drawing object element, for example, the<draw:text-box> element or the <draw:image> element.

9.3 Frames
A frame is a rectangular container where that contains enhanced content like text boxes, images
or objects. Frames are very similar to regular drawing shapes, but support some features that are
not available for regular drawing shapes, like contours, image maps and hyperlinks. In particular,a frame allows to have multiple renditions of an object. That is, a frame may for instance containan object as well as an image. In this case, the application may choose the content that itsupports best. If the application supports the object type contained in the frame, it probably willrender the object. If it does not support the object, it will render the image.
In general, an application must not render more than one of the content elements contained in aframe. The order of content elements dictates the document author's preference for rendering,with the first child being the most preferred. This means that applications should render the firstchild element that it supports. A frame must contain at least one content element. The inclusion ofmultiple content elements is optional. Application may preserve the content elements they don't
render, but don't have to.
Within text documents, frames are also used to position content outside the default text flow of adocument.
Frames can contain:•

Text boxes•

Objects represented either in the OpenDocument format or in a object specific binary format•

Images•Applets•

Plug-ins•

Floating frames

Like the formatting properties of drawing shapes, frame formatting properties are stored in styles
belonging to the graphic family. The way a frame is contained in a document also is the same
as for drawing shapes.
6774
6775
6776
6777

<define name="draw-frame"><element name="draw:frame"><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-position-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 308 of 738

6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815

<ref name="common-draw-rel-size-attlist"/><ref name="common-draw-caption-id-attlist"/><ref name="presentation-shape-attlist"/><ref name="draw-frame-attlist"/><zeroOrMore><choice><ref name="draw-text-box"/><ref name="draw-image"/><ref name="draw-object"/><ref name="draw-object-ole"/><ref name="draw-applet"/><ref name="draw-floating-frame"/><ref name="draw-plugin"/></choice></zeroOrMore><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><optional><ref name="draw-image-map"/></optional><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><choice><ref name="draw-contour-polygon"/><ref name="draw-contour-path"/></choice></optional></element></define>

The attributes that may be associated with the <draw:frame> element are:•

Position, Size (relative sizes, see below), Style, Layer, Z-Index, ID, Caption ID andTransformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16•

Presentation class – see section 9.6.1•

Copy frames

The following elements may be contained in the image element:•

Event Listeners – see section 12.4.

•

Glue Points – see section 9.2.19.

•

Image Map – see section 9.3.10.

•

Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Contour – see section 9.3.8.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 309 of 738

Relative Sizes
For frames, the width and height of the drawing object may be specified as a relative value using
the style:rel-width and style:rel-height attributes. The relative value either is apercentage value, the special value scale, or the special value scale-min.
The interpretation of relative values depends on the anchor of the drawing object. If the anchor forthe drawing object is in a table cell, the percentage value relates to the surrounding table box. If
the anchor for the drawing object is in a text box, the percentage value relates to the surrounding
text box. In other cases, the percentage values relate to the width of the page or window.
The value scale for the width means that the width should be calculated depending on theheight, so that the ratio of with and height of the original image or object size is preserved.
The value scale for the height means that the height should be calculated depending on thewidth, so that the ratio of with and height of the original image or object size is preserved.
The value scale-min equals the value scale, except that the calculated width or height is aminimum height rather than an absolute one.
To support application that don't support relative with and heights, applications that save theattributes style:rel-width or style:rel-height should also provide the real width andheights in the svg:width and svg:height/fo:min-height attributes.
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836

<define name="common-draw-rel-size-attlist"><ref name="common-draw-size-attlist"/><optional><attribute name="style:rel-width"><choice><ref name="percent"/><value>scale</value><value>scale-min</value></choice></attribute></optional><optional><attribute name="style:rel-height"><choice><ref name="percent"/><value>scale</value><value>scale-min</value></choice></attribute></optional></define>

Copy FramesMultiple frames can be set to display the exact same underlying data: for instance for a company
logo, that must appear somewhere on every page, without being part of a header or footer.
A frame can be set to display the contents of another frame, referenced by the draw:copy-of
attribute. This does not effect style and position information. This is, the frame that has thedraw:copy-of attribute has its own style and position information and does not use the one of
the referenced frame.
6837
6838
6839
6840

<define name="draw-frame-attlist" combine="interleave"><optional><attribute name="draw:copy-of"><ref name="string"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 310 of 738

6841
6842
6843

</attribute></optional></define>

9.3.1 Text Box
The <draw:text-box>element represents a text box. A text box may be used to place text in acontainer that is outside of the normal flow of the document.
6844
6845
6846
6847
6848
6849
6850
6851

<define name="draw-text-box"><element name="draw:text-box"><ref name="draw-text-box-attlist"/><zeroOrMore><ref name="text-content"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:text-box> element are:
•

Chain

•

Round Corners•

Minimum Height and Width•

Maximum Height and Width

Text boxes don't support contours as described in section 9.3.8 and alternative texts as describedin section 9.2.20.

Chain
Text boxes can be chained, in other words, if the content of a text box exceeds its capacity, thecontent flows into the next text box in the chain. To chain text boxes, the attribute draw:chainnext-name is used, The value of this attribute is the name of the next text box in the chain.
Chained text boxes usually are supported by text documents only.
6852
6853
6854
6855
6856
6857
6858

<define name="draw-text-box-attlist" combine="interleave"><optional><attribute name="draw:chain-next-name"><ref name="string"/></attribute></optional></define>

Round Corners
The attribute draw:corner-radius specifies the radius of the circle used to round off thecorners of the text-box.
6859
6860
6861
6862
6863
6864
6865

<define name="draw-text-box-attlist" combine="interleave"><optional><attribute name="draw:corner-radius"><ref name="nonNegativeLength"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 311 of 738

Minimum Height and Width
The fo:min-height and fo:min-width attributes specify a minimum height or width for a text
box. If they are existing, they overwrite the height or width of a text box specified by the
svg:height and svg:width attributes of the surrounding <draw:frame> element. Their value
can be either a length or a percentage. If the anchor for the text box is in a table cell, thepercentage value relates to the surrounding table box. If the anchor for the text box is in a text
box, the percentage value relates to the surrounding text box. In other cases, the percentage
values relate to the height of the page or window.
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883

<define name="draw-text-box-attlist" combine="interleave"><optional><attribute name="fo:min-height"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="fo:min-width"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

Maximum Height and Width
If the width or height of a text box is specified as a minimum width or height (using the fo:minwidth or fo:min-height attributes), then the fo:max-width and fo:max-height attributes
specify a maximum width and height for the text box. When these maximum values are reached,
the text box stops increasing in size. The attributes' value can be either a length or a percentage.
If the anchor for the text box is in a table cell, the percentage value relates to the size of thesurrounding table cell. If the anchor for the text box is in a text box, the percentage value relates
to the size of the surrounding text box. In other cases, the percentage values relate to the width orheight of the page or window.
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901

<define name="draw-text-box-attlist" combine="interleave"><optional><attribute name="fo:max-height"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="fo:max-width"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 312 of 738

ID
A text box may have an ID. This ID can be used to reference the text box from other elements.
6902
6903
6904
6905
6906

<define name="draw-text-box-attlist" combine="interleave"><optional><ref name="text-id"/></optional></define>

9.3.2 Image
The <draw:image> element represents an image. An image can be either:•

Contained in a document as a link to an external resourceor•Embedded in a document

This element can be an [XLink], in which case the element contains some attributes with fixedvalues that describe the link semantics.
While the image data may have an arbitrary format, it is recommended that vector graphics are
stored in the [SVG] format and bitmap graphics in the [PNG] format.
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916

<define name="draw-image"><element name="draw:image"><ref name="draw-image-attlist"/><choice><ref name="common-draw-data-attlist"/><ref name="office-binary-data"/></choice><ref name="draw-text"/></element></define>

The attributes that may be associated with the <draw:image> element are:•Image data•

Filter nameLike most other drawing shapes, image drawing shapes may have text content. It is displayed inaddition to the image data.

Image Data
The image data can be stored in one of the following ways:

6917
6918
6919

•

The image data is contained in an external file. Use the xlink:href and associatedattributes described below to link to the external file.

•

The image data is contained in the <draw:image> element. The <draw:image> thenelement contains an <office:binary-data> element that contains the image data in
BASE64 encoding (as defined in [RFC2045]). In this situation the xlink:href attribute is not
required.

<define name="common-draw-data-attlist" combine="interleave"><group><attribute name="xlink:href">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 313 of 738

6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944

<ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><choice><value>simple</value></choice></attribute></optional><optional><attribute name="xlink:show" a:defaultValue="embed"><choice><value>embed</value></choice></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onLoad"><choice><value>onLoad</value></choice></attribute></optional></group></define>

6945
6946
6947
6948
6949
6950

<define name="office-binary-data"><element name="office:binary-data"><ref name="base64Binary"/></element></define>

Filter Name
If required, the draw:filter-name attribute can represent the filter name of the image. This
attribute contains the internal filter name that the office application software used to load thegraphic.
6951
6952
6953
6954
6955
6956
6957

<define name="draw-image-attlist" combine="interleave"><optional><attribute name="draw:filter-name"><ref name="string"/></attribute></optional></define>

9.3.3 Objects
A document in OpenDocument format can contain two types of objects, as follows:•

Objects that have an OpenDocument or other XML representation. Objects that have an
OpenDocument representation are:–

Formulas (represented as [MathML])–

Charts–Spreadsheets–

Text documents

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 314 of 738

•–Drawings–

Presentations

Objects that do not have an XML representation. These objects only have a binary
representation, An example for this kind of objects OLE objects (see [OLE]).

The <draw:object> element represents objects that have a XML representation. The<draw:object-ole> element represents objects that only have a binary representation.
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967

<define name="draw-object"><element name="draw:object"><ref name="draw-object-attlist"/><choice><ref name="common-draw-data-attlist"/><ref name="office-document"/><ref name="math-math"/></choice></element></define>

6968
6969
6970
6971
6972
6973
6974
6975
6976
6977

<define name="draw-object-ole"><element name="draw:object-ole"><ref name="draw-object-ole-attlist"/><choice><ref name="common-draw-data-attlist"/><ref name="office-binary-data"/></choice></element></define>

The attributes that may be associated with the <draw:object> and <draw:object-ole>
elements are:•

Object data•

Table Change Notifications•

Class Id

Objects do not support transformations as described in section 9.2.15.

Object Data
The object data can be called in one of the following ways:•

The xlink:href attribute links to the object representation, as follows:–

For objects that have an XML representation, the link references the sub package of theobject. The object is contained within this sub page exactly as it would as it is a documentof its own.

–

For objects that do not have an XML representation, the link references a sub stream ofthe package that contains the binary representation of the object.

Application that support objects should support linking to objects that are contained within thesame package. They may also support linking to object located outside the package.
•

The object data is contained in the <draw:object> or <draw:object-ole> element, as
follows:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 315 of 738

–

The <draw:object> element contains the XML representation of the object, forexample, an <office:document> or a <math:math> element.

–

The <draw:object-ole> element contains an <office:binary-data> element,
which contains the binary data for the object in BASE64 encoding.

In these situations, the xlink:href attributes are not required.
The xlink:href attribute is described in section 9.3.2.
It is recommended to include an image representation of the object into the frame in addition tothe object itself.

Notification on Table Change
Some objects, especially charts, may require a notification when a table in the document changes.
To enable this notification, use the draw:notify-on-change-of-table attribute, whichcontains the name of the table. This attribute can be associated with the <draw:object>element.
6978
6979
6980
6981
6982
6983
6984

<define name="draw-object-attlist" combine="interleave"><optional><attribute name="draw:notify-on-update-of-ranges"><ref name="string"/></attribute></optional></define>

Class Id
If the embedded object is an OLE object, the draw:class-id attribute optionally contains theOLE class id of the object (see also [OLE]).
6985
6986
6987
6988
6989

<define name="draw-object-ole-attlist" combine="interleave"><optional><attribute name="draw:class-id"/></optional></define>

9.3.4 Applet
An applet is a small Java-based program that is embedded in a document. The <draw:applet>element is based on the <applet> tag in [HTML4]. This element must contain either thedraw:code or draw:object attribute.
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000

<define name="draw-applet"><element name="draw:applet"><ref name="draw-applet-attlist"/><optional><ref name="common-draw-data-attlist"/></optional><zeroOrMore><ref name="draw-param"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:applet> element are:•Codebase

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 316 of 738

•

Code

•

Object•Archive•

Mayscript

The only element that may be contained in the <draw:applet> element is:•Parameter (see section 9.3.6)

Applets do not support transformations as described in section 9.2.15.

Codebase
The codebase specifies the base IRI for the applet. If this attribute is not specified, then it defaults
the same base IRI as for the current document. The codebase is represented be the [XLink]
attributes xlink:href, xlink:type, xlink:show, and xlink:actuate. The xlink:href
attribute is described in section 9.3.2.

Code
The draw:code attribute specifies one of the following:•

The name of the class file that contains the compiled applet subclass.

•

The path to the class, including the class file itself.

Either this attribute or the draw:object attribute is required. The value of this attribute isinterpreted in relation to the codebase for the applet.
7001
7002
7003
7004
7005

<define name="draw-applet-attlist" combine="interleave"><optional><attribute name="draw:code"/></optional></define>

Object
The draw:object attribute specifies a resource that contains a serialized representation of thestate of the applet. The serialized data contains the class name of the applet but not theimplementation. The value of this attribute is interpreted in relation to the codebase for the applet.
7006
7007
7008
7009
7010

<define name="draw-applet-attlist" combine="interleave"><optional><attribute name="draw:object"/></optional></define>

Archive
The draw:archive attribute specifies a comma-separated list of URLs for archives that containclasses and other resources that are preloaded.
7011
7012
7013
7014

<define name="draw-applet-attlist" combine="interleave"><optional><attribute name="draw:archive"/></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 317 of 738

7015</define>

Mayscript
The draw:mayscript attribute specifies whether or not the applet can be scripted.
7016
7017
7018
7019
7020
7021
7022

<define name="draw-applet-attlist" combine="interleave"><optional><attribute name="draw:may-script" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

9.3.5 Plugins
A plugin is a binary object that is plugged into a document to represent a media-type that usuallyis not handled natively by office application software. Plugins are represented by the<draw:plugin> element
7023
7024
7025
7026
7027
7028
7029
7030
7031

<define name="draw-plugin"><element name="draw:plugin"><ref name="draw-plugin-attlist"/><ref name="common-draw-data-attlist"/><zeroOrMore><ref name="draw-param"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:plugin> element are:•Mime type•

SourceThe only element that may be contained in the <draw:plugin> element is:•Parameter (see section 9.3.6)

Plugins do not support transformations as described in section 9.2.15.

Mime typeThe draw:mimetype attribute specifies the MIME type to which this plugin should be registered.
7032
7033
7034
7035
7036

<define name="draw-plugin-attlist" combine="interleave"><optional><attribute name="draw:mime-type"/></optional></define>

SourceThe [XLink] attributes xlink:href, xlink:type, xlink:show, and xlink:actuate specify
the source of the plugin. The xlink:href attribute is described in section 9.3.2.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 318 of 738

9.3.6 Parameters
The <draw:param> element contains parameters that are passed to an applet or plugin when
they are initialized.
7037
7038
7039
7040
7041
7042

<define name="draw-param"><element name="draw:param"><ref name="draw-param-attlist"/><empty/></element></define>

The attributes that may be associated with the <draw:param> element are:● Name● ValueName
The draw:name attribute specifies the name of a runtime parameter.
7043
7044
7045
7046
7047

<define name="draw-param-attlist" combine="interleave"><optional><attribute name="draw:name"/></optional></define>

Value
The draw:value attribute specifies the value of the runtime parameter specified by the name.
7048
7049
7050
7051
7052

<define name="draw-param-attlist" combine="interleave"><optional><attribute name="draw:value"/></optional></define>

9.3.7 Floating Frame
A floating frame is a frame embedded in a document, which may contain, for example, a text
document or spreadsheet. A floating frame is represented by the <draw:floating-frame>
element.
7053
7054
7055
7056
7057
7058

<define name="draw-floating-frame"><element name="draw:floating-frame"><ref name="draw-floating-frame-attlist"/><ref name="common-draw-data-attlist"/></element></define>

The attributes that may be associated with the <draw:floating-frame> element are:•Source•Frame Name

Floating frames do not support transformations as described in section 9.2.15.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 319 of 738

Source
The [XLink] attributes xlink:href, xlink:type, xlink:show, and xlink:actuate specify
the source of the floating frame. The xlink:href attribute is described in section 9.3.2.

Frame Name
The draw:frame-name specifies the name of the frame. This name can be used as target fromwithin hyperlinks.
7059
7060
7061
7062
7063
7064
7065

<define name="draw-floating-frame-attlist" combine="interleave"><optional><attribute name="draw:frame-name"><ref name="string"/></attribute></optional></define>

9.3.8 Contour
The <draw:contour-polygon> and <draw:contour-path> elements may be contained in
the following elements:•<draw:image>•<draw:object>•<draw:object-ole>•<draw:applet>•<draw:plugin>•<draw:floating-frame>

These elements describe the contour of an image or object.
7066
7067
7068
7069
7070
7071
7072
7073
7074

<define name="draw-contour-polygon"><element name="draw:contour-polygon"><ref name="common-contour-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-points-attlist"/><empty/></element></define>

7075
7076
7077
7078
7079
7080
7081
7082
7083
7084

<define name="draw-contour-path"><element name="draw:contour-path"><ref name="common-contour-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-path-data-attlist"/><empty/></element></define>

The elements are similar to the <draw:polygon> (see section 9.2.4) and <draw:path> (seesection 9.2.6) elements, except that they specify a contour rather than a drawing shape. The
attributes they support are the ones for the size, the viewbox, the points (contour polygon only)
and the path (contour path only).
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 320 of 738

For the svg:width and svg:height attributes of the <draw:contour-polygon> and<draw:contour-path> elements, applications should support pixel lengths (i.e., 20px) in
addition to traditional lengths like 2cm.

Recreate on Edit
The draw:recreate-on-edit attribute specifies if the contour of the image or object should berecreated automatically when the image or object is edited.
7085
7086
7087
7088
7089

<define name="common-contour-attlist" combine="interleave"><attribute name="draw:recreate-on-edit"><ref name="boolean"/></attribute></define>

9.3.9 Hyperlinks
Frames may behave like hyperlinks. Such hyperlinks are represented by the <draw:a> element,
where. the element's content is the frame that should be the source of the link.
This element is an [XLink] and has some attributes with fixed values and describe the semanticsof the link.
7090
7091
7092
7093
7094
7095

<define name="draw-a"><element name="draw:a"><ref name="draw-a-attlist"/><ref name="draw-frame"/></element></define>

The attributes that may be associated with the <draw:a> element are:•Link location•

Link target frame

•

Name

•

Title

•

Server side image map

Link Location
The xlink:href attribute specifies the target location of the link.
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109

<define name="draw-a-attlist" combine="interleave"><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><choice><value>onRequest</value></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 321 of 738

7110
7111
7112

</attribute></optional></define>

Link Target Frame
The office:target-frame attribute specifies the target frame of the link.
This attribute can have one of the following values:•_self : The referenced document replaces the content of the current frame.

•_blank : The referenced document is displayed in a new frame.

•_parent : The referenced document is displayed in the parent frame of the current frame.

•_top : The referenced document is displayed in the topmost frame, that is the frame that
contains the current frame as a child or descendent but is not contained within another frame.

•

A frame name : The referenced document is displayed in the named frame. If the named
frame does not exist, a new frame with that name is created.

To conform with the [XLink] specification, an additional xlink:show attribute is attached to the<draw:a> element. If the value of the this attribute is _blank, the xlink:show attribute value isnew. If the value of the this attribute is any of the other value options, the value of thexlink:show attribute is replace.
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127

<define name="draw-a-attlist" combine="interleave"><optional><attribute name="office:target-frame-name"><ref name="targetFrameName"/></attribute></optional><optional><attribute name="xlink:show"><choice><value>new</value><value>replace</value></choice></attribute></optional></define>Name
A hyperlink can have a name, but it is not essential. The office:name attribute specifies thename of the link. The name can serve as a target for other hyperlinks. The name does not have to
be unique.
This attribute is specified for compatibility with [HTML4] only, where an <a> element may serve
as a link source and target simultaneously. We strongly recommend that this attribute not be used
for any purpose other than to represent links that originally came from a HTML document.
7128
7129
7130
7131
7132
7133
7134

<define name="draw-a-attlist" combine="interleave"><optional><attribute name="office:name"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 322 of 738

TitleThe office:title attribute specifies a short accessible description for hint text.
See appendix E for guidelines how to use this attribute.
7135
7136
7137
7138
7139
7140
7141

<define name="draw-a-attlist" combine="interleave"><optional><attribute name="office:title"><ref name="string"/></attribute></optional></define>

Server Side Image Map
A link can be a server side image map. If the office:server-map attribute is present, themouse coordinates of the click position of the graphic shape are appended to the IRI of the link.
The coordinates may be used by the server to determine which link to activate within the image
map.
7142
7143
7144
7145
7146
7147
7148

<define name="draw-a-attlist" combine="interleave"><optional><attribute name="office:server-map" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

9.3.10 Client Side Image Maps
An client side image map is a collection of hyperlinks that are associated with graphic elements.
The image map is a sequence of image map elements. Each image map element associates a
hyperlink with an area. The area can be one of the following shapes:•

Rectangular•

Circular•

Polygonal

The <draw:image-map> element represents an image map.
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159

<define name="draw-image-map"><element name="draw:image-map"><zeroOrMore><choice><ref name="draw-area-rectangle"/><ref name="draw-area-circle"/><ref name="draw-area-polygon"/></choice></zeroOrMore></element></define>

The <draw:image-map> element can contain three types of image map elements, which
represent the three types of image map areas as follows:•

Rectangular image map elements•

Circular image map elements

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 323 of 738

•Polygonal image map elements

Image map elements are described in terms of absolute positions. When loading the XML file, theoffice application must map the image map onto its associated graphical element, for example animage, in its original size. The application then must scale the image map to match the current
size of the image, but in the file format the image is always saved in its unscaled version,
matching the dimensions of the unscaled image.

Rectangular Image Map Areas
The <draw:area-rectangle> element describes a rectangular image map area by an x, y
position (svg:x and svg:y attributes) as well as a width and the height (svg:width andsvg:height attributes). These attributes are required. In addition to this, the attributes describedin section 9.3.10:Common Image Map Attributes and Elements are optionally supported.
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185

<define name="draw-area-rectangle"><element name="draw:area-rectangle"><ref name="common-draw-area-attlist"/><attribute name="svg:x"><ref name="coordinate"/></attribute><attribute name="svg:y"><ref name="coordinate"/></attribute><attribute name="svg:width"><ref name="length"/></attribute><attribute name="svg:height"><ref name="length"/></attribute><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional></element></define>

Circular Image Map Areas
The <draw:area-circle> element describes a circular image map area. The additional
attributes for circular image maps are described below in the common attributes section.
The required attributes svg:cx and svg:cy specify the center point of the circle. The required
svg:r attribute specifies the radius of the circle.
The attributes described in section 9.3.10:Common Image Map Attributes and Elements are
optional.
7186
7187
7188
7189
7190
7191
7192

<define name="draw-area-circle"><element name="draw:area-circle"><ref name="common-draw-area-attlist"/><attribute name="svg:cx"><ref name="coordinate"/></attribute><attribute name="svg:cy">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 324 of 738

7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208

<ref name="coordinate"/></attribute><attribute name="svg:r"><ref name="length"/></attribute><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional></element></define>

Polygonal Image Map Areas
The <draw:area-polygon> element describes a polygonal image map area. A polygonal
image map area is comprised of the following components:•

A bounding box.
The bounding box, which is represented in the same way as a rectangular image map area
using the svg:x, svg:y, svg:width, and svg:height attributes, establishes the reference
frame for the view box and the polygon point sequence. The reference frame enables thecoordinates to be translated into absolute coordinates.

•

A view box.
The view box attribute svg:viewBox establishes a coordinate system for the point
sequence. The view box obviates the need to record every point of the point sequence as
absolute coordinates with length and unit of measurement.

•

A sequence of points in view box coordinates in the svg:points attribute.

For more information about how to represent polygons, see section 9.2.4.
The attributes above are required. The attributes described in section 9.3.10:Common Image Map
Attributes and Elements are optional.
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229

<define name="draw-area-polygon"><element name="draw:area-polygon"><ref name="common-draw-area-attlist"/><attribute name="svg:x"><ref name="coordinate"/></attribute><attribute name="svg:y"><ref name="coordinate"/></attribute><attribute name="svg:width"><ref name="length"/></attribute><attribute name="svg:height"><ref name="length"/></attribute><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-points-attlist"/><optional><ref name="svg-title"/></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 325 of 738

7230
7231
7232
7233
7234
7235
7236

<ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional></element></define>

Example: Polygonal image map area
The element shown in the following example defines a triangle that is located in the middle of a
2cm by 2cm image. The bounding box covers an area of 2cm by 1.5cm. One view box unit
corresponds to 0.01mm.
<draw:area-polygon ...
svg:x="0" svg:y="0" svg:width="2.0cm" svg:height="2.0cm"
svg:viewBox="0 0 2000 2000"
svg:points="400,1500 1600,1500 1000,400"/>

Common Image Map Attributes and Elements
In addition to the shape attributes, each image map element can contain the following information:•

Link, including a IRI and link target frame.

•

Name.

•

Inactive flag.

•

Title (short accessible name). Use the <svg:title> child element as described in section
9.2.20.

•Long description (in support of accessibility). Use the <svg:desc> child element as
described in section 9.2.20.

•

Events associated with the area. Use the <office:event-listeners> child element as
described in section 12.4.

Other attributes of the image maps are taken from the HTML image map representation.
Each image map element identifies a hyperlink and uses the [XLink] href, type, and show
attributes, and the office:target-frame-name attribute to describe the link.
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255

<define name="common-draw-area-attlist" combine="interleave"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></optional><optional><attribute name="xlink:type" a:defaultValue="simple"><choice><value>simple</value></choice></attribute></optional><optional><attribute name="office:target-frame-name"><ref name="targetFrameName"/></attribute></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 326 of 738

7256
7257
7258
7259
7260
7261
7262
7263

<attribute name="xlink:show"><choice><value>new</value><value>replace</value></choice></attribute></optional></define>

The office:name attribute assigns a name to each image map element.
7264
7265
7266
7267
7268
7269
7270

<define name="common-draw-area-attlist" combine="interleave"><optional><attribute name="office:name"><ref name="string"/></attribute></optional></define>

The draw:nohref attribute declares that the image map element and the associated area isinactive. The IRI that is contained in the image map element is not used.
7271
7272
7273
7274
7275
7276
7277
7278
7279

<define name="common-draw-area-attlist" combine="interleave"><optional><attribute name="draw:nohref"><choice><value>nohref</value></choice></attribute></optional></define>

9.4 3D Shapes
9.4.1 Scene
The <dr3d:scene> element is the only element that can contain three-dimensional shapes. A
scene is like a group, but it also defines the projection, lighting, and other render details for the
shapes inside the scene.
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300

<define name="dr3d-scene"><element name="dr3d:scene"><ref name="dr3d-scene-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-text-spreadsheet-shape-attlist"/><ref name="common-dr3d-transform-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><zeroOrMore><ref name="dr3d-light"/></zeroOrMore>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 327 of 738

7301
7302
7303
7304
7305

<zeroOrMore><ref name="shapes3d"/></zeroOrMore></element></define>

7306
7307
7308
7309
7310
7311
7312
7313
7314
7315

<define name="shapes3d"><choice><ref name="dr3d-scene"/><ref name="dr3d-extrude"/><ref name="dr3d-sphere"/><ref name="dr3d-rotate"/><ref name="dr3d-cube"/></choice></define>

The attributes that may be associated with the <dr3d:scene> element are:•

Position, Size, Style, Layer, Z-Index, ID and Caption ID – see section 9.2.15•

Text anchor, table background, draw end position – see section 9.2.16•

Camera vectors•

Projection•

Distance•

Focal length•

Shadow slant•

Shade mode•

Ambient color•

Lighting mode

The elements that may be contained in the <dr3d:scene> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Light – see section 9.4.2.

•

Scene – see section 9.4.1.

•

Extrude – see section 9.4.5.

•

Sphere – see section 9.4.4.

•

Rotate – see section 9.4.6.

•

Cube – see section 9.4.3.

Camera Vectors
The camera vectors define a viewing volume. The dr3d:vrp attribute specifies the origin, thedr3d:vpn attribute points towards the projected objects, and the dr3d:vup attribute defines theup vector.
7316<define name="dr3d-scene-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 328 of 738

7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332

<optional><attribute name="dr3d:vrp"><ref name="vector3D"/></attribute></optional><optional><attribute name="dr3d:vpn"><ref name="vector3D"/></attribute></optional><optional><attribute name="dr3d:vup"><ref name="vector3D"/></attribute></optional></define>

Projection
The dr3d:projection attribute specifies the projection. The projection can be perspective orparallel. In perspective mode, objects become smaller in the distance.
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:projection"><choice><value>parallel</value><value>perspective</value></choice></attribute></optional></define>

Distance
The dr3d:distance attribute specifies the distance between the camera and the object.
7343
7344
7345
7346
7347
7348
7349

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:distance"><ref name="length"/></attribute></optional></define>

Focal Length
The dr3d:focal-length attribute specifies the length of the focus for the virtual camera of thisscene.
7350
7351
7352
7353
7354
7355
7356

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:focal-length"><ref name="length"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 329 of 738

Shadow Slant
The dr3d:shadow-slant attribute defines the angle from the three-dimensional scene to a
virtual paper on which the shadow is cast.
7357
7358
7359
7360
7361
7362
7363

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:shadow-slant"><ref name="nonNegativeInteger"/></attribute></optional></define>

Shade Mode
The shade mode defines how the lighting is calculated for rendered surfaces

7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375

•

flat: lighting is calculated by one surface normal.

•phong: lighting is calculated by interpolating the surface normals over the surface.

•gouraud: lighting is calculated by interpolating the color calculated with the surface normals
at each edge.

•

draft: surfaces are not lit and drawn as wireframe only.

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:shade-mode"><choice><value>flat</value><value>phong</value><value>gouraud</value><value>draft</value></choice></attribute></optional></define>

Ambient Color
The dr3d:ambient-color attribute specifies the color for ambient light. Ambient light is thatlight that seems to come from all directions.
7376
7377
7378
7379
7380
7381
7382

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:ambient-color"><ref name="color"/></attribute></optional></define>

Lighting Mode
The attribute dr3d:lighting-mode enables or disables the use of lighting in the threedimensional scene.
7383
7384
7385

<define name="dr3d-scene-attlist" combine="interleave"><optional><attribute name="dr3d:lighting-mode">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 330 of 738

7386
7387
7388
7389

<ref name="boolean"/></attribute></optional></define>

3D Transformation
The value of the dr3d:transform attribute is a list of transform definitions, which are applied in
the order provided. The individual transform definitions are separated by whitespace. The
available types of transform definitions include:

7390
7391
7392
7393
7394

•

matrix (<a> <b> <c> <d> <e> <f> <g> <h> <i> <j> <k> <l>), which specifies atransformation in the form of a transformation matrix of six values. matrix(a,b,c,d,e,f,g,h,i,j,k,l)
is equivalent to applying the transformation matrix [a b c d e f g h i j k l].

•translate (<tx> <ty> <tz>), which specifies a translation by tx, ty and tz.

•

scale (<sx> <sy> <sz>), which specifies a scale operation by sx, sy and sz.

•

rotatex (<rotate-angle> ), which specifies a rotation by <rotate-angle> degrees along
the x-axis.

•

rotatey (<rotate-angle> ), which specifies a rotation by <rotate-angle> degrees along
the y-axis.

•

rotatez (<rotate-angle> ), which specifies a rotation by <rotate-angle> degrees along
the y-axis.

<define name="common-dr3d-transform-attlist"><optional><attribute name="dr3d:transform"/></optional></define>

9.4.2 Light
The <dr3d:light> element represents a light inside a scene.
This element must be the first element contained in a <dr3d:scene> element. There may be
several lights, but applications may only support a limited number per scene. A typical limitation
are 8 lights per scene.
7395
7396
7397
7398
7399
7400

<define name="dr3d-light"><element name="dr3d:light"><ref name="dr3d-light-attlist"/><empty/></element></define>

The attributes that may be associated with the <dr3d:light> element are:•Diffuse color•

Direction•

Enabled•Specular

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 331 of 738

Diffuse Color
The dr3d:diffuse-color attribute specifies the base color that the light is emitting.
7401
7402
7403
7404
7405
7406
7407

<define name="dr3d-light-attlist" combine="interleave"><optional><attribute name="dr3d:diffuse-color"><ref name="color"/></attribute></optional></define>

Direction
The dr3d:direction attribute specifies the direction in which the light is emitted.
7408
7409
7410
7411
7412

<define name="dr3d-light-attlist" combine="interleave"><attribute name="dr3d:direction"><ref name="vector3D"/></attribute></define>

EnabledThe dr3d:enabled attribute specifies whether or not the light is enabled. If a light is not enabled,
it does not emit any light.
7413
7414
7415
7416
7417
7418
7419

<define name="dr3d-light-attlist" combine="interleave"><optional><attribute name="dr3d:enabled"><ref name="boolean"/></attribute></optional></define>

Specular
The dr3d:specular attribute specifies whether or not the light causes a specular reflection on
the objects. Applications may evaluate this attribute only for the first light in a scene.
7420
7421
7422
7423
7424
7425
7426

<define name="dr3d-light-attlist" combine="interleave"><optional><attribute name="dr3d:specular"><ref name="boolean"/></attribute></optional></define>

9.4.3 Cube
The <dr3d:cube> element represents a three-dimensional cube shape.
7427
7428
7429
7430
7431
7432
7433

<define name="dr3d-cube"><element name="dr3d:cube"><ref name="dr3d-cube-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-draw-style-name-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 332 of 738

7434
7435
7436
7437

<ref name="common-dr3d-transform-attlist"/><empty/></element></define>

The attributes that may be associated with the <dr3d:cube> element are:•Style, Layer, Z-Index and ID – see section 9.2.15•

Minimum and Maximum Edge

Minimum and Maximum Edge
The attributes dr3d:min-edge and dr3d:max-edge specify the minimum and maximum edgeof the cube in a 3D space.
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449

<define name="dr3d-cube-attlist" combine="interleave"><optional><attribute name="dr3d:min-edge"><ref name="vector3D"/></attribute></optional><optional><attribute name="dr3d:max-edge"><ref name="vector3D"/></attribute></optional></define>

9.4.4 Sphere
The <dr3d:sphere> element represents a three-dimensional sphere shape.
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460

<define name="dr3d-sphere"><element name="dr3d:sphere"><ref name="dr3d-sphere-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-dr3d-transform-attlist"/><empty/></element></define>

The attributes that may be associated with the <dr3d:sphere> element are:•Style, Layer, Z-Index, and ID – see section 9.2.15•

Center•Size

Center
The dr3d:center attribute defines the center of the sphere in a three-dimensional space.
7461
7462
7463

<define name="dr3d-sphere-attlist" combine="interleave"><optional><attribute name="dr3d:center">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 333 of 738

7464
7465
7466
7467

<ref name="vector3D"/></attribute></optional></define>Size
The dr3d:size attribute defines the size of the sphere in a three-dimensional space.
7468
7469
7470
7471
7472
7473
7474

<define name="dr3d-sphere-attlist" combine="interleave"><optional><attribute name="dr3d:size"><ref name="vector3D"/></attribute></optional></define>

9.4.5 Extrude
The <dr3d:extrude> element represents a three-dimensional extrude based on a polygon.
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486

<define name="dr3d-extrude"><element name="dr3d:extrude"><ref name="common-draw-path-data-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-dr3d-transform-attlist"/><empty/></element></define>

The attributes that may be associated with the <dr3d:extrude> element are:•Viewbox, Style, Layer, Z-Index, and ID – see section 9.2.15•

Path Data – see section 9.2.6

9.4.6 Rotate
The <dr3d:rotate> element represents a three-dimensional rotation shape based on apolygon.
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498

<define name="dr3d-rotate"><element name="dr3d:rotate"><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-path-data-attlist"/><ref name="common-draw-z-index-attlist"/><ref name="common-draw-id-attlist"/><ref name="common-draw-layer-name-attlist"/><ref name="common-draw-style-name-attlist"/><ref name="common-dr3d-transform-attlist"/><empty/></element></define>

The attributes that may be associated with the <dr3d:rotate> element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 334 of 738

•

Viewbox, Style, Layer, Z-Index, and ID – see section 9.2.15•

Path Data – see section 9.2.6

9.5 Custom Shape
A <draw:custom-shape> represents a shape that is capable of rendering complex figures. It is
offering font work and extrusion functionality. A custom shape may have a geometry that
influences its shape. This geometry may be visualized in office application user interfaces, forinstance by displaying interaction handles, that provide a simple way to modify the the geometry.
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523

<define name="draw-custom-shape"><element name="draw:custom-shape"><ref name="draw-custom-shape-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><ref name="common-draw-caption-id-attlist"/><optional><ref name="svg-title"/></optional><optional><ref name="svg-desc"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><ref name="draw-glue-point"/></zeroOrMore><ref name="draw-text"/><optional><ref name="draw-enhanced-geometry"/></optional></element></define>

The attributes that may be associated with the <draw:custom shape> element are:•

Position, Size, Style, Layer, Z-Index, ID, Caption ID and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16.

•

Draw engine•

Draw data

The elements that may be contained in the <draw:custom-shape> element are:•Title (short accessible name) – see section 9.2.20.

•

Long description (in support of accessibility) – see section 9.2.20.

•

Event listeners – see section 9.2.21.

•

Glue points – see section 9.2.19.

•

Text – see section 9.2.17.

•

Enhanced geometry – see section 9.5.1,

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 335 of 738

Draw Engine
The optional draw:engine attribute specifies the name of a rendering engine that can be used
to render the custom shape. The attribute's value is a namespaced token, meaning an identifier
prefixed by an XML namespace prefix, just like any attribute or element name in this specification.
The drawing engine may get its data either from the draw:data attribute, or it may evaluate the<draw:enhanced-geometry> child element.
If the draw:engine attribute is omitted, the office application's default enhanced custom shaperendering engine will be used. This engine gets its geometry data from the <draw:enhancedgeometry> element only.
7524
7525
7526
7527
7528
7529
7530

<define name="draw-custom-shape-attlist" combine="interleave"><optional><attribute name="draw:engine"><ref name="namespacedToken"/></attribute></optional></define>

Draw Data
The draw:data attribute contains rendering engine specific data that describes the geometry of
the custom shape. This attribute is only evaluated if a non default rendering engine is specified by
the draw:engine attribute.
7531
7532
7533
7534
7535
7536
7537

<define name="draw-custom-shape-attlist" combine="interleave"><optional><attribute name="draw:data"><ref name="string"/></attribute></optional></define>

9.5.1 Enhanced Geometry
The <draw:enhanced-geometry> element contains the geometry for a <draw:customshape> element if its draw:engine attribute has been omitted.
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548

<define name="draw-enhanced-geometry"><element name="draw:enhanced-geometry"><ref name="draw-enhanced-geometry-attlist"/><zeroOrMore><ref name="draw-equation"/></zeroOrMore><zeroOrMore><ref name="draw-handle"/></zeroOrMore></element></define>

The attributes that may be associated with the <draw:enhanced-geometry> element are
•

Type

•

View Box•

Mirror•Text Rotate Angle

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 336 of 738

•

Extrusion Allowed•

Text Path Allowed•

Concentric Gradient Fill Allowed•

Enhanced Geometry - Extrusion Attributes (see section 9.5.2)•

Enhanced Geometry - Path Attributes (see section 9.5.3)•

Enhanced Geometry - Text Path Attributes (see section 9.5.4)•

Enhanced Geometry - Equation (see section 9.5.5)•

Enhanced Geometry - Handle Attributes (see section 9.5.6)

Type
The draw:type attribute contains the name of a shape type. This name can be used to offer
specialized user interfaces for certain classes of shapes, like for arrows, smileys, etc.
The shape type is rendering engine dependent and does not influence the geometry of the shape.
If the value of the draw:type attribute is non-primitive, then no shape type is available.
7549
7550
7551
7552
7553
7554
7555

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:type" a:defaultValue="non-primitive"><ref name="custom-shape-type"/></attribute></optional></define>

7556
7557
7558
7559
7560
7561
7562

<define name="custom-shape-type"><choice><value>non-primitive</value><ref name="string"/></choice></define>

View Box
The svg:viewBox attribute establishes a user coordinate system inside the physical coordinate
system of the shape specified by the position and size attributes. This user coordinate system isused by the <draw:enhanced-path> element.
The syntax for using this attribute is the same as the [SVG] syntax. The value of the attribute are
four numbers separated by white spaces, which define the left, top, right, and bottom dimensionsof the user coordinate system.
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="svg:viewBox"><list><ref name="integer"/><ref name="integer"/><ref name="integer"/><ref name="integer"/></list></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 337 of 738

MirrorThe draw:mirror-vertical and draw:mirror-horizontal attributes specify if thegeometry of the shape is to be mirrored.
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:mirror-vertical" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="draw:mirror-horizontal" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Text Rotate Angle
The draw:text-rotate-angle attribute specifies the angle by which the text within the custom
shape is rotated in addition to the rotation included in the shape's draw:transform attribute.
7587
7588
7589
7590
7591
7592
7593

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-rotate-angle" a:defaultValue="0"><ref name="double"/></attribute></optional></define>

Extrusion Allowed
The draw:extrusion-allowed attribute specifies whether the shape is capable to be rendered
as extrusion object.
7594
7595
7596
7597
7598
7599
7600

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-allowed" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Text Path Allowed
The draw:text-path-allowed attribute specifies if the shape is capable of being rendered as
Fontwork object. The text of a Fontwork object is distinguished from normal text objects by being
able to render text along or between lines that are specified by the draw:enhanced-path
attribute. Fontwork objects are capable to support standard graphic attributes such as fill, shadow
and or line styles.
7601
7602
7603
7604
7605
7606
7607

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-path-allowed" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 338 of 738

Concentric Gradient Fill Allowed
The draw:concentric-gradient-fill-allowed attribute specifies if the shape is capable
being rendered with a concentric gradient that uses the custom shape path.
7608
7609
7610
7611
7612
7613
7614
7615

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:concentric-gradient-fill-allowed"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

9.5.2 Enhanced Geometry - Extrusion Attributes
Extrusion
The draw:extrusion attribute determines if an extrusion is displayed.
7616
7617
7618
7619
7620
7621
7622

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Extrusion Brightness
The draw:extrusion-brightness attribute specifies the brightness of a scene.
7623
7624
7625
7626
7627
7628

7629

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-brightness" a:defaultValue="33%"><ref name="percent"/></attribute></optional></define>

Extrusion Depth
The draw:extrusion-depth attribute specifies the depth of the extrusion. It takes two space
separated values. The first value specifies the depth of the extrusion, the second value specifies
the fraction of the extrusion that lies before the shape. It must be in the range [0,1]. A value of 0 is
default.
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-depth" a:defaultValue="36pt 0"><list><ref name="length"/><ref name="double"/></list></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 339 of 738

Extrusion Diffusion
The amount of diffusion reflected by the shape is specified by the draw:extrusiondiffusion attribute.
7640
7641
7642
7643
7644
7645
7646

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-diffusion" a:defaultValue="0%"><ref name="percent"/></attribute></optional></define>

Extrusion Number Of Line Segments
The draw:extrusion-number-of-line-segments attribute specifies the number of line
segments that should be used to display curved surfaces. The higher the number the more line
segments are used.
7647
7648
7649
7650
7651
7652
7653
7654

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-number-of-line-segments"
a:defaultValue="30"><ref name="integer"/></attribute></optional></define>

Extrusion Light Face
The draw:extrusion-light-face attribute specifies if the front face of the extrusion
responds to lightning changes.
7655
7656
7657
7658
7659
7660
7661

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-light-face" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Extrusion First Light Harsh
The draw:extrusion-first-light-harsh attribute specifies if the primary light is harsh.
7662
7663
7664
7665
7666
7667
7668
7669

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-first-light-harsh"
a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Extrusion Second Light Harsh
The draw:extrusion-second-light-harsh attribute specifies if the secondary light isharsh.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 340 of 738

7670
7671
7672
7673
7674
7675
7676
7677

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-second-light-harsh"
a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Extrusion First Light Level
The draw:extrusion-first-light-level attribute specifies the intensity for the first light.
7678
7679
7680
7681
7682
7683
7684
7685

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-first-light-level"a:defaultValue="66%"><ref name="percent"/></attribute></optional></define>

Extrusion Second Light Level
The draw:extrusion-second-light-level attribute specifies the intensity for the second
light.
7686
7687
7688
7689
7690
7691
7692
7693

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-second-light-level"a:defaultValue="66%"><ref name="percent"/></attribute></optional></define>

Extrusion First Light Direction
The draw:extrusion-first-light-direction attribute specifies the direction of the firstlight.
7694
7695
7696
7697
7698
7699
7700
7701

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-first-light-direction"
a:defaultValue="(5 0 1)">
<ref name="vector3D"/></attribute></optional></define>

Extrusion Second Light Direction
The draw:extrusion-second-light-direction attribute specifies the direction of thesecond light.
7702
7703
7704
7705

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-second-light-direction"
a:defaultValue="(-5 0 1)">OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 341 of 738

7706
7707
7708
7709

<ref name="vector3D"/></attribute></optional></define>

Extrusion Metal
The draw:extrusion-metal attribute specifies if the surface of the extrusion object looks likemetal.
7710
7711
7712
7713
7714
7715
7716

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-metal" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Extrusion Shade Mode
The dr3d:shade-mode attribute defines how the lighting is calculated for rendered surfaces

7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728

•

flat: lighting is calculated by one surface normal.

•phong: lighting is calculated by interpolating the surface normals over the surface.

•gouraud: lighting is calculated by interpolating the color calculated with the surface normals
at each edge.

•

draft: surfaces are not lit and drawn as wireframe only.

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="dr3d:shade-mode" a:defaultValue="flat"><choice><value>flat</value><value>phong</value><value>gouraud</value><value>draft</value></choice></attribute></optional></define>

Extrusion Rotation Angle
The first value of the draw:extrusion-rotation-angle specifies the rotation about the xaxis. The second value of the draw:extrusion-rotation-angle specifies the rotation
about the y-axis. The rotation about the z-axis is specified by the rotate angle of thedraw:transform attribute.
The order of the rotation is: z-axis, y-axis and then x-axis.
7729
7730
7731
7732
7733
7734
7735

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-rotation-angle" a:defaultValue="0 0"><list><ref name="double"/><ref name="double"/></list>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 342 of 738

7736
7737
7738

</attribute></optional></define>

Extrusion Rotation Center
The draw:extrusion-rotation-center attribute specifies the position of the rotation centerin terms of shape size fractions, if it is omitted then the geometrical center of the shape is used.
7739
7740
7741
7742
7743
7744
7745

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-rotation-center"><ref name="vector3D"/></attribute></optional></define>

Extrusion Shininess
The draw:extrusion-shininess attribute specifies the shininess of a mirror.
7746
7747
7748
7749
7750
7751
7752

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-shininess" a:defaultValue="50%"><ref name="percent"/></attribute></optional></define>

Extrusion Skew
The draw:extrusion-skew attribute specifies the skew amount and skew angle of an
extrusion. Skew settings are only applied if the attribute dr3d:projection has the value
parallel.
The first parameter represents the skew amount in percent, the second parameter specifies the
skew angle.
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-skew" a:defaultValue="50 45">
<list><ref name="double"/><ref name="double"/></list></attribute></optional></define>

Extrusion Specularity
The draw:extrusion-specularity attribute specifies the specularity of an extrusion object.
7763
7764
7765
7766
7767
7768

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-specularity" a:defaultValue="0%"><ref name="percent"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 343 of 738

7769</define>

Extrusion Projection Mode
The dr3d:projection attribute specifies if the projection mode is perspective or parallel.
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="dr3d:projection" a:defaultValue="parallel"><choice><value>parallel</value><value>perspective</value></choice></attribute></optional></define>

Extrusion Viewpoint
The draw:extrusion-viewpoint attribute specifies the viewpoint of the observer as an 3D
point. The attribute's value syntax is similar to vector3D, solely a unit is following each parameter.
An example for a 3D point is: “(1cm 1cm 0m)”.
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790

7791

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-viewpoint"
a:defaultValue="3.5cm -3.5cm 25cm"><ref name="point3D"/></attribute></optional></define><define name="point3D"><data type="string"/></define>

Extrusion Origin
The draw:extrusion-origin attributes specifies the origin within the bounding box of the
shape in terms of the shape size fractions.
The first parameter represents the horizontal origin, a value of -0.5 represents the left side of the
shape, a value of 0 represents the center of the shape, a value of 0.5 represents the right side of
the shape.
The second parameter represents the vertical origin, a value of -0.5 represents the top side of the
shape, a value of 0 represents the center of the shape, a value of 0.5 represents the bottom sideof the shape.
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-origin" a:defaultValue="0.5 -0.5"><list><ref name="double"/><ref name="double"/></list></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 344 of 738

Extrusion Color
The draw:extrusion-color attribute specifies if an extrusion color is used. The extrusion
color is then defined by the draw:secondary-fill-color attribute specified in the custom
shape's graphic style.
7802
7803
7804
7805
7806
7807
7808

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:extrusion-color" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

9.5.3 Enhanced Geometry - Path Attributes
Enhanced Path
The draw:enhanced-path attribute specifies a path similar to the svg:d attribute of the<svg:path> element. Instructions such as moveto, lineto, arcto and other instructions
together with its parameter are describing the geometry of a shape which can be filled and or
stroked. Relative commands are not supported.
The syntax of draw:enhanced-path attribute is as follows:•

Instructions are expressed as one character (e.g., a moveto is expressed as an M).

•

A prefix notation is being used, that means that each command is followed by its parameter.

•

Superfluous white space and separators such as commas can be eliminated. (e.g., “M 10 10
L 20 20 L 30 20” can also be written: “M10 10L20 20L30 20”•

If the command is repeated multiple times, only the first command is required. (e.g., “M 10 10
L 20 20 L 30 20” can also be expressed as followed “M 10 10 L 20 20 30 20”•

Floats can be used, therefore the only allowable decimal point is a dot (“.”)

The above mentioned rules are the same as specified for the <svg:path> element.
A parameter can also have one of the following enhancements:•

A “?” is used to mark the beginning of a formula name. The result of the element's
draw:formula attribute is used as parameter value in this case.

•

If “$” is preceding a integer value, the value is indexing a draw:modifiers attribute. The
corresponding modifier value is used as parameter value then.

Following notation is used in the table below:•(): grouping of parameters•+: 1 or more of the given parameter(s) is required

Example for a custom-shape that uses the draw:enhanced-path to describe a pie-chart whose top
right quarter segment is taken out:
<draw:custom-shape
svg:width="10cm" svg:height="10cm" svg:x="0cm" svg:y="0cm"><draw:enhanced-geometry svg:viewBox="0 0 10 10"
draw:enhanced-path="V 0 0 10 10 10 5 5 0 L 5 5 Z N">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 345 of 738

</draw:enhanced-geometry></draw:custom-shape>

The following commands are supported:
CommandName

Parameters

Description

M

moveto(x y) +Start a new sub-path at the given (x,y)
coordinate. If a moveto is followed by multiple
pairs of coordinates, they are treated as lineto.

Llineto(x y) +

Draws a line from the current point to (x, y). If
multiple coordinate pairs are following, they
are all interpreted as lineto.

Ccurveto(x1 y1 x2 y2 x y) +Draws a cubic Bézier curve from the current
point to (x,y) using (x1,y1) as the control pointat the beginning of the curve and (x2,y2) as
the control point at the end of the curve.

Z

closepath (none)

Close the current sub-path by drawing astraight line from the current point to current
sub-path's initial point.

N

endpath(none)

Ends the current set of sub-paths. The subpaths will be filled by using the “even-odd”
filling rule. Other following subpaths will befilled independently.

F

nofill(none)

Specifies that the current set of sub-paths
won't be filled.

S

nostroke(none)

Specifies that the current set of sub-paths
won't be stroked.

Tangleellipseto(x y w h t0 t1) +Draws a segment of an ellipse. The ellipse isspecified by the center(x, y), the size(w, h) andthe start-angle t0 and end-angle t1.

Uangleellipse(x y w h t0 t1) +The same as the “T” command, except that a
implied moveto to the starting point is done.

A

arcto

(x1 y1 x2 y2 x3 y3 x y) + (x1, y1) and (x2, y2) is defining the boundingbox of a ellipse. A line is then drawn from thecurrent point to the start angle of the arc that is
specified by the radial vector of point (x3, y3)
and then counter clockwise to the end-angle
that is specified by point (x4, y4).

Barc

(x1 y1 x2 y2 x3 y3 x y) + The same as the “A” command, except that a
implied moveto to the starting point is done.

Wclockwis
earcto(x1 y1 x2 y2 x3 y3 x y) + The same as the “A” command except, thatthe arc is drawn clockwise.

V

clockwisearc(x1 y1 x2 y2 x3 y3 x y)+ The same as the “A” command, except that a
implied moveto to the starting point is done
and the arc is drawn clockwise.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 346 of 738

Command

7809
7810
7811
7812
7813
7814
7815

Name

Parameters

DescriptionXelliptical- (x y) +quatrantx

Draws a quarter ellipse, whose initial segment
is tangential to the x-axis, is drawn from thecurrent point to (x, y).

Yelliptical- (x y) +quadranty

Draws a quarter ellipse, whose initial segment
is tangential to the y-axis, is drawn from thecurrent point to (x, y).

Q

quadratic- (x1 y1 x y)+
curvetoDraws a quadratic Bézier curve from thecurrent point to (x, y) using (x1, y1) as thecontrol point. (x, y) becomes the new current
point at the end of the command.

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:enhanced-path"><ref name="string"/></attribute></optional></define>

Path Stretchpoint
The draw:path-stretchpoint-x and draw:path-stretchpoint-y attributes specifies
the stretchpoint of a shape.
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:path-stretchpoint-x" a:defaultValue="0"><ref name="double"/></attribute></optional><optional><attribute name="draw:path-stretchpoint-y" a:defaultValue="0"><ref name="double"/></attribute></optional></define>

Text Areas
The draw:text-areas attribute specifies a list of text areas. The text area is used to position
and align the text. If no text area is omitted, the area of the shape itself is used. If a second text
area is available it is used for vertical text.
An area consists of four parameters:
The first parameter specifies the left side of the text area.
The second parameter specifies the top side of the text area.
The third parameter specifies the right side of the text area.
The fourth parameter specifies the bottom side of the text area.
A parameter can also have one of the following enhancements:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 347 of 738

•

A “?” is used to mark the beginning of a formula name. The result of the element's
draw:formula attribute is used as parameter value in this case.

•

If “$” is preceding a integer value, the value is a indexing a draw:modifiers attribute. The
corresponding modifier value is used as parameter value then.

A example of the draw:text-areas attribute that defines two text areas, including modifier andequation usage, would be: draw:text-areas=”0 0 100 100 ?Formula1 $1 200 200”
7828
7829
7830
7831
7832
7833
7834

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-areas"><ref name="string"/></attribute></optional></define>

Glue Points
The draw:glue-points attribute specifies a list of object defined glue points. In contradiction to
the user defined glue points which are defined by the <draw:glue-point> sub-element, theobject defined glue point can make use of equations and modifiers.
The first parameter specifies the horizontal position of the glue point.
The second parameter specifies the vertical position of the glue point.
Each parameter can be a float, or it can also have one of the following enhancements:•

A “?” is used to mark the beginning of a formula name. The result of the element's
draw:formula attribute is used as parameter value in this case.

•

If “$” is preceding a integer value, the value is a indexing a draw:modifiers attribute. The
corresponding modifier value is used as parameter value then.

A example of the draw:glue-points attribute that defines two glue points, including modifier andequation usage, would be: draw:glue-points=”0 ?Formula1 100 $1”
7835
7836
7837
7838
7839
7840
7841

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:glue-points"><ref name="string"/></attribute></optional></define>

Glue Point TypeThe draw:glue-point-type attribute specifies the glue-point type. If the draw:glue-points
attribute is also available this attribute is ignored.

7842
7843

•

none: there are no special object glue points.

•

segments: a connector will connect with each point of the draw:enhanced-path
attribute•

rectangle: the middle of each side of the shape bound rectangle specifies a object specificglue point<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 348 of 738

7844
7845
7846
7847
7848
7849
7850
7851
7852

<attribute name="draw:glue-point-type" a:defaultValue="none"><choice><value>none</value><value>segments</value><value>rectangle</value></choice></attribute></optional></define>

Glue Point Leaving Directions
The draw:glue-point-leaving-directions attribute is containing a comma separated listof angles in grad. The angle can be a float value. The position in the list is the same as the to bereferenced glue-point of the draw:glue-points attribute.
7853
7854
7855
7856
7857

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:glue-point-leaving-directions"/></optional></define>

9.5.4 Enhanced Geometry - Text Path Attributes
Text Path
The draw:text-path attribute specifies if text is displayed on a text path.
7858
7859
7860
7861
7862
7863
7864

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-path" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Text Path Mode
The draw:text-path-mode attribute specifies how the text is drawn.

7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875

•

normal: the text is drawn along the path without scaling.

•

path: the text is fit to the path.

•shape: the text is fit to the bounding box of the shape.

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-path-mode" a:defaultValue="normal"><choice><value>normal</value><value>path</value><value>shape</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 349 of 738

Text Path Scale
The draw:text-path-scale attribute specifies the scaling of the text path.

7876
7877
7878
7879
7880
7881
7882
7883
7884
7885

•

path: The text scaling is determined by the length of the path from the draw:enhancedpath attribute.

•shape: The text scaling is determined by the width of a shape.

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-path-scale" a:defaultValue="path"><choice><value>path</value><value>shape</value></choice></attribute></optional></define>

Text Path Same Letter Heights
The draw:text-path-same-letter-heights attribute specifies if all letters in the custom
shape will have the same height.
7886
7887
7888
7889
7890
7891
7892
7893

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:text-path-same-letter-heights"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Modifiers
The draw:modifiers attribute contains list of modifier values. The modifier can be a float value.
In the majority of cases, the draw:modifiers attribute is being used by the draw:handleposition attribute to store the handle position.
7894
7895
7896
7897
7898
7899
7900

<define name="draw-enhanced-geometry-attlist" combine="interleave"><optional><attribute name="draw:modifiers"><ref name="string"/></attribute></optional></define>

9.5.5 Enhanced Geometry – Equation
Equation
The <draw:equation> element can be referenced by handles, text areas, glue points andenhanced paths to calculate values which are dependent to modifier values. Due to the fact thatmodifier values may changed by interaction it is a convenient way to integrate dynamic values into
the shape geometry.
7901<define name="draw-equation">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 350 of 738

7902
7903
7904
7905
7906

<element name="draw:equation"><ref name="draw-equation-attlist"/><empty/></element></define>

Name
The draw:name attribute specifies the name of the equation. The name is not allowed to include
spaces.
7907
7908
7909
7910
7911
7912
7913

<define name="draw-equation-attlist" combine="interleave"><optional><attribute name="draw:name"><ref name="string"/></attribute></optional></define>

FormulaThe draw:formula attribute specifies an equation that should be used to evaluate a value. A
formula can make use of other formulas or modifier values by function and or modifier reference.
number_digit = '0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'
number = number number_digit | number_digit
identifier = 'pi'|'left'|'top'|'right'|'bottom'|'xstretch'|'ystretch'|'hasstroke'|'hasfill'|'width'|'height'|'logwidth'|'logheight'
unary_function = 'abs'|'sqrt'|'sin'|'cos'|'tan'|'atan'|'atan2'
binary_function = 'min'|'max'
ternary_function = 'if'function_reference = '?' 'a-z,A-Z,0-9' ' 'modifier_reference = '$' '0-9' ' 'basic_expression =number |identifier |function_reference |modifier_reference |unary_function '(' additive_expression ')' |binary_function '(' additive_expression ',' additive_expression ')' |ternary_function '(' additive_expression ',' additive_expression ',' additive_expression ')' | '(' additive_expression ')'unary_expression = '-' basic_expression
multiplicative_expression =basic_expression |multiplicative_expression '*' basic_expression |multiplicative_expression '/' basic_expression
additive_expression =multiplicative_expression |additive_expression '+' multiplicative_expression |additive_expression '-' multiplicative_expression

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 351 of 738

identifier

Description

left

The left position of the svg:viewBox attribute has to be used.

top

The top position the svg:viewBox attribute has to be used.

right

The right position the svg:viewBox attribute has to be used.

bottomThe bottom position the svg:viewBox attribute has to be used.

xstretch

The value of draw:path-stretchpoint-x is used.

ystretch

The value of draw:path-stretchpoint-y is used.

hasstroke If the shape has a line style, a value of 1 is used.
hasfillIf the shape has a fill style, a value of 1 is used.

width

The width of the svg:viewBox is used.

height

The height of the svg:viewBox is used.

logwidth

The width of the svg:viewBox in 1/100th mm is used.

logheight

The height of the svg:viewBox in 1/100th mm is used.

A example for the draw:formula attribute would be: draw:formula=”width+10-$0” If the valueof the first modifier value is “100” and the width of the svg:viewbox is “10000”, then the result of
the above formula would be 10000 + 10 – 100 = 9910
7914
7915
7916
7917
7918
7919
7920

<define name="draw-equation-attlist" combine="interleave"><optional><attribute name="draw:formula"><ref name="string"/></attribute></optional></define>

9.5.6 Enhanced Geometry - Handle Attributes
HandleThe <draw:handle> element specifies a single interaction handle.
7921
7922
7923
7924
7925
7926

<define name="draw-handle"><element name="draw:handle"><ref name="draw-handle-attlist"/><empty/></element></define>

Handle Mirror Vertical
The draw:handle-mirror-vertical attribute specifies if the x position of the handle ismirrored.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 352 of 738

7927
7928
7929
7930
7931
7932
7933

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-mirror-vertical" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Handle Mirror Horizontal
The draw:handle-mirror-horizontal attribute specifies if the y position of the handle ismirrored.
7934
7935
7936
7937
7938
7939
7940

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-mirror-horizontal" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Handle Switched
The draw:handle-switched attribute specifies if the handle directions are swapped if the
shape height is higher than the shape width.
7941
7942
7943
7944
7945
7946
7947

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-switched" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Handle Position
The draw:handle-position attribute specifies the position of the handle and consists of
two parameters.
Each parameter can be a float or it can have one of the following enhancements:•

A “?” is used to mark the beginning of a formula name. The result of the element's
draw:formula attribute is used as parameter value in this case.

•

If “$” is preceding a integer value, the value is a indexing a draw:modifiers attribute. The
corresponding modifier value is used as parameter value then.

•Instead of a number a parameter can also be one of the following constants:
Constant

Descriptionleft

The value of the draw:coordinate-origin-x attribute has to be used.

top

The value of the draw:coordinate-origin-y attribute has to be used.

right

The value of the draw:coordinate-origin-x attribute + the value of thedraw:coordinate-width has to be used.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 353 of 738

ConstantDescription

bottomThe value of the draw:coordinate-origin-y attribute + the value of thedraw:coordinate-height has to be used.

xstretch

The value of draw:path-stretchpoint-x is used.

ystretch

The value of draw:path-stretchpoint-y is used.

hasstroke If the shape has a line style, a value of 1 is used.
hasfillIf the shape has a fill style, a value of 1 is used.

width

The width of the svg:viewBox is used.

height

The height of the svg:viewBox is used.

logwidth

The width of the svg:viewBox in 1/100th mm is used.

logheight The height of the svg:viewBox in 1/100th mm is used.
The draw:handle-position attribute specifies the position of the handle. If thedraw:handle-polar attribute is not set, the first parameter of the draw:handle-position
attribute specifies the horizontal handle position, the vertical handle position is described by thesecond parameter. If the draw:handle-polar attribute is set, then the handle is a polar handle
and the first parameter of the draw:handle-position attribute specifies the angle in grad, the handle
radius is specified by the second parameter. A example for the draw:handle-position
attribute is: draw:handle-position = "left $5"
7948
7949
7950
7951
7952

<define name="draw-handle-attlist" combine="interleave"><attribute name="draw:handle-position"><ref name="string"/></attribute></define>

Handle Range X Minimum
The draw:handle-range-x-minimum attribute specifies the horizontal minimum value of therange the handle can be moved within. The syntax for the attribute is the same as for the attributedraw:handle-position, except that only the first parameter is used. Example for this attributedeclaring a minimum value that results from the first formula equation: draw:handle-range-xminimum = ”?Formula1”
7953
7954
7955
7956
7957
7958
7959

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-range-x-minimum"><ref name="string"/></attribute></optional></define>

Handle Range X Maximum
The draw:handle-range-x-maximum attribute specifies the horizontal maximum value of therange the handle can be moved within. The syntax for the attribute is the same as for the attributedraw:handle-range-x-minimum.
7960<define name="draw-handle-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 354 of 738

7961
7962
7963
7964
7965
7966

<optional><attribute name="draw:handle-range-x-maximum"><ref name="string"/></attribute></optional></define>

Handle Range Y Minimum
The draw:handle-range-y-minimum attribute specifies the vertical minimum value of therange the handle can be moved within. The syntax for the attribute is the same as for the attributedraw:handle-range-x-minimum.
7967
7968
7969
7970
7971
7972
7973

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-range-y-minimum"><ref name="string"/></attribute></optional></define>

Handle Range Y Maximum
The draw:handle-range-y-maximum attribute specifies the vertical maximum value of therange the handle can be moved within. The syntax for the attribute is the same as for the attributedraw:handle-range-x-minimum.
7974
7975
7976
7977
7978
7979
7980

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-range-y-maximum"><ref name="string"/></attribute></optional></define>

Handle Polar
The draw:handle-polar attribute specifies that the handle is a polar handle. The syntax for
this attribute is the same as for the attribute draw:handle-position. The first parameter
specifies the horizontal center position, the vertical center position is specified by the second
parameter. If this attribute is set, the attributes draw:handle-range-x and draw:handlerange-y are ignored, instead the attributes draw:handle-radius-range-minimum anddraw:handle-radius-range-maximum can be used.
7981
7982
7983
7984
7985
7986
7987

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-polar"><ref name="string"/></attribute></optional></define>

Handle Radius Range Minimum
If the attribute draw:handle-radius-range-minimum is set, it specifies the minimum radius
range that can be used for a polar handle. The syntax is the same as for the attributedraw:handle-range-x-minimum.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 355 of 738

7988
7989
7990
7991
7992
7993
7994

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-radius-range-minimum"><ref name="string"/></attribute></optional></define>

Handle Radius Range Maximum
If the attribute draw:handle-radius-range-maximum is set, it specifies the maximum radius
range that can be used for a polar handle. The syntax is the same as for the attributedraw:handle-range-x-minimum.
7995
7996
7997
7998
7999
8000
8001

<define name="draw-handle-attlist" combine="interleave"><optional><attribute name="draw:handle-radius-range-maximum"><ref name="string"/></attribute></optional></define>

9.6 Presentation Shapes
Presentation shapes are special text box, image, object or thumbnail drawing shapes contained ina presentation. Presentation shapes use styles with a style family value of presentation, unlike
drawing shapes which use styles with a style family value of graphic. Presentation shapes canbe empty, acting only as placeholders. If a draw page's presentation layout (see section 14.15) ischanged, all presentation shapes are adapted automatically.
Standard drawing shapes can also be used in presentations. The presentation:classattribute distinguishes presentation shapes from drawing shapes. Unlike presentation shapes,
standard drawing shapes are not adapted if the presentation page layout is changed.

9.6.1 Common Presentation Shape Attributes
The attributes described in this section are common to all presentation shapes.

Style
Presentation shapes can have styles from the style family presentation assigned to them. A
presentation shape can be distinguished from a drawing shape by checking whether it has apresentation:style-name attribute. A drawing shape uses a draw:style-name attributewith a style from the graphic family, while a presentation shape uses apresentation:style-name attribute with a style from the presentation family. This namelinks to a <style:style> element with the family presentation. The formatting properties inthis style and its optional parent styles are used to format this shape. See also section 9.2.15.

Class
The presentation:class attribute classifies presentation shapes by their usage within a draw
page (for instance as title or outline). The following classes exist:•

title: Titles are standard text shapes.

•

outline: Outlines are standard text shapes.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 356 of 738

•subtitle: Subtitles are standard text shapes.

•

text: Presentation texts are standard text shapes.

•

graphic: Presentation graphics are standard graphic shapes•

object: Presentation objects are standard object shapes.

•

chart: Presentation charts are standard object shapes.

•

table: Presentation tables are standard object shapes.

•

orgchart: Presentation organization charts are standard object shapes.

•

page: Presentation pages are used on notes pages.

•

notes: Presentation notes are used on notes pages.

•

handout: Presentation handouts are placeholder for the drawing page in a handout page.

The next four classes can be used only for drawing shapes that are contained in master pages.
Depending on the settings of the page (see section 15.36), they are displayed automatically on
drawing pages that use the master page.

8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028

•

header: The drawing shape is used as a header. Header shapes are standard text shapes.

•

footer: The drawing shape is used as a footer. Footer shapes are standard text shapes.

•

date-time: The drawing shape is used as a date and/or time shape. Date and Time shapes
are standard text shapes.

•

page-number: The drawing shape is used as a page number shape. Page Number shapes
are standard text shapes.

<define name="presentation-shape-attlist" combine="interleave"><optional><attribute name="presentation:class"><ref name="presentation-classes"/></attribute></optional></define><define name="presentation-classes"><choice><value>title</value><value>outline</value><value>subtitle</value><value>text</value><value>graphic</value><value>object</value><value>chart</value><value>table</value><value>orgchart</value><value>page</value><value>notes</value><value>handout</value><value>header</value><value>footer</value><value>date-time</value><value>page-number</value></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 357 of 738

Placeholder
The presentation:placeholder attribute defines if a shape is a placeholder or apresentation object with actual content.
8029
8030
8031
8032
8033
8034
8035

<define name="presentation-shape-attlist" combine="interleave"><optional><attribute name="presentation:placeholder"><ref name="boolean"/></attribute></optional></define>

User-Transform
The presentation:user-transformed attribute specifies whether the size and position of
the shape is set by the user or is set by the corresponding presentation shape on the master
page.
8036
8037
8038
8039
8040
8041
8042

<define name="presentation-shape-attlist" combine="interleave"><optional><attribute name="presentation:user-transformed"><ref name="boolean"/></attribute></optional></define>

9.7 Presentation Animations
In a presentation document, shapes can be animated. Each presentation page can have an
optional <presentation:animations> element, which is a container for animation effects.
The animation is executed when the page is displayed during a presentation.
This specification allows multiple effects for one and the same shape within a page. Applications
may have restrictions regarding the number and combination of effects applicable to a shape, forinstance may support only one show and one hide effect per shape with an additional show andhide text and one dim and sound effect.
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062

<define name="presentation-animations"><element name="presentation:animations"><zeroOrMore><choice><ref name="presentation-animation-elements"/><ref name="presentation-animation-group"/></choice></zeroOrMore></element></define><define name="presentation-animation-elements"><choice><ref name="presentation-show-shape"/><ref name="presentation-show-text"/><ref name="presentation-hide-shape"/><ref name="presentation-hide-text"/><ref name="presentation-dim"/><ref name="presentation-play"/></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 358 of 738

9.7.1 SoundThe element <presentation:sound> may be contained in all animation effect elements that
support sounds. The sound file referenced by the XLink attributes is played when the effect is
executed.
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093

<define name="presentation-sound"><element name="presentation:sound"><ref name="presentation-sound-attlist"/><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><choice><value>simple</value></choice></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><choice><value>onRequest</value></choice></attribute></optional><optional><attribute name="xlink:show"><choice><value>new</value><value>replace</value></choice></attribute></optional><empty/></element></define>

The attribute that may be associate with the <presentation:sound> element is:•

Play fullPlay Full
If the value of the attribute presentation:play-full is true, the next effect starts after thesound is played. If the value of this attribute is false, the next effect starts when the current
effect is finished.
8094
8095
8096
8097
8098
8099
8100

<define name="presentation-sound-attlist" combine="interleave"><optional><attribute name="presentation:play-full"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 359 of 738

9.7.2 Show ShapeThe element <presentation:show-shape> makes a shape visible. If there is a<presentation:show-shape> element for one shape, this shape is automatically invisible
before the effect is executed.
8101
8102
8103
8104
8105
8106
8107
8108

<define name="presentation-show-shape"><element name="presentation:show-shape"><ref name="common-presentation-effect-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

The attributes that may be associated with the <presentation:show-shape> element are:
•

Shape

•

Effect•Direction

•

Speed

•

Delay

•

Start Scale

•

Path

Shape
The attribute draw:shape-id specifies the shape of this effect using a shape ID.
8109
8110
8111
8112
8113

<define name="common-presentation-effect-attlist" combine="interleave"><attribute name="draw:shape-id"><ref name="IDREF"/></attribute></define>

Effect
The attribute presentation:effect specifies the type of effect.
•

none: no effect is used.

•

fade: the shape fades from its visible or hidden state to a hidden or visible state.

•

move: the shape moves from or to its final position.

•

stripes: the shape is faded in or out by drawing or removing horizontal or vertical stripesthat change their size.

•

open: the shape is drawn or removed line by line, either horizontally or vertically, starting at
the center of the shape.

•

close: the shape is drawn or removed line by line, either horizontally or vertically, starting at
the edge of the shape.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 360 of 738

8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141

•

dissolve: the shape is faded in or out by drawing or removing small blocks in a random
fashion.

•wavyline: the shape is faded in our out by drawing or removing small blocks in a snake likefashion.

•random: an effect is chosen at random to fade the shape in or out.

•lines: the shape is faded in our out by drawing or removing line by line, either horizontally or
vertically, in a random fashion.

•laser: this effect is only available for text shapes; the characters of the text are moved one
by one from the top edge of the screen to their final position.

•

appear: the shape is faded in by just switching its state from invisible to visible.

•

hide: the shape is faded out by just switching its state from visible to invisible.

•

move-short: like the move effect, but the moving shape is clipped to its final bounding
rectangle during fade.

•checkerboard: the shape is faded in or out by drawing or removing checkerboard likeblocks that increase in size over time.

•

rotate: the shape rotates horizontally or vertically for a short amount of time during thiseffect.

•stretch: the shape is faded in or out by changing its size during this effect.

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:effect" a:defaultValue="none"><ref name="presentationEffects"/></attribute></optional></define><define name="presentationEffects"><choice><value>none</value><value>fade</value><value>move</value><value>stripes</value><value>open</value><value>close</value><value>dissolve</value><value>wavyline</value><value>random</value><value>lines</value><value>laser</value><value>appear</value><value>hide</value><value>move-short</value><value>checkerboard</value><value>rotate</value><value>stretch</value></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 361 of 738

Direction
The attribute presentation:direction specifies the direction of the effect. This is relevant forsome effects only.
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:direction" a:defaultValue="none"><ref name="presentationEffectDirections"/></attribute></optional></define><define name="presentationEffectDirections"><choice><value>none</value><value>from-left</value><value>from-top</value><value>from-right</value><value>from-bottom</value><value>from-center</value><value>from-upper-left</value><value>from-upper-right</value><value>from-lower-left</value><value>from-lower-right</value><value>to-left</value><value>to-top</value><value>to-right</value><value>to-bottom</value><value>to-upper-left</value><value>to-upper-right</value><value>to-lower-right</value><value>to-lower-left</value><value>path</value><value>spiral-inward-left</value><value>spiral-inward-right</value><value>spiral-outward-left</value><value>spiral-outward-right</value><value>vertical</value><value>horizontal</value><value>to-center</value><value>clockwise</value><value>counter-clockwise</value></choice></define>

Speed
The attribute presentation:speed specifies the speed of the effect.
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:speed" a:defaultValue="medium"><ref name="presentationSpeeds"/></attribute></optional></define><define name="presentationSpeeds"><choice><value>slow</value><value>medium</value><value>fast</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 362 of 738

8193
8194

</choice></define>

Delay
The attribute presentation:delay specifies the delay before a presentation effect starts after
the previous one has been finished.
8195
8196
8197
8198
8199
8200
8201

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:delay"><ref name="duration"/></attribute></optional></define>

Start Scale
Some effects scale a shape during execution of the effect. The attribute presentation:startscale specifies the start size of the shape as a percentage of its original size.
8202
8203
8204
8205
8206
8207
8208

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:start-scale" a:defaultValue="100%"><ref name="percent"/></attribute></optional></define>

Path
The attribute presentation:path-id applies to move effects. The attribute specifies theshape-id of a polygon shape. The effect moves along the lines of the specified polygon. The
referenced polygon is not visible during the presentation.
8209
8210
8211
8212
8213

<define name="common-presentation-effect-attlist" combine="interleave"><optional><attribute name="presentation:path-id"/></optional></define>

9.7.3 Show Text
The element <presentation:show-text> makes the text of a shape visible. If there is a<show-text> element for one shape, the text of the shape is automatically invisible before theeffect is executed.
8214
8215
8216
8217
8218
8219
8220
8221

<define name="presentation-show-text"><element name="presentation:show-text"><ref name="common-presentation-effect-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

The attributes that may be associated with the <presentation:show-text> element are:•Shape, Effect, Direction, Speed, Start Scale, Path – see section 9.7.2

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 363 of 738

9.7.4 Hide ShapeThe element <presentation:hide-shape> makes a shape invisible.
8222
8223
8224
8225
8226
8227
8228
8229

<define name="presentation-hide-shape"><element name="presentation:hide-shape"><ref name="common-presentation-effect-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

The attributes that may be associated with the <presentation:hide-shape> element are:•Shape, Effect, Direction, Speed, Start Scale, Path – see section 9.7.2

9.7.5 Hide Text
The element <presentation:hide-text> makes the text of a shape invisible.
8230
8231
8232
8233
8234
8235
8236
8237

<define name="presentation-hide-text"><element name="presentation:hide-text"><ref name="common-presentation-effect-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

The attributes that may be associated with the <presentation:hide-text> element are:•Shape, Effect, Direction, Speed, Start Scale, Path – see section 9.7.2

9.7.6 Dim
The element <presentation:dim> fills a shape in a single color.
8238
8239
8240
8241
8242
8243
8244
8245

<define name="presentation-dim"><element name="presentation:dim"><ref name="presentation-dim-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

The attributes that may be associated with the <presentation:dim> element are:

8246
8247
8248
8249
8250

•

Shape – see section 9.7.2

•

Color

<define name="presentation-dim-attlist" combine="interleave"><attribute name="draw:shape-id"><ref name="IDREF"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 364 of 738

Color
The attribute draw:color specifies the color that is used to fill the shape when the shape isdimmed.
8251
8252
8253
8254
8255

<define name="presentation-dim-attlist" combine="interleave"><attribute name="draw:color"><ref name="color"/></attribute></define>

9.7.7 PlayThe element <presentation:play> starts the animation of a shape that supports animation.
8256
8257
8258
8259
8260
8261

<define name="presentation-play"><element name="presentation:play"><ref name="presentation-play-attlist"/><empty/></element></define>

The attributes that may be associated with the <presentation:play> element are:
•
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271

Shape ID and Speed – see section 9.7.2<define name="presentation-play-attlist" combine="interleave"><attribute name="draw:shape-id"><ref name="IDREF"/></attribute><optional><attribute name="presentation:speed" a:defaultValue="medium"><ref name="presentationSpeeds"/></attribute></optional></define>

9.7.8 Effect groups
The element <presentation:animation-group> allows to specify that multiple effects
should happen at the same time.
8272
8273
8274
8275
8276
8277
8278

<define name="presentation-animation-group"><element name="presentation:animation-group"><zeroOrMore><ref name="presentation-animation-elements"/></zeroOrMore></element></define>

9.8 SMIL Presentation Animations
This chapter describes [SMIL20] based shape animations for presentation documents. This kindof animations can be used instead of the ones specified by the <presentation:animations>
elements if one of the following items is required:•

Multiple animations per shape.

•

A mixture of animations starting on user interaction and starting automatically per page.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 365 of 738

•Multiple animations running at the same time.

•

Additional effects 'programmed' in XML by combining basic animation elements.

•

Document transformations to SVG including [SMIL20].

9.8.1 Recommended Usage Of SMIL
The following sections describe the usage of SMIL animation elements that enables an officeapplication to present the animation elements in a simple and easy to use UI to the user. This UI
may contain a single main sequence of effects, and in addition to this, multiple sequences ofeffects that are started as interactions on drawing shapes. An effect is a combination of one ormore animation elements that animate a single shape and or a shape's paragraphs.
It is recommended, that in user interfaces, effects can be created by using presets that have
localized and meaningful names. This way, the user will not work on a hierarchy of SMIL
animation elements, but on one dimensional lists of effects, which are much easier to handle forthe office application users.

Slide Animation
Each <draw:page> element may optionally have an <anim:par> element that defines theanimation of that page during a running slideshow. This <anim:par> element should contain one<anim:seq> element which is the main sequence for shape effects and zero or more<anim:seq> elements that define interactive sequences for shapes that contain animationinteractions. The animation elements are executed after the slide has executed its initial transition.

Main Sequence
The main sequence is a <anim:seq> element which contains the effects that should start after
the slide has executed its initial transition. Since this is a sequential container, its child nodes are
executed one after each other. If a child node's smil:begin attribute has the value
indefinite, then the execution is stalled until the user advances the slideshow by a mouse or
key interaction.
The first level of child nodes in the main sequence should be <anim:par> elements that group
animation elements that are started with the same user interaction. The second level of childnodes should be <anim:par> elements that group animations elements that start at the sametime. The third level of child nodes should be <anim:par> elements that group the animation
elements for a single effect.
The following example shows a main sequence with the effects A, B, C and D. Effect A is started
on user interaction, effect B is started simultaneously with A. Effect C is started 4 seconds after
the effects A and B. Effect D is started on the next user interaction:<amin:par> <!-- timing root--><anim:seq> <!-- main sequence--><anim:par smil:begin="indefinite"><!-- first user interaction --><anim:par smil:begin="0s" smil:dur="4s"><!-- first group of effects to execute --><anim:par> <!-- effect a --><!-- nodes for effect a--></anim:par><anim:par> <!-- effect b --><!-- nodes for effect b-->

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 366 of 738

</anim:par></anim:par><anim:par smil:begin="4s"><!-- second group of effects to execute --><anim:par> <!-- effect c --><!-- nodes for effect c--></anim:par></anim:par></anim:par><anim:par><!-- second user interaction--><anim:par smil:begin="indefinite"><!-- first group of effects to execute --><anim:par> <!-- effect d --><!--- nodes for effect d--></anim:par></anim:par></anim:par></anim:seq></anim:par>Interactive Sequence
An interactive sequence is a <anim:seq> element that should have the same structure as amain sequence. The only difference is that the <anim:par> element in the first level has asmil:begin attribute with a value like [shape-id].click, where [shape-id] identifies adrawing shapes by its draw:id attribute. These animation elements are triggered when the userinteracts with the element defined by [shape-id].

9.8.2 Document Dependent SMIL Animation Attribute Values
This section describes the attribute values of the document type dependent attributes specified in
section 13 if they are used within presentation documents.

Iteration Target Element
For presentation documents, the smil:targetElement attribute of the <anim:iterate>element (see section 13.4.4) can reference drawing shape or paragraph elements. If theanim:sub-item attribute of <anim:iterate> has the value whole, the iteration includes thedrawing shape's background and its text. If the anim:sub-item attribute's value is text, only
the shape's text is iterated.

Iteration TypeFor presentation documents, the anim:iterate-type attribute of the <anim:iterate>element (see section 13.4.4) can have the following values:•

by-paragraph: the target shape is iterated by paragraphs.

•

by-word: the target shape or paragraph is iterated by words.

•

by-letter: the target shape or paragraph is iterated by letters.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 367 of 738

Target Element
For presentation documents, the smil:targetElement specified in section 13.3.1 canreference drawing shapes by their draw:id attribute value and paragraphs by their text:id
attribute value.

Target Attribute
For presentation documents, the smil:attributeName attribute specified in section 13.3.1 canhave the following values:•

x: animates the elements x position, values are given in screen space where 0 is the left edge
and 1 is the right edge.

•

y: animates the elements y position, values are given in screen space where 0 is the top and
1 is the bottom.

•

width: animates the elements width, values are given in screen space where 0 is no widthand 1 is the same width as the screen.

•height: animates the elements height, values are given in screen space where 0 is no heightand 1 is the same height as the screen.

•color: animates the elements color, this animates both fill,line and char color. Values can be
RGB or HSL•

rotate: animates the elements rotation, this animates both the shapes and text animation.

•

skewX: animates the elements horizontal skew.

•

fillColor: animates the elements fill color.

•

fillStyle: animates the elements fill style.

•lineColor: animates the elements line color.

•lineStyle: animates the elements line style.

•charColor: animates the elements char color.

•charWeight: animates the elements text weight.

•

charUnderline: animates the elements text underline.

•

charFontName: animates the elements text font.

•charHeight: animates the elements text height.

•

charPosture: animates the elements text posture.

•visibility: animates the elements visibility.

•

opacity: animates the elements opacity.

Target Element Sub Item
For presentation documents, the anim:sub-item attribute specified in section 13.3.1 can havethe following values:•

whole: animates both the shape and its text.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 368 of 738

•background:animates only the shapes background and not its text.

•

text: animates only the text.

FormulaFor presentation documents, the anim:formula attribute specified in section 13.3.2 may containthe following additional identifiers:•e,: this is the Euler constant.

•

x: this is the animated elements left edge in screen space where 0 is the left edge of thescreen and 1 is the right edge.

•y: this is the animated elements top edge in screen space, where 0 is the top edge of thescreen and 1 is the bottom edge.

•

width: this is the animated elements width in screen space, where 0 is no width and 1 is thescreens width.

•height: this is the animated elements height in screen space, where 0 is no height and 1 isthe screens height.

Command
For presentation documents, The anim:command attribute of the <anim:command> element (seesection 13.6.1) can have the following values:•

custom: the command is user defined.

•

verb: the command targets an OLE2 shape. The parameter verb is the verb number that will
be executed at the OLE2 shape.

•

play: the command targets a media shape and starts its playback. The optional parameter
media-time defines the playback start time in seconds. If this parameter is not set, playback
starts at the last position.

•

toggle-pause: the command targets a media shape and toggles its playback state from play
to paused or from paused to play.

•

stop: the command targets a media shape and stops its playback.

•stop-audio: the command has no target and stops all running audio playback.

9.8.3 SMIL Presentation Animation Attributes
The attributes described in this section can be attached to the animation elements described in
section 13.4, 13.5 and 13.6 if they are used inside presentation documents. They don't influence
the actual animation behavior, but help office application user interfaces in presenting animation
effect settings to the user.

Node TypeThe presentation:node-type attribute specifies a node type for an animation element. This
attribute does not alter the element's behavior but helps the application to quickly identify anelements purpose inside an animation element hierarchy. The value of this attribute can be:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 369 of 738

8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293

•

default: this animation element has no special meaning for the application. This is thedefault setting.

•on-click: this animation element is the root element of an effect that starts with a user click.

•

with-previous: this animation element is the root element of an effect that starts with theprevious effect.

•

after-previous: this animation element is the root element of an effect that starts after theprevious effect.

•

timing-root: this animation element is the root element for the animation of a page.

•main-sequence: this animation element is the root element for the main sequence of effects
of a page•interactive-sequence: this animation element is the root element for a sequence ofeffects that are started when the user interactively clicks on a special element inside a page.

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:node-type" a:defaultValue="default"><choice><value>default</value><value>on-click</value><value>with-previous</value><value>after-previous</value><value>timing-root</value><value>main-sequence</value><value>interactive-sequence</value></choice></attribute></optional></define>

Preset Id
The presentation:preset-id attribute specifies the name of the preset that was used tocreate this animation element.
8294
8295
8296
8297
8298
8299
8300

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:preset-id"><ref name="string"/></attribute></optional></define>

Preset Sub TypeThe presentation:preset-sub-type attribute specifies the sub type of the preset that wasused to create this animation element.
8301
8302
8303
8304
8305
8306
8307

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:preset-sub-type"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 370 of 738

Preset Class
The presentation:preset-class attribute specifies the class of the preset that was used tocreate this animation element. The value of this attribute can be:

8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322

•

custom: the preset was a user defined one. This is the default setting.

•entrance: the preset was an entrance effect.

•

exit: the preset was an exit effect.

•emphasis: the preset was an emphasis effect.

•

motion-path: the preset was a motion path.

•ole-action: the preset was an ole action.

•

media-call: the preset was a media call.

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:preset-class" a:defaultValue="custom"><choice><value>custom</value><value>entrance</value><value>exit</value><value>emphasis</value><value>motion-path</value><value>ole-action</value><value>media-call</value></choice></attribute></optional></define>

Master Element
The presentation:master-element attribute specifies the id of an animation element. Officeapplication user interfaces may only display animation elements that don't have apresentation:master-element attribute, and may consider the ones that have apresentation:master-element to be a part of the animation element that is referenced.
8323
8324
8325
8326
8327
8328
8329

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:master-element"><ref name="IDREF"/></attribute></optional></define>

Group Id
The presentation:group-id attribute specifies a group id. This id can be used to group
animation elements within the user interface, where a group consists of all animation elementsthat have the same group id. This can be used for instance to group the animation elements thatanimate the paragraphs of a single shape.
8330
8331
8332

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="presentation:group-id">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 371 of 738

8333
8334
8335
8336

<ref name="string"/></attribute></optional></define>

9.9 Presentation Events
Many objects inside a presentation document support special presentation events. For example, auser can advance the presentation one frame when he clicks on an object with a corresponding
event. Presentation events are contained with a graphic object's event listener table. See section
9.2.21 for details.
8337
8338
8339
8340
8341
8342
8343
8344

<define name="presentation-event-listener"><element name="presentation:event-listener"><ref name="presentation-event-listener-attlist"/><optional><ref name="presentation-sound"/></optional></element></define>

Event Name
The script:event-name attribute specifies the name of the event. See section 12.4.1 fordetails.
8345
8346
8347
8348
8349

<define name="presentation-event-listener-attlist" combine="interleave"><attribute name="script:event-name"><ref name="string"/></attribute></define>

Event Action
The kind of action that is executed when the event is triggered can be selected with thepresentation:action attribute. The following actions are available:•

none: no action is performed when this event is triggered.

•previous-page: the presentation jumps to the previous page.

•next-page: the presentation jumps to the next page.

•

first-page: the presentation jumps to the first page of the current document.

•

last-page: the presentation jumps to the last page of the current document.

•

hide: the object that contains this event is hidden if the event is triggered.

•stop: if a slide show is active, it will be stopped.

•

execute: another application is lunched when this event is triggered. The application can be
set with an xlink.

•

show: the target of an URL is opened when this event is triggered. The URL can be set with
an xlink.

•

verb: if the object that contains this event supports the execution of [OLE] verbs, the verb
with the id set in the presentation:verb attribute is executed.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 372 of 738

8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367

•

fade-out: the object that contains this event is faded out when this event is triggered. The
attributes presentation:effect, presentation:direction, presentation:speed
and presentation:start-scale can be used to set the effect.

•

sound: an audio effect is started when the effect is triggered. The audio effect is described by
a <presentation:sound> child element.

<define name="presentation-event-listener-attlist" combine="interleave"><attribute name="presentation:action"><choice><value>none</value><value>previous-page</value><value>next-page</value><value>first-page</value><value>last-page</value><value>hide</value><value>stop</value><value>execute</value><value>show</value><value>verb</value><value>fade-out</value><value>sound</value></choice></attribute></define>

Event EffectSee presentation:effect attribute in section 9.7.2.
8368
8369
8370
8371
8372
8373
8374

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="presentation:effect" a:defaultValue="none"><ref name="presentationEffects"/></attribute></optional></define>

Effect Direction
See presentation:direction attribute in section 9.7.2.
8375
8376
8377
8378
8379
8380
8381

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="presentation:direction" a:defaultValue="none"><ref name="presentationEffectDirections"/></attribute></optional></define>

Effect Speed
See presentation:speed attribute in section 9.7.2.
8382
8383
8384
8385
8386
8387

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="presentation:speed" a:defaultValue="medium"><ref name="presentationSpeeds"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 373 of 738

8388</define>

Start Scale
See presentation:start-scale attribute in section 9.7.2.
8389
8390
8391
8392
8393
8394
8395

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="presentation:start-scale" a:defaultValue="100%"><ref name="percent"/></attribute></optional></define>

Link
Depending on the action selected by the presentation:action attribute, this xlink:href
attribute either selects a document bookmark or an application.
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></optional><optional><attribute name="xlink:type" a:defaultValue="simple"><choice><value>simple</value></choice></attribute></optional><optional><attribute name="xlink:show" a:defaultValue="embed"><choice><value>embed</value></choice></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><choice><value>onRequest</value></choice></attribute></optional></define>

Verb
The [OLE] verb defined by the presentation:verb attribute is executed for event listeners oftype verb at the object that contains this event.
8424
8425
8426
8427
8428
8429
8430

<define name="presentation-event-listener-attlist" combine="interleave"><optional><attribute name="presentation:verb"><ref name="nonNegativeInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 374 of 738

9.10 Presentation Text Fields
This section describes text fields that are specific to the text of drawing shapes that are contained
presentations.

9.10.1 Header Field
Header fields display a header text specified in a header field declaration (see section 9.11.2).
Which header field declaration is used is specified by the presentation:use-header-nameattribute of the draw page where the field occurs. If the field is contained in a presentation shapeinside a master page (see section 9.6.1), then the presentation:use-header-name attributeof the drawing page for which the drawing shape is displayed is used (see section 9.1.4).
This field is mainly used inside master pages. Since its value may differ for the individual drawing
pages that make use of a master page, the current field value is not available.
8431
8432
8433
8434
8435

<define name="paragraph-content" combine="choice"><element name="presentation:header"><empty/></element></define>

9.10.2 Footer Field
Footer fields display a footer text specified in a footer field declaration (see section 9.11.3). Whichfooter field declaration is used is specified by the presentation:use-footer-name attributeof the draw page where the field occurs. If the field is contained in a presentation drawing shapeinside a master page (see section 9.6.1), then the presentation:use-footer-name attributeof the drawing page for which the drawing shape is displayed is used (see section 9.1.4).
This field is mainly used inside master pages. Since its value may differ for the individual drawing
pages that make use of a master page, the current field value is not available.
8436
8437
8438
8439
8440

<define name="paragraph-content" combine="choice"><element name="presentation:footer"><empty/></element></define>

9.10.3 Date and Time Field
Date and time fields display a date/time text as specified in the date/time field declaration(seesection 9.11.4). Which date-time field declaration is used is specified by thepresentation:use-date-time-name attribute of the draw page where the field occurs. If the
field is contained in a presentation drawing shape inside a master page (see section 9.6.1), thenthe presentation:use-date-time-name attribute of the drawing page for which the drawing
shape is displayed is used (see section 9.1.4).
This field is mainly used inside master pages. Since its value may differ for the individual drawing
pages that make use of a master page, the current field value is not available.
8441
8442
8443
8444
8445

<define name="paragraph-content" combine="choice"><element name="presentation:date-time"><empty/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 375 of 738

9.11 Presentation Document Content
9.11.1 Presentation Declarations
Some presentation specific text fields need per-document declarations before they can be used.
For example, header fields require that the header text that is displayed is declared separately.
These declarations are collected at the beginning of a text document.
8446
8447
8448
8449
8450

<define name="presentation-decls"><zeroOrMore><ref name="presentation-decl"/></zeroOrMore></define>

9.11.2 Header field declaration
The <presentation:header-decl> element specifies the text of a header field. See section
9.10.1 for details.
8451
8452
8453
8454
8455
8456

<define name="presentation-decl" combine="choice"><element name="presentation:header-decl"><ref name="presentation-header-decl-attlist"/><text/></element></define>

Name
The presentation:name attribute specifies the name of the header declaration.
8457
8458
8459
8460
8461

<define name="presentation-header-decl-attlist" combine="interleave"><attribute name="presentation:name"><ref name="string"/></attribute></define>

9.11.3 Footer field declaration
The <presentation:footer-decl> element specifies the text of a footer field. See section
9.10.2 for details.
8462
8463
8464
8465
8466
8467

<define name="presentation-decl" combine="choice"><element name="presentation:footer-decl"><ref name="presentation-footer-decl-attlist"/><text/></element></define>

Name
The presentation:name attribute specifies the name of the footer declaration.
8468
8469
8470
8471
8472

<define name="presentation-footer-decl-attlist" combine="interleave"><attribute name="presentation:name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 376 of 738

9.11.4 Date and Time field declaration
The <presentation:date-time-decl> element specifies the text of a date-time field. See
section 9.10.3 for details.
8473
8474
8475
8476
8477
8478

<define name="presentation-decl" combine="choice"><element name="presentation:date-time-decl"><ref name="presentation-date-time-decl-attlist"/><text/></element></define>

Name
The presentation:name attribute specifies the name of the date-time declaration.
8479
8480
8481
8482
8483

<define name="presentation-date-time-decl-attlist" combine="interleave"><attribute name="presentation:name"><ref name="string"/></attribute></define>

SourceThe presentation:source attribute specifies whether the current date/time or the fixed
content of the the field declaration is displayed.
8484
8485
8486
8487
8488
8489
8490
8491

<define name="presentation-date-time-decl-attlist" combine="interleave"><attribute name="presentation:source"><choice><value>fixed</value><value>current-date</value></choice></attribute></define>

Date and time formatting style
The date style referenced by the style:data-style-name attribute is used to format the date
and time of the presentation:date-time fields if the field is not fixed.
8492
8493
8494
8495
8496
8497
8498

<define name="presentation-date-time-decl-attlist" combine="interleave"><optional><attribute name="style:data-style-name"><ref name="styleNameRef"/></attribute></optional></define>

9.11.5 Presentation Settings
The settings for a presentation are stored in the element <presentation:settings> inside an<office:presentation> element. These settings affect the behavior if the document isdisplayed in a presentation.
8499
8500
8501
8502

<define name="presentation-settings"><optional><element name="presentation:settings"><ref name="presentation-settings-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 377 of 738

8503
8504
8505
8506
8507
8508

<zeroOrMore><ref name="presentation-show"/></zeroOrMore></element></optional></define>

The attributes that may be associated with the <presentation:settings> element are:•Start page

•

Show

•

Full screen•Endless

•

Pause

•

Show logo•

Force manual•

Mouse visible•

Mouse as pen•

Start with navigator•

Animation•

Transition on click•

Stay on top

Start pageThe attribute presentation:start-page specifies the name of the page on which thepresentation starts. If this attribute is set, it overrides the presentation:show attribute.
8509
8510
8511
8512
8513
8514
8515

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:start-page"><ref name="string"/></attribute></optional></define>Show
The attribute presentation:show specifies the name of a show definition (see section 9.11.6)
that is used for the presentation. If the presentation:start-page attribute is set, it overrides
the value of this attribute.
8516
8517
8518
8519
8520
8521
8522

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:show"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 378 of 738

Full Screen
The attribute presentation:full-screen determines whether the presentation is displayed infull screen mode or in a window.
8523
8524
8525
8526
8527
8528
8529

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:full-screen" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>Endless
The attribute presentation:endless switches indefinite repetition of a presentation on and
off.
8530
8531
8532
8533
8534
8535
8536

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:endless" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Pause
If a presentation is repeated indefinitely, the attribute presentation:pause specifies a time
duration for displaying a pause screen before the presentation is played again. If this attribute is
not set or has a value of 0, a pause screen is not displayed in endless mode. The value of this
attribute must conform to the time period format described in §3.2.6 of [xmlschema-2].
8537
8538
8539
8540
8541
8542
8543

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:pause"><ref name="duration"/></attribute></optional></define>

Show Logo
The attribute presentation:show-logo specifies whether or not a presentation applicationshows its logo on the pause screen.
8544
8545
8546
8547
8548
8549
8550

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:show-logo" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Force Manual
If set, the attribute presentation:force-manual overrides allpresentation:transition-type properties that are specified within a presentation page
(see section 15.36.1) and sets it to manual.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 379 of 738

8551
8552
8553
8554
8555
8556
8557

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:force-manual" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Mouse Visible
The attribute presentation:mouse-visible specifies whether or not the mouse pointer isvisible during a presentation.
8558
8559
8560
8561
8562
8563
8564

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:mouse-visible" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Mouse As Pen
The attribute presentation:mouse-as-pen specifies if the mouse pointer is displayed as apen or a pointer. If the mouse is displayed as a pen the user can draw sketches on the pages
during a presentation.
8565
8566
8567
8568
8569
8570
8571

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:mouse-as-pen" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Start With Navigator
The attribute presentation:start-with-navigator specifies whether or not the navigator
window is initially displayed during a presentation.
8572
8573
8574
8575
8576
8577
8578
8579

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:start-with-navigator"
a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Animations
The attribute presentation:animations enables or disables the playback of bitmap
animations during a presentation.
8580
8581
8582
8583
8584

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:animations" a:defaultValue="enabled"><choice><value>enabled</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 380 of 738

8585
8586
8587
8588
8589

<value>disabled</value></choice></attribute></optional></define>

Transition On Click
The attribute presentation:transition-on-click enables or disables a manual transition
by a mouse click on the slide during a presentation.
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:transition-on-click"a:defaultValue="enabled"><choice><value>enabled</value><value>disabled</value></choice></attribute></optional></define>

Stay On Top
If the attribute presentation:stay-on-top is set to true, the presentation window isdisplayed on top of other windows during a presentation.
8601
8602
8603
8604
8605
8606
8607

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:stay-on-top" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Show End-Of-Presentation Slide
The attribute presentation:show-end-of-presentation-slide defines whether thepresentation application should show an additional slide at the end of the presentation, telling theuser that the presentation is finished.
This slides content itself is not defined within the document, but is generated by the application
automatically.
8608
8609
8610
8611
8612
8613
8614
8615

<define name="presentation-settings-attlist" combine="interleave"><optional><attribute name="presentation:show-end-of-presentation-slide"a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

9.11.6 Show Definitions
A presentation document can contain one or more <presentation:show> elements. A<presentation:show> element customizes the order in which the pages are displayed during

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 381 of 738

a presentation. It can be also used to omit pages from the presentation or to repeat pages during
the presentation.
This element is optional.
8616
8617
8618
8619
8620
8621

<define name="presentation-show"><element name="presentation:show"><ref name="presentation-show-attlist"/><empty/></element></define>

The attributes that may be associated with the <presentation:show> element are:
•

Name

•

Pages

Name
The attribute presentation:name uniquely identifies a <presentation:show> element.
8622
8623
8624
8625
8626

<define name="presentation-show-attlist" combine="interleave"><attribute name="presentation:name"><ref name="string"/></attribute></define>

Pages
The attribute presentation:pages contains a comma separated list of page names. The
pages are displayed in the order in which they are listed during a presentation that uses this show.
Pages can be included more than once.
8627
8628
8629

<define name="presentation-show-attlist" combine="interleave"><attribute name="presentation:pages"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 382 of 738

10 Chart Content
This chapter describes the XML representation of chart content. It contains the following sections:•Introduction to Chart Documents

•

Chart

•

Title, Subtitle and Footer•

Legend•Plot Area

•

Wall

•

Floor

•

Axis

•

Series•Categories•

Data Point•

Mean Value•

Error Indicator•

Regression Curves

10.1 Introduction to Chart Documents
Chart documents are always contained within other XML documents. There are two types of chartcontainer documents:● Documents that do not provide data for the chart: The chart data is contained in a<table:table> element inside the <chart:chart> element.

● Documents that provide data for the chart: The chart data may be contained in a<table:table> element in the parent document, for example, in a spreadsheet or text
document.

The chart data is specified by the <chart:plot-area> element's table:cell-rangeaddress attribute. The <chart:plot-area> element represents the visualization container ofall data series in the chart.

10.2 Chart
The <chart:chart> element represents an entire chart, including titles, a legend, and thegraphical object that visualizes the underlying data called the plot area. The data underlying thechart is represented by a table element. This element may also exist for embedded charts that get
the data from the container document. In this case the chart can be rendered without getting thedata from the container document.
8630<define name="chart-chart">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 383 of 738

8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650

<element name="chart:chart"><ref name="chart-chart-attlist"/><optional><ref name="chart-title"/></optional><optional><ref name="chart-subtitle"/></optional><optional><ref name="chart-footer"/></optional><optional><ref name="chart-legend"/></optional><ref name="chart-plot-area"/><optional><ref name="table-table"/></optional></element></define>Class
The chart:class attribute specifies the chart type. The chart type is represented by anamespaced token, meaning an identifier prefixed by an XML namespace prefix, just like any
attribute or element name in this specification. This specification defines a number of chart types
in the chart namespace (URN: urn:oasis:names:tc:opendocument:xmlns:chart:1.0). Additional
chart types may be supported by using a different namespace.
The chart type may be specified more precisely with formatting properties that may be attached tochart styles. For example, a 3D bar chart with horizontal bars is specified by setting the classattribute to chart:bar and by adding the properties for three dimensional and horizontal
arrangement in the corresponding style.
8651
8652
8653
8654
8655

<define name="chart-chart-attlist" combine="interleave"><attribute name="chart:class"><ref name="namespacedToken"/></attribute></define>

The pre-defined chart types are:•line – the data points of each data series are connected through lines.

•

area – the area below a data series is filled, and additional data series are stacked.

•

circle – a circular chart is segmented according to the relative weights of the data points.

•ring – each data series is represented as a concentric rings, with each ring rendered as if it
was part of a circle chart of the series.

•

scatter – a pair of data series is used to determine x and y positions for each data point.

•radar – a radial plot of the data points, where the value of each point determines the distancefrom the chart origin. The data points of a series are connected, thus forming a closed line
around the center.

•bar – each data point is depicted by a bar whose length is proportional to the data value.

•stock – four data series are interpreted as opening, minimum, maximum and closing stock
values.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 384 of 738

•bubble – the first two of three data series are interpreted a positions as in a scatter chart,
where the area of each data point is sized relative to the value in the third data series.

•

surface – the data points are interpreted as tabular data, where each value defines a 'height'
at a specific grid location. The graph may visualize these using colors for height intervals,
creating color bands similar to geographical maps.

•

gantt – a pair of data series is used to determine the start and end positions for horizontal bars
Example: The following table shows examples for the pre-defined chart types. Thosecharts that use one or two data series use two data series with the values 1;2;3;4 and
1;4;9;16 and the labels a;b;c;d. Those chart types that use more than two data series(stock and bubble) use the data series 1;2;3;4 and multiples thereof. The radar chart uses
two data series with five data points.

chart:line

chart:area

chart:circle

chart:ring

chart:scatter

chart:radar

chart:barchart:stock

chart:bubble

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 385 of 738

chart:surface

chart:gantt

Size
The svg:width and svg:height (see section 9.2.15) attributes define the extent of the entire
chart. If they are omitted, the size of the chart is determined by the size of the window in which thechart is displayed.
8656
8657
8658

<define name="chart-chart-attlist" combine="interleave"><ref name="common-draw-size-attlist"/></define>

Column and Row Mapping
The chart:column-mapping and chart:row-mapping attributes contain, if provided, a list ofindexes of series. The numbers define a reordering of data that comes from a container
document that provides the data for the chart. The numbering begins with 1. A list of ascending
numbers beginning with 1 has no effect. To exchange two series, their numbers must be
exchanged in the list. For example, 1 3 2 4 exchanges the second and the third series.
The chart:column-mapping and chart:row-mapping attributes must not be usedsimultaneously.
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672

<define name="chart-chart-attlist" combine="interleave"><optional><attribute name="chart:column-mapping"><ref name="string"/></attribute></optional></define><define name="chart-chart-attlist" combine="interleave"><optional><attribute name="chart:row-mapping"><ref name="string"/></attribute></optional></define>

Style Name
The chart:style-name attribute references a chart style. See section 14.16 for details.
Within the style applied to the <chart:chart> element, fill properties (described in section
15.14) and the stroke properties (described in section 15.13) as well as the scale text property
described in section 15.29.1 can be used.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 386 of 738

8673
8674
8675
8676
8677
8678
8679

<define name="chart-chart-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.3 Title, Subtitle and Footer
10.3.1 Title
The <chart:title> element represents a main title object in a chart document. This element
can contain fixed text or it can contain a <table:cell-address> element pointing to the textthat should be displayed as the title. This element can also be a sub-element of chart:axis,
see section 10.8. In this case the title is displayed beside the axis object.
8680
8681
8682
8683
8684
8685
8686
8687

<define name="chart-title"><element name="chart:title"><ref name="chart-title-attlist"/><optional><ref name="text-p"/></optional></element></define>

Table Range
A chart title may be bound to a table cell, causing the current content of the given cell to be
displayed in the chart title.
8688
8689
8690
8691
8692
8693
8694

<define name="chart-title-attlist" combine="interleave"><optional><attribute name="table:cell-range"><ref name="cellAddress"/></attribute></optional></define>

Position and Size
The common positioning attributes for drawing objects can be used on <chart:title>
elements.
8695
8696
8697

<define name="chart-title-attlist" combine="interleave"><ref name="common-draw-position-attlist"/></define>

Style Name
The chart:style-name attribute specifies a chart style for the <chart:title> element.
Within the referenced style, fill and stroke properties may be used. They are applied to thesurrounding title box. See sections 15.14 and 15.13 for more information. In addition to this, text
properties may be used. They are applied to the title text itself. See section 15.4.
8698
8699

<define name="chart-title-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 387 of 738

8700
8701
8702
8703
8704

<attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.3.2 Subtitle
The <chart:subtitle> element represents a subtitle which can be used for additional title
information in a chart.
The structure of the <chart:subtitle> element is the same as that of the <chart:title>
element. The attributes that may be associated with the <chart:subtitle> element are thesame as those that may be associated with the <chart:title> element. See section 10.3.1 formore information.
8705
8706
8707
8708
8709
8710
8711
8712

<define name="chart-subtitle"><element name="chart:subtitle"><ref name="chart-title-attlist"/><optional><ref name="text-p"/></optional></element></define>

10.3.3 Footer
The <chart:footer> element represents a footer below the chart's plot area.
The structure of the subtitle element is the same as that of the <chart:title> title element.
See section 10.3.1 for more information.
8713
8714
8715
8716
8717
8718
8719
8720

<define name="chart-footer"><element name="chart:footer"><ref name="chart-title-attlist"/><optional><ref name="text-p"/></optional></element></define>

10.4 Legend
The <chart:legend> element determines whether or not a legend is displayed in the chart. The
legend's position may be specified either as a relative or as an absolute position. The size of thelegend is calculated automatically and therefore cannot be set as attribute.
8721
8722
8723
8724
8725
8726

<define name="chart-legend"><element name="chart:legend"><ref name="chart-legend-attlist"/><empty/></element></define>

Legend Placement
The legend can be placed automatically, next to the plot area, or in one of the corners. This
placement is determined by the chart:legend-position attribute, which may have the values

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 388 of 738

start, end, top, bottom for legend positions next to the plot area and top-start, bottomstart, top-end or bottom-end for legend positions in the corners. If the legend is placed next
to the plot area, in any of the four directions start, end, top bottom, an additional alignment
attribute chart:legend-align determines which border (start, end) or axis (center) of thelegend and the plot area are to be aligned.
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758

<define name="chart-legend-attlist" combine="interleave"><choice><group><attribute name="chart:legend-position"><choice><value>start</value><value>end</value><value>top</value><value>bottom</value></choice></attribute><optional><attribute name="chart:legend-align"><choice><value>start</value><value>center</value><value>end</value></choice></attribute></optional></group><attribute name="chart:legend-position"><choice><value>top-start</value><value>bottom-start</value><value>top-end</value><value>bottom-end</value></choice></attribute><empty/></choice></define>

Example: If chart:legend-position="right", the legend will be positioned to theright of the chart's plot area. The chart:legend-align values of start, center, andend will yield legend positions as depicted by the green, red, and blue boxes, respectively.

The legend position can also be given in absolute coordinates, as with any drawing object. If botha drawing position and legend placement options are available, the legend placement takes
precedence and the position should reflect the automatic placement.
8759
8760
8761

<define name="chart-legend-attlist" combine="interleave"><ref name="common-draw-position-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 389 of 738

Legend Expansion
The legend needs to be expanded to accommodate additional legend items. The
style:legend-expansion attribute determines in which direction the legend expands. Legend
expansion of wide and high causes the legend to be expanded horizontally and vertically. An
expansion balanced causes expansion into both directions. An expansion value of custom witha numeric style:legend-expansion-aspect-ratio causes the legend to be expanded
such that the given ratio between width and height is observed.
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781

<define name="chart-legend-attlist" combine="interleave"><choice><attribute name="style:legend-expansion"><choice><value>wide</value><value>high</value><value>balanced</value></choice></attribute><group><attribute name="style:legend-expansion"><value>custom</value></attribute><attribute name="style:legend-expansion-aspect-ratio"><ref name="double"/></attribute></group><empty/></choice></define>

Legend Styling
Additional styling information for the chart legend can be referenced through the chart:stylename attribute. The style may specify fill and stroke properties. They are applied to the legend
object. See sections 15.14 and 15.13 for more information. In addition to this, the style may
specify text properties. They are applied to the text inside the legend object. See section 15.4.
8782
8783
8784
8785
8786
8787
8788

<define name="chart-legend-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.5 Plot Area
The <chart:plot-area> element is a container for the graphics objects that represent chart
data. The main purpose of the plot area is to be a container for the series elements that represent
single data series, and the axis elements.
8789
8790
8791
8792
8793
8794
8795
8796

<define name="chart-plot-area"><element name="chart:plot-area"><ref name="chart-plot-area-attlist"/><zeroOrMore><ref name="dr3d-light"/></zeroOrMore><zeroOrMore><ref name="chart-axis"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 390 of 738

8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817

</zeroOrMore><zeroOrMore><ref name="chart-series"/></zeroOrMore><optional><ref name="chart-stock-gain-marker"/></optional><optional><ref name="chart-stock-loss-marker"/></optional><optional><ref name="chart-stock-range-line"/></optional><optional><ref name="chart-wall"/></optional><optional><ref name="chart-floor"/></optional></element></define>

Plot Area Positioning
The plot area's position and size are determined the common positioning and sizing attributes fordrawing objects. If the position and size attributes are not specified, the values are calculated by
the render application.
8818
8819
8820
8821

<define name="chart-plot-area-attlist" combine="interleave"><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/></define>

Plot Area Style
The chart:style-name attribute that is set for the <chart:plot-area> element is used forall data elements contained inside the plot area, unless extra styles are specified in one of thosesub-elements. These data elements can be <chart:series> and <chart:data-point>
elements.
If the chart is three-dimensional, 3D scene properties may be applied to the plot area. See thesection 15.22 - 15.26 for more information.
8822
8823
8824
8825
8826
8827
8828

<define name="chart-plot-area-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Plot Area Data Attributes
If a chart is embedded in a document that provides the data for the chart, the table:cellrange-address attribute reflects the ranges from which all the data for the chart comes. The
range given here is interpreted by the chart as consecutive series.
8829
8830

<define name="chart-plot-area-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 391 of 738

8831
8832
8833
8834
8835

<attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

If the first row or column, or both contains labels, this is stated by the chart:data-sourcehas-labels attribute.
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847

<define name="chart-plot-area-attlist" combine="interleave"><optional><attribute name="chart:data-source-has-labels" a:defaultValue="none"><choice><value>none</value><value>row</value><value>column</value><value>both</value></choice></attribute></optional></define>

The chart:series-source formatting property specified in section 15.34.1 determines
whether the data table contains the data series in column-wise or row-wise fashion.

10.5.1 3D Plot Area
The plot area may be displayed as an 3D scene as specified in section 9.4.1. All 3D attributes thatcan be applied to the <dr3d:scene> element can be applied to the <chart:plot-area>
element, including the dr3d:transform attribute. It represents the rotation of a chart scene, thatis the three-dimensional plot area. See section 9.4.1 for more information. In addition to this, the<chart:plot-area> element may contain a <dr3d:light> element as specified in section
9.4.2.
8848
8849
8850
8851

<define name="chart-plot-area-attlist" combine="interleave"><ref name="dr3d-scene-attlist"/><ref name="common-dr3d-transform-attlist"/></define>

10.6 Wall
The <chart:wall> element can be contained in the <chart:plot-area> element. It specifies
a chart's wall. For two-dimensional charts, the wall spans the entire plot area. For threedimensional charts, the wall usually consists of two perpendicular rectangles.
8852
8853
8854
8855
8856
8857

<define name="chart-wall"><element name="chart:wall"><ref name="chart-wall-attlist"/><empty/></element></define>

Width
The svg:width attributes specifies the width of the wall for three-dimensional charts.
8858
8859
8860

<define name="chart-wall-attlist" combine="interleave"><optional><attribute name="svg:width">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 392 of 738

8861
8862
8863
8864

<ref name="length"/></attribute></optional></define>

Style
The <chart:wall> element may have a chart:style-name attribute to specify further stylinginformation. They style may contain fill and stroke properties. See sections 15.14 and 15.13 formore information.
8865
8866
8867
8868
8869
8870
8871

<define name="chart-wall-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.7 Floor
The <chart:floor> element can be contained in the <chart:plot-area> element. For
three-dimensional charts, the <chart:floor> element is present in addition to the<chart:wall> element.
8872
8873
8874
8875
8876
8877

<define name="chart-floor"><element name="chart:floor"><ref name="chart-floor-attlist"/><empty/></element></define>

Size
The size of the floor is determined in respect of the size of the plot area, which is always a twodimensional rectangle that serves as a bounding rectangle of the three-dimensional scene. The
svg:width attribute can be used to set the width of the floor.
8878
8879
8880
8881
8882
8883
8884

<define name="chart-floor-attlist" combine="interleave"><optional><attribute name="svg:width"><ref name="length"/></attribute></optional></define>

Style
The <chart:floor> element may have a chart:style-name attribute to specify further
styling information. Fill and stroke properties can be applied to a floor. See sections 15.14 and15.13 for more information.
8885
8886
8887
8888
8889
8890

<define name="chart-floor-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 393 of 738

8891</define>

10.8 Axis
The <chart:axis> element mainly contains style information, in particular scaling information.
Chart data is usually structured as follows:● Several data series each consisting of a name, for example, the name of a company.
● Values, for example, the yield of the company in different years.
● One value in each series belongs to a category, for example, the year.
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905

<define name="chart-axis"><element name="chart:axis"><ref name="chart-axis-attlist"/><optional><ref name="chart-title"/></optional><optional><ref name="chart-categories"/></optional><zeroOrMore><ref name="chart-grid"/></zeroOrMore></element></define>

Dimension
The chart:dimension attribute specifies along which physical axis on the chart the values of
the current axis are displayed.
A chart may contain more than one axis with the same dimension. For example, it may have twoaxes with dimension y. Data series may be attached to either axis. This way, data may begrouped for different scaling. To attach a specific axis to a data series, the axis has to bereferenced by the <chart:series> element's chart:axis-name attribute. If an axis is notreferences by a data series, it becomes a copy of an existing axis with the same dimension.
The position of an axis in a chart is determined by the rendering application and depends on thechart type. In a chart with horizontal bars, the rendering application usually paints the axis withdimension x on the bottom of the plot area. If there are two axes with dimension y, a rendering
application might paint the second axis at the top of the plot area.
8906
8907
8908
8909
8910
8911
8912
8913
8914

<define name="chart-axis-attlist" combine="interleave"><attribute name="chart:dimension"><choice><value>x</value><value>y</value><value>z</value></choice></attribute></define>

Name
The chart:name attribute can be used to assign a name to this axis, so it can be referenced
from e.g., a data series.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 394 of 738

8915
8916
8917
8918
8919
8920
8921

<define name="chart-axis-attlist" combine="interleave"><optional><attribute name="chart:name"><ref name="string"/></attribute></optional></define>

Style
A chart:style-name attribute can be associated with an axis. Stroke properties can be applied
to axes; see section 15.13. These properties affect all lines of the axis object. Text properties canalso be applied to axes; see section 15.4. These properties affect the appearance of all text
objects. The axis properties described in section 15.31 can also be used.
The chart style that is referenced by the chart:style-name attribute may specify a data stylethat is used to format the axis' labels. See section 14.1 for details.
8922
8923
8924
8925
8926
8927
8928

<define name="chart-axis-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Example: Bar chart
In this example, there are two axes with dimension y. One of these axes has the nameprimary-value. A data series has been attached to that named axis. There is no dataattached to the second axis, therefore an axis name has not been specified, and the axis isjust a copy of the first one.
<chart:chart chart:class="bar"><chart:title><text:p>Title of my chart</text:p></chart:title><chart:plot-area><chart:axis chart:dimension="x"chart:axis-name="x"/><chart:axis chart:dimension="y"chart:axis-name="primary-value"/><chart:axis chart:dimension="y"/><chart:series chart:values-address="Sheet1.A1:.A7"
chart:attached-axis="primary-value"/></chart:plot-area></chart:chart>

10.8.1 Grid
The <chart:grid> element can be contained in a <chart:axis> element. It adds a grids tothe axis.
8929
8930
8931
8932
8933

<define name="chart-grid"><element name="chart:grid"><ref name="chart-grid-attlist"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 395 of 738

Class
The chart:class attribute specifies whether major or minor tick marks are used. If a major gridis applied to an axis, the major tick marks are extended to grid lines. If a grid is minor, any minor
tick marks assigned to the axis are used.
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943

<define name="chart-grid-attlist" combine="interleave"><optional><attribute name="chart:class" a:defaultValue="major"><choice><value>major</value><value>minor</value></choice></attribute></optional></define>

Style Name
The <chart:grid> element may have a chart:style-name attribute to specify further stylinginformation. Stroke properties can be applied to grids, which affect the lines of the grid. See
section 15.13 for information on these stroke properties.
8944
8945
8946
8947
8948
8949
8950

<define name="chart-grid-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.9 Series
The <chart:series> element represents a data series in a chart. If the chart requires more
input data like scatter and bubble charts, <chart:domain> sub-elements must be defined thatmainly contain the cell-range-address of the corresponding data.
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970

<define name="chart-series"><element name="chart:series"><ref name="chart-series-attlist"/><zeroOrMore><ref name="chart-domain"/></zeroOrMore><optional><ref name="chart-mean-value"/></optional><optional><ref name="chart-regression-curve"/></optional><optional><ref name="chart-error-indicator"/></optional><zeroOrMore><ref name="chart-data-point"/></zeroOrMore></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 396 of 738

Cell Range
The chart:values-cell-range-address attribute allows a range to be specified that
contains the values that should be visualized by this data series.
8971
8972
8973
8974
8975
8976
8977

<define name="chart-series-attlist" combine="interleave"><optional><attribute name="chart:values-cell-range-address"><ref name="cellRangeAddress"/></attribute></optional></define>

The chart:label-cell-address attribute allows a name to be provided for the series.
8978
8979
8980
8981
8982
8983
8984

<define name="chart-series-attlist" combine="interleave"><optional><attribute name="chart:label-cell-address"><ref name="cellAddress"/></attribute></optional></define>Class
The chart:class attribute can be used to assign a chart type to be used for rendering the dataof this <chart:series> element. A chart:class attribute for a <chart:series> element
overrides the chart:class attribute for the entire chart. This allows the creation of charts withmultiple sub-charts, e.g., a bar chart with one or more data series rendered as lines. For more
information on the available chart classes, see section 10.2.
8985
8986
8987
8988
8989
8990
8991

<define name="chart-series-attlist" combine="interleave"><optional><attribute name="chart:class"><ref name="namespacedToken"/></attribute></optional></define>

Attached Axis
The chart:attached-axis attribute can be used to assign the data series to a<chart:axis> element.
8992
8993
8994
8995
8996
8997
8998

<define name="chart-series-attlist" combine="interleave"><optional><attribute name="chart:attached-axis"><ref name="string"/></attribute></optional></define>

Style Name
Styling attributes for the data series can be assigned through the chart:style-name attribute.
Fill and stroke properties may be applied for <chart:series> element, see sections 15.14 and15.13 for information. Text properties can also be applied to the descriptive text underneath theseries, see section 15.4 for information.
8999<define name="chart-series-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 397 of 738

9000
9001
9002
9003
9004
9005

<optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.9.1 Domain
For scatter and bubble charts, one ore more <chart:domain> elements must be specified forthe <chart:series> elements.
For scatter charts, one <chart:domain> element is required. Its cell-range-address
attribute references the x coordinate values for the scatter chart.
For bubble charts, two <chart:domain> elements are required. Their cell-range-address
attributes reference the x and y coordinate values for the bubble chart
For both chart types, there must be at least one <chart:series> element with the necessary
number of <chart:domain> sub-elements. All other <chart:series> elements can omit
these. In this case, the first domain that is specified is used.
9006
9007
9008
9009
9010
9011
9012
9013
9014

<define name="chart-domain"><element name="chart:domain"><optional><attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute></optional></element></define>

10.10 Categories
The element <chart:categories> element represents the range of cell addresses that
contains the captions for the categories contained in each series.
The element may contain a table:cell-range-address that denotes the region from which
the category labels are taken from. If this attribute or the <chart:categories> element isomitted the application will evaluate the chart:data-source-has-labels attribute.
9015
9016
9017
9018
9019
9020
9021
9022
9023

<define name="chart-categories"><element name="chart:categories"><optional><attribute name="table:cell-range-address"><ref name="cellRangeAddress"/></attribute></optional></element></define>

10.11 Data Point
If a single data point in a data series should have a specific appearance, the <chart:datapoint> element is used to apply the required properties.
9024
9025

<define name="chart-data-point"><element name="chart:data-point">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 398 of 738

9026
9027
9028
9029

<ref name="chart-data-point-attlist"/><empty/></element></define>

Repetition
The chart:repeated attribute serves as a simplification if more than one consecutive datapoints have the same properties. For example, the following XML-fragments have an identicalmeaning:<chart:series chart:style-name="ch9"><chart:data-point/><chart:data-point/><chart:data-point/><chart:data-point/></chart:series>

and<chart:series chart:style-name="ch9"><chart:data-point chart:repeated="4"/></chart:series>
9030
9031
9032
9033
9034
9035
9036

<define name="chart-data-point-attlist" combine="interleave"><optional><attribute name="chart:repeated"><ref name="nonNegativeInteger"/></attribute></optional></define>

Style
The chart:style-name attribute referenced a chart style. Fill and stroke properties can beapplied to each data point object, see sections 15.14 and 15.13. Text properties can also be
applied to the descriptive text located underneath the data points, see section 15.4.
9037
9038
9039
9040
9041
9042
9043

<define name="chart-data-point-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

9044

10.12 Mean Value
The formatting properties of the mean-value line are stored in the <chart:mean-value>element, which may be part of a <chart:series> element.
9045
9046
9047
9048
9049
9050

<define name="chart-mean-value"><element name="chart:mean-value"><ref name="chart-mean-value-attlist"/><empty/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 399 of 738

Style Name
The chart:style-name attribute references a chart style that contains the formatting properties
for the mean-value line.
9051
9052
9053
9054
9055
9056
9057

<define name="chart-mean-value-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.13 Error Indicator
The formatting properties of error-indicators are stored in the <chart:error-indicator>
elements which may be part of a series.
9058
9059
9060
9061
9062
9063

<define name="chart-error-indicator"><element name="chart:error-indicator"><ref name="chart-error-indicator-attlist"/><empty/></element></define>

Style Name
The chart:style-name attribute references a chart style that contains the formatting properties
for the error indicator.
9064
9065
9066
9067
9068
9069
9070

<define name="chart-error-indicator-attlist" combine="interleave"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

10.14 Regression Curves
The formatting properties of regression-lines are stored in the <chart:regression-curve>
elements which may be part of a series.
9071
9072
9073
9074
9075
9076

<define name="chart-regression-curve"><element name="chart:regression-curve"><ref name="chart-regression-curve-attlist"/><empty/></element></define>

Style Name
The chart:style-name attribute referenced a chart style that contains the formatting properties
for the error indicator. The chart style especially may contain the regression type property
specified in section 15.35.1.
9077
9078
9079

<define name="chart-regression-curve-attlist" combine="interleave"><optional><attribute name="chart:style-name">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 400 of 738

9080
9081
9082
9083

<ref name="styleNameRef"/></attribute></optional></define>

10.14.1 Stock Chart Markers
The properties of a stock chart, i.e., the different colors for filling the candlestick-bars or the linestyles of the lines pointing to the high and low values (the range-line), are stored in separate
elements.
The candlestick-bars for stocks that have a higher close-value than open-value take theirformatting from the <chart:stock-gain-marker> element's properties, whereas stocks whichclose value is lower than the open-value, use the properties stored in <chart:stock-lossmarker>.
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098

<define name="chart-stock-gain-marker"><element name="chart:stock-gain-marker"><ref name="common-stock-marker-attlist"/></element></define><define name="chart-stock-loss-marker"><element name="chart:stock-loss-marker"><ref name="common-stock-marker-attlist"/></element></define><define name="chart-stock-range-line"><element name="chart:stock-range-line"><ref name="common-stock-marker-attlist"/></element></define>

Style Name
The chart:style-name attribute referenced a chart style that contains the formatting properties
for stock markers.
9099
9100
9101
9102
9103
9104
9105

<define name="common-stock-marker-attlist"><optional><attribute name="chart:style-name"><ref name="styleNameRef"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 401 of 738

11 Form Content
A form is a container for user interface controls which a user interacts with. For example, buttons,
text boxes, check boxes, and drop-down lists are user interface controls that can be contained ina form. In the XML file format, the following basic rules apply to user interface controls and forms:•

All controls must be located in a form.

•

All controls that are not hidden have to be associated with an absolute or relative position.
These visual aspects of the control are represented by drawing shapes that contain areference to the control. See section 9.2.12 for details.

•

Forms may be nested.

•

Forms are not connected with the text flow and layout of a document. This does not apply tocontrols.

•

Forms can be data-aware. The controls reflect the content of a database.

Forms define rules for the following form behavior:•

Submitting the form, which is similar to [HTML4].
Note: Form submission is only supported for non nested forms that contain only controls thatcan be converted to HTML.

•

Connecting to a data source. When this happens, the controls in a form become data-aware.

•

Submitting and binding according to the [XForms] data model.

Forms are contained in the <office:forms> section of an XML document. This element may
contain an arbitrary sequence of <form:form> or <xforms:model> elements. Note that
controls are always declared inside a <form:form> element, while an <xforms:model>
element contains only the XForms data model. Thus, the <office:forms> element may contain
only <form:form> elements but no <xforms:model> element, while an <xforms:model>
would typically be accompanied by an additional <form:form> element.
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118

<define name="office-forms"><optional><element name="office:forms"><ref name="office-forms-attlist"/><zeroOrMore><choice><ref name="form-form"/><ref name="xforms-model"/></choice></zeroOrMore></element></optional></define>

For ease of use when using (filling out) forms, applications may focus controls initially so that theuser can immediately type into the first form control. To achieve this behavior, theform:automatic-focus flag may be set to true.
9119
9120
9121
9122

<define name="office-forms-attlist" combine="interleave"><optional><attribute name="form:automatic-focus" a:defaultValue="false"><ref name="boolean"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 402 of 738

9123
9124
9125

</attribute></optional></define>

Application which support both creation and usage (filling out) of forms, the form:applydesign-mode flag determines whether the application is supposed to present the forms in thisdocument in editable or fill-out state.
9126
9127
9128
9129
9130
9131
9132

<define name="office-forms-attlist" combine="interleave"><optional><attribute name="form:apply-design-mode" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

11.1 Form
The <form:form> element represents a user interface form and defines the contents andproperties of the form.
This element is contained in either an <office:forms> or a <form:form> element. It contains
the controls and sub forms of the form, a <form:properties> element which defines theproperties of the form, and an <office:events-listeners> element that contains the events
for the form.
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153

<define name="form-form"><element name="form:form"><ref name="common-form-control-attlist"/><ref name="form-form-attlist"/><optional><ref name="form-properties"/></optional><optional><ref name="office-event-listeners"/></optional><zeroOrMore><choice><ref name="controls"/><ref name="form-form"/></choice></zeroOrMore><optional><ref name="form-connection-resource"/></optional></element></define>

The attributes that may be associated with the <form:form> are as follows:•

Name. See section 11.4.

•

Service name. See section 11.4.

•

Action•Target frame•

Method•Encoding TypeOpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 403 of 738

•Allow deletes•

Allow inserts•

Allow updates•

Apply filter•

Command type•Command•

Data source•

Master fields•

Detail fields•

Escape processing•

Filter•Ignore result•

Navigation mode

•

Order

•

Tabbing cycle

11.1.1 Action
The xlink:href attribute represents the IRI of the processing agent for the form.
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170

<define name="form-form-attlist" combine="interleave"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional></optional></define>

11.1.2 Target Frame
The office:target-frame attribute specifies the target frame of the form.
This attribute can have one of the following values:•_self: The form replaces the content of the current frame.

•_blank: The form is displayed in a new frame.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 404 of 738

9171
9172
9173
9174
9175
9176
9177

•

_parent: The form is displayed in the parent frame of the current frame.

•_top: The form is displayed in the topmost frame, that is the frame that contains the current
frame as a child or descendent but is not contained within another frame.

•

A frame name: The form is displayed in the named frame. If the named frame does not exist,a new frame with that name is created.

<define name="form-form-attlist" combine="interleave"><optional><attribute name="office:target-frame" a:defaultValue="_blank"><ref name="targetFrameName"/></attribute></optional></define>

11.1.3 Method
The form:method attribute specifies the HTTP method to use to submit the data in the form to
the server. The value of this attribute can be get or post. The default value is get. These values
are not case sensitive.
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:method" a:defaultValue="get"><choice><value>get</value><value>post</value><ref name="string"/></choice></attribute></optional></define>

11.1.4 Encoding TypeIf the value of the form:method attribute is post, the form:enctype attribute specifies thecontent type used to submit the form to the server. The default value of this attribute isapplication/x-www-form-urlencoded. Other suitable MIME types are also acceptable.
See §17.3 of [HTML4] for more information.
9189
9190
9191
9192
9193
9194
9195
9196

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:enctype"a:defaultValue="application/x-www-form-urlencoded"><ref name="string"/></attribute></optional></define>

11.1.5 Allow Deletes
The form:allow-deletes attribute specifies whether or not data records can be deleted. It
applies only if the form is data-aware.
9197
9198
9199
9200

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:allow-deletes" a:defaultValue="true"><ref name="boolean"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 405 of 738

9201
9202
9203

</attribute></optional></define>

11.1.6 Allow Inserts
The form:allow-inserts attribute specifies whether or not new data records can be inserted.
It applies only if the form is data-aware.
9204
9205
9206
9207
9208
9209
9210

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:allow-inserts" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

11.1.7 Allow Updates
The form:allow-updates attribute specifies whether or not data records can be updated.
9211
9212
9213
9214
9215
9216
9217

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:allow-updates" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

11.1.8 Apply Filter
The form:apply-filter attribute specifies whether or not filters should be applied to the form.
See also the Filter attribute.
9218
9219
9220
9221
9222
9223
9224

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:apply-filter" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.1.9 Command TypeThe form:command-type attribute specifies the type of command to execute on the data
source. The value of this attribute can be one of the following:

9225
9226
9227
9228

•

table: The command contains a table name. The form retrieves all of the data in the table.

•

query: The command contains the name of query. The form retrieves and executes thequery.

•

command : The command contains an SQL statement. The form executes the SQL
statement.

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:command-type" a:defaultValue="command"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 406 of 738

9229
9230
9231
9232
9233
9234
9235

<value>table</value><value>query</value><value>command</value></choice></attribute></optional></define>

11.1.10 Command
The form:command attribute specifies the command to execute on the data source.
The value is interpreted differently, depending to the value of the Command Type attribute of theform. It can be the name of a database table, the name of a query object or an SQL statement.
9236
9237
9238
9239
9240

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:command"/></optional></define>

11.1.11 Data Source
The form:datasource attribute specifies the name of a data source to use for the form.
The value of this attribute can be one of the following:

9241
9242
9243
9244
9245
9246
9247
9248
9249
9250

•

A URL specifying a database connection.

•

A data source name that the office application can use to establish database connections.

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:datasource"><choice><ref name="anyURI"/><ref name="string"/></choice></attribute></optional></define>

11.1.12 Master Fields
The form:master-fields attribute is used for nested data-aware forms. It specifies the namesof the columns in the result set represented by the parent form. Usually, they denote the foreign
key fields of the parent form. The values of the columns are used to parameterize the data for thenested form. Each time the parent form changes the current row, the nested form queries the
database again based on the values of the master fields.
The attribute contains a comma separated list of field names.
9251
9252
9253
9254
9255
9256
9257

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:master-fields"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 407 of 738

11.1.13 Detail Fields
The form:detail-fields attribute is used for nested database forms. It specifies the namesof the columns in detail forms that are related to columns in the parent form. The columns areused as parameters in the command for the nested form to retrieve the details for a matching
master form record.
This attribute contains a comma separated list of field names.
9258
9259
9260
9261
9262
9263
9264

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:detail-fields"><ref name="string"/></attribute></optional></define>

11.1.14 Escape Processing
If the value of the form:command-type attribute is command, the form:escape-processing
attribute specifies whether or not the application processes the command before passing it to the
database driver.
9265
9266
9267
9268
9269
9270
9271

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:escape-processing" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

11.1.15 Filter
The form:filter attribute specifies a filter for the command to base the form on. No matter
whether the form is based on a query, a table, or a command, the filter is always conjunctively
added to any possible existing filter. The filter usually forms a SQL “WHERE” clause, without the“WHERE” keyword.
The form:apply-filter attribute specifies whether or not the filter is actually applies to thecommand.
9272
9273
9274
9275
9276
9277
9278

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:filter"><ref name="string"/></attribute></optional></define>

11.1.16 Ignore Result
The form:ignore-result attribute specifies whether or not to discard all results that are
retrieved from the underlying data source. If true, a database-bound form will discard any data it
queries from the database, and thus only inserting and editing of new records is available.
Essentially, this allows a mode of operation where only new data can be inserted into a database.
9279
9280
9281

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:ignore-result" a:defaultValue="false">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 408 of 738

9282
9283
9284
9285

<ref name="boolean"/></attribute></optional></define>

11.1.17 Navigation Mode
The form:navigation-mode attribute specifies how the records in a database form arenavigated.
The value of this attribute can be one of the following:•

none: A dedicated navigation bar is not provided by the user interface. The form must be
navigated using the TAB and SHIFT/TAB keys on the keyboard.

•current: A navigation bar is provided and the navigation is performed on the current form.

•

parent: A navigation bar is provided and the navigation is performed on the parent form of
the current form.

9286
9287
9288
9289
9290
9291
9292

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:navigation-mode"><ref name="navigation"/></attribute></optional></define>

9293
9294
9295
9296
9297
9298
9299
9300

<define name="navigation"><choice><value>none</value><value>current</value><value>parent</value></choice></define>

11.1.18 Order
The form:order attribute specifies a sort criteria for the command. No matter whether the form
is based on a query, a table, or a command, the sorting is always conjunctively added to any
possible existing sorting. The attribute value usually forms an SQL “ORDER BY” clause, without
the “ORDER BY” keyword.
9301
9302
9303
9304
9305
9306
9307

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:order"><ref name="string"/></attribute></optional></define>

11.1.19 Tabbing Cycle
The form:tab-cycle attribute specifies how the application responds when the user presses
the TAB key in the controls in a form. The behavior of the application depends on whether or not
the form is bound to a data source.
The value of this attribute can be one of the following:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 409 of 738

9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321

•

records: If a user presses the TAB key in the last control of the form, the focus moves to thefirst control specified in the tab order of the same form, and moves the form to the next
record.

•current: If a user presses the TAB key in the last control of the form, the focus moves to thefirst control specified in the tab order of the same form, while the record pointer of the form is
not touched.

•

page: If a user presses the TAB key in the last control of a form, the focus moves to the firstcontrol specified in the tab order for the next form.

<define name="form-form-attlist" combine="interleave"><optional><attribute name="form:tab-cycle"><ref name="tab-cycles"/></attribute></optional></define><define name="tab-cycles"><choice><value>records</value><value>current</value><value>page</value></choice></define>

11.1.20 Connection Resource
The <form:connection-resource> element specifies the source database by an [XLink]. Its
xlink:href attribute either references a file containing a database, or it contains information on
how to make a connection to a database, for instance a [JDBC] URL.
9322
9323
9324
9325
9326
9327
9328
9329

<define name="form-connection-resource"><element name="form:connection-resource"><attribute name="xlink:href"><ref name="anyURI"/></attribute><empty/></element></define>

11.2 XForms Model
The form model described in section 11.1 implies a data model where each control defines a
name-value-pair, with the name being determined by the control id and the value being editablethrough the control. No interaction between controls is possible (save for macro programming).
For applications where this kind of form logic does not suffice, W3C has introduced XForms (see[XForms]), a standard for XML-based forms.
XForms is designed to be embedded in another XML format. It consists of two major parts, the
XForms model which contains the form logic plus form data, and the XForms controls, which canbe bound to a data model. In the OASIS Open Office 1.0 we embed the W3C XForms model as
defined by the <xforms:model> element into the <office:forms> forms container. The
controls (see 11.3) will be left as is, except that they receive an xforms:bind attribute, whichallows to bind any OpenDocument control to a previously defined XForms model.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 410 of 738

11.2.1 XForms Model
We import the XForms model defined in [XForms]. In order to avoid duplication of the XForms
schema here, we only specify the XForms model element and allow arbitrary content.
9330
9331
9332
9333
9334

<define name="xforms-model"><element name="xforms:model"><ref name="anyAttListOrElements"/></element></define>

11.3 Controls
Controls are used to interact with forms. Each control in a form is identified by a name, though thenames must not necessarily be unique.
Controls are connected to a the surrounding document (and its text flow, if applicable) by binding
them to a shape that acts as a placeholder for the control. See section 9.2.12 for details.
In addition to the attributes defined in this file format, controls may have application-specificadditional attributes. These attributes are stored in the <form:properties> element in eachcontrol. Control events are specified in the <office:event-listeners> element.
When a user submits a form for processing, the names of some controls are paired with thecurrent values of the controls and the pairs are submitted with the form. These controls are calledsuccessful controls. See section 17.13.2 of [HTML4]for more information.
The file format provides elements for the following standard controls:
•

Text

•

Text area•

Password

•

File

•

Formatted text•

Number

•

Date

•

Time

•

Fixed text•

Combo box•

List box•

Button

•

Image

•

Check box•

Radio button

•

Frame

•

Image frame

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 411 of 738

•

Hidden•Grid

It is also possible to define application-specific controls. These controls are described by the<form:generic-control> element.

11.3.1 Text
The <form:text> element defines a control for displaying and inputting text.
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369

<define name="column-controls" combine="choice"><element name="form:text"><ref name="form-text-attlist"/><ref name="common-form-control-content"/></element></define><define name="controls" combine="choice"><ref name="column-controls"/></define><define name="form-text-attlist"><ref name="form-control-attlist"/><ref name="common-current-value-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-convert-empty-attlist"/><ref name="common-data-field-attlist"/></define><define name="form-control-attlist"><ref name="common-form-control-attlist"/><ref name="common-control-id-attlist"/><ref name="xforms-bind-attlist"/></define><define name="common-form-control-content"><optional><ref name="form-properties"/></optional><optional><ref name="office-event-listeners"/></optional></define>

The attributes that may be associated with the <form:text> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab
Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

11.3.2 Text Area
The <form:textarea> element defines a control for displaying and inputting text on multiplelines.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 412 of 738

The <form:textarea> element may be used with plain text values (specified by theform:current-value attribute) as well as with formatted text (specified as paragraph content).
If both, the form:current-value and one or more <text:p> elements are present, it is up to
the application reading the document to decide which information is used.
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391

<define name="column-controls" combine="choice"><element name="form:textarea"><ref name="form-textarea-attlist"/><ref name="common-form-control-content"/><zeroOrMore><ref name="text-p"/></zeroOrMore></element></define><define name="form-textarea-attlist"><ref name="form-control-attlist"/><ref name="common-current-value-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-convert-empty-attlist"/><ref name="common-data-field-attlist"/></define>

The attributes that may be associated with the <form:textarea> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab
Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

11.3.3 Password
The <form:password> element defines a control that hides the text that a user inputs using anecho character, for example, an asterisk. This type of control is usually used for inputting sensitive
information such as a password.
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407

<define name="controls" combine="choice"><element name="form:password"><ref name="form-password-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-password-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-convert-empty-attlist"/></define>

The attributes that may be associated with the <form:password> element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 413 of 738

•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Tab Index, Tab Stop, Title and Value. See
section 11.5 for information about these attributes.

•

Echo Char

Echo CharThe form:echo-char attribute specifies the character that the form uses to mask the text which
a user inputs in a password control.
9408
9409
9410
9411
9412
9413
9414

<define name="form-password-attlist" combine="interleave"><optional><attribute name="form:echo-char" a:defaultValue="*"><ref name="character"/></attribute></optional></define>

11.3.4 File
The <form:file> element defines a control for selecting a file.
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431

<define name="controls" combine="choice"><element name="form:file"><ref name="form-file-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-file-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-current-value-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/></define>

The attributes that may be associated with the <form:file> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Printable, Read only, Tab Index, Tab Stop, Title andValue. See section 11.5 for information about these attributes.

11.3.5 Formatted Text
The <form:formatted-text> element defines a control for inputting formatted text, which
follows a certain formatting in both input and display.
9432
9433
9434
9435
9436
9437

<define name="column-controls" combine="choice"><element name="form:formatted-text"><ref name="form-formatted-text-attlist"/><ref name="common-form-control-content"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 414 of 738

9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450

<define name="form-formatted-text-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-current-value-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-convert-empty-attlist"/><ref name="common-data-field-attlist"/></define>

The attributes that may be associated with the <form:formatted-text> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab
Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Maximum Value•

Minimum Value•

Validation

Maximum Value
The form:max-value attribute specifies the maximum value that a user can enter.
9451
9452
9453
9454
9455
9456
9457

<define name="form-formatted-text-attlist" combine="interleave"><optional><attribute name="form:max-value"><ref name="string"/></attribute></optional></define>

Minimum Value
The form:min-value attribute specifies the minimum value that a user can enter.
9458
9459
9460
9461
9462
9463
9464

<define name="form-formatted-text-attlist" combine="interleave"><optional><attribute name="form:min-value"><ref name="string"/></attribute></optional></define>

Validation
The form:validation attribute specifies whether or not the text that the user enters is
validated during input.
9465
9466
9467

<define name="form-formatted-text-attlist" combine="interleave"><optional><attribute name="form:validation" a:defaultValue="false">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 415 of 738

9468
9469
9470
9471

<ref name="boolean"/></attribute></optional></define>

11.3.6 Number
The <form:number> element describes a control which allows the user to enter a floating point
number. The attributes that may be associated on this control are similar to those of the<form:formatted-text>, except that the data type is fixed to numeric data.
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489

<define name="column-controls" combine="choice"><element name="form:number"><ref name="form-number-attlist"/><ref name="common-numeric-control-attlist"/><ref name="common-form-control-content"/></element></define><define name="common-numeric-control-attlist"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-convert-empty-attlist"/><ref name="common-data-field-attlist"/></define>

The attributes that may be associated with the <form:number> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title andValue. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Value and Current Value•

Minimum and Maximum Value

Value
The attributes for value and current value are the same as those for other fields, except that they
can contain only floating point data.
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502

<define name="form-number-attlist" combine="interleave"><optional><attribute name="form:value"><ref name="double"/></attribute></optional></define><define name="form-number-attlist" combine="interleave"><optional><attribute name="form:current-value"><ref name="double"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 416 of 738

9503</define>

Minimum and Maximum
The attributes for minimum and maximum value define the smallest and largest numerical values
that are acceptable for this control.
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517

<define name="form-number-attlist" combine="interleave"><optional><attribute name="form:min-value"><ref name="double"/></attribute></optional></define><define name="form-number-attlist" combine="interleave"><optional><attribute name="form:max-value"><ref name="double"/></attribute></optional></define>

11.3.7 Date And Time
The controls for date and time are the same as those for number values, except that they accept
date and time values, respectively. They support the same attributes as the numerical field,
except for the different data types of their value attributes.
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531

<define name="column-controls" combine="choice"><element name="form:date"><ref name="form-date-attlist"/><ref name="common-numeric-control-attlist"/><ref name="common-form-control-content"/></element></define><define name="controls" combine="choice"><element name="form:time"><ref name="form-time-attlist"/><ref name="common-numeric-control-attlist"/><ref name="common-form-control-content"/></element></define>

The attributes that may be associated with the <form:date> and <form:time> elements are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title andValue. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Value and Current Value•

Minimum and Maximum Value

Value
The attributes for value and current value are the same as those for <form:number>, exceptthat they can contain only date or time data, respectively.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 417 of 738

9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559

<define name="form-date-attlist" combine="interleave"><optional><attribute name="form:value"><ref name="date"/></attribute></optional></define><define name="form-time-attlist" combine="interleave"><optional><attribute name="form:value"><ref name="time"/></attribute></optional></define><define name="form-date-attlist" combine="interleave"><optional><attribute name="form:current-value"><ref name="date"/></attribute></optional></define><define name="form-time-attlist" combine="interleave"><optional><attribute name="form:current-value"><ref name="time"/></attribute></optional></define>

Minimum and Maximum
The attributes for minimum and maximum value define the smallest and largest dates (or times)that are acceptable for this control.
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586

<define name="form-date-attlist" combine="interleave"><optional><attribute name="form:min-value"><ref name="date"/></attribute></optional></define><define name="form-time-attlist" combine="interleave"><optional><attribute name="form:min-value"><ref name="time"/></attribute></optional></define><define name="form-date-attlist" combine="interleave"><optional><attribute name="form:max-value"><ref name="date"/></attribute></optional></define><define name="form-time-attlist" combine="interleave"><optional><attribute name="form:max-value"><ref name="time"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 418 of 738

9587</define>

11.3.8 Fixed Text
The <form:fixed-text> element describes a control which attaches additional information tocontrols, or merely displays information in the application. Relations between a labeling and alabeled control can be established by specifying the form:for attribute of the label. Only one
label may be associated with the same control.
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601

<define name="controls" combine="choice"><element name="form:fixed-text"><ref name="form-fixed-text-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-fixed-text-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="for"/><ref name="common-disabled-attlist"/><ref name="label"/><ref name="common-printable-attlist"/><ref name="common-title-attlist"/></define>

The attributes that may be associated with the <form:fixed-text> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, For, Label, Printable, and Title. See section 11.5 for information about
these attributes.

•

Multi-LineMulti-Line
The form:multi-line attribute specifies whether or not the label is displayed on multiple lines.
9602
9603
9604
9605
9606
9607
9608

<define name="form-fixed-text-attlist" combine="interleave"><optional><attribute name="form:multi-line" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.3.9 Combo Box
The <form:combobox> element defines a control which allows displaying and editing of text,
and containing a list of possible values for this text.
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618

<define name="column-controls" combine="choice"><element name="form:combobox"><ref name="form-combobox-attlist"/><ref name="common-form-control-content"/><zeroOrMore><ref name="form-item"/></zeroOrMore></element></define><define name="form-combobox-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 419 of 738

9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634

<ref name="form-control-attlist"/><ref name="common-current-value-attlist"/><ref name="common-disabled-attlist"/><ref name="dropdown"/><ref name="common-maxlength-attlist"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="size"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-convert-empty-attlist"/><ref name="common-data-field-attlist"/><ref name="list-source"/><ref name="list-source-type"/></define>

The attributes that may be associated with the <form:combobox> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Dropdown, Max Length, Printable, Read only, Size, Tab
Index, Tab Stop, Title, and Value. See section 11.5 for information about these attributes.

•

Convert Empty, Data Field, List Source, and List Source Type. See section 11.5.22 for
information about these attributes.

•

Automatic Completion

Automatic Completion
The form:auto-complete attribute specifies whether, when the user enters text in the
combobox that matches one of the list items in the combobox, the application automaticallycompletes the text for the user.
9635
9636
9637
9638
9639
9640
9641

<define name="form-combobox-attlist" combine="interleave"><optional><attribute name="form:auto-complete"><ref name="boolean"/></attribute></optional></define>

Item
The <form:item> element defines a list item for a combobox control.
9642
9643
9644
9645
9646
9647
9648
9649
9650

<define name="form-item"><element name="form:item"><ref name="form-item-attlist"/><text/></element></define><define name="form-item-attlist" combine="interleave"><ref name="label"/></define>

The attribute that may be associated associate with the <form:item> element is:•Label. See section 11.5 for information about this attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 420 of 738

11.3.10 List Box
The <form:listbox> element defines an input control that allows a user to select one or more
items from a list. It is an alternative representation for a group of radio buttons.
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672

<define name="column-controls" combine="choice"><element name="form:listbox"><ref name="form-listbox-attlist"/><ref name="common-form-control-content"/><zeroOrMore><ref name="form-option"/></zeroOrMore></element></define><define name="form-listbox-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="dropdown"/><ref name="common-printable-attlist"/><ref name="size"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="bound-column"/><ref name="common-data-field-attlist"/><ref name="list-source"/><ref name="list-source-type"/></define>

The attributes that may be associated with the <form:listbox> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Dropdown, Printable, Read only, Size, Tab Index, Tab Stop, and Title.
See section 11.5 for information about these attributes.

•

Bound Column, Data Field, List Source, and List Source Type. See section 11.5.22 for
information about these attributes.

•

Multiple•

XForms source

Multiple
The form:multiple attribute determines whether or not a user can select multiple items from alist box.
9673
9674
9675
9676
9677
9678
9679

<define name="form-listbox-attlist" combine="interleave"><optional><attribute name="form:multiple" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

XForms source
The form:xforms-list-source allows to dynamically create the list of choices by binding thelist content to XForms (see section 11.2, as well as [XForms]). The attribute references an<xforms:bind> element, and creates a list entry for each node in the node-set defined by that
attribute.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 421 of 738

9680
9681
9682
9683
9684
9685
9686

<define name="form-listbox-attlist" combine="interleave"><optional><attribute name="form:xforms-list-source"><ref name="string"/></attribute></optional></define>

OptionThe <form:option> element defines the list items for a list box control. An item can bepreselected and can contain a related value.
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698

<define name="form-option"><element name="form:option"><ref name="form-option-attlist"/><text/></element></define><define name="form-option-attlist" combine="interleave"><ref name="current-selected"/><ref name="selected"/><ref name="label"/><ref name="common-value-attlist"/></define>

The attributes that may be associated with the <form:option> element are:•

Current Selected, Selected, Label, and Value. See section 11.5 for information about these
attributes.

11.3.11 Button
The <form:button> element defines a button. When pressed, a button usually triggers anaction.
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718

<define name="controls" combine="choice"><element name="form:button"><ref name="form-button-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-button-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="button-type"/><ref name="common-disabled-attlist"/><ref name="label"/><ref name="image-data"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="target-frame"/><ref name="target-location"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-form-relative-image-position-attlist"/></define>

The attributes that may be associated with the <form:button> element are:•Name and Service Name. See section 11.4 for information about these attributes.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 422 of 738

•

Button Type, Control ID, Disabled, Image Data, Printable, Tab Index, Tab Stop, Target
Frame, Target Location, Title, Value and relative image position. See section 11.5 for
information about these attributes.

•

Default Button•

Toggle•Focus on Click•

XForms Submission

Default Button
The form:default-button attribute determines whether or not the button is the default buttonon the form. If a user clicks the default button or presses Return while an input control is focused,
the application takes the same action.
If a form contains more than one default button, the behavior of the application is undefined.
9719
9720
9721
9722
9723
9724
9725

<define name="form-button-attlist" combine="interleave"><optional><attribute name="form:default-button" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Toggle
The form:toggle attribute specifies whether a form button control, when it is operated (viamouse or keyboard), should be toggled between a "pressed" and a "not pressed" state. If this
attribute is set to false, the button controls behaves like a push button.
9726
9727
9728
9729
9730
9731
9732

<define name="form-button-attlist" combine="interleave"><optional><attribute name="form:toggle" a:default-value="false"><ref name="boolean"/></attribute></optional></define>

Focus on click
The form:focus-on-click attribute specifies whether a form button control should grab the
focus when it is clicked with the mouse.
9733
9734
9735
9736
9737
9738
9739

<define name="form-button-attlist" combine="interleave"><optional><attribute name="form:focus-on-click"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 423 of 738

XForms Submission
Buttons may be used to trigger an XForms submission by adding an form:xformssubmission attribute. If such a button is triggered, a previously declared XForms submission
with the given name is executed.
9740
9741
9742
9743
9744
9745
9746

<define name="form-button-attlist" combine="interleave"><optional><attribute name="form:xforms-submission"><ref name="string"/></attribute></optional></define>

11.3.12 Image
The <form:image> element defines a graphical button control. This element corresponds to the
input element of type image in HTML 4.01. Note: HTML 4.01 only allows the button type to be“submit” for an image button. In office application file format, an image button can be of any type.
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764

<define name="controls" combine="choice"><element name="form:image"><ref name="form-image-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-image-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="button-type"/><ref name="common-disabled-attlist"/><ref name="image-data"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="target-frame"/><ref name="target-location"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/></define>

The attributes that may be associated with the <form:image> element are:● Name and Service Name. See section 11.4 for information about these attributes.
● Button Type, Control ID, Disabled, Image Data, Printable, Tab Index, Tab Stop, Target Frame,

Target Location, Title, and Value. See section 11.5 for information about these attributes.

11.3.13 Check Box
The <form:checkbox> element defines an on/off control which a user can toggle. The control ison when the value of the form:current-state attribute associated with the control element ischecked. When a user submits a form, only the controls whose current state is checked aresuccessful.
9765
9766
9767
9768
9769
9770
9771

<define name="column-controls" combine="choice"><element name="form:checkbox"><ref name="form-checkbox-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-checkbox-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 424 of 738

9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782

<ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="label"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-data-field-attlist"/><ref name="common-form-visual-effect-attlist"/><ref name="common-form-relative-image-position-attlist"/></define>

The attributes that may be associated with the <form:checkbox> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Label, Printable, Tab Index, Tab Stop, Title, Value, Visual Effect andRelative Image Position. See section 11.5 for information about these attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

•

Current State•Is Tristate

•

State

Current StateThe form:current-state attribute specifies the current state of the check box control.
The value of this attribute can be one of the following:

9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796

•

unchecked: The check box is not checked.

•

checked: The check box is checked. The value of the control is submitted with the form.

•

unknown: This value is only available when the control is in tristate mode (See the "Is Tristate"
attribute) . This value may, for instance, be used in connection with a database field binding toindicate that the value is NULL.

<define name="states"><choice><value>unchecked</value><value>checked</value><value>unknown</value></choice></define><define name="form-checkbox-attlist" combine="interleave"><optional><attribute name="form:current-state"><ref name="states"/></attribute></optional></define>

Is Tristate
The form:is-tristate attribute specifies that the check box can have three states instead of
the common two states.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 425 of 738

9797
9798
9799
9800
9801
9802
9803

<define name="form-checkbox-attlist" combine="interleave"><optional><attribute name="form:is-tristate" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

State
The form:state attribute specifies the default state of the check box control. This state is used
to initialize the control.
9804
9805
9806
9807
9808
9809
9810

<define name="form-checkbox-attlist" combine="interleave"><optional><attribute name="form:state" a:defaultValue="unchecked"><ref name="states"/></attribute></optional></define>

11.3.14 Radio Button
The <form:radio> element describes controls which act like check boxes except that whenseveral radio buttons share the same control name they are mutually exclusive. When one button
is on, all of the other buttons with the same name are off. If no radio button is initially on, the way
in which the application chooses which button to turn on initially is undefined.
If a group of radio buttons is bound to one database field, the reference value of the selected radio
button is written into the database field.
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830

<define name="controls" combine="choice"><element name="form:radio"><ref name="form-radio-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-radio-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="current-selected"/><ref name="common-disabled-attlist"/><ref name="label"/><ref name="common-printable-attlist"/><ref name="selected"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/><ref name="common-data-field-attlist"/><ref name="common-form-visual-effect-attlist"/><ref name="common-form-relative-image-position-attlist"/></define>

The attributes that may be associated with the <form:radio> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Selected, Disabled, Label, Printable, Selected, Tab Index, Tab Stop, Title,
Value, Visual Effect and Relative Image Position. See section 11.5 for information about these
attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 426 of 738

11.3.15 Frame
The <form:frame> element defines a frame, which may be used to arrange controls visually.
This element does not have a value and it does not allow any user input.
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844

<define name="controls" combine="choice"><element name="form:frame"><ref name="form-frame-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-frame-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="for"/><ref name="label"/><ref name="common-printable-attlist"/><ref name="common-title-attlist"/></define>

The attributes that may be associated with the <form:frame> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, For, Label, Printable, and Title. See section 11.5 for information about
these attributes.

11.3.16 Image Frame
The <form:image-frame> element defines a graphical control. The control displays an image,whose location is described in the control.
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859

<define name="controls" combine="choice"><element name="form:image-frame"><ref name="form-image-frame-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-image-frame-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="image-data"/><ref name="common-printable-attlist"/><ref name="common-readonly-attlist"/><ref name="common-title-attlist"/><ref name="common-data-field-attlist"/></define>

The attributes that may be associated with the <form:image-frame> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Image Data, Printable, Read only, and Title. See section 11.5 for
information about these attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

11.3.17 Hidden
The <form:hidden> element defines a control that does not have a visual representation. Thiselement is usually used as a container for information.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 427 of 738

9860
9861
9862
9863
9864
9865
9866
9867
9868
9869

<define name="controls" combine="choice"><element name="form:hidden"><ref name="form-hidden-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-hidden-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-value-attlist"/></define>

The attributes that may be associated with the <form:hidden> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Value. See section 11.5 for information about this attribute.

11.3.18 Grid
The <form:grid> element defines a control that displays table data. This control is data-aware
and is bound to a form which retrieves data from a data source. The actual data to display in agrid control is determined by the parent form, which is data-aware and thus based on a certain
row set. The rows in the grid contain these data rows.
Each column in the grid is specified by a <form:column> element. Each column is bound to a
field in the form's row set.
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885

<define name="controls" combine="choice"><element name="form:grid"><ref name="form-grid-attlist"/><ref name="common-form-control-content"/><zeroOrMore><ref name="form-column"/></zeroOrMore></element></define><define name="form-grid-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/></define>

The attributes that may be associated with the <form:grid> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Printable, Tab Index, Tab Stop, and Title. See section 11.5 for
information about these attributes.

ColumnThe <form:column> element defines a column in a grid control. The column contains a control
that displays the grid data for the column.
9886
9887
9888
9889
9890

<define name="form-column"><element name="form:column"><ref name="form-column-attlist"/><oneOrMore><ref name="column-controls"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 428 of 738

9891
9892
9893
9894
9895
9896
9897
9898

</oneOrMore></element></define><define name="form-column-attlist" combine="interleave"><ref name="common-form-control-attlist"/><ref name="label"/><ref name="text-style-name"/></define>

The attributes that may be associated with the <form:column> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Label. See section 11.5 for information about this attribute.

•

Column Style

Column Style
The form:text-style-name attribute specifies paragraph style that is applied to all controls
with the column. See also section 9.2.12. Unlike other paragraph styles, this style may reference adata style.
9899
9900
9901
9902
9903
9904
9905

<define name="text-style-name"><optional><attribute name="form:text-style-name"><ref name="styleNameRef"/></attribute></optional></define>

11.3.19 Value Range
The new <form:value-range> element defines a control which allows the user to select avalue from a continuous number range. Possible representations include scroll bars and spinbuttons.
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919

<define name="controls" combine="choice"><element name="form:value-range"><ref name="form-value-range-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-value-range-attlist" combine="interleave"><ref name="form-control-attlist"/><ref name="common-disabled-attlist"/><ref name="common-printable-attlist"/><ref name="common-tab-attlist"/><ref name="common-title-attlist"/><ref name="common-value-attlist"/></define>

The attributes that may be associated with a <form:value-range> element are:•Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Printable, Read only, Tab Index, Tab Stop, Title andValue. See section 11.5 for information about these attributes.

•

Maximum Value

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 429 of 738

•Minimum Value•

Step Size•

Page Step Size•

Repeat Delay•

Orientation

Maximum Value
The form:max-value attribute specifies the maximum value that a user can enter.
9920
9921
9922
9923
9924
9925
9926

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:max-value"><ref name="string"/></attribute></optional></define>

Minimum Value
The form:min-value attribute specifies the minimum value that a user can enter.
9927
9928
9929
9930
9931
9932
9933

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:min-value"><ref name="string"/></attribute></optional></define>

Step Size
The form:step-size attribute specifies the increment to be used for a control representing avalue.
9934
9935
9936
9937
9938
9939
9940

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:step-size" a:defaultName="1"><ref name="positiveInteger"/></attribute></optional></define>

Page Step Size
The form:page-step-size attribute specifies a second-level increment to be used for acontrol representing a value. In the user interface, this is usually associated with the user pressingthe "Page Up" or "Page Down" key.
9941
9942
9943
9944
9945
9946
9947

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:page-step-size"><ref name="positiveInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 430 of 738

Repeat Delay
The form:delay-for-repeat attribute specifies a time-out to be used before a pressedmouse button results in repeating an action.
9948
9949
9950
9951
9952
9953
9954

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:delay-for-repeat"><ref name="duration"/></attribute></optional></define>

Orientation
The form:orientation attribute specifies the orientation of the control, which could be either
horizontal or vertical.
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964

<define name="form-value-range-attlist" combine="interleave"><optional><attribute name="form:orientation"><choice><value>horizontal</value><value>vertical</value></choice></attribute></optional></define>

11.3.20 Generic Control
The <form:generic-control> element defines a placeholder for a generic control. The
generic control can contain any properties and any events. The application detects the type of thecontrol and instantiates the correct control.
9965
9966
9967
9968
9969
9970
9971
9972
9973

<define name="controls" combine="choice"><element name="form:generic-control"><ref name="form-generic-control-attlist"/><ref name="common-form-control-content"/></element></define><define name="form-generic-control-attlist" combine="interleave"><ref name="form-control-attlist"/></define>

The attributes that may be associated with the <form:generic-control> element are:•Name and Service Name. See section 11.4 for information about these attributes.

11.4 Common Form and Control Attributes
11.4.1 Name
The form:name attribute specifies the name of the form or control element. This may be used togive a form or control element an identity, which is important for scripting and for submitting thecontent of controls.
9974<define name="common-form-control-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 431 of 738

9975
9976
9977
9978
9979
9980

<optional><attribute name="form:name"><ref name="string"/></attribute></optional></define>

11.4.2 Control Implementation
A control may be given a control type attribute, which determines which concrete rendition or
implementation the user agent should instantiate. For easy extensibility, the value of this attributeis a namespaced token, i.e., it is token using a namespace prefix, much like attributes in XML.
9981
9982
9983
9984
9985
9986
9987

<define name="common-form-control-attlist" combine="interleave"><optional><attribute name="form:control-implementation"><ref name="namespacedToken"/></attribute></optional></define>

11.4.3 Bind to XForms
Any control can be bound to an XForms form (see section 11.2, as well as [XForms]) by using thexforms:bind attribute. With buttons the bind attribute refers to an <xforms:submission>
element with the given ID. Pushing the button causes the appropriate XForms submission action
to be performed. For all other control types, the xforms:bind attribute refers to an<xforms:bind> element with the given ID. Any such bound control reads and writes its data as
determined by the appropriate bind element.
9988
9989
9990
9991
9992
9993
9994

<define name="xforms-bind-attlist"><optional><attribute name="xforms:bind"><ref name="string"/></attribute></optional></define>

11.5 Common Control Attributes
11.5.1 Button TypeThe form:button-type attribute specifies the type of a button. This attribute is supported forthe following elements:•<form:button>•<form:image>The value of this attribute can be one of the following:•submit: Pressing the button submits the form.

•

reset: Pressing the button resets every control in the form to its default value.

•

push: Pressing the button does not perform any action by default. The use then can add
scripts to the button. and the script is run when the button is pressed.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 432 of 738

•
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009

url: Pressing the button loads the URL that is specified in the form:target-url attribute.

<define name="types"><choice><value>submit</value><value>reset</value><value>push</value><value>url</value></choice></define><define name="button-type"><optional><attribute name="form:button-type" a:defaultValue="push"><ref name="types"/></attribute></optional></define>

11.5.2 Control ID
All controls except Hidden Controls have a visual representation in the host document. Thus, theyneed an absolute or relative position, describing the location in the document. The position isrepresented by a shape that contains a reference to the control element within the form element.
The form:id attribute is used to uniquely identify a control element. Every control that is not
hidden must have such an attribute associated with it, which in turn can be used to reference thecontrol.
This attribute is supported for the following elements:

10010
10011

•

<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:fixed-text>•<form:combobox>•<form:listbox>•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:frame>•<form:image-frame>•<form:grid><define name="common-control-id-attlist"><attribute name="form:id">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 433 of 738

10012
10013
10014<ref name="ID"/></attribute></define>

11.5.3 Current Selected
The form:current-selected attribute determines the current state of a radio button or option
element.
This attribute is supported for the following elements:

10015
10016
10017
10018
10019
10020
10021

•

<form:option>•<form:radio><define name="current-selected"><optional><attribute name="form:current-selected" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.5.4 Value and Current Value
Every control has a default value and a current value. The current value changes with userinteraction; the default value of a control does not. In general, the default value is specified in aform:value attribute.
The default value is used during special events, such as resetting the form, which transfers thedefault value of every control to its current value. If a control does not have a default value, theresult of resetting the form is undefined.
Besides storing the current value together with the control, it is also possible to bind controls toother value providers, which act as value sink and source, such as database fields (in data-aware
forms) or e.g., cells in a spreadsheet document the controls live in. In this case, the current value
is not stored with the control itself, but in the external instance, which may or may not store it
together with the document. See section 11.5.22 for more details on database properties.

Default Value
The form:value attribute specifies the default value of an input control. This attribute issupported for the following elements:•<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:combobox>•<form:option>•<form:button>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 434 of 738

10022
10023
10024
10025
10026
10027
10028

•

<form:image>•<form:checkbox>•<form:radio>•<form:hidden><define name="common-value-attlist"><optional><attribute name="form:value"><ref name="string"/></attribute></optional></define>

Current Value
The form:current-value attribute specifies the current status of an input control. It overrides
the value of a form:value attribute, if one is present.
This attribute is supported for the following elements:

10029
10030
10031
10032
10033
10034
10035

•

<form:text>•<form:textarea>•<form:file>•<form:formatted-text>•<form:combobox><define name="common-current-value-attlist"><optional><attribute name="form:current-value"><ref name="string"/></attribute></optional></define>

11.5.5 Disabled
The form:disabled attribute specifies whether or not a control can accept user input. This
attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:fixed-text>•<form:combobox>•<form:listbox>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 435 of 738

•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:frame>•<form:image-frame>•<form:grid>Controls that are disabled are not included in the tabbing navigation sequence and can not be
focused.
10036
10037
10038
10039
10040
10041
10042

<define name="common-disabled-attlist"><optional><attribute name="form:disabled" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.5.6 Dropdown
The form:dropdown attribute specifies whether the list in a combo box or list box is always
visible or is only visible when the user clicks the drop-down button. This attribute is supported forthe following elements:•<form:combobox>•<form:listbox>

If the value is true, the list is always visible. If the value is false, the list is only visible when theuser clicks the drop-down button.
10043
10044
10045
10046
10047
10048
10049

<define name="dropdown"><optional><attribute name="form:dropdown" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.5.7 For
The form:for attribute specifies the IDs of the controls with which control element is labeling.
This attribute is supported for the following elements:•<form:fixed-text>•<form:frame>

This attribute contains a comma separated list of control IDs.
10050
10051
10052
10053

<define name="for"><optional><attribute name="form:for"><ref name="string"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 436 of 738

1005410055
10056</attribute></optional></define>

11.5.8 Image Data
The form:image-data attribute links the control to an external file containing image data. This
attribute is supported for the following elements:

10057
10058
10059
10060
10061
10062
10063

•

<form:button>•<form:image>•<form:image-frame><define name="image-data"><optional><attribute name="form:image-data"><ref name="anyURI"/></attribute></optional></define>

11.5.9 LabelThe form:label attribute contains a label for a control such as a radio button or check box. This
attribute is supported for the following elements:

10064
10065
10066
10067
10068
10069
10070

•

<form:fixed-text>•<form:item>•<form:option>•<form:checkbox>•<form:radio>•<form:frame>•<form:column><define name="label"><optional><attribute name="form:label"><ref name="string"/></attribute></optional></define>

11.5.10 Maximum Length
The form:max-length attribute specifies the maximum number of characters that a user canenter in an input control. This attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:password>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 437 of 738

•<form:formatted-text>•<form:combobox>

The default value of this attribute is unlimited, which allows a user to enter an unlimited number ofcharacters.
10071
10072
10073
10074
10075
10076
10077

<define name="common-maxlength-attlist"><optional><attribute name="form:max-length"><ref name="nonNegativeInteger"/></attribute></optional></define>

11.5.11 Printable
The form:printable attribute specifies whether or not a control is printed when a user prints
the document in which the control is contained. This attribute is supported for the following
elements:

10078
10079
10080
10081
10082
10083
10084

•

<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:fixed-text>•<form:combobox>•<form:listbox>•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:frame>•<form:image-frame>•<form:grid><define name="common-printable-attlist"><optional><attribute name="form:printable" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 438 of 738

11.5.12 Read only
The form:readonly attribute specifies whether or not a user can modify the value of a control.
This attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:file>•<form:formatted-text>•<form:combobox>•<form:listbox>•<form:image-frame>

Read-only controls are included in the tabbing navigation sequence.
10085
10086
10087
10088
10089
10090
10091

<define name="common-readonly-attlist"><optional><attribute name="form:readonly" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.5.13 Selected
The form:selected attribute specifies the default state of a radio button or option. When thecontrol is initialized, it is in the default state specified by this attribute. This attribute is supported
for the following elements:•<form:option>•<form:radio>

In a group of radio buttons that share the same name, only one radio button can have this
attribute set to true.
10092
10093
10094
10095
10096
10097
10098

<define name="selected"><optional><attribute name="form:selected" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

11.5.14 Size
The form:size attribute specifies the number of rows that are visible at a time in a combo box
list or a list box list. This attribute is supported for the following elements:

10099
10100

•

<form:combobox>•<form:listbox><define name="size"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 439 of 738

10101
10102
10103
10104
10105

<attribute name="form:size"><ref name="nonNegativeInteger"/></attribute></optional></define>

11.5.15 Tab Index
The form:tab-index attribute specifies the tabbing navigation order of a control within a form.
The tabbing order is the order in which controls are given focus when a user navigates throughthe form using the TAB key on the keyboard. The tabbing order can include elements that arenested in other elements. This attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:combobox>•<form:listbox>•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:grid>

The rules for tabbing are similar to the tabbing rules used in HTML 4.0.
Controls that can be given focus are navigated in the order described in the following rules:
1. The controls that have a positive value for the form:tab-index attribute are navigated first.
2. The navigation starts at the control with lowest form:tab-index value and ends at thecontrol with the highest value. Values do not have to be sequential and they do not have to
begin with a particular value.
3. Controls that have the same values for the form:tab-index attribute are navigated according
their position in the form.
4. Controls that do not contain the form:tab-index attribute or contain the attribute with avalue of 0 are navigated next. These controls are navigated according to their position in theform.
5. Controls that have the form:disabled attribute set to true are not included in thenavigation, independent on their form:tab-index value.
10106
10107
10108
10109

<define name="common-tab-attlist" combine="interleave"><optional><attribute name="form:tab-index" a:defaultValue="0"><ref name="nonNegativeInteger"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 440 of 738

1011010111
10112</attribute></optional></define>

11.5.16 Tab Stop
The form:tab-stop attribute specifies whether or not a control is included in the tabbing
navigation order. This attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:combobox>•<form:listbox>•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:grid>If the value is false, the control is not included in the tabbing navigation.
10113
10114
10115
10116
10117
10118
10119

<define name="common-tab-attlist" combine="interleave"><optional><attribute name="form:tab-stop" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

11.5.17 Target Frame
The office:target-frame attribute specifies the link target frame of the area. This attribute issupported for the following elements:

10120
10121
10122
10123
10124
10125
10126

•

<form:button>•<form:image><define name="target-frame"><optional><attribute name="office:target-frame" a:defaultValue="_blank"><ref name="targetFrameName"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 441 of 738

11.5.18 Target Location
An xlink:href attribute specifies the URL that is loaded if a button is clicked. This attribute issupported for the following elements:•<form:button>•<form:image>This attribute is only evaluated if the value of the form:button-type attribute is location.
10127
10128
10129
10130
10131
10132
10133

<define name="target-location"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></optional></define>

11.5.19 Title
The form:title attribute contains additional information about a control. The value of theattribute can be used as a tool tip. This attribute is supported for the following elements:

10134
10135
10136
10137
10138

•

<form:text>•<form:textarea>•<form:password>•<form:file>•<form:formatted-text>•<form:fixed-text>•<form:combobox>•<form:listbox>•<form:button>•<form:image>•<form:checkbox>•<form:radio>•<form:image>•<form:image-frame>•<form:grid><define name="common-title-attlist"><optional><attribute name="form:title"/></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 442 of 738

11.5.20 Visual Effect
The form:visual-effect attributes specifies a visual affect to apply to a control. The attributevalues can be flat for a flat visual effect and 3d for a 3D effect. This attribute is supported forthe following elements:

10139
10140
10141
10142
10143
10144
10145
10146
10147
10148

•

<form:checkbox>•<form:radio><define name="common-form-visual-effect-attlist" combine="interleave"><optional><attribute name="form:visual-effect"><choice><value>flat</value><value>3d</value></choice></attribute></optional></define>

11.5.21 Relative Image Position
The form:image-position and form:image-align together specify the position of animage to be displayed in a form control, relative to the label text.
If the form:image-position attribute has the value center, the image shown in a control
should be centered relative to the control's text.
If the form:image-position attribute has one of the values start, end, top, bottom, theimage is to be placed before, after, above, or below the text. In this case, the form:imagealign attribute specifies which border (start, end) or axis (center) of the image and the text
are to be aligned. If the form:image-position attribute is not present, it is assumed to becenter. The form:image-position and form:image-align attributes are supported forthe following elements:

10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166

•

<form:button>•<form:checkbox>•<form:radio><define name="common-form-relative-image-position-attlist"
combine="interleave"><choice><optional><attribute name="form:image-position" a:defaultValue="center"><value>center</value></attribute></optional><group><attribute name="form:image-position"><choice><value>start</value><value>end</value><value>top</value><value>bottom</value></choice></attribute><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 443 of 738

10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177

<attribute name="form:image-align" a:defaultValue="center"><choice><value>start</value><value>center</value><value>end</value></choice></attribute></optional></group></choice></define>

11.5.22 Database Binding Attributes
A control may be bound to a database fields. In this case, the controls becomes data-aware. The
control acquires the values of a database field by going through a result set that is provided by theform. Each time there is a row change in the form, the value of the control may change. The valuechanges are stored in the associated database field.

Bound Column
The form:bound-column attribute specifies the column values of the list source result set thatare used to fill the data field values. This attribute is supported for the <form:listbox> element.
10178
10179
10180
10181
10182
10183
10184

<define name="bound-column"><optional><attribute name="form:bound-column"><ref name="string"/></attribute></optional></define>

Convert Empty To Null
The form:convert-empty-to-null attribute specifies whether or not empty current values
are regarded as NULL This attribute is important for data-aware controls to determine which
values to store for the bound database field. This attribute is supported for the following elements:•<form:text>•<form:textarea>•<form:formatted-text>•<form:combobox>

If the value of the attribute is true, an empty string in the control is regarded as the dedicated
NULL value. If the value of the attribute is false, an empty string in the control is regarded as an
empty string.
10185
10186
10187
10188
10189
10190
10191

<define name="common-convert-empty-attlist"><optional><attribute name="form:convert-empty-to-null" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 444 of 738

Data Field
The form:data-field attribute specifies the name of a result set column. The result set isdetermined by the form which the control belongs to. This attribute is supported for the following
elements:

10192
10193
10194
10195
10196
10197
10198

•

<form:text>•<form:textarea>•<form:formatted-text>•<form:combobox>•<form:listbox>•<form:checkbox>•<form:radio>•<form:image-frame><define name="common-data-field-attlist"><optional><attribute name="form:data-field"><ref name="string"/></attribute></optional></define>

List Source
The form:list-source attribute specifies the source used to populate the list in a list box orcombo box. The first column of the list source result set populates the list. This attribute issupported for the following elements:

10199
10200
10201
10202
10203
10204
10205

•

<form:combobox>•<form:listbox><define name="list-source"><optional><attribute name="form:list-source"><ref name="string"/></attribute></optional></define>

List Source TypeThe form:list-source-type attribute specifies the type of data source that is used topopulates the list data in a list box or combo box. This attribute is supported for the following
elements:•<form:combobox>•<form:listbox>

The value of this attribute can be one of the following:•table: The list is populated using the content of a database table.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 445 of 738

10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219

•

query: The list is populated by executing a query.

•sql: The list is populated by executing an SQL statement.

•

sql-pass-through: The list is populated by executing any type of statement that is passed
directly to a database driver, without being interpreted by the application.

•

value-list: The list is populated with values specified by the user using the form:value
attribute in the <form:option> element. This setting is only applicable to list boxes.

•

table-fields: The list is populated using the field names in a database table.

<define name="list-source-type"><optional><attribute name="form:list-source-type"><choice><value>table</value><value>query</value><value>sql</value><value>sql-pass-through</value><value>value-list</value><value>table-fields</value></choice></attribute></optional></define>

11.6 Event Listeners
Forms and form controls may have event listeners attached. The event listeners that are attachedto, for example, a list box or button, are represented by an event listener element as described in
section 12.4. This element is contained within the form or form control element, for example, the<form:listbox> element or the <form:button> element.
Section 12.4.1 contains guidelines for event names that may be used within forms and form
controls. In addition to those, the following events may be used for forms and form controls.
Value of script:event­name Attribute

Applies To

Description of Event

form:approveaction

Button or image.

Occurs before the “on performaction” event
takes place. Allows the user to veto the action.

form:performaction

Button or image.

Occurs when the control action is to be
performed. The common interpretation of thisevent is “pressing the button”.

form:textchange

All controls thatallow text input.

Occurs when a user changes the text in acontrol.

form:itemstatechange

Check box orradio button.

Occurs when the state of a check box or radio
button changes.

form:mousedragAll controls.

Occurs when a user presses and holds one of
the mouse buttons and moves the mousepointer onto a control.

form:approveresetsame objects as
for form:on-reset

Occurs before the on-reset event takes place.
Allows the user to veto the reset event.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 446 of 738

Value of script:event­name Attribute

Applies To

Description of Event

form:approveupdate

All controls that
Occurs before the on-update event takes
can be bound to a place. Allows the user to veto the update.
database field,that is controlsthat contain thedata-field
attribute.

form:update

All controls that
Occurs when the content of a control that iscan be bound to a bound to a database field is committed.
database field,that is controlsthat contain thedata-field
attribute.

form:load

Forms.

Occurs when the form establishes aconnection to the data source.

form:startrealod

Forms.

Occurs when the form is about to refresh adata source connection.

form:reload

Forms.

Occurs when the form has refreshed a data
source connection.

form:startunload

Forms.

Occurs when the form is about to drop a data
source connection.

form:unload

Forms.

Occurs when the form has dropped a data
source connection.

form:confirmdelete

Forms.

Occurs when the user is about to delete a
record.

form:approverowchangeForms.

Occurs before the “on rowchange” event takes
place. Allows the user to veto the change.

form:rowchange

Forms.

Occurs after changes to a row are complete,such as deletions, updates, and insertions.

form:approvecursormoveForms.

Occurs before the form is moved to anotherrow. Allows the user to veto the move.

form:cursormove

Forms.

Occurs after the form is moved to another row.

form:supplyparameter

Forms.

Occurs when the form needs to fill parameters
to connect to a data source.

form:error

Forms, combo
boxes and list
boxes.

Occurs when a database-related error occurs.

form:adjust

Value Range

Occurs when the value of a Value Range
element has been adjusted.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 447 of 738

11.7 Properties
The <form:properties> element may be used to store the following settings for controls andforms:•

Settings that are not known by the document format.

•

Settings that are provided by external vendors.

•

Settings that are specific to the application.

Properties consist of a name/value pair. The name identifies the property. The value can be given
in a fundamental data type or as a list of fundamental data types.

11.7.1 Property Set
The <form:properties> element contains the property elements. Properties are encodedusing the form:property element, except for list properties, which make use of theform:list-property element.
10220
10221
10222
10223
10224
10225
10226

<define name="form-properties"><element name="form:properties"><oneOrMore><ref name="form-property"/></oneOrMore></element></define>

11.7.2 Property
The <form:property> element describes a single property, and contains its name, type andvalue.
10227
10228
10229
10230
10231
10232

<define name="form-property" combine="choice"><element name="form:property"><ref name="form-property-name"/><ref name="form-property-value-and-type-attlist"/></element></define>

Property Name
The form:property-name attribute specifies the name of a property element.
10233
10234
10235
10236
10237

<define name="form-property-name" combine="interleave"><attribute name="form:property-name"><ref name="string"/></attribute></define>

Property Value and TypeThe value and type of form properties are represented through the common office:valuetype and suitable value attributes. See section 6.7.1for more information on these attributes.
In addition to these value types, form properties can also be empty. This is represented by the
special value type void. Such properties have no value attribute.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 448 of 738

10238
10239
10240
10241
10242
10243
10244
10245

<define name="form-property-value-and-type-attlist" combine="interleave"><choice><ref name="common-value-and-type-attlist"/><attribute name="office:value-type"><value>void</value></attribute></choice></define>

11.7.3 List Property
The <form:list-property> element specifies a property that contains a list of values. A value
type attribute determines which types are allowed on the list elements. The element contains asequence of list value elements, each of which contains a value attribute suitable to the value typegiven in the <form:list-property> element. The value attributes are the same as those used
elsewhere in the specification, except that the type attribute is attached to the container element,
which the value attributes are attached to the list values. (See section 6.7.1 for more information
on vale and value type attributes.)
10246
10247
10248
10249
10250
10251

<define name="form-property" combine="choice"><element name="form:list-property"><ref name="form-property-name"/><ref name="form-property-type-and-value-list"/></element></define>

List Value
The list value element contains value attributes for the value type given in the containing<form:list-property> element.
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280

<define name="form-property-type-and-value-list"><choice><group><attribute name="office:value-type"><value>float</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:value"><ref name="double"/></attribute></element></zeroOrMore></group><group><attribute name="office:value-type"><value>percentage</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:value"><ref name="double"/></attribute></element></zeroOrMore></group><group><attribute name="office:value-type"><value>currency</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 449 of 738

10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342

</attribute><zeroOrMore><element name="form:list-value"><attribute name="office:value"><ref name="double"/></attribute><optional><attribute name="office:currency"><ref name="string"/></attribute></optional></element></zeroOrMore></group><group><attribute name="office:value-type"><value>date</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:date-value"><ref name="dateOrDateTime"/></attribute></element></zeroOrMore></group><group><attribute name="office:value-type"><value>time</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:time-value"><ref name="duration"/></attribute></element></zeroOrMore></group><group><attribute name="office:value-type"><value>boolean</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:boolean-value"><ref name="boolean"/></attribute></element></zeroOrMore></group><group><attribute name="office:value-type"><value>string</value></attribute><zeroOrMore><element name="form:list-value"><attribute name="office:string-value"><ref name="string"/></attribute></element></zeroOrMore></group>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 450 of 738

10343
10344
10345
10346
10347

<attribute name="office:value-type"><value>void</value></attribute></choice></define>

Example: Form properties
The following contains a string property “Name” with value “Name 1”, and a string list
property “Items” containing the strings “Item 1”, “Item 2”, “Item 3”.
<form:properties><form:property form:property-name="Name"
office:value-type="string"
office:string-value="Name 1"><form:list-property form:property-name="Items"
office:value-type="string" ><form:list-value office:string-value="Item 1"/>
<form:list-value office:string-value="Item 2"/>
<form:list-value office:string-value="Item 3"/></form:list-property></form:properties>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 451 of 738

12 Common Content
12.1 Annotation
The <office:annotation> element specifies an OpenDocument annotation. The annotation's
text is contained in <text:p> and <text:list> elements.
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371

<define name="office-annotation"><element name="office:annotation"><ref name="office-annotation-attlist"/><ref name="draw-caption-attlist"/><ref name="common-draw-position-attlist"/><ref name="common-draw-size-attlist"/><ref name="common-draw-shape-with-text-and-styles-attlist"/><optional><ref name="dc-creator"/></optional><optional><ref name="dc-date"/></optional><optional><ref name="meta-date-string"/></optional><zeroOrMore><choice><ref name="text-p"/><ref name="text-list"/></choice></zeroOrMore></element></define>

The attributes associated with the <office:annotation> element are:•

Display•

Position, size, style, layer, z-index, id, and transformation (see section 9.2.15)•

Text anchor, table background, draw end position (see section 9.2.16)•

Caption point, round corners (see section 9.2.10)

Display
The office:display attribute specifies whether or not the annotation is visible.
10372
10373
10374
10375
10376
10377
10378

<define name="office-annotation-attlist" combine="interleave"><optional><attribute name="office:display"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 452 of 738

Caption Attributes
The following attributes can be attached to the <office:annotation> element to influence
how it is displayed: svg:x, svg:y, svg:width, svg:height, draw:caption-point-x,
draw:caption-point-y, draw:corner-radius, table:end-cell-address,
table:end-x, table:end-y, text:anchor-type, text:anchor-page-number,draw:layer, draw:style-name, draw:text-style-name, draw:transform,
draw:name, draw:z-index and draw:id. Their meaning is the same as if they are applied toa <draw:caption> element (see section 9.2.10). The use of these attributes is optional.

12.1.1 Creator
The optional <dc:creator> element described in section 3.1.7 specifies the author of theannotation.

12.1.2 Creation Date and Time
The optional <dc:date> element described in section 3.1.9 specifies the creation date and timeof the annotation.

12.1.3 Creation Date and Time String
If the application only has a date string and cannot parse this string, it may write the string into the<meta:date-string> element.
10379
10380
10381
10382
10383

<define name="meta-date-string"><element name="meta:date-string"><ref name="string"/></element></define>

12.2 Number Format
The OpenDocument number format consists of three parts:•

Prefix – the text that is displayed before the number•

Display format specification, for example, A, B, C, or 1, 2, 3•Suffix – the text that is displayed after the number

12.2.1 Prefix and Suffix
The style:num-prefix and style:num-suffix attributes specify what to display before andafter the number.
If the prefix and suffix do not contain alphanumeric characters, an [XSLT] format attribute canbe created from the OpenDocument attributes by concatenating the values of the style:numprefix, style:num-format, and style:num-suffix attributes.
10384
10385
10386
10387
10388

<define name="common-num-format-prefix-suffix-attlist" combine="interleave"><optional><attribute name="style:num-prefix"><ref name="string"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 453 of 738

10389
10390
10391
10392
10393
10394
10395

</optional><optional><attribute name="style:num-suffix"><ref name="string"/></attribute></optional></define>

12.2.2 Format Specification
The style:num-format attribute specifies the format of the number in the same way as the[XSLT] format attribute. The number styles supported are as follows:•

Numeric: 1, 2, 3, ...

•Alphabetic: a, b, c, ... or A, B, C, ...

•Roman: i, ii, iii, iv, ... or I, II, III, IV,...

The value of this attribute can be "1", "a", "A", "i", or "I". For some elements, the attribute value
also can be empty. In this case, no number is displayed.
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418

<define name="common-num-format-attlist" combine="interleave"><choice><attribute name="style:num-format"><choice><value>1</value><value>i</value><value>I</value><ref name="string"/><empty/></choice></attribute><group><attribute name="style:num-format"><choice><value>a</value><value>A</value></choice></attribute><ref name="style-num-letter-sync-attlist"/></group><empty/></choice></define>

12.2.3 Letter Synchronization in Number Formats
If letters are used in alphabetical order for numbering, there are two ways to process overflows
within a digit, as follows:•

A new digit is inserted. Its start value is A, and it is incremented every time an overflow occurs
in the following digit. The numbering sequence in this case is something like a,b,c, ..., z, aa,
ab, ac, ...,az, ba, ..., and so on.

•

A new digit is inserted that always has the same value as the following digit. The numbering
sequence in this case is something like a, b, c, ..., z, aa, bb, cc, ..., zz, aaa, ..., and so on. Thisis called letter synchronization.

The style:num-letter-sync specifies whether letter synchronization shall take place.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 454 of 738

10419
10420
10421
10422
10423
10424
10425

<define name="style-num-letter-sync-attlist" combine="interleave"><optional><attribute name="style:num-letter-sync"><ref name="boolean"/></attribute></optional></define>

12.3 Change Tracking Metadata
Meta-data for change tracking is contained inside an <office:change-info> element. It
contains the author and creation date of a tracked change, as well as an optional comment.
10426
10427
10428
10429
10430
10431
10432
10433
10434

<define name="office-change-info"><element name="office:change-info"><ref name="dc-creator"/><ref name="dc-date"/><zeroOrMore><ref name="text-p"/></zeroOrMore></element></define>

Creator
The <dc:creator> element as described in section 3.1.7 specifies the name of the author whochanged the document.

Date and TimeThe <dc:date> element as described in section 3.1.9 specifies the date and time when thechange took place.

Comment
An additional comment may be included as <text:p> elements.

12.4 Event Listener Tables
Many objects such as controls, images, text boxes, or an entire document support events. An
event binds the occurrence of a particular condition to an action that is executed if the condition
arises. For example, if a user places the cursor over a graphic, this condition triggers an actionthat is supported by the office application. This event, called "on-mouse-over", can be associatedwith a macro that is executed whenever the condition occurs, that is, whenever a user places the
cursor over a graphic.
The XML representation of events and event tables is structured as follows:•

All of the event elements that are associated with an object are located in a container element
called <office:event-listeners>.

•

Each event-to-action association is recorded in one <script:event-listener> element.

•

Depending on the type of action that the event triggers, the following elements are used:–

The <script:event-listener> element represents events that are bound to a macroor script.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 455 of 738

–

The <presentation:event-listener> element represents events that are bound toan action that is specific to a presentation, for example, go to the next page. Presentation
events are described in section .

The <office:event-listeners> element specifies the table of events that are associatedwith an object.
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444

<define name="office-event-listeners"><element name="office:event-listeners"><zeroOrMore><choice><ref name="script-event-listener"/><ref name="presentation-event-listener"/></choice></zeroOrMore></element></define>

12.4.1 Event Listener
The <script:event-listener> element binds an event to a macro.
10445
10446
10447
10448
10449
10450

<define name="script-event-listener" combine="interleave"><element name="script:event-listener"><ref name="script-event-listener-attlist"/><empty/></element></define>

The attributes that may be associated with the <script:event-listener> element are:•Event name•

Script language•

Macro Name and Location

Event Name
The script:event-name attribute specifies the name of the event. Since the available events,
their names and their meanings are application and script language dependent, the name should
be preceded by a namespace prefix, so that the corresponding namespace together with theevent name can be used to identify the semantic of the event.
Where appropriate, it is recommended to use the event names described in [DOMEvents2]. The
corresponding namespace is "http://www.w3.org/2001/xml-events".
Note: Event names defined in [DOMEvents2] are not namespaced. If used in OpenDocument,
they should be preceded by a namespace prefix as described above. [DOMEvents3], which is awork in progress, specifies namespaced event names. After completion of this specification, it isrecommended to use event names as specified in [DOMEvents3].
The following table describes events defined in [DOMEvents2] that are typically supported by
office application and have an equivalent event in HTML. The namespace that should be used forthese events is “http://www.w3.org/2001/xml-events”. The namespace prefix used in thisspecification is “dom”.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 456 of 738

Value of script:event­name AttributeEquivalent HTML
Event

Description of Event

dom:change

onchange

Occurs when a control is no longer focusedand the value of the control was modified since
it was given focus.

dom:DOMFocusIn

onfocusOccurs when a control is given focus using themouse or the TAB key.

dom:DOMFocusOut

onblur

Occurs when a control is no longer focused asa result of moving the mouse or by tabbing
navigation. It may be used with the sameelements as form:on-focus.

dom:mouseover

onmouseover

Occurs when the mouse pointer is moved overthe control.

dom:mousemove

onmousemove

Occurs when the mouse pointer is moved onto
a control.

dom:mousedown

onmousedown

Occurs when a mouse button is pressed on acontrol.

dom:mouseup

onmouseup

Occurs when a mouse button is released on acontrol.

on-mouseout

onmouseout

Occurs when the mouse pointer is moved
away from a control.

dom:reset

onresetOccurs when a form is reset.

dom:submit

onsubmit

Occurs when a form is submitted.

12.4.2 Event Types
In addition to the HTML event types, the XML file format for office applications allows additional
events to be handled at run time.
10451
10452
10453
10454
10455

<define name="script-event-listener-attlist" combine="interleave"><attribute name="script:event-name"><ref name="string"/></attribute></define>

Script Language
The script:language attribute specifies the scripting language in which the macro or script
which is associated with the event is written. See also section 2.5.1.
10456
10457
10458
10459
10460

<define name="script-event-listener-attlist" combine="interleave"><attribute name="script:language"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 457 of 738

Macro Name and Location
The macro code that should be called for the event can be either specified by an IRI in [XLink]
notation, or a simple name specified by a script:macro-name attribute. If an XLink is used, theIRI may have an arbitrary protocol, for instance one that encodes the name of a macro libraryname together with macro name defined in this library. Both, the XLink IRI as well as a simple
name, are script language dependent.
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482

<define name="script-event-listener-attlist" combine="interleave"><choice><attribute name="script:macro-name"><ref name="string"/></attribute><group><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional></group></choice></define>

12.5 Mathematical Content
Mathematical content is represented by MathML 2.0 (see [MathML])
10483
10484
10485
10486
10487

<define name="math-math"><element name="math:math"><ref name="mathMarkup"/></element></define>

10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504

<!-- To avoid inclusion of the complete MathML schema, anything --><!-- is allowed within a math:math top-level element--><define name="mathMarkup"><zeroOrMore><choice><attribute><anyName/></attribute><text/><element><anyName/><ref name="mathMarkup"/></element></choice></zeroOrMore></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 458 of 738

12.6 DDE Connections
A Dynamic Data Exchange (DDE) connection consists of the parameters for the DDE target
application, a file name, and a command string. A DDE connection also takes a parameter thatspecifies whether it will be updated automatically or only on the user's request. Every DDE
connection must be named.
All elements making use of DDE connections must contain their content (or its presentation), sothat documents using DDE can still be properly displayed on machines which do not support the
DDE mechanism, or where the DDE target is not available. Applications should preserve the DDE
connection information even if they cannot make use of it, so that other applications can makeuse the DDE facilities.
DDE only is available on some operating systems. In order to create portable documents, authors
are advised to use this feature in their documents with great care.

12.6.1 Container for DDE Connection Declarations
Within text and spreadsheet documents, DDE connection declarations are contained in one
declaration element. For text documents, the element is <text:dde-connection-decls> as
described in section 4.8. For spreadsheet documents, it is <table:dde-links> as described in
section 8.10.

12.6.2 Declaring DDE Connections for Text Fields
Every DDE connection used by a text field is declared using a declaration element. Multiple DDE
fields can refer to one DDE connection by using the same name. The declaration element has nocontent.
10505
10506
10507
10508
10509
10510

<define name="text-dde-connection-decl"><element name="text:dde-connection-decl"><ref name="text-dde-connection-decl-attlist"/><ref name="common-dde-connection-decl-attlist"/></element></define>

The attributes that may be associated with the <text:dde-connection-decl> element are:•Connection name•

DDE target application•

DDE target topic•

DDE target item•

Automatic update flag

Connection Name
The office:name attribute specifies the name by which the connection will be referred.
10511
10512
10513
10514
10515

<define name="text-dde-connection-decl-attlist" combine="interleave"><attribute name="office:name"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 459 of 738

Target Application
The office:dde-application attribute specifies the name of the target application to use forthe DDE connection.
10516
10517
10518
10519
10520

<define name="common-dde-connection-decl-attlist" combine="interleave"><attribute name="office:dde-application"><ref name="string"/></attribute></define>

Example: The target name for the OpenOffice.org software is soffice.
Therefore, internal DDE links have the attribute text:ddeapplication="soffice".

Target Topic
The office:dde-topic attribute specifies the name of the topic to use for the DDE connection.
10521
10522
10523
10524
10525

<define name="common-dde-connection-decl-attlist" combine="interleave"><attribute name="office:dde-topic"><ref name="string"/></attribute></define>

Example: The OpenOffice.org software interprets the DDE topic as the name of the
file.

Target Item
The office:dde-item attribute specifies which information the target application shoulddeliver.
10526
10527
10528
10529
10530

<define name="common-dde-connection-decl-attlist" combine="interleave"><attribute name="office:dde-item"><ref name="string"/></attribute></define>

Example: If the target application for the DDE connection is the OpenOffice.org
Writer software, the item represents the name of a bookmark. OpenOffice.org
delivers the current text content to the requesting application.

Automatic Update
Office applications by default automatically update DDE links. If a manual update of the link ispreferred, the text:automatic-update attribute my be used to specify that the DDE
connection links should only be updated at the request of the user.
If the value of this attribute is true, then the application is expected to automatically update theDDE links. If this value of this attribute is false, the DDE links are updated on user request only.
10531
10532
10533
10534
10535
10536

<define name="common-dde-connection-decl-attlist" combine="interleave"><optional><attribute name="office:automatic-update" a:defaultValue="true"><ref name="boolean"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 460 of 738

10537</define>

12.6.3 Declaring DDE Connections for Tables
The DDE connection data of tables is contained in an <office:dde-source> element. The
usage of this element differs between spreadsheet and text document tables. For text documenttables, the element is contained within the table's <table:table> element directly. For
spreadsheet documents, it is contained in a <table:dde-link> element, that describes asingle DDE connection.
The <table:dde-link> element contains the DDE source data in the <office:ddesource> element and a simple table element that might be used to cache the data of the DDE
source. The table does not need a name and does not contain style information. Only the datacontained in the cell attributes is used. The cells themselves remain empty.
10538
10539
10540
10541
10542
10543

<define name="table-dde-link"><element name="table:dde-link"><ref name="office-dde-source"/><ref name="table-table"/></element></define>

The <office:dde-source> element supports office:dde-application, office:ddetopic, office:dde-item and office:automatic-update attributes as described in
section 12.6.2. In addition to this, it supports the following attributes

10544
10545
10546
10547
10548
10549

•

Connection name•

Conversion mode<define name="office-dde-source"><element name="office:dde-source"><ref name="office-dde-source-attlist"/><ref name="common-dde-connection-decl-attlist"/></element></define>

Connection Name
The office:name attribute specifies the name by which the connection can be referred.
10550
10551
10552
10553
10554
10555
10556

<define name="office-dde-source-attlist" combine="interleave"><optional><attribute name="office:name"><ref name="string"/></attribute></optional></define>

Conversion Mode
The office:conversion-mode attribute specifies the method by which the DDE server
converts its data into numbers. There are three possible values:•

into-default-style-data-style: Numbers are converted into the data style which is
set on the default style.

•into-english-number: numbers are converted into the English default format.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 461 of 738

•
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568

keep-text: Numbers are not converted. They are treated as text.

<define name="office-dde-source-attlist" combine="interleave"><optional><attribute name="office:conversion-mode"
a:defaultValue="into-default-style-data-style"><choice><value>into-default-style-data-style</value><value>into-english-number</value><value>keep-text</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 462 of 738

13 SMIL Animations
This section describes [SMIL20] based elements and attribute that can be used within the
OpenDocument format for animation effects.

13.1 Basic Animation Elements
The basic animation elements are directly derived from basic animation elements specified §3.5
and §12.5 of [SMIL20], and in section §19.2 of [SVG].

13.1.1 Animate
The <anim:animate> element behaves like the [SMIL20] <smil:animate> element. See§3.5.1 of [SMIL20] for details.
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579

<define name="animation-element" combine="choice"><element name="anim:animate"><ref name="common-anim-target-attlist"/><ref name="common-anim-named-target-attlist"/><ref name="common-anim-values-attlist"/><ref name="common-anim-spline-mode-attlist"/><ref name="common-spline-anim-value-attlist"/><ref name="common-timing-attlist"/><ref name="common-anim-add-accum-attlist"/></element></define>

13.1.2 Set
The <anim:set> element behaves like the [SMIL20] <smil:set> element. See §3.5.2 of[SMIL20] for details.
10580
10581
10582
10583
10584
10585
10586
10587
10588

<define name="animation-element" combine="choice"><element name="anim:set"><ref name="common-anim-target-attlist"/><ref name="common-anim-named-target-attlist"/><ref name="common-anim-set-values-attlist"/><ref name="common-timing-attlist"/><ref name="common-anim-add-accum-attlist"/></element></define>

13.1.3 Animate Motion
The <anim:animateMotion> element behaves as the [SVG] <svg:animateMotion>
element. See §19.2.12 of [SVG] and §3.5.3 of [SMIL20] for details.
10589
10590
10591
10592
10593
10594
10595

<define name="animation-element" combine="choice"><element name="anim:animateMotion"><ref name="anim-animate-motion-attlist"/><ref name="common-anim-target-attlist"/><ref name="common-anim-named-target-attlist"/><ref name="common-anim-add-accum-attlist"/><ref name="common-anim-values-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 463 of 738

10596
10597
10598
10599

<ref name="common-timing-attlist"/><ref name="common-spline-anim-value-attlist"/></element></define>

The Motion Path
The [SVG] svg:path attribute can be used to specify a path along which the element isanimated. See §19.2.12 of [SVG] for details.
10600
10601
10602
10603
10604
10605
10606

<define name="anim-animate-motion-attlist" combine="interleave"><optional><attribute name="svg:path"><ref name="pathData"/></attribute></optional></define>

OriginThe [SVG] svg:origin attribute can be used to specify an origin. See §19.2.12 of [SVG] fordetails.
10607
10608
10609
10610
10611
10612
10613

<define name="anim-animate-motion-attlist" combine="interleave"><optional><attribute name="svg:origin"><ref name="string"/></attribute></optional></define>

Calc Mode
The [SMIL20] smil:calcMode attribute is used to specify the interpolation mode of theanimation. See §19.2.12 of [SVG] for details.
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625

<define name="anim-animate-motion-attlist" combine="interleave"><optional><attribute name="smil:calcMode" a:defaultValue="paced"><choice><value>discrete</value><value>linear</value><value>paced</value><value>spline</value></choice></attribute></optional></define>

13.1.4 Animate Color
The <anim:animateColor> element behaves like the [SMIL20] <smil:animateColor>element. See §3.5.4 of [SMIL20] for details.
10626
10627
10628
10629
10630

<define name="animation-element" combine="choice"><element name="anim:animateColor"><ref name="common-anim-target-attlist"/><ref name="common-anim-named-target-attlist"/><ref name="common-anim-add-accum-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 464 of 738

10631
10632
10633
10634
10635
10636
10637

<ref name="common-anim-values-attlist"/><ref name="common-anim-spline-mode-attlist"/><ref name="common-spline-anim-value-attlist"/><ref name="anim-animate-color-attlist"/><ref name="common-timing-attlist"/></element></define>

Color Interpolation
The anim:color-interpolation attribute specifies the color space that is used for color
interpolation.
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647

<define name="anim-animate-color-attlist" combine="interleave"><optional><attribute name="anim:color-interpolation" a:defaultValue="rgb"><choice><value>rgb</value><value>hsl</value></choice></attribute></optional></define>

Color Interpolation Direction
The anim:color-interpolation-direction attribute specify the direction that is used forcolor interpolation. This is only valid for the HSL color space.
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658

<define name="anim-animate-color-attlist" combine="interleave"><optional><attribute name="anim:color-interpolation-direction"
a:defaultValue="clockwise"><choice><value>clockwise</value><value>counter-clockwise</value></choice></attribute></optional></define>

13.1.5 Animate Transform
The <anim:animateTransform> element is based on the [SVG]<svg:animateTransform> element. See §19.2.14 of [SVG] for details.
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668

<define name="animation-element" combine="choice"><element name="anim:animateTransform"><ref name="common-anim-target-attlist"/><ref name="common-anim-named-target-attlist"/><ref name="common-anim-add-accum-attlist"/><ref name="common-anim-values-attlist"/><ref name="anim-animate-transform-attlist"/><ref name="common-timing-attlist"/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 465 of 738

Transformation TypeThe [SVG] svg:type attribute is used to specify the transformation type. See §19.2.14 of [SVG]
for details.
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679

<define name="anim-animate-transform-attlist" combine="interleave"><attribute name="svg:type"><choice><value>translate</value><value>scale</value><value>rotate</value><value>skewX</value><value>skewY</value></choice></attribute></define>

13.1.6 Transition Filter
The <anim:transitionFilter> element is based on the [SMIL20]<smil:transitionFilter> element. See §12.5.1 of [SMIL20] for details.
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689

<define name="animation-element" combine="choice"><element name="anim:transitionFilter"><ref name="common-anim-target-attlist"/><ref name="common-anim-add-accum-attlist"/><ref name="common-anim-values-attlist"/><ref name="common-anim-spline-mode-attlist "/><ref name="anim-transition-filter-attlist"/><ref name="common-timing-attlist"/></element></define>

Transition TypeThe [SMIL20] smil:type attribute is used to specify the transition type or family. See §12.8 of[SMIL20] for a list of supported types.
10690
10691
10692
10693
10694

<define name="anim-transition-filter-attlist" combine="interleave"><attribute name="smil:type"><ref name="string"/></attribute></define>

Transition Subtype
The [SMIL20] smil:subtype attribute can be used to specify the transition subtype. See §12.8
of [SMIL20] for a list of supported subtypes.
10695
10696
10697
10698
10699
10700
10701

<define name="anim-transition-filter-attlist" combine="interleave"><optional><attribute name="smil:subtype"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 466 of 738

Transition Direction
The [SMIL20] smil:direction attribute can be used to specify the transition direction. See§12.4.1 of [SMIL20] for details.
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711

<define name="anim-transition-filter-attlist" combine="interleave"><optional><attribute name="smil:direction" a:defaultValue="forward"><choice><value>forward</value><value>reverse</value></choice></attribute></optional></define>

Fade Color
The [SMIL20] smil:fadeColor attribute can be used to specify the transition fade color fortransitions that makes use of a start or end color. See §12.5.1 of [SMIL20] for details.
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721

<define name="anim-transition-filter-attlist" combine="interleave"><optional><attribute name="smil:fadeColor"><choice><value>forward</value><value>reverse</value></choice></attribute></optional></define>

The Transition Mode
The [SMIL20] smil:mode attribute is used to specify if the animated element will be transition inor out. See §12.5.1 of [SMIL20] for details.
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731

<define name="anim-transition-filter-attlist" combine="interleave"><optional><attribute name="smil:mode" a:defaultValue="in"><choice><value>in</value><value>out</value></choice></attribute></optional></define>

13.2 Animation Model Attributes
The animation model uses the same concepts and syntax as specified in §3 of [SMIL20].

13.3 Common Animation Attributes
Element Id
The anim:id attribute defines an ID that is used to identify the element inside a document.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 467 of 738

10732
10733
10734
10735
10736
10737
10738

<define name="common-anim-attlist" combine="interleave"><optional><attribute name="anim:id"><ref name="ID"/></attribute></optional></define>

13.3.1 Animation Target Attributes
Target Element
The [SMIL20] smil:targetElement attribute is used to specify the target element to beanimated. See §3.4.1 of [SMIL20] for details. See section 9.8.2 for details about the usage of this
attribute in presentation documents.
10739
10740
10741
10742
10743
10744
10745

<define name="common-anim-target-attlist" combine="interleave"><optional><attribute name="smil:targetElement"><ref name="IDREF"/></attribute></optional></define>

Target Attribute
The [SMIL20] smil:attributeName attribute is used to specify a target attribute by name. See§3.4.1 of [SMIL20] for details. See section 9.8.2 for details about the usage of this attribute inpresentation documents.
10746
10747
10748
10749
10750

<define name="common-anim-named-target-attlist" combine="interleave"><attribute name="smil:attributeName"><ref name="string"/></attribute></define>

Target Element Sub Item
The anim:sub-item attribute specifies an optional sub item of the target element. Possible
values for this element depend on the document type and the target element type. See section
9.8.2 for details about the usage of this attribute in presentation documents.
10751
10752
10753
10754
10755
10756
10757

<define name="common-anim-target-attlist" combine="interleave"><optional><attribute name="anim:sub-item"><ref name="string"/></attribute></optional></define>

13.3.2 Animation Function Attributes
Value List
The [SMIL20] smil:values attribute specifies the values used to animate the target element.
See $3.4.2 of [SMIL20] for details.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 468 of 738

10758
10759
10760
10761
10762
10763
10764

<define name="common-anim-values-attlist" combine="interleave"><optional><attribute name="smil:values"><ref name="string"/></attribute></optional></define>

Calc Mode
The [SMIL20] smil:calcMode attribute is used to specify the interpolation mode of theanimation function. See $3.4.2 of [SMIL20] for details.
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776

<define name="common-anim-spline-mode-attlist" combine="interleave"><optional><attribute name="smil:calcMode" a:defaultValue="discrete"><choice><value>discrete</value><value>linear</value><value>paced</value><value>spline</value></choice></attribute></optional></define>

Key Times
The [SMIL20] smil:keyTimes attribute specifies the pacing of the animation. See $3.7.1 of[SMIL20] for details.
10777
10778
10779
10780
10781
10782
10783

<define name="common-spline-anim-value-attlist" combine="interleave"><optional><attribute name="smil:keyTimes"><ref name="string"/></attribute></optional></define>

Key Splines
The [SMIL20] smil:keySplines attribute specifies a cubic Bézier function that controls interval
pacing. See $3.7.1 of [SMIL20] for details.
10784
10785
10786
10787
10788
10789
10790

<define name="common-spline-anim-value-attlist" combine="interleave"><optional><attribute name="smil:keySplines"><ref name="string"/></attribute></optional></define>

Accumulation
The [SMIL20] smil:accumulate attribute specifies the accumulation of the animation function.
See $3.4.3 of [SMIL20] for details.
10791
10792

<define name="common-anim-add-accum-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 469 of 738

10793
10794
10795
10796
10797
10798
10799
10800

<attribute name="smil:accumulate"><choice><value>none</value><value>sum</value></choice></attribute></optional></define>

Additive
The [SMIL20] smil:additive attribute specifies if the additive of the animation function. See$3.4.3 of [SMIL20] for details.
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810

<define name="common-anim-add-accum-attlist" combine="interleave"><optional><attribute name="smil:additive"><choice><value>replace</value><value>sum</value></choice></attribute></optional></define>

FormulaThe anim:formula attribute specifies a formula that is used as the animation function. The
identifier '$' will be replaced by a value between 0 and 1 (inclusive) that represents the
proportional offset into the animation element's duration. For specific document types, additional
identifiers may exist. The following is the minimum supported grammar:
identifier = '$' | 'pi'function = 'abs'|'sqrt'|'sin'|'cos'|'tan'|'atan'|'acos'|'asin'|'exp'|'log'

binary_function = 'min'|'max'
basic_expression =number |identifier |function '(' additive_expression ')' |binary_function'(' additive_expression ',' additive_expression ')' |'(' additive_expression ')'unary_expression ='-' basic_expression |basic_expression
multiplicative_expression =unary_expression(( '*' unary_expression )* |( '/' unary_expression )* )additive_expression =multiplicative_expression(( '+' multiplicative_expression )* |( '-' multiplicative_expression )* )See section 9.8.2 for details about additional identifiers for presentation documents.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 470 of 738

If a anim:formula attribute is given, it overrides the smil:values, smil:to, smil:from andsmil:by attributes as specified in the next section.
10811
10812
10813
10814
10815
10816
10817

<define name="common-anim-values-attlist" combine="interleave"><optional><attribute name="anim:formula"><ref name="string"/></attribute></optional></define>

Simple Animation Functions
In addition to describing an animation with a list of values, a simplified version using the [SMIL20]
smil:from, smil:to and smil:by attributes can be used. See §3.4.4 of [SMIL20] for details.
10818
10819
10820
10821
10822
10823
10824

<define name="common-anim-set-values-attlist" combine="interleave"><optional><attribute name="smil:to"><ref name="string"/></attribute></optional></define>

10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838

<define name="common-anim-values-attlist" combine="interleave"><ref name="common-anim-set-values-attlist"/><optional><attribute name="smil:from"><ref name="string"/></attribute></optional><optional><attribute name="smil:by"><ref name="string"/></attribute></optional></define>

13.4 Animation Timing
The animation timing uses the same concepts and syntax as specified in §10 and §11 of [SMIL20]
chapters.

13.4.1 Animation Timing Attributes
Element Start
The [SMIL20] smil:begin attribute can be used to specify the begin time of an element. See§10.3.1 of [SMIL20] for details.
10839
10840
10841
10842
10843
10844
10845

<define name="common-begin-end-timing-attlist" combine="interleave"><optional><attribute name="smil:begin"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 471 of 738

Element End
The [SMIL20] smil:end attribute can be used to specify the end time of an element. See §10.3.1
of [SMIL20] for details.
10846
10847
10848
10849
10850
10851
10852

<define name="common-begin-end-timing-attlist" combine="interleave"><optional><attribute name="smil:end"><ref name="string"/></attribute></optional></define>

Element Duration
The [SMIL20] smil:dur attribute can be used to specify the duration of an element. See §10.3.1
of [SMIL20] for details.
10853
10854
10855
10856
10857
10858
10859

<define name="common-dur-timing-attlist" combine="interleave"><optional><attribute name="smil:dur"><ref name="string"/></attribute></optional></define>

Element End Synchronization
The [SMIL20] smil:endsync attribute can be used to control the implicit duration of time
containers, as a function of their children. See §10.3.1 of [SMIL20] for details.
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871

<define name="common-endsync-timing-attlist" combine="interleave"><optional><attribute name="smil:endsync"><choice><value>first</value><value>last</value><value>all</value><value>media</value></choice></attribute></optional></define>

Repeating Elements
The [SMIL20] smil:repeatCount and smil:repeatDur attributes specifies the behavior of
repeated animations. See §10.3.1 of [SMIL20] for details.
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882

<define name="common-repeat-timing-attlist" combine="interleave"><optional><attribute name="smil:repeatDur"><ref name="string"/></attribute></optional><optional><attribute name="smil:repeatCount"><choice><ref name="nonNegativeInteger"/><value>indefinite</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 472 of 738

10883
10884
10885
10886

</choice></attribute></optional></define>

Fill
The [SMIL20] smil:fill attribute specifies the behavior of an element after an animation isfinished. See §10.3.1 of [SMIL20] for details.
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900

<define name="common-fill-timing-attlist" combine="interleave"><optional><attribute name="smil:fill"><choice><value>remove</value><value>freeze</value><value>hold</value><value>auto</value><value>default</value><value>transition</value></choice></attribute></optional></define>

Fill Default
The [SMIL20] smil:fillDefault attribute specifies the default behavior for the smil:fill
attribute. See §10.3.1 of [SMIL20] for details.
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914

<define name="common-fill-default-attlist" combine="interleave"><optional><attribute name="smil:fillDefault"><choice><value>remove</value><value>freeze</value><value>hold</value><value>transition</value><value>auto</value><value>inherit</value></choice></attribute></optional></define>

Restart
The [SMIL20] smil:restart attribute can be used to specify the restart behavior of an element.
See §10.3.1 of [SMIL20] for details.
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924

<define name="common-restart-timing-attlist" combine="interleave"><optional><attribute name="smil:restart" a:defaultValue="default"><choice><value>never</value><value>always</value><value>whenNotActive</value><value>default</value></choice></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 473 of 738

1092510926</optional></define>

Restart Default
The [SMIL20] smil:restartDefault attribute can be used to specify the default restartbehavior of an element. See §10.3.1 of [SMIL20] for details.
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938

<define name="common-restart-default-attlist" combine="interleave"><optional><attribute name="smil:restartDefault" a:defaultValue="inherit"><choice><value>never</value><value>always</value><value>whenNotActive</value><value>inherit</value></choice></attribute></optional></define>

Accelerate
The [SMIL20] smil:accelerate attribute can be used to specify a simple acceleration ofelement time. See §11.1.2 of [SMIL20] for details.
10939
10940
10941
10942
10943
10944
10945

<define name="common-time-manip-attlist" combine="interleave"><optional><attribute name="smil:accelerate" a:defaultValue="0.0"><ref name="double"/></attribute></optional></define>

Decelerate
The [SMIL20] smil:decelerate attribute can be used to specify a simple deceleration ofelement time. See §11.1.2 of [SMIL20] for details.
10946
10947
10948
10949
10950
10951
10952

<define name="common-time-manip-attlist" combine="interleave"><optional><attribute name="smil:decelerate" a:defaultValue="0.0"><ref name="double"/></attribute></optional></define>

Auto Reverse
The [SMIL20] smil:autoreverse attribute can be used to specify an automatic playback inreverse. See §11.1.2 of [SMIL20] for details.
10953
10954
10955
10956
10957
10958
10959

<define name="common-time-manip-attlist" combine="interleave"><optional><attribute name="smil:autoReverse" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 474 of 738

13.4.2 Parallel Animations
The <anim:par> element is based on the [SMIL20] <smil:par> element and defines a paralleltime container. See §10.3.2 of [SMIL20] for details.
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969

<define name="animation-element" combine="choice"><element name="anim:par"><ref name="common-anim-attlist"/><ref name="common-timing-attlist"/><ref name="common-endsync-timing-attlist"/><zeroOrMore><ref name="animation-element"/></zeroOrMore></element></define>

10970
10971
10972
10973
10974
10975

<define name="common-basic-timing-attlist" combine="interleave"><ref name="common-begin-end-timing-attlist"/><ref name="common-dur-timing-attlist"/><ref name="common-repeat-timing-attlist"/></define>

10976
10977
10978
10979
10980
10981
10982
10983
10984

<define name="common-timing-attlist" combine="interleave"><ref name="common-basic-timing-attlist"/><ref name="common-restart-timing-attlist"/><ref name="common-restart-default-attlist"/><ref name="common-fill-timing-attlist"/><ref name="common-fill-default-attlist"/><ref name="common-time-manip-attlist"/></define>

13.4.3 Sequential Animations
The <anim:seq> element is based on the [SMIL20] <smil:seq> element and defines asequential time container. See §10.3.2 of [SMIL20] for details.
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994

<define name="animation-element" combine="choice"><element name="anim:seq"><ref name="common-anim-attlist"/><ref name="common-endsync-timing-attlist"/><ref name="common-timing-attlist"/><zeroOrMore><ref name="animation-element"/></zeroOrMore></element></define>

13.4.4 Iterative Animations
The <anim:iterate> element defines a parallel time container. The difference to a<anim:par> element is that the <anim:iterate> element does not specify effects for its target
element itself. Instead of this, it iterates over possible child elements of the target element andexecutes all its child effects with the children of the target element as target.
10995
10996
10997
10998
10999
11000

<define name="animation-element" combine="choice"><element name="anim:iterate"><ref name="common-anim-attlist"/><ref name="anim-iterate-attlist"/><ref name="common-timing-attlist"/><ref name="common-endsync-timing-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 475 of 738

11001
11002
11003
11004
11005

<zeroOrMore><ref name="animation-element"/></zeroOrMore></element></define>

The Target Element
The [SMIL20] smil:targetElement and anim:sub-item attributes specify the target element
to whose children the effects should be applied. See section 9.8.2 for details about the attribute's
usage in presentation documents.
11006
11007
11008

<define name="anim-iterate-attlist" combine="interleave"><ref name="common-anim-target-attlist"/></define>

The Iterate TypeThe anim:iterate-type attribute specifies how the iteration targets child elements areiterated. Possible values depends on the document type and the target element type. See section
9.8.2 for details about the attribute's usage in presentation documents.
11009
11010
11011
11012
11013
11014
11015

<define name="anim-iterate-attlist" combine="interleave"><optional><attribute name="anim:iterate-type"><ref name="string"/></attribute></optional></define>

The Iterate Interval
The anim:iterate-interval attribute specifies the delay between the execution of the childeffects of this element. The effects of the next iterated child of the target element are started when
the given time is elapsed since the effects for the previous child has been started. An iterateinterval of zero seconds would have the same behavior as using a <anim:par> element.
11016
11017
11018
11019
11020
11021
11022

<define name="anim-iterate-attlist" combine="interleave"><optional><attribute name="anim:iterate-interval"><ref name="duration"/></attribute></optional></define>

13.5 Media Elements
13.5.1 Audio
The <anim:audio> element is based on the [SMIL20] <smil:audio> element. It allows the
playback of audio streams during an animation. See §7.3.1 of [SMIL20] for details.
11023
11024
11025
11026
11027

<define name="animation-element" combine="choice"><element name="anim:audio"><ref name="common-anim-attlist"/><ref name="anim-audio-attlist"/><ref name="common-basic-timing-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 476 of 738

1102811029</element></define>

SourceThe xlink:href attribute specifies the IRI of the audio stream.
11030
11031
11032
11033
11034
11035
11036

<define name="anim-audio-attlist" combine="interleave"><optional><attribute name="xlink:href"><ref name="anyURI"/></attribute></optional></define>

Audio Level
The anim:audio-level attribute specifies the volume during playback. Its value is a number inthe range 0 (inaudible) to 1 (the system volume).
11037
11038
11039
11040
11041
11042
11043

<define name="anim-audio-attlist" combine="interleave"><optional><attribute name="anim:audio-level"><ref name="double"/></attribute></optional></define>

13.6 Special Elements
13.6.1 Command
The <anim:command> element is used to send generic commands to the application during an
animation. The available command types and its parameters depend on the document type andthe type of the target element. See section 9.8.2 for details about the element's usage inpresentation documents.
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057

<define name="animation-element" combine="choice"><element name="anim:command"><ref name="common-anim-attlist"/><ref name="anim-command-attlist"/><ref name="common-begin-end-timing-attlist"/><ref name="common-anim-target-attlist"/><zeroOrMore><element name="anim:param"><attribute name="anim:name"/><attribute name="anim:value"/></element></zeroOrMore></element></define>

Command
The anim:command attribute specifies the command that will be executed at the application
when this animation element is started.
11058<define name="anim-command-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 477 of 738

11059
11060
11061
11062

<attribute name="anim:command"><ref name="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 478 of 738

14 Styles
Many objects in an office document have formatting properties. A formatting property influences
the visual representation of an object but it does not contribute to the content or structure of the
document. Examples of formatting properties are:•

Font family•

Font size•

Font color•

Page margins

In the OpenDocument format, formatting properties are only stored within styles. This differs to
the user interface of typical office applications, where formatting properties may be assigned to an
object directly, or indirectly by applying a style to the object. Assigning formatting properties to an
object directly has the same effect as assigning an unnamed style with the same properties to that
object. Therefore, user interface styles remain unchanged conceptually in the OpenDocument fileformat, while formatting properties assigned directly to an object are assumed to be unnamedstyles. In order to use unnamed styles, they are assigned a name and therefore become
automatic styles.
There are two main reasons for using styles to store formatting properties:
1. The format and layout of the document get separated from the document content.
2. If two or more objects have the same formatting properties and styles assigned, the formatting
properties that are assigned to the objects directly can be represented by a single automaticstyle for all objects. This saves disk space and allows styles to integrate seamlessly into theoverall document style.
Within this chapter, the various style types are explained.

14.1 Style Element
Some style families are very similar in structure and can be represented by the same element. For
example, the <style:style> element can represent paragraph, text, and graphic styles.
The individual style families that make use of these element are described separately. Within thissection, the common attributes of the style element are described.
11063
11064
11065
11066
11067
11068
11069
11070
11071

<define name="style-style"><element name="style:style"><ref name="style-style-attlist"/><ref name="style-style-content"/><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

The attributes that may be associated with the <style:style> element are:•Style name•

Display name

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 479 of 738

•

Style family•

Parent style•

Next style•

List style•

Master page name•Automatically update•

Data style name

•

Class

•

Outline numbering level

Style Name
The style:name attribute identifies the name of the style. This attribute, combined with thestyle:family attribute, uniquely identifies a style. The <office:styles>,<office:automatic-styles> and <office:master-styles> elements each must notcontain two styles with the same family and the same name.
For automatic styles, a name is generated during document export. If the document is exported
several times, it cannot be assumed that the same name is generated each time.
In an XML document, the name of each style is a unique name that may be independent of thelanguage selected for an office applications user interface. Usually these names are the ones used
for the English version of the user interface.
11072
11073
11074
11075
11076

<define name="style-style-attlist" combine="interleave"><attribute name="style:name"><ref name="styleName"/></attribute></define>

Display Name
The style:display-name attribute specifies the name of the style as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
11077
11078
11079
11080
11081
11082
11083

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:display-name"><ref name="string"/></attribute></optional></define>

Style Family
The style:family attribute identifies the family of the style, for example, paragraph, text, or
frame. It might have one of the following values: paragraph, text, section, table, tablecolumn, table-row, table-cell, table-page, chart, default, drawing-page,graphic, presentation, control and ruby.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 480 of 738

Parent Style
The style:parent-style-name attribute specifies the name of the parent style. If a parent
style is not specified, a default parent style defined by the application is used. The parent stylecannot be an automatic style and has to exist.
11084
11085
11086
11087
11088
11089
11090

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:parent-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Next Style
The style:next-style-name attribute specifies the style to used for the next paragraph if aparagraph break is inserted in the user interface. By default, the current style is used as the next
style.
11091
11092
11093
11094
11095
11096
11097

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:next-style-name"><ref name="styleNameRef"/></attribute></optional></define>

List Style
A paragraph style and styles of other families that may contain paragraph properties (for instancegraphic styles) can have an associated list style. This applies to automatic and common styles.
The list style specified by the style:list-style-name attribute is only applied to headings
and to paragraphs that are contained in a list, where the list does not specify a list style itself, andthe list has no list style specification for any of its parents.
The style:list-style-name attribute's value can be empty. In this case, an association witha list style that is inherited from a parent style will be removed.
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:list-style-name"><choice><ref name="styleName"/><empty/></choice></attribute></optional></define>

Master Page Name
A paragraph or table style can have an associated style:master-page-name attribute. Thisapplies to automatic and common styles. If this attribute is associated with a style, a page break isinserted when the style is applied and the specified master page is applied to the preceding page.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 481 of 738

This attribute is ignored if it is associated with a paragraph style that is applied to a paragraphwithin a table.
11108
11109
11110
11111
11112
11113
11114

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:master-page-name"><ref name="styleNameRef"/></attribute></optional></define>

Automatically Update
The style:auto-update attribute determines whether or not styles are automatically updated
when the formatting properties of an object that has the style assigned to it are changed. For
example, there might be a paragraph style that contains a formatting property specifying thatparagraph text is centered, and this paragraph style is applied to a paragraph. If the user manuallychanges the formatting of that paragraph text to be right-aligned and the value of thestyle:auto-update attribute is true, then the paragraph style is automatically updated toreflect the new paragraph formatting and every paragraph that uses the paragraph style is also
modified to right-align the paragraph text. This attribute can have a value of true or false.
11115
11116
11117
11118
11119
11120
11121

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:auto-update" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Data Style Name
Table cell style can have an associated data style. This applies to automatic and common styles.
The data style is referenced by the style:data-style-name attribute. See section 14.7 fordetails about data styles.
11122
11123
11124
11125
11126
11127
11128

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:data-style-name"><ref name="styleNameRef"/></attribute></optional></define>Class
A style may belong to an arbitrary class of styles. The class is an arbitrary string. The class has no
meaning within the file format itself, but it can for instance be evaluated by user interfaces to show
a list of styles where the styles are grouped by its name.
11129
11130
11131
11132
11133
11134
11135

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:class"><ref name="string"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 482 of 738

Outline Numbering Level
For style with family paragraph, the style:default-outline-level attribute specifies adefault outline level. It takes a number like the text:outline-level attribute of the heading
element <text:h>. If this attribute is existing for a paragraph style, and if the paragraph style isassigned to a paragraph by an user interface action, then office applications should convert theparagraph into a heading of the given level. However, the attribute has no effect to thedifferentiation of headings and paragraphs in the file format itself. The differentiation between
headings and paragraphs still takes place by using either a <text:h> or a <text:p> element. If
a <text:p> element references a paragraph style that has a style:default-outlinelevel attribute, the paragraph remains a paragraph and will not become a heading.
11136
11137
11138
11139
11140
11141
11142

<define name="style-style-attlist" combine="interleave"><optional><attribute name="style:default-outline-level"><ref name="positiveInteger"/></attribute></optional></define>

Formatting Properties
If a style has formatting attributes assigned, the style element contains one ore more formatting
property container elements. See section 15 for detailed information about these element.

Sample Style
Example: OpenDocument representation of the “Text body” paragraph style<style:style style:name="Text body" style:family="paragraph"style:parent-style-name="Standard"><style:paragraph-properties fo:margin-top="0cm"
fo:margin-bottom=".21cm"/></style:style>14.1.1 Style Mappings
The <style:map> element specifies the mapping to another style, if certain conditions exist. If astyle contains such mappings, it is called an conditional style. There is one element for every
condition that the style uses.
Conditional styles usually are supported by paragraph styles contained in text documents andtable cell styles contained in spreadsheets only. Conditional styles are also supported by datastyles.
11143
11144
11145
11146
11147
11148

<define name="style-map"><element name="style:map"><ref name="style-map-attlist"/><empty/></element></define>

The attributes that may be associated with the <style:map> element are:•Condition•

Applied style•

Base cell address

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 483 of 738

Condition
The style:condition attribute specifies the condition in which a style map should be applied.
The value of this attribute is a Boolean expression. The syntax of the expression is similar to the
XPath syntax. If an application detects a condition that it does not recognize, it must ignore theentire <style:map> element.
The following conditions are valid for paragraph styles:•

list-level()=n, where n is a number between 1 and 10•

outline-level()=n, where n is a number between 1 and 10•

table() and table-header()•section()•header() and footer()•footnote() and endnote()

The following conditions are valid for paragraph styles:•

is-true-formula(formula)•cell-content-is-between(value, value)•cell-content-is-not-between(value, value)•cell-content() operator value, where operator is one of; '<', '>', '<=', '>=','=' or '!=', and value is a numberValue, a string or a formula.

•

A numberValue is a whole or decimal number. The number cannot contain comma
separators for numbers of 1000 or greater.

•

A string comprises one or more characters surrounded by quotation marks.

•

A formula is a formula (see 8.1.3) without the equals (=) sign at the beginning.

The following conditions are valid for data styles:•

value() op n, where op is a relational operator and n is a number.

•

For Boolean styles the condition value must be true and false.

The conditions that apply for different types of styles may differ.
11149
11150
11151
11152
11153

<define name="style-map-attlist" combine="interleave"><attribute name="style:condition"><ref name="string"/></attribute></define>

Applied Style
The style:apply-style-name attribute specifies the style to apply when the condition
specified by the style:condition attribute is true. If the referenced style is undefined or is an
automatic style, an error occurs.
11154
11155

<define name="style-map-attlist" combine="interleave"><attribute name="style:apply-style-name">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 484 of 738

1115611157
11158<ref name="styleNameRef"/></attribute></define>

Base Cell Address
For table cell styles, the style:base-cell-address attribute specifies the base cell for
relative addresses in formulas. This attribute only applies to cell styles where the condition
contains a formula. The value of this attribute must be an absolute cell address with a table name.
11159
11160
11161
11162
11163
11164
11165

<define name="style-map-attlist" combine="interleave"><optional><attribute name="style:base-cell-address"><ref name="cellAddress"/></attribute></optional></define>

Example: Style mapping<style:style style:name="Text body" style:family="paragraph"style:parent-style-name="Standard"style:next-style-name="Text body"><style:paragraph-properties fo:margin-top="0cm"
fo:margin-bottom=".21cm"/><style:map style:condition="footnote"style:apply-style-name="footnote"/><style:map style:condition="heading(1)"style:apply-style-name="Heading 1"/><style:map style:condition="heading(2)"style:apply-style-name="Heading 2"/></style:style>14.2 Default Styles
A default style specifies default formatting properties for a certain style family. These defaults areused if a formatting property is neither specified by an automatic nor a common style. Default
styles exist for all style families that are represented by the <style:style> element specified in
section 14.1.
Default styles are represented by the <style:default-style> element. The only attributesupported by this element is style:family. Its meaning equals the one of the same attribute forthe <style:style> element, and the same properties child elements are supported dependingon the style family.
11166
11167
11168
11169
11170

<define name="style-default-style"><element name="style:default-style"><ref name="style-style-content"/></element></define>

14.3 Page Layout
The <style:page-layout> element specifies the physical properties of a page. This element
contains a <style:page-layout-properties> element which specifies the formatting
properties of the page and two optional elements that specify the properties of headers andfooters.
11171<define name="style-page-layout">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 485 of 738

11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184

<element name="style:page-layout"><ref name="style-page-layout-attlist"/><optional><ref name="style-page-layout-properties"/></optional><optional><ref name="style-header-style"/></optional><optional><ref name="style-footer-style"/></optional></element></define>

The attributes that may be associated with the <style:page-layout> element are:
•

Name

•

Page usage

Name
The style:name attribute specifies the name of the page layout.
11185
11186
11187
11188
11189

<define name="style-page-layout-attlist" combine="interleave"><attribute name="style:name"><ref name="styleName"/></attribute></define>

Page Usage
The style:page-usage attribute specifies the type of pages that the page master should
generate.
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201

<define name="style-page-layout-attlist" combine="interleave"><optional><attribute name="style:page-usage" a:defaultValue="all"><choice><value>all</value><value>left</value><value>right</value><value>mirrored</value></choice></attribute></optional></define>

14.3.1 Header and Footer Styles
The header and footer style elements <style:header-style> and <style:footer-style>specify the formatting properties for headers and footers on a page. These elements must be
contained within a page layout element. The contain a <style:header-footer-properties>
element that contains the formatting properties of the header or footer.
11202
11203
11204
11205
11206

<define name="style-header-style"><element name="style:header-style"><optional><ref name="style-header-footer-properties"/></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 486 of 738

11207
11208
11209
11210
11211
11212
11213
11214
11215

</element></define><define name="style-footer-style"><element name="style:footer-style"><optional><ref name="style-header-footer-properties"/></optional></element></define>

14.4 Master Pages
In text and spreadsheet documents, the <style:master-page> element contains the content
of headers and footers. In these applications, a sequence of pages is generated by making use ofa single master page or a set of master pages.
In drawing and presentation documents, the <style:master-page> element is used to define
master pages as common backgrounds for drawing pages. Each drawing page here is directly
linked to one master page, which is specified by the draw:master-page-name attribute of thedrawing pages style.
Master pages are contained in the <office:master-styles> element. See also section 2.8.
All document must contain at least one master page element.
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244

<define name="style-master-page"><element name="style:master-page"><ref name="style-master-page-attlist"/><optional><ref name="style-header"/><optional><ref name="style-header-left"/></optional></optional><optional><ref name="style-footer"/><optional><ref name="style-footer-left"/></optional></optional><optional><ref name="office-forms"/></optional><zeroOrMore><ref name="style-style"/></zeroOrMore><zeroOrMore><ref name="shape"/></zeroOrMore><optional><ref name="presentation-notes"/></optional></element></define>

The attributes that may be associated with the <style:master-page> element are:•Page name•

Display name•

Page layout

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 487 of 738

•Page style•

Next style name

The elements that my be included in the <style:master-page> element are:•Headers and Footers

•

Forms

•

Styles•Shapes•Presentation notes

Page Name
The style:name attribute specifies the name of a master page. Each master page is referenced
using the page name. This attribute is required and the name specified must be unique.
11245
11246
11247
11248
11249

<define name="style-master-page-attlist" combine="interleave"><attribute name="style:name"><ref name="styleName"/></attribute></define>

Display Name
The style:display-name attribute specifies the name of the master as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
11250
11251
11252
11253
11254
11255
11256

<define name="style-master-page-attlist" combine="interleave"><optional><attribute name="style:display-name"><ref name="string"/></attribute></optional></define>

Page Layout
The style:page-layout-name attribute specifies a page layout which contains the sizes,
border and orientation of the master page. See section 14.3 for details on page layouts.
11257
11258
11259
11260
11261

<define name="style-master-page-attlist" combine="interleave"><attribute name="style:page-layout-name"><ref name="styleNameRef"/></attribute></define>

Page Style
In graphic applications, additional drawing page attributes my be assigned to a drawing pageusing the draw:style-name attribute. This attribute is optional. The fixed family for page styles
is drawing-page. This is used to define an optional background filling.
11262
11263

<define name="style-master-page-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 488 of 738

11264
11265
11266
11267
11268

<attribute name="draw:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Next Style Name
For text and spreadsheet documents, the style:next-style-name attribute identifies themaster page that is used for the next page if the current page is entirely filled. This attribute is
optional. If the next style name is not specified, the current master page is used for the next page.
The value of this attribute must be the name of another style:master-page element.
11269
11270
11271
11272
11273
11274
11275

<define name="style-master-page-attlist" combine="interleave"><optional><attribute name="style:next-style-name"><ref name="styleNameRef"/></attribute></optional></define>

14.4.1 Headers and Footers
The header and footer elements specify the content of headers and footers. They are contained
within a master page element. The <style:header> and <style:footer> elements containthe content of headers and footers. The two additional elements, <style:header-left> and<style:footer-left>, can be used to specify different content for left pages, if appropriate. If
the latter two elements are missing, the content of the headers and footers on left and right pages
is the same.
If the style:page-usage attribute associated with the page layout has a value of all or
mirrored and there are no <style:header-left> or <style:footer-left> elements, theheader and footer content is the same for left and right pages.
If the style:page-usage attribute has a value of left or right, the <style:headerleft> or <style:footer-left> elements are ignored.
The content of headers and footers is either:

11276
11277
11278
11279
11280
11281
11282
11283
11284
11285

•

Standard text content, for example paragraphs, tables, or lists. Such headers and footersusually are supported by text documents.

•

A sequence of any of the following elements; <style:region-left>, <style:regioncenter> and <style:region-right>. These elements usually are supported byspreadsheet documents.

•

Empty, which switches off the display of all headers or footers. It is not possible to switch off
the display of headers or footers for left pages only.

<define name="style-header"><element name="style:header"><ref name="common-style-header-footer-attlist"/><ref name="header-footer-content"/></element></define><define name="style-footer"><element name="style:footer"><ref name="common-style-header-footer-attlist"/><ref name="header-footer-content"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 489 of 738

11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336

</element></define><define name="style-header-left"><element name="style:header-left"><ref name="common-style-header-footer-attlist"/><ref name="header-footer-content"/></element></define><define name="style-footer-left"><element name="style:footer-left"><ref name="common-style-header-footer-attlist"/><ref name="header-footer-content"/></element></define><define name="header-footer-content"><choice><group><ref name="text-tracked-changes"/><ref name="text-decls"/><zeroOrMore><choice><ref name="text-h"/><ref name="text-p"/><ref name="text-list"/><ref name="table-table"/><ref name="text-section"/><ref name="text-table-of-content"/><ref name="text-illustration-index"/><ref name="text-table-index"/><ref name="text-object-index"/><ref name="text-user-index"/><ref name="text-alphabetical-index"/><ref name="text-bibliography"/><ref name="text-index-title"/><ref name="change-marks"/></choice></zeroOrMore></group><group><optional><ref name="style-region-left"/></optional><optional><ref name="style-region-center"/></optional><optional><ref name="style-region-right"/></optional></group></choice></define>

Display
The style:display attribute specifies whether the header or footer is displayed or not.
11337
11338
11339
11340
11341

<define name="common-style-header-footer-attlist" combine="interleave"><optional><attribute name="style:display" a:defaultValue="true"><ref name="boolean"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 490 of 738

1134211343</optional></define>

Regions
The region elements <style:region-left>, <style:region-center> and<style:region-right> specify three regions of a header or footer that are displayed leftaligned, centered or right aligned. Each of these regions can contain a sequence of paragraphs.
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358

<define name="style-region-left"><element name="style:region-left"><ref name="region-content"/></element></define><define name="style-region-center"><element name="style:region-center"><ref name="region-content"/></element></define><define name="style-region-right"><element name="style:region-right"><ref name="region-content"/></element></define>

11359
11360
11361
11362
11363
11364

<define name="region-content"><zeroOrMore><ref name="text-p"/></zeroOrMore></define>

14.4.2 Presentation Notes
The <presentation:notes> element is usually supported only by presentation applications,where each master page as well as each drawing page in a presentation can have an additionalpresentation notes page. The presentation notes page contains:

11365
11366
11367
11368
11369
11370
11371
11372
11373
11374

•

A preview of the drawing page.

•

Additional graphic shapes as contained in the <presentation:notes> element. While the<presentation:notes> may contain any kind of shapes, the only shape type that should
be supported by presentation applications are text boxes (i.e., <draw:text-box> containedin a <draw:frame>).

<define name="presentation-notes"><element name="presentation:notes"><ref name="common-presentation-header-footer-attlist"/><ref name="presentation-notes-attlist"/><ref name="office-forms"/><zeroOrMore><ref name="shape"/></zeroOrMore></element></define>

Page Layout
The style:page-layout-name attribute specifies a page layout which contains the sizes,
border and orientation of the notes page. See section 14.3 for details on page layouts.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 491 of 738

11375
11376
11377
11378
11379
11380
11381

<define name="presentation-notes-attlist" combine="interleave"><optional><attribute name="style:page-layout-name"><ref name="styleNameRef"/></attribute></optional></define>

Page Style
The attribute draw:style-name assigns an additional formatting attributes to a notes page byassigning a drawing page style. This attribute is optional. The fixed family for page styles isdrawing-page.
11382
11383
11384
11385
11386
11387
11388

<define name="presentation-notes-attlist" combine="interleave"><optional><attribute name="draw:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Header Declaration
The presentation:use-header-name attribute specifies the name of the header fielddeclaration (see section 9.11.2) that is used for all header fields (see section 9.10.1) that are
displayed on the notes page. See also section 9.1.4.

Footer Declaration
The presentation:use-footer-name attribute specifies the name of the footer fielddeclaration (see section 9.11.3) that is used for all footer fields (see section 9.10.2) that are
displayed on the notes page. See also section 9.1.4.

Date and Time Declaration
The presentation:use-date-time-name attribute specifies the name of the date-time fielddeclaration (see section 9.11.4) that is used for all date-time fields (see section 9.10.3) that are
displayed on the notes page. See also section 9.1.4.
Example: Master page containing presentation notes.
<office:master-styles>...
<style:master-page style:name="home" style:page-layout="default"><style:style style:name="title" style:family="presentation"><style:text-properties fo:font-style="italic"/></style:style><style:style style:name="subtitle" style:family="presentation"style:parent-style-name="title"><style:text-properties style:text-outline="true"/></style:style><draw:rectangle .../><presentation:notes><draw:text ...>this is a note</draw:text></presentation:notes></style:master-page>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 492 of 738

...
</office:master-styles>

14.5 Table Templates
A table template is a set formatting properties, like borders, background color, and text properties
that can be applied to a table when creating it. In contrast to other styles, it is not referenced by atable, but if a table is created, a set of table-cell styles is created from the table template. Tochange the formatting properties of a table, the cell styles and other styles themselves have to bechanged. Table are contained in the <style:master-styles> element.
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416

<define name="table-table-template"><element name="table:table-template"><ref name="table-table-template-attlist"/><optional><ref name="table-first-row"/></optional><optional><ref name="table-last-row"/></optional><optional><ref name="table-first-column"/></optional><optional><ref name="table-last-column"/></optional><choice><ref name="table-body"/><group><ref name="table-even-rows"/><ref name="table-odd-rows"/></group><group><ref name="table-even-columns"/><ref name="table-odd-columns"/></group></choice></element></define>

Style Name
The table:name attribute specifies the name of the table template.
11417
11418
11419
11420
11421

<define name="table-table-template-attlist" combine="interleave"><attribute name="text:name"><ref name="string"/></attribute></define>

Corner Styles
The attributes table:first-row-start-column, table:first-row-end-column,
table:last-row-start-column and table:last-row-end-column specify whether thecells in the four corners of the table should get the style from the row they are in or from thecolumn. The possible values of these attributes are row and column.
11422
11423
11424

<define name="table-table-template-attlist" combine="interleave"><attribute name="text:first-row-start-column"><ref name="rowOrCol"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 493 of 738

1142511426</attribute></define>

11427
11428
11429
11430
11431
11432

<define name="table-table-template-attlist" combine="interleave"><attribute name="text:first-row-end-column"><ref name="rowOrCol"/></attribute></define>

11433
11434
11435
11436
11437
11438

<define name="table-table-template-attlist" combine="interleave"><attribute name="text:last-row-start-column"><ref name="rowOrCol"/></attribute></define>

11439
11440
11441
11442
11443
11444

<define name="table-table-template-attlist" combine="interleave"><attribute name="text:last-row-end-column"><ref name="rowOrCol"/></attribute></define>

11445
11446
11447
11448
11449
11450
11451

<define name="rowOrCol"><choice><value>row</value><value>column</value></choice></define>

14.5.1 Row and Column Styles
The elements <table:first-row> and <table:last-row> specify the cell styles that shallbe applied to the first and last row of a table. They have a text:style-name attribute thatreferences these styles.
The optional text:paragraph-style-name attribute specifies the paragraph style whichshould be applied to the empty paragraphs created in the corresponding cells
The elements <table:first-col> and <table:last-col> do the same for the first and lasttable column.
For the remaining cells, the cells styles can either be specified by the <table:body> element, orby the <table:even-rows>/<table:odd-rows> or <table:evencolumns>/<table:odd-columns> element pairs if different cell styles should be applied toeven and odd rows or columns.
11452
11453
11454
11455
11456
11457

<define name="table-first-row"><element name="table:first-row"><ref name="common-table-template-attlist"/><empty/></element></define>

11458
11459
11460
11461
11462
11463
11464

<define name="table-last-row"><element name="table:last-row"><ref name="common-table-template-attlist"/><empty/></element></define>

11465
11466
11467

<define name="table-first-column"><element name="table:first-column">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 494 of 738

11468
11469
11470
11471

<ref name="common-table-template-attlist"/><empty/></element></define>

11472
11473
11474
11475
11476
11477
11478

<define name="table-last-column"><element name="table:last-column"><ref name="common-table-template-attlist"/><empty/></element></define>

11479
11480
11481
11482
11483
11484
11485

<define name="table-body"><element name="table:body"><ref name="common-table-template-attlist"/><empty/></element></define>

11486
11487
11488
11489
11490
11491
11492

<define name="table-even-rows"><element name="table:even-rows"><ref name="common-table-template-attlist"/><empty/></element></define>

11493
11494
11495
11496
11497
11498
11499

<define name="table-odd-rows"><element name="table:odd-rows"><ref name="common-table-template-attlist"/><empty/></element></define>

11500
11501
11502
11503
11504
11505
11506

<define name="table-even-columns"><element name="table:even-columns"><ref name="common-table-template-attlist"/><empty/></element></define>

11507
11508
11509
11510
11511
11512
11513

<define name="table-odd-columns"><element name="table:odd-columns"><ref name="common-table-template-attlist"/><empty/></element></define>

11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524

<define name="common-table-template-attlist" combine="interleave"><attribute name="text:style-name"><ref name="styleNameRef"/></attribute><attribute name="text:paragraph-style-name"><optional><ref name="styleNameRef"/></optional></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 495 of 738

14.6 Font Face Declaration
OpenDocument font face declarations directly correspond to the @font-face font description of[CSS2] (see §15.3.1) and the <font-face> element of [SVG] (see §20.8.3), but have thefollowing two extensions:•

OpenDocument font face declarations optionally may have an unique name. This name canbe used inside styles (i.e., as attribute of <style:text-properties> element) as value ofthe style:font-name attribute to immediately select a font face declaration. If a font facedeclaration is referenced this way, the steps described in §15.5 the [CSS2] font matchingalgorithms for selecting a font declaration based on the font-family, font-style, font-variant,font-weight and font-size descriptors will not take place, but the referenced font facedeclaration is used directly.

•

Some additional font descriptor attributes exist. They are described below.

With the exception mentioned above, conforming applications should implement the CSS2 fontmatching algorithm as described in described in §15.5 the [CSS2], but they may also implement
variants of it. They are especially allowed to implement a font matching based only on the fontface declarations, that is, a font matching that is not applied to every character independently but
only once for each font face declaration. This is useful for editing applications, where a fontmatching based on characters might be too expensive.
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535

<define name="style-font-face"><element name="style:font-face"><ref name="style-font-face-attlist"/><optional><ref name="svg-font-face-src"/></optional><optional><ref name="svg-definition-src"/></optional></element></define>

14.6.1 CSS2/SVG Font Descriptors
Font face declarations support the font descriptor attributes and elements described in §20.8.3 of[SVG].
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555

<define name="style-font-face-attlist" combine="interleave"><optional><attribute name="svg:font-family"><ref name="string"/></attribute></optional><optional><attribute name="svg:font-style"><ref name="fontStyle"/></attribute></optional><optional><attribute name="svg:font-variant"><ref name="fontVariant"/></attribute></optional><optional><attribute name="svg:font-weight"><ref name="fontWeight"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 496 of 738

11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617

</optional><optional><attribute name="svg:font-stretch"><choice><value>normal</value><value>ultra-condensed</value><value>extra-condensed</value><value>condensed</value><value>semi-condensed</value><value>semi-expanded</value><value>expanded</value><value>extra-expanded</value><value>ultra-expanded</value></choice></attribute></optional><optional><attribute name="svg:font-size"><ref name="positiveLength"/></attribute></optional><optional><attribute name="svg:unicode-range"/></optional><optional><attribute name="svg:units-per-em"><ref name="integer"/></attribute></optional><optional><attribute name="svg:panose-1"/></optional><optional><attribute name="svg:stemv"><ref name="integer"/></attribute></optional><optional><attribute name="svg:stemh"><ref name="integer"/></attribute></optional><optional><attribute name="svg:slope"><ref name="integer"/></attribute></optional><optional><attribute name="svg:cap-height"><ref name="integer"/></attribute></optional><optional><attribute name="svg:x-height"><ref name="integer"/></attribute></optional><optional><attribute name="svg:accent-height"><ref name="integer"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 497 of 738

11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679

<optional><attribute name="svg:ascent"><ref name="integer"/></attribute></optional><optional><attribute name="svg:descent"><ref name="integer"/></attribute></optional><optional><attribute name="svg:widths"/></optional><optional><attribute name="svg:bbox"/></optional><optional><attribute name="svg:ideographic"><ref name="integer"/></attribute></optional><optional><attribute name="svg:alphabetic"><ref name="integer"/></attribute></optional><optional><attribute name="svg:mathematical"><ref name="integer"/></attribute></optional><optional><attribute name="svg:hanging"><ref name="integer"/></attribute></optional><optional><attribute name="svg:v-ideographic"><ref name="integer"/></attribute></optional><optional><attribute name="svg:v-alphabetic"><ref name="integer"/></attribute></optional><optional><attribute name="svg:v-mathematical"><ref name="integer"/></attribute></optional><optional><attribute name="svg:v-hanging"><ref name="integer"/></attribute></optional><optional><attribute name="svg:underline-position"><ref name="integer"/></attribute></optional><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 498 of 738

11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704

<attribute name="svg:underline-thickness"><ref name="integer"/></attribute></optional><optional><attribute name="svg:strikethrough-position"><ref name="integer"/></attribute></optional><optional><attribute name="svg:strikethrough-thickness"><ref name="integer"/></attribute></optional><optional><attribute name="svg:overline-position"><ref name="integer"/></attribute></optional><optional><attribute name="svg:overline-thickness"><ref name="integer"/></attribute></optional></define>

11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715

<define name="svg-font-face-src"><element name="svg:font-face-src"><oneOrMore><choice><ref name="svg-font-face-uri"/><ref name="svg-font-face-name"/></choice></oneOrMore></element></define>

11716
11717
11718
11719
11720
11721
11722
11723
11724

<define name="svg-font-face-uri"><element name="svg:font-face-uri"><ref name="common-svg-font-face-xlink-attlist"/><zeroOrMore><ref name="svg-font-face-format"/></zeroOrMore></element></define>

11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741

<define name="svg-font-face-format"><element name="svg:font-face-format"><optional><attribute name="svg:string"/></optional><empty/></element></define><define name="svg-font-face-name"><element name="svg:font-face-name"><optional><attribute name="svg:name"/></optional><empty/></element></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 499 of 738

11742
11743
11744
11745
11746
11747
11748

<define name="svg-definition-src"><element name="svg:definition-src"><ref name="common-svg-font-face-xlink-attlist"/><empty/></element></define>

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764

<define name="common-svg-font-face-xlink-attlist" combine="interleave"><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><value>simple</value></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onRequest"><value>onRequest</value></attribute></optional></define>

14.6.2 Name
The style:name attribute specifies the unique name of the font declaration. This name can beused inside styles (i.e., as an attribute of the <style:text-properties> element) as value ofthe style:font-name attribute to immediately select a font face declaration
11765
11766
11767
11768
11769

<define name="style-font-face-attlist" combine="interleave"><attribute name="style:name"><ref name="string"/></attribute></define>

14.6.3 Adornments
The style:font-adornments attributes specifies adornments, like bold or italic that can beused to locate a font in addition to the family name.
11770
11771
11772
11773
11774
11775
11776

<define name="style-font-face-attlist" combine="interleave"><optional><attribute name="style:font-adornments"><ref name="string"/></attribute></optional></define>

14.6.4 Font Family Generic
The style:font-family-generic attribute specifies a generic font family name. See section
15.4.15 for details.
11777
11778
11779
11780
11781

<define name="style-font-face-attlist" combine="interleave"><optional><attribute name="style:font-family-generic"><ref name="fontFamilyGeneric"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 500 of 738

1178211783</optional></define>

14.6.5 Font Pitch
The style:font-pitch attribute specifies whether a font has a fixed or variable width. See
section 15.4.17 for details.
11784
11785
11786
11787
11788
11789
11790

<define name="style-font-face-attlist" combine="interleave"><optional><attribute name="style:font-pitch"><ref name="fontPitch"/></attribute></optional></define>

11791

14.6.6 Font Character Set
The style:font-charset attribute specifies the character set of a font. See section 15.4.18
for details.
11792
11793
11794
11795
11796
11797
11798

<define name="style-font-face-attlist" combine="interleave"><optional><attribute name="style:font-charset"><ref name="textEncoding"/></attribute></optional></define>

14.7 Data Styles
Data styles describe how to display different types of data, for example, a number or a date. The
elements and attributes that are used to represent data styles are contained in the namespace
urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0. The prefix number denotes the datastyles namespace.
This section describes the OpenDocument representation of the following data styles:•

Number style•

Currency style•

Percentage style•

Date style•

Boolean style•

Text style

14.7.1 Number Style
The <number:number-style> element describes the style for decimal numbers.
This element can contain one of the following elements:•<number:number>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 501 of 738

•<number:scientific-number>•<number:fraction>

These elements describe the display format of the number. The elements can be preceded orfollowed by <number:text> elements, which contain any additional text to be displayed before
or after the number.
In addition, this element can contain a <style:text-properties> element and a<style:map> element.
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818

<define name="number-number-style"><element name="number:number-style"><ref name="common-data-style-attlist"/><optional><ref name="style-text-properties"/></optional><optional><ref name="number-text"/></optional><optional><ref name="any-number"/><optional><ref name="number-text"/></optional></optional><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

11819
11820
11821
11822
11823
11824
11825
11826

<define name="any-number"><choice><ref name="number-number"/><ref name="number-scientific-number"/><ref name="number-fraction"/></choice></define>

See section 14.7.9 for information about the attributes that may be associated with the number
style elements.
The following elements may be contained in the <number:number-style> element:•

Number•Scientific number•

Fraction

Number
The <number:number> element specifies the display properties for a decimal number.
This element is contained in the <number:number-style> element. The <number:number>element can contain multiple <number:embedded-text> elements.
The number:decimal-replacement and number:display-factor attributes may be usedwith this element. See also section 14.7.11 for information about additional attributes that may be
associate with the <number:number> element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 502 of 738

11827
11828
11829
11830
11831
11832
11833
11834
11835
11836

<define name="number-number"><element name="number:number"><ref name="number-number-attlist"/><ref name="common-decimal-places-attlist"/><ref name="common-number-attlist"/><zeroOrMore><ref name="number-embedded-text"/></zeroOrMore></element></define>

Decimal Replacement
If a number style specifies that decimal places are used but the number displayed is an integer, areplacement text may be displayed instead of the decimal places. The number:decimalreplacement attribute specifies the replacement text.
Some applications may supports replacement text only that consists of the same number of “-”characters as decimal places.
11837
11838
11839
11840
11841

<define name="number-number-attlist" combine="interleave"><optional><attribute name="number:decimal-replacement"/></optional></define>

Display Factor
The number:display-factor attribute specifies a factor by which each number is scaled(divided) before displaying. A factor of 1000, for example, causes numbers to be displayed inthousands.
Some applications may only support display factors of 1000 to the power of a non-negative integer
number, that is 1, 1000, 1000000, 1000000000, etc.
11842
11843
11844
11845
11846
11847
11848

<define name="number-number-attlist" combine="interleave"><optional><attribute name="number:display-factor" a:defaultValue="1"><ref name="double"/></attribute></optional></define>

Embedded Text
The <number:embedded-text> element specifies text that is displayed at one specific position
within a number. This element is different to a grouping separator, which appears several times
within a number.
This element is contained in the <number:number> element. The <number:number> element
can contain multiple occurrences of the <number:embedded-text> element to describe text at
different positions in the number.
11849
11850
11851
11852
11853
11854

<define name="number-embedded-text"><element name="number:embedded-text"><ref name="number-embedded-text-attlist"/><text/></element></define>

The number:position attribute specifies the position where the text appears.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 503 of 738

Position Attribute
The position is counted from right to left, from before the decimal point if one exists, or else fromthe end of the number. For example, position number 1 indicates that the text is inserted before
the last digit. Position number 2 indicates that the text is inserted before the second last digit, andso on.
11855
11856
11857
11858
11859

<define name="number-embedded-text-attlist" combine="interleave"><attribute name="number:position"><ref name="integer"/></attribute></define>

Scientific Number
The <number:scientific-number> element specifies the display properties for a number
style that should be displayed in scientific format.
This element is contained in the <number:number-style> element.
The number:min-exponent-digits attribute may be used with this element. See section
14.7.11 for information on additional attributes that may be associated with the<number:scientific-number> element.
11860
11861
11862
11863
11864
11865
11866
11867

<define name="number-scientific-number"><element name="number:scientific-number"><ref name="number-scientific-number-attlist"/><ref name="common-decimal-places-attlist"/><ref name="common-number-attlist"/><empty/></element></define>

Minimum Exponent Digits
The number:min-exponent-digits attribute specifies the minimum number of digits to use todisplay an exponent. This attribute is supported for the <number:scientific-number>element.
11868
11869
11870
11871
11872
11873
11874

<define name="number-scientific-number-attlist" combine="interleave"><optional><attribute name="number:min-exponent-digits"><ref name="integer"/></attribute></optional></define>

Fraction
The <number:fraction> element specifies the display properties for a number style thatshould be displayed as a fraction.
This element is contained in the <number:number-style> element.
The number:min-numerator-digits and number:min-denominator-digits attributes
may be used with this element. See section 14.7.11 for information on the attributes that may be
associated with the <number:fraction> elements.
11875
11876
11877

<define name="number-fraction"><element name="number:fraction"><ref name="number-fraction-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 504 of 738

11878
11879
11880
11881

<ref name="common-number-attlist"/><empty/></element></define>

Minimum Numerator Digits
The number:min-numerator-digits attribute specifies the minimum number of digits to use
to display the numerator in a fraction.
11882
11883
11884
11885
11886
11887
11888

<define name="number-fraction-attlist" combine="interleave"><optional><attribute name="number:min-numerator-digits"><ref name="integer"/></attribute></optional></define>

Minimum Denominator Digits
The number:min-denominator-digits attribute specifies the minimum number of digits to
use to display the denominator of a fraction.
11889
11890
11891
11892
11893
11894
11895

<define name="number-fraction-attlist" combine="interleave"><optional><attribute name="number:min-denominator-digits"><ref name="integer"/></attribute></optional></define>

Denominator Value
The number:denominator-value attribute specifies an integer value that is used as
denominator of a fraction. If this attribute is not present, the application may choose an arbitrary
denominator value.
11896
11897
11898
11899
11900
11901
11902

<define name="number-fraction-attlist" combine="interleave"><optional><attribute name="number:denominator-value"><ref name="integer"/></attribute></optional></define>

14.7.2 Currency Style
The <number:currency-style> element describes the style for currency values.
This element can contain one <number:number> element and one <number:currencysymbol> element. It can also contain <number:text> elements , which display additional text,
but it cannot contain two of these elements consecutively.
In addition, this element can contain a <style:text-properties> element and a<style:map> element.
11903
11904
11905
11906
11907
11908

<define name="number-currency-style"><element name="number:currency-style"><ref name="common-data-style-attlist"/><ref name="common-auto-reorder-attlist"/><optional><ref name="style-text-properties"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 505 of 738

11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933

</optional><optional><ref name="number-text"/></optional><optional><choice><group><ref name="number-and-text"/><optional><ref name="currency-symbol-and-text"/></optional></group><group><ref name="currency-symbol-and-text"/><optional><ref name="number-and-text"/></optional></group></choice></optional><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946

<define name="currency-symbol-and-text"><ref name="number-currency-symbol"/><optional><ref name="number-text"/></optional></define><define name="number-and-text"><ref name="number-number"/><optional><ref name="number-text"/></optional></define>

See section 14.7.9 for information about the attributes that may be associated with the number
style elements.
The following elements may be contained in the <number:currency-style> element:•

Number, see section 14.7.1.

•

Currency symbol

Currency Symbol
The <number:currency-symbol> element determines whether or not a currency symbol isdisplayed in a currency style.
The content of this element is the text that is displayed as the currency symbol. If the element isempty or contains white space characters only, the default currency symbol for the currency styleor the language and country of the currency style is displayed.
This element is contained in the <number:currency-style> element.
11947
11948
11949

<define name="number-currency-symbol"><element name="number:currency-symbol"><ref name="number-currency-symbol-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 506 of 738

1195011951
11952<text/></element></define>

The number:language and number:country attributes may be used to specify the language
and country of the currency symbol. See section 14.7.11 for information on the other attributes
that may be associated with the currency style elements.
Currency Language and Country Attributes
If the currency symbol contained in a currency style belongs to a different language or country
than the currency style itself, then the number:language and number:country attributes may
be used to specify the language and country of the currency symbol.
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964

<define name="number-currency-symbol-attlist" combine="interleave"><optional><attribute name="number:language"><ref name="languageCode"/></attribute></optional><optional><attribute name="number:country"><ref name="countryCode"/></attribute></optional></define>

14.7.3 Percentage Style
The <number:percentage-style> element describes the style for percentage values.
This element can contain one <number:number> element, which describes the display format
for the percentage. The element can be preceded or followed by <number:text> elements,
which contain any additional text to display before or after the percentage. Some applications
require that at least one <number:text> element exist and that its text must contain a “%”character.
In addition, the <number:percentage-style> element can contain a <style:textproperties> element and a <style:map> element.
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981

<define name="number-percentage-style"><element name="number:percentage-style"><ref name="common-data-style-attlist"/><optional><ref name="style-text-properties"/></optional><optional><ref name="number-text"/></optional><optional><ref name="number-and-text"/></optional><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

See section 14.7.9 for information on the attributes that may be associated with the percentage
style element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 507 of 738

14.7.4 Date Style
The <number:date-style> element describes the style for date values.
This element can contain one instance of each of the following elements: <number:day>,<number:month>, <number:year>, <number:era>, <number:day-of-week>,<number:week-of-year>, <number:quarter>, <number:hours>, <number:minutes>,<number:seconds>, and <number:am-pm>.
The <number:date-style> element can also contain <number:text> elements, whichdisplay additional text, but it cannot contain two of these elements consecutively. In addition, it cancontain a <style:text-properties> element and a <style:map> element.
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005

<define name="number-date-style"><element name="number:date-style"><ref name="common-data-style-attlist"/><ref name="common-auto-reorder-attlist"/><ref name="common-format-source-attlist"/><optional><ref name="style-text-properties"/></optional><!-- This DTD does not reflect the fact that some elements must not --><!-- occur more than once. --><optional><ref name="number-text"/></optional><oneOrMore><ref name="any-date"/><optional><ref name="number-text"/></optional></oneOrMore><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021

<define name="any-date"><choice><ref name="number-day"/><ref name="number-month"/><ref name="number-year"/><ref name="number-era"/><ref name="number-day-of-week"/><ref name="number-week-of-year"/><ref name="number-quarter"/><ref name="number-hours"/><ref name="number-am-pm"/><ref name="number-minutes"/><ref name="number-seconds"/></choice></define>

See section 14.7.9 for information on the attributes that may be associated with the date styleelements.
The <number:date-style> element can contain the following elements:•<number:day> – day of month•<number:month> – month

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 508 of 738

•<number:year> – year•

<number:era> – era•<number:day-of-week> – day of week•<number:week-of-year> – week of year•

<number:quarter> – quarterDay of Month
The <number:day> element specifies the day of the month in a date.
If this element is used, it should be contained in the <number:date-style> element.
12022
12023
12024
12025
12026
12027
12028

<define name="number-day"><element name="number:day"><ref name="number-day-attlist"/><ref name="common-calendar-attlist"/><empty/></element></define>

The number:style attribute may be used with this element. See section 14.7.11 for informationon the other attributes that may be associated with the element.
Format Attribute
The number:style attribute specifies whether the day of month element is displayed in short orlong format. The value of this attribute can be short or long. The meaning of these values
depends on the value of the number:format-source attribute that is attached to the date style.
For days, if the value of the number:format-source attribute is fixed:

12029
12030
12031
12032
12033
12034
12035
12036
12037
12038

•

short means that the day of the month is displayed using one or two digits•

long means that the day of the month is displayed using two digits<define name="number-day-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Month
The <number:month> element specifies the month in a date.
If used, this element must be contained in the <number:date-style> element.
12039
12040
12041
12042
12043

<define name="number-month"><element name="number:month"><ref name="number-month-attlist"/><ref name="common-calendar-attlist"/><empty/>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 509 of 738

1204412045</element></define>

The number:textual and number:style attributes may be used with this element. See
section 14.7.11 for information on the other attributes that may be associated with the element.
Textual Representation Attribute
The number:textual attribute determines whether the name or number of a month is displayedin the month element of a date. If the value of this attribute value is true, the name of the monthis displayed. If the attribute value is false, the number of the month is displayed.
12046
12047
12048
12049
12050
12051
12052

<define name="number-month-attlist" combine="interleave"><optional><attribute name="number:textual" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Possessive Form Attribute
The number:possessive-form attribute determines whether the month is displayed as is (e.g.,
as in "17 January 2004") or using the possessive form (e.g., as in "17th day of January"). If thevalue of this attribute value is true, the name of the month is displayed in possessive form. If theattribute value is false, the number of the month is displayed as is.
12053
12054
12055
12056
12057
12058
12059

<define name="number-month-attlist" combine="interleave"><optional><attribute name="number:possessive-form" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Format Attribute
The number:style attribute specifies whether the month element is displayed in short or longformat. The value of this attribute can be short or long. The meaning of these values depends
on the value of the number:format-source attribute that is attached to the date style.
For months, if the value of the number:format-source attribute is fixed:

12060
12061
12062
12063
12064
12065
12066
12067
12068
12069

•

short means that the abbreviated name of the month is displayed or the month is displayedusing one or two digits•

long means that the full name of the month is displayed or the month is displayed using two
digits<define name="number-month-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 510 of 738

Year
The <number:year> element specifies the year in the date.
If used, this element must be contained in the <number:date-style> element.
12070
12071
12072
12073
12074
12075
12076

<define name="number-year"><element name="number:year"><ref name="number-year-attlist"/><ref name="common-calendar-attlist"/><empty/></element></define>

The number:style attribute may be used with this element. See section 14.7.11 for informationon the other attributes that may be associated with the element.
Format Attribute
The number:style attribute specifies whether the year element is displayed in short or longformat. The value of this attribute can be short or long. The meaning of these values depends
on the value of the number:format-source attribute that is attached to the date style.
For years, if the value of the number:format-source attribute is fixed:

12077
12078
12079
12080
12081
12082
12083
12084
12085
12086

•

short means that the year is displayed using two digits•

long means that the year is displayed using four digits<define name="number-year-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Era
The <number:era> element specifies the era in which the year is counted.
If used, this element must be contained in the <number:date-style> element.
12087
12088
12089
12090
12091
12092
12093

<define name="number-era"><element name="number:era"><ref name="number-era-attlist"/><ref name="common-calendar-attlist"/><empty/></element></define>

The number:style attribute may be used with this element. See section 14.7.11 for informationon the other attributes that may be associated with the element.
Format Attribute
The number:style attribute specifies whether the era element is displayed in short or longformat. The value of this attribute can be short or long. The meaning of these values depends
on the value of the number:format-source attribute that is attached to the date style.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 511 of 738

For eras, if the value of the number:format-source attribute is fixed:

12094
12095
12096
12097
12098
12099
12100
12101
12102
12103

•

short means that the abbreviated era name is used•

long means that the full era name is used<define name="number-era-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Day Of Week
The <number:day-of-week> element specifies the day of the week in a date.
If used, this element must be contained in the <number:date-style> element.
12104
12105
12106
12107
12108
12109
12110

<define name="number-day-of-week"><element name="number:day-of-week"><ref name="number-day-of-week-attlist"/><ref name="common-calendar-attlist"/><empty/></element></define>

The number:style attribute may be used with this element. See section 14.7.11 for informationon the other attributes that may be associated with the element.
Format Attribute
The number:style attribute specifies whether the day of week element is displayed in short orlong format.
The value of this attribute can be short or long. The meaning of these values depends on thevalue of the number:format-source attribute that is attached to the date style.
For days of the week, the value of the number:format-source attribute is fixed:

12111
12112
12113
12114
12115
12116
12117
12118
12119
12120

•

short means that the abbreviated name of the day is displayed•

long means that the full name of the day is displayed<define name="number-day-of-week-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Week Of Year
The <number:week-of-year> element specifies the week of the year in the date.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 512 of 738

If used, this element must be contained in the <number:date-style> element.
12121
12122
12123
12124
12125
12126

<define name="number-week-of-year"><element name="number:week-of-year"><ref name="common-calendar-attlist"/><empty/></element></define>

See section 14.7.11 for information on the the attributes that may be associated with the element.

Quarter
The <number:quarter> element specifies the quarter of the year in the date.
If used, this element must be contained in the <number:date-style> element.
12127
12128
12129
12130
12131
12132
12133

<define name="number-quarter"><element name="number:quarter"><ref name="number-quarter-attlist"/><ref name="common-calendar-attlist"/><empty/></element></define>

The number:style attribute may be used with this element. See section 14.7.11 for informationon the other attributes that may be associated with the element.
Format Attribute
The number:style attribute specifies whether the quarter element is displayed in short or longformat.
The value of this attribute can be short or long. The meaning of these values depends on thevalue of the number:format-source attribute that is attached to the date style.
For quarters, if the value of the number:format-source attribute is fixed:

12134
12135
12136
12137
12138
12139
12140
12141
12142
12143

•

short means that the abbreviated name of the quarter is displayed, for example, Q1•long means that the full name of the quarter is displayed, for example, Quarter 1<define name="number-quarter-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

14.7.5 Time Style
The <number:time-style> element describes the style for time values.
This element can contain one instance of any of the following elements: <number:hours>,<number:minutes>, <number:seconds> and <number:am-pm>.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 513 of 738

The <number:time-style> element can also contain <number:text> elements , whichdisplay additional text, but it cannot contain two of these elements consecutively. In addition, it cancontain a <style:text-properties> element and a <style:map> element.
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167

<define name="number-time-style"><element name="number:time-style"><ref name="number-time-style-attlist"/><ref name="common-data-style-attlist"/><ref name="common-format-source-attlist"/><optional><ref name="style-text-properties"/></optional><!-- This DTD does not reflect the fact that some elements must not --><!-- occur more than once. --><optional><ref name="number-text"/></optional><oneOrMore><ref name="any-time"/><optional><ref name="number-text"/></optional></oneOrMore><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

12168
12169
12170
12171
12172
12173
12174
12175
12176

<define name="any-time"><choice><ref name="number-hours"/><ref name="number-am-pm"/><ref name="number-minutes"/><ref name="number-seconds"/></choice></define>

See section 14.7.9 for information on the attributes that may be associated with the time styleelements.
The following elements can be contained in the <number:time-style> element:•<number:hours> – hours•<number:minutes> – minutes•<number:seconds> – seconds•<number:am-pm> – am/pm

Time Value Truncation
If a time or duration is too large to be displayed using the default value range for a timecomponent, (0 to 23 for <number:hours>), the number:truncate-on-overflow attributemay be used to specify whether the time or duration value should be truncated or whether thevalue range becomes extended.
12177
12178
12179
12180

<define name="number-time-style-attlist" combine="interleave"><optional><attribute name="number:truncate-on-overflow" a:defaultValue="true"><ref name="boolean"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 514 of 738

12181
12182
12183</attribute></optional></define>

Hours
The <number:hours> element specifies if hours are displayed as part of a date or time.
12184
12185
12186
12187
12188
12189

<define name="number-hours"><element name="number:hours"><ref name="number-hours-attlist"/><empty/></element></define>

Format Attribute
The number:style attribute specifies whether the hours element is displayed in short or longformat.
The value of this attribute can be short or long. The meaning of these values depends on thevalue of the number:format-source attribute that is attached to the time style.
For hours, if the value of the number:format-source attribute is fixed:

12190
12191
12192
12193
12194
12195
12196
12197
12198
12199

•

short means that the hours are displayed using at least one digit•

long means that the hours are displayed using at least two digits<define name="number-hours-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Minutes
The <number:minutes> element specifies if minutes are displayed as part of a date or time.
12200
12201
12202
12203
12204
12205

<define name="number-minutes"><element name="number:minutes"><ref name="number-minutes-attlist"/><empty/></element></define>

Format Attribute
The number:style attribute specifies whether the minutes element is displayed in short or longformat.
The value of this attribute can be short or long. The meaning of these values depends on thevalue of the number:format-source attribute that is attached to the time style.
For minutes, if the value of the number:format-source attribute is fixed:•

short means that the minutes are displayed using at least one digit

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 515 of 738

•
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215

long means that the minutes are displayed using at least two digits<define name="number-minutes-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Seconds
The <number:seconds> element specifies if seconds are displayed as part of a date or time.
12216
12217
12218
12219
12220
12221

<define name="number-seconds"><element name="number:seconds"><ref name="number-seconds-attlist"/><empty/></element></define>

Format Attribute
The number:style attribute specifies whether the seconds element is displayed in short or longformat.
The value of this attribute can be short or long. The meaning of these values depends on thevalue of the number:format-source attribute that is attached to the time style.
For seconds, if the value of the number:format-source attribute is fixed:

12222
12223
12224
12225
12226
12227
12228
12229
12230
12231

•

short means that the seconds are displayed using at least one digit•

long means that the seconds are displayed using at least two digits<define name="number-seconds-attlist" combine="interleave"><optional><attribute name="number:style" a:defaultValue="short"><choice><value>short</value><value>long</value></choice></attribute></optional></define>

Decimal Places Attribute
The number:decimal-places attribute determines the number of decimal places to use whendisplaying fractions.
If this attribute is not present or if the value of the attribute is 0, fractions are not displayed.
12232
12233
12234
12235
12236
12237
12238

<define name="number-seconds-attlist" combine="interleave"><optional><attribute name="number:decimal-places" a:defaultValue="0"><ref name="integer"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 516 of 738

AM/PM
The <number:am-pm> element specifies if AM/PM is included as part of the date or time.
If a <number:am-pm> element is contained in a date or time style, hours are displayed using
values from 1 to 12 only.
12239
12240
12241
12242
12243

<define name="number-am-pm"><element name="number:am-pm"><empty/></element></define>

14.7.6 Boolean Style
The <number:boolean-style> element describes the style for Boolean values.
This element can contain one <number:boolean> element, which can be preceded or followedby <number:text> elements. In addition, it can contain a <style:text-properties>
element and a <style:map> element.
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263

<define name="number-boolean-style"><element name="number:boolean-style"><ref name="common-data-style-attlist"/><optional><ref name="style-text-properties"/></optional><optional><ref name="number-text"/></optional><optional><ref name="number-boolean"/><optional><ref name="number-text"/></optional></optional><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

Boolean
The <number:boolean> element contains the Boolean value of a Boolean style.
12264
12265
12266
12267
12268

<define name="number-boolean"><element name="number:boolean"><empty/></element></define>

14.7.7 Text Style
The <number:text-style> element describes the style for displaying text.
This element can contain any number of <number:text-content> elements. It can also
contain <number:text> elements , which display additional text, but it cannot contain two ofthese elements consecutively. In addition, it can contain a <style:text-properties>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 517 of 738

element and a <style:map> element. The <number:text-content> elements represent thevariable text content to display, while the <number:text> elements contain any additional fixed
text to display.
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288

<define name="number-text-style"><element name="number:text-style"><ref name="common-data-style-attlist"/><optional><ref name="style-text-properties"/></optional><optional><ref name="number-text"/></optional><zeroOrMore><ref name="number-text-content"/><optional><ref name="number-text"/></optional></zeroOrMore><zeroOrMore><ref name="style-map"/></zeroOrMore></element></define>

See section 14.7.9 for information on the attributes that may be associated with the text styleelements.

Fixed Text
The <number:text> element contains any fixed text for a data style.
This element is contained in all data styles element.
12289
12290
12291
12292
12293

<define name="number-text"><element name="number:text"><text/></element></define>

Text Content
The <number:text-content> element contains the variable text content of a text style.
12294
12295
12296
12297
12298

<define name="number-text-content"><element name="number:text-content"><empty/></element></define>

14.7.8 Common Data Style Elements
The following common style elements may be contained within data style elements:•

Text formatting properties•

Style mappings

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 518 of 738

Formatting Properties
The <style:text-properties> element specifies the text formatting properties to apply to
any text displayed in the data style. See section 15.4 for information on the formatting properties
element.
The purpose of specifying text formatting properties within data styles is mainly to highlight certain
values (for instance negative ones) by using style mappings. For this reason, data styles usually
support only very few text formatting properties, for instance a text color. There may be also
restrictions for the values of text formatting properties. For instance, the only value allowed for the
text color might be read.

Style Mappings
The <style:map> element specifies an alternative data style to map to if a certain condition
exists. See section 14.1.1 for information on the <style:map> element.
The following rules exist for using style maps element with data style elements:•

The style referenced by the style:apply-style attribute must be of the same type as thestyle containing the map.

•

The condition must be in the format value() op n, where op is a relational operator and n is anumber. For Boolean styles the condition value must be true and false.

14.7.9 Common Data Style Attributes
Many of the data style attributes are applicable to more than one data style element. The following
data style attributes are common to many of the data style elements:
•

Name

•

Language•Country

•

Title

•

Volatility•

Automatic Order•

Format Source•

Transliteration

Name
The style:name attribute specifies the name of the data style. It can be used with all data styleelements.
12299
12300
12301
12302
12303

<define name="common-data-style-attlist" combine="interleave"><attribute name="style:name"><ref name="styleName"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 519 of 738

Display Name
The style:display-name attribute specifies the name of the style as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
The style:display-name attribute can be used with all data style elements.
12304
12305
12306
12307
12308
12309
12310

<define name="style-data-style-attlist" combine="interleave"><optional><attribute name="style:display-name"><ref name="string"/></attribute></optional></define>

Language
The number:language attribute specifies the language of the style. The value of the attribute isa language code in conformance with [RFC3066]. The language code is used to retrieve
information about any display properties that are language-dependent. The language attribute canbe used with all data style elements.
If a language code is not specified, either the system settings or the setting for the system's
language are used, depending on the property whose value should be retrieved.
12311
12312
12313
12314
12315
12316
12317

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:language"><ref name="languageCode"/></attribute></optional></define>

Country
The number:country attribute specifies the country of the style. The value of the attribute is acountry code in conformance with [RFC3066]. The country code is used to retrieve information
about any display properties that are country-dependent. The language attribute can be used withall data style elements.
If a country is not specified, either the system settings or the setting for the system's country areused, depending on the property whose value should be retrieved.
12318
12319
12320
12321
12322
12323
12324

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:country"><ref name="countryCode"/></attribute></optional></define>

Title
The number:title attribute specifies the title of the data style. It can be used with all data styleelements.
12325
12326
12327

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:title"/>OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 520 of 738

1232812329</optional></define>

Volatility
Sometimes when a document is opened, not all of the styles contained in the document are
actually referenced. The application may retain or discard this unused styles. This may becontrolled by the style:volatile attribute, that is supported by all data style elements.
If the value of the attribute is true, the application keeps the style if possible. If the value isfalse, the application discards the unused styles.
12330
12331
12332
12333
12334
12335
12336

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="style:volatile"><ref name="boolean"/></attribute></optional></define>

Automatic OrderThe number:automatic-order attribute can be used to automatically order data to match thedefault order for the language and country of the data style. This attribute is used with thefollowing elements:•<number:currency-style>, where number and the currency symbols are reordered•<number:date-style>, where the <number:date-style> child elements that are not<number:text> or <style:text-properties> elements are reordered

The attribute value can be true or false.
12337
12338
12339
12340
12341
12342
12343

<define name="common-auto-reorder-attlist" combine="interleave"><optional><attribute name="number:automatic-order" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Format Source
The number:format-source attribute specifies the source of the short and long display
formats. It is used with the following elements:•<number:date-style>•<number:time-style>

The value of this attribute can be fixed or language.
If the value is fixed, the meaning of the values number:style attribute's values short andlong is as described in this specification.
If the value of the number:format-source attribute is language, the meaning of short andlong depends on the language and country of the date style, or, if neither of these are specified,applications should use the system settings for short and long date and time formats.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 521 of 738

12344
12345
12346
12347
12348
12349
12350
12351
12352
12353

<define name="common-format-source-attlist"><optional><attribute name="number:format-source" a:defaultValue="fixed"><choice><value>fixed</value><value>language</value></choice></attribute></optional></define>

14.7.10 Transliteration
The various number:transliteration-* attributes specify the native number system of thestyle to display the number using, for example, CJK number characters. The notation is inspiredby the W3C XSLT 2.0 draft, see §12.3 of [XSLT2]. However, to be able to fully distinguishbetween all possible native number systems additional attributes are needed in combination. For
example, Korean uses 11 different systems where the digits are not always different but short andlong and formal and informal forms exist.
The transliteration attributes can be used with all data style elements.

Transliteration Format
The number:transliteration-format attribute specifies which number characters to use.
The value of the attribute is the digit "1" expressed as a native number.
If no format is specified the default ASCII representation of Arabic digits is used, othertransliteration attributes present in this case are ignored.
12354
12355
12356
12357
12358
12359
12360

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:transliteration-format" a:defaultValue="1"><ref name="string"/></attribute></optional></define>

Transliteration Language
The number:transliteration-language attribute specifies which language the native
number system belongs to. The value of the attribute is a language code in conformance with
[RFC3066].
If no language/country (locale) combination is specified the locale of the data style is used.
12361
12362
12363
12364
12365
12366
12367

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:transliteration-language"><ref name="countryCode"/></attribute></optional></define>

Transliteration Country
The number:transliteration-country attribute specifies which country the native number
system belongs to. The value of the attribute is a country code in conformance with [RFC3066].

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 522 of 738

If no language/country (locale) combination is specified the locale of the data style is used.
12368
12369
12370
12371
12372
12373
12374

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:transliteration-country"><ref name="countryCode"/></attribute></optional></define>

Transliteration Style
The number:transliteration-style attribute specifies which style the native number
system belongs to. If more than one native number system matches the transliteration-format this
attribute selects one. A short style should result in a one to one mapping of Arabic digits to native
number digits if possible.
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385

<define name="common-data-style-attlist" combine="interleave"><optional><attribute name="number:transliteration-style" a:defaultValue="short"><choice><value>short</value><value>medium</value><value>long</value></choice></attribute></optional></define>

14.7.11 Common Data Style Child Element Attributes
Many of the number style attributes are applicable to more than one number style element. The
following attributes are common to many of the number style elements:•

Decimal places•

Minimum integer digits•

Grouping separator•

Decimal replacement•

Minimum exponent digits•

Minimum numerator digits•

Minimum denominator digits•

Calendar system

Decimal Places
The number:decimal-places attribute specifies the number of decimal places to display. This
attribute is supported for the following elements:•<number:number>•<number:scientific-number>If this attribute is not specified, a default number of decimal places is used.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 523 of 738

12386
12387
12388
12389
12390
12391
12392

<define name="common-decimal-places-attlist"><optional><attribute name="number:decimal-places"><ref name="integer"/></attribute></optional></define>

Minimum Integer Digits
The number:min-integer-digits attribute specifies the minimum number of integer digits todisplay in a number, a scientific number, or a fraction. This attribute is supported for the following
elements:•<number:number>•<number:scientific-number>•<number:fraction>

If this attribute is not specified, a default number of integer digits is used.
12393
12394
12395
12396
12397
12398
12399

<define name="common-number-attlist" combine="interleave"><optional><attribute name="number:min-integer-digits"><ref name="integer"/></attribute></optional></define>

Grouping Separator
The number:grouping attribute specifies whether or not the integer digits of a number should
be grouped using a separator character. This attribute is supported for the following elements:•<number:number>•<number:scientific-number>•<number:fraction>

The grouping character that is used and the number of digits that are grouped together depends
on the language and country of the style.
12400
12401
12402
12403
12404
12405
12406

<define name="common-number-attlist" combine="interleave"><optional><attribute name="number:grouping" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Calendar System
The number:calendar attribute specifies the calendar system used to extract parts of a date.
This attribute is supported for the following elements:•<number:day>•<number:month>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 524 of 738

•<number:year>•<number:era>•<number:day-of-week>•<number:week-of-year>•<number:quarter>

The attribute may have the values gregorian, gengou, ROC, hanja_yoil, hanja, hijri,
jewish, buddhist or an arbitrary string value. If this attribute is not specified, the default
calendar system is used.
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423

<define name="common-calendar-attlist" combine="interleave"><optional><attribute name="number:calendar"><choice><value>gregorian</value><value>gengou</value><value>ROC</value><value>hanja_yoil</value><value>hanja</value><value>hijri</value><value>jewish</value><value>buddhist</value><ref name="string"/></choice></attribute></optional></define>

14.8 Text Styles
14.8.1 Text Styles
Text styles are <style:style> elements that have the family text. They can be used within all
kind of applications to specify formatting properties for piece of text. They support the text
properties as described in section 15.4.
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>text</value></attribute><optional><ref name="style-text-properties"/></optional></group></define>

14.8.2 Paragraph Styles
Paragraph styles are <style:style> elements that have the family paragraph. They can beused within all kind of applications to specify formatting properties for paragraphs and headings.
They support the paragraph properties described in section 15.5 as well as the text properties
described in section 15.4.
12434<define name="style-style-content" combine="choice">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 525 of 738

12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446

<group><attribute name="style:family"><value>paragraph</value></attribute><optional><ref name="style-paragraph-properties"/></optional><optional><ref name="style-text-properties"/></optional></group></define>

14.8.3 Section Styles
Section styles are <style:style> elements that have the family section. They can be usedwithin text documents to specify formatting properties for a text section. They support the section
properties as described in section 15.7.
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>section</value></attribute><optional><ref name="style-section-properties"/></optional></group></define>

14.8.4 Ruby Style
A ruby style specifies how the ruby text is displayed relative to the base text. It is represented by a<style:style> element those family is ruby. The ruby style is assigned to the ruby element
using a text:style-name attribute. Ruby styles support the formatting properties described in
section 15.6.
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>ruby</value></attribute><optional><ref name="style-ruby-properties"/></optional></group></define>

14.9 Enhanced Text Styles
14.9.1 Line Numbering Configuration
A document can contain none or one line numbering configuration element<text:linenumbering-configuration> within the <office:styles> element. If theelement is not present, a default line numbering configuration is used. The default line numbering
may vary on the office application software, but every document saved by an application that
supports line numbering should contain a line numbering configuration element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 526 of 738

12467
12468
12469
12470
12471
12472
12473
12474

<define name="text-linenumbering-configuration"><element name="text:linenumbering-configuration"><ref name="text-linenumbering-configuration-attlist"/><optional><ref name="text-linenumbering-separator"/></optional></element></define>

The attributes that may be associated with the <text:linenumbering-configuration>
element are:•Line numbering enable•

Number format•

Text style•

Increment•

Position•

Offset•Count empty lines•

Count line in text boxes•

Restart numbering on every pageThe following element may be included in the <text:linenumbering-separator> element:•

Separator

Line Numbering Enable
The text:number-lines attribute controls whether or not lines are numbered.
12475
12476
12477
12478
12479
12480
12481

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:number-lines" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Number Format
See section 12.2 for detailed information on number format attributes. The attributes described in
section 12.2 can also be associated with the <text:linenumbering-configuration>
element.
12482
12483
12484
12485
12486

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><ref name="common-num-format-attlist"/></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 527 of 738

Text Style
The text:style-name attribute specifies the text style for all line numbers. The value of this
attribute is the name of the text style that is applied to all line numbers.
12487
12488
12489
12490
12491
12492
12493

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Increment
The text:increment attribute causes line numbers that are a multiple of the given increment tobe numbered. For example, if the increment is 5, only lines number 5, 10, 15, and so on are
numbered.
12494
12495
12496
12497
12498
12499
12500

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:increment"><ref name="nonNegativeInteger"/></attribute></optional></define>

Position
The text:position attribute determines whether the line numbers are printed on the left, right,
inner, or outer margins.
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:number-position" a:defaultValue="left"><choice><value>left</value><value>right</value><value>inner</value><value>outer</value></choice></attribute></optional></define>

Offset
The text:offset attribute determines the distance between the line number and the margin.
12513
12514
12515
12516
12517
12518
12519

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:offset"><ref name="nonNegativeLength"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 528 of 738

Count Empty Lines
The text:count-empty-lines attribute determines whether or not empty lines are included in
the line count. If the value of this attribute is true, empty lines are included in the line count.
12520
12521
12522
12523
12524
12525
12526

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:count-empty-lines" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

Count Lines in Text Boxes
The text:count-in-text-boxes attribute determines whether or not text in text boxes is
included in the line count. If the value of this attribute is true, text within text boxes is included in
the line count.
12527
12528
12529
12530
12531
12532
12533

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:count-in-text-boxes" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Restart Numbering on Every Page
The text:restart-on-page attribute determines whether or not the line count is reset to 1 at
the start of every page.
If the value of this attribute is true, the line count is reset to 1 at the beginning of every page,
resulting in page -specific numbering of lines. The default value of this attribute is false,
resulting in document-specific numbering of lines.
12534
12535
12536
12537
12538
12539
12540

<define name="text-linenumbering-configuration-attlist" combine="interleave"><optional><attribute name="text:restart-on-page" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Separator
The <text:linenumbering-separator> element contains the text that is displayed as aseparator. A separator is text that is displayed instead of a line number for lines where no number
is displayed.
This element is contained in the line numbering configuration element. If the element is notpresent, no separator is displayed.
The element's text:increment attribute causes the separator to appear on lines that are a
multiple of the given increment. For example, if the increment is 2, only lines 2, 4, 6, and so on get
a separator, provided that no number is displayed already.
12541
12542

<define name="text-linenumbering-separator"><element name="text:linenumbering-separator">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 529 of 738

12543
12544
12545
12546
12547
12548
12549
12550

<optional><attribute name="text:increment"><ref name="nonNegativeInteger"/></attribute></optional><text/></element></define>

14.9.2 Notes Configuration Element
A document in OpenDocument format contains at most one notes configuration element for every
notes class used in the document. If there is no note configuration element, a default note
configuration is used.
12551
12552
12553
12554
12555

<define name="text-notes-configuration"><element name="text:notes-configuration"><ref name="text-notes-configuration-content"/></element></define>

The attributes that may be associated with the <text:notes-configuration> element are:•Note class•

Citation text style•

Citation body text style•Default footnote paragraph style•

Master page•

Start value•

Number format•

Numbering scheme•

Footnote position

The following element may be included in the <text:footnotes-configuration> element:•

Footnote continuation notice (forward and backward)

Note class
The note class attribute determines which note elements this notes configuration applies to.
12556
12557
12558

<define name="text-notes-configuration-content" combine="interleave"><ref name="text-note-class"/></define>

Citation Text Style
The text:citation-style attribute specifies the text style to use for the footnote citation
within the footnote.
12559
12560
12561

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:citation-style-name">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 530 of 738

12562
12563
12564
12565

<ref name="styleNameRef"/></attribute></optional></define>

Citation Body Text Style
The text:citation-body-style-name attribute specifies the text style to use for thefootnote citation in the text flow.
12566
12567
12568
12569
12570
12571
12572

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:citation-body-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Default Note Paragraph Style
The default footnote paragraph style is only used for footnotes that are inserted into an existing
document. It is not used for footnotes that already exist.
12573
12574
12575
12576
12577
12578
12579

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:default-style-name"><ref name="styleNameRef"/></attribute></optional></define>

Master Page
To display the footnotes at the end of the document, the pages that contain the footnotes must be
instances of the master page specified by the text:master-page-name attribute.
12580
12581
12582
12583
12584
12585
12586

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:master-page-name"><ref name="styleNameRef"/></attribute></optional></define>

Start Value
The start:value attribute specifies the value at which the footnote numbering starts.
12587
12588
12589
12590
12591
12592
12593

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:start-value"><ref name="nonNegativeInteger"/></attribute></optional></define>

Number Format
See section 12.2 for information on the number format for footnotes.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 531 of 738

12594
12595
12596
12597
12598
12599

<define name="text-notes-configuration-content" combine="interleave"><ref name="common-num-format-prefix-suffix-attlist"/><optional><ref name="common-num-format-attlist"/></optional></define>

Numbering Scheme
The text:start-numbering-at attribute specifies if footnote numbers start with a newnumber at the beginning of the document or at the beginning of each chapter or page.
Note: [XSLT] does not have the capability to start with new footnote numbers on
every page.
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:start-numbering-at"><choice><value>document</value><value>chapter</value><value>page</value></choice></attribute></optional></define>

Footnotes Position
The text:footnotes-position attribute specifies one of the following positions for footnotes:•

text: At the page where the footnote citation is located, immediately below the page's
text.

•

page: The bottom of the page where the footnote citation is located.

•section: The end of the section•

document: The end of the document.

Note: [XSL] does not have the capability to display footnotes at the end of the document.
However, an [XSLT] stylesheet may generate some other flow objects to display such footnotes.
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622

<define name="text-notes-configuration-content" combine="interleave"><optional><attribute name="text:footnotes-position"><choice><value>text</value><value>page</value><value>section</value><value>document</value></choice></attribute></optional></define>

Footnote Continuation
The footnote continuation elements specify:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 532 of 738

12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636

•

Text displayed at the end of a footnote that is continued on the next page•

Text displayed before the continued text

<define name="text-notes-configuration-content" combine="interleave"><optional><element name="text:note-continuation-notice-forward"><text/></element></optional></define><define name="text-notes-configuration-content" combine="interleave"><optional><element name="text:note-continuation-notice-backward"><text/></element></optional></define>

Example: Footnote configuration<text:notes-configuration
text:notes-type="footnote"
text:citation-style="Footnote symbol"
text:default-style="Footnote"><text:note-continuation-notice-forward>" .."</text:note-continuation-notice-forward><text:note-continuation-notice-forward>".. "</text:note-continuation-notice-forward></text:notes-configuration>

14.9.3 Bibliography Configuration
The bibliography configuration element <text:bibliography-configuration> is containedin the document's style section. It contains information how bibliography entries are displayed inline, and how they are displayed in the bibliography index.
12637
12638
12639
12640
12641
12642
12643
12644

<define name="text-bibliography-configuration"><element name="text:bibliography-configuration"><ref name="text-bibliography-configuration-attlist"/><zeroOrMore><ref name="text-sort-key"/></zeroOrMore></element></define>

Prefix and Suffix
The text:prefix and text:suffix attributes contain a string that is displayed before andafter an bibliography entry's short name or number if it occurs in the document body.
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655

<define name="text-bibliography-configuration-attlist" combine="interleave"><optional><attribute name="text:prefix"><ref name="string"/></attribute></optional><optional><attribute name="text:suffix"><ref name="string"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 533 of 738

12656</define>

Numbered Entries
The text:numbered-entry attribute specifies whether a number is displayed for bibliography
entries instead of their short name.
Example: With prefix and suffix "[" and "]" a bibliography entry with short name "Abc123" would
be displayed as "[Abc123]" in the document body if text:numbered-entry has the value
false, and for instance as “[5]”, if it has the value true.
12657
12658
12659
12660
12661
12662
12663

<define name="text-bibliography-configuration-attlist" combine="interleave"><optional><attribute name="text:numbered-entries" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

Sorting
The text:sort-by-position attribute specifies whether bibliography entries are displayed in
the order of their positions in the document, or by an arbitrary selection of entry fields, e.g., authorname or publication date. In the later case, the collating order for entries is determined by the
triplet language/country/sort-algorithm as specified in the attributes fo:language, fo:country
and text:sort-algorithm. See also section 7.8.
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685

<define name="text-bibliography-configuration-attlist" combine="interleave"><optional><attribute name="text:sort-by-position" a:defaultValue="true"><ref name="boolean"/></attribute></optional><optional><attribute name="fo:language"><ref name="languageCode"/></attribute></optional><optional><attribute name="fo:country"><ref name="countryCode"/></attribute></optional><optional><attribute name="text:sort-algorithm"><ref name="string"/></attribute></optional></define>

Sort Keys
The <text:sort-key> element specifies a single sort key if bibliography entries are notdisplayed in document order. It has an attribute text:key, that contains the type of index entry
data that should be used for sorting (see also section 7.1.4) and an attribute text:sortascending that specifies whether sorting takes pace in ascending or descending order.
12686
12687

<define name="text-sort-key"><element name="text:sort-key">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 534 of 738

12688
12689
12690
12691

<ref name="text-sort-key-attlist"/><empty/></element></define>

12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735

<define name="text-sort-key-attlist" combine="interleave"><attribute name="text:key"><choice><value>address</value><value>annote</value><value>author</value><value>bibliography-type</value><value>booktitle</value><value>chapter</value><value>custom1</value><value>custom2</value><value>custom3</value><value>custom4</value><value>custom5</value><value>edition</value><value>editor</value><value>howpublished</value><value>identifier</value><value>institution</value><value>isbn</value><value>issn</value><value>journal</value><value>month</value><value>note</value><value>number</value><value>organizations</value><value>pages</value><value>publisher</value><value>report-type</value><value>school</value><value>series</value><value>title</value><value>url</value><value>volume</value><value>year</value></choice></attribute><optional><attribute name="text:sort-ascending" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

14.10 List Style
List styles specify the formatting properties for lists. A <text:list-style> element contains a
set of style elements for each list level, which are called list level styles. There are three different
list level style elements, depending on whether this particular list level is to have a list label
containing the list numbering, a bullet, or an image.
If a list style is applied to a list but does not contain a list level specification for the suitable level,
the list level style of the next lower level is used. If no suitable list level exists, a default style is
used.
12736

<define name="text-list-style">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 535 of 738

12737
12738
12739
12740
12741
12742
12743

<element name="text:list-style"><ref name="text-list-style-attr"/><zeroOrMore><ref name="text-list-style-content"/></zeroOrMore></element></define>

Note: List styles contain different properties than paragraph or text styles. This is
why they are represented by a different element.
The attributes that may be associated with the <text:list-style> element are:
•

Name

•

Display name•

Consecutive numberingName
The style:name attribute specifies the name of the list style.
12744
12745
12746
12747
12748

<define name="text-list-style-attr" combine="interleave"><attribute name="style:name"><ref name="styleName"/></attribute></define>

Display Name
The style:display-name attribute specifies the name of the list style as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
12749
12750
12751
12752
12753
12754
12755

<define name="text-list-style-attr" combine="interleave"><optional><attribute name="style:display-name"><ref name="string"/></attribute></optional></define>

Consecutive Numbering
The text:consecutive-numbering attribute specifies whether or not the list style uses
consecutive numbering for all list levels or whether each list level restarts the numbering.
12756
12757
12758
12759
12760
12761
12762

<define name="text-list-style-attr" combine="interleave"><optional><attribute name="text:consecutive-numbering" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

14.10.1 Common List-Level Style Attributes
The following attributes can be used on all list-level styles:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 536 of 738

LevelThe text:level attribute specifies the level of the number list style.
12763
12764
12765
12766
12767

<define name="text-list-level-style-attr"><attribute name="text:level"><ref name="positiveInteger"/></attribute></define>

14.10.2 Number Level Style
A number level style specifies a list style where the list items are preceded by numbers.
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779

<define name="text-list-style-content" combine="choice"><element name="text:list-level-style-number"><ref name="text-list-level-style-attr"/><ref name="text-list-level-style-number-attr"/><optional><ref name="style-list-level-properties"/></optional><optional><ref name="style-text-properties"/></optional></element></define>

The attributes that may be associated with the <text:list-level-style-number> element
are:•Level (see section 14.10.1)•

Text style•

Number format•

Display levels•

Start value

Additional formatting properties may be contained in the <style:list-level-properties>
and <style:text-properties> elements. See sections 15.12 and 15.4 for details.

Text Style
The text:style-name attribute specifies the name of the character style to use to format the
number of the list.
12780
12781
12782
12783
12784
12785
12786

<define name="text-list-level-style-number-attr" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 537 of 738

Number Format
See section 12.2 for detailed information on number format attributes. The attributes described in
section 12.2 can also be associated with the <text:list-level-style-number> element.
The style:num-format attribute can be empty. In this case, no number is displayed.
12787
12788
12789
12790

<define name="text-list-level-style-number-attr" combine="interleave"><ref name="common-num-format-attlist"/><ref name="common-num-format-prefix-suffix-attlist"/></define>

Display Levels
The text:display-levels attribute specifies the number of levels whose numbers are
displayed at the current level.
12791
12792
12793
12794
12795
12796
12797

<define name="text-list-level-style-number-attr" combine="interleave"><optional><attribute name="text:display-levels" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Example: Given a third-level chapter number 1.2.3. Values of text:display-number from 1 to threewould achieve the following results:
text:display-number display
1

1

2

1.2

3

1.2.3

Start Value
The text:start-value attribute specifies the first number of a list item of the current level.
12798
12799
12800
12801
12802
12803
12804

<define name="text-list-level-style-number-attr" combine="interleave"><optional><attribute name="text:start-value" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

14.10.3 Bullet Level Style
A bullet level style element specifies a list style where the list items are preceded by bullets.
12805
12806
12807
12808
12809
12810
12811
12812
12813

<define name="text-list-style-content" combine="choice"><element name="text:list-level-style-bullet"><ref name="text-list-level-style-attr"/><ref name="text-list-level-style-bullet-attr"/><optional><ref name="style-list-level-properties"/></optional><optional><ref name="style-text-properties"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 538 of 738

1281412815
12816</optional></element></define>

The attributes that may be associated with the <text:list-level-style-bullet> element
are:•Level (see section 14.10.1)•

Text style•

Bullet character•

Prefix and suffix•

Bullet relative size

Additional formatting properties may be contained in the <style:list-level-properties>
and <style:text-properties> elements. See sections 15.12 and 15.4 for details.

Text Style
The text:style-name attribute specifies the name of the character style to use to format thelist bullet.
12817
12818
12819
12820
12821
12822
12823

<define name="text-list-level-style-bullet-attr" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute></optional></define>

Bullet Character
The bullet character attribute specifies the [UNICODE] character to use as the bullet in a bullet
level style.
Typical bullet characters are:
UNICODE TypicalCharacter ShapeCode

UNICODE Character
Name

Reference

U+2022•

BULLET

http://www.unicode.org/charts/PDF/U2000.pdf

U+25CF●

BLACK CIRCLE

http://www.unicode.org/charts/PDF/U25A0.pdf

U+2714✔

HEAVY CHECK MARK

http://www.unicode.org/charts/PDF/U2700.pdf

U+2717✗BALLOT X

U+2794➔HEAV WIDE-HEADEDRIGHTWARDS ARROW

U+27A2➢

THREE-D TOP-LIGHTED
RIGHTWARDSARROWHEAD

These characters might not be available within some fonts.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 539 of 738

12824
12825
12826
12827
12828

<define name="text-list-level-style-bullet-attr" combine="interleave"><attribute name="text:bullet-char"><ref name="character"/></attribute></define>

Prefix and Suffix
The attributes style:num-prefix and style:num-suffix specified in section 12.2 can beused to add characters before or behind the bullet character.
12829
12830
12831

<define name="text-list-level-style-bullet-attr" combine="interleave"><ref name="common-num-format-prefix-suffix-attlist"/></define>

Bullet Relative Size
The text:bullet-relative-size attribute specifies a percentage value for the bullet size
relative to the font size of the paragraphs in the bullet list. For example, if the value of the
text:bullet-relative-size attribute is 75, the bullet used in the list is 75% of the font sizefor the paragraph.
12832
12833
12834
12835
12836
12837
12838

<define name="text-list-level-style-bullet-attr" combine="interleave"><optional><attribute name="text:bullet-relative-size"><ref name="percent"/></attribute></optional></define>

14.10.4 Image Level Style
An image level style element specifies a list style where the list items are preceded by images.
This element can be an [XLink] and can only be contained in list style elements.
12839
12840
12841
12842
12843
12844
12845
12846
12847

<define name="text-list-style-content" combine="choice"><element name="text:list-level-style-image"><ref name="text-list-level-style-attr"/><ref name="text-list-level-style-image-attr"/><optional><ref name="style-list-level-properties"/></optional></element></define>

The following elements and attributes may be associated with the <text:list-level-styleimage> element are:•Level (see section 14.10.1)•

Image location

Additional formatting properties may be contained in the <style:list-level-properties>
element. See section 15.12 for details.

Image Location
The image data can be stored in one of the following ways (see also section 9.3.2):

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 540 of 738

12848
12849
12850
12851
12852
12853

•

The image data is located in an external file. Use the xlink:href attribute described below
to specify the location of the file.

•

The image data is contained in the <text:list-level-style-image> element. The<text:list-level-style-image> element must contain an <office:binary-data>
element that contains the image data in BASE64 encoding. In this situation, the xlink:href
attribute is not required.

<define name="text-list-level-style-image-attr" combine="interleave"><choice><ref name="common-draw-data-attlist"/><ref name="office-binary-data"/></choice></define>

14.10.5 List Level Style Example
Example: List level style<text:list-style style:name="List 1"><text:list-level-style-number text:level="1"
fo:num-format="1"/><text:list-level-style-bullet text:level="2"
text:bullet-char="-"text:style-name="Bullet Char"/><text:list-level-style-image text:level="3" xlink:href="bullet.gif"><style:list-level-properties fo:width=".27cm" fo:height=".27cm"
style:vertical-pos="middle" style:vertical-rel="line"/></text:list-level-style-image></text:list-style>

The following is the output from the above example:
1. This is the first list item.
This is a continuation of the first list item.
2. This is the second list item. It contains an unordered sub list.
-

This is a sub list item.

-

This is a sub list item.

-

This is a sub list item.
This is a sub sub list item.
This is a sub sub list item.

3. This is the third list item.

14.11 Outline Style
The outline style is a list style that is applied to all headings within a text document where theheading's paragraph style does not define a list style to use itself.
The way in which the OpenDocument format represents outline numbering styles is very similar to
the way it represents list styles. The <text:outline-style> element contains elements thatspecify the style of each outline level. It can be contained within the <office:styles> element
only.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 541 of 738

12854
12855
12856
12857
12858
12859
12860

<define name="text-outline-style"><element name="text:outline-style"><oneOrMore><ref name="text-outline-level-style"/></oneOrMore></element></define>

14.11.1 Outline Level Style
The <text:outline-level-style> element specifies the style for each outline level. Thiselement is contained in <text:outline-style> elements only.
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871

<define name="text-outline-level-style"><element name="text:outline-level-style"><ref name="text-outline-level-style-attlist"/><optional><ref name="style-list-level-properties"/></optional><optional><ref name="style-text-properties"/></optional></element></define>

The attributes that may be associated with the <text:outline-level-style> element are:
•

Level

•

Text style•

Number format•

Display levels•

Start value

Additional formatting properties may be contained in the <style:list-level-properties>
and <style:text-properties> element. See sections 15.12 and 15.4 for details.

Level
The text:level attribute specifies the level of the outline style.
12872
12873
12874
12875
12876

<define name="text-outline-level-style-attlist" combine="interleave"><attribute name="text:level"><ref name="positiveInteger"/></attribute></define>

Text Style
The text:style-name attribute specifies the name of the character style to use to format the
number of the heading.
12877
12878
12879
12880
12881

<define name="text-outline-level-style-attlist" combine="interleave"><optional><attribute name="text:style-name"><ref name="styleNameRef"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 542 of 738

12882
12883</optional></define>

Number Format
See section 14.10.2 for information on the number format attributes.
12884
12885
12886
12887

<define name="text-outline-level-style-attlist" combine="interleave"><ref name="common-num-format-attlist"/><ref name="common-num-format-prefix-suffix-attlist"/></define>

Display Levels
The text:display-levels attribute specifies the number of levels whose numbers are
displayed at the current level. See also section 14.10.2.
12888
12889
12890
12891
12892
12893
12894

<define name="text-outline-level-style-attlist" combine="interleave"><optional><attribute name="text:display-levels" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

Start Value
The text:start-value attribute specifies the first number of a heading of the current level.
12895
12896
12897
12898
12899
12900
12901

<define name="text-outline-level-style-attlist" combine="interleave"><optional><attribute name="text:start-value" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

14.12 Table Styles
14.12.1 Table Styles
Table styles are <style:style> elements that have the family table. They can be used within
all kind of applications to specify formatting properties for tables. They support the table properties
as described in section 15.8.
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>table</value></attribute><optional><ref name="style-table-properties"/></optional></group></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 543 of 738

14.12.2 Table Column Styles
Table column styles are <style:style> elements that have the family table-column. They
can be used within all kind of applications to specify formatting properties for table columns. They
support the table column properties as described in section 15.9.
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>table-column</value></attribute><optional><ref name="style-table-column-properties"/></optional></group></define>

14.12.3 Table Row Styles
Table row styles are <style:style> elements that have the family table-row. They can beused within all kind of applications to specify formatting properties for table rows. They support thetable properties as described in section 15.10.
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>table-row</value></attribute><optional><ref name="style-table-row-properties"/></optional></group></define>

14.12.4 Table Cell Styles
Table cell styles are <style:style> elements that have the family table-cell. They can beused within all kind of applications to specify formatting properties for table cells. They support thetable properties as described in section 15.11 as well as the paragraph and text properties as
described in sections 15.5 and 15.4.
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>table-cell</value></attribute><optional><ref name="style-table-cell-properties"/></optional><optional><ref name="style-paragraph-properties"/></optional><optional><ref name="style-text-properties"/></optional></group></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 544 of 738

14.13 Graphic Styles
14.13.1 Graphic and Presentation Styles
Graphic and presentation styles are <style:style> elements that have either the familygraphic or presentation. Graphic styles with family graphic may occur within all kinds ofapplications, graphic styles with family presentation may occur only within presentation
documents. Both kind of styles support the graphic properties described in section 15.17. They
may also contain paragraph and text properties as described in sections 15.5 and 15.4.
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><choice><value>graphic</value><value>presentation</value></choice></attribute><optional><ref name="style-graphic-properties"/></optional><optional><ref name="style-paragraph-properties"/></optional><optional><ref name="style-text-properties"/></optional></group></define>

12967
12968
12969
12970
12971
12972

<define name="style-graphic-properties"><element name="style:graphic-properties"><ref name="style-graphic-properties-content"/></element></define>

12973
12974
12975
12976

<define name="style-graphic-properties-content"><ref name="style-properties-content"/></define>

12977
12978
12979
12980
12981
12982

<define name="style-graphic-properties-content-strict"><ref name="style-graphic-properties-attlist"/><ref name="style-graphic-fill-properties-attlist"/><ref name="style-graphic-properties-elements"/></define>

12983
12984
12985
12986

<define name=" style-graphic-properties-elements"><empty/></define>

14.13.2 Drawing Page Style
A drawing page style is a <style:style> element with family drawing-page. Within graphicalapplications, drawing page styles can be used to change the background of draw page. If a
background is set with the help of a drawing page style, then it overrides the background of themaster page that is assigned to the draw page, but not the shapes that are on the master page.
Within presentation applications, the draw page style additionally may contain presentation
properties, for example, the duration for which a page is displayed or fade effects.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 545 of 738

The properties that can be used in a draw page style to change the background are the ones
described in section 15.14.
The presentation properties that can be used in a draw page style are described in section 15.36.
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>drawing-page</value></attribute><optional><ref name="style-drawing-page-properties"/></optional></group></define>

12997
12998
12999
13000
13001
13002

<define name="style-drawing-page-properties"><element name="style:drawing-page-properties"><ref name="style-drawing-page-properties-content"/></element></define>

13003
13004
13005
13006

<define name="style-drawing-page-properties-content"><ref name="style-properties-content"/></define>

13007
13008
13009
13010
13011
13012

<define name="style-drawing-page-properties-content-strict"><ref name="style-graphic-fill-properties-attlist"/><ref name="style-drawing-page-properties-attlist"/><ref name="style-drawing-page-properties-elements"/></define>

14.14 Enhanced Graphic Style Elements
The elements described in this section are enhanced graphic style. They cannot be used as
automatic styles, that is, they have to be located in the <office:styles> section of adocument. Like all other style elements, they are referenced to by a unique name. The following
styles for filling graphic objects are available:•

Gradient•

SVG Gradient

•

Hatch

•

Image

•

Opacity Gradient•Marker•Dash•Presentation Page Layout

14.14.1 Gradient
The element <draw:gradient> defines a gradient for filling a drawing object. Gradients are notavailable as automatic styles.
13013<define name="draw-gradient">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 546 of 738

13014
13015
13016
13017
13018
13019

<element name="draw:gradient"><ref name="common-draw-gradient-attlist"/><ref name="draw-gradient-attlist"/><empty/></element></define>

The attributes that may be associated with the gradient element are:
•

Name

•

Display name•Gradient style•

Gradient center•

Colors•Intensity

•

Angle

•

BorderName
The attribute draw:name uniquely identifies a gradient inside an <office:styles> element.
13020
13021
13022
13023
13024
13025
13026

<define name="common-draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:name"><ref name="styleName"/></attribute></optional></define>

Display Name
The draw:display-name attribute specifies the name of the gradient as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
13027
13028
13029
13030
13031
13032
13033

<define name="common-draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional></define>

Gradient Style
The attribute draw:style specifies the style of the gradient. The gradient styles that an officeapplication should support are linear, axial, radial, ellipsoid, square, andrectangular.
13034
13035
13036
13037

<define name="common-draw-gradient-attlist" combine="interleave"><attribute name="draw:style"><ref name="gradient-style"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 547 of 738

13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048

</define><define name="gradient-style"><choice><value>linear</value><value>axial</value><value>radial</value><value>ellipsoid</value><value>square</value><value>rectangular</value></choice></define>

Gradient Center
If the gradient style is radial, ellipsoid, square, or rectangular, the gradient center
attributes draw:cx and draw:cy specifies the center of the geometry that is used for thegradient. The values of these attributes are always percentage values.
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060

<define name="common-draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:cx"><ref name="percent"/></attribute></optional><optional><attribute name="draw:cy"><ref name="percent"/></attribute></optional></define>

ColorsThe gradient interpolates between a start color and an end color, which are specified using theattributes draw:start-color and draw:end-color.
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072

<define name="draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:start-color"><ref name="color"/></attribute></optional><optional><attribute name="draw:end-color"><ref name="color"/></attribute></optional></define>

Intensity
The attributes draw:start-intensity and draw:end-intensity specify the intensity of thegradient's start and end color as percentage values. These attributes are optional. If the attributes
are not specified, the colors are used as they are, that is at 100% intensity.
13073
13074
13075
13076
13077

<define name="draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:start-intensity"><ref name="percent"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 548 of 738

13078
13079
13080
13081
13082
13083
13084

</optional><optional><attribute name="draw:end-intensity"><ref name="percent"/></attribute></optional></define>

Angle
The draw:angle attribute specifies an angle that rotates the axis at which the gradient values
are interpolated. This attribute is ignored for radial style gradients.
13085
13086
13087
13088
13089
13090
13091

<define name="common-draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:angle"><ref name="integer"/></attribute></optional></define>

BorderDepending on the style of the gradient, the draw:border attribute specifies a percentage value
which is used to scale a border which is filled by the start or end color only.
For example, a border of 10% means that the first 10% of the gradient is colored completely in thestart color and the remaining 90% are an interpolation between start and end color.
13092
13093
13094
13095
13096
13097
13098

<define name="common-draw-gradient-attlist" combine="interleave"><optional><attribute name="draw:border"><ref name="percent"/></attribute></optional></define>

14.14.2 SVG Gradients
In addition to the gradients specified in section 14.14.1, gradient may be defined by the SVG
gradient elements <linearGradient> and <radialGradient> as specified in §13.2 of[SVG]. The following rules apply to SVG gradients if they are used in documents in
OpenDocument format:•

The gradients must get a name. It is specified by the draw:name attribute.

•

For <linearGradient>, only the attributes gradientTransform, x1, y1, x2, y2 andspreadMethod will be evaluated.

•

For <radialGradient>, only the attributes gradientTransform, cx, cy, r, fx, fy andspreadMethod will be evaluated.

•

The gradient will be calculated like having a gradientUnits of objectBoundingBox,
regardless what the actual value of the attribute is.

•

The only child element that is evaluated is <stop>.

•

For <stop>, only the attributes offset, stop-color and stop-opacity will be
evaluated.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 549 of 738

13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138

<define name="svg-linearGradient"><element name="svg:linearGradient"><ref name="common-svg-gradient-attlist"/><optional><attribute name="svg:x1" a:defaultValue="0%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:y1" a:defaultValue="0%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:x2" a:defaultValue="100%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:y2" a:defaultValue="100%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><zeroOrMore><ref name="svg-stop"/></zeroOrMore></element></define>

13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160

<define name="svg-radialGradient"><element name="svg:radialGradient"><ref name="common-svg-gradient-attlist"/><optional><attribute name="svg:cx" a:defaultValue="50%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:cy" a:defaultValue="50%"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:r" a:defaultValue="50%">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 550 of 738

13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187

<choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:fx"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="svg:fy"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute></optional><zeroOrMore><ref name="svg-stop"/></zeroOrMore></element></define>

13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208

<define name="svg-stop"><element name="svg:stop"><attribute name="svg:offset"><choice><ref name="double"/><ref name="percent"/></choice></attribute><optional><attribute name="svg:stop-color"><ref name="color"/></attribute></optional><optional><attribute name="svg:stop-opacity"><ref name="double"/></attribute></optional></element></define>

13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222

<define name="common-svg-gradient-attlist" combine="interleave"><optional><attribute name="svg:gradientUnits" a:defaultValue="objectBoundingBox"><value>objectBoundingBox</value></attribute></optional><optional><attribute name="svg:gradientTransform"><ref name="string"/></attribute></optional><optional><attribute name="svg:spreadMethod" a:defaultValue="pad">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 551 of 738

13223
13224
13225
13226
13227
13228
13229
13230

<choice><value>pad</value><value>reflect</value><value>repeat</value></choice></attribute></optional></define>

Name
The attribute draw:name uniquely identifies a gradient inside an <office:styles> element.
Like <draw:gradient> elements, SVG gradients are referenced by this name using thedraw:fill-gradient-name attribute within a graphic style. SVG gradients cannot be referenced by adraw:opacity-name attribute. The result of referencing a SVG gradient with draw:fillgradient-name attribute and an opacity gradient with a draw:opacity-name attribute at the sametime is unspecified.
13231
13232
13233
13234
13235

<define name="common-svg-gradient-attlist" combine="interleave"><attribute name="draw:name"><ref name="styleName"/></attribute></define>

Display Name
The draw:display-name attribute specifies the name of the gradient as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
13236
13237
13238
13239
13240
13241
13242

<define name="common-svg-gradient-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional></define>

14.14.3 Hatch
The <draw:hatch> element defines a hatch for filling graphic objects. A hatch is a simple
pattern of straight lines that is repeated in the fill area. Hatches are not available as automaticstyles.
13243
13244
13245
13246
13247
13248

<define name="draw-hatch"><element name="draw:hatch"><ref name="draw-hatch-attlist"/><empty/></element></define>

The attributes that may be associated with the hatch element are:
•

Name

•

Display name

•

Style

•

Color

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 552 of 738

•Distance

•

Angle

•

BackgroundName
The draw:name attribute uniquely identifies a hatch inside an <office:styles> element.
13249
13250
13251
13252
13253

<define name="draw-hatch-attlist" combine="interleave"><attribute name="draw:name"><ref name="styleName"/></attribute></define>

Display Name
The draw:display-name attribute specifies the name of the hatch style as it should appear in
the user interface. In contrast to the style name itself, this name may contain arbitrary characters.
If this attribute is not present, the display name equals the style name.
13254
13255
13256
13257
13258
13259
13260

<define name="draw-hatch-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional></define>

Style
The draw:style attribute specifies the style of the hatch.
The hatch can have one of three styles: single, double, or triple.
13261
13262
13263
13264
13265
13266
13267
13268
13269

<define name="draw-hatch-attlist" combine="interleave"><attribute name="draw:style"><choice><value>single</value><value>double</value><value>triple</value></choice></attribute></define>Color
The draw:color attribute specifies the color of the hatch lines.
13270
13271
13272
13273
13274
13275
13276

<define name="draw-hatch-attlist" combine="interleave"><optional><attribute name="draw:color"><ref name="color"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 553 of 738

Distance
The draw:distance attribute specifies the distance between two hatch lines.
13277
13278
13279
13280
13281
13282
13283

<define name="draw-hatch-attlist" combine="interleave"><optional><attribute name="draw:distance"><ref name="length"/></attribute></optional></define>

Angle
The draw:rotation attribute specified the rotation angle of the hatch lines.
13284
13285
13286
13287
13288
13289
13290

<define name="draw-hatch-attlist" combine="interleave"><optional><attribute name="draw:rotation"><ref name="integer"/></attribute></optional></define>

14.14.4 Fill Image
The <draw:fill-image> element specifies a link to a bitmap resource, for example, a .PNG
file. This element follows the XLink specification. Fill image are not available as automatic styles.
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320

<define name="draw-fill-image"><element name="draw:fill-image"><ref name="draw-fill-image-attlist"/><attribute name="xlink:href"><ref name="anyURI"/></attribute><optional><attribute name="xlink:type" a:defaultValue="simple"><choice><value>simple</value></choice></attribute></optional><optional><attribute name="xlink:show" a:defaultValue="embed"><choice><value>embed</value></choice></attribute></optional><optional><attribute name="xlink:actuate" a:defaultValue="onLoad"><choice><value>onLoad</value></choice></attribute></optional><empty/></element></define>

The attributes that may be associated with the fill image element are:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 554 of 738

•

Name

•

Display name

•

Size

Name
The draw:name attribute uniquely identifies a fill image inside an <office:styles> element.
13321
13322
13323
13324
13325

<define name="draw-fill-image-attlist" combine="interleave"><attribute name="draw:name"><ref name="styleName"/></attribute></define>

Display Name
The draw:display-name attribute specifies the name of the fill image as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
13326
13327
13328
13329
13330
13331
13332

<define name="draw-fill-image-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional></define>

Size
The optional attributes svg:width and svg:height specify the size of the linked image. These
values are optional and are overridden by the physical size of the linked image resource. They
can be used to get the size of an image before it is loaded.
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344

<define name="draw-fill-image-attlist" combine="interleave"><optional><attribute name="svg:width"><ref name="length"/></attribute></optional><optional><attribute name="svg:height"><ref name="length"/></attribute></optional></define>

14.14.5 Opacity Gradient
The <draw:opacity> element specifies an opacity gradient for a graphic object. An opacity
gradient works like a gradient, except that the opacity is interpolated instead of the color. Opacity
gradients are not available as automatic styles.
13345
13346
13347
13348

<define name="draw-opacity"><element name="draw:opacity"><ref name="common-draw-gradient-attlist"/><ref name="draw-opacity-attlist"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 555 of 738

1334913350
13351<empty/></element></define>

The attributes that may be associated with the <draw:opacity> element are:•Name, Display name, Style, Opacity center, Angle, Border – see section 14.14.1.

•

Opacity

Opacity
The opacity interpolates between a start and an end value.
The values of the attributes draw:start and draw:end are percentages where 0% is fullytransparent and 100% is fully opaque.
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363

<define name="draw-opacity-attlist" combine="interleave"><optional><attribute name="draw:start"><ref name="percent"/></attribute></optional><optional><attribute name="draw:end"><ref name="percent"/></attribute></optional></define>

14.14.6 Marker
The element <draw:marker> represents a marker, which is used to draw polygons at the startand end points of strokes. Markers are not available as automatic styles.
13364
13365
13366
13367
13368
13369
13370
13371

<define name="draw-marker"><element name="draw:marker"><ref name="draw-marker-attlist"/><ref name="common-draw-viewbox-attlist"/><ref name="common-draw-path-data-attlist"/><empty/></element></define>

See sections 9.2.4 and 9.2.15 for information on the path data and viewbox attributes that may be
associated with the <draw:marker> element.

Name
The draw:name attribute uniquely identifies a fill image inside an <office:styles> element.
13372
13373
13374
13375
13376

<define name="draw-marker-attlist" combine="interleave"><attribute name="draw:name"><ref name="styleName"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 556 of 738

Display Name
The draw:display-name attribute specifies the name of the marker as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
13377
13378
13379
13380
13381
13382
13383

<define name="draw-marker-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional></define>

14.14.7 Stroke Dash
The dash element <draw:stroke-dash> represents a dash style that can be used to render
strokes of shapes. Stroke dashes are not available as automatic styles.
13384
13385
13386
13387
13388
13389

<define name="draw-stroke-dash"><element name="draw:stroke-dash"><ref name="draw-stroke-dash-attlist"/><empty/></element></define>

The attributes that may be associated with the <draw:stroke-dash> element are:
•

Name

•

Display name

•

Style

•

Dots

•

Distance

Name
The attribute draw:name uniquely identifies a dash inside an <office:styles> element.
13390
13391
13392
13393
13394

<define name="draw-stroke-dash-attlist" combine="interleave"><attribute name="draw:name"><ref name="styleName"/></attribute></define>

Display Name
The draw:display-name attribute specifies the name of the dash as it should appear in theuser interface. In contrast to the style name itself, this name may contain arbitrary characters. If
this attribute is not present, the display name equals the style name.
13395
13396
13397
13398
13399
13400

<define name="draw-stroke-dash-attlist" combine="interleave"><optional><attribute name="draw:display-name"><ref name="string"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 557 of 738

13401</define>

Style
The attribute draw:style specifies whether the points of a dash are round or rectangular.
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411

<define name="draw-stroke-dash-attlist" combine="interleave"><optional><attribute name="draw:style"><choice><value>rect</value><value>round</value></choice></attribute></optional></define>

Dots
The attribute pairs draw:dots1, draw:dots1-length and draw:dots2, draw:dots2length each define a repeating sequence of dots that are used to render a dash. Bothsequences are used alternating. The draw:dots1 and draw:dots2 attributes specify the
number of dots to draw for both sequences, and the draw:dots1-length and draw:dots2length attributes specify the length of each dot.
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433

<define name="draw-stroke-dash-attlist" combine="interleave"><optional><attribute name="draw:dots1"><ref name="integer"/></attribute></optional><optional><attribute name="draw:dots1-length"><ref name="length"/></attribute></optional><optional><attribute name="draw:dots2"><ref name="integer"/></attribute></optional><optional><attribute name="draw:dots2-length"><ref name="length"/></attribute></optional></define>

Distance
The draw:distance attribute specifies the distance between the dots of a dash.
13434
13435
13436
13437
13438
13439
13440

<define name="draw-stroke-dash-attlist" combine="interleave"><optional><attribute name="draw:distance"><ref name="length"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 558 of 738

14.15 Presentation Page Layouts
The element <style:presentation-page-layout> is a container for placeholders, which
define a set of empty presentation objects, for example, a title or outline. These placeholders areused as templates for creating new presentation objects and to mark the size and position of an
object if the presentation page layout of a drawing page is changed.
The <style:presentation-page-layout> element has an attribute style:name. It defines
the name of the page layout. If a drawing page has been created using a presentation pagelayout, the name of the layout is contained in the draw page's presentation:presentationpage-layout-name attribute. The optional style:display-name attribute specifies the nameof the presentation page layout as it should appear in the user interface.
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455

<define name="style-presentation-page-layout"><element name="style:presentation-page-layout"><attribute name="style:name"><ref name="styleName"/></attribute><optional><attribute name="style:display-name"><ref name="string"/></attribute></optional><zeroOrMore><ref name="presentation-placeholder"/></zeroOrMore></element></define>

14.15.1 Presentation Placeholder
The element <presentation:placeholder> specifies a placeholder for presentation objects,
for example, a title or outline.
The element has the following attributes:

13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472

•

object: Specifies the kind of object the element is a placeholder for. The value equals theone of the presentation:class attribute for presentation shapes. See section 9.6.

•

svg:x, svg:y, svg:width, svg:height: position and size attributes as specified in section
9.2.15, with the exception that the attributes may take percentage values in addition tocoordinates and lengths.

<define name="presentation-placeholder"><element name="presentation:placeholder"><attribute name="presentation:object"><ref name="presentation-classes"/></attribute><attribute name="svg:x"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute><attribute name="svg:y"><choice><ref name="coordinate"/><ref name="percent"/></choice></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 559 of 738

13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487

<attribute name="svg:width"><choice><ref name="length"/><ref name="percent"/></choice></attribute><attribute name="svg:height"><choice><ref name="length"/><ref name="percent"/></choice></attribute><empty/></element></define>

14.16 Chart Styles
Chart styles are <style:style> elements that have the family chart. They can be used withinchart documents to specify formatting properties for the chart, but also for certain objects within achart. They support the chart properties described in section 15.29, but also graphic, paragraphand text properties as described in sections 15.17, 15.5 and 15.4.
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506

<define name="style-style-content" combine="choice"><group><attribute name="style:family"><value>chart</value></attribute><optional><ref name="style-chart-properties"/></optional><optional><ref name="style-graphic-properties"/></optional><optional><ref name="style-paragraph-properties"/></optional><optional><ref name="style-text-properties"/></optional></group></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 560 of 738

15 Formatting Properties
A document can contain several style elements. To acquire a common set of formatting
properties, all formatting properties are contained in formatting property elements which areincluded as a child elements of any style element. This container elements offers two important
advantages, as follows:•

Formatting properties can be addressed by [CSS2] or [XSLT] stylesheets regardless of thestyle type.

•

Styles contain additional information that is not a formatting property, for example, the stylename and parent style. It is good practice to separate this type of information.

The following formatting property elements do exist:•<style:page-layout-properties> for page layout properties•<style:header-footer-properties> for page header and footer properties•<style:text-properties> for text properties•<style:paragraph-properties> for paragraph properties.

•<style:section-properties> for text section properties.

•<style:ruby-properties> for ruby section properties.

•<style:list-level-properties> for list properties.

•<style:table-properties> for table properties.

•<style:table-column-properties> for table column properties.

•<style:table-row-properties> for table row properties.

•<style:table-cell-properties> for table cell properties.

•<style:graphic-properties> for drawing object properties.

15.1 Simple and Complex Formatting Properties
15.1.1 Simple Formatting Properties
Most formatting properties are simple and can be represented as attributes of the formatting
property elements. Where possible, [XSL] attributes or attributes from other specifications areused to represent formatting properties. In this specification, the namespace prefix fo is used for
XSL properties, that is properties that are part of the XSL namespace.
In office application, there are very often formatting properties that cannot be specified
independent of other formatting properties. If this is the case, and if some of the required
properties are missing, the application assumes reasonable default values.
Example: Simple style properties
This example shows a formatting property container that specifies an upper paragraph margin of
1 cm as well as a lower margin of 0.5 cm:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 561 of 738

<style:paragraph-properties fo:margin-left="1cm" fo:margin-bottom=".5cm"/>

15.1.2 Complex Formatting Properties
If a formatting property is too complex to be represented by XML attributes, it is represented by an
XML element. Each such property is represented by an element type of its own.
Example: Complex formatting properties
This is an example of a formatting property container that specifies upper and lower margins aswell as tab stop position at 2 and 4 cm.
<style:paragraph-properties><style:tab-stops><style:tab-stop style:position="2cm"/><style:tab-stop style:position="4cm"/></style:tab-stops></style:paragraph-properties>

15.1.3 Processing Rules for Formatting Properties
In the OpenDocument schema the various <style:*-properties> elements may contain predefined formatting attributes and elements as well as custom formatting attributes and elements.
The pre-defined attributes and elements have defined semantics, and are described within thischapter.
Custom formatting attributes and elements are arbitrary attributes and elements inside<style:*-properties> elements. Their semantics are not defined in this specification,
Conforming applications in general should preserve both, pre-defined and custom formatting
attributes and elements when editing the document.
13507
13508
13509

<define name="style-properties-content"><ref name="anyAttListOrElements"/></define>

15.2 Page Layout Formatting Properties
The properties described in this section can be contained within style page layouts (see section
14.3) They are contained in a <style:page-layout-properties> element.
•

Page size•

Page number format•

Paper tray•

Print orientation•

Margins•

Border•Border line width•

Padding•

Shadow•

Background

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 562 of 738

•Columns•

Register-truth

•

Print

•

Print page order•First page number

•

Scale

•

Table centering•

Maximum footnote height•

Footnote separator

13510
13511
13512
13513
13514

<define name="style-page-layout-properties"><element name="style:page-layout-properties"><ref name="style-page-layout-properties-content"/></element></define>

13515
13516
13517
13518

<define name="style-page-layout-properties-content"><ref name="style-properties-content"/></define>

13519
13520
13521
13522
13523

<define name="style-page-layout-properties-content-strict"><ref name="style-page-layout-properties-attlist"/><ref name="style-page-layout-properties-elements"/></define>

15.2.1 Page Size
The fo:page-width and fo:page-height attributes specify the physical size of the page.
The fo:page-width attribute must correspond to the orientation of the page. For example, if apage is printed in portrait, the fo:page-width attribute specifies the width of the shorter pageside. If the page is printed in landscape, the fo:page-width attribute specifies the width of thelonger page side.
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="fo:page-width"><ref name="length"/></attribute></optional><optional><attribute name="fo:page-height"><ref name="length"/></attribute></optional></define>

15.2.2 Page Number Format
The style:num-format, style:num-prefix and style:num-suffix attributes specify adefault number format for page styles, which is used to display page numbers within headers andfooters. See section 12.2 for detailed information on number format attributes.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 563 of 738

The style:num-format attribute can be empty. In this case, no page number will be displayed
by default.
13536
13537
13538
13539
13540
13541

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><ref name="common-num-format-attlist"/></optional><ref name="common-num-format-prefix-suffix-attlist"/></define>

15.2.3 Paper Tray
The style:paper-tray-name attribute specifies the paper tray to use when printing the
document. The names assigned to the printer trays depend on the printer. If the value of this
attribute is default, the default tray specified in the printer configuration settings is used.
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:paper-tray-name"><choice><value>default</value><ref name="string"/></choice></attribute></optional></define>

15.2.4 Print Orientation
The style:print-orientation attribute specifies the orientation of the printed page. The
value of this attribute can be portrait or landscape.
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:print-orientation"><choice><value>portrait</value><value>landscape</value></choice></attribute></optional></define>

15.2.5 Margins
The margins attributes fo:margin, fo:margin-top, fo:margin-bottom, fo:margin-leftand fo:margin-right specify the size of the page margins. See sections 15.5.17, 15.5.20 and
15.5.21 for detailed information on these attributes. Percentage values are not supported.
13562
13563
13564
13565
13566

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/><ref name="common-vertical-margin-attlist"/><ref name="common-margin-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 564 of 738

15.2.6 Border
The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-leftand fo:border-right specify the border properties of the page. See section 15.5.25 fordetailed information on these attributes.
13567
13568
13569

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-border-attlist"/></define>

15.2.7 Border Line Width
If a page contains borders, the border line width attributes style:border-line-width,style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of theborder lines of the page. See section 15.5.26 for detailed information on these attributes.
13570
13571
13572

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-border-line-width-attlist"/></define>

15.2.8 Padding
The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the page. See section 15.5.27
for detailed information on these attributes.
13573
13574
13575

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-padding-attlist"/></define>

15.2.9 Shadow
The shadow attribute style:shadow specifies the shadow of the page. See section 15.5.28 fordetailed information on this attribute.
13576
13577
13578

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

15.2.10 BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the page. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
13579
13580
13581
13582
13583
13584

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-page-layout-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 565 of 738

15.2.11 Columns
The <style:columns> element specifies if the page contains columns. See section 15.7.3 fordetailed information on this element.
13585
13586
13587

<define name="style-page-layout-properties-elements" combine="interleave"><ref name="style-columns"/></define>

15.2.12 Register-truth
The style:register-truth-ref-style-name attribute references a paragraph style. Theline distance specified of the paragraph style is used as the reference line distance for all
paragraphs that have the register-truth feature enabled.
13588
13589
13590
13591
13592
13593
13594

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:register-truth-ref-style-name"><ref name="styleNameRef"/></attribute></optional></define>

15.2.13 Print
The style:print attribute specifies which components in a spreadsheet document to print.
The value of this attribute is a list of the following values separated by blanks:

13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608

•

headers

•

grid

•

annotations•

objects (including graphics)•

charts•drawings•

formulas•zero-values<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:print"><list><zeroOrMore><choice><value>headers</value><value>grid</value><value>annotations</value><value>objects</value><value>charts</value><value>drawings</value><value>formulas</value><value>zero-values</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 566 of 738

13609
13610
13611
13612
13613
13614

</choice></zeroOrMore></list></attribute></optional></define>

15.2.14 Print Page Order
The style:print-page-order attribute specifies the order in which data in a spreadsheet isnumbered and printed when the data does not fit on one printed page.
The value of this attribute can be ttb or ltr. Use ttb to print the data vertically from the left
column to the bottom row of the sheet. Use ltr to print the data horizontally from the top row to
the right column of the sheet.
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:print-page-order"><choice><value>ttb</value><value>ltr</value></choice></attribute></optional></define>

15.2.15 First Page Number
The style:first-page-number specifies the number of the first page of a text or graphicaldocument, or for the first page of a table within a spreadsheet document.
The value of this attribute can be an integer or continue. If the value is continue, the page
number is the preceding page number incremented by 1. The default first page number is 1.
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:first-page-number"><choice><ref name="positiveInteger"/><value>continue</value></choice></attribute></optional></define>

15.2.16 Scale
The style:scale-to and style:scale-to-pages attributes specify how the application
should scale spreadsheet documents for printing.
The style:scale-to attribute specifies that the document is scaled to a percentage value,
where 100% equals no scaling. When using this attribute, all pages are enlarged or reduced insize while printing.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 567 of 738

The style:scale-to-pages attribute specifies the number of pages on which the thedocument should be printed. The document is then scaled to fit the defined number of pages.
If none of these attributes are present, the document is not scaled.
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:scale-to"><ref name="percent"/></attribute></optional><optional><attribute name="style:scale-to-pages"><ref name="positiveInteger"/></attribute></optional></define>

15.2.17 Table Centering
The style:table-centering attribute specifies how the application should center tables on
the page. This attribute only applies to spreadsheet documents.
The value of this attribute can be horizontal, vertical, both, or none. If this attribute is notpresent, the table is not centered.
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:table-centering"><choice><value>horizontal</value><value>vertical</value><value>both</value><value>none</value></choice></attribute></optional></define>

15.2.18 Maximum Footnote HeightThe style:footnote-max-height attribute specifies the maximum amount of space on thepage that a footnote can occupy. The value of the attribute is a length, which determines the
maximum height of the footnote area.
If the value of this attribute is set to 0in, there is no limit to the amount of space that the footnote
can occupy.
13659
13660
13661
13662
13663
13664
13665

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:footnote-max-height"><ref name="length"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 568 of 738

15.2.19 Writing Mode
The style:writing mode attribute specifies the writing mode that should is used by all
paragraphs that appear on the page. See section 15.5.36 for details. The value page is notallowed within page layouts.
13666
13667
13668

<define name="style-page-layout-properties-attlist" combine="interleave"><ref name="common-writing-mode-attlist"/></define>

15.2.20 Footnote Separator
The <style:footnote-sep> element describes the line that separates the footnote area fromthe body text area on a page.
The <style:footnote-sep> element supports the following attributes:•

style:width – specifies the width or thickness of the line.

•

style:rel-width – specifies the length of the line as a percentage of the body text area.

•

style:color – specifies the color of the line.

•

style:adjustment – specifies how the line is aligned on the page, that is left, right, or
center.

•style:distance-before-sep – specifies the space between the body text area and thefootnote line.

•

style:distance-after-sep – specifies the space between the footnote line and thefootnote text.

•

style:line-style – specifies the style of the line.

13669
13670
13671

<define name="style-page-layout-properties-elements" combine="interleave"><ref name="style-footnote-sep"/></define>

13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695

<define name="style-footnote-sep"><optional><element name="style:footnote-sep"><ref name="style-footnote-sep-attlist"/><empty/></element></optional></define><define name="style-footnote-sep-attlist" combine="interleave"><optional><attribute name="style:width"><ref name="length"/></attribute></optional><optional><attribute name="style:rel-width"><ref name="percent"/></attribute></optional><optional><attribute name="style:color"><ref name="color"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 569 of 738

13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721

</optional><optional><attribute name="style:line-style"><ref name="lineStyle"/></attribute></optional><optional><attribute name="style:adjustment" a:defaultValue="left"><choice><value>left</value><value>center</value><value>right</value></choice></attribute></optional><optional><attribute name="style:distance-before-sep"><ref name="length"/></attribute></optional><optional><attribute name="style:distance-after-sep"><ref name="length"/></attribute></optional></define>

15.2.21 Layout Grid
The style:layout-grid-mode property enables Asian layout grids. It has the following values:

13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732

•

none: Disables the layout grid.

•lines: Enables a line layout, this is, the page is divided in a fixed number of lines. The exact
number of lines depends on the other grid layout properties described below. There is nospace between the layout grid lines. The layout grid itself is centered on the page.

•

both: Like lines, except that the lines are divided into square cells. The number of cells perline depends on the line height, where the line height is the sum of the base height and theruby height as specified below. Within a layout cell, nor more than one Asian [UNICODE]
character is displayed. Asian characters that do not fit into a single cell are displayed centeredinto as many cells as required. Non Asian text is centered within as many cells as required.

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-mode"><choice><value>none</value><value>line</value><value>both</value></choice></attribute></optional></define>

15.2.22 Layout Grid Base HeightThe style:layout-grid-base-height attribute specifies the height reserved in the layout
grid lines for non ruby text.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 570 of 738

13733
13734
13735
13736
13737
13738
13739

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-base-height"><ref name="length"/></attribute></optional></define>

15.2.23 Layout Grid Ruby HeightThe style:layout-grid-ruby-height attribute specifies the height reserved in the layout
grid lines for ruby text.
13740
13741
13742
13743
13744
13745
13746

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-ruby-height"><ref name="length"/></attribute></optional></define>

15.2.24 Layout Grid Lines
The style:layout-grid-lines attribute specifies the number of layout grid lines per page.
The number of lines actually displayed may be smaller than specified if the page has not enoughspace to display the specified number of lines with the specified line height (i.e., the sum of thebase and ruby height).
13747
13748
13749
13750
13751
13752
13753

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-lines"><ref name="positiveInteger"/></attribute></optional></define>

15.2.25 Layout Grid Color
The style:layout-grid-color attribute specifies the color of the layout grid border lines.
13754
13755
13756
13757
13758
13759
13760

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-color"><ref name="color"/></attribute></optional></define>

15.2.26 Layout Grid Ruby Below
The style:layout-grid-ruby-below attribute specifies whether ruby text is displayed above
or below the base text.
13761
13762
13763
13764
13765
13766

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-ruby-below"><ref name="boolean"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 571 of 738

13767</define>

15.2.27 Layout Grid Print
The style:layout-grid-ruby-print attribute specifies whether the layout grid border lines
are printed.
13768
13769
13770
13771
13772
13773
13774

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-print"><ref name="boolean"/></attribute></optional></define>

15.2.28 Layout Grid Display
The style:layout-grid-ruby-print attribute specifies whether the layout grid border lines
are displayed.
13775
13776
13777
13778
13779
13780
13781

<define name="style-page-layout-properties-attlist" combine="interleave"><optional><attribute name="style:layout-grid-display"><ref name="boolean"/></attribute></optional></define>

15.3 Header Footer Formatting Properties
The properties described in this section can be contained within the header and footer styleelements contained in page layouts (see section 14.3) They are contained in a <style:headerfooter-properties> element.
These attributes are:•Fixed and minimum heights - see section 15.27•

Left and right margins - see section 15.5.17•

Bottom (for headers only) and top (for footers only) margins - see section 15.5.20.

•

Borders - see section 15.5.25 and 15.5.26•

Shadows – see section 15.5.28•

Backgrounds – see section 15.5.23 and 15.5.24.

•

Dynamic-Spacing

13782
13783
13784
13785
13786

<define name="style-header-footer-properties"><element name="style:header-footer-properties"><ref name="style-header-footer-properties-content"/></element></define>

13787
13788
13789
13790

<define name="style-header-footer-properties-content"><ref name="style-properties-content"/></define>

13791

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 572 of 738

13792
13793
13794
13795

<define name="style-header-footer-properties-content-strict"><ref name="style-header-footer-properties-attlist"/><ref name="style-header-footer-properties-elements"/></define>

15.3.1 Fixed and Minimum heights
The attributes svg:height and fo:min-height properties specify a fixed or a minimum height
for the header or footer.
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807

<define name="style-header-footer-properties-attlist" combine="interleave"><optional><attribute name="svg:height"><ref name="length"/></attribute></optional><optional><attribute name="fo:min-height"><ref name="length"/></attribute></optional></define>

15.3.2 Margins
The margins attributes fo:margin, fo:margin-top, fo:margin-bottom, fo:marginleft and fo:margin-right specify the size of the header and footer margins. See sections
15.5.17, 15.5.20 and 15.5.21 for detailed information on these attributes. Percentage values are
not supported. Bottom margins are only supported for headers, top margins only for footers.
13808
13809
13810
13811
13812

<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/><ref name="common-vertical-margin-attlist"/><ref name="common-margin-attlist"/></define>

15.3.3 Border
The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-leftand fo:border-right specify the border properties of the headers and footers. See section
15.5.25 for detailed information on these attributes.
13813
13814
13815

<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-border-attlist"/></define>

15.3.4 Border Line Width
If a page contains borders, the border line width attributes style:border-line-width,style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of theborder lines of the headers and footers. See section 15.5.26 for detailed information on these
attributes.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 573 of 738

1381613817
13818<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-border-line-width-attlist"/></define>

15.3.5 Padding
The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the headers and footers. See
section 15.5.27 for detailed information on these attributes.
13819
13820
13821

<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-padding-attlist"/></define>

15.3.6 BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the header or footer. See
sections 15.5.23 and 15.5.24 for detailed information on this attribute and element.
13822
13823
13824
13825
13826
13827

<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-header-footer-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.3.7 Shadow
The shadow attribute style:shadow specifies the shadow of the headers and footers. See
section 15.5.28 for detailed information on this attribute.
13828
13829
13830

<define name="style-header-footer-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

15.3.8 Dynamic Spacing
The style:dynamic-spacing property specifies whether or not the header or footer grows into
the space between the page body and the header or footer before the height of the page body
becomes smaller. If the value of this attribute is true, the header or footers first grows into thespace between the header and footer and the page body.
13831
13832
13833
13834
13835
13836
13837

<define name="style-header-footer-properties-attlist" combine="interleave"><optional><attribute name="style:dynamic-spacing"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 574 of 738

15.4 Text Formatting Properties
The properties described in this section can be contained within text styles (see section 14.8.1),
but also within other styles, like paragraph styles (see section 14.8.2) or cell styles (see section
14.12.4) They are contained in a <style:text-properties> element.
13838
13839
13840
13841
13842

<define name="style-text-properties"><element name="style:text-properties"><ref name="style-text-properties-content"/></element></define>

13843
13844
13845
13846

<define name="style-text-properties-content"><ref name="style-properties-content"/></define>

13847
13848
13849
13850
13851

<define name="style-text-properties-content-strict"><ref name="style-text-properties-attlist"/><ref name="style-text-properties-elements"/></define>

13852
13853
13854
13855

<define name="style-text-properties-elements"><empty/></define>

15.4.1 Font Variant
Use the fo:font-variant property to switch the option to display text as small capitalized
letters on or off. See §7.8.8 of [XSL] for details.
For some implementations, the fo:font-variant and fo:text-transform properties aremutually exclusive. If both properties are used simultaneously, the result is undefined except thatthe fo:text-transform value is none and the fo:font-variant value is normal.
13856
13857
13858
13859
13860
13861
13862

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:font-variant"><ref name="fontVariant"/></attribute></optional></define>

13863
13864
13865
13866
13867
13868
13869

<define name="fontVariant"><choice><value>normal</value><value>small-caps</value></choice></define>

15.4.2 Text Transformations
Use the fo:text-transform property to describe text transformations to uppercase,lowercase, and capitalization. See §7.16.6 of [XSL] for details.
For some implementations, the fo:font-variant and fo:text-transform properties aremutually exclusive. If both properties are attached used simultaneously, the result is undefined
except that the fo:text-transform value is none and the fo:font-variant value isnormal.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 575 of 738

13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:text-transform"><choice><value>none</value><value>lowercase</value><value>uppercase</value><value>capitalize</value></choice></attribute></optional></define>

15.4.3 Color
Use the fo:color property to specify the foreground color of text. See §7.17.1 of [XSL] fordetails.
13882
13883
13884
13885
13886
13887
13888

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:color"><ref name="color"/></attribute></optional></define>

15.4.4 Window Font Color
Use the style:use-window-font-color property to specify whether or not the window
foreground color should be as used as the foreground color for a light background color and white
for a dark background color.
13889
13890
13891
13892
13893
13894
13895

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:use-window-font-color"><ref name="boolean"/></attribute></optional></define>

15.4.5 Text Outline
Use the style:text-outline property to specify whether to display an outline of text or the
text itself. This attribute can have a value of true or false.
13896
13897
13898
13899
13900
13901
13902

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-outline"><ref name="boolean"/></attribute></optional></define>

15.4.6 Line-Through TypeUse the style:text-line-through-type property to specify whether text is lined through,and if so, whether a single or double line will be used. See section 15.4.28 for details.
13903<define name="style-text-properties-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 576 of 738

13904
13905
13906
13907
13908
13909

<optional><attribute name="style:text-line-through-type"><ref name="lineType"/></attribute></optional></define>

15.4.7 Line-Through Style
Use the style:text-line-through-style property to specify if and how text is lined
through. This property is similar to the [CSS3Text] text-line-style property, except that it
has the additional value long-dash and that it does not have the value double. Instead of this,the attribute style:text:line-through-type can be used to turn each line style into adouble line. See §9.2 of [CSS3Text] for details. See also section 15.4.29.
13910
13911
13912
13913
13914
13915
13916

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-style"><ref name="lineStyle"/></attribute></optional></define>

15.4.8 Line-Through Width
Use the style:text-line-through-width property to specifies the width of a line-throughline. This property is very similar to the [CSS3Text] text-line-through-width property,
except that it has an additional value bold. bold specifies a line width that is calculated from thefont sizes like an auto width, but is wider than an auto width. See §9.3 of [CSS3Text] for details.
See also section 15.4.30.
13917
13918
13919
13920
13921
13922
13923

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-width"><ref name="lineWidth"/></attribute></optional></define>

15.4.9 Line-Through Color
Use the style:text-line-through-color property to specify the color that is used to linethrough text. The value of this property is either font-color or a color. If the value is fontcolor, the current text color is used for underlining.
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-color"><choice><value>font-color</value><ref name="color"/></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 577 of 738

15.4.10 Line-Through Text
The style:text-line-through-text attribute is evaluated only if the value ofstyle:text-line-through-style attribute is different than none. If the attribute value is not
empty, the attribute value string is used for line-through instead of the line that has been specified,provided that the application supports line-through with text. If the application does not support
line-through with text, the attribute is ignored, this means, style:text-line-through-style
will be evaluated only. If the application supports line-through with single characters only, and thetext-line-through-text has more than one character, the first character of the line-through-text
should be used only. If the applications supports line-through with with certain characters only (like"x" or "/"), the application should use one of these characters if the text-line-through-text specifies
characters that are not supported. In other words: line-through with text has a higher priority thanline-through with lines, even if the line-through text that is specified has to be adapted to be usableby the application.
13934
13935
13936
13937
13938
13939
13940

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-text"><ref name="string"/></attribute></optional></define>

15.4.11 Line-Through Text Style
The style:text-line-through-text-style specifies a text style that is applied to the textline-through characters. It is not applied to line-through lines. If the attribute appears in an
automatic style, it may reference either an automatic text style or a common style. If the attributeappears in a common style, it may reference a common style only.
13941
13942
13943
13944
13945
13946
13947

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-text-style"><ref name="styleNameRef"/></attribute></optional></define>

15.4.12 Text Position
Use the style:text-position formatting property to specify whether text is positioned above
or below the baseline and to specify the relative font height that is used for this text.
This attribute can have one or two values.
The first value must be present and specifies the vertical text position as a percentage that relates
to the current font height or it takes one of the values sub or super. Negative percentages or the
sub value place the text below the baseline. Positive percentages or the super value place thetext above the baseline. If sub or super is specified, the application can choose an appropriate
text position.
The second value is optional and specifies the font height as a percentage that relates to thecurrent font-height. If this value is not specified, an appropriate font height is used. Although thisvalue may change the font height that is displayed, it never changes the current font height that isused for additional calculations.
13948
13949

<define name="style-text-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 578 of 738

13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963

<attribute name="style:text-position"><list><choice><ref name="percent"/><value>super</value><value>sub</value></choice><optional><ref name="percent"/></optional></list></attribute></optional></define>

15.4.13 Font Name
Use the style:font-name, style:font-name-asian and style:font-name-complex
properties to assign a font to the text.
The values of these attributes form the name of a font that is declared by a <style:fontface> element within the <office:font-face-decls> element.
The style:font-name-asian attribute is evaluated for [UNICODE] characters that are CJKcharacters.
The style:font-name-complex attribute is evaluated for [UNICODE] characters that arecomplex text layout (CTL) characters.
The style:font-name attribute is evaluated for any other [UNICODE] character.
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-name"><ref name="string"/></attribute></optional><optional><attribute name="style:font-name-asian"><ref name="string"/></attribute></optional><optional><attribute name="style:font-name-complex"><ref name="string"/></attribute></optional></define>

15.4.14 Font Family
Use the fo:font-family, style:font-family-asian and style:font-familycomplex properties to specify the font family for the text.
These attributes may be used instead of the font name attributes to specify the properties of a fontindividually. However, it is advisable to use the style:font-name attributes instead. See
section 15.4.13 for information about when Asian and complex variants of the attribute are
evaluated. See also §7.8.2 of [XSL].
13981<define name="style-text-properties-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 579 of 738

13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997

<optional><attribute name="fo:font-family"><ref name="string"/></attribute></optional><optional><attribute name="style:font-family-asian"><ref name="string"/></attribute></optional><optional><attribute name="style:font-family-complex"><ref name="string"/></attribute></optional></define>

15.4.15 Font Family GenericUse the style:font-family-generic, style:font-family-generic-asian andstyle:font-family-generic-complex properties to specify a generic font family name.
These properties are ignored if there is no corresponding fo:font-family property attached tothe same properties element.
Although it is recommended to use the font name attributes (see section 15.4.13), theseproperties may be used instead of them to specify the properties of a font.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-family-generic"><ref name="fontFamilyGeneric"/></attribute></optional><optional><attribute name="style:font-family-generic-asian"><ref name="fontFamilyGeneric"/></attribute></optional><optional><attribute name="style:font-family-generic-complex"><ref name="fontFamilyGeneric"/></attribute></optional></define>

14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025

<define name="fontFamilyGeneric"><choice><value>roman</value><value>swiss</value><value>modern</value><value>decorative</value><value>script</value><value>system</value></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 580 of 738

15.4.16 Font Style
Use the style:font-style-name, style:font-style-name-asian and style:fontstyle-name-complex properties to specify a font style name.
These properties are ignored if there is no corresponding fo:font-family property attached tothe same properties element.
Although it is recommended to use the font name attributes (see section 15.4.13), theseproperties may be used instead of them to specify the properties of a font.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-style-name"><ref name="string"/></attribute></optional><optional><attribute name="style:font-style-name-asian"><ref name="string"/></attribute></optional><optional><attribute name="style:font-style-name-complex"><ref name="string"/></attribute></optional></define>

15.4.17 Font Pitch
Use the style:font-pitch, style:font-pitch and style:font-pitch-complex
properties to specify whether a font has a fixed or variable width.
These properties are ignored if there is no corresponding fo:font-family property attached tothe same properties element.
Although it is recommended to use the font name attributes (see section 15.4.13), theseproperties may be used instead of them to specify the properties of a font.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-pitch"><ref name="fontPitch"/></attribute></optional><optional><attribute name="style:font-pitch-asian"><ref name="fontPitch"/></attribute></optional><optional><attribute name="style:font-pitch-complex"><ref name="fontPitch"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 581 of 738

1405814059</optional></define>

14060
14061
14062
14063
14064
14065
14066

<define name="fontPitch"><choice><value>fixed</value><value>variable</value></choice></define>

15.4.18 Font Character Set
Use the style:font-charset, style:font-charset-asian and style:font-charsetcomplex properties to specify the character set of a font.
The value of these attributes can be x-symbol or the character encoding in the notation
described in the §4.3.3 of [XML1.0]. If the value is x-symbol, all characters that are displayedusing this font must be contained in the [UNICODE] character range 0xf000 to 0xf0ff.
These properties are ignored if there is no corresponding fo:font-family property attached tothe same properties element.
Although it is recommended to use the font name attributes (see section 15.4.13), theseproperties may be used instead of them to specify the properties of a font.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-charset"><ref name="textEncoding"/></attribute></optional><optional><attribute name="style:font-charset-asian"><ref name="textEncoding"/></attribute></optional><optional><attribute name="style:font-charset-complex"><ref name="textEncoding"/></attribute></optional></define>

14084
14085
14086
14087
14088
14089

<define name="textEncoding"><data type="string"><param name="pattern">[A-Za-z][A-Za-z0-9._\-]*</param></data></define>

15.4.19 Font Size
Use the fo:font-size, style:font-size-asian and style:font-size-complex
properties to specify the size of font.
The value of these property is either an absolute length or a percentage as described in §8.8.4 of[XSL]. In contrast to XSL, percentage values can be used within common styles only and relates
to the font height of the parent style rather than to the font height of the attributes neighborhood.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 582 of 738

Absolute font heights such as medium, large, x-large, and so on, and relative font heights
such as smaller, and larger are not supported.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:font-size"><choice><ref name="positiveLength"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="style:font-size-asian"><choice><ref name="positiveLength"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="style:font-size-complex"><choice><ref name="positiveLength"/><ref name="percent"/></choice></attribute></optional></define>

15.4.20 Relative Font Size
Use the style:font-size-rel, style:font-size-rel-asian and style:font-sizerel-complex properties to specify a relative font size change.
These properties specify a relative font size change as a length such as +1pt, -3pt. It cannot be
used within automatic styles. The size changes relates to the font size setting that applies to theparent style of the style.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-size-rel"><ref name="length"/></attribute></optional><optional><attribute name="style:font-size-rel-asian"><ref name="length"/></attribute></optional><optional><attribute name="style:font-size-rel-complex"><ref name="length"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 583 of 738

14132</define>

15.4.21 Script TypeThe style:script-type property may be used to specify which script dependent attributes(like fo:font-family, style:font-family-asian, style:font-family-complex) arecurrently active for some text. The attribute should be evaluated by applications that do notsupport script types to select the correct script dependent properties. Application that support
script types may also evaluate the attribute and overwrite the script type they would evaluate for acertain character, but they don't have to.
The usage of this property simplifies for instance transformations from and to [CSS2]/[XSL] andother formats that don't have script-dependent attributes, and also can be used to assign scripttypes to weak [UNICODE] characters, where application may choose different script types.
The values of this property are latin, asian, complex and ignore. The value ignore can beused only within default styles. If it is set, all script-dependent attributes are applied to all script
types. This would mean for example that a fo:font-family would be applied to all script types
as well as a style:font-family-asian or style:font-family-complex. This simplifies
saving documents with application that do not support a script type.
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:script-type"><choice><value>latin</value><value>asian</value><value>complex</value><value>ignore</value></choice></attribute></optional></define>

15.4.22 Letter Spacing
Use the fo:letter-spacing property to specify the amount of space between letters. The
value of this property can be normal or it can specify a length. See §7.16.2 of [XSL] for details.
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:letter-spacing"><choice><ref name="length"/><value>normal</value></choice></attribute></optional></define>

15.4.23 Language
Use the fo:language, fo:language-asian and fo:language-complex properties tospecify the language of the text. See §7.9.2 of [XSL] for details.
Some applications ignore these properties if they are not specified together with thecorresponding fo:country property.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 584 of 738

See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
fo:language, fo:language-asian and fo:language-complex
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:language"><ref name="languageCode"/></attribute></optional><optional><attribute name="style:language-asian"><ref name="languageCode"/></attribute></optional><optional><attribute name="style:language-complex"><ref name="languageCode"/></attribute></optional></define>

15.4.24 Country
Use the fo:country, style:country-asian and style:country-complex properties tospecify the country of the text. See §7.9.1 of [XSL] for details.
Some application ignore these properties if they are not specified together with the corresponding
fo:language property.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:country"><ref name="countryCode"/></attribute></optional><optional><attribute name="style:country-asian"><ref name="countryCode"/></attribute></optional><optional><attribute name="style:country-complex"><ref name="countryCode"/></attribute></optional></define>

15.4.25 Font Style
Use the fo:font-style, style:font-style-asian and style:font-style-complex
properties to specify whether to use normal or italic font face. See §7.8.7 of [XSL] for details.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14189<define name="style-text-properties-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 585 of 738

14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205

<optional><attribute name="fo:font-style"><ref name="fontStyle"/></attribute></optional><optional><attribute name="style:font-style-asian"><ref name="fontStyle"/></attribute></optional><optional><attribute name="style:font-style-complex"><ref name="fontStyle"/></attribute></optional></define>

14206
14207
14208
14209
14210
14211
14212
14213

<define name="fontStyle"><choice><value>normal</value><value>italic</value><value>oblique</value></choice></define>

15.4.26 Font Relief
Use the style:font-relief property to specify whether the font should be embossed,
engraved, or neither.
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:font-relief"><choice><value>none</value><value>embossed</value><value>engraved</value></choice></attribute></optional></define>

15.4.27 Text Shadow
Use the fo:text-shadow property to specify the text shadow style to use. See §7.16.5 of [XSL]
for details.
Some applications may only supports a limited number of shadow effects, for instance a default
text shadow style only.
14225
14226
14227
14228
14229
14230
14231

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:text-shadow"><ref name="shadowType"/></attribute></optional></define>

14232
14233
14234

<define name="shadowType"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 586 of 738

14235
14236
14237
14238
14239

<value>none</value><!-- The following string must match an XSL shadow decl --><ref name="string"/></choice></define>

15.4.28 Underlining TypeUse the style:text-underline-type property to specify whether text is underlined, and if
so, whether a single or double line will be used for underlining.
14240
14241
14242
14243
14244
14245
14246

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-underline-type"><ref name="lineType"/></attribute></optional></define>

14247
14248
14249
14250
14251
14252
14253
14254

<define name="lineType"><choice><value>none</value><value>single</value><value>double</value></choice></define>

15.4.29 Underlining Style
Use the style:text-underline-style property to specify if and how text is underlined. The
value of this property is the underlining style for the text, for example, single, dotted, dash.
This property is similar to the [CSS3Text] text-underline-style property, except that has
the additional value long-dash and that it does not have the value double. Instead of this, theattribute style:text:underline-type can be used to turn each line style into a double line.
See §9.2 of [CSS3Text] for details.
14255
14256
14257
14258
14259
14260
14261

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-underline-style"><ref name="lineStyle"/></attribute></optional></define>

14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274

<define name="lineStyle"><choice><value>none</value><value>solid</value><value>dotted</value><value>dash</value><value>long-dash</value><value>dot-dash</value><value>dot-dot-dash</value><value>wave</value></choice></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 587 of 738

15.4.30 Underling Width
Use the style:text-underline-width property specifies the width of an underline. This
property is very similar to the [CSS3Text] text-underline-width property, except that it has
an additional value bold. bold specifies a line width that is calculated from the font sizes like an
auto width, but is wider than an auto width. See §9.3 of [CSS3Text] for details.
14275
14276
14277
14278
14279
14280
14281

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-underline-width"><ref name="lineWidth"/></attribute></optional></define>

14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296

<define name="lineWidth"><choice><value>auto</value><value>normal</value><value>bold</value><value>thin</value><value>dash</value><value>medium</value><value>thick</value><ref name="positiveInteger"/><ref name="percent"/><ref name="positiveLength"/></choice></define>

15.4.31 Underline Color
Use the style:text-underline-color property to specify the color that is used to underline
text. The value of this property is either font-color or a color. If the value is font-color, thecurrent text color is used for underlining.
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-underline-color"><choice><value>font-color</value><ref name="color"/></choice></attribute></optional></define>

15.4.32 Font Weight
Use the fo:font-weight, style:font-weight-asian and style:font-weightcomplex properties to specify the weight of the font. See §7.8.9 of [XSL] for details.
The relative values lighter or bolder are not supported and only a few distinct numericalvalues are supported. Unsupported numerical values are rounded off to the next supported value.
See section 15.4.13 for information about when the Asian and complex variants of the attributeare evaluated.
14307
14308

<define name="style-text-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 588 of 738

14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323

<attribute name="fo:font-weight"><ref name="fontWeight"/></attribute></optional><optional><attribute name="style:font-weight-asian"><ref name="fontWeight"/></attribute></optional><optional><attribute name="style:font-weight-complex"><ref name="fontWeight"/></attribute></optional></define>

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339

<define name="fontWeight"><choice><value>normal</value><value>bold</value><value>100</value><value>200</value><value>300</value><value>400</value><value>500</value><value>600</value><value>700</value><value>800</value><value>900</value></choice></define>

15.4.33 Text Underline Word ModeUse the style:text-underline-mode property to specify whether underlining is applied towords only or to portions of text. If underlining is applied to text portions, the spaces between
words and the words are underlined. This property is very similar to the text-underline-mode
property of [CSS3Text]. See § 9.5 of [CSS3Text] for details.
14340
14341
14342
14343
14344
14345
14346

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-underline-mode"><ref name="lineMode"/></attribute></optional></define>

14347
14348
14349
14350
14351
14352
14353

<define name="lineMode"><choice><value>continuous</value><value>skip-white-space</value></choice></define>

15.4.34 Text Line-Through Word ModeUse the style:text-line-through-mode property to specify whether lining through isapplied to words only or to portions of text. If lining through is applied to text portions, the spaces
between words and the words are line-through. This property is very similar to the text-linethrough-mode property of [CSS3Text]. See § 9.5 of [CSS3Text] for details.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 589 of 738

14354
14355
14356
14357
14358
14359
14360

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-line-through-mode"><ref name="lineMode"/></attribute></optional></define>

15.4.35 Letter Kerning
Use the style:letter-kerning property to enable or disable kerning between characters.
14361
14362
14363
14364
14365
14366
14367

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:letter-kerning"><ref name="boolean"/></attribute></optional></define>

15.4.36 Text Blinking
Use the style:text-blinking property to specify whether or not text blinks.
14368
14369
14370
14371
14372
14373
14374

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-blinking"><ref name="boolean"/></attribute></optional></define>

15.4.37 Text Background Color
Use the fo:background-color property to specify the background color to apply to characters.
See §7.7.2 of [XSL] for details.
The value of this property can be transparent or a color. See also section 15.5.23.
14375
14376
14377

<define name="style-text-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define>

15.4.38 Text Combine
Use the style:text-combine property to combine characters so that they are displayed within
two lines.
The value of this attribute can be none, letters or lines.
If the value is lines, all characters with this attribute value that immediately follow each other are
displayed within two lines of approximately the same length. There can be a line break between
any two characters to meet this constraint.
If the value of the attribute is letters, up to 5 characters are combined within two lines. Any
additional character is displayed as normal text.
14378
14379

<define name="style-text-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 590 of 738

14380
14381
14382
14383
14384
14385
14386
14387
14388

<attribute name="style:text-combine"><choice><value>none</value><value>letters</value><value>lines</value></choice></attribute></optional></define>

15.4.39 Text Combine Start and End Characters
Use the two properties style:text-combine-start-char and style:text-combineend-char to specify a start and end character that is displayed before and after a portion of text
whose style:text-combine property has a value of lines.
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-combine-start-char"><ref name="character"/></attribute></optional><optional><attribute name="style:text-combine-end-char"><ref name="character"/></attribute></optional></define>

15.4.40 Text Emphasis
Use the style:text-emphasize property to emphasize text in Asian documents.
The value of this attribute consists of two space-separated values.
The first value represents the style to use for emphasis and it can be none, accent, dot,
circle, or disc.
The second value represents the position of the emphasis and it can be above or below. If thefirst value is none, this value can be omitted.
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-emphasize"><choice><value>none</value><list><choice><value>none</value><value>accent</value><value>dot</value><value>circle</value><value>disc</value></choice><choice><value>above</value><value>below</value></choice></list></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 591 of 738

1442014421
14422</attribute></optional></define>

15.4.41 Text Scale
Use the style:text-scale property to decrease or increase the width of the text by scaling thefont width.
14423
14424
14425
14426
14427
14428
14429

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-scale"><ref name="percent"/></attribute></optional></define>

15.4.42 Text Rotation Angle
The style:text-rotation-angle property specifies an angle to which text is rotated. The
value of this attribute can be 0, 90, or 270. For any angle greater than 359 the remainder of adivision by 360 is used. Any angle other than 0, 90 or 270 is rounded to the nearest possible
value.
If this attribute is specified for more than one character, all text containing these characters is
rotated.
14430
14431
14432
14433
14434
14435
14436

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-rotation-angle"><ref name="integer"/></attribute></optional></define>

15.4.43 Text Rotation Scale
If text is rotated, the style:text-rotation-scale property specifies whether the width of thetext should be scaled to fit into the current line height or the width of the text should remain fixed,
therefore changing the current line height.
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="style:text-rotation-scale"><choice><value>fixed</value><value>line-height</value></choice></attribute></optional></define>

15.4.44 Hyphenation
Use the fo:hyphenate property to enable or disable automatic hyphenation. See §7.9.4 of [XSL]
for details.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 592 of 738

Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count andfo:hyphenation-ladder-count independent of each other within a style. A reasonable
default for fo:hyphenate in this case is false.
14447
14448
14449
14450
14451
14452
14453

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:hyphenate"><ref name="boolean"/></attribute></optional></define>

15.4.45 Hyphenation Remain Char CountUse the fo:hyphenation-remain-char-count property to specify the number of charactersthat must be present before a hyphenation character. See §7.9.7 of [XSL] for details.
Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count andfo:hyphenation-ladder-count independent of each other within a style. A reasonable
default for fo:hyphenation-remain-char-count in this case is 0.
14454
14455
14456
14457
14458
14459
14460

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:hyphenation-remain-char-count"><ref name="positiveInteger"/></attribute></optional></define>

15.4.46 Hyphenation Push Char CountUse the fo:hyphenation-push-char-count property to specify the minimum number ofcharacters that are moved to the next line. See §7.9.6 of [XSL] for details.
Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count andfo:hyphenation-ladder-count independent of each other within a style. A reasonable
default for fo:hyphenation-push-char-count in this case is 0.
14461
14462
14463
14464
14465
14466
14467

<define name="style-text-properties-attlist" combine="interleave"><optional><attribute name="fo:hyphenation-push-char-count"><ref name="positiveInteger"/></attribute></optional></define>

15.4.47 Hidden or Conditional Text
The text:display property allows text to be hidden. This can be made dependent on acondition as well. This attributes and its values are the same as for text:display attribute on
text sections (see also section 4.4). The values of this attribute may be any of:•true – the text will be displayed normally. This is the default.

•

none – the text will be hidden.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 593 of 738

•
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486

condition – a condition determines whether the text will be displayed or hidden. In this case,a text:condition attribute must be present specifying the condition.

<define name="style-text-properties-attlist" combine="interleave"><choice><attribute name="text:display"><value>true</value></attribute><attribute name="text:display"><value>none</value></attribute><group><attribute name="text:display"><value>condition</value></attribute><attribute name="text:condition"><value>none</value></attribute></group><empty/></choice></define>

15.5 Paragraph Formatting Properties
The properties described in this section can be contained within paragraph styles (see section
14.8.2), but also within other styles, like cell styles (see section 14.12.4) They are contained in a<style:paragraph-properties> element.
14487
14488
14489
14490
14491

<define name="style-paragraph-properties"><element name="style:paragraph-properties"><ref name="style-paragraph-properties-content"/></element></define>

14492
14493
14494
14495

<define name="style-paragraph-properties-content"><ref name="style-properties-content"/></define>

14496
14497
14498
14499
14500

<define name="style-paragraph-properties-content-strict"><ref name="style-paragraph-properties-attlist"/><ref name="style-paragraph-properties-elements"/></define>

15.5.1 Fixed Line Height
Use the fo:line-height property to specify a fixed line height either as a length or apercentage that relates to the highest character in a line. A special value of normal activates thedefault line height calculation. It is also used to deactivate the effects of the style:lineheight-at-least and style:line-spacing properties. The value of this property can be alength, a percentage, or a value of normal. See §7.15.4 of [XSL] for details.
14501
14502
14503
14504
14505
14506
14507
14508

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:line-height"><choice><value>normal</value><ref name="nonNegativeLength"/><ref name="percent"/></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 594 of 738

1450914510
14511</attribute></optional></define>

15.5.2 Minimum Line Height
Use the style:line-height-at-least property to specify a minimum line height. The valueof this property is a length. There is no normal value for the property.
14512
14513
14514
14515
14516
14517
14518

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:line-height-at-least"><ref name="nonNegativeLength"/></attribute></optional></define>

15.5.3 Line DistanceUse the style:line-spacing property to specify a fixed distance between two lines. There isno normal value for this property.
14519
14520
14521
14522
14523
14524
14525

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:line-spacing"><ref name="length"/></attribute></optional></define>

15.5.4 Font-Independent Line Spacing
The style:font-independent-line-spacing property specifies if font independent line
spacing is used. If the attribute's value is true, then the line height is calculated only from thefont height as specified by the font size attributes fo:font-size, style:font-size-asianand style:font-size-complex. If the value is false, the font metric of the actual font istaken into account.
14526
14527
14528
14529
14530
14531
14532

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:font-independent-line-spacing"><ref name="boolean"/></attribute></optional></define>

15.5.5 Text Align
Use the fo:text-align property to specify how to align text in paragraphs.
The value of this property can be start, end, left, right, center, or justify. See §7.15.9of [XSL] for details. The values inside and outside are not supported.
If there are no values specified for the fo:text-align-last and style:justify-singleword properties within the same item set element, the values of these properties are set to startand false respectively.
14533<define name="style-paragraph-properties-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 595 of 738

1453414535<ref name="common-text-align"/></define>

14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550

<define name="common-text-align"><optional><attribute name="fo:text-align"><choice><value>start</value><value>end</value><value>left</value><value>right</value><value>center</value><value>justify</value></choice></attribute></optional></define>

15.5.6 Text Align of Last Line
Use the fo:text-align-last property to specify how to align the last line of a justified
paragraph. See §7.15.9 of [XSL] for details. The only values of this property that are supported
are start, center, or justify.
This property is ignored if it not accompanied by an fo:text-align property.
If there are no values specified for the fo:text-align and style:justify-single-wordproperties, these values of these properties is set to start and false respectively.
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:text-align-last"><choice><value>start</value><value>center</value><value>justify</value></choice></attribute></optional></define>

15.5.7 Justify Single Word
If the last line in a paragraph is justified, use the style:justify-single-word property to
specify whether or not a single word should be justified.
If there are no values specified for the fo:text-align and fo:text-align-last properties,
the values of these properties are set to start. This means that specifying a style:justifysingle-word property without specifying a fo:text-align and fo:text-align-lastproperty has no effect.
14562
14563
14564
14565
14566
14567
14568

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:justify-single-word"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 596 of 738

15.5.8 Keep Together
Use the fo:keep-together property to control whether the lines of a paragraph should be kept
together on the same page or column (if the value is always), or whether breaks are allowed
within the paragraph (if the value is auto). See §7.19.3 of [XSL] for details.
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:keep-together"><choice><value>auto</value><value>always</value></choice></attribute></optional></define>

15.5.9 Widows
Use the fo:widows property to specify the minimum number of lines allowed at the top of a page
to avoid paragraph widows. See §7.19.7 of [XSL] for details.
14579
14580
14581
14582
14583
14584
14585

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:widows"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.5.10 Orphans
Use the fo:orphans property to specify the minimum number of lines required at the bottom of apage to avoid paragraph orphans. See See §7.19.6 of [XSL] for details.
14586
14587
14588
14589
14590
14591
14592

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:orphans"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.5.11 Tab Stops
Use the tab stop element <style:tab-stops> to specify tab stop definitions.
Every tab stop position is represented by a single <style:tab-stop> element that is containedin the <style:tab-stops> element.
14593
14594
14595

<define name="style-paragraph-properties-elements" combine="interleave"><ref name="style-tab-stops"/></define>

14596
14597
14598
14599
14600
14601

<define name="style-tab-stops"><optional><element name="style:tab-stops"><zeroOrMore><ref name="style-tab-stop"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 597 of 738

14602
14603
14604
14605

</zeroOrMore></element></optional></define>

14606
14607
14608
14609
14610
14611
14612

<define name="style-tab-stop"><element name="style:tab-stop"><ref name="style-tab-stop-attlist"/><empty/></element></define>

The attributes that may be associated with the <style:tab-stop> elements are:•Tab position•

Tab type•

Delimiter character•

Leader type•

Leader style•

Leader width•

Leader color•

Leader text•

Leader text style

Tab Position
The style:position attribute specifies the position of a tab stop.
This attribute is associated with the <style:tab-stop> element and its value is a length.
14613
14614
14615
14616
14617

<define name="style-tab-stop-attlist" combine="interleave"><attribute name="style:position"><ref name="nonNegativeLength"/></attribute></define>

Tab Type
The style:type attribute specifies the type of tab stop.
This attribute is associated with the <style:tab-stop> element and its value can be left,
center, right or char.
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628

<define name="style-tab-stop-attlist" combine="interleave"><choice><optional><attribute name="style:type" a:defaultValue="left"><choice><value>left</value><value>center</value><value>right</value></choice></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 598 of 738

14629
14630
14631
14632
14633
14634
14635
14636

<group><attribute name="style:type"><value>char</value></attribute><ref name="style-tab-stop-char-attlist"/></group></choice></define>

Delimiter Character
The style:char attribute specifies the delimiter character for tab stops of type char.
This attribute is associated with the <style:tab-stop> element and it must be present if thevalue of the style:type attribute is char. If the value of style:type attribute is not char, it
is ignored.
The value of the attribute must be a single [UNICODE] character.
14637
14638
14639
14640
14641

<define name="style-tab-stop-char-attlist" combine="interleave"><attribute name="style:char"><ref name="character"/></attribute></define>

Leader TypeUse the style:leader-type attribute to specify whether a leader line should be drawn, and if
so, whether a single or double line will be used. See also section 15.4.28.
14642
14643
14644
14645
14646
14647
14648

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-type"><ref name="lineType"/></attribute></optional></define>

Leader Style
Use the style:leader-style property to specify if and how a leader line is drawn. The line
styles that can be used are described in section 15.4.29.
14649
14650
14651
14652
14653
14654
14655

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-style"><ref name="lineStyle"/></attribute></optional></define>

Leader Width
Use the style:leader-width property to specifies the width of a leader line. See section
15.4.30 for the values of this attribute.
14656
14657
14658

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-width">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 599 of 738

14659
14660
14661
14662

<ref name="lineWidth"/></attribute></optional></define>

Leader Color
Use the style:leader-color property to specify the color that is for the leader line. The valueof this property is either font-color or a color. If the value is font-color, the current text
color is used for the leader line.
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-color"><choice><value>font-color</value><ref name="color"/></choice></attribute></optional></define>

Leader Text
The style:leader-text attribute specifies the leader text to use for tab stops. If the attributevalue is not empty, the attribute value string is used as leader instead of the line that has been
specified, provided that the application supports textual leaders. If the application does notsupport textual, the attribute is ignored, this means, style:leader-style will be evaluatedonly. If the application supports textual consisting of a single characters only, and the leader text
has more than one character, the first character of the leader text should be used only. If theapplications supports textual leaders with with certain characters only (like "." or "_"), theapplication should use one of these characters if the leader-text specifies characters that are notsupported. In other words: textual leaders have a higher priority than line leaders, even if theleader text that is specified has to be adapted to be usable by the application.
This attribute is associated with the <style:tab-stop> element and its value must be a single[UNICODE] character.
14673
14674
14675
14676
14677
14678
14679

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-text" a:defaultValue=" "><ref name="string"/></attribute></optional></define>

Leader Text Style
The style:leader-text-style specifies a text style that is applied to a textual leader. It is
not applied to leader lines. If the attribute appears in an automatic style, it may reference either an
automatic text style or a common style. If the attribute appears in a common style, it may
reference a common style only.
14680
14681
14682
14683
14684
14685

<define name="style-tab-stop-attlist" combine="interleave"><optional><attribute name="style:leader-text-style"><ref name="styleNameRef"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 600 of 738

14686</define>

15.5.12 Tab Stop Distance
The attribute style:tab-stop-distance specifies the distance between default tab stops. A
default tab stop is repeated automatically after the specified distance. Default tab stops usually
are only evaluated if they are specified within a default style (see section 14.2).
14687
14688
14689
14690
14691
14692
14693

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:tab-stop-distance"><ref name="nonNegativeLength"/></attribute></optional></define>

15.5.13 Hyphenation Keep
Use the fo:hyphenation-keep property to enable or disable the hyphenation of the last word
on a page. See §7.15.1 of [XSL] for details.
Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count andfo:hyphenation-ladder-count independent of each other within a style. A reasonable
default for fo:hyphenation-keep in this case is auto.
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:hyphenation-keep"><choice><value>auto</value><value>page</value></choice></attribute></optional></define>

15.5.14 Maximum Hyphens
Use the fo:hyphenation-ladder-count property to specify the maximum number ofsuccessive lines that can contain a hyphenated word. See §7.15.2 of [XSL] for details.
Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count andfo:hyphenation-ladder-count independent of each other within a style. A reasonable
default for fo:hyphenation-push-char-count in this case is no-limit.
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:hyphenation-ladder-count"><choice><value>no-limit</value><ref name="positiveInteger"/></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 601 of 738

15.5.15 Drop Caps
Use the <style:drop-cap> element to specify if the first character or more of a paragraph isdisplayed in a larger font. This element can be contained in a <style:paragraphproperties> element.
14714
14715
14716

<define name="style-paragraph-properties-elements" combine="interleave"><ref name="style-drop-cap"/></define>

14717
14718
14719
14720
14721
14722
14723
14724
14725

<define name="style-drop-cap"><optional><element name="style:drop-cap"><ref name="style-drop-cap-attlist"/><empty/></element></optional></define>

The attributes that may be associated with the <style:drop-cap> element are:•Length

•

Lines

•

Distance•

Text style

LengthThe style:length attribute specifies the number of characters that are dropped.
The value of this attribute can be a number or word, which indicates that the first word should be
dropped.
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735

<define name="style-drop-cap-attlist" combine="interleave"><optional><attribute name="style:length" a:defaultValue="1"><choice><value>word</value><ref name="positiveInteger"/></choice></attribute></optional></define>Lines
The style:lines attribute specifies the number of lines that the dropped characters should
encircle. If the value of this attribute is 1 or 0, drop caps is disabled.
14736
14737
14738
14739
14740
14741
14742

<define name="style-drop-cap-attlist" combine="interleave"><optional><attribute name="style:lines" a:defaultValue="1"><ref name="positiveInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 602 of 738

Distance
The style:distance attribute specifies the distance between the last dropped character andthe first of the remaining characters of each line. The value of this attribute is a length.
14743
14744
14745
14746
14747
14748
14749

<define name="style-drop-cap-attlist" combine="interleave"><optional><attribute name="style:distance" a:defaultValue="0cm"><ref name="length"/></attribute></optional></define>

Text Style
The style:style-name attribute specifies the text style to apply to the dropped characters.
14750
14751
14752
14753
14754
14755
14756

<define name="style-drop-cap-attlist" combine="interleave"><optional><attribute name="style:style-name"><ref name="styleNameRef"/></attribute></optional></define>

15.5.16 Register True
The style:register-true property specifies whether the lines on both sides of a printed page
match when a document is printed using two-sided printing, It also ensures that the text in page
columns or text box columns is arranged in such a way that the text baselines seem to run fromone column to another. See also section 15.2.12.
14757
14758
14759
14760
14761
14762
14763

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:register-true"><ref name="boolean"/></attribute></optional></define>

15.5.17 Left and Right Margins
Use the fo:margin-left and fo:margin-right properties to specify the left and rightmargins for a paragraph. See §7.10.3 and §7.10.4 of [XSL] for details. The attributes' values arelengths. If the attribute is contained in a common style, the attributes' values may be also
percentages. They here relate to the corresponding margin of the parent style.
For some applications. these two properties must be used simultaneously and also together withthe fo:text-indent property. If any of the properties is missing, its value is assumed to be
0cm.
14764
14765
14766

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/></define>

14767
14768
14769
14770
14771

<define name="common-horizontal-margin-attlist"><optional><attribute name="fo:margin-left"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 603 of 738

14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785

<ref name="length"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="fo:margin-right"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.5.18 Text Indent
Use the fo:text-indent property to specify a positive or negative indent for the first line of aparagraph. See §7.15.11 of [XSL] for details. The attribute's value is a length. If the attribute is
contained in a common style, the attribute's value may be also a percentage. It here relates to thecorresponding margin of the parent style.
For some applications. the fo:text-indent property must be used together with the
fo:margin-left and fo:margin-right properties. If any of these properties is missing, itsvalue is assumed to be 0cm.
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="fo:text-indent"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.5.19 Automatic Text Indent
Use the style:auto-text-indent property to specify that the first line of a paragraph isindented by a value that is based on the current font size.
For some applications. the style:auto-text-indent property must be used together with the
fo:margin-left and fo:margin-right properties. If any of these properties is missing, itsvalue is assumed to be 0cm.
If this property has a value of true and is used together with a fo:text-indent property, thenthe fo:text-indent property is ignored.
14796
14797
14798
14799
14800
14801
14802

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:auto-text-indent"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 604 of 738

15.5.20 Top and Bottom Margins
Use the fo:margin-top and fo:margin-bottom properties to specify the top and bottom
margins for paragraphs. See §7.10.1 and §7.10.2 of [XSL] for details. The attributes' values arelengths. If the attribute is contained in a common style, the attributes' values may be also
percentages. They here relate to the corresponding margin of the parent style.
For some applications. these two properties must be used simultaneously. If any of the properties
is missing, its value is assumed to be 0cm.
14803
14804
14805

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-vertical-margin-attlist"/></define>

14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824

<define name="common-vertical-margin-attlist"><optional><attribute name="fo:margin-top"><choice><ref name="nonNegativeLength"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="fo:margin-bottom"><choice><ref name="nonNegativeLength"/><ref name="percent"/></choice></attribute></optional></define>

15.5.21 Margins
Use the fo:margin property to specify the top, bottom, left and right margins for paragraphs
simultaneously. See §7.29.4 of [XSL] and sections 15.5.17 and 15.5.20 for details.
14825
14826
14827

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-margin-attlist"/></define>

14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838

<define name="common-margin-attlist"><optional><attribute name="fo:margin"><choice><ref name="nonNegativeLength"/><ref name="percent"/></choice></attribute></optional></define>

15.5.22 Break Before and Break After
Use the fo:break-before and fo:break-after properties to insert a page or column break
before or after a paragraph. See §7.19.1 and §7.19.2 of [XSL] for details. The values odd-pageand even-page are not supported.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 605 of 738

These two properties are mutually exclusive. If they are used simultaneously, the result isundefined.
14839
14840
14841

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-break-attlist"/></define>

14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862

<define name="common-break-attlist"><optional><attribute name="fo:break-before"><choice><value>auto</value><value>column</value><value>page</value></choice></attribute></optional><optional><attribute name="fo:break-after"><choice><value>auto</value><value>column</value><value>page</value></choice></attribute></optional></define>

15.5.23 Paragraph Background Color
Use the fo:background-color property to specify the background color of a paragraph. See§7.7.2 of [XSL] for details.
The value of this attribute can be either transparent or it can be a color. If the value istransparent, it switches off any background image that is specified by a<style:background-image> element simultaneously.
14863
14864
14865

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define>

14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876

<define name="common-background-color-attlist"><optional><attribute name="fo:background-color"><choice><value>transparent</value><ref name="color"/></choice></attribute></optional></define>

15.5.24 Paragraph Background Image
Use the <style:background-image> element to specify a background image for a paragraph.
The background image can be stored in one of the following ways (see also section 9.3.2):•

The image data is stored in an external file. Use the [XLink] attributes to specify the location of
the image.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 606 of 738

•

The image data is contained in an <office:binary-data> sub-element in BASE64
encoding.

If the <style:background-image> element is empty and if there is no color specified by an
fo:background-color element in the same properties element, the background color is set totransparent.
14877
14878
14879

<define name="style-paragraph-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892

<define name="style-background-image"><optional><element name="style:background-image"><ref name="style-background-image-attlist"/><choice><ref name="common-draw-data-attlist"/><ref name="office-binary-data"/><empty/></choice></element></optional></define>

The attributes that may be associated with the <style:background-image> element are:•

Repetition•

Position•

Filter•Opacity

Repetition
The style:repeat attribute specifies whether a background image is repeated or stretched in aparagraph.
This attribute is attached to the <style:background-image> element and its value can be
no-repeat, repeat, or stretch.
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903

<define name="style-background-image-attlist" combine="interleave"><optional><attribute name="style:repeat" a:defaultValue="repeat"><choice><value>no-repeat</value><value>repeat</value><value>stretch</value></choice></attribute></optional></define>

Position
The style:position attribute specifies where to position a background image in a paragraph.
This attribute is attached to the <style:background-image> element and its value can be a
space separated combination of top, center or bottom for the vertical position and left,

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 607 of 738

center or right for the horizontal position. The vertical and horizontal positions can be
specified in any order. If one position is specified, the other position defaults to center.
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924

<define name="style-background-image-attlist" combine="interleave"><optional><attribute name="style:position" a:defaultValue="center"><choice><value>left</value><value>center</value><value>right</value><value>top</value><value>bottom</value><list><ref name="horiBackPos"/><ref name="vertBackPos"/></list><list><ref name="vertBackPos"/><ref name="horiBackPos"/></list></choice></attribute></optional></define>

14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939

<define name="horiBackPos"><choice><value>left</value><value>center</value><value>right</value></choice></define><define name="vertBackPos"><choice><value>top</value><value>center</value><value>bottom</value></choice></define>

Filter
The style:filter-name attribute specifies the application specific filter name that is used toload the image into the document.
This attribute is attached to the <style:background-image> element.
14940
14941
14942
14943
14944
14945
14946

<define name="style-background-image-attlist" combine="interleave"><optional><attribute name="style:filter-name"><ref name="string"/></attribute></optional></define>

Opacity
The draw:opacity attribute specifies the opacity of the background image. The value is apercentage, where 0% is fully transparent and 100% is fully opaque.
14947<define name="style-background-image-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 608 of 738

14948
14949
14950
14951
14952
14953

<optional><attribute name="draw:opacity"><ref name="percent"/></attribute></optional></define>

15.5.25 Border
Use the border properties fo:border, fo:border-top, fo:border-bottom, fo:borderleft and fo:border-right to specify the border properties for paragraphs. See §7.29.3 §7.29.7 of [XSL] for details.
The fo:border property applies to all four sides of a paragraph while the other properties apply
to one side only.
For some applications, all four borders must be set simultaneously by using either the
fo:border property or by attaching all four of the other border properties to a properties
element. In the latter case, if one or more of the properties is missing their values are assumed to
be none.
There may be also restriction regarding the border styles and widths that are supported. In
addition to this, some applications may add a default padding for sides that have a border.
14954
14955
14956

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-border-attlist"/></define>

14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984

<define name="common-border-attlist"><optional><attribute name="fo:border"><ref name="string"/></attribute></optional><optional><attribute name="fo:border-top"><ref name="string"/></attribute></optional><optional><attribute name="fo:border-bottom"><ref name="string"/></attribute></optional><optional><attribute name="fo:border-left"><ref name="string"/></attribute></optional><optional><attribute name="fo:border-right"><ref name="string"/></attribute></optional></define>

15.5.26 Border Line Width
If the line style for a border is double, use the border line properties style:border-linewidth, style:border-line-width-top, style:border-line-width-bottom,

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 609 of 738

style:border-line-width-left and style:border-line-width-right to individuallyspecify the width of the inner and outer lines and the distance between them.
The style:border-line-width specifies the line widths of all four sides, while the otherattributes specify the line widths of one side only.
The value of the attributes can be a list of three space-separated lengths, as follows:•

The first value specifies the width of the inner line•

The second value specified the distance between the two lines•

The third value specifies the width of the outer line

The result of specifying a border line width without specifying a border width style of double forthe same border is undefined.
14985
14986
14987

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-border-line-width-attlist"/></define>

14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015

<define name="common-border-line-width-attlist"><optional><attribute name="style:border-line-width"><ref name="borderWidths"/></attribute></optional><optional><attribute name="style:border-line-width-top"><ref name="borderWidths"/></attribute></optional><optional><attribute name="style:border-line-width-bottom"><ref name="borderWidths"/></attribute></optional><optional><attribute name="style:border-line-width-left"><ref name="borderWidths"/></attribute></optional><optional><attribute name="style:border-line-width-right"><ref name="borderWidths"/></attribute></optional></define>

15016
15017
15018
15019
15020
15021
15022
15023

<define name="borderWidths"><list><ref name="positiveLength"/><ref name="positiveLength"/><ref name="positiveLength"/></list></define>

15.5.27 Padding
Use the padding properties fo:padding, fo:padding-top, fo:padding-bottom,
fo:padding-left and fo:padding-right to specify the spacing around a paragraph. See§7.29.15 and §7.7.35- §7.7.38 of [XSL] for details.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 610 of 738

For some application, the value of these properties can be a non-zero value only if there is aborder at the same side and the border is specified within the same properties element. If a
properties element contains a padding specification for one but not all four sides, some
applications may also assign a zero or a default padding to these sides depending on whether or
not there is a border at that side. There might be also other restriction regarding the combinationof borders and paddings.
15024
15025
15026

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-padding-attlist"/></define>

15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054

<define name="common-padding-attlist"><optional><attribute name="fo:padding"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="fo:padding-top"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="fo:padding-bottom"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="fo:padding-left"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="fo:padding-right"><ref name="nonNegativeLength"/></attribute></optional></define>

15.5.28 Shadow
Use the style:shadow property to specify a shadow effect for the paragraph.
The valid values for this attribute are the same as the values for the fo:text-shadow property.
See section 15.4.27 for information.
Some applications may only supports a limited number of shadow effects, for instance only one
effect where the the horizontal and vertical positions have the same value.
15055
15056
15057

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

15058
15059
15060
15061
15062
15063
15064
15065

<define name="common-shadow-attlist"><optional><attribute name="style:shadow"><ref name="shadowType"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 611 of 738

15.5.29 Keep with Next
Use the fo:keep-with-next property to specify whether or not to keep the current paragraphand the next paragraph together on a page or in a column after a break is inserted. See §7.9.14 of[XSL] for details. The only supported values are auto and always.
15066
15067
15068

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-keep-with-next-attlist"/></define>

15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079

<define name="common-keep-with-next-attlist"><optional><attribute name="fo:keep-with-next"><choice><value>auto</value><value>always</value></choice></attribute></optional></define>

15.5.30 Line Numbering
The text:number-lines attribute controls whether or not lines are numbered.
15080
15081
15082
15083
15084
15085
15086

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="text:number-lines" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

15.5.31 Line Number Start Value
The text:line-number property specifies a new start value for line numbering. The attribute is
only recognized if there is also a text:number-lines attribute with a value of true in thesame properties element.
15087
15088
15089
15090
15091
15092
15093

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="text:line-number"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.5.32 Text Autospace
Use the style:text-autospace property to specify whether to add space between Asian,western, and complex text.
The possible values are none and ideograph-alpha.
15094
15095
15096
15097
15098

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:text-autospace"><choice><value>none</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 612 of 738

15099
15100
15101
15102
15103

<value>ideograph-alpha</value></choice></attribute></optional></define>

15.5.33 Punctuation Wrap
Use the style:punctuation-wrap property to determine whether or not a punctuation mark, if
one is present, can be hanging, that is, whether it can placed in the margin area at the end of afull line of text. This is a common setting in East Asian typography.
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:punctuation-wrap"><choice><value>simple</value><value>hanging</value></choice></attribute></optional></define>

15.5.34 Line BreakUse the style:line-break property to select the set of line breaking rules to use for text. If thevalue is strict, line breaks are forbidden between certain user and application configurable
characters. If the value is normal, line breaks may occur between arbitrary characters.
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:line-break"><choice><value>normal</value><value>strict</value></choice></attribute></optional></define>

15.5.35 Vertical Alignment
The style:vertical-align property specifies the vertical position of a character. By default
characters are aligned according to their baseline, which is the default for most European
languages. This is also the alignment used in this specification. Alternatively, characters may bevertically aligned as follows:•bottom — To the bottom of the line.

•

top —To the top of the line.

•

middle —To the center of the line.

•

auto — Automatically, which sets the vertical alignment to suit the text rotation. Text that is
rotated 0 or 90 degrees is aligned to the baseline, while text that is rotated 270 degrees isaligned to the center of the line.

The following graphic illustrates the effect of the vertical alignment property when it is set tobaseline, top, bottom, and middle respectively.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 613 of 738

mgk mgk
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136

mgk mgk

mgk mgk

mgk mgk<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:vertical-align" a:defaultValue="auto"><choice><value>top</value><value>middle</value><value>bottom</value><value>auto</value><value>baseline</value></choice></attribute></optional></define>

15.5.36 Writing Mode
The style:writing mode attribute specifies the writing mode of a paragraph. The attribute issimilar to the writing-mode attribute specified in §7.27.7 of [XSL], except hat it has the
additional value page. This value specifies that the writing mode is inherited from the page that
contains the paragraph.
15137
15138
15139

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-writing-mode-attlist"/></define>

15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156

<define name="common-writing-mode-attlist"><optional><attribute name="style:writing-mode"><choice><value>lr-tb</value><value>rl-tb</value><value>tb-rl</value><value>tb-lr</value><value>lr</value><value>rl</value><value>tb</value><value>page</value></choice></attribute></optional></define>

15.5.37 Automatic Writing Mode
If the style:writing-mode-automatic attribute is given for a paragraph and if its value istrue, then an application is allowed to recalculate the writing mode of the paragraph based on its
content whenever the content changes. The actual value for the writing-mode should be containedin style:writing-mode attribute, so that applications that do not support an automatic writingmode calculation or use a different algorithm always know the actual value.
By specifying a fo:text-align='start' attribute additionally, the text alignment can beadapted to the writing mode simultaneously.
15157
15158

<define name="style-paragraph-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 614 of 738

15159
15160
15161
15162
15163

<attribute name="style:writing-mode-automatic"><ref name="boolean"/></attribute></optional></define>

15.5.38 Snap To Layout
The style:snap-to layout-grid attribute specifies whether the paragraph should consider
the layout grid settings of the page. See section 15.2.21.
15164
15165
15166
15167
15168
15169
15170

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:snap-to-layout-grid"><ref name="boolean"/></attribute></optional></define>

15.5.39 Page Number
If a paragraph style specifies a master page that should be applied beginning from the start of theparagraph, the style:page-number attribute specifies the page number that should be used for
new page.
The attribute value can be an integer value or the value auto. An integer value specifies the page
number of the new page directly. The value auto specifies that the page gets the page number ofthe previous page, incremented by one.
15171
15172
15173

<define name="style-paragraph-properties-attlist" combine="interleave"><ref name="common-page-number-attlist"/></define>

15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184

<define name="common-page-number-attlist"><optional><attribute name="style:page-number"><choice><ref name="positiveInteger"/><value>auto</value></choice></attribute></optional></define>

15.5.40 Background Transparency
15185
15186
15187
15188
15189
15190
15191

<define name="style-paragraph-properties-attlist" combine="interleave"><optional><attribute name="style:background-transparency"><ref name="percent"/></attribute></optional></define>

15.6 Ruby Text Formatting Properties
The properties described in this section can be used within ruby styles (see section 14.8.4 fordetails). They are contained in a <style:ruby-properties> element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 615 of 738

15192
15193
15194
15195
15196

<define name="style-ruby-properties"><element name="style:ruby-properties"><ref name="style-ruby-properties-content"/></element></define>

15197
15198
15199
15200

<define name="style-ruby-properties-content"><ref name="style-properties-content"/></define>

15201
15202
15203
15204
15205

<define name="style-ruby-properties-content-strict"><ref name="style-ruby-properties-attlist"/><ref name="style-ruby-properties-elements"/></define>

15206
15207
15208
15209

<define name="style-ruby-properties-elements"><empty/></define>

15.6.1 Ruby Position
This property specifies the position of the ruby text relative to the ruby base.
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219

<define name="style-ruby-properties-attlist" combine="interleave"><optional><attribute name="style:ruby-position"><choice><value>above</value><value>below</value></choice></attribute></optional></define>

15.6.2 Ruby Alignment
This property specifies the alignment of the ruby text relative to the ruby base.
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232

<define name="style-ruby-properties-attlist" combine="interleave"><optional><attribute name="style:ruby-align"><choice><value>left</value><value>center</value><value>right</value><value>distribute-letter</value><value>distribute-space</value></choice></attribute></optional></define>

15.7 Section Formatting Properties
The properties described in this section can be used within section styles (see section 14.8.3 fordetails). They are contained in a <style:section-properties> element.
15233
15234
15235

<define name="style-section-properties"><element name="style:section-properties"><ref name="style-section-properties-content"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 616 of 738

1523615237</element></define>

15238
15239
15240
15241

<define name="style-section-properties-content"><ref name="style-properties-content"/></define>

15242
15243
15244
15245
15246

<define name="style-section-properties-content-strict"><ref name="style-section-properties-attlist"/><ref name="style-section-properties-elements"/></define>

15.7.1 Section BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the section. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
15247
15248
15249
15250
15251
15252

<define name="style-section-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-section-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.7.2 Margins
The margins attributes fo:margin-left and fo:margin-right specify the size of the section
margins. See sections 15.5.17 for detailed information on these attributes. Percentage values are
not supported.
15253
15254
15255

<define name="style-section-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/></define>

15.7.3 Columns
The <style:columns> element contains <style:column> elements that specify eachcolumn individually (see section 15.7.4). If these elements are not present, all columns are
assigned the same width.
The <style:columns> can contain a <style:column-sep> element that describes theseparator line between columns. See section 15.7.5 for information on this element.
15256
15257
15258

<define name="style-section-properties-elements" combine="interleave"><ref name="style-columns"/></define>

15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269

<define name="style-columns"><optional><element name="style:columns"><ref name="style-columns-attlist"/><optional><ref name="style-column-sep"/></optional><zeroOrMore><ref name="style-column"/></zeroOrMore>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 617 of 738

1527015271
15272</element></optional></define>

The attributes that may be associated with the <style:columns> element are:•Column count•Column gap

Column CountThe fo:columns-count attribute specifies the number of columns in a section.
15273
15274
15275
15276
15277

<define name="style-columns-attlist" combine="interleave"><attribute name="fo:column-count"><ref name="positiveInteger"/></attribute></define>

Note: This attribute has the same name as an [XSL] property but it is attached toa different element.

Column Gap
If the <style:columns> element does not contain individual <style:column> elements, thenthe gap between columns may be specified by the fo:column-gap attribute. If there areindividual column elements, this attribute is ignored.
15278
15279
15280
15281
15282
15283
15284

<define name="style-columns-attlist" combine="interleave"><optional><attribute name="fo:column-gap"><ref name="length"/></attribute></optional></define>

Note: This attribute has the same name as an [XSL] property but it is attached toa different element.

15.7.4 Column Specification
The <style:column> element can be contained in a <style:columns> element, to specify
details of an individual column. This element is contained in the <styles:columns> element.
There can be either no column elements or there can be the same number of column elements as
specified by the fo:column-count attribute.
15285
15286
15287
15288
15289

<define name="style-column"><element name="style:column"><ref name="style-column-attlist"/></element></define>

Note: In [XSL], it is not possible to specify columns individually.
The attributes that may be associated with the <style:column> element are:•Column width

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 618 of 738

•Column left, right, upper, and lower space

Column Width
Use the style:rel-width attribute to specify the width of a column. The column widths are
specified as number values instead of lengths. To get the absolute column width, the space that isavailable for a columned area is distributed among the columns proportional to these numbers.
The column width is not specified in a percentage length, but rather in terms of relative weights,
that is, a number followed by a '*' character. The total space available for the entire table isdistributed among its columns according to its relative widths. For example, if three columns are
assigned the relative widths 1, 2 and 3, then the first column will take up 1/6 of the available width,
the second will take up 1/3, and the last column will take up 1/2 of the available space. To achievethese figures, all given relative widths must be summed up (six in the example), and then eachcolumn will get as much space as the proportion of its own relative width to the sum of all relative
widths indicates (3/6 = 1/2 for the last column in the example).
15290
15291
15292
15293
15294

<define name="style-column-attlist" combine="interleave"><attribute name="style:rel-width"><ref name="relativeLength"/></attribute></define>

Column Left, Right, Upper, and Lower SpaceFor each column, its left, right, upper, and lower space may be specified. The right space of acolumn together with the left space of the next column corresponds to the gap between twocolumns. If a columned area contains a separator line between columns, the space that is
occupied by the line is contained within the left and right spaces and therefore is not added to
them.
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322

<define name="style-column-attlist" combine="interleave"><optional><attribute name="fo:start-indent" a:defaultValue="0cm"><ref name="length"/></attribute></optional></define><define name="style-column-attlist" combine="interleave"><optional><attribute name="fo:end-indent" a:defaultValue="0cm"><ref name="length"/></attribute></optional></define><define name="style-column-attlist" combine="interleave"><optional><attribute name="fo:space-before" a:defaultValue="0cm"><ref name="length"/></attribute></optional></define><define name="style-column-attlist" combine="interleave"><optional><attribute name="fo:space-after" a:defaultValue="0cm"><ref name="length"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 619 of 738

15.7.5 Column Separator
The <style:column-sep> element specifies the separator line to use between columns. Thiselement can be contained in a <style:columns> element to specify the type of separator line touse between columns.
15323
15324
15325
15326
15327

<define name="style-column-sep"><element name="style:column-sep"><ref name="style-column-sep-attlist"/></element></define>

Note: [XSL] does not support column separators.
The attributes that may be associated with the <style:column-sep> element are:•Line style•Line width•Line height•

Vertical line alignment•

Line color

Line Style
Use the style:style attribute to specify the line style of the column separator line.
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340

<define name="style-column-sep-attlist" combine="interleave"><optional><attribute name="style:style" a:defaultValue="solid"><choice><value>none</value><value>solid</value><value>dotted</value><value>dashed</value><value>dot-dashed</value></choice></attribute></optional></define>Line Width
Use the style:width attribute to specify the width of the column separator line.
15341
15342
15343
15344
15345

<define name="style-column-sep-attlist" combine="interleave"><attribute name="style:width"><ref name="length"/></attribute></define>Line Height
Use the style:height to specify the height of the column separator line. The value of this
attribute is a percentage that relates to the height of the columned area.
15346<define name="style-column-sep-attlist" combine="interleave">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 620 of 738

15347
15348
15349
15350
15351
15352

<optional><attribute name="style:height" a:defaultValue="100%"><ref name="percent"/></attribute></optional></define>

Vertical Line Alignment
Use the style:vertical-align attribute to specify how to vertically align a line that is lessthan 100% of its height within the columned area. The value of this attribute can be either top,
middle, or bottom.
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363

<define name="style-column-sep-attlist" combine="interleave"><optional><attribute name="style:vertical-align" a:defaultValue="top"><choice><value>top</value><value>middle</value><value>bottom</value></choice></attribute></optional></define>Line Color
Use the style:color attribute to specify the color of the column separator line.
15364
15365
15366
15367
15368
15369
15370

<define name="style-column-sep-attlist" combine="interleave"><optional><attribute name="style:color" a:defaultValue="#000000"><ref name="color"/></attribute></optional></define>

15.7.6 Protect
Sections marked with the style:protect attribute should not be changed. The user interface
should prevent the user from manually making any changes. The style:protect attributeshould be set by default for linked sections or indexes. Removing the protection makes these
sections accessible to the user, but updating the links or the index will not preserve the changes.
15371
15372
15373
15374
15375
15376
15377

<define name="style-section-properties-attlist" combine="interleave"><optional><attribute name="style:protect" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

15.7.7 Don't Balance Text Columns
The text:dont-balance-text-columns attribute specifies whether the text column content should beevenly distributed over all text columns or not.
15378
15379

<define name="style-section-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 621 of 738

15380
15381
15382
15383
15384

<attribute name="text:dont-balance-text-columns"><ref name="boolean"/></attribute></optional></define>

15.7.8 Writing Mode
The style:writing-mode attribute specifies the writing mode that should be used for thesection. See section 15.5.36 for details.
15385
15386
15387

<define name="style-section-properties-attlist" combine="interleave"><ref name="common-writing-mode-attlist"/></define>

15.7.9 Notes Configuration
A section style may contain have its own notes configurations (see section 14.9.2). If this is thecase, notes of the corresponding notes type are displayed at the end of the columns of the sectionor the section itself instead of the end of the page's columns or the end of the document.
15388
15389
15390
15391
15392

<define name="style-section-properties-elements" combine="interleave"><zeroOrMore><ref name="text-notes-configuration"/></zeroOrMore></define>

15.8 Table Formatting Properties
The properties described in this section can be contained within table styles (see section 14.12.1)
They are contained in a <style:table-properties> element.
15393
15394
15395
15396
15397

<define name="style-table-properties"><element name="style:table-properties"><ref name="style-table-properties-content"/></element></define>

15398
15399
15400
15401

<define name="style-table-properties-content"><ref name="style-properties-content"/></define>

15402
15403
15404
15405
15406

<define name="style-table-properties-content-strict"><ref name="style-table-properties-attlist"/><ref name="style-table-properties-elements"/></define>

15.8.1 Table Width
Every table must have a fixed width. This width is specified by the style:width attribute.
The width of a table may be also specified relative to the width of the area that the table is in. In
this case, the width is specified as a percentage using the style:rel-width attribute. User
agents that support specifying the relative width of a table can specify widths in this way, but it is
not essential.
The reasons why every table must have a fixed width and relative widths are only an option are as
follows:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 622 of 738

•Specifying the width of a table by a percentage is useful for current web browsers and otherapplications where the percentage is relative to the width of a window. But it may cause
problems if the percentage relates to a fixed paper width.

•

Relative widths can also cause problems for applications such as spreadsheet applications,where there is no requirement for a table to fit on a page.

However, if an application supports relative widths, it is relatively easy to program the application
to calculate a fixed table width, based on a percentage.
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418

<define name="style-table-properties-attlist" combine="interleave"><optional><attribute name="style:width"><ref name="positiveLength"/></attribute></optional><optional><attribute name="style:rel-width"><ref name="percent"/></attribute></optional></define>

15.8.2 Table Alignment
A table alignment property table:align specifies the horizontal alignment of a table.
The options for a table alignment property are as follows:
left — The table aligns to the left.
center — The table aligns to the center.
right — The table aligns to the right.
margins — The table fills all the space between the left and right margins.
User agents that do not support the margins value, may treat this value as left.
•
•
•
•
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430

<define name="style-table-properties-attlist" combine="interleave"><optional><attribute name="table:align"><choice><value>left</value><value>center</value><value>right</value><value>margins</value></choice></attribute></optional></define>

15.8.3 Table Left and Right Margin
The fo:margin-left and fo:margin-right properties specify the distance of the table fromthe left and right margins. See section 15.5.17 for a full explanation of left and right margin
properties. An application may recognize table margins, but this is not essential.
Tables that align to the left or to the center ignore right margins, and tables align to the right or tothe center ignore left margins.
15431
15432
15433

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 623 of 738

15.8.4 Table Top and Bottom Margin
The fo:margin-top and fo:margin-bottom properties specify the distance of the table fromthe top and bottom. See section 15.5.20 for a full explanation of top and bottom margin properties.
15434
15435
15436

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-vertical-margin-attlist"/></define>

15.8.5 Table Margins
The fo:margin property specifies the distance of the table from the left, right, top and bottom.
See section 15.5.21 for a full explanation of this property.
15437
15438
15439

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-margin-attlist"/></define>

15.8.6 Page Number
If the table style specifies a master page that should be applied beginning from the start of thetable, the style:page-number attribute specifies the page number that should be used for the
first page of the table. See also section 15.5.39.
15440
15441
15442

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-page-number-attlist"/></define>

15.8.7 Break Before and Break After
The fo:break-before and fo:break-after properties insert a page or column break before
or after a table. See section 15.5.22 for a full explanation of these properties.
15443
15444
15445

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-break-attlist"/></define>

15.8.8 Table Background and Background Image
The background attribute fo:background-color and the background element<style:background-image> specify the background properties of the table. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
15446
15447
15448
15449
15450
15451

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-table-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.8.9 Table Shadow
The style:shadow property specifies that a shadow visual effect appears on a table. See
section 15.5.28 for a full explanation of this property.
15452
15453
15454

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 624 of 738

15.8.10 Keep with Next
The fo:keep-with-next property specifies that a table stays with the paragraph that follows it.
See section 15.5.29 for a full explanation of this property.
15455
15456
15457

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-keep-with-next-attlist"/></define>

15.8.11 May Break Between Rows
The style:may-break-between-rows property specifies that a page break may occur inside
a table.
15458
15459
15460
15461
15462
15463
15464

<define name="style-table-properties-attlist" combine="interleave"><optional><attribute name="style:may-break-between-rows"><ref name="boolean"/></attribute></optional></define>

15.8.12 Border Model Property
The table:border-model property specifies what border model to use when creating a tablewith a border. There are two types of border model, as follows:•Collapsing border model
When two adjacent cells have different borders, the wider border appears as the border
between the cells. Each cell receives half of the width of the border.

•

Separating border model
Borders appear within the cell that specifies the border.

Both border models are very similar to the collapsing and separating border models of [XSL] and[CSS2]. They differ in how border widths relate to row and column widths.
In OpenDocument, a row height or column width includes any space required to display borders or
padding. This means that, while the width and height of the content area is less than the column
width and row height, the sum of the widths of all columns is equal to the total width of the table.
In XSL and CSS2, a column width or row height specifies the width or height of the content areaof a cell. This means that the sum of the widths of all columns is less than the width of the table.
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474

<define name="style-table-properties-attlist" combine="interleave"><optional><attribute name="table:border-model"><choice><value>collapsing</value><value>separating</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 625 of 738

15.8.13 Writing Mode
The style:writing-mode attribute specifies the writing mode that should is used for the table.
See section 15.5.36 for details.
15475
15476
15477

<define name="style-table-properties-attlist" combine="interleave"><ref name="common-writing-mode-attlist"/></define>

15.8.14 Display
The table:display attribute specifies whether or not a table is displayed.
15478
15479
15480
15481
15482
15483
15484

<define name="style-table-properties-attlist" combine="interleave"><optional><attribute name="table:display"><ref name="boolean"/></attribute></optional></define>

15.9 Column Formatting Properties
The properties described in this section can be contained within table column styles (see section
14.12.2) They are contained in a <style:table-column-properties> element.
15485
15486
15487
15488
15489

<define name="style-table-column-properties"><element name="style:table-column-properties"><ref name="style-table-column-properties-content"/></element></define>

15490
15491
15492
15493

<define name="style-table-column-properties-content"><ref name="style-properties-content"/></define>

15494
15495
15496
15497
15498

<define name="style-table-column-properties-content-strict"><ref name="style-table-column-properties-attlist"/><ref name="style-table-column-properties-elements"/></define>

15499
15500
15501
15502

<define name="style-table-column-properties-elements"><empty/></define>

15.9.1 Column Width
Every table column must have a fixed width. This width is specified by the style:columnwidth attribute.
The width of a column may be also specified relative to the other column widths. Applications that
support specifying the relative width of a column may specify widths in this way, but it is notessential.
A relative width is specified by the style:rel-column-width property that takes a number
value, followed by a '*' character. If rc is the relative with of the column, rs the sum of all relative
columns widths, and ws the absolute width that is available for these columns, then the absolutewith wc of the column is wc=rcws/rs.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 626 of 738

15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514

<define name="style-table-column-properties-attlist" combine="interleave"><optional><attribute name="style:column-width"><ref name="positiveLength"/></attribute></optional><optional><attribute name="style:rel-column-width"><ref name="relativeLength"/></attribute></optional></define>

15.9.2 Optimal Table Column Width
The style:use-optimal-column-width attribute specifies that the column width should berecalculated automatically if some content in the column changes.
15515
15516
15517
15518
15519
15520
15521

<define name="style-table-column-properties-attlist" combine="interleave"><optional><attribute name="style:use-optimal-column-width"><ref name="boolean"/></attribute></optional></define>

15.9.3 Break Before and Break After
The fo:break-before and fo:break-after properties insert a page or column break before
or after a table column. See section 15.5.22 for a full explanation of these properties.
15522
15523
15524

<define name="style-table-column-properties-attlist" combine="interleave"><ref name="common-break-attlist"/></define>

15.10 Table Row Formatting Properties
The properties described in this section can be contained within table row styles (see section
14.12.3) They are contained in a <style:table-row-properties> element.
15525
15526
15527
15528
15529

<define name="style-table-row-properties"><element name="style:table-row-properties"><ref name="style-table-row-properties-content"/></element></define>

15530
15531
15532
15533

<define name="style-table-row-properties-content"><ref name="style-properties-content"/></define>

15534
15535
15536
15537
15538

<define name="style-table-row-properties-content-strict"><ref name="style-table-row-properties-attlist"/><ref name="style-table-row-properties-elements"/></define>

15.10.1 Row HeightThe style:row-height and style:min-row-height properties specifies the height of atable row. By default, the row height is the height of the tallest item in the row.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 627 of 738

The style:row-height property specifies a fixed row height, while the style:min-rowheight property specifies a fixed height.
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550

<define name="style-table-row-properties-attlist" combine="interleave"><optional><attribute name="style:row-height"><ref name="positiveLength"/></attribute></optional><optional><attribute name="style:min-row-height"><ref name="nonNegativeLength"/></attribute></optional></define>

15.10.2 Optimal Table Row HeightThe style:use-optimal-row-height attribute specifies that the row height should berecalculated automatically if some content in the row changes.
15551
15552
15553
15554
15555
15556
15557

<define name="style-table-row-properties-attlist" combine="interleave"><optional><attribute name="style:use-optimal-row-height"><ref name="boolean"/></attribute></optional></define>

15.10.3 Row BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the table. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
15558
15559
15560
15561
15562
15563

<define name="style-table-row-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-table-row-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.10.4 Break Before and Break After
The fo:break-before and fo:break-after properties insert a page or row break before orafter a table row. See section 15.5.22 for a full explanation of these properties.
15564
15565
15566

<define name="style-table-row-properties-attlist" combine="interleave"><ref name="common-break-attlist"/></define>

15.10.5 Keep Together
Use the fo:keep-together property to control whether the contents of a table cell should be
kept together on the same page or column (if the value is always), or whether breaks areallowed within the cell (if the value is auto). See §7.19.3 of [XSL] for details.
15567
15568

<define name="style-table-row-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 628 of 738

15569
15570
15571
15572
15573
15574
15575
15576

<attribute name="fo:keep-together"><choice><value>auto</value><value>always</value></choice></attribute></optional></define>

15.11 Table Cell Formatting Properties
The properties described in this section can be contained within table cell styles (see section
14.12.4) They are contained in a <style:table-column-properties> element.
15577
15578
15579
15580
15581

<define name="style-table-cell-properties"><element name="style:table-cell-properties"><ref name="style-table-cell-properties-content"/></element></define>

15582
15583
15584
15585

<define name="style-table-cell-properties-content"><ref name="style-properties-content"/></define>

15586
15587
15588
15589
15590

<define name="style-table-cell-properties-content-strict"><ref name="style-table-cell-properties-attlist"/><ref name="style-table-cell-properties-elements"/></define>

15.11.1 Vertical Alignment
The vertical alignment property style:vertical-align is used to specify the verticalalignment of text in a table cell.
The options for the vertical alignment property are as follows:
•
•
•
•
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602

top — Aligns text vertically with the top of the cell.
middle — Aligns text vertically with the middle of the cell.
bottom — Aligns text vertically with the bottom of the cell.
automatic – The application decide how to align the text.

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:vertical-align"><choice><value>top</value><value>middle</value><value>bottom</value><value>automatic</value></choice></attribute></optional></define>

15.11.2 Text Align Source
The style:text-align-source property specifies the source of the text-align property. If thevalue of this attribute is fix, the value of the fo:text-align property is used. If the value isvalue-type, the text alignment depends on the value-type of the cell.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 629 of 738

15603
15604
15605
15606
15607
15608
15609
15610
15611
15612

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:text-align-source"><choice><value>fix</value><value>value-type</value></choice></attribute></optional></define>

15.11.3 Direction
The style:direction property specifies the direction of characters in a cell. The mostcommon direction is left to right (ltr). The other direction is top to bottom (ttb), where thecharacters in the cell are stacked but not rotated.
15613
15614
15615

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-style-direction-attlist"/></define>

15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626

<define name="common-style-direction-attlist"><optional><attribute name="style:direction"><choice><value>ltr</value><value>ttb</value></choice></attribute></optional></define>

15.11.4 Vertical Glyph Orientation
The style:glyph-orientation-vertical property specifies the vertical glyph orientation.
The property specifies an angle or automatic mode. The only possible angle is 0, which disables
this feature.
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:glyph-orientation-vertical"><choice><value>auto</value><value>0</value></choice></attribute></optional></define>

15.11.5 Cell Shadow
The style:shadow property specifies that a shadow visual effect appears on a table cell. See
section 15.5.28 for a full explanation of this property.
15637
15638
15639

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 630 of 738

15.11.6 Cell BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the table cell. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
15640
15641
15642
15643
15644
15645

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-table-cell-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.11.7 Cell Border
The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-leftand fo:border-right specify the border properties of the table cell. See section 15.5.25 fordetailed information on these attributes.
15646
15647
15648

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-border-attlist"/></define>

15.11.8 Diagonal Lines
Spreadsheet cells can also have diagonal lines, which follow the same specification as borders.
style:diagonal-tl-br defines the style of "border" to use for the topleft-bottomright diagonal(see section 15.5.25 for detailed information). In case of a double line, style:diagonal-bltr-widths allows to specify the width of the inner and outer lines and the distance between
them (see section 15.5.26 for detailed information).
style:diagonal-bl-tr and style:diagonal-tl-br-widths define the same properties
for the bottomleft-topright diagonal.
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:diagonal-tl-br"><ref name="string"/></attribute></optional><optional><attribute name="style:diagonal-tl-br-widths"><ref name="borderWidths"/></attribute></optional><optional><attribute name="style:diagonal-bl-tr"><ref name="string"/></attribute></optional><optional><attribute name="style:diagonal-bl-tr-widths"><ref name="borderWidths"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 631 of 738

15.11.9 Border Line Width
The border line width attributes style:border-line-width, style:border-line-widthtop, style:border-line-width-bottom, style:border-line-width-left andstyle:border-line-width-right specify the properties of the border lines of the page. See
section 15.5.26 for detailed information on these attributes.
15671
15672
15673

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-border-line-width-attlist"/></define>

15.11.10 Padding
The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the table cell. See section
15.5.27 for detailed information on these attributes.
15674
15675
15676

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-padding-attlist"/></define>

15.11.11 Wrap Option
The fo:wrap-option property specifies whether text wraps within a table cell. See §7.5.13 of[XSL] for details. If wrapping is disabled, the application determines whether the clipped text isvisible or hidden. If the text is hidden applications may support a scrolling mechanism to accessthe text. This is similar to setting a fo:overflow property to a value of auto. See also §7.20.2of [XSL].
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="fo:wrap-option"><choice><value>no-wrap</value><value>wrap</value></choice></attribute></optional></define>

15.11.12 Rotation Angle
The style:rotation-angle property specifies the rotation angle of the cell content indegrees.
15687
15688
15689

<define name="style-table-cell-properties-attlist" combine="interleave"><ref name="common-rotation-angle-attlist"/></define>

15690
15691
15692
15693
15694
15695
15696
15697

<define name="common-rotation-angle-attlist"><optional><attribute name="style:rotation-angle"><ref name="nonNegativeInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 632 of 738

15.11.13 Rotation Align
The style:rotation-align property specifies how the edge of the text in a cell is aligned
after a rotation. There are four alignment options: "none", "bottom", "top", or "center".
Alignment

Text is...

Borders and background are...

None.

Rotated.

Unchanged.

Bottom of the cell.

Rotated and may overlap withother cells if the text is longer
than the length of the cell.

Positioned parallel to the text, whereby
the upper or lower edge is drawn at theoriginal position of the cell.

Top of the cell.
Center of the cell.
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:rotation-align"><choice><value>none</value><value>bottom</value><value>top</value><value>center</value></choice></attribute></optional></define>

15.11.14 Cell Protect
The style:cell-protect property specifies how a cell is protected.
This attribute is only evaluated if the current table is protected (see section 8.1.1). The value ofthe attribute can be "none", "hidden-and-protected", or a space-separated list containing thevalues "protected" or "formula-hidden".
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:cell-protect"><choice><value>none</value><value>hidden-and-protected</value><list><oneOrMore><choice><value>protected</value><value>formula-hidden</value></choice></oneOrMore></list></choice></attribute></optional></define>

15.11.15 Print Content
The style:print-content property specifies whether or not the cell content is printed.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 633 of 738

15728
15729
15730
15731
15732
15733
15734

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:print-content"><ref name="boolean"/></attribute></optional></define>

15.11.16 Decimal places
The style:decimal-places attribute specifies the maximum number of decimal places thatare displayed if numbers are formatted by a data style that has no setting for number of decimal
places itself. See also section 14.7.9.
This property is usually only evaluated if it is contained in a default style (see section 14.2).
15735
15736
15737
15738
15739
15740
15741

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:decimal-places"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.11.17 Repeat Content
The style:repeat-content property specifies whether the content of a cell is displayed as
many times as there is space left in the cell's writing direction. Only full instances of the text are
displayed. The property has no effect for cell content that contains a line break. This property isfor instance used to "fill" a table cell with "-" or "x" characters so that no other data can be entered.
15742
15743
15744
15745
15746
15747
15748

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:repeat-content"><ref name="boolean"/></attribute></optional></define>

15.11.18 Shrink To Fit
The style:shrink-to-fit property specifies whether the content of a cell, if necessary, gets
shrunk to fit into the cell. Shrinking does mean that the cell's font size is decreased, so that thecomplete text fits into the cell. The property has no effect on cells where the cell content fits
already into the cell.
15749
15750
15751
15752
15753
15754
15755

<define name="style-table-cell-properties-attlist" combine="interleave"><optional><attribute name="style:shrink-to-fit"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 634 of 738

15.12 List-Level Style Properties
The properties described in this section can be contained within the various list style levelelements (see section 14.10). They are contained in a <style:list-level-properties>
element.
15756
15757
15758
15759
15760

<define name="style-list-level-properties"><element name="style:list-level-properties"><ref name="style-list-level-properties-content"/></element></define>

15761
15762
15763
15764

<define name="style-list-level-properties-content"><ref name="style-properties-content"/></define>

15765
15766
15767
15768
15769
15770
15771
15772
15773

<define name="style-list-level-properties-content-strict"><ref name="style-list-level-properties-attlist"/><ref name="style-list-level-properties-elements"/></define><define name="style-list-level-properties-elements"><empty/></define>

Label Alignment
The fo:text-align attribute specifies the horizontal alignment of a label (number) within thewidth specified by the text:min-label-width attribute. See also section 15.5.5,
15774
15775
15776

<define name="style-list-level-properties-attlist" combine="interleave"><ref name="common-text-align"/></define>

Start Indent
The text:space-before attribute specifies the space to include before the number for all
paragraphs at this level. If a paragraph has a left margin that is greater than 0, the actual positionof the list label box is the left margin width plus the start indent value.
This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element.
The value of the attribute is an absolute value. This means that when the position of a label iscalculated the start indent value of the current level is only considered. The start indent values forlower levels do not affect the label position.
15777
15778
15779
15780
15781
15782
15783

<define name="style-list-level-properties-attlist" combine="interleave"><optional><attribute name="text:space-before"><ref name="nonNegativeLength"/></attribute></optional></define>

Minimum Label Width
The text:min-label-width attribute specifies the minimum width of a number.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 635 of 738

This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element.
The label can be aligned horizontally with the width using an fo:text-align property. See theLabel Alignment attribute below for more information.
15784
15785
15786
15787
15788
15789
15790

<define name="style-list-level-properties-attlist" combine="interleave"><optional><attribute name="text:min-label-width"><ref name="nonNegativeLength"/></attribute></optional></define>

Minimum Label Distance
The text:min-label-distance attribute specifies the minimum distance between the number
and the text of the list item.
This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element.
15791
15792
15793
15794
15795
15796
15797

<define name="style-list-level-properties-attlist" combine="interleave"><optional><attribute name="text:min-label-distance"><ref name="nonNegativeLength"/></attribute></optional></define>

Font Name
The style:font-name attribute species the name of a font that is used to display a bullet
character. See also section 15.4.13.
15798
15799
15800
15801
15802
15803
15804

<define name="style-list-level-properties-attlist" combine="interleave"><optional><attribute name="style:font-name"><ref name="string"/></attribute></optional></define>

Image Size
The size of the image is specified by the following attributes:
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816

<define name="style-list-level-properties-attlist" combine="interleave"><optional><attribute name="fo:width"><ref name="positiveLength"/></attribute></optional><optional><attribute name="fo:height"><ref name="positiveLength"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 636 of 738

Vertical Alignment
The vertical alignment of the image is specified by the style:vertical-pos and style:verticalrel properties. See sections 15.27.11 and 15.27.12 for details.
15817
15818
15819
15820

<define name="style-list-level-properties-attlist" combine="interleave"><ref name="common-vertical-rel-attlist"/><ref name="common-vertical-pos-attlist"/></define>

15.13 Stroke Properties
The following stroke properties are used to define drawing object line characteristics. They areavailable for drawing objects contained in all kinds of applications.
•

Style

•

Dash

•

Width

•

Color

•

Start marker•

End marker•

Start marker width•

End marker width•Start marker center•

End marker center•

Opacity•

Joint

The properties described in this section can be contained within style elements <style:style>whose family is either graphic or presentation. They are contained in a <style:graphicproperties> element.

15.13.1 Stroke Style
The attribute draw:stroke specifies the style of the stroke on the current object. The valuenone means that no stroke is drawn, and the value solid means that a solid stroke is drawn. If
the value is dash, the stroke referenced by the draw:stroke-dash property is drawn.
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:stroke"><choice><value>none</value><value>dash</value><value>solid</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 637 of 738

15.13.2 Dash
The attribute draw:stroke-dash specifies the dash style that is used for the stroke. See
section 14.14.7 for dash styles.
15832
15833
15834
15835
15836
15837
15838

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:stroke-dash"><ref name="styleNameRef"/></attribute></optional></define>

15.13.3 Multiple Dashes
The attribute draw:stroke-dash-names specifies a list of dash styles that are used for the
stroke in addition to the dash specified by the draw:stroke-dash attribute. See section 15.13.2
for the draw:stroke-dash attribute and section 14.14.7 for dash styles.
15839
15840
15841
15842
15843
15844
15845

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:stroke-dash-names"><ref name="styleNameRefs"/></attribute></optional></define>

15.13.4 Width
The attribute svg:stroke-width specifies the width of the stroke on the current object.
15846
15847
15848
15849
15850
15851
15852

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="svg:stroke-width"><ref name="length"/></attribute></optional></define>

15.13.5 Color
The attribute svg:stroke-color specifies the color of the stroke on the current object.
15853
15854
15855
15856
15857
15858
15859

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="svg:stroke-color"><ref name="color"/></attribute></optional></define>

15.13.6 Start Marker
The attribute draw:marker-start specifies a line start marker, which is a path that can beconnected to the start of a stroke. See section 14.14.6 for markers.
15860
15861
15862

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-start">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 638 of 738

15863
15864
15865
15866

<ref name="styleNameRef"/></attribute></optional></define>

15.13.7 End Marker
The attribute draw:marker-end specifies a stroke end marker, which is a path that can beconnected to the end of a stroke. See section 14.14.6 for markers.
15867
15868
15869
15870
15871
15872
15873

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-end"><ref name="styleNameRef"/></attribute></optional></define>

15.13.8 Start Marker Width
The attribute draw:marker-start-width specifies the width of the marker at the start of thestroke.
15874
15875
15876
15877
15878
15879
15880

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-start-width"><ref name="length"/></attribute></optional></define>

15.13.9 End Marker Width
The attribute draw:marker-end-width specifies the width of the marker at the end of thestroke.
15881
15882
15883
15884
15885
15886
15887

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-end-width"><ref name="length"/></attribute></optional></define>

15.13.10 Start Marker Center
The attribute draw:marker-start-center specifies whether or not a start marker is centeredat the start of a stroke.
15888
15889
15890
15891
15892
15893
15894

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-start-center"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 639 of 738

15.13.11 End Marker Center
The attribute draw:marker-end-center specifies whether or not an end marker is centered at
the end of a stroke.
15895
15896
15897
15898
15899
15900
15901

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:marker-end-center"><ref name="boolean"/></attribute></optional></define>

15.13.12 Opacity
The attribute svg:stroke-opacity specifies the opacity of a stroke. The value of this attributecan be a number between 0 (fully transparent) and 1 (fully opaque) or a percentage.
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="svg:stroke-opacity"><choice><data type="double"><param name="minInclusive">0</param><param name="maxInclusive">1</param></data><ref name="percent"/></choice></attribute></optional></define>

15.13.13 Line Join
The attribute draw:stroke-linejoin specifies the shape at the corners of paths or othervector shapes, when they are stroked. The values are the same as for [SVG]'s strokelinejoin attribute, except that the attribute in addition to the values supported by SVG may
have the value middle, which means that the mean value between the joints is used.
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:stroke-linejoin"><choice><value>miter</value><value>round</value><value>bevel</value><value>middle</value><value>none</value><value>inherit</value></choice></attribute></optional></define>

15.14 Fill Properties
The following fill properties are used to define drawing object fill characteristics. They areavailable for drawing objects contained in all kinds of applications.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 640 of 738

•

Style

•

Color

•

Gradient•

Gradient step count

•

Hatch

•

Solid hatch•

Bitmap•Opacity•

Fill rule15.14.1 Fill Style
The attribute draw:fill specifies the fill style for a graphic object. Graphic objects that are notclosed, such as a path without a closepath at the end, will not be filled. The fill operation does
not automatically close all open subpaths by connecting the last point of the subpath with the firstpoint of the subpath before painting the fill. The attribute has the following values:

15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941

•

none: the drawing object is not filled.

•

solid: the drawing object is filled with color specified by the draw:fill-color attribute.

•bitmap: the drawing object is filled with the bitmap specified by the draw:fill-imagename attribute.

•

gradient: the drawing object is filled with the gradient specified by the draw:fillgradient-name attribute.

•hatch: the drawing object is filled with the hatch specified by the draw:fill-hatch-nameattribute.

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill"><choice><value>none</value><value>solid</value><value>bitmap</value><value>gradient</value><value>hatch</value></choice></attribute></optional></define>

15.14.2 Color
The attribute draw:fill-color specifies the color of the fill for a graphic object. It is used only
if the draw:fill attribute has the value solid.
15942
15943
15944
15945

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-color"><ref name="color"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 641 of 738

1594615947
15948</attribute></optional></define>

15.14.3 Secondary Fill Color
The draw:secondary-fill-color attribute specifies the secondary fill color. It may be usedas fill color for the extrusion.
15949
15950
15951
15952
15953
15954
15955

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:secondary-fill-color"><ref name="color"/></attribute></optional></define>

15.14.4 Gradient
The attribute draw:fill-gradient-name specifies a gradient style that is used for fillinggraphic objects. It is used only if the draw:fill attribute has the value gradient. See section
14.14.1 and 14.14.2 for gradients.
15956
15957
15958
15959
15960
15961
15962

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-gradient-name"><ref name="styleNameRef"/></attribute></optional></define>

15.14.5 Gradient Step CountIf a gradient is used for filling, the attribute draw:gradient-step-count can be used to set
the gradient step count of the color interpolation to be a fixed value. By default, the step count is
automatically calculated based on the size and resolution of the filled area.
A step count less than 3 is not valid as there would be no interpolation possible. Values above 256
may not be supported or may result in performance issues.
15963
15964
15965
15966
15967
15968
15969

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:gradient-step-count"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.14.6 Hatch
The attribute draw:fill-hatch-name specifies a hatch style that is used for filling. It is used
only if the draw:fill attribute has the value hatch. See section 14.14.3 for hatches.
15970
15971
15972
15973
15974

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-hatch-name"><ref name="styleNameRef"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 642 of 738

1597515976</optional></define>

15.14.7 Solid Hatch
The attribute draw:fill-hatch-solid specifies whether the background of a hatch filling issolid or transparent.
15977
15978
15979
15980
15981
15982
15983

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-hatch-solid"><ref name="boolean"/></attribute></optional></define>

15.14.8 Fill Image
The attribute draw:fill-image-name specifies a fill image that is used for filling. It is used only
if the draw:fill attribute has the value bitmap. See section 14.14.4 for fill images.
15984
15985
15986
15987
15988
15989
15990

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-image-name"><ref name="styleNameRef"/></attribute></optional></define>

15.14.9 Fill Image Rendering Style
If an image is used for filling, the bitmap image can either be rendered in the given size, stretchedto the filled area, or tiled over the area. The attribute style:repeat specifies how the bitmap
image should be treated.
The value of the attribute can be no-repeat, repeat, or stretch.
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="style:repeat"><choice><value>no-repeat</value><value>repeat</value><value>stretch</value></choice></attribute></optional></define>

15.14.10 Fill Image Size
If an image is used for filling, the optional attributes draw:fill-image-width anddraw:fill-image-height can be used to override the logical size of the source image data. If
the value of the style:repeat attribute is stretch, these attributes are ignored.
16002
16003
16004

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-image-width">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 643 of 738

16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019

<choice><ref name="length"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="draw:fill-image-height"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.14.11 Fill Image Tile Reference Point
If an image is used for filling, the attributes draw:fill-image-ref-point, draw:fillimage-ref-point-x and draw:fill-image-ref-point-y specify the reference position of
the image. The draw:fill-image-ref-point attribute specifies the position as an alignmentof the image within the filling area, while the draw:fill-image-ref-point-x anddraw:fill-image-ref-point-y attributes specify an horizontal and vertical movement aspercentage values, where the percentage value relates to the image width and height. If analignment and a movement is specified at the same time, the image first is aligned and afterwards
moved.
These attributes are only interpreted if the value of the current style:repeat attribute isrepeat.
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:fill-image-ref-point-x"><ref name="percent"/></attribute></optional><optional><attribute name="draw:fill-image-ref-point-y"><ref name="percent"/></attribute></optional><optional><attribute name="draw:fill-image-ref-point"><choice><value>top-left</value><value>top</value><value>top-right</value><value>left</value><value>center</value><value>right</value><value>bottom-left</value><value>bottom</value><value>bottom-right</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 644 of 738

15.14.12 Fill Image Tile Translation
If an image is used for filling, the attribute draw:tile-repeat-offset defines the translationof each tile in relation to the previous tile. This attribute is only interpreted if the value of thecurrent style:repeat attribute is tiled. The value of this attribute is a percentage value
representing the tiles repeat offset relative to the tiles height or width, followed by either the word
horizontal or vertical.
16047
16048
16049
16050
16051

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:tile-repeat-offset"/></optional></define>

Example: Tile translation<style:graphic-properties draw:tile-repeat-offset="50% horizontal"/>15.14.13 None and Linear Opacity
The fill area of a graphic object can either have a full, a linear, or gradient opacity. Full and linear
opacity is selected using the draw:opacity attribute, while gradient opacity is selected using thedraw:opacity-name attribute.
The draw:opacity attribute disables any transparency effect or sets a linear opacity for the fillarea of a graphic object.
16052
16053
16054
16055
16056
16057
16058

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:opacity"><ref name="percent"/></attribute></optional></define>

15.14.14 Gradient Opacity
The draw:opacity-name attribute specifies an opacity gradient that defines the opacity for thefill area of a graphic object. When applying an opacity gradient, the opacity is interpolated as
defined in the referenced opacity gradient style. This fill style is rendered independently from otherfill styles like gradient, image, and hatch. See section 14.14.5 for opacity gradients.
The value of this attribute overrides the draw:opacity attribute.
16059
16060
16061
16062
16063
16064
16065

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional><attribute name="draw:opacity-name"><ref name="styleNameRef"/></attribute></optional></define>

15.14.15 Fill Rule
The svg:fill-rule specifies the algorithm which is to be used to determine what parts of thecanvas are included inside the shape. See §11.3 of [SVG] for more details.
16066
16067

<define name="style-graphic-fill-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 645 of 738

16068
16069
16070
16071
16072
16073
16074
16075

<attribute name="svg:fill-rule"><choice><value>nonzero</value><value>evenodd</value></choice></attribute></optional></define>

15.14.16 Symbol color
The draw:symbol-color attribute defines the color to be used to draw symbols contained on
the drawing object. This could be for instance arrows displayed within a control.
16076
16077
16078
16079
16080
16081
16082

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:symbol-color"><ref name="color"/></attribute></optional></define>

15.15 Text Animation Properties
Drawing objects that contain text and text boxes can have optional text animation properties.
These properties always animate the complete text of a drawing object or text frame. The
following attributes define the text animation:•

Animation•

Animation direction•

Animation start inside•

Animation stop inside•

Animation repeat•

Animation delay•

Animation steps

These properties are available for drawing objects contained in all kinds of applications.

15.15.1 Animation
The attribute text:animation specifies the type of animation that is used for the text.
The value of this attribute can be one of the following:

16083
16084

•

none, disables the text animation.

•

scroll, scrolls the text from one side to another.

•alternate, scrolls the text from one side to another and back.

•slide, scrolls the text from one side to the original text position and stops there.

<define name="style-graphic-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 646 of 738

16085
16086
16087
16088
16089
16090
16091
16092
16093
16094

<attribute name="text:animation"><choice><value>none</value><value>scroll</value><value>alternate</value><value>slide</value></choice></attribute></optional></define>

15.15.2 Animation Direction
The attribute text:animation-direction specifies the scroll direction of animated text.
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-direction"><choice><value>left</value><value>right</value><value>up</value><value>down</value></choice></attribute></optional></define>

15.15.3 Animation Start Inside
If this attribute text:animation-start-inside is true, the text starts its animation inside
the shape. If its false, the text starts its animation just outside the shapes bounding rectangle.
16107
16108
16109
16110
16111
16112
16113

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-start-inside"><ref name="boolean"/></attribute></optional></define>

15.15.4 Animation Stop Inside
If this attribute text:animation-stop-inside is true, the text stops when it is inside the theshape. If its false, the text stops its animation just outside the shapes bounding rectangle.
16114
16115
16116
16117
16118
16119
16120

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-stop-inside"><ref name="boolean"/></attribute></optional></define>

15.15.5 Animation Repeat
The attribute text:animation-repeat specifies the number of times the animation isrepeated. If the value of the attribute is 0, the animation is repeated indefinitely.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 647 of 738

16121
16122
16123
16124
16125
16126
16127

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-repeat"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.15.6 Animation Delay
The attribute text:animation-delay specifies a delay before the animation is started. The
value of this attribute must conform to the time period format described in §3.2.6 of [xmlschema2].
16128
16129
16130
16131
16132
16133
16134

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-delay"><ref name="duration"/></attribute></optional></define>

15.15.7 Animation Steps
The attribute text:animation-steps specifies the distance by which text is moved within eachscrolling step.
16135
16136
16137
16138
16139
16140
16141

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="text:animation-steps"><ref name="length"/></attribute></optional></define>

15.16 Text and Text Alignment Properties
Drawing objects that contain text and text boxes can have optional properties that specify how the
text is aligned within the drawing object. These properties are available for drawing objects
contained in all kinds of applications.

15.16.1 Auto Grow Width and Height
The attributes draw:auto-grow-width and draw:auto-grow-height specify whether or not
to automatically increase the width and height of the drawing object if text is added to the drawing
object. These attributes usually are evaluated only for text boxes.
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:auto-grow-width"><ref name="boolean"/></attribute></optional><optional><attribute name="draw:auto-grow-height"><ref name="boolean"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 648 of 738

16153</define>

15.16.2 Fit To Size
The attribute draw:fit-to-size specifies whether or not to stretch the text content of adrawing object to fill the entire object. If the value of the attribute is true, the text content isstretched.
16154
16155
16156
16157
16158
16159
16160

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:fit-to-size"><ref name="boolean"/></attribute></optional></define>

15.16.3 Fit To Contour
The attribute draw:fit-to-contour specifies whether or not to stretch the text content of adrawing object to fill the contour of the object. If the value of the attribute is true, the text content
is stretched.
16161
16162
16163
16164
16165
16166
16167

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:fit-to-contour"><ref name="boolean"/></attribute></optional></define>

15.16.4 Text Area Vertical Align
The attribute draw:textarea-vertical-align specifies the vertical alignment of the text
area inside a shape.
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:textarea-vertical-align"><choice><value>top</value><value>middle</value><value>bottom</value><value>justify</value></choice></attribute></optional></define>

15.16.5 Text Area Horizontal Align
The attribute draw:textarea-horizontal-align specifies the horizontal alignment of thetext area inside a shape.
16180
16181
16182
16183
16184

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:textarea-horizontal-align"><choice><value>left</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 649 of 738

16185
16186
16187
16188
16189
16190
16191

<value>center</value><value>right</value><value>justify</value></choice></attribute></optional></define>

15.16.6 Word Wrap
The fo:wrap-option attribute specifies if text is word wrapped in a shape.
16192
16193
16194
16195
16196
16197
16198
16199
16200

16201

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="fo:wrap-option"><choice><value>no-wrap</value><value>wrap</value></choice></attribute></optional></define>

15.16.7 List Styles
The <text:list-style> element as described in section 14.10 specifies a list style that is
applied to the paragraphs contained in a text box. Although the list style has a name, it is not
displayed in the user interface, even if the graphic style that contains it is a common style.
Including a list style element into a graphic style has the same semantics as adding astyle:list-style-name attribute (see section 14.1) to the style that references a list style thatis declared outside a graphic style. The inclusion of a list style element is required in cases wherea common graphic style should be associated with an automatic list style.
List styles contained in a graphic style can be referenced by other graphic styles using thestyle:list-style-name attribute.
16202
16203
16204
16205
16206

<define name="style-graphic-properties-elements" combine="interleave"><optional><ref name="text-list-style"/></optional></define>

15.17 Color Properties
Drawing objects that display a bitmap graphic can have optional properties that adjust the colorsof the bitmap. These properties are available for drawing objects contained in all kinds ofapplications.

15.17.1 Color Mode
The attribute draw:color-mode affects the output of colors from a source bitmap or rastergraphic.
16207
16208
16209
16210

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:color-mode"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 650 of 738

16211
16212
16213
16214
16215
16216
16217
16218

<value>greyscale</value><value>mono</value><value>watermark</value><value>standard</value></choice></attribute></optional></define>

15.17.2 Color Inversion
The attribute draw:color-inversion specifies whether or not the colors in the graphic shapeshould be inverted.
16219
16220
16221
16222
16223
16224
16225

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:color-inversion"><ref name="boolean"/></attribute></optional></define>

15.17.3 Adjust Luminance
The attribute draw:luminance specifies a signed percentage value that affects the output
luminance of a bitmap or raster graphic.
16226
16227
16228
16229
16230
16231
16232

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:luminance"><ref name="percent"/></attribute></optional></define>

15.17.4 Adjust Contrast
The attribute draw:contrast specifies a signed percentage value that affects the output
contrast of a bitmap or raster graphic.
16233
16234
16235
16236
16237
16238
16239

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:contrast"><ref name="percent"/></attribute></optional></define>

15.17.5 Adjust Gamma
The attribute draw:gamma specifies a value that affects the output gamma of a bitmap or rastergraphic.
16240
16241
16242
16243
16244
16245

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:gamma"><ref name="percent"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 651 of 738

16246</define>

15.17.6 Adjust Red
The attribute draw:red specifies a signed percentage value that affects the output of the red color
space of a bitmap or raster graphic.
16247
16248
16249
16250
16251
16252
16253

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:red"><ref name="percent"/></attribute></optional></define>

15.17.7 Adjust GreenThe attribute draw:green specifies a signed percentage value that affects the output of thegreen color space of a bitmap or raster graphic.
16254
16255
16256
16257
16258
16259
16260

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:green"><ref name="percent"/></attribute></optional></define>

15.17.8 Adjust BlueThe attribute draw:blue specifies a signed percentage value that affects the output of the blue
color space of a bitmap or raster graphic.
16261
16262
16263
16264
16265
16266
16267

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:blue"><ref name="percent"/></attribute></optional></define>

15.17.9 Adjust Opacity
The attribute draw:image-opacity adjusts the opacity of an image. The value can be between
0% and 100%. See also section 15.14.13.
16268
16269
16270
16271
16272
16273
16274

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:image-opacity"><ref name="percent"/></attribute></optional></define>

15.18 Shadow Properties
Most drawing objects can have a shadow. The following attributes specify how the shadow isrendered. These properties are available for drawing objects contained in all kinds of applications.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 652 of 738

15.18.1 Shadow
The attribute draw:shadow enables or disables the visibility of a shadow.
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:shadow"><choice><value>visible</value><value>hidden</value></choice></attribute></optional></define>

15.18.2 Offset
The attributes draw:shadow-offset-x and draw:shadow-offset-y are used to render ashadow. A copy of the shape is rendered in the single shadow color (specified by draw:shadowcolor) behind the shape. The offset attributes specify the offset between the top left edge of the
shape and the top left edge of the border
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:shadow-offset-x"><ref name="length"/></attribute></optional><optional><attribute name="draw:shadow-offset-y"><ref name="length"/></attribute></optional></define>

15.18.3 Color
The attribute draw:shadow-color specifies the color in which the shadow is rendered.
16297
16298
16299
16300
16301
16302
16303

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:shadow-color"><ref name="color"/></attribute></optional></define>

15.18.4 Opacity
The attribute draw:shadow-opacity specifies the opacity in which the shadow is rendered.
The value of this attribute is a percentage value.
16304
16305
16306
16307
16308
16309
16310

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:shadow-opacity"><ref name="percent"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 653 of 738

15.19 Connector Properties
The properties described in this section are specific to connector drawing objects. These
properties are available for connector drawing objects contained in all kinds of applications.

15.19.1 Start Line Spacing
For standard connectors, the attributes draw:start-line-spacing-horizontal anddraw:start-line-spacing-vertical increment the length of the escape line from the start
shape for standard connectors. For lines connectors, these attributes specify the absolute lengthof the escape line from the start shape. For other connector types, they are ignored.
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:start-line-spacing-horizontal"><ref name="distance"/></attribute></optional><optional><attribute name="draw:start-line-spacing-vertical"><ref name="distance"/></attribute></optional></define>

15.19.2 End Line Spacing
For standard connectors, the attributes draw:end-line-spacing-horizontal anddraw:end-line-spacing-vertical increment the length of the escape line from the end
shape. For lines connectors, they specify the absolute length of the escape line from the end
shape. For other connector types, they are ignored.
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:end-line-spacing-horizontal"><ref name="distance"/></attribute></optional><optional><attribute name="draw:end-line-spacing-vertical"><ref name="distance"/></attribute></optional></define>

15.20 Measure Properties
The properties described in this section are specific to measure drawing objects. These properties
are available for measure drawing objects contained in all kinds of applications.

15.20.1 Line Distance
The attribute draw:line-distance specifies the distance from the reference points to themeasure line.
16335
16336

<define name="style-graphic-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 654 of 738

16337
16338
16339
16340
16341

<attribute name="draw:line-distance"><ref name="distance"/></attribute></optional></define>

15.20.2 Guide Overhang
The guides are the two lines from the reference points to the measure line. The attributedraw:guide-overhang specifies the length that the guides are drawn after they cross themeasure line.
16342
16343
16344
16345
16346
16347
16348

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:guide-overhang"><ref name="length"/></attribute></optional></define>

15.20.3 Guide Distance
The attribute draw:guide-distance specifies the distance between the reference points andthe start point of the guide lines. This distance does not take the attributes draw:start-guideand draw:end-guide into account, that is, the distance specified in draw:guide-distanceequals the distance that is actually drawn only if draw:start-guide and draw:end-guideboth are 0.
16349
16350
16351
16352
16353
16354
16355

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:guide-distance"><ref name="distance"/></attribute></optional></define>

15.20.4 Start Guide
The draw:start-guide attribute specifies a length that is added to the length of the guide fromthe first reference point to the measure line. The guide is extended by this length at the end thatpoints towards the reference points.
16356
16357
16358
16359
16360
16361
16362

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:start-guide"><ref name="length"/></attribute></optional></define>

15.20.5 End Guide
The draw:end-guide attribute specifies a length that is added to the length of the guide fromthe second reference point to the measure line. The guide is extended by this length at the end
that points towards the reference points.
16363
16364

<define name="style-graphic-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 655 of 738

16365
16366
16367
16368
16369

<attribute name="draw:end-guide"><ref name="length"/></attribute></optional></define>

15.20.6 Placing
The attribute draw:placing specifies whether the measure line is rendered below or above theedge defined by the two reference points. The value of this attribute can be below or above.
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:placing"><choice><value>below</value><value>above</value></choice></attribute></optional></define>

15.20.7 Parallel
The draw:parallel attributes specifies whether the measure text is displayed parallel to themeasure line or perpendicular.
16380
16381
16382
16383
16384
16385
16386

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:parallel"><ref name="boolean"/></attribute></optional></define>

15.20.8 Text Alignment
The attributes draw:measure-align and draw:measure-vertical-align determine thehorizontal and vertical alignment of the measure text relative to the measure line. If value of these
attributes is automatic, the application chooses the best position.
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:measure-align"><choice><value>automatic</value><value>left-outside</value><value>inside</value><value>right-outside</value></choice></attribute></optional><optional><attribute name="draw:measure-vertical-align"><choice><value>automatic</value><value>above</value><value>below</value><value>center</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 656 of 738

16405
16406
16407
16408

</choice></attribute></optional></define>

15.20.9 Unit
The attribute draw:unit specifies the unit used in the textual presentation of a measure shape.
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:unit"><choice><value>automatic</value><value>mm</value><value>cm</value><value>m</value><value>km</value><value>pt</value><value>pc</value><value>inch</value><value>ft</value><value>mi</value></choice></attribute></optional></define>

15.20.10 Show Unit
The attribute draw:show-unit toggles the display of the unit in the textual presentation of ameasure shape.
16427
16428
16429
16430
16431
16432
16433

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:show-unit"><ref name="boolean"/></attribute></optional></define>

15.20.11 Decimal Places
The attribute draw:decimal-places specifies the number of decimal places that are used forthe measure text.
16434
16435
16436
16437
16438
16439
16440

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:decimal-places"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.21 Caption Properties
The following attributes can be used in the styles for caption shapes. These properties areavailable for caption objects contained in all kinds of applications.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 657 of 738

•

Type

•

Angle type

•

Angle

•

Gap

•

Escape direction•

Escape•Line length•

Fit line length

15.21.1 TypeThe attribute draw:caption-type specifies the geometry of the line of a caption.

16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451

•

straight-line: a straight perpendicular line is drawn to the caption point.

•

angled-line: a straight line is drawn to the caption point.

•

angled-connector-line: a straight perpendicular line, followed by a straight line is drawn
to the caption point.

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-type"><choice><value>straight-line</value><value>angled-line</value><value>angled-connector-line</value></choice></attribute></optional></define>

15.21.2 Angle TypeThe attribute draw:caption-angle-type specifies if the escape angle of the line of a caption
is fixed or free. If this is set to free the application can choose the best possible angle.
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-angle-type"><choice><value>fixed</value><value>free</value></choice></attribute></optional></define>

15.21.3 Angle
The attribute draw:caption-angle specifies the escape angle of the line of a caption. It isevaluated only if draw:caption-angle-type has the value fixed.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 658 of 738

16462
16463
16464
16465
16466
16467
16468

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-angle"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.21.4 Gap
The attribute draw:caption-gap specifies the distance between the text area of the caption
and the start of the line.
16469
16470
16471
16472
16473
16474
16475

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-gap"><ref name="distance"/></attribute></optional></define>

15.21.5 Escape Direction
The attribute draw:caption-escape-direction specifies the escape direction for the line ofa caption. If this is set to auto the application can choose the best direction.
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-escape-direction"><choice><value>horizontal</value><value>vertical</value><value>auto</value></choice></attribute></optional></define>

15.21.6 Escape
The attribute draw:caption-escape specifies the escape point of the caption line measured
from the top left corner of the text area. The value can be an absolute length or a percentage.
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-escape"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 659 of 738

15.21.7 Line Length
The attribute draw:caption-line-length specifies the length of the first caption line (i.e., theone that starts at the caption's text area). The attribute is only evaluated if draw:caption-fitline-length has the value false.
16497
16498
16499
16500
16501
16502
16503

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-line-length"><ref name="length"/></attribute></optional></define>

15.21.8 Fit Line Length
If the attribute draw:caption-fit-line-length is true, the application determines the best
possible length for the caption line.
16504
16505
16506
16507
16508
16509
16510

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:caption-fit-line-length"><ref name="boolean"/></attribute></optional></define>

15.22 3D Geometry Properties
The 3D geometry properties described in this section are applicable to 3D drawing objects. These
properties are available for 3D drawing objects contained in all kinds of applications.

15.22.1 Horizontal Segments
If the geometry of a 3D object is generated during run-time, the dr3d:horizontal-segments
attribute is used to specify the number of horizontal segments that are used to generate thegeometry. Typical applications support values between 2 and 256.
16511
16512
16513
16514
16515
16516
16517

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:horizontal-segments"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.22.2 Vertical Segments
If the geometry of a 3D object is generated during run-time, the dr3d:vertical-segments
attribute is used to specify the number of vertical segments that are used to generate thegeometry. Typical applications support values between 2 and 256.
16518
16519
16520
16521
16522
16523

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:vertical-segments"><ref name="nonNegativeInteger"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 660 of 738

16524</define>

15.22.3 Edge Rounding
If the geometry of a 3D object is generated during run-time, the dr3d:edge-rounding attributeis used to specify the size of an area at the edges of the geometry that is used for rounding theedges.
16525
16526
16527
16528
16529
16530
16531

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:edge-rounding"><ref name="percent"/></attribute></optional></define>

15.22.4 Edge Rounding Mode
The attribute dr3d:edge-rounding-mode specifies how to generate rounded edges.
The value of this attribute can be correct or attractive. If the value is correct, themathematically correct method is used. If the value is attractive, a method which preserves
the visual appearance of the text is used.
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:edge-rounding-mode"><choice><value>correct</value><value>attractive</value></choice></attribute></optional></define>

15.22.5 Back Scale
The attribute dr3d:back-scale specifies the proportion of the background geometry for latheand extrude objects.
For example, with a back scale of 50%, the background plane of an extrude object is half the sizeof the foreground plane.
16542
16543
16544
16545
16546
16547
16548

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:back-scale"><ref name="percent"/></attribute></optional></define>

15.22.6 Depth
The dr3d:depth attribute specifies the extrusion depth for extrude objects.
16549
16550
16551
16552

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:depth"><ref name="length"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 661 of 738

1655316554
16555</attribute></optional></define>

15.22.7 Backface Culling
The dr3d:backface-culling attribute enables or disables backface culling.
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:backface-culling"><choice><value>enabled</value><value>disabled</value></choice></attribute></optional></define>

15.22.8 End Angle
The attribute dr3d:end-angle specifies the rotation angle for 3D lathe objects. If it is the default(360°), the lathe object is closed and completely rotated. With smaller values it is possible todefine opened lathe objects (segments). The then visible sides are closed and take into accountthe dr3d:back-scale and dr3d:edge-rounding attributes. With bigger values it is possible
to create lathe objects with more than one rotation. This will only have a visible effect when e.g.,
dr3d:back-scale is used.
For example, with a end angle of 270°, the lathe object will be opened by 90°.
16566
16567
16568
16569
16570
16571
16572

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:end-angle"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.22.9 Close Front
The dr3d:close-front property specifies whether a front plane shall be generated. E.g., if anellipse is extruded, and this attribute is set, the ellipse will have an open front. The attribute can beused with extrudes and lathe objects.
16573
16574
16575
16576
16577
16578
16579

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:close-front"><ref name="boolean"/></attribute></optional></define>

15.22.10 Close Back
The dr3d:close-back property describes if a back plane shall be generated. E.g., if anellipse is extruded, and this attribute is set, the ellipse will have an open back. The attribute can beused with extrudes and lathe objects.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 662 of 738

16580
16581
16582
16583
16584
16585
16586

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:close-back"><ref name="boolean"/></attribute></optional></define>

15.23 3D Lighting Properties
The 3D lightning properties described in this section are applicable to 3D drawing objects. These
properties are available for 3D drawing objects contained in all kinds of applications.

15.23.1 Mode
The attribute dr3d:lighting-mode determines the lighting algorithm used to render thecorresponding 3D object.
The value of this attribute can be standard or double-sided. If the value is double-sided,
the reverse sides of the objects are also lighted.
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:lighting-mode"><choice><value>standard</value><value>double-sided</value></choice></attribute></optional></define>

15.23.2 Normals Kind
The attribute dr3d:normals-kind specifies how the normal settings for the generated lighting.

16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607

•

object: does not produce standard normals, but leaves the object-specific ones untouched.

•flat: forces one normal per flat part•

sphere: forces normals to behave as the object would be a sphere.

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:normals-kind"><choice><value>object</value><value>flat</value><value>sphere</value></choice></attribute></optional></define>

15.23.3 Normals Direction
The dr3d:normals-direction attribute is used to inverse the generated normal lighting
settings.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 663 of 738

16608
16609
16610
16611
16612
16613
16614
16615
16616
16617

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:normals-direction"><choice><value>normal</value><value>inverse</value></choice></attribute></optional></define>

15.24 3D Texture Properties
The 3D texture properties described in this section are applicable to 3D drawing objects. These
properties are available for 3D drawing objects contained in all kinds of applications.

15.24.1 Generation Mode
The attributes dr3d:texture-generation-mode-x and dr3d:texture-generationmode-y specify how the texture coordinates are generated.

16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637

•

object: This value specifies that the standard object projection method is used•

parallel: This value specifies a flat parallel projection in the specified degree of freedom (Xor Y).

•

sphere: This value forces projection to wrapping in X and/or Y direction<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:texture-generation-mode-x"><choice><value>object</value><value>parallel</value><value>sphere</value></choice></attribute></optional><optional><attribute name="dr3d:texture-generation-mode-y"><choice><value>object</value><value>parallel</value><value>sphere</value></choice></attribute></optional></define>

15.24.2 Kind
The attribute dr3d:texture-kind is used to select whether the texture changes theluminance, intensity, or color of the shape.
16638
16639
16640
16641
16642

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:texture-kind"><choice><value>luminance</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 664 of 738

16643
16644
16645
16646
16647
16648

<value>intensity</value><value>color</value></choice></attribute></optional></define>

15.24.3 Filter
The attribute dr3d:texture-filter is used to enable or disable texture filtering.
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:texture-filter"><choice><value>enabled</value><value>disabled</value></choice></attribute></optional></define>

15.24.4 Mode
The attribute dr3d:normals-direction is used to specify how the texture is modulated.
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:texture-mode"><choice><value>replace</value><value>modulate</value><value>blend</value></choice></attribute></optional></define>

15.25 3D Material Properties
The 3D texture properties described in this section are applicable to 3D drawing objects. These
properties are available for 3D drawing objects contained in all kinds of applications.

15.25.1 Colors
The attributes dr3d:ambient-color, dr3d:emissive-color, dr3d:specular-colorand dr3d:diffuse-color specify the four colors that define a material.
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:ambient-color"><ref name="color"/></attribute></optional><optional><attribute name="dr3d:emissive-color"><ref name="color"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 665 of 738

16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691

</optional><optional><attribute name="dr3d:specular-color"><ref name="color"/></attribute></optional><optional><attribute name="dr3d:diffuse-color"><ref name="color"/></attribute></optional></define>

15.25.2 Shininess
The attribute dr3d:shininess specifies the shine of the used material.
16692
16693
16694
16695
16696
16697
16698

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:shininess"><ref name="percent"/></attribute></optional></define>

15.26 3D Shadow Properties
The 3D shadow properties described in this section are applicable to 3D drawing objects. These
properties are available for 3D drawing objects contained in all kinds of applications.

15.26.1 Shadow
The attribute dr3d:shadow enables or disables a three-dimensional shadow for a threedimensional object.
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="dr3d:shadow"><choice><value>visible</value><value>hidden</value></choice></attribute></optional></define>

15.27 Frame Formatting Properties
The properties described in this section apply to draw frames (see section 9.3). They can be usedwithin graphic styles (see section 14.13.1) and they are contained in a <style:graphicproperties> element.

15.27.1 Frame Widths
There are three types of frame widths; fixed widths, minimum widths and relative widths. Fixedwidths are specified using the svg:width attribute, minimum widths are specified using thefo:min-width attribute and relative widths are specified using the style:rel-width attribute.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 666 of 738

The meaning of these attributes is the same as described in section 9.3, except that the attributes
specify the default width for new created frames only. The style:rel-width attribute will be
evaluated only for graphic styles that are applied to text boxes.
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-draw-rel-size-attlist"/><optional><attribute name="fo:min-width"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.27.2 Frame Heights
There are three types of frame heights; fixed heights, minimum heights and relative heights. Fixedheights are specified using the svg:height attribute, minimum heights are specified using thefo:min-height attribute and relative heights are specified using the style:rel-height
attribute. The meaning of these attributes is the same as described in section 9.3, except that the
attributes specify the default height for new created frames only. The style:rel-height
attribute will be evaluated only for graphic styles that are applied to text boxes. See also section
15.27.1.
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="fo:min-height"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.27.3 Maximum Width and Height
Text boxes can increase in size automatically when content is added. The fo:max-width andfo:max-height attributes specify a maximum width and height for the frame. When the
maximum values are reached, the frame stops increasing in size. The attributes' value can beeither a length or a percentage. If the anchor for the text box is in a table cell, the percentage
value relates to the surrounding table box. If the anchor for the text box is in a text box, thepercentage value relates to the surrounding text box. In other cases, the percentage values relate
to the height of the page or window.
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="fo:max-height"><choice><ref name="length"/><ref name="percent"/></choice></attribute></optional><optional><attribute name="fo:max-width"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 667 of 738

16742
16743
16744
16745
16746
16747

<ref name="length"/><ref name="percent"/></choice></attribute></optional></define>

15.27.4 Left and Right Margins
The fo:margin-left and fo:margin-right properties determine the left and right margins
to set around a frame. See sections 15.5.17 for detailed information on these attributes.
Percentage values are not supported.
16748
16749
16750

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-horizontal-margin-attlist"/></define>

15.27.5 Top and Bottom Margins
The fo:margin-top and fo:margin-bottom properties determine the top and bottom
margins to set around a frame. See sections 15.5.20 for detailed information on these attributes.
Percentage values are not supported.
16751
16752
16753

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-vertical-margin-attlist"/></define>

15.27.6 Margins
The fo:margin property specifies the the margin for all four edges of a frame. See section
15.5.21 for a full explanation of this property.
16754
16755
16756

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-margin-attlist"/></define>

15.27.7 Print Content
The style:print-content property specifies whether or not the content of a frame is printed.
16757
16758
16759
16760
16761
16762
16763

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:print-content"><ref name="boolean"/></attribute></optional></define>

15.27.8 Protect
The style:protect property specifies whether the content, size, or position of a frame isprotected. The value of this property can be either none or a space separated list that consists ofany of the values content, position, or size.
16764
16765
16766
16767

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:protect"><choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 668 of 738

16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781

<value>none</value><list><oneOrMore><choice><value>content</value><value>position</value><value>size</value></choice></oneOrMore></list></choice></attribute></optional></define>

15.27.9 Horizontal Position
Within text documents, the style:horizontal-pos property specifies the horizontal alignmentof the frame in relation to the specific area.
The value of this property can be one of the following: from-left, left, center, right,
from-inside, inside, or outside. The area that the position relates to is specified by thestyle:horizontal-rel property. The values from-inside, inside and outsidecorrespond to the values from-left, left, and right on pages that have an odd page number
and to the opposite values on pages that have an even page number.
If the property value is from-left or from-inside, the svg:x attribute associated with theframe element specifies the horizontal position of the frame. Otherwise the svg:x attribute isignored for text documents.
It is also possible to use an svg:x attribute within a graphic style. If this is the case, then theattribute specifies a default position for new frames that are created using this style.
Some values may be used in connection with certain frame anchor and relation types only.
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:horizontal-pos"><choice><value>left</value><value>center</value><value>right</value><value>from-left</value><value>inside</value><value>outside</value><value>from-inside</value></choice></attribute></optional><optional><attribute name="svg:x"><ref name="coordinate"/></attribute></optional></define>

The following tables display the possible values of the attributes style:horizontal-pos andstyle:horizontal-rel. The possible values of these alignment attributes are listed in the firstcolumn on the left, and an alignment attribute value/anchor type value match is indicated by an X.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 669 of 738

Value ofstyle:horizon
tal-pos
any

Value of text:anchor-type
page
X

Value ofstyle:horizon
tal-relframe
XparagraphXcharas­charX

Value of text:anchor-type
page

frame

paragraph

char

page

X

X

X

page-content

X

X

X

page-start-margin

X

X

X

page-end-margin

X

X

X

paragraph

X

X

paragraph-content

XX

paragraph-startmargin

X

X

paragraph-endmargin

X

X

frame

X

frame-content

X

frame-start-margin

X

frame-end-margin

X

char

as­charX

15.27.10 Horizontal Relation
The style:horizontal-rel property specifies the area to which the horizontal position of aframe relates. See section 15.27.9 for information on the style:horizontal-pos property.
The value of this property can be one of the following: page, page-content, page-startmargin, page-end-margin, frame, frame-content, frame-start-margin, frame-endmargin, paragraph, paragraph-content, paragraph-start-margin, paragraph-endmargin, or char.
Some values can be used with only certain frame anchor types.
The value start-margin determines the left margin, except when the horizontal position isfrom-inside, inside or outside and the anchor for the frame is on a page with an evenpage number, in which case it determines the right margin. The value end-margin determines
the opposite margin to the start-margin values.
16802
16803

<define name="style-graphic-properties-attlist" combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 670 of 738

16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822

<attribute name="style:horizontal-rel"><choice><value>page</value><value>page-content</value><value>page-start-margin</value><value>page-end-margin</value><value>frame</value><value>frame-content</value><value>frame-start-margin</value><value>frame-end-margin</value><value>paragraph</value><value>paragraph-content</value><value>paragraph-start-margin</value><value>paragraph-end-margin</value><value>char</value></choice></attribute></optional></define>

15.27.11 Vertical Position
The style:vertical-pos property specifies the vertical alignment of the frame in relation to a
specific area.
The value of this property can be one of the following: from-top, top, middle, below orbottom. The area that the position relates to is specified by the style:vertical-rel
property. top, middle and bottom specify the the given corners of the frame and the reference
area get aligned. below specifies that the top corner of the frame is positioned below thereference area.
If the value of this property is from-top, the svg:y attribute associated with the frame element
specifies the vertical position of the frame. Otherwise, the svg:y attribute is ignored for text
documents.
It is also possible to use an svg:y attribute within a graphic style. If this is the case, the attribute
specifies a default position for new frames that are created using this style.
Some values may be used in connection with certain frame anchor and relation types only.
16823
16824
16825

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-vertical-pos-attlist"/></define>

16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842

<define name="common-vertical-pos-attlist"><optional><attribute name="style:vertical-pos"><choice><value>top</value><value>middle</value><value>bottom</value><value>from-top</value><value>below</value></choice></attribute></optional><optional><attribute name="svg:y"><ref name="coordinate"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 671 of 738

1684316844</optional></define>

The following tables display the possible values of the attributes style:vertical-pos andstyle:vertical-rel. The possible values of these alignment attributes are listed in the firstcolumn on the left, and an alignment attribute value/anchor type value match is indicated by an X.
Value ofstyle:vertical
-pos
any

Value of text:anchor-type
page
X

Value ofstyle:vertical
-rel

frame
X

paragraph
X

char
X

as­charX

Value of text:anchor-type
page

page

X

page-content

X

frame

frame

X

frame-content

Xparagraphcharparagraph

X

X

paragraph-content

X

X

char

X

as-char

X

line

X

baseline

X

text

X

15.27.12 Vertical Relation
The style:vertical-rel property specifies the area to which the vertical position of a frame
relates. See section 15.27.11 for information on the style:vertical-pos property.
The value of this property can be one of the following: page, page-content, frame, framecontent, paragraph, paragraph-content, line, baseline, text or char.
Some values can be used with only certain frame anchor types.
16845
16846
16847

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-vertical-rel-attlist"/></define>

16848
16849
16850
16851
16852
16853
16854
16855

<define name="common-vertical-rel-attlist"><optional><attribute name="style:vertical-rel"><choice><value>page</value><value>page-content</value><value>frame</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 672 of 738

16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866

<value>frame-content</value><value>paragraph</value><value>paragraph-content</value><value>char</value><value>line</value><value>baseline</value><value>text</value></choice></attribute></optional></define>

15.27.13 Frame Anchor
The text:anchor-type and text:anchor-page-number specify the default anchor for new frames anddrawing objects. See section 9.2.16 for details.
16867
16868
16869

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-text-anchor-attlist"/></define>

15.27.14 Border
The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-leftand fo:border-right specify the border properties of the frame. See section 15.5.25 fordetailed information on these attributes.
16870
16871
16872

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-border-attlist"/></define>

15.27.15 Border Line Width
If a frame has borders, the border line width attributes style:border-line-width,style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of theborder lines of the frame. See section 15.5.26 for detailed information on these attributes.
16873
16874
16875

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-border-line-width-attlist"/></define>

15.27.16 Padding
The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the frame. See section 15.5.27
for detailed information on these attributes.
16876
16877
16878

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-padding-attlist"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 673 of 738

15.27.17 Shadow
The shadow attribute style:shadow specifies the shadow of the frame. See section 15.5.28 fordetailed information on this attribute.
16879
16880
16881

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-shadow-attlist"/></define>

15.27.18 BackgroundThe background attribute fo:background-color and the background element<style:background-image> specify the background properties of the frame. See sections
15.5.23 and 15.5.24 for detailed information on this attribute and element.
16882
16883
16884
16885
16886
16887

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-background-color-attlist"/></define><define name="style-graphic-properties-elements" combine="interleave"><ref name="style-background-image"/></define>

15.27.19 Columns
The <style:columns> element specifies if a text box contains columns. See section 15.7.3 fordetailed information on this element.
16888
16889
16890

<define name="style-graphic-properties-elements" combine="interleave"><ref name="style-columns"/></define>

15.27.20 Editable
Within text documents, a text box can be editable even if the document in which it is contained isa read-only document. The style:editable property specifies if a text box can be edited.
16891
16892
16893
16894
16895
16896
16897

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:editable"><ref name="boolean"/></attribute></optional></define>

15.27.21 Wrapping
Within text documents, the style:wrap property specifies how text around a frame or graphic
object is treated. For example, text can run around the left side of the frame, around the right sideof the frame, or through the frame. The possible values are:•none: no text wraps around the drawing shape.

•

left: Text may wrap around the left side of the drawing shape.

•

right: Text may wrap around the left side of the drawing shape.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 674 of 738

16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912

•

parallel: Text may wrap around both sides of the drawing shape.

•

dynamic: Text may wrap around both sides of the drawing shape, provided that there issufficient space left.

•

biggest: Text may wraps around the object border where the difference to the left or rightpage or column border is largest.

•

run-through: Text runs through the drawing object.

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:wrap"><choice><value>none</value><value>left</value><value>right</value><value>parallel</value><value>dynamic</value><value>run-through</value><value>biggest</value></choice></attribute></optional></define>

15.27.22 Dynamic Wrap Threshold
The style:wrap-dynamic-threshold attribute is evaluated only if the style:wrap attributehas a value of dynamic. It specifies the minimum distance between the page or column borderand the object for which wrapping will be enabled.
16913
16914
16915
16916
16917
16918
16919

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:wrap-dynamic-threshold"><ref name="nonNegativeLength"/></attribute></optional></define>

15.27.23 Paragraph-only Wrapping
If the anchor position of a frame or drawing shape is a paragraph or a character, and the wrap
mode specified by the style:wrap property is left, right, parallel, or dynamic, thenumber of paragraphs that wrap around the frame can be specified using a style:numberwrapped-paragraphs attribute.
This property is only recognized by frames or styles that have a style:wrap property attachedwith a value of left, right, parallel, or dynamic.
If the value is no-limit, there is no limit on the number of paragraphs that are allowed to wrap
around a frame.
16920
16921
16922
16923
16924
16925
16926

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:number-wrapped-paragraphs"><choice><value>no-limit</value><ref name="positiveInteger"/></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 675 of 738

1692716928
16929</attribute></optional></define>

15.27.24 Contour Wrapping
Within text documents, the style:wrap-contour attribute specifies for some frame types thatthe text should wrap around the shape of the object in the frame rather than around the frame
itself . This is called contour wrapping.
16930
16931
16932
16933
16934
16935
16936

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:wrap-contour"><ref name="boolean"/></attribute></optional></define>

15.27.25 Contour Wrapping Mode
The style:wrap-contour-mode attribute is used to further specify how the text should wrap
around the contour.
This attribute is recognized only by frames/drawing shapes or styles that already have thestyle:wrap and style:wrap-contour attributes attached.
The value of the attribute can be outside or full. If the value of the attribute is outside, thetext wraps around the general area to the left and right of the shape. If the value of the attribute isfull, the text wraps around the shape and fills any possible spaces and indentations in the
shape.
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:wrap-contour-mode"><choice><value>full</value><value>outside</value></choice></attribute></optional></define>

15.27.26 Run ThroughIf the value of the style:wrap attribute is run-through, it can be further specified whether thecontent of the frame should be displayed in the background or in the foreground. The
style:run-through attribute is usually used for transparent objects.
The value of this attribute can be foreground or background. If the value is foreground, theframe content is displayed in front of the text. If the value is background, the frame content isdisplayed behind the text.
16947
16948
16949
16950
16951
16952
16953

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:run-through"><choice><value>foreground</value><value>background</value></choice>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 676 of 738

1695416955
16956</attribute></optional></define>

15.27.27 Flow with Text
The style:flow-with-text attribute specifies the behavior of drawing shapes that are
positioned at a certain distance below an anchor and do not fit on the page where the anchor is. If
the value of the property is true, such drawing objects follow the text flow, that is, they adisplayed on the next page. If the attribute value is false, such drawing objects are displayedoutside the page's text area.
Example: A graphic is to be positioned 10cm below its anchor. It is followed by only 8cm of text
before the next page break. With style:flow-with-text='false' the graphics would thenbe positioned 2cm below the text area (somewhere in the footer); with style:flow-withtext='true' it would positioned 2cm into the text flow of the following page.
16957
16958
16959
16960
16961
16962
16963

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:flow-with-text"><ref name="boolean"/></attribute></optional></define>

15.27.28 Overflow behavior
For text boxes contained within text document, the style:overflow-behavior property
specifies the behavior of text boxes where the containing text does not fit into the text box. If theattribute's value is clip, the text that does not fit into the text box is not displayed. If the attributevalue is auto-create-new-frame, a new frame will be created on the next page, with thesame position and dimensions of the original frame.
If the style:overflow-behavior property's value is auto-create-new-frame and the text
box has a minimum width or height specified, then the text box will grow until the page bounds arereached before a new frame is created.
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:overflow-behavior"><choice><value>clip</value><value>auto-create-new-frame</value></choice></attribute></optional></define>

15.27.29 Mirroring
The style:mirror property specifies whether or not an image is mirrored before it is displayed.
The mirroring can be vertical or horizontal. Horizontal mirroring can be restricted to images thatare only located on either odd or even pages.
The value of this attribute can be none, vertical, horizontal, horizontal-on-odd, or
horizontal-on-even. The value vertical and the various horizontal values can be specified
together, separating them by a white space.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 677 of 738

16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="style:mirror"><choice><value>none</value><value>vertical</value><ref name="horizontal-mirror"/><list><value>vertical</value><ref name="horizontal-mirror"/></list><list><ref name="horizontal-mirror"/><value>vertical</value></list></choice></attribute></optional></define>

16993
16994
16995
16996
16997
16998
16999
17000

<define name="horizontal-mirror"><choice><value>horizontal</value><value>horizontal-on-odd</value><value>horizontal-on-even</value></choice></define>

15.27.30 Clipping
The fo:clip property specifies whether to display:•

A rectangular section of an image, or•the entire image.

See §7.20.1 of [XSL] for details.
17001
17002
17003
17004
17005
17006
17007
17008

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="fo:clip"><!-- The attribute value must match the one XSL's clip --><ref name="string"/></attribute></optional></define>

15.27.31 Wrap Influence on Position
This attribute details how the wrapping mode (see the style:wrap attribute) influences the
positioning of a frame. It is intended as a hint to the layout algorithm to help decide on theplacement of frames in certain cases where several correct placements could be used. All three
options describe different, correct interpretations of the layout constraints already in the format.
The new hint would allow to disambiguate between these situations.
17009
17010
17011
17012
17013
17014

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:wrap-influence-on-position"
a:defaultValue="iterative"><choice><value>iterative</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 678 of 738

17015
17016
17017
17018
17019
17020

<value>once-concurrent</value><value>once-successive</value></choice></attribute></optional></define>

The situation in which this attribute makes a difference is when the anchor,
position and wrapping mode of a frame are such that they influence each other.
For example, consider a paragraph of text with two images positioned somewhat
above the anchor. Without wrapping, the images overly the text and can simply beplaced at the given offset from the anchor.
If wrap-around is enabled, the text hidden behind the images now needs to flow
around the images, making the first paragraph use more space than previously.
This moves the anchor position further down. If one does the placement only onceand concurrently for all objects, this is the final result. This corresponds to theobject once-concurrently.
If one proceeds as above, but does the process one image at a time, one arrives
at the positions given to the right. This corresponds to the option oncesuccessive.

If one places the images iteratively, until a position is found which corresponds to
the given offset from the anchor, one can often achieve a placement that fully
satisfy all the given layout properties (at a certain price in implementation cost).
This corresponds to the option iterative.

15.27.32 Writing Mode
The style:writing-mode attribute specifies the writing mode for a text-box. See section
15.5.36 for details.
17021
17022
17023

<define name="style-graphic-properties-attlist" combine="interleave"><ref name="common-writing-mode-attlist"/></define>

15.28 Floating Frame Formatting Properties
The attributes described in this section can be assigned to a graphic style that is assigned tofloating frames.

15.28.1 Display Scrollbar
The draw:display-scrollbar attribute specifies whether or not vertical and horizontal
scrollbars are displayed. This attribute can be assigned to automatic styles only.
17024
17025
17026
17027
17028

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:frame-display-scrollbar"><ref name="boolean"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 679 of 738

1702917030</optional></define>

15.28.2 Display Border
The draw:display-border attribute specifies whether or not a border is displayed on the
floating frame. This attribute can be assigned to automatic styles only.
17031
17032
17033
17034
17035
17036
17037

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:frame-display-border"><ref name="boolean"/></attribute></optional></define>

15.28.3 Margins
The draw:margin-horizontal and draw:margin-vertical attributes specify thehorizontal and vertical margins between the border and the content of the floating frame. If these
attributes are not specified, the default margins are used. These attributes can be assigned toautomatic styles only. The value of these attributes must be a length in pixels.
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:frame-margin-horizontal"><ref name="nonNegativePixelLength"/></attribute></optional><optional><attribute name="draw:frame-margin-vertical"><ref name="nonNegativePixelLength"/></attribute></optional></define>

17050
17051
17052
17053
17054
17055

<define name="nonNegativePixelLength"><data type="string"><param name="pattern">([0-9]+(\.[0-9]*)?|\.[0-9]+)(px)</param></data></define>

15.28.4 Object Formatting Properties
The attributes described in this section can be assigned to a graphic style that is assigned toobjects.

15.28.5 Visible Area
The visible area of an object is the rectangular area of the object that is currently visible. The
attributes draw:visible-area-left, draw:visible-area-top, draw:visible-areawidth and draw:visible-area-height specify a default visible area that the object has theoption to use.
When the entire object is visible, the values of the draw:visible-area-left anddraw:visible-area-top attributes are 0 and the draw:visible-area-width anddraw:visible-area-height attributes specify the size of the object. These attributes can be
assigned to automatic styles only.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 680 of 738

Not all objects support these attributes. Some objects, may store and load their own visible area.
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:visible-area-left"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="draw:visible-area-top"><ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="draw:visible-area-width"><ref name="positiveLength"/></attribute></optional><optional><attribute name="draw:visible-area-height"><ref name="positiveLength"/></attribute></optional></define>

15.28.6 Draw Aspect
For embedded OLE objects, the draw:ole-draw-aspect attribute specifies the draw aspect that isused to display embedded objects (see [OLE]). The draw aspect controls whether the object isdisplayed as a normal sub document, or whether the object is for instance displayed as an icon
only. Within the [OLE] API, the draw aspect is an unsigned integer value that the host application
passes to the object when it requests its presentation.
The draw:ole-draw-aspect attribute takes a non negative integer value and has only ameaning for objects that are embedded using the [OLE] API. In this case, its value specifies adefault value for method calls that require a draw aspect. The interpretation of this integer value isleft to the OLE object's discretion and not part of this specification.
17078
17079
17080
17081
17082
17083
17084

<define name="style-graphic-properties-attlist" combine="interleave"><optional><attribute name="draw:ole-draw-aspect"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.29 Chart Formatting Properties
The properties described in this section can be applied to all charts. They can be used within chartstyles (see section 14.16) and are contained in a <style:chart-properties> element.
17085
17086
17087
17088
17089

<define name="style-chart-properties"><element name="style:chart-properties"><ref name="style-chart-properties-content"/></element></define>

17090
17091
17092
17093

<define name="style-chart-properties-content"><ref name="style-properties-content"/></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 681 of 738

17094
17095
17096
17097
17098
17099
17100
17101
17102

<define name="style-chart-properties-content-strict"><ref name="style-chart-properties-attlist"/><ref name="style-chart-properties-elements"/></define><define name="style-chart-properties-elements"><empty/></define>

15.29.1 Scale Text
The chart:scale-text property is used to specify that all text objects in the chart should bescaled whenever the size of the chart changes. To enable scaling, set the value of this property to
true.
17103
17104
17105
17106
17107
17108
17109

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:scale-text" a:defaultValue="true"><ref name="boolean"/></attribute></optional></define>

15.30 Chart Subtype Properties
The properties described in this section can be used to customize the basic chart type set in the<chart:chart> element. They can be used within chart styles (see section 14.16) and arecontained in a <style:chart-properties> element.

15.30.1 Three-dimensional Charts
The chart:three-dimensional property specifies whether chart is displayed as a 3D scene.
17110
17111
17112
17113
17114
17115
17116

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:three-dimensional"><ref name="boolean"/></attribute></optional></define>

15.30.2 Chart Depth
The chart:deep property is only relevant with the chart:three-dimensional property. It
specifies that the data series are displayed back-to-back rather than side by side.
17117
17118
17119
17120
17121
17122
17123

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:deep"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 682 of 738

15.30.3 Chart Symbol
For some chart types, the data points can be denoted by symbols. The chart:symbol-typeattribute determines whether a symbol is used, and whether it is a pre-defined symbol type, animage, or whether the application is free to automatically choose a type out of the set of predefined symbol types, e.g., choose one symbol per series in round-robin fashion.
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168

<define name="style-chart-properties-attlist" combine="interleave"><choice><attribute name="chart:symbol-type"><value>none</value></attribute><attribute name="chart:symbol-type"><value>automatic</value></attribute><group><attribute name="chart:symbol-type"><value>named-symbol</value></attribute><attribute name="chart:symbol-name"><choice><value>square</value><value>diamond</value><value>arrow-down</value><value>arrow-up</value><value>arrow-right</value><value>arrow-left</value><value>bow-tie</value><value>hourglass</value><value>circle</value><value>star</value><value>x</value><value>plus</value><value>asterisk</value><value>horizontal-bar</value><value>vertical-bar</value></choice></attribute></group><group><attribute name="chart:symbol-type"><value>image</value></attribute><element name="chart:symbol-image"><attribute name="xlink:href"><ref name="anyURI"/></attribute></element></group><empty/></choice></define>

15.30.4 Chart Symbol Size
The width and height of each symbol can be set using the attribute chart:symbol-width andchart:symbol-length.
17169
17170
17171

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:symbol-width">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 683 of 738

17172
17173
17174
17175
17176
17177
17178
17179
17180

<ref name="nonNegativeLength"/></attribute></optional><optional><attribute name="chart:symbol-height"><ref name="nonNegativeLength"/></attribute></optional></define>

15.30.5 Bar Chart Properties
The chart:vertical and chart:connect-bars properties are for bar charts only.
chart:vertical determines whether the bars will be oriented horizontally or vertically. If
chart:connect-bars is set to true, the data points (the top of the bars) are additionallyconnected by lines.
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:vertical" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define><define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:connect-bars" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

With bar charts, the properties chart:gap-width and chart:overlap can be used to specify
the relative size and distance of bars. The chart:gap-width attribute contains the relative
width of the gap between bars for neighboring categories. The chart:overlap attributes
determines how much bars within the same category overlap. Both are integral percentages.
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:gap-width"><ref name="integer"/></attribute></optional><optional><attribute name="chart:overlap"><ref name="integer"/></attribute></optional></define>

15.30.6 Stock Chart Properties
These attributes are only effective for stock charts.
Stock charts display a span from minimum to maximum values as a straight line. Opening andclosing courses can be displayed either as left and right tick-lines, respectively, or as colored bars,
with their color depending on whether the opening value is larger than the closing value. The
chart:japanese-candle-stick attribute distinguish between those two representations.
Example: A stock chart in Japanese-candle-stick fashion (left), and as default (right).

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 684 of 738

17207
17208
17209
17210
17211
17212
17213
17214

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:japanese-candle-stick"a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

15.30.7 Line Chart Properties
For line chart-types, the attribute chart:interpolation can be set to one of the following
values:

17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235

•

none -Straight lines – don't use spline interpolation•

cubic-spline - Cubic Splines (chart:spline-resolution determines the number ofinterpolated points between two data points)•

b-spline - B-Splines (chart:spline-order determines the order of the polygons used
for calculation. The chart:spline-resolution is also taken into account.)<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:interpolation" a:defaultValue="none"><choice><value>none</value><value>cubic-spline</value><value>b-spline</value></choice></attribute></optional><optional><attribute name="chart:spline-order" a:defaultValue="2"><ref name="positiveInteger"/></attribute></optional><optional><attribute name="chart:spline-resolution" a:defaultValue="20"><ref name="positiveInteger"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 685 of 738

15.30.8 Pie Chart Properties
The chart:pie-offset attribute is only interpreted by pie charts. It determines the offset the tipof a 'pie' in a pie chart (or circle chart) has from the center of the circle.
17236
17237
17238
17239
17240
17241
17242

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:pie-offset" a:defaultValue="0"><ref name="nonNegativeInteger"/></attribute></optional></define>

15.30.9 Lines
The chart:lines property determines whether connecting lines between data points areshown. The line interpolation is determined by the chart:splines property.
17243
17244
17245
17246
17247
17248
17249

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:lines" a:defaultValue="false"><ref name="boolean"/></attribute></optional></define>

15.30.10 Solid Charts Bars
The chart:solid-type attribute determines how the bars in three-dimensional bar chartsshould be rendered.
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:solid-type" a:defaultValue="cuboid"><choice><value>cuboid</value><value>cylinder</value><value>cone</value><value>pyramid</value></choice></attribute></optional></define>

15.30.11 Stacked Chart Bars
The attribute chart:stacked attribute causes bars in bar charts to be stacked on top of eachother, instead of next to each other. If chart:percentage is set to true, the stacked bars will all
be scaled to the full height of the plot area, so that the bar segments represent the percentage of
their respective data point in the total bar stack.
17262
17263
17264
17265
17266
17267
17268
17269

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:stacked" a:defaultValue="false"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:percentage" a:defaultValue="false">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 686 of 738

17270
17271
17272
17273

<ref name="boolean"/></attribute></optional></define>

15.31 Chart Axes Properties
The properties described in this section can be applied to chart axis elements (see section 10.8).
They can be used within chart styles (see section 14.16) and are contained in a <style:chartproperties> element.

15.31.1 Linked Data Formats
The chart:link-data-style-to-source attribute can only be used in chart documents that
reside in a document that provides the data for the chart. If the value of the attribute is true, thenumber format used for rendering the axis is the format that the container document suggests
based on the selected cell range. For example, if a cell range contains currencies all formatted in€, then this format will also be used at this axis.
17274
17275
17276
17277
17278
17279
17280

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:link-data-style-to-source"><ref name="boolean"/></attribute></optional></define>

15.31.2 Visibility
To determine whether or not an axis object is visible, use the chart:axis-visible styleproperty. This way, a chart with scaling information can be provided without displaying the axis
object.
17281
17282
17283
17284
17285
17286
17287

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:visible"><ref name="boolean"/></attribute></optional></define>

15.31.3 Scaling
If a scaling attribute is omitted, the axis is set to adaptation mode. This means that the value is not
set to a fixed value but may be changed by the render application if data changes. However, thechart:axis-logarithmic attribute is set to false.
The optional chart:axis-logarithmic attribute can be used to cause logarithmic scaling on
an axis. By default, proportional scaling is used.
17288
17289
17290
17291
17292
17293
17294

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:logarithmic"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 687 of 738

The following set of optional attributes further details the scaling of an axis. The properties havethe following uses:
chart:minimum, chart:maximum – set minimal and maximal scaling values of an axis
chart:origin – determine the origin of the chart axis
chart:interval-major, chart:interval-minor-divisor – set major and minor interval
for ticks or markings on the axis. The chart:interval-major defines the interval value. The
minor interval is determined by dividing the chart:interval-major value by thechart:interval-minor-divisor.
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:maximum"><ref name="double"/></attribute></optional><optional><attribute name="chart:minimum"><ref name="double"/></attribute></optional><optional><attribute name="chart:origin"><ref name="double"/></attribute></optional><optional><attribute name="chart:interval-major"><ref name="double"/></attribute></optional><optional><attribute name="chart:interval-minor-divisor"><ref name="positiveInteger"/></attribute></optional></define>

15.31.4 Tick Marks
The tick mark properties are used to specify the existence of tick marks at an axis. The majormarks are drawn with respect to the major interval that may be specified by the chart:axisinterval-major attribute. The minor tick marks refer to the chart:axis-interval-minor
attribute. Inner marks are drawn towards the inside of the plot area, that is to the right for an axis
displayed on the left hand side of the plot area, and to the left for an axis displayed on the righthand side of the plot area. Outer marks point in the opposite direction. If both properties are
specified, one tick mark is drawn that crosses the axis.
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:tick-marks-major-inner"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:tick-marks-major-outer"><ref name="boolean"/></attribute></optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 688 of 738

17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343

<optional><attribute name="chart:tick-marks-minor-inner"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:tick-marks-minor-outer"><ref name="boolean"/></attribute></optional></define>

15.31.5 Labels
The following set of properties describes how axis labels are being represented.
chart:display-label determines whether labels will be displayed at all. If chart:textoverlap is set true, labels may overlap. text:line-break determines whether label lines may
be broken into multiple lines.
The chart:label-arrangement property allows labels to be arranged either side-by-side(i.e., all labels start on one line), or staggered (i.e., labels are distributed to two lines, with every
other label starting on the same line). In case of staggered labels, one can choose between evenor odd staggering, i.e., one can choose whether even or odd labels are aligned on the line thatwould be used for side-by-side arrangement.
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:display-label"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:text-overlap"><ref name="boolean"/></attribute></optional><optional><attribute name="text:line-break"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:label-arrangement"
a:defaultValue="side-by-side"><choice><value>side-by-side</value><value>stagger-even</value><value>stagger-odd</value></choice></attribute></optional></define>

15.32 Common Chart Properties
The properties described in this section apply to all types of data representation objects, including
the elements <chart:plot-area>, <chart:series>, and <chart:data-point>. They canbe used within chart styles (see section 14.16) and are contained in a <style:chartproperties> element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 689 of 738

Properties are applied in a hierarchical manner. If a property is set in the <chart:chart>element, it applies to all data points contained in the chart. If the same property is set in a<chart:series> element, it only applies to the data points contained in that specific series. To
set a formatting property for one data point only, set the property in the <chart:data-point>
element.

15.32.1 Stacked Text
The property style:direction determines whether or not text is displayed vertically without
rotating the letters. It can be applied to several text objects.
The value of this property can be ltr if text goes from left to right or ttb if the text is stacked,
that is goes from top to bottom. It can be applied to several text objects. See section 15.11.3 fordetails.
17371
17372
17373

<define name="style-chart-properties-attlist" combine="interleave"><ref name="common-style-direction-attlist"/></define>

15.32.2 Rotation Angle
The style:rotation-angle property specifies the value of a rotation angle in degrees. See
section 15.11.12 for information on using this property.
17374
17375
17376

<define name="style-chart-properties-attlist" combine="interleave"><ref name="common-rotation-angle-attlist"/></define>

15.32.3 Data Labels
Data labels can be applied to data series and data points as well as to an entire chart. In the latter
case, labels are shown for all data points. Data labels can consist of the following three parts:•

The value, which can be displayed as a percentage or the value itself.

•

The label of the corresponding series.

•

The legend symbol.

Value
The chart:data-label-number attribute represents the value of the data label.
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:data-label-number"><choice><value>none</value><value>value</value><value>percentage</value></choice></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 690 of 738

LabelThe chart:data-label-text attribute determines whether or not to display the label of thecorresponding series.
The value of this attribute can be true or false.
17388
17389
17390
17391
17392
17393
17394

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:data-label-text"><ref name="boolean"/></attribute></optional></define>

Legend Symbol
The chart:data-label-symbol attribute determines whether or not to display the legend
symbol. The value of this attribute can be true or false.
17395
17396
17397
17398
17399
17400
17401

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:data-label-symbol"><ref name="boolean"/></attribute></optional></define>

15.33 Statistical Properties
Statistical properties can be applied to data series or to an entire chart. In the latter case, theproperties apply to all series in the chart. They can be used within chart styles (see section 14.16)
and are contained in a <style:chart-properties> element.

15.33.1 Mean Value
The chart:mean-value attribute determines whether or not to display a line that represents thestatistical mean value of all data points of a series. The value of this attribute can be true or
false.
17402
17403
17404
17405
17406
17407
17408

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:mean-value"><ref name="boolean"/></attribute></optional></define>

15.33.2 Error Category
The chart:error-category attribute is used to determine which function is used to display
error indicators at data points. The following functions are available:•

Variance of the values of a series assuming an equal distribution.

•

Standard-deviation of the values of a series assuming an equal distribution.

•

Use a fixed percentage of each value

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 691 of 738

•

Use a fixed percentage of the biggest value – this is called error-margin.

•

Use fixed absolute values for both directions: positive and negative

If this attribute is set to any value other than none, error indicators are shown. To determine inwhich direction the indicators are pointing see the attributes chart:error-upper-indicatorand chart:error-lower-indicator.
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:error-category" a:defaultValue="none"><choice><value>none</value><value>variance</value><value>standard-deviation</value><value>percentage</value><value>error-margin</value><value>constant</value></choice></attribute></optional></define>

Error Percentage
The chart:error-percentage attribute determines the percentage that is used to display
error indicators for each data point of a series.
17423
17424
17425
17426
17427
17428
17429

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:error-percentage"><ref name="double"/></attribute></optional></define>

Error Margin
The chart:error-margin attribute determines the percentage that is used to display error
indicators for the biggest value in a series.
17430
17431
17432
17433
17434
17435
17436

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:error-margin"><ref name="double"/></attribute></optional></define>

Constant Error Lower and Upper Limit
If the error category is set to constant, the chart:error-lower-limit and chart:errorupper-limit attributes determine the absolute values in a positive and negative direction thatare used to display the error indicators.
17437
17438
17439
17440
17441

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:error-lower-limit"><ref name="double"/></attribute>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 692 of 738

17442
17443
17444
17445
17446
17447
17448

</optional><optional><attribute name="chart:error-upper-limit"><ref name="double"/></attribute></optional></define>

Error Indicators
The chart:error-lower-indicator and chart:error-upper-indicator attributes
determine in which direction indicators should be drawn.
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:error-upper-indicator"><ref name="boolean"/></attribute></optional><optional><attribute name="chart:error-lower-indicator"><ref name="boolean"/></attribute></optional></define>

15.34 Plot Area Properties
The properties described in this section can be applied to chart plot area elements (see section
10.5). They can be used within chart styles (see section 14.16) and are contained in a<style:chart-properties> element.

15.34.1 Series Source
The chart:series-source attribute determines whether the data table contains the data
series in column-wise or row-wise fashion.
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:series-source" a:defaultValue="columns"><choice><value>columns</value><value>rows</value></choice></attribute></optional></define>

15.35 Regression Curve Properties
The properties described in this section can be applied to chart regression curves elements (seesection 10.14). They can be used within chart styles (see section 14.16) and are contained in a<style:chart-properties> element.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 693 of 738

15.35.1 Regression TypeUse the chart:regression-type attribute to display a regression for a series. A regression
can be used to approximate the data points in a series by a mathematical function. The following
models for approximation are available:•

Linear regression – approximate the values of the series using the model: y = A·x + B.

•

Logarithmic regression – approximate the values of the series using the model: y = A·log(x) +B.

•

Exponential regression – approximate the values of the series using the model: y = A·eB·x.

•

Regression with a power function – approximate the values of the series using the model: y =A·xB.

This property is only relevant in scatter charts, because regression needs both x and y values forcalculation
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483

<define name="style-chart-properties-attlist" combine="interleave"><optional><attribute name="chart:regression-type" a:defaultValue="none"><choice><value>none</value><value>linear</value><value>logarithmic</value><value>exponential</value><value>power</value></choice></attribute></optional></define>

15.36 Presentation Page Attributes
The properties described in this section can be contained within style elements <style:style>whose family is drawing-page. They are contained in a <style:style-drawpageproperties> element.
The following presentation properties do exist:•

Transition Type•Transition Style•

Transition Speed•

Page Duration•

Page Visibility

•

Sound

•

Background Size•

Background Objects Visible•

Background Visible•

Display Header•

Display Footer

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 694 of 738

•Display Page Number•

Display Date and Time15.36.1 Transition TypeThe mode of transition, for example manual, can be set using the attributepresentation:transition-type.

17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495

•

manual: slide transition and shape effects must be started separately by the user.

•

automatic: slide transition and shape effects start automatically.

•semi-automatic: slide transition starts automatically, shape effects must be started by theuser.

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:transition-type"><choice><value>manual</value><value>automatic</value><value>semi-automatic</value></choice></attribute></optional></define>

15.36.2 Transition Style
The attribute presentation:transition-style specifies the way that each presentation
page replaces the previous presentation page, for example left-to-right replacement, or fading.
•none: no effect is used.

•fade-*: the pages fades from a visible or hidden state to a hidden or visible state in thespecified direction.

•

move-*: the page moves in the specified direction to its final position.

•

uncover-*: the page get uncovered in the specified direction.

•*-stripes: the page is uncovered by drawing horizontal or vertical stripes that change theirsize during this effect.

•

clockwise: the page is uncovered by the hand of a watch, moving clockwise.

•

counterclockwise: the page is uncovered by the hand of a watch, moving
counterclockwise.

•

open-*: the page is uncovered by drawing it line by line, either horizontally or vertically,
starting at the center of the page.

•close-*: the page is uncovered by drawing it line by line, either horizontally or vertically,
starting at the edge of the page.

•

wavyline-*: the page is uncovered by drawing small blocks in a snake like fashion.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 695 of 738

17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519

•

spiralin-*: the page is uncovered by drawing blocks in a spiral fashion, starting from theedge of the page.

•spiralout-*: the page is uncovered by drawing blocks in a spiral fashion, starting from thecenter of the page.

•roll-*: the pages moves in the specified direction to its final position, pushing the old pageout.

•

stretch-*: the page is uncovered by changing its size during this effect.

•*-lines: the page is uncovered by drawing it line by line, either horizontally or vertically in arandom fashion.

•dissolve: the page is faded in by drawing small blocks in a random fashion.

•

random: an effect is chosen at random to uncover the page.

•*-checkerboard: the page is uncovered by drawing checkerboard like blocks that increasein size horizontally or vertically.

•

interlocking-horizontal-*: the new page appears in 4 horizontal stripes (i.e., theheight is divided in 4, a bit like in the horizontal-stripes effect) but those stripes come from left,right, left, and right, and cross each other in the middle of the screen.

•interlocking-vertical-*: similar effect with vertical stripes crossing each other.

•fly-away: the page first reduces itself to a smaller size (while remaining centered in thescreen), and then "flies away" (turns around a bit and moves to the bottom-right corner of thescreen). The next slide appears under it meanwhile.

•

open: Combination of open-horizontal and open-vertical, i.e., a sort of plus sign opening.

•close: Combination of close-horizontal and close-vertical, i.e., a sort of plus sign closing.

•melt: Small vertical stripes move down at random speed, which gives the effect of the current
page "melting down".

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:transition-style"><choice><value>none</value><value>fade-from-left</value><value>fade-from-top</value><value>fade-from-right</value><value>fade-from-bottom</value><value>fade-from-upperleft</value><value>fade-from-upperright</value><value>fade-from-lowerleft</value><value>fade-from-lowerright</value><value>move-from-left</value><value>move-from-top</value><value>move-from-right</value><value>move-from-bottom</value><value>move-from-upperleft</value><value>move-from-upperright</value><value>move-from-lowerleft</value><value>move-from-lowerright</value><value>uncover-to-left</value><value>uncover-to-top</value>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 696 of 738

17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570

<value>uncover-to-right</value><value>uncover-to-bottom</value><value>uncover-to-upperleft</value><value>uncover-to-upperright</value><value>uncover-to-lowerleft</value><value>uncover-to-lowerright</value><value>fade-to-center</value><value>fade-from-center</value><value>vertical-stripes</value><value>horizontal-stripes</value><value>clockwise</value><value>counterclockwise</value><value>open-vertical</value><value>open-horizontal</value><value>close-vertical</value><value>close-horizontal</value><value>wavyline-from-left</value><value>wavyline-from-top</value><value>wavyline-from-right</value><value>wavyline-from-bottom</value><value>spiralin-left</value><value>spiralin-right</value><value>spiralout-left</value><value>spiralout-right</value><value>roll-from-top</value><value>roll-from-left</value><value>roll-from-right</value><value>roll-from-bottom</value><value>stretch-from-left</value><value>stretch-from-top</value><value>stretch-from-right</value><value>stretch-from-bottom</value><value>vertical-lines</value><value>horizontal-lines</value><value>dissolve</value><value>random</value><value>vertical-checkerboard</value><value>horizontal-checkerboard</value><value>interlocking-horizontal-left</value><value>interlocking-horizontal-right</value><value>interlocking-vertical-top</value><value>interlocking-vertical-bottom</value><value>fly-away</value><value>open</value><value>close</value><value>melt</value></choice></attribute></optional></define>

15.36.3 Transition Speed
The attribute presentation:transition-speed controls the speed at which a presentation
page is removed from display, and replaced by a new presentation page. See also section 9.7.2.
17571
17572
17573
17574

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:transition-speed">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 697 of 738

17575
17576
17577
17578

<ref name="presentationSpeeds"/></attribute></optional></define>

15.36.4 Transition Type or Family
The [SMIL20] smil:type attribute is used to specify the transition type or family. See §12.4.1 of[SMIL20] for details. See §12.8 of [SMIL20] for a list of supported types.
If this attribute is present, the attributes presentation:transition-type andpresentation:transition-style attributes should be ignored.
17579
17580
17581
17582
17583
17584
17585

<define name="style-drawing-page-properties-attlist " combine="interleave"><optional><attribute name="smil:type"><ref name="string"/></attribute></optional></define>

15.36.5 Transition Subtype
The [SMIL20] smil:subtype attribute is used to specify the transition subtype. See §12.4.1 of[SMIL20] for details. See §12.8 of [SMIL20] for a list of supported subtypes.
17586
17587
17588
17589
17590
17591
17592

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="smil:subtype"><ref name="string"/></attribute></optional></define>

15.36.6 Transition Direction
The [SMIL20] smil:direction attribute is used to specify the transition direction. See §12.4.1
of [SMIL20] for details.
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="smil:direction" a:defaultValue="forward"><choice><value>forward</value><value>reverse</value></choice></attribute></optional></define>

15.36.7 Fade Color
The [SMIL20] smil:fadeColor attribute is used to specify the transition fade color fortransitions that make use of a start or end color. See §12.4.1 of [SMIL20] for details.
17603
17604
17605
17606

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="smil:fadeColor"><ref name="color"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 698 of 738

1760717608
17609</attribute></optional></define>

15.36.8 Page Duration
The attribute presentation:page-duration controls the amount of time that the presentation
page is displayed. The value of this attribute must conform to the time period format described in§3.2.6 of [xmlschema-2].
17610
17611
17612
17613
17614
17615
17616
17617

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:duration"><ref name="duration"/></attribute></optional></define>

15.36.9 Page Visibility
A drawing page can be marked as hidden during a presentation by using the attributepresentation:visibility. A page marked with this attribute is only shown while editing the
document but not during the presentation.
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:visibility"><choice><value>visible</value><value>hidden</value></choice></attribute></optional></define>

15.36.10 Sound
Sound effects can be added to your presentation pages using the element
presentation:sound. It must be included in the <style:presentation-properties>
element.
17629
17630
17631
17632
17633
17634

<define name="style-drawing-page-properties-elements"
combine="interleave"><optional><ref name="presentation-sound"/></optional></define>

15.36.11 Background Size
The attribute draw:background-size specifies whether the background of a page is renderedon the full page or only inside the borders of the page.
17635
17636
17637

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 699 of 738

17638
17639
17640
17641
17642
17643
17644
17645

<attribute name="draw:background-size"><choice><value>full</value><value>border</value></choice></attribute></optional></define>

15.36.12 Background Objects Visible
The attribute presentation:background-objects-visible specifies whether or not tohide objects on the background of the master page when displaying the presentation page.
17646
17647
17648
17649
17650
17651
17652
17653

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:background-objects-visible"><ref name="boolean"/></attribute></optional></define>

15.36.13 Background Visible
The attribute presentation:background-visible specifies whether or not to hide thebackground of the master page when displaying the presentation page.
17654
17655
17656
17657
17658
17659
17660
17661

<define name="style-drawing-page-properties-attlist"
combine="interleave"><optional><attribute name="presentation:background-visible"><ref name="boolean"/></attribute></optional></define>

15.36.14 Display Header
The presentation:display-header attribute sets the visibility of presentation shapes fromthe master page with the presentation class header (see section 9.6.1).
17662
17663
17664
17665
17666
17667
17668

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="presentation:display-header"><ref name="boolean"/></attribute></optional></define>

15.36.15 Display Footer
The presentation:display-footer attribute sets the visibility of presentation shapes fromthe master page with the presentation class footer (see section 9.6.1).
17669
17670
17671
17672

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="presentation:display-footer"><ref name="boolean"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 700 of 738

17673
17674
17675</attribute></optional></define>

15.36.16 Display Page Number
The presentation:display-page-number attribute sets the visibility of presentation shapes
from the master page with the presentation class page-number (see section 9.6.1).
17676
17677
17678
17679
17680
17681
17682

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="presentation:display-page-number"><ref name="boolean"/></attribute></optional></define>

15.36.17 Display Date And Time
The presentation:display-date-time attribute sets the visibility of presentation shapes
from the master page with the presentation class date-time (see section 9.6.1).
17683
17684
17685
17686
17687
17688
17689

<define name="style-drawing-page-properties-attlist" combine="interleave"><optional><attribute name="presentation:display-date-time"><ref name="boolean"/></attribute></optional></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 701 of 738

16 Data Types and Schema Definitions
16.1 Data Types
The following data types are used within this specification:•

W3C Schema data types as defined in [xmlschema-2] (referenced by <ref> elements
named the same as the corresponding data types)–

string

–

date

–

time

–

dateTime–duration–

integer–

nonNegativeInteger–

positiveInteger–

double–anyURI–

base64Binary

–

ID

–

IDREF

–

IDREFS

Relax-NG definitions for the W3C schema data types:
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709

<define name="string"><data type="string"/></define><define name="date"><data type="date"/></define><define name="time"><data type="time"/></define><define name="dateTime"><data type="dateTime"/></define><define name="duration"><data type="duration"/></define><define name="integer"><data type="integer"/></define><define name="nonNegativeInteger"><data type="nonNegativeInteger"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 702 of 738

17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731

</define><define name="positiveInteger"><data type="positiveInteger"/></define><define name="double"><data type="double"/></define><define name="anyURI"><data type="anyURI"/></define><define name="base64Binary"><data type="base64Binary"/></define><define name="ID"><data type="ID"/></define><define name="IDREF"><data type="IDREF"/></define><define name="IDREFS"><data type="IDREFS"/></define>•custom data types (usually specializations of W3C Schema data types)–

boolean
A Boolean value may have either of the values true or false.

–

dateOrDateTime
A dateOrDateTime value is essentially an [xmlschema-2] date and time value with an
optional time component. In other words, it may contain either a date, or a date and timevalue.

–

timeOrDateTime
A timeOrDateTime value is essentially an [xmlschema-2] date and time value with an
optional date component. In other words, it may contain either a time, or a date and timevalue.

–

language
A language is the same as an [xmlschema-2] language data type.

–

countryCode
A countryCode is a country code in conformance with [RFC3066], as specified in [XSL].

–

languageCode
A languageCode is a language code in conformance with [RFC3066], as specified in[XSL].

–

characterA character value is a string with only one character.

–lengthA (positive or negative) physical length, consisting of magnitude and unit, in conformancewith §5.9.11 of [XSL]. Supported units are „cm“, „mm“, „in“, „pt“ and „pc“. Applications
shall support all these units. Applications may also support “px” (pixel). Where the

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 703 of 738

description of an attribute explicitly states that pixel lengths are supported, applications
should support them.
Examples for valid lengths are “2.54cm” and “1in”.
–

nonNegativeLength
Like length, except that the value must be zero or positive.

–

positiveLength
Like length, except that the value must be positive.

–

percent(Positive or negative) percentage values in conformance with §5.9.11 of [XSL], e.g.,“40%”.

–

relativeLength
A relative length is a positive integer, followed by a '*' character.

–coordinate
Like a length, except that the physical length denotes a certain point.

–

distance
Like a length, except that the physical length measures the distance between to points.

–

color
A RGB color in conformance with §5.9.11 of [XSL], that is a RGB color in notation“#rrggbb”, where rr, gg and bb are hexadecimal digits.

–styleNameA NCName as specified in [xmlschema-2] that is the name of a style.

–

StyleNameRef
A NCName as specified in [xmlschema-2] that is the name of a referenced style, or an
empty value.

–

StyleNames
A whitespace separated list of NCNames as specified in [xmlschema-2] that are thenames of a styles.

–

VariableName
A string specifying the name of a variable–

formulaA string containing a formula. Formulas don't have a predefined syntax, but should startwith a namespace prefix that specifies the syntax used within the formula.

–valueTypeA list of value types supported for certain generic values, such as “string” or “date”.

–

targetFrameName
The name of a target frame in conformance with §6.16 of [HTML4].

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 704 of 738

–points
A sequence of points. The points are two integer coordinates separated by a comma. The
points are separated by white space.

–

pathData
Path data as described in §8 of [SVG].

–

vector3D
A 3-element vector that is represented by floating point x,y,z coordinates. The coordinates
are encapsulated between parentheses and the coordinates are noted in the order x, y
and z, separated by whitespaces. If this value represents a normal, then it should benormalized.
Example: A directional vector with the coordinates x = 0.5, y = 0 and z = 1 looks like "(0.5
0 1)".

–

namespacedToken
A namespaced token is a token id that makes use of the XML namespace mechanism formodularization purposes.
Example: The predefined chart types make use of the chart namespace
urn:oasis:names:tc:opendocument:xmlns:chart:1.0. Assuming a namespace declarationof xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0", a bar chart
would be identified as chart:bar.

Relax-NG definitions for custom data types:
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763

<define name="boolean"><choice><value>true</value><value>false</value></choice></define><define name="dateOrDateTime"><choice><data type="date"/><data type="dateTime"/></choice></define><define name="timeOrDateTime"><choice><data type="time"/><data type="dateTime"/></choice></define><define name="language"><data type="language"/></define><define name="countryCode"><data type="token"><param name="pattern">[A-Za-z0-9]{1,8}</param></data></define><define name="languageCode"><data type="token"><param name="pattern">[A-Za-z]{1,8}</param></data></define><define name="character">

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 705 of 738

17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824

<data type="string"><param name="length">1</param></data></define><define name="length"><data type="string"><param name="pattern">-?([0-9]+(\.[0-9]*)?|\.[0-9]+)((cm)|(mm)|(in)|(pt)|(pc)|(px))</param></data></define><define name="nonNegativeLength"><data type="string"><param name="pattern">([0-9]+(\.[0-9]*)?|\.[0-9]+)((cm)|(mm)|(in)|(pt)|(pc)|(px))</param></data></define><define name="positiveLength"><data type="string"><param name="pattern">([0-9]*[1-9][0-9]*(\.[0-9]*)?|0+\.[0-9]*[1-9][09]*|\.[0-9]*[1-9][0-9]*)((cm)|(mm)|(in)|(pt)|(pc)|(px))</param></data></define><define name="percent"><data type="string"><param name="pattern">-?([0-9]+(\.[0-9]*)?|\.[0-9]+)%</param></data></define><define name="relativeLength"><data type="string"><param name="pattern">[0-9]+\*</param></data></define><define name="coordinate"><ref name="length"/></define><define name="distance"><ref name="length"/></define><define name="color"><data type="string"><param name="pattern">#[0-9a-fA-F]{6}</param></data></define><define name="styleName"><data type="NCName"/></define><define name="styleNameRef"><choice><data type="NCName"/><empty/></choice></define><define name="styleNameRefs"><list><zeroOrMore><data type="NCName"/></zeroOrMore></list></define><define name="variableName"><data type="string"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 706 of 738

17825
17826
17827
17828
17829
17830

</define><define name="formula"><!-- A formula should start with a namespace prefix, --><!-- but has no restrictions--><data type="string"/></define>

17831
17832
17833
17834
17835
17836
17837
17838
17839
17840

<define name="targetFrameName"><choice><value>_self</value><value>_blank</value><value>_parent</value><value>_top</value><ref name="string"/></choice></define>

17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852

<define name="valueType"><choice><value>float</value><value>time</value><value>date</value><value>percentage</value><value>currency</value><value>boolean</value><value>string</value></choice></define>

17853
17854
17855
17856
17857
17858
17859
17860
17861

<define name="points"><data type="string"><param name="pattern">-?[0-9]+,-?[0-9]+([ ]+-?[0-9]+,-?[0-9]+)*</param></data></define><define name="pathData"><data type="string"/></define>

17862
17863
17864
17865
17866
17867
17868

<define name="vector3D"><data type="string"><param name="pattern">\([ ]*-?([0-9]+(\.[0-9]*)?|\.[0-9]+)([ ]+-?([09]+(\.[0-9]*)?|\.[0-9]+)){2}[ ]*\)</param></data></define>

17869
17870
17871
17872
17873
17874

<define name="namespacedToken"><data type="string"><param name="pattern">[0-9a-zA-Z_]+:[0-9a-zA-Z._\-]+</param></data></define>

16.2 Other Definitions
To provide for extensibility of the format, inclusion of custom content is allowed on several
occasions. The following definitions allow for inclusion of arbitrary attributes or elements (witharbitrary content models).
17875
17876
17877
17878

<define name="anyAttListOrElements"><zeroOrMore><attribute><anyName/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 707 of 738

17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893

<text/></attribute></zeroOrMore><ref name="anyElements"/></define><define name="anyElements"><zeroOrMore><element><anyName/><mixed><ref name="anyAttListOrElements"/></mixed></element></zeroOrMore></define>

16.3 Relax-NG Schema Suffix
Suffix for the normative Relax-NG schema:
17894</grammar>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 708 of 738

17 Packages
This chapter describes the package format that optionally can be used in OpenDocument. It
contains the following sections:•Introduction•

Zip File Structure•

Encryption•

Preview Image•

Manifest File17.1 Introduction
As XML has no native support for binary objects such as images, [OLE] objects, or other media
types, and because uncompressed XML files can get very large, OpenDocument uses a package
file to store the XML content of a document together with its associated binary data, and tooptionally compress the XML content. This package is a standard Zip file, whose structure isdiscussed below.
Information about the files contained in the package is stored in an XML file called the manifest
file. The manifest file is always stored at the pathname META-INF/manifest.xml. The main pieces
of information stored in the manifest are as follows:•

A list of all of the files in the package.

•

The media type of each file in the package.

•

If a file stored in the package is encrypted, the information required to decrypt the file is stored
in the manifest.

17.2 Zip File Structure
A Zip file starts with a sequence of files, each of which can be compressed or stored in raw
format. Each file has a local header immediately before its data, which contains most of theinformation about the file, including time-stamps, compression method and file name. The
compressed file contents immediately follow, and are terminated by an optional data descriptor.
The data descriptor contains the CRC and compressed size of the file, which are frequently notavailable when writing the local file header. If these details were included, the data descriptor canbe skipped.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 709 of 738

Each file in the archive is laid down
sequentially in this format, followed by acentral directory at the end of the Zip archive.
The central directory is a contiguous set of
directory entries, each of which contains all
the information in the local file header, plus
extras such as file comments and attributes.
Most importantly, the central directory
contains pointers to the position of each file in
the archive, which makes navigation of theZip file quick and easy.
For more details about the Zip file format, see[ZIP].

17.3 Encryption
The encryption process takes place in thefollowing multiple stages:
1. A 20-byte SHA1 digest of the user enteredpassword is created and passed to the
package component.
2. The package component initializes arandom number generator with the currenttime.
3. The random number generator is used to generate a random 8-byte initialization vector and16-byte salt for each file.
4. This salt is used together with the 20-byte SHA1 digest of the password to derive a unique
128-bit key for each file. The algorithm used to derive the key is PBKDF2 using HMAC-SHA-1(see [RFC2898]) with an iteration count of 1024.
5. The derived key is used together with the initialization vector to encrypt the file using theBlowfish algorithm in cipher-feedback (CFB) mode.
Each file that is encrypted is compressed before being encrypted. To allow the contents of the
package file to be verified, it is necessary that encrypted files are flagged as 'STORED' rather
than 'DEFLATED'. As entries which are 'STORED' must have their size equal to the compressed
size, it is necessary to store the uncompressed size in the manifest. The compressed size isstored in both the local file header and central directory record of the Zip file.

17.4 MIME Type Stream
If a MIME type for a document that makes use of packages is existing, then the package should
contain a stream called "mimetype". This stream should be first stream of the package's zip file, it
shall not be compressed, and it shall not use an 'extra field' in its header (see [ZIP]).
The purpose is to allow packaged files to be identified through 'magic number' mechanisms, suchas Unix's file/magic utility. If a ZIP file contains a stream at the beginning of the file that is
uncompressed, and has no extra data in the header, then the stream name and the stream
content can be found at fixed positions. More specifically, one will find:•a string 'PK' at position 0 of all zip files•

a string 'mimetype' at position 30 of all such package files

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 710 of 738

•

the mimetype itself at position 38 of such a package.

17.5 Usage of IRIs Within Packages
Within a file that is contained in a package, relative IRIs are used to reference other sub files ofthe package, but can also be used to reference files within the file system.
The following restrictions exist for IRIs that are used within a package:•

only sub files within the same package and files outside the package can be referenced.

•

IRIs that reference a sub file of a package shall be relative, and they shall not contain paths
that are not within the package. This especially means that sub files of a package shall not
be referenced by an absolute IRI.

•

sub file of a package can not be referenced from outside the package, for instance from thefile system or another package.

A relative-path reference (as described in §6.5 of [RFC3987]) that occurs in a file that is containedin a package has to be resolved exactly as it would be resolved if the whole package gets
unzipped into a directory at its current location. The base IRI for resolving relative-path referencesis the one that has to be used to retrieve the (unzipped) file that contains the relative-pathreference.
All other kinds of IRI references, namely the ones that start with a protocol (like http:), an authority(i.e., //) or an absolute-path (i.e., /) do not need any special processing. This especially means thatabsolute-paths do not reference files inside the package, but within the hierarchy the package iscontained in, for instance the file system. IRI references inside a package may leave the package,
but once they have left the package, they never can return into the package or another one.

17.6 Preview Image
A thumbnail representation of a document should be generated by default when the file is saved.
It should be a representation of the first page, first sheet, etc. of the document. For maximum
reusability of the thumbnails they have to be generated without any effects, surrounding frames, orborders. Such effects might interfere with effects added to the thumbnails by the different filesystem explorers or may not be desired at all for certain use cases.
The thumbnail must be saved as “thumbnail.png” in a separate folder named “Thumbnails”.
The “Thumbnails” folder must not get a media type in the manifest.xml file, since it is not actuallypart of the document.
Encrypted files are intended to be unreadable for unauthorized users that's why a thumbnail forsuch files must not be generated. Instead of saving a thumbnail of the first page a replacement
representation that doesn't depend on the contents of the document is saved for encrypted files
which makes obvious that the corresponding file is encrypted.
In order to conform to the Thumbnail Managing Standard (TMS) at www.freedesktop.org,
thumbnails must be saved as 24bit, non-interlaced PNG image with full alpha transparency. The
required size for the thumbnails is 128x128 pixel.

17.7 Manifest File
The elements and attributes in the manifest file are in the namespace:
urn:oasis:names:tc:opendocument:xmlns:manifest:1.0.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 711 of 738

17.7.1 Relax-NG Schema
The normative XML Schema for OpenDocument Manifest files is embedded within thisspecification. It can be obtained from the specification document by concatenating all schema
fragments contained in this chapters. All schema fragments have a gray background color andline numbers.
The schema language used within this specification is Relax-NG (see [RNG]).
Prefix for the normative Relax-NG Manifest schema:
1
2
3
4
5

<?xml version="1.0" encoding="UTF-8"?><!-OASIS OpenDocument v1.1
OASIS Standard, 1 Feb 2007
Relax-NG Manifest Schema

6
7
8
9
10
11
12
13
14

$Id$
© 2002-2007 OASIS Open© 1999-2007 Sun Microsystems, Inc.
-->
<grammar
xmlns="http://relaxng.org/ns/structure/1.0"

15
16

datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"

17
18

xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">

17.7.2 Manifest Root Element
The root element is called manifest. The root element contains one fixed attribute which specifies
the namespace as described above and multiple <manifest:file-entry> elements, each ofwhich describes a single file in the package.
19
20
21
22
23
24
25

<define name="manifest"><element name="manifest:manifest"><oneOrMore><ref name="file-entry"/></oneOrMore></element></define>

26
27
28
29
30
31

<start><choice><ref name="manifest"/></choice></start>17.7.3 File Entry
The <manifest:file-entry> element represents a single file within the package, and storesthe files location in the package, the mime-type of the file and optionally the data required todecrypt this file.
Directories only receive <manifest:file-entry> entries if they have inherent semantics. For
example, a directory that constitutes a sub-document referenced as an object from within themain document would contain a <manifest:file-entry> with a suitable media type. A

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 712 of 738

directory for administrative or convenience purposes, such as a directory that contains various
image files, would not receive an entry in the manifest file.
32
33
34
35
36
37
38
39

<define name="file-entry"><element name="manifest:file-entry"><ref name="file-entry-attlist"/><optional><ref name="encryption-data"/></optional></element></define>

The attributes associated with a <manifest:file-entry> are as follows:•

Full path

•

Size

•

Media type

Full Path
The manifest:full-path attribute describes the location of the file within the package.
40
41
42
43
44

<define name="file-entry-attlist" combine="interleave"><attribute name="manifest:full-path"><data type="string"/></attribute></define>

Size
The manifest:size attribute is only present if the file is stored in an encrypted format. The
reason why this attribute is required is explained in section 17.3. This attribute is only used forencrypted files.
45
46
47
48
49
50
51

<define name="file-entry-attlist" combine="interleave"><optional><attribute name="manifest:size"><data type="nonNegativeInteger"/></attribute></optional></define>

Media TypeThe manifest:media-type attribute specifies the mime type of the specified file. For a full listof mime types see http://www.isi.edu/in-notes/iana/assignments/media-types/media-types. As an
example, all XML streams have the media type "text/xml".
52
53
54
55
56

<define name="file-entry-attlist" combine="interleave"><attribute name="manifest:media-type"><data type="string"/></attribute></define>

17.7.4 Encryption Data
The <manifest:encryption-data> element contains all of the information required todecrypt the file.
OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 713 of 738

57
58
59
60
61
62
63

<define name="encryption-data"><element name="manifest:encryption-data"><ref name="encryption-data-attlist"/><ref name="algorithm"/><ref name="key-derivation"/></element></define>

The <encryption-data> element contains the following elements:•

Algorithm•

Key Derivation

Checksum TypeThe manifest:checksum-type attribute specifies the name of digest algorithm that can beused to check password correctness. Currently, the only supported digest algorithm is SHA1.
64
65
66
67
68

<define name="encryption-data-attlist" combine="interleave"><attribute name="manifest:checksum-type"><data type="string"/></attribute></define>

Checksum
The manifest:checksum attribute specifies the digest in BASE64 encoding (as defined in[RFC2045]) that can be used to detect password correctness as specified within
manifest:checksum-type attribute.
69
70
71
72
73

<define name="encryption-data-attlist" combine="interleave"><attribute name="manifest:checksum"><data type="base64Binary"/></attribute></define>

17.7.5 Algorithm
The <manifest:algorithm> element contains information about the algorithm used to encrypt
the data.
74
75
76
77
78
79

<define name="algorithm"><element name="manifest:algorithm"><ref name="algorithm-attlist"/><empty/></element></define>

The attributes associated with <manifest:algorithm> are as follows:•

Algorithm name•

Initialization vector

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 714 of 738

Algorithm Name
The manifest:algorithm-name attribute specifies the name of the algorithm used to encrypt
the file, and also specifies in which mode this algorithm was used. Currently, the only supports
algorithm is the Blowfish algorithm in CFB mode.
80
81
82
83
84

<define name="algorithm-attlist" combine="interleave"><attribute name="manifest:algorithm-name"><data type="string"/></attribute></define>

Initialization Vector
The manifest:initialisation-vector attribute specifies the 8 bytes used as an
initialization vector to the stream cipher. The initialization vector is an 8 byte binary sequence, andso is encoded in BASE64 (as defined in [RFC2045]) when written to the manifest file.
85
86
87
88
89

<define name="algorithm-attlist" combine="interleave"><attribute name="manifest:initialisation-vector"><data type="base64Binary"/></attribute></define>

17.7.6 Key Derivation
The <manifest:key-derivation> element contains the information that was used to derive
the encryption key for this file from the user specified password.
90
91
92
93
94
95

<define name="key-derivation"><element name="manifest:key-derivation"><ref name="key-derivation-attlist"/><empty/></element></define>

The attributes associated with the <manifest:key-derivation> element are as follows:•

Key derivation name

•

Salt

•

Iteration count

Key Derivation Name
The manifest:key-derivation-name attribute specifies the name of the algorithm used toderive the name. At this time, the packages only supports the use of the PBKDF2 key derivation
method. For further details see [RFC2898].
96
97
98
99
100

<define name="key-derivation-attlist" combine="interleave"><attribute name="manifest:key-derivation-name"><data type="string"/></attribute></define>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 715 of 738

Salt
The manifest:salt attribute specifies the 16-byte sequence used as the 'salt' by the key
derivation algorithm. The salt is a 16-byte binary sequence, and thus is encoded in BASE64 (asdefined in [RFC2045]) before being written to the manifest file.
101
102
103
104
105

<define name="key-derivation-attlist" combine="interleave"><attribute name="manifest:salt"><data type="base64Binary"/></attribute></define>

Iteration CountThe manifest:iteration-count attribute specifies the number of iterations used by the key
derivation algorithm to derive the key.
106
107
108
109
110

<define name="key-derivation-attlist" combine="interleave"><attribute name="manifest:iteration-count"><data type="nonNegativeInteger"/></attribute></define>

Sample Manifest<manifest:manifest
xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0"><manifest:file-entry
manifest:media-type="application/vnd.oasis.opendocument.text"
manifest:full-path="/"/><manifest:file-entry manifest:media-type="image/jpeg"
manifest:full-path="Pictures/100000000000032000000258912EB1C3.jpg"
manifest:size="66704"><manifest:encryption-data><manifest:algorithm manifest:algorithm-name="Blowfish CFB"
manifest:initialisation-vector="T+miu403484="/><manifest:key-derivation manifest:key-derivation-name="PBKDF2"
manifest:iteration-count="1024"
manifest:salt="aNYdmqv4cObAJSJjm4RzqA=="/></manifest:encryption-data></manifest:file-entry><manifest:file-entry
manifest:media-type="text/xml" manifest:full-path="content.xml"
manifest:size="3143"><manifest:encryption-data><manifest:algorithm manifest:algorithm-name="Blowfish CFB"
manifest:initialisation-vector="T+miu403484="/><manifest:key-derivation manifest:key-derivation-name="PBKDF2"
manifest:iteration-count="1024"
manifest:salt="aNYdmqv4cObAJSJjm4RzqA=="/></manifest:encryption-data></manifest:file-entry><manifest:file-entry manifest:media-type="text/xml"
manifest:full-path="styles.xml" manifest:size="5159"><manifest:encryption-data><manifest:algorithm manifest:algorithm-name="Blowfish CFB"
manifest:initialisation-vector="bChL2No5I+A="/><manifest:key-derivation manifest:key-derivation-name="PBKDF2"
manifest:iteration-count="1024"
manifest:salt="/kfasyu7X0Ae+1uopdeCtA=="/></manifest:encryption-data></manifest:file-entry>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 716 of 738

<manifest:file-entry
manifest:media-type="text/xml" manifest:full-path="meta.xml"/><manifest:file-entry
manifest:media-type="text/xml"
manifest:full-path="settings.xml" manifest:size="5317"><manifest:encryption-data><manifest:algorithm manifest:algorithm-name="Blowfish CFB"
manifest:initialisation-vector="JQxEm6rD+4c="/><manifest:key-derivation manifest:key-derivation-name="PBKDF2"
manifest:iteration-count="1024"
manifest:salt="PlpDaxloh4KUKx+v1g4V9g=="/></manifest:encryption-data></manifest:file-entry></manifest:manifest>

17.7.7 Relax-NG Schema Suffix
Suffix for the normative Relax-NG Manifest schema:111</grammar>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 717 of 738

Appendix A.Strict Relax NG Schema
The Relax-NG (see [RNG])schema provided in this appendix equals the schema defined inchapters 1 to 16 of this specification, but restricts the content of meta information elements andformatting properties elements to the attributes and elements defined in this specification. See
also section 1.5.
1
2
3
4
5

<?xml version="1.0" encoding="UTF-8"?><!-OASIS OpenDocument v1.1
OASIS Standard, 1 Feb 2007
Strict Relax-NG Schema

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

$Id$
© 2002-2007 OASIS Open© 1999-2007 Sun Microsystems, Inc.
-->
<grammar xmlns="http://relaxng.org/ns/structure/1.0"><include href="OpenDocument-schema-v1.1.rng"><define name="office-meta-content"><ref name="office-meta-content-strict"/></define><define name="style-page-layout-properties-content"><ref name="style-page-layout-properties-content-strict"/></define><define name="style-header-footer-properties-content"><ref name="style-header-footer-properties-content-strict"/></define><define name="style-drawing-page-properties-content"><ref name="style-drawing-page-properties-content-strict"/></define><define name="style-text-properties-content"><ref name="style-text-properties-content-strict"/></define><define name="style-paragraph-properties-content"><ref name="style-paragraph-properties-content-strict"/></define><define name="style-ruby-properties-content"><ref name="style-ruby-properties-content-strict"/></define><define name="style-section-properties-content"><ref name="style-section-properties-content-strict"/></define><define name="style-list-level-properties-content"><ref name="style-list-level-properties-content-strict"/></define><define name="style-table-properties-content"><ref name="style-table-properties-content-strict"/></define><define name="style-table-column-properties-content"><ref name="style-table-column-properties-content-strict"/></define><define name="style-table-row-properties-content"><ref name="style-table-row-properties-content-strict"/></define><define name="style-table-cell-properties-content"><ref name="style-table-cell-properties-content-strict"/>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 718 of 738

53
54
55
56
57
58
59
60
61

</define><define name="style-graphic-properties-content"><ref name="style-graphic-properties-content-strict"/></define><define name="style-chart-properties-content"><ref name="style-chart-properties-content-strict"/></define></include></grammar>

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 719 of 738

Appendix B.References[CSS2] Bert Bos, Håkon Wium Lie, Chris Lilley, Ian Jacobs, Cascading Style Sheets, level 2,
http://www.w3.org/TR/1998/REC-CSS2-19980512, W3C, 1998.
[CSS3Text]
Michel Suignard, CSS3 Text Module, http://www.w3.org/TR/2003/CR-css3-text20030514, W3C, 2003.
[DAISY]ANSI/NISO Z39.86-2005 Specifications for the Digital Talking Book,
http://www.niso.org/standards/resources/Z39-86-2005.html, 2005
[DCMI] -, Dublin Core Metadata Element Set, Version 1.1: Reference Description,
http://www.dublincore.org/documents/dces/, Dublin Core Metadata Initiative, 2003.
[DOM2]
W3C, Document Object Model Level 2 Core Specification,
http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113, W3C, 2000.
[DOMEvents2] Tom Pixley, Document Object Model (DOM) Level 2 Events Specification,
http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113, W3C, 2000.
[DOMEvents3] Philippe Le Hégaret, Tom Pixley, Document Object Model (DOM) Level 3 Events
Specification, http://www.w3.org/TR/DOM-Level-3-Events/, W3C, 2003.
[HTML4]
Dave Raggett, Arnoud Le Hors, Ian Jacobs, HTML 4.01 Specification,
http://www.w3.org/TR/1999/REC-html401-19991224, W3C, 1999.
[ISO/IEC Directives] ISO/IEC Directives, Part 2 Rules for the structure and drafting ofInternational Standards, 2004
[JDBC] Jon Ellis, Linda Ho, Maydene Fisher, JDBC 3.0 Specification,
http://java.sun.com/products/jdbc/, Sun Microsystems, Inc., 2001.
[MathML]David Carlisle, Patrick Ion, Robert Miner, Nico Poppelier, Mathematical Markup
Language (MathML) Version 2.0 (Second Edition), http://www.w3.org/TR/2003/REC-MathML220031021/, W3C, 2003.
[MIMETYPES] , List of registered MIME types, ftp://ftp.isi.edu/in-notes/iana/assignments/mediatypes/, IANA, .
[OLE]

Kraig Brockschmidt, Inside OLE, Microsoft Press, 1995, ISBN: 1-55615-843-2[OOo] , OpenOffice.org XML File Format 1.0 Technical Reference Manual,
http://xml.openoffice.org/xml_specification.pdf, Sun Microsystems, Inc., 2002.
[PNG] Thomas Boutell, PNG (Portable Network Graphics) Specification,
http://www.w3.org/TR/REC-png-multi.html, W3C, 1996.
[RFC2045]
N. Freed and N. Borenstein, Multipurpose Internet Mail Extensions (MIME) Part
One: Format of Internet Message Bodies, http://www.ietf.org/rfc/rfc2045.txt, IETF, 1996.
[RFC2048]
N. Freed, J. Klensin, J. Postel, Multipurpose Internet Mail Extensions (MIME) Part
Four: Registration Procedures, http://www.ietf.org/rfc/rfc2048.txt, IETF, 1996.
[RFC2616]
IETF, 1999.

IETF, Hypertext Transfer Protocol -- HTTP/1.1, http://www.ietf.org/rfc/rfc2616.txt,[RFC2898]
B. Kaliski, PKCS #5: Password-Based Cryptography Specification Version 2.0,
http://www.ietf.org/rfc/rfc2898, IETF, 2000.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 720 of 738

[RFC3066]
H. Alvestrand, Tags for the Identification of Languages,
http://www.ietf.org/rfc/rfc3066.txt, IETF, 2001.
[RFC3987]
M. Duerst, M. Suignard, Internationalized Resource Identifiers (IRIs),
http://www.ietf.org/rfc/rfc3987.txt, IETF, 2005.
[RNG] ISO/IEC 19757-2 Document Schema Definition Language (DSDL) -- Part 2: Regulargrammar-based validation -- RELAX NG, 2003
[RNG-Compat] James Clark, MURATA Makoto, RELAX NG DTD Compatibility, http://www.oasisopen.org/committees/relax-ng/compatibility-20011203.html, OASIS, 2001.
[SMIL20]
W3C, Synchronized Multimedia Integration Language 2.0 (SMIL 2.0),
http://www.w3.org/TR/smil20/, W3C, 2001.
[SVG] Jon Ferraiolo, 藤沢 淳 (FUJISAWA Jun), Dean Jackson, Scalable Vector Graphics (SVG)
1.1, http://www.w3.org/TR/2003/REC-SVG11-20030114/, W3C, 2003.
[UAX9] Mark Davis, Unicode Standard Annex #9: The Bidirectional Algorithm, Version 15 or later,
http://www.unicode.org/reports/tr9/tr9-15.html, 2005
[UNICODE]The Unicode Consortium. The Unicode Standard, Version 4.0.0, defined by: The
Unicode Standard, Version 4.0 (Boston, MA, Addison-Wesley, 2003. ISBN 0-321-18578-1)[UTR20]Martin Dürst and Asmus Freytag, Unicode Technical Report #20: Unicode in XML
and other Markup Languages, http://www.unicode.org/reports/tr20/, 2003
[XForms]

W3C, XForms, http://www.w3.org/TR/xforms/, W3C, 2004.

[XLink] Steve DeRose, Eve Maler, David Orchard, XML Linking Language,
http://www.w3c.org/TR/xlink/, W3C, 2001.
[xml-names] Tim Bray, Dave Hollander, Andrew Layman, Namespaces in XML,
http://www.w3.org/TR/REC-xml-names/, W3C, 1999.
[XML1.0]
Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, Eve Maler, François Yergeau ,Extensible Markup Language (XML) 1.0 (Third Edition), http://www.w3.org/TR/2004/REC-xml20040204, W3C, 2004.
[xmlschema-2] Paul V. Biron, Ashok Malhotra, XML Schema Part 2: Datatypes Second Edition,
http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/, W3C, 2004.
[XSL] W3C, Extensible Stylesheet Language (XSL), http://www.w3.org/TR/2001/REC-xsl20011015/, W3C, 2001.
[XSLT] James Clark, XSL Transformations (XSLT) Version 1.0, http://www.w3.org/TR/1999/RECxslt-19991116, W3C, 1999.
[XSLT2]
Michael Kay, XSL Transformations (XSLT) Version 2.0,
http://www.w3.org/TR/2003/WD-xslt20-20031112/, W3C, 2003.
[ZIP] Info-ZIP Application Note 970311, ftp://ftp.uu.net/pub/archiving/zip/doc/appnote-970311iz.zip, 1997

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 721 of 738

Appendix C.MIME Types and File Name
Extensions (Non Normative)
The MIME types and extensions contained in this section are applicable only to office documentsthat are contained in a package (see section 2.1). See section 1.7 for the MIME type to use fordocuments that are not contained in a package.
The following table contains a list of MIME types and extensions for documents that conform tothis specification, that, at the time this specification is published, have been registered according
to [RFC2048]. Please see [MIMETYPES] for a current list of registered MIME types.
MIME typeExt.

Description

No registered MIME types exist at the time this specification is published.
The following table contains a list of MIME types and extensions for office documents that
conform to this specification where a registration according to [RFC2048] is in progress at thetime this specification is published.
Please check [MIMETYPES] before using these MIME types. If a MIME type is not listed there,
the MIME type that is the result of inserting "x-" behind the "/" character (i.e., application/xvnd.oasis.opendocument.text) should be used.
MIME typeExt.

Description

application/vnd.oasis.opendocument.text

odt Text document

application/
vnd.oasis.opendocument.text-template

ott Text document used as
templateapplication/vnd.oasis.opendocument.graphics

odg Graphics document(Drawing)

application/
vnd.oasis.opendocument.graphics-template

otg Drawing document used as
templateapplication/vnd.oasis.opendocument.presentation

odp Presentation document

application/
vnd.oasis.opendocument.presentationtemplate

otp Presentation document usedas template

application/vnd.oasis.opendocument.spreadsheet

ods Spreadsheet document

application/
vnd.oasis.opendocument.spreadsheettemplateots Spreadsheet document usedas template

application/vnd.oasis.opendocument.chart

odc Chart document

application/
vnd.oasis.opendocument.chart-template

otc Chart document used as
templateapplication/vnd.oasis.opendocument.image

odi Image document

application/
vnd.oasis.opendocument.image-template

oti Image document used as
template

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 722 of 738

MIME typeExt.

Description

application/vnd.oasis.opendocument.formula

odf Formula document

application/
vnd.oasis.opendocument.formula-template

otf Formula document used as
templateapplication/vnd.oasis.opendocument.textmasterodm Global Text document (seesection 2.3.1)

application/vnd.oasis.opendocument.text-web

oth Text document used as
template for HTML
documents

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 723 of 738

Appendix D.Core Features Sets (Non Normative)
The OpenDocument specification does not specify which elements and attributes conforming
application must, should, or may support. The intention behind this is to ensure that the
OpenDocument specification can be used by as many implementations as possible, even if theseapplications do not support some or many of the elements and attributes defined in thisspecification. Viewer applications for instance may not support all editing relates elements andattributes (like change tracking), other application may support only the content related elements
and attributes, but none of the style related ones.
Even typical office applications may only support a subset of the elements and attributes definedin this specification. They may for instance not support lists within text boxes or may not support
some of the language related element and attributes.
The follow table provides an overview which element and attributes usually are supported bytypical office application. It lists the chapters and sections contained in this specification and sometypical office application classes. An “X” in this table indicates that most (or at least a significant
number) of the elements and attributes defined in a section usually are supported by a certain
application classes. An “(X)” indicates that only a limited number of elements and attributes
usually is supported.
Sect­
ion.

Title

Text

Spread­
sheet

Draw­
ing

Presen­tation

Chart

Image

2.2 Document Metadata

X

X

X

X

X

X

2.3 Body Element andDocument Types

X

X

X

X

X

X

2.4 Application Settings

X

X

X

X

X

X

2.5 Scripts

X

X

X

X

X

X

2.6 Font Face Declarations

X

X

X

X

X

2.7 Styles

X

X

X

X

X

X

2.8 Page Styles and Layout

X

X

X

X

3 Metadata Elements

X

X

X

X

X

X

4.1 Paragraphs and Basic Text
Structure

X

X(1)

X(2)

X(2)

X(3)

4.1 Headings

X

4.2 Page SequencesX

4.3 Lists

X

X(2)

X(2)

4.4 Text Sections

X

4.5 Page-bound graphicalcontent

X

4.6 Text Change Tracking

X

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 724 of 738

Sect­
ion.

Title

Text

Spread­
sheet

Draw­
ing

Presen­tationChart

4.7 Text Declarations

X

(X)

(X)

(X)

(X)

5.1 Basic Text Content

X

X(1)

X(2)

X(2)

X(3)

5.2 Bookmarks and ReferencesX

5.3 Notes

X

5.4 RubyX

5.5 Text Annotation

X

5.6 Index MarksX

5.7 Change Tracking andChange MarksX

5.8 Inline graphics and textboxes

X
(X)

(X)

(X)

X

X

6 Text Fields

X

7 Text IndicesX

8.1 Basic Table ModelXX

8.2 Advanced Table ModelXX

8.3 Advanced Tables

X

8.4 Advanced Table Cells

X

8.5 Spreadsheet Document
Content

X

8.6 Database Ranges

X

8.7 Filters

X

8.8 Data Pilot Tables

X

8.9 ConsolidationX

8.10 Table DDE Links

X

8.11 Change Tracking in
SpreadsheetsX

9.1 Enhanced Page Features forGraphical Applications
9.2 Drawing Shapes

X

X

X

X

9.3 Frames

X

X

X

X

9.4 3D Shapes

X

X

X

X

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

Image

X(4)

1 February 2007
Page 725 of 738

Sect­
ion.

Title

9.5 Custom Shapes

Text
X

Spread­
sheet

Draw­
ing

Presen­tationX

X

X

9.6 Presentation Shapes

X

9.7 Presentation Animations

X

9.8 SMIL Presentation
Animations

X

9.9 Presentation Events

X

9.10 Presentation Text Fields

X

9.11 Presentation Document
Content

X

10 Chart Content
11 Form Content

Chart

Image

X
X

X

X

X

12.1 Annotation

X(5)

X(1)

12.2 Number Format for page
numbers, etc.

X

X

X

X

12.3 Change Tracking MetadataX

X

12.4 Event Listener Tables

X

X

X

X

12.5 Mathematical Content

X

X

X

X

12.6 DDE Connections

X

X

13 SMIL Animations

X

14.1 Style Element

X

X

X

X

X

X

14.2 Default Styles

X

X

X

X

X

X

14.3 Page Layout

X

X

X

X

14.4 Master Pages

X

X

X

X

14.5 Table TemplatesXX

14.6 Font Face Declaration

X

X

X

X

X

14.7 Data Styles

X

X

X

X

X

14.8 Text Styles

X

X(6)

X(6)

X(6)

X(6)

14.9 Enhanced Text Styles

X

14.10 List Style

X

X

X

14.11 Outline Style

X

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 726 of 738

Sect­
ion.

Title

Text

Spread­
sheet

Draw­
ing

Presen­tation14.12 Table Styles

XX

14.13 Graphic Styles

X

X

X

X

14.14 Enhanced Graphic Style
Elements

X

X

X

X

14.15 Presentation Page Layouts

Chart

Image

X

X

14.16 Chart Styles

X

15.2 Page Layout Formatting
Properties

X

X

X

X

15.3 Header Footer Formatting
Properties

X(X)

15.4 Text Formatting Properties

X

X

X

X

X

15.5 Paragraph Formatting
Properties

X

X

X

X

X

15.6 Ruby Text Formatting
Properties

X

15.7 Section Formatting
Properties

X

15.8 Table Formatting Properties(X)

X

15.9 Column Formatting
Properties(X)

X

15.10 Table Row Formatting
Properties(X)

X

15.11 Table Cell Formatting
Properties(X)

X

15.12 List-Level Style Properties

X

X

X

15.13 Stroke Properties

X(7)

X(7)

X

X

X

15.14 Fill Properties

X(7)

X(7)

X

X

X

15.15 Text Animation Properties

X(7)

X(7)

X

X

15.16 Text Alignment Properties

X(7)

X(7)

X

X

15.17 Color Properties

X(7)

X(7)

X

X

15.18 Shadow Properties

X(7)

X(7)

X

X

15.19 Connector Properties

X(7)

X(7)

X

X

15.20 Measure Properties

X(7)

X(7)

X

X

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

X

1 February 2007
Page 727 of 738

Sect­
ion.

Title

Text

Spread­
sheet

Draw­
ing

Presen­tationChart

15.21 Caption Properties

X(7)

X(7)

X

X

15.22 3D Geometry Properties

X(7)

X(7)

X

X

X

15.23 3D Lighting Properties

X(7)

X(7)

X

X

X

15.24 3D Texture Properties

X(7)

X(7)

X

X

X

15.25 3D Material Properties

X(7)

X(7)

X

X

X

15.26 3D Shadow Properties

X(7)

X(7)

X

X

X

15.27 Frame Formatting Properties X

(X)

(X)

(X)

(X)

15.28 Floating Frame Formatting
Properties

X

X

X

X

15.29 Chart Formatting Properties

X

15.30 Chart Subtype Properties

X

15.31 Chart Axes Properties

X

15.32 Common Chart Properties

X

15.33 Statistical Properties

X

15.34 Plot Area Properties

X

15.35 Regression Curve Properties

X

15.36 Presentation Page Attributes

Image

X

(1) within table cells(2) within text boxes(3) within some chart objects(4) only frames that contain images(5) within text(6) only automatic styles(7) only for drawing shapes

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 728 of 738

Appendix E.Accessibility Guidelines (NonNormative)
E.1. Title, Description and Caption of Graphical Elements
User agents supporting platform accessibility APIs should follow the following conventions forsupporting the accessible name, accessible description (accessible help on some systems), andcaption-id relationships (see sections 9.2.20 and 9.2.15:Caption-ID for a description of theseelements and attributes):
If an <svg:title> element is provided it should map to the accessible name. If not, the nameshould use the text referenced by the draw:caption-id attribute. The <svg:desc> element
must be used to support the accessible description. User agents shall not manufacture names forthe <svg:title> element, such as using the drawing object name followed by a cardinal
number in a string as it is used for accessibility. Name assignments such as these provide no
semantic meaning to the user.
When transforming from another document format to OpenDocument the short names, likeHTML's alt text on the <img> elements shall be mapped to the <svg:title> element.
If the user agent supports a platform which provides a draw:caption-id relationship in its
accessibility API, this relationship for captions should be used to fulfill the relationship.
Guidance for authors:
Authors should not assign names to objects having no semantic value. If no name is assigned thecaption text will be used in its place.<svg:title> elements shall take precedence over thecaption text for accessible name assignment by the user agent.
Assignment of the long description should only be necessary when a drawing object issignificantly complex and the user needs more information to describe it. Long descriptions would
be more applicable to drawing groupings than basic drawing shapes.
Authoring tool responsibility for presenting and prompting for the <svg:title> and<svg:desc> elements:
Authoring tools should provide an option from an objects context menu to allow the user to enter
the text for either of these elements as a minimum. More proactive authoring tools should have afacility for prompting the author for this text. Since the <svg:desc> element is a long description,a text area vs. a text field should be used to prompt the user accordingly in GUI-based authoring
tools like office applications.
Navigation tools used to list the objects in the view should provide the type of object followed by
the contents of <svg:title> element. The title must have been entered by the author.
For <draw:g> elements the drawing objects which are members of the group should visible only
when the group is expanded.

E.2. Hyperlink Titles
When transforming from another document format to OpenDocument the alt text of hyperlinks,
shall be mapped to the office:title attribute of <text:a> elements (see section 5.1.4) or<draw:a> elements (see section 9.3.9). When exporting OpenDocument documents to HTML,OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 729 of 738

the contents of title text should be mapped to title attribute text on HTML anchor tags. As aminimum, authoring tools should provide a mechanism to provide the hint text.
The title text should be made accessible to the assistive technology and user. The user agent
should allow for programmatic access through standard accessibility APIs such as the accessible
description. Users should experience visible access to the hint text via the keyboard or mouse.

E.3. Tables in Presentations
Users importing non-OpenDocument slides that contain tables need access to the table structure
via their assistive technology. Therefore tables imported into an OpenDocument application fromanother file format must have their structure preserved, and when saved as OpenDocument
should be saved as as embedded spreadsheets.

E.4. Further Guidelines
Please see the additional, detailed Accessibility Guidelines http://docs.oasis-open.org/office/officeaccessibility/guidelines. That more comprehensive document will be the up-to-date set ofrecommendations for what all OpenDocument applications should do in order to fully support
accessibility.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 730 of 738

Appendix F.Bidirectional (BiDi) Scripts,Numeric
Digits Presentation and Calendars (NonNormative)
This appendix describes how bidirectional (BiDi) scripts and related information are represented in
OpenDocument.

Paragraph and Layout Direction
In OpenDocument, the direction of text runs inside a paragraph is calculated using the Unicode
BiDi Algorithm (see [UAX9]). The paragraph direction, as required by the BiDi Algorithm (see BD5of [UAX9]), and the display direction of layout objects like table or page columns (in the following
called layout direction) is controlled by a writing mode attribute (style:writing-mode) that canbe used within styles.
The writing mode attribute can be applied individually to paragraph styles, page styles, section
styles, table styles and graphic styles. If present within a paragraph style, it controls the paragraphdirection of those paragraphs, to which the style is applied. If present within a page style, section
style, table style or graphic style, it controls the layout direction of those pages, text sections,tables and text-boxes to which the styles is applied.
Section 15.2.19 describes the style:writing-mode attribute for page styles. It may, among
other values, take the the values lr-tb (left-to-right, top-to-bottom) and rl-tb (right-to-left, topto-bottom). The writing-mode attribute of a page style specifies the layout direction of page
columns (left-to-right or right-to-left) for pages that are formatted using the page style.
Section 15.5.36 describes the style:writing-mode attribute for paragraph styles. It specifies
the paragraph direction as defined in BD5 of [UAX9] for all paragraphs that have the paragraphstyle assigned. For paragraphs that are contained in lists, it further specifies whether the list
numbers and bullets are displayed on the left or on the right of the paragraph.
The writing mode attribute for paragraph styles takes the same values as the writing mode
attribute for page styles, but may also take the value page. This value specifies that theparagraph direction is inherited from the layout direction of the closest layout object (section, tableor text-box) in which the paragraph is contained, and which has a layout direction other than
page. If the paragraph is not contained in any of these layout objects, the paragraph direction isinherited from the page on which the paragraph appears.
The paragraph direction determines the default bidirectional orientation of the text in thatparagraph. The result of the BiDi Algorithm can be manually changed by inserting BiDi embedding
control characters (U+202A ... U+202E) and implicit directional marks (U+200E ...U+200F) into
the text (see [UTR20]).
OpenDocument further has a style:automatic-writing-mode attributes (described in
section 15.5.37) that specifies that an application is allowed to recalculate the value of theparagraph's writing-mode attribute based on its content whenever the content changes.
Section 15.7.8 describes the style:writing-mode attribute for section styles. It may take thesame values as the writing mode attribute for paragraph styles.
The writing-mode attribute of a section style specifies the layout direction of section columns (leftto-right or right-to-left) for text sections that have the section style assigned. If the attribute's value
is page, then the layout direction is inherited from the layout direction of the closest layout object

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 731 of 738

(section, table or text-box) in which the section is contained, and which has a layout direction
other than page.
Section 15.8.13 describes the style:writing-mode attribute for table styles. It may take thesame values as the writing mode attribute for paragraph styles.
The writing-mode attribute of a table style specifies the layout direction of table cells (left-to-rightor right-to-left) for tables that have the table style assigned. If the attribute's value is page, thenthe layout direction is inherited from the layout direction of the closest layout object (section, tableor text-box) in which the table is contained, and which has a layout direction other than page.
Section 14.13.1 describes the style:writing-mode attribute for graphic styles. It may take thesame values as the writing mode attribute for paragraph styles.
The writing-mode attribute of a graphic style specifies the layout direction of columns (left-to-rightor right-to-left) for text-boxes that have the graphic style assigned. If the attribute's value is page,then the layout direction for text-boxes that are anchored to a page is inherited from the layout
direction of the page on which the text-box is displayed. For text-boxes that have a different
anchor type, the layout direction is inherited from the paragraph direction of the paragraph that
contains the text-box.

Numeric Digits Presentation and Calendars
All digits that have a Unicode code point can be included in an OpenDocument document.
Note: Some office application have a feature that allows the user to specify whether the ASCII
digits U+0030 ... U+0039 should be displayed as Arabic digits or as Indic digits (U+0660 ...
U+0669). Since this feature effects only what digits are displayed and does not influence therepresentation of digits in the document itself, OpenDocument only allows storing this setting as
an application specific setting, not as document or style content.
For list numbers, that are calculated automatically, OpenDocument provides a genericmechanism to specify the applicable numbering formats (see section 12.2.2).
Note: The specification currently mentions only "1, 2, 3...", "I, II, III...", and "i, ii, iii" explicitly, but
the schema also allows a generic string here.
OpenDocument further supports data styles, which describe how different types of data aredisplayed, for example, a number or a date. Data styles are described in section 14.7. The
presentation of numeric digits can be controlled by the transliteration attributes described in
section 14.7.10. The presentation of date information can be controlled by the number:calendar
attribute specified in section 14.7.11.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 732 of 738

Appendix G.Changes From Previous Specification
Versions (Non Normative)
G.1. Changes from “Open Office Specification 1.0 Committee
Draft 1”
The following are the changes since the “Open Office Specification 1.0 Committee Draft 1”:•

The name of this specification has been changed to “Open Document Format for Office
Applications (OpenDocument) 1.0”.

•

The namespace URIs (section 1.3) have been adapted to the new specification name.

•

The MIME type recommendations have been moved into a non normative appendix (appendixC) and have been adapted to the new specification name.

•

Various new definitions have been added. Among them are:–

Custom Shapes (section 9.5)–

SMIL Animations (section 9.8 and chapter 13)–

Support for XForms (section 11.2)•

Various errors in the schema and descriptions have been corrected.

•

Some descriptions have been rewritten for easier understanding.

G.2. Changes from “Open Document Format for Office
Applications (OpenDocument) 1.0 Committee Draft 2”
The following are the changes since the “Open Document Format for Office Applications(OpenDocument) 1.0 Committee Draft 2”:•••

Namespaces for compatible elements and attributes have been added as follows:–

urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0 for attributes that arecompatible with [XSL];–

urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0 for elements and attributes
that are compatible with [SVG];–

urn:oasis:names:tc:opendocument:xmlns:smil-compatible:1.0 for attributes that arecompatible with [SMIL20].

The following namespaces are not imported any longer:–

http://www.w3.org/1999/XSL/Format–

http://www.w3.org/2000/svg–

http://www.w3.org/2001/SMIL20/

The attribute xforms:submission specified in section 11.3.11 has been renamed toform:xforms-submission.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 733 of 738

•

Information for Custom Shapes (section 9.5), SMIL Animations (sections 9.8 and chapter 13)
and Presentation Text Fields (section 9.10) has been added to the core feature set table inappendix D; the chapter numbers in the table have been updated.

G.3. Changes from “Open Document Format for Office
Applications (OpenDocument) v1.0”
The following are the changes between the “Open Document Format for Office Applications(OpenDocument) v1.0” specification and the “Open Document Format for Office Applications(OpenDocument) v1.0 (Second Edition)” specification.
•

The usage of key words for “shall”, “may”, etc. conforms now to Annex H of the ISO
directives.

•

Various ambiguous references were replaced with explicit references to chapter and section
numbers.

•

Various spelling and grammatical errors were corrected.

•

All occurrences of "unicode" and "UNICODE" were replaced with the bibliographic reference“[UNICODE]”. A bibliographic entry for Unicode was added to appendix B.

•

All occurrences of the term URI, with the exception of one in appendix E.1, were replaced withthe term IRI, because the W3C Schema "anyURI" datatype that is used in the OpenDocument
schema actually takes IRIs rather than URIs. References to [RFC2396]) were replaced withreferences to [RFC3987]. In appendix B, the bibliographic entry for RFC2396 was replacedwith one for RFC3987.

•

A reference to the RELAX NG DTD Compatibility specification was added to the second
paragraph of section 1.4. A bibliography entry for the RELAX NG DTD Compatibility
specification was added to appendix B.

•

References to [RFC2045] were added to some usages of the term “BASE64”, andoccurrences of “base64” were corrected to “BASE64”. A bibliography entry for RFC2045 has
been added to appendix B.

•

The description of the draw:z-index attribute in section 9.2.5 was corrected.

•

The references to the W3C CSS3 Text Module were clarified. In appendix B, the URL“http://www.w3.org/TR/2003/CR-css3-text-20030514” was added to the bibliographic entry for
CSS3Text.

•

In appendix B, the bibliographic entry for [RNG] now references to the ISO Relax-NG
specification document rather than the OASIS Relax-NG specification document.

•

In appendix B, the bibliographic entry for ZIP was updated.

•

The contributor list was moved from the title page into an appendix.

G.4. Changes from “Open Document Format for Office
Applications (OpenDocument) v1.0 (Second Edition)”
The following are the changes between the “Open Document Format for Office Applications
The following are the changes between the “Open Document Format for Office Applications(OpenDocument) v1.0 (Second Edition)” specification and the “Open Document Format for Office
Applications (OpenDocument) v1.1” specification.
•

The accessibility support of OpenDocument was improved by the following changes:

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 734 of 738

–Soft Page Breaks were added.

–

The usage of table header and row columns was clarified (sections 8.2.2 and 8.2.4).

–

A logical navigation order for presentation slides was added (section 9.1.4).

–

Alternative texts for graphical objects, image maps, drawing layers and hyperlinks wereadded (sections 9.2.20, 9.3.9 and 5.1.4).

–

An attribute to establish a relationship between graphical objects and captions was added(section 9.2.15).

–

An appendix E containing accessibility guidelines was added.

•

The use of DDE and OLE was clarified (section 12.6).

•

The measure units supported by attribute values of type “length” was clarified (chapter 16).

•

The definition of the “positiveLength” data type was improved (chapter 16).

•

The recommendations for event names to be used in event listener definitions was clarified(sections 11.6 and 12.4.1).

•

A style:writing-mode attribute was added for graphic styles (section 15.27.32).

•

An appendix F containing information on bidirectional (BiDi) scripts, numeric digits
presentation and calendars was added.

•

The following errors in the schema were corrected:–

Section 8.5.2:Null Date: The attribute “table:date-value" was misspelled “table:datevalue-type”.

–

Section 9.2.19:Align: An “<optional>” element was missing.

–

Section 13.1: For the elements described in this section, the schema referenced“common-fill-timing-attlist” instead of “common-timing-attlist”.

–

Section 13.4.1:Repeating Elements: The value “indefinite” was missing for the“smil:repeatCount” attribute, and an “<optional/><optional>” pair was missing between theattribute definitions of “smil:repeatCount” and “smil:repeatDur”.

–

Section 13.4.3: The element content for “<anim:seq>” was missing.

–

Section 13.4.4: The define “anim-iterate-attlist” was misspelled “anin-iterate-attlist”.

–

Section 13.4.4:The Target Element: Instead of referencing “common-anim-target-attlist”,
the schema defined a subset of the defined attributes itself.

–

Section 14.4.1: A reference to “text-decls” was missing in the definition of “header-footercontent”.

–

Section 14.4.2: A reference to “office-forms” was missing in the definition of“presentation-notes”.

–

Section 14.6.1: The name attribute was missing the svg: namespace prefix.

–

Section 14.9.1:Position : The attribute value “right” was misspelled “rigth”.

–

Section 15.3.8: The definition was named “style-header-footer-attlist” instead of “styleheader-footer-properties-attlist”.

–

Section 15.4.18: The schema for the "style:font-charset-asian" and "style:font-charsetcomplex" attributes was missing.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 735 of 738

–Section 15.5.35: The value "baseline" was missing.

–

Section 15.24.2:Kind: The attribute value “intensity” was misspelled “intesity”.

–

Section 15.27.22:Dynamic Wrap Threshold: The attribute “draw:dynamic-wrap-threshold”
was misspelled “draw:dynamic-wrap-treshold”.

–

Section 15.31.3: The attribute “chart:interval-minor-divisor” was misspelled“chart:interval-minor”.

–

Section 15.36.7: The attribute value type of "smil:fadeColor" was not "color".

–

Appendix A: The "style-chart-properties-content" define referenced "style-propertiescontent" instead of "style-chart-properties-content-strict".

•

The referenced version of xmlschema part 2 has been updated to xmlschema part 2 second
edition.

•

The text and schema in section 8.3.1:Referencing Table Cells the text and schema wasextended to allow for apostrophe characters in table names by escaping them throughdoubling in quoted names.

•

In section 15.5.39, and “auto”-value has been added to the style:page-number attribute.

•

In section 14.5.1:Row and Column Styles, the text:paragraph-style-name attribute was added.

•

The presentation:show-end-of-presentation-slide attribute has been added to section 9.11.5:
Presentation Settings.

•

The example for addressing of sub-table cells has be clarified in section 8.2.6:Subtables.

•

The descriptive text in section 4.6.4 was clarified and some examples were corrected.

•

The example in section 4.3.2 was corrected.

•

In section 17.5, the restrictions that exist for IRIs that are used within a packages wereclarified.

•

The descriptive texts in sections 8.1.2:Default Cell Style and 8.2.1:Default Cell Style wereclarified.

•

In the description of the example in section 15.5.35, "middle" was referred to as "center".

•

The descriptive texts of sections 15.10 and 15.10.4 were corrected to refer to rows rather thancolumns.

•

The white-space processing in section 5.1.1 was clarified.

•

Various spelling errors were corrected.

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 736 of 738

Appendix H.Acknowledgments (Non Normative)
Current Contributors:
Daniel Brotsky, Adobe Systems
Jerome Dumonteil, Ars Aperta
Charles Schulz, Ars Aperta
Jerry Berrier, BayState Council of the Blind (BSCB)
Donglin Wang, Beijing Sursen International Information Technology Co., Ltd.
Rui Zhao, Changfeng Open Standards Platform Software Alliance
Stephen Noble, Design Science, Inc.
John Madden, Duke University
Chieko Asakawa, IBM
Nathaniel Borenstein, IBM
Pete Brunet, IBM
Yue Ma, IBM
Richard Schwerdtfeger, IBM
Robert Weir, IBM
Zhi Yu Yue, IBM
John Barstow, Individual
Patrick Durusau, IndividualMichael Paciello, Individual
Janina Sajka, IndividualDavid Clark, Institute for Community Inclusion
Waldo Bastian, Intel Corporation
James Mason, ISO/IEC JTC1/SC34
David Faure, KDE e.V
Jody Goldberg, Novell
David Pawson, Royal National Institute for the Blind
Michael Brauer, Sun Microsystems, Inc.
Peter Korn, Sun Microsystems, Inc.
Lars Oppermann, Sun Microsystems, Inc.
Eike Rathke, Sun Microsystems, Inc.
Svante Schubert, Sun Microsystems, Inc.
Frank Stecher, Sun Microsystems, Inc.
Malte Timmermann, Sun Microsystems, Inc.
Daniel Bricklin, The OpenDocument Foundation, Inc.
Daniel Carrera, The OpenDocument Foundation, Inc.
Bruce D'Arcus, The OpenDocument Foundation, Inc.
Gary Edwards, The OpenDocument Foundation, Inc.
Elmar Geese, The OpenDocument Foundation, Inc.
Sam Hiser, The OpenDocument Foundation, Inc.
Michael Kleinhenz, The OpenDocument Foundation, Inc.
Tomas Mecir, The OpenDocument Foundation, Inc.
Thomas Metcalf, The OpenDocument Foundation, Inc.
Stefan Nikolaus, The OpenDocument Foundation, Inc.
Florian Reuter, The OpenDocument Foundation, Inc.
Daniel Vogelheim, The OpenDocument Foundation, Inc.
David A. Wheeler, The OpenDocument Foundation, Inc.
Chris Nokleberg, Tonic Systems, Inc.
Previous Contributors:
Paul Grosso, Arbortext
Tom Magliery, Blast Radius
Doug Alberg, Boeing

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 737 of 738

Paul Langille, CorelJohn Chelsom, CSW Informatics
Monica Martin, Drake Certivo
Jason Harrop, Individual
Uche Ogbuji, Individual
Lauren Wood, Individual
Simon Davis, National Archive of Australia
Mark Heller, New York State Office of the Attorney General
Phil Boutros, Stellent

OpenDocument-v1.1-os.odt
Copyright © OASIS Open 2002 - 2007. All Rights Reserved.

1 February 2007
Page 738 of 738