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, Individual Michael 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]. 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 the Technical Committee's email list. Others should send comments to the Technical Committee by using the "Send A Comment" button on the Technical Committee's web page at www.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 to the 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.oasis-open.org/committees/office. 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 OASIS Intellectual 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 the above 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 to translate 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 OASIS DISCLAIMS 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 FITNESS FOR A PARTICULAR PURPOSE. OASIS requests that any OASIS Party or any other party that believes it has patent claims that would 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 to grant 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 of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so. OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document 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 OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available 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 by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained 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 the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance. Table of Contents 1 Introduction33 1.1 Introduction33 1.2 Notation33 1.3 Namespaces33 1.4 Relax-NG Schema35 1.5 Document Processing and Conformance36 1.6 White-Space Processing and EOL Handling37 1.7 MIME Types and File Name Extensions37 2 Document Structure39 2.1 Document Roots39 2.1.1 Document Root Element Content Models40 2.1.2 Document Root Attributes41 2.2 Document Metadata42 2.2.1 Pre-Defined vs. Custom Metadata42 2.2.2 Sample Metadata43 2.3 Body Element and Document Types43 2.3.1 Text Documents44 2.3.2 Drawing Documents46 2.3.3 Presentation Documents47 2.3.4 Spreadsheet Documents48 2.3.5 Chart Documents49 2.3.6 Image Documents49 2.4 Application Settings50 2.4.1 Sequence of Settings50 2.4.2 Base Settings51 2.4.3 Index Access of Sequences52 2.4.4 Map Entry52 2.4.5 Name Access of Sequences53 2.4.6 Cursor Position Setting53 2.5 Scripts54 2.5.1 Script54 2.6 Font Face Declarations55 2.7 Styles55 2.7.1 Location of Styles 56 2.8 Page Styles and Layout58 3 Metadata Elements59 3.1 Pre-Defined Metadata Elements59 3.1.1 Generator59 3.1.2 Title59 3.1.3 Description59 3.1.4 Subject60 3.1.5 Keywords60 3.1.6 Initial Creator 60 3.1.7 Creator60 3.1.8 Printed By60 3.1.9 Creation Date and Time61 3.1.10 Modification Date and Time61 3.1.11 Print Date and Time61 3.1.12 Document Template61 3.1.13 Automatic Reload62 3.1.14 Hyperlink Behavior63 3.1.15 Language64 3.1.16 Editing Cycles64 3.1.17 Editing Duration65 3.1.18 Document Statistics65 3.2 User-defined Metadata67 3.3 Custom Metadata68 4 Text Content69 4.1 Headings, Paragraphs and Basic Text Structure69 4.1.1 Headings69 4.1.2 Paragraphs70 4.1.3 Common Paragraph Elements Attributes70 4.2 Page Sequences71 4.2.1 Page72 4.3 Lists73 4.3.1 List Block73 4.3.2 List Item74 4.3.3 List Header76 4.3.4 Numbered Paragraphs76 4.4 Text Sections77 4.4.1 Section Attributes78 4.4.2 Section Source79 4.4.3 DDE Source80 4.5 Page-bound graphical content81 4.6 Change Tracking81 4.6.1 Tracked Changes81 4.6.2 Changed Regions81 4.6.3 Insertion82 4.6.4 Deletion82 4.6.5 Format Change84 4.6.6 Change Info84 4.6.7 Change Marks85 4.7 Soft Page Break85 4.8 Text Declarations85 5 Paragraph Elements Content87 5.1 Basic Text Content87 5.1.1 White-space Characters87 5.1.2 Soft Hyphens, Hyphens, and Non-breaking Blanks89 5.1.3 Attributed Text90 5.1.4 Hyperlinks90 5.2 Bookmarks and References93 5.2.1 Bookmarks93 5.2.2 References93 5.3 Notes95 5.3.1 Note Element95 5.4 Ruby97 5.5 Text Annotation97 5.6 Index Marks98 5.7 Change Tracking and Change Marks98 5.8 Inline graphics and text-boxes98 6 Text Fields99 6.1 Common Characteristics of Field Elements99 6.2 Document Fields100 6.2.1 Date Fields100 6.2.2 Time Fields101 6.2.3 Page Number Fields103 6.2.4 Page Continuation Text104 6.2.5 Sender Fields105 6.2.6 Author Fields108 6.2.7 Chapter Fields108 6.2.8 File Name Fields109 6.2.9 Document Template Name Fields110 6.2.10 Sheet Name Fields111 6.3 Variable Fields111 6.3.1 Declaring Simple Variables112 6.3.2 Setting Simple Variables112 6.3.3 Displaying Simple Variables113 6.3.4 Simple Variable Input Fields114 6.3.5 Declaring User Variables115 6.3.6 Displaying User Variables115 6.3.7 User Variable Input Fields116 6.3.8 Declaring Sequence Variables117 6.3.9 Using Sequence Fields118 6.3.10 Expression Fields119 6.3.11 Text Input Fields120 6.4 Metadata Fields120 6.4.1 Initial Creator121 6.4.2 Document Creation Date121 6.4.3 Document Creation Time121 6.4.4 Document Description121 6.4.5 User-Defined Document Information122 6.4.6 Print Time122 6.4.7 Print Date123 6.4.8 Printed By123 6.4.9 Document Title123 6.4.10 Document Subject123 6.4.11 Document Keywords124 6.4.12 Document Revision Number124 6.4.13 Document Edit Duration124 6.4.14 Document Modification Time124 6.4.15 Document Modification Date125 6.4.16 Document Modified By125 6.4.17 Document Statistics Fields125 6.5 Database Fields126 6.5.1 Database Field Data Source127 6.5.2 Displaying Database Content128 6.5.3 Selecting the Next Database Row128 6.5.4 Selecting a Row Number129 6.5.5 Displaying the Row Number130 6.5.6 Display Current Database and Table131 6.6 More Fields131 6.6.1 Page Variable Fields131 6.6.2 Placeholders132 6.6.3 Conditional Text Fields133 6.6.4 Hidden Text Field135 6.6.5 Reference Fields136 6.6.6 Script Fields138 6.6.7 Macro Fields139 6.6.8 Hidden Paragraph Fields140 6.6.9 DDE Connection Fields141 6.6.10 Measure Fields141 6.6.11 Table Formula Field142 6.7 Common Field Attributes142 6.7.1 Variable Value Types and Values142 6.7.2 Fixed144 6.7.3 Variable Name145 6.7.4 Description 145 6.7.5 Display145 6.7.6 Formula146 6.7.7 Formatting Style147 6.7.8 Number Formatting Style147 7 Text Indices149 7.1 Index Marks149 7.1.1 Table of Content Index Marks149 7.1.2 User-Defined Index Marks150 7.1.3 Alphabetical Index Mark151 7.1.4 Bibliography Index Mark153 7.2 Index Structure154 7.2.1 Index Source154 7.2.2 Index Body Section155 7.2.3 Index Title Section155 7.3 Table Of Content155 7.3.1 Table of Content Source156 7.3.2 Table of Content Entry Template158 7.4 Index of Illustrations159 7.4.1 Index of Illustration Source160 7.4.2 Illustration Index Entry Template161 7.5 Index of Tables162 7.5.1 Table Index Source162 7.5.2 Table Index Entry Template163 7.6 Index of Objects163 7.6.1 Object Index Source163 7.6.2 Object Index Entry Template165 7.7 User-Defined Index165 7.7.1 User-Defined Index Source165 7.7.2 User-Defined Index Entry Template167 7.8 Alphabetical Index168 7.8.1 Alphabetical Index Source168 7.8.2 Auto Mark File172 7.8.3 Alphabetical Index Entry Template172 7.9 Bibliography173 7.9.1 Bibliography Index Source173 7.9.2 Bibliography Entry Template174 7.10 index source styles174 7.10.1 Index source style175 7.11 Index title template175 7.12 Index Template Entries175 7.12.1 Chapter Information176 7.12.2 Entry Text176 7.12.3 Page Number176 7.12.4 Fixed String177 7.12.5 Bibliography Information177 7.12.6 Tab Stop178 7.12.7 Hyperlink Start and End179 7.12.8 Example of an Index Entry Configuration180 8 Tables182 8.1 Basic Table Model182 8.1.1 Table Element182 8.1.2 Table Row 186 8.1.3 Table Cell 188 8.2 Advanced Table Model193 8.2.1 Column Description 193 8.2.2 Header Columns195 8.2.3 Column Groups195 8.2.4 Header Rows196 8.2.5 Row Groups196 8.2.6 Subtables 197 8.3 Advanced Tables200 8.3.1 Referencing Table Cells200 8.3.2 Linked Tables202 8.3.3 Scenario Tables204 8.3.4 Shapes206 8.4 Advanced Table Cells 207 8.4.1 Linked Table Cells207 8.4.2 Cell Annotation 208 8.4.3 Detective208 8.4.4 Detective Operation208 8.4.5 Highlighted Range209 8.5 Spreadsheet Document Content211 8.5.1 Document Protection211 8.5.2 Calculation Settings211 8.5.3 Table Cell Content Validations214 8.5.4 Label Ranges218 8.5.5 Named Expressions219 8.6 Database Ranges221 8.6.1 Database Range 222 8.6.2 Database Source SQL 225 8.6.3 Database Source Table 225 8.6.4 Database Source Query226 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 Filters233 8.7.1 Table Filter233 8.7.2 Filter And234 8.7.3 Filter Or 235 8.7.4 Filter Condition 235 8.8 Data Pilot Tables237 8.8.1 Data Pilot Table237 8.8.2 Source Cell Range242 8.8.3 Source Service243 8.8.4 Data Pilot Field244 8.8.5 Data Pilot Level246 8.8.6 Data Pilot Subtotals247 8.8.7 Data Pilot Subtotal247 8.8.8 Data Pilot Members248 8.8.9 Data Pilot Member248 8.8.10 Data Pilot Display Info249 8.8.11 Data Pilot Sort Info250 8.8.12 Data Pilot Layout Info251 8.8.13 Data Pilot Field Reference252 8.8.14 Data Pilot Groups254 8.8.15 Data Pilot Group256 8.8.16 Data Pilot Group Member257 8.9 Consolidation257 8.10 DDE Links259 8.11 Change Tracking in Spreadsheets259 8.11.1 Tracked Changes259 8.11.2 Insertion260 8.11.3 Dependencies261 8.11.4 Dependence261 8.11.5 Deletions262 8.11.6 Cell Content Deletion262 8.11.7 Change Deletion262 8.11.8 Deletion263 8.11.9 Cut Offs264 8.11.10 Insertion Cut Off265 8.11.11 Movement Cut Off265 8.11.12 Movement266 8.11.13 Target Range Address, Source Range Address267 8.11.14 Change Track Cell268 8.11.15 Cell Content Change269 8.11.16 Cell Address270 8.11.17 Previous270 8.11.18 Common Change Tracking Attributes270 9 Graphic Content272 9.1 Enhanced Page Features for Graphical Applications272 9.1.1 Handout Master272 9.1.2 Layer Sets273 9.1.3 Layer274 9.1.4 Drawing Pages275 9.1.5 Presentation Notes278 9.2 Drawing Shapes279 9.2.1 Rectangle279 9.2.2 Line280 9.2.3 Polyline281 9.2.4 Polygon282 9.2.5 Regular Polygon283 9.2.6 Path285 9.2.7 Circle286 9.2.8 Ellipse288 9.2.9 Connector289 9.2.10 Caption293 9.2.11 Measure294 9.2.12 Control295 9.2.13 Page Thumbnail296 9.2.14 Grouping297 9.2.15 Common Drawing Shape Attributes298 9.2.16 Common Shape Attributes for Text and Spreadsheet Documents302 9.2.17 Common Drawing Shape Content305 9.2.18 Common Shape Attribute Groups305 9.2.19 Glue Points305 9.2.20 Title and Description307 9.2.21 Event Listeners308 9.3 Frames308 9.3.1 Text Box311 9.3.2 Image313 9.3.3 Objects314 9.3.4 Applet316 9.3.5 Plugins318 9.3.6 Parameters319 9.3.7 Floating Frame319 9.3.8 Contour320 9.3.9 Hyperlinks321 9.3.10 Client Side Image Maps323 9.4 3D Shapes327 9.4.1 Scene327 9.4.2 Light331 9.4.3 Cube332 9.4.4 Sphere333 9.4.5 Extrude334 9.4.6 Rotate334 9.5 Custom Shape335 9.5.1 Enhanced Geometry336 9.5.2 Enhanced Geometry - Extrusion Attributes339 9.5.3 Enhanced Geometry - Path Attributes345 9.5.4 Enhanced Geometry - Text Path Attributes349 9.5.5 Enhanced Geometry – Equation350 9.5.6 Enhanced Geometry - Handle Attributes352 9.6 Presentation Shapes356 9.6.1 Common Presentation Shape Attributes356 9.7 Presentation Animations358 9.7.1 Sound359 9.7.2 Show Shape360 9.7.3 Show Text363 9.7.4 Hide Shape364 9.7.5 Hide Text364 9.7.6 Dim364 9.7.7 Play365 9.7.8 Effect groups365 9.8 SMIL Presentation Animations365 9.8.1 Recommended Usage Of SMIL366 9.8.2 Document Dependent SMIL Animation Attribute Values367 9.8.3 SMIL Presentation Animation Attributes369 9.9 Presentation Events372 9.10 Presentation Text Fields375 9.10.1 Header Field375 9.10.2 Footer Field375 9.10.3 Date and Time Field375 9.11 Presentation Document Content376 9.11.1 Presentation Declarations376 9.11.2 Header field declaration376 9.11.3 Footer field declaration376 9.11.4 Date and Time field declaration377 9.11.5 Presentation Settings377 9.11.6 Show Definitions381 10 Chart Content383 10.1 Introduction to Chart Documents383 10.2 Chart383 10.3 Title, Subtitle and Footer387 10.3.1 Title387 10.3.2 Subtitle388 10.3.3 Footer388 10.4 Legend388 10.5 Plot Area390 10.5.1 3D Plot Area392 10.6 Wall392 10.7 Floor393 10.8 Axis394 10.8.1 Grid395 10.9 Series396 10.9.1 Domain398 10.10 Categories398 10.11 Data Point398 10.12 Mean Value399 10.13 Error Indicator400 10.14 Regression Curves400 10.14.1 Stock Chart Markers401 11 Form Content402 11.1 Form403 11.1.1 Action404 11.1.2 Target Frame404 11.1.3 Method405 11.1.4 Encoding Type405 11.1.5 Allow Deletes405 11.1.6 Allow Inserts406 11.1.7 Allow Updates406 11.1.8 Apply Filter406 11.1.9 Command Type406 11.1.10 Command407 11.1.11 Data Source407 11.1.12 Master Fields407 11.1.13 Detail Fields408 11.1.14 Escape Processing408 11.1.15 Filter408 11.1.16 Ignore Result408 11.1.17 Navigation Mode409 11.1.18 Order409 11.1.19 Tabbing Cycle409 11.1.20 Connection Resource410 11.2 XForms Model410 11.2.1 XForms Model411 11.3 Controls411 11.3.1 Text412 11.3.2 Text Area412 11.3.3 Password413 11.3.4 File414 11.3.5 Formatted Text414 11.3.6 Number416 11.3.7 Date And Time417 11.3.8 Fixed Text419 11.3.9 Combo Box419 11.3.10 List Box421 11.3.11 Button422 11.3.12 Image424 11.3.13 Check Box424 11.3.14 Radio Button426 11.3.15 Frame427 11.3.16 Image Frame427 11.3.17 Hidden427 11.3.18 Grid428 11.3.19 Value Range429 11.3.20 Generic Control431 11.4 Common Form and Control Attributes431 11.4.1 Name431 11.4.2 Control Implementation432 11.4.3 Bind to XForms432 11.5 Common Control Attributes432 11.5.1 Button Type432 11.5.2 Control ID433 11.5.3 Current Selected434 11.5.4 Value and Current Value434 11.5.5 Disabled435 11.5.6 Dropdown436 11.5.7 For436 11.5.8 Image Data437 11.5.9 Label437 11.5.10 Maximum Length437 11.5.11 Printable438 11.5.12 Read only439 11.5.13 Selected439 11.5.14 Size439 11.5.15 Tab Index440 11.5.16 Tab Stop441 11.5.17 Target Frame441 11.5.18 Target Location442 11.5.19 Title442 11.5.20 Visual Effect443 11.5.21 Relative Image Position443 11.5.22 Database Binding Attributes444 11.6 Event Listeners446 11.7 Properties448 11.7.1 Property Set448 11.7.2 Property448 11.7.3 List Property449 12 Common Content452 12.1 Annotation452 12.1.1 Creator453 12.1.2 Creation Date and Time453 12.1.3 Creation Date and Time String453 12.2 Number Format453 12.2.1 Prefix and Suffix453 12.2.2 Format Specification454 12.2.3 Letter Synchronization in Number Formats454 12.3 Change Tracking Metadata455 12.4 Event Listener Tables455 12.4.1 Event Listener456 12.4.2 Event Types457 12.5 Mathematical Content458 12.6 DDE Connections459 12.6.1 Container for DDE Connection Declarations459 12.6.2 Declaring DDE Connections for Text Fields459 12.6.3 Declaring DDE Connections for Tables 461 13 SMIL Animations463 13.1 Basic Animation Elements463 13.1.1 Animate463 13.1.2 Set463 13.1.3 Animate Motion463 13.1.4 Animate Color464 13.1.5 Animate Transform465 13.1.6 Transition Filter466 13.2 Animation Model Attributes467 13.3 Common Animation Attributes467 13.3.1 Animation Target Attributes468 13.3.2 Animation Function Attributes468 13.4 Animation Timing471 13.4.1 Animation Timing Attributes471 13.4.2 Parallel Animations475 13.4.3 Sequential Animations475 13.4.4 Iterative Animations475 13.5 Media Elements476 13.5.1 Audio476 13.6 Special Elements477 13.6.1 Command477 14 Styles479 14.1 Style Element479 14.1.1 Style Mappings483 14.2 Default Styles485 14.3 Page Layout485 14.3.1 Header and Footer Styles486 14.4 Master Pages487 14.4.1 Headers and Footers489 14.4.2 Presentation Notes491 14.5 Table Templates493 14.5.1 Row and Column Styles494 14.6 Font Face Declaration496 14.6.1 CSS2/SVG Font Descriptors496 14.6.2 Name500 14.6.3 Adornments500 14.6.4 Font Family Generic500 14.6.5 Font Pitch501 14.6.6 Font Character Set501 14.7 Data Styles501 14.7.1 Number Style501 14.7.2 Currency Style505 14.7.3 Percentage Style507 14.7.4 Date Style508 14.7.5 Time Style513 14.7.6 Boolean Style517 14.7.7 Text Style517 14.7.8 Common Data Style Elements518 14.7.9 Common Data Style Attributes519 14.7.10 Transliteration522 14.7.11 Common Data Style Child Element Attributes523 14.8 Text Styles525 14.8.1 Text Styles525 14.8.2 Paragraph Styles525 14.8.3 Section Styles526 14.8.4 Ruby Style526 14.9 Enhanced Text Styles526 14.9.1 Line Numbering Configuration526 14.9.2 Notes Configuration Element530 14.9.3 Bibliography Configuration533 14.10 List Style535 14.10.1 Common List-Level Style Attributes536 14.10.2 Number Level Style537 14.10.3 Bullet Level Style538 14.10.4 Image Level Style540 14.10.5 List Level Style Example541 14.11 Outline Style541 14.11.1 Outline Level Style542 14.12 Table Styles543 14.12.1 Table Styles543 14.12.2 Table Column Styles544 14.12.3 Table Row Styles544 14.12.4 Table Cell Styles544 14.13 Graphic Styles545 14.13.1 Graphic and Presentation Styles545 14.13.2 Drawing Page Style545 14.14 Enhanced Graphic Style Elements546 14.14.1 Gradient546 14.14.2 SVG Gradients549 14.14.3 Hatch552 14.14.4 Fill Image554 14.14.5 Opacity Gradient555 14.14.6 Marker556 14.14.7 Stroke Dash557 14.15 Presentation Page Layouts559 14.15.1 Presentation Placeholder559 14.16 Chart Styles560 15 Formatting Properties561 15.1 Simple and Complex Formatting Properties561 15.1.1 Simple Formatting Properties561 15.1.2 Complex Formatting Properties562 15.1.3 Processing Rules for Formatting Properties562 15.2 Page Layout Formatting Properties562 15.2.1 Page Size563 15.2.2 Page Number Format563 15.2.3 Paper Tray564 15.2.4 Print Orientation564 15.2.5 Margins564 15.2.6 Border565 15.2.7 Border Line Width565 15.2.8 Padding565 15.2.9 Shadow565 15.2.10 Background565 15.2.11 Columns566 15.2.12 Register-truth566 15.2.13 Print566 15.2.14 Print Page Order567 15.2.15 First Page Number567 15.2.16 Scale567 15.2.17 Table Centering568 15.2.18 Maximum Footnote Height568 15.2.19 Writing Mode569 15.2.20 Footnote Separator569 15.2.21 Layout Grid570 15.2.22 Layout Grid Base Height570 15.2.23 Layout Grid Ruby Height571 15.2.24 Layout Grid Lines571 15.2.25 Layout Grid Color571 15.2.26 Layout Grid Ruby Below571 15.2.27 Layout Grid Print572 15.2.28 Layout Grid Display572 15.3 Header Footer Formatting Properties572 15.3.1 Fixed and Minimum heights573 15.3.2 Margins573 15.3.3 Border573 15.3.4 Border Line Width573 15.3.5 Padding574 15.3.6 Background574 15.3.7 Shadow574 15.3.8 Dynamic Spacing574 15.4 Text Formatting Properties575 15.4.1 Font Variant575 15.4.2 Text Transformations575 15.4.3 Color576 15.4.4 Window Font Color576 15.4.5 Text Outline576 15.4.6 Line-Through Type576 15.4.7 Line-Through Style577 15.4.8 Line-Through Width577 15.4.9 Line-Through Color577 15.4.10 Line-Through Text578 15.4.11 Line-Through Text Style578 15.4.12 Text Position578 15.4.13 Font Name579 15.4.14 Font Family579 15.4.15 Font Family Generic580 15.4.16 Font Style581 15.4.17 Font Pitch581 15.4.18 Font Character Set582 15.4.19 Font Size582 15.4.20 Relative Font Size583 15.4.21 Script Type584 15.4.22 Letter Spacing584 15.4.23 Language584 15.4.24 Country585 15.4.25 Font Style585 15.4.26 Font Relief586 15.4.27 Text Shadow586 15.4.28 Underlining Type587 15.4.29 Underlining Style587 15.4.30 Underling Width588 15.4.31 Underline Color588 15.4.32 Font Weight588 15.4.33 Text Underline Word Mode589 15.4.34 Text Line-Through Word Mode589 15.4.35 Letter Kerning590 15.4.36 Text Blinking590 15.4.37 Text Background Color590 15.4.38 Text Combine590 15.4.39 Text Combine Start and End Characters591 15.4.40 Text Emphasis591 15.4.41 Text Scale592 15.4.42 Text Rotation Angle592 15.4.43 Text Rotation Scale592 15.4.44 Hyphenation592 15.4.45 Hyphenation Remain Char Count593 15.4.46 Hyphenation Push Char Count593 15.4.47 Hidden or Conditional Text593 15.5 Paragraph Formatting Properties594 15.5.1 Fixed Line Height594 15.5.2 Minimum Line Height595 15.5.3 Line Distance595 15.5.4 Font-Independent Line Spacing595 15.5.5 Text Align595 15.5.6 Text Align of Last Line596 15.5.7 Justify Single Word596 15.5.8 Keep Together597 15.5.9 Widows597 15.5.10 Orphans597 15.5.11 Tab Stops597 15.5.12 Tab Stop Distance601 15.5.13 Hyphenation Keep601 15.5.14 Maximum Hyphens601 15.5.15 Drop Caps602 15.5.16 Register True 603 15.5.17 Left and Right Margins603 15.5.18 Text Indent604 15.5.19 Automatic Text Indent604 15.5.20 Top and Bottom Margins605 15.5.21 Margins605 15.5.22 Break Before and Break After605 15.5.23 Paragraph Background Color606 15.5.24 Paragraph Background Image606 15.5.25 Border609 15.5.26 Border Line Width609 15.5.27 Padding610 15.5.28 Shadow611 15.5.29 Keep with Next612 15.5.30 Line Numbering612 15.5.31 Line Number Start Value612 15.5.32 Text Autospace612 15.5.33 Punctuation Wrap613 15.5.34 Line Break613 15.5.35 Vertical Alignment613 15.5.36 Writing Mode614 15.5.37 Automatic Writing Mode614 15.5.38 Snap To Layout615 15.5.39 Page Number615 15.5.40 Background Transparency615 15.6 Ruby Text Formatting Properties615 15.6.1 Ruby Position616 15.6.2 Ruby Alignment616 15.7 Section Formatting Properties616 15.7.1 Section Background617 15.7.2 Margins617 15.7.3 Columns617 15.7.4 Column Specification618 15.7.5 Column Separator620 15.7.6 Protect621 15.7.7 Don't Balance Text Columns621 15.7.8 Writing Mode622 15.7.9 Notes Configuration622 15.8 Table Formatting Properties622 15.8.1 Table Width622 15.8.2 Table Alignment623 15.8.3 Table Left and Right Margin623 15.8.4 Table Top and Bottom Margin624 15.8.5 Table Margins624 15.8.6 Page Number624 15.8.7 Break Before and Break After624 15.8.8 Table Background and Background Image624 15.8.9 Table Shadow624 15.8.10 Keep with Next625 15.8.11 May Break Between Rows625 15.8.12 Border Model Property625 15.8.13 Writing Mode626 15.8.14 Display626 15.9 Column Formatting Properties626 15.9.1 Column Width626 15.9.2 Optimal Table Column Width627 15.9.3 Break Before and Break After627 15.10 Table Row Formatting Properties627 15.10.1 Row Height627 15.10.2 Optimal Table Row Height628 15.10.3 Row Background628 15.10.4 Break Before and Break After628 15.10.5 Keep Together628 15.11 Table Cell Formatting Properties629 15.11.1 Vertical Alignment629 15.11.2 Text Align Source629 15.11.3 Direction630 15.11.4 Vertical Glyph Orientation630 15.11.5 Cell Shadow630 15.11.6 Cell Background631 15.11.7 Cell Border631 15.11.8 Diagonal Lines631 15.11.9 Border Line Width632 15.11.10 Padding632 15.11.11 Wrap Option632 15.11.12 Rotation Angle632 15.11.13 Rotation Align633 15.11.14 Cell Protect633 15.11.15 Print Content633 15.11.16 Decimal places634 15.11.17 Repeat Content634 15.11.18 Shrink To Fit634 15.12 List-Level Style Properties635 15.13 Stroke Properties637 15.13.1 Stroke Style637 15.13.2 Dash638 15.13.3 Multiple Dashes638 15.13.4 Width638 15.13.5 Color638 15.13.6 Start Marker638 15.13.7 End Marker639 15.13.8 Start Marker Width639 15.13.9 End Marker Width639 15.13.10 Start Marker Center639 15.13.11 End Marker Center640 15.13.12 Opacity640 15.13.13 Line Join640 15.14 Fill Properties640 15.14.1 Fill Style641 15.14.2 Color641 15.14.3 Secondary Fill Color642 15.14.4 Gradient642 15.14.5 Gradient Step Count642 15.14.6 Hatch642 15.14.7 Solid Hatch643 15.14.8 Fill Image643 15.14.9 Fill Image Rendering Style643 15.14.10 Fill Image Size643 15.14.11 Fill Image Tile Reference Point644 15.14.12 Fill Image Tile Translation645 15.14.13 None and Linear Opacity645 15.14.14 Gradient Opacity645 15.14.15 Fill Rule645 15.14.16 Symbol color646 15.15 Text Animation Properties646 15.15.1 Animation646 15.15.2 Animation Direction647 15.15.3 Animation Start Inside647 15.15.4 Animation Stop Inside647 15.15.5 Animation Repeat647 15.15.6 Animation Delay648 15.15.7 Animation Steps648 15.16 Text and Text Alignment Properties648 15.16.1 Auto Grow Width and Height648 15.16.2 Fit To Size649 15.16.3 Fit To Contour649 15.16.4 Text Area Vertical Align649 15.16.5 Text Area Horizontal Align649 15.16.6 Word Wrap650 15.16.7 List Styles650 15.17 Color Properties650 15.17.1 Color Mode 650 15.17.2 Color Inversion651 15.17.3 Adjust Luminance651 15.17.4 Adjust Contrast651 15.17.5 Adjust Gamma651 15.17.6 Adjust Red652 15.17.7 Adjust Green652 15.17.8 Adjust Blue652 15.17.9 Adjust Opacity652 15.18 Shadow Properties652 15.18.1 Shadow653 15.18.2 Offset653 15.18.3 Color653 15.18.4 Opacity653 15.19 Connector Properties654 15.19.1 Start Line Spacing654 15.19.2 End Line Spacing654 15.20 Measure Properties654 15.20.1 Line Distance654 15.20.2 Guide Overhang655 15.20.3 Guide Distance655 15.20.4 Start Guide655 15.20.5 End Guide655 15.20.6 Placing656 15.20.7 Parallel656 15.20.8 Text Alignment656 15.20.9 Unit657 15.20.10 Show Unit657 15.20.11 Decimal Places657 15.21 Caption Properties657 15.21.1 Type658 15.21.2 Angle Type658 15.21.3 Angle658 15.21.4 Gap659 15.21.5 Escape Direction659 15.21.6 Escape659 15.21.7 Line Length660 15.21.8 Fit Line Length660 15.22 3D Geometry Properties660 15.22.1 Horizontal Segments660 15.22.2 Vertical Segments660 15.22.3 Edge Rounding661 15.22.4 Edge Rounding Mode661 15.22.5 Back Scale661 15.22.6 Depth661 15.22.7 Backface Culling662 15.22.8 End Angle662 15.22.9 Close Front662 15.22.10 Close Back662 15.23 3D Lighting Properties663 15.23.1 Mode663 15.23.2 Normals Kind663 15.23.3 Normals Direction663 15.24 3D Texture Properties664 15.24.1 Generation Mode664 15.24.2 Kind664 15.24.3 Filter665 15.24.4 Mode665 15.25 3D Material Properties665 15.25.1 Colors665 15.25.2 Shininess666 15.26 3D Shadow Properties666 15.26.1 Shadow666 15.27 Frame Formatting Properties666 15.27.1 Frame Widths666 15.27.2 Frame Heights667 15.27.3 Maximum Width and Height667 15.27.4 Left and Right Margins668 15.27.5 Top and Bottom Margins668 15.27.6 Margins668 15.27.7 Print Content668 15.27.8 Protect668 15.27.9 Horizontal Position669 15.27.10 Horizontal Relation670 15.27.11 Vertical Position671 15.27.12 Vertical Relation672 15.27.13 Frame Anchor673 15.27.14 Border673 15.27.15 Border Line Width673 15.27.16 Padding673 15.27.17 Shadow674 15.27.18 Background674 15.27.19 Columns674 15.27.20 Editable674 15.27.21 Wrapping674 15.27.22 Dynamic Wrap Threshold675 15.27.23 Paragraph-only Wrapping675 15.27.24 Contour Wrapping676 15.27.25 Contour Wrapping Mode676 15.27.26 Run Through676 15.27.27 Flow with Text677 15.27.28 Overflow behavior677 15.27.29 Mirroring677 15.27.30 Clipping678 15.27.31 Wrap Influence on Position678 15.27.32 Writing Mode679 15.28 Floating Frame Formatting Properties679 15.28.1 Display Scrollbar679 15.28.2 Display Border680 15.28.3 Margins680 15.28.4 Object Formatting Properties680 15.28.5 Visible Area680 15.28.6 Draw Aspect681 15.29 Chart Formatting Properties681 15.29.1 Scale Text682 15.30 Chart Subtype Properties682 15.30.1 Three-dimensional Charts682 15.30.2 Chart Depth682 15.30.3 Chart Symbol683 15.30.4 Chart Symbol Size683 15.30.5 Bar Chart Properties684 15.30.6 Stock Chart Properties684 15.30.7 Line Chart Properties685 15.30.8 Pie Chart Properties686 15.30.9 Lines686 15.30.10 Solid Charts Bars686 15.30.11 Stacked Chart Bars686 15.31 Chart Axes Properties687 15.31.1 Linked Data Formats687 15.31.2 Visibility687 15.31.3 Scaling687 15.31.4 Tick Marks688 15.31.5 Labels689 15.32 Common Chart Properties689 15.32.1 Stacked Text690 15.32.2 Rotation Angle690 15.32.3 Data Labels690 15.33 Statistical Properties691 15.33.1 Mean Value691 15.33.2 Error Category691 15.34 Plot Area Properties693 15.34.1 Series Source693 15.35 Regression Curve Properties693 15.35.1 Regression Type694 15.36 Presentation Page Attributes694 15.36.1 Transition Type695 15.36.2 Transition Style695 15.36.3 Transition Speed697 15.36.4 Transition Type or Family698 15.36.5 Transition Subtype698 15.36.6 Transition Direction698 15.36.7 Fade Color698 15.36.8 Page Duration699 15.36.9 Page Visibility699 15.36.10 Sound699 15.36.11 Background Size699 15.36.12 Background Objects Visible700 15.36.13 Background Visible700 15.36.14 Display Header700 15.36.15 Display Footer700 15.36.16 Display Page Number701 15.36.17 Display Date And Time701 16 Data Types and Schema Definitions702 16.1 Data Types702 16.2 Other Definitions707 16.3 Relax-NG Schema Suffix708 17 Packages709 17.1 Introduction709 17.2 Zip File Structure709 17.3 Encryption710 17.4 MIME Type Stream710 17.5 Usage of IRIs Within Packages711 17.6 Preview Image711 17.7 Manifest File711 17.7.1 Relax-NG Schema712 17.7.2 Manifest Root Element712 17.7.3 File Entry712 17.7.4 Encryption Data713 17.7.5 Algorithm714 17.7.6 Key Derivation715 17.7.7 Relax-NG Schema Suffix717 Appendix A. Strict Relax NG Schema718 Appendix B. References720 Appendix C. MIME Types and File Name Extensions (Non Normative)722 Appendix D. Core Features Sets (Non Normative)724 Appendix E. Accessibility Guidelines (Non Normative)729 E.1. Title, Description and Caption of Graphical Elements729 E.2. Hyperlink Titles729 E.3. Tables in Presentations730 E.4. Further Guidelines730 Appendix F. Bidirectional (BiDi) Scripts,Numeric Digits Presentation and Calendars (Non Normative)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 Introduction Introduction This document defines an XML schema for office applications and its semantics. The schema is suitable for office documents, including text documents, spreadsheets, charts and graphical documents 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 XML-based tools. Chapter 1 contains the introduction to the OpenDocument format. The structure of documents that 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 their text 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 is common 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 data types used by the OpenDocument schema are described in chapter 16. The OpenDocument format makes use of a package concept. These packages are described in chapter 17. Notation Within this specification, the key words " shall ", " shall not ", " should ", " should not " and " may " are to be interpreted as described in Annex H of [ISO/IEC Directives] if they appear in bold letters. 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 Prefix Description Namespace office For all common pieces of information that 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 config For elements and attributes that describe application specific settings. urn:oasis:names:tc:opendocument:xmlns:config:1.0 text For elements and attributes that may occur within text documents and text parts of other document types, such as 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 within table 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 script For 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 inheritance model used by the OpenDocument format as well as some common formatting attributes. urn:oasis:names:tc:opendocument:xmlns:style:1.0 number For elements and attributes that describe data style information. urn:oasis:names:tc:opendocument:xmlns: data style :1.0 manifest For elements and attribute contained in 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 contain elements and attributes whose semantics are compatible to elements and attributes from other specifications. Table 2: XML Namespaces defined by the OpenDocument schema that include elements and attributes that are compatible to elements and attributes of other standards. Prefix Description Namespace fo For attributes that are compatible to attributes defined in [XSL]. urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0 svg For elements and attributes that are compatible to elements or attributes defined in [SVG]. urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0 smil For attributes that are compatible to attributes 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 Prefix Description Namespace dc 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 xforms The XForms namespace (see [XForms]). http://www.w3.org/2002/xforms 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 attribute default 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 a schema that restricts the content within these elements to the attributes and elements defined in this specification. Prefix for the normative Relax-NG schema: <?xml version="1.0" encoding="UTF-8"?> <!-- OASIS OpenDocumentv1.1 OASIS Standard, 1 Feb 2007 Relax-NG Schema $Id$ © 2002-2007 OASIS Open © 1999-2007 Sun Microsystems, Inc. --> <grammar xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" 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" 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" 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" 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" > 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 of a namespace that is defined within this specification and are called foreign elements and attributes. 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 shall write documents that are valid against the OpenDocument schema if all foreign elements and attributes are removed before validation takes place. Conforming applications that read and write documents may preserve foreign elements and attributes. In addition to this, conforming applications should preserve meta information and the content of styles. 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 these elements 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 the value true or false. If the attribute's value is true, or if the attribute does not exist, the element'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 the element'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 should preserve them. 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. <define name="office-process-content"> <optional> <attribute name="office:process-content" a:defaultValue="true"> <ref name="boolean"/> </attribute> </optional> </define> White-Space Processing and EOL Handling In conformance with the W3C XML specification [XML1.0], optional white-space characters that are 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 is no 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 contained in 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 HORIZONTAL TABULATION and LINE FEED characters if they are contained in an attribute value. 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. 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 in appendix C should be used where appropriate. Document Structure This chapter introduces the structure of the OpenDocument format. The chapter contains the following 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, with associated 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. 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 and stores a particular aspect of the XML document. For example, one subdocument contains the style information and another subdocument contains the content of the document. All types of documents, for example, text and spreadsheet documents, use the same document and subdocuments 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 automatic styles used in the content. content.xml <office:document-styles> Styles used in the document content and automatic styles used in the styles themselves. styles.xml <office:document-meta> Document meta information, such as the author or the time of the last save action. meta.xml <office:document-settings> Application-specific settings, such as the window size or printer information. settings.xml 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. <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> 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 meta­data app. sett. script font decls style auto style mast style body <office:document> <office:document-content> <office:document-styles> <office:document-meta> <office:document-settings> The <office:document> root contains a complete document: <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"/> <ref name="office-body"/> </element> </define> The <office:document-content> root contains only the document content, along with the automatic styles needed for the document content: <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 the automatic styles needed for the named styles: <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. <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. <define name="office-document-settings"> <element name="office:document-settings"> <ref name="office-document-common-attrs"/> <ref name="office-settings"/> </element> </define> Document Root Attributes Version All root elements take an office:version attribute, which indicates which version of this specification 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. <define name="office-document-common-attrs" combine="interleave"> <optional> <attribute name="office:version"> <ref name="string"/> </attribute> </optional> </define> MIME Type The <office:document> element takes an office:mimetype attribute, which indicates the type 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 is also present in a separate file, see section 17.4). Its values are the MIME types that are used for the packaged variant of office documents (see section 1.7). <define name="office-document-attrs" combine="interleave"> <attribute name="office:mimetype"> <ref name="string"/> </attribute> </define> Document Metadata Metadata is general information about a document. In the OpenDocument format, all of the metadata 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. <define name="office-meta"> <optional> <element name="office:meta"> <ref name="office-meta-content"/> </element> </optional> </define> <define name="office-meta-content"> <ref name="anyElements"/> </define> <define name="office-meta-content-strict"> <zeroOrMore> <ref name="office-meta-data"/> </zeroOrMore> </define> 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, and value. 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 the use of suitable text fields. Custom metadata are arbitrary elements inside <office:meta>. Since their semantics is not defined in this specification, conforming applications in general cannot process or display this data. Applications should preserve this data when editing the document. 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> 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 is typically framed by a prelude and epilogue, which contain additional information for a specific type of document, like form data or variable declarations. <define name="office-body"> <element name="office:body"> <ref name="office-body-content"/> </element> </define> Text Documents The content of text documents mainly consists of a sequence containing any number of paragraphs, tables, indices, text frames, text sections, and graphical elements. Additionally, a text document may contain forms, change tracking information and variable declarations. Each of these is defined in the document prelude, and may be referenced from the document content. <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, and variable declarations. To allow office applications to implement functionality that usually is available in spreadsheets for text documents, it may also contain elements that implement enhanced table features. See also section 2.3.4. <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 an alternative, 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 a sequence frames only. <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> <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 elements that implement enhanced table features. See also section 2.3.4. <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. <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:break-before 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. 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 not depend 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:use-page-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-page-breaks attribute to false (or remove it). It should also remove the text:soft-page-break elements 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 on export 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 number of <text:soft-page-break> elements that appear within the single table cells determines the number 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. <define name="office-text-attlist" combine="interleave"> <optional> <attribute name="text:use-soft-page-breaks" a:defaultValue="false"> <ref name="boolean"/> </attribute> </optional> </define> Drawing Documents The content of drawing document consists of a sequence of draw pages. <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> <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. <define name="office-drawing-content-prelude"> <ref name="text-decls"/> <ref name="table-decls"/> </define> The main document content contains a sequence of draw pages. <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 contain elements that implement enhanced table features. See also section 2.3.4. <define name="office-drawing-content-epilogue"> <ref name="table-functions"/> </define> Presentation Documents The content of presentation document consists of a sequence of draw pages. <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> <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. <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. <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. <define name="office-presentation-content-epilogue"> <ref name="presentation-settings"/> <ref name="table-functions"/> </define> 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 of declarations that simplify the usage of spreadsheet tables and their analysis. Each of these are contained in either the document prelude, or the document epilogue. <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 for label ranges. <define name="office-spreadsheet-content-prelude"> <optional> <ref name="table-tracked-changes"/> </optional> <ref name="text-decls"/> <ref name="table-decls"/> </define> <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. <define name="office-spreadsheet-content-main"> <zeroOrMore> <ref name="table-table"/> </zeroOrMore> </define> The epilogue of spreadsheet documents contains declarations for named expressions, database ranges, data pilot tables, consolidation operations and DDE links. <define name="office-spreadsheet-content-epilogue"> <ref name="table-functions"/> </define> <define name="table-functions"> <optional> <ref name="table-named-expressions"/> </optional> <optional> <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> Chart Documents The content of chart documents mainly consists of a chart element. <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> <define name="office-chart-attlist"> <empty/> </define> Chart Document Content Model To allow office applications to implement functionality that usually is available in spreadsheets for the 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. <define name="office-chart-content-prelude"> <ref name="text-decls"/> <ref name="table-decls"/> </define> The main document is a chart element only. <define name="office-chart-content-main"> <ref name="chart-chart"/> </define> There are no chart documents specific epilogue elements, but the epilogue may contain elements that implement enhanced table features. See also section 2.3.4. <define name="office-chart-content-epilogue"> <ref name="table-functions"/> </define> Image Documents The content of an image document is a frame element only. The frame element must contain a single image element. <define name="office-body-content" combine="choice"> <element name="office:image"> <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> <define name="office-image-attlist"> <empty/> </define> Image Document Content Model The image document prelude is empty. <define name="office-image-content-prelude"> <empty/> </define> The main document content contains a frame only. <define name="office-image-content-main"> <ref name="draw-frame"/> </define> There are no image documents specific epilogue elements. <define name="office-image-content-epilogue"> <empty/> </define> Application Settings Application settings are contained in a <office:settings> element. <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. 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. <define name="config-config-item-set"> <element name="config:config-item-set"> <ref name="config-config-item-set-attlist"/> <ref name="config-items"/> </element> </define> <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. <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> Base Settings The <config:config-item> element contains all base settings. The value of the setting is stored in the element. <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. <define name="config-config-item-attlist" combine="interleave"> <attribute name="config:name"> <ref name="string"/> </attribute> </define> Config Type The config:type attribute identifies the data type of setting. <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> 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 <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. <define name="config-config-item-map-indexed-attlist" combine="interleave"> <attribute name="config:name"> <ref name="string"/> </attribute> </define> 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. <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. <define name="config-config-item-map-entry-attlist" combine="interleave"> <optional> <attribute name="config:name"> <ref name="string"/> </attribute> </optional> </define> 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. <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. <define name="config-config-item-map-named-attlist" combine="interleave"> <attribute name="config:name"> <ref name="string"/> </attribute> </define> Cursor Position Setting A common view setting for editing applications is the position where the text cursor was while saving the document. For WYSIWYG applications, this usually will be a position within a paragraph 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> Scripts A document may contain several scripts in different scripting languages. Each script is represented 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 are called immediately after the document is loaded. In addition to <office:script> elements, the <office:scripts> element may also contain an <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. <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> 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. <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. <define name="office-script-attlist"> <attribute name="script:language"> <ref name="string"/> </attribute> </define> 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 for details. <define name="office-font-face-decls"> <optional> <element name="office:font-face-decls"> <zeroOrMore> <ref name="style-font-face"/> </zeroOrMore> </element> </optional> </define> Styles The OpenDocument format supports the following types of styles: Common stylesMost office applications support styles within their user interface. Within this specification, the XML representations of such styles are referred to as styles. When a differentiation from the other 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 stylesAn automatic style contains formatting properties that, in the user interface view of a document, are assigned to an object such as a paragraph. The term automatic indicates that the 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 of content and layout is achieved. Master stylesA 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 master style are master pages. Master pages can be used in graphical applications. In this case, the additional 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 is additional content that influences the representation of a document but does not change the content 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 of a 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 is reloaded or displayed on any device, because this is common practice for documents created by word processors. This type of style information differs from [CSS2] or [XSLT] style sheets that are used to display a document. An additional style sheet for CSS, XSLT, and so on, is required to display a document in OpenDocument format on a certain device. This style sheet must take into account the styles in the document as well as the requirements and capabilities of the output device. The ideal case is that this style sheet depends on the output device only. See section 14 for more information on styles. Location of Styles Common and automatic styles have the same XML representation, but they are contained within two distinct container elements, as follows: <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> </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> <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> </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> 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 is displayed on all pages in the document that use the master page. Examples of static content are headers, 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 master page is instantiated, an empty page is generated with the properties of the page master and the static 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 a style: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 page styles. 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. 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). Pre-Defined Metadata Elements There is a set of pre-defined metadata elements which should be processed and updated by the applications. Metadata elements may be omitted or occur multiple times. It is application-specific how to update multiple instances of the same elements. Generator The <meta:generator> element contains a string that identifies the application or tool that was used to create or last modify the XML document. This string should match the definition for user-agents 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 instance by including build ids or patch level information. Conforming applications may use the generator string to work around bugs that exist or existed in certain applications, but shall not deliberately implement a different behavior depending on a certain 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 created the document. <define name="office-meta-data" combine="choice"> <element name="meta:generator"> <ref name="string"/> </element> </define> Title The <dc:title> element specifies the title of the document. <define name="office-meta-data" combine="choice"> <element name="dc:title"> <ref name="string"/> </element> </define> Description The <dc:description> element contains a brief description of the document. <define name="office-meta-data" combine="choice"> <element name="dc:description"> <ref name="string"/> </element> </define> Subject The <dc:subject> element specifies the subject of the document. <define name="office-meta-data" combine="choice"> <element name="dc:subject"> <ref name="string"/> </element> </define> 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. <define name="office-meta-data" combine="choice"> <element name="meta:keyword"> <ref name="string"/> </element> </define> Initial Creator The <meta:initial-creator> element specifies the name of the person who created the document initially. <define name="office-meta-data" combine="choice"> <element name="meta:initial-creator"> <ref name="string"/> </element> </define> 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 last person to modify the document is primarily responsible for making the content of the document. <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> Printed By The <meta:printed-by> element specifies the name of the last person who printed the document. <define name="office-meta-data" combine="choice"> <element name="meta:printed-by"> <ref name="string"/> </element> </define> Creation Date and Time The <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. <define name="office-meta-data" combine="choice"> <element name="meta:creation-date"> <ref name="dateTime"/> </element> </define> Modification Date and Time The <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. <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> Print Date and Time The <meta:print-date> element specifies the date and time when the document was last printed. To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss. <define name="office-meta-data" combine="choice"> <element name="meta:print-date"> <ref name="dateTime"/> </element> </define> Document Template The <meta:template> element contains a URL for the document template that was used to create 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 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 Time The 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. <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> Automatic Reload The <meta:auto-reload> element specifies whether a document is reloaded or replaced by another 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 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 attribute is PnYnMnDTnHnMnS. See §3.2.6 of [xmlschema-2] for more detailed information on this duration format. <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> Hyperlink Behavior The <meta:hyperlink-behaviour> element specifies the default behavior for hyperlinks in the 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 in which to display a document referenced by a hyperlink. 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 <meta:hyperlink-behaviour> element. If the value of the meta:target-frame-name attribute is _blank, the xlink:show attribute value is new. If the value of the meta:target-frame-name attribute is any of the other value options, the value of the xlink:show attribute is replace. <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> 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. <define name="office-meta-data" combine="choice"> <element name="dc:language"> <ref name="language"/> </element> </define> 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. <define name="office-meta-data" combine="choice"> <element name="meta:editing-cycles"> <ref name="nonNegativeInteger"/> </element> </define> 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. <define name="office-meta-data" combine="choice"> <element name="meta:editing-duration"> <ref name="duration"/> </element> </define> Document Statistics The <meta:document-statistic> element specifies the statistics of the document, for example, 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 Document Statistics Attributes Text meta:page-countmeta:table-countmeta:draw-countmeta:image-countmeta:object-countmeta:ole-object-countmeta:paragraph-count meta:word-countmeta:character-countmeta:row-countmeta:frame-countmeta:sentence-countmeta:syllable-countmeta:non-whitespace-character-count Spreadsheet meta:page-countmeta:table-count meta:image-count meta:cell-countmeta:object-count Graphic meta:page-count meta:image-count meta:object-count <define name="office-meta-data" combine="choice"> <element name="meta:document-statistic"> <optional> <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"/> </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> 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 as value of the office:value attributes for the various data types. The default type for meta-data elements is string. <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> </attribute> <ref name="boolean"/> </group> <group> <attribute name="meta:value-type"> <value>string</value> </attribute> <ref name="string"/> </group> <text/> </choice> </element> </define> 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 such foreign content, applications need not process this information other than to preserve it when editing the document. Text Content Headings, Paragraphs and Basic Text Structure This section describes the XML elements and attributes that are used to represent heading and paragraph components in a text document. The elements <text:h> and <text:p> represent headings and paragraphs, respectively, and are collectively referred to as paragraph elements. All text content in an OpenDocument file must be contained in either of these elements. Headings Headings define the chapter structure for a document. A chapter or subchapter begins with a heading and extends to the next heading at the same or higher level. <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 level of the heading, starting with 1. Headings without a level attribute are assumed to be at level 1. <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 (see section 4.3.2, below). The numbering of headers can be restarted by setting the text:restart-numbering attribute to true. <define name="heading-attrs" combine="interleave"> <optional> <attribute name="text:restart-numbering" a:defaultValue="false"> <ref name="boolean"/> </attribute> </optional> </define> Start Value The attribute text:start-value may be used to restart the numbering of headers of the current header's level, by setting a new value for the numbering. <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. <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 of headings, but it will be ignored by applications that support numbering. <define name="text-number"> <element name="text:number"> <ref name="string"/> </element> </define> Paragraphs Paragraphs are the basic unit of text. <define name="text-p"> <element name="text:p"> <ref name="paragraph-attrs"/> <zeroOrMore> <ref name="paragraph-content"/> </zeroOrMore> </element> </define> Common Paragraph Elements Attributes The paragraph elements have text:style-name, text:class-names and text:cond-style-name attributes. These attributes must reference paragraph styles. A text:style-name attribute references a paragraph style, while a text:cond-style-name attribute references a conditional-style, that is, a style that contains conditions and maps to other styles (see section 14.1.1). If a conditional style is applied to a paragraph, the text:style-name attribute contains the name of the style that was the result of the conditional style evaluation, while the conditional style name itself is the value of the text:cond-style-name attribute. This XML structure simplifies [XSLT] transformations because XSLT only has to acknowledge 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:style-name and text:class-names are present, the style referenced by the text:style-name attribute 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 should preserve it while editing. <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 numbered paragraph, 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 other elements. <define name="paragraph-attrs" combine="interleave"> <optional> <ref name="text-id"/> </optional> </define> Page Sequences A page sequence element <text:page-sequence> specifies a sequence of master pages that are instantiated in exactly the same order as they are referenced in the page sequence. If a text 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 and paragraphs as is the case for documents that do not contain a page sequence. Text content is included within text boxes for documents with page sequences. The only other content that is permitted 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> <define name="text-page-sequence"> <element name="text:page-sequence"> <oneOrMore> <ref name="text-page"/> </oneOrMore> </element> </define> Page The <text:page> element specifies a single page within a page sequence. <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. <define name="text-page-attlist"> <attribute name="text:master-page-name"> <ref name="styleNameRef"/> </attribute> </define> Lists The OpenDocument format supports list structures, similar to those found in [HTML4]. A list is a paragraph-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 a suitable list style being used. In addition to this structural information, lists can have list styles associated with them, which contain 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. List Block A list is represented by the <text:list> element. It contains an optional list header, followed by any number of list items. Every list has a list level, which is determined by the nesting of the <text:list> elements. If a list 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: 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> 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 is taken: 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 that have paragraph styles attached specifying a list style, this list style is used for any of these paragraphs. 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 are taken into account. See section 14.10 for more information on list formatting properties. <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 in the preceding list incremented by one. <define name="text-list-attr" combine="interleave"> <optional> <attribute name="text:continue-numbering"> <ref name="boolean"/> </attribute> </optional> </define> List Item List items contain the textual content of a list. A <text:list-item> element can contain paragraphs, headings, lists or soft page breaks. A list item cannot contain tables. <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"> <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 the numbering of the list at the current item. <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> </text:list-item> <text:list-item> <text:p>This is the third list item</text:p> </text:list-item> </text:list> 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. <define name="text-list-header"> <element name="text:list-header"> <ref name="text-list-item-content"/> </element> </define> 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 at which level. To facilitate this, the <text:numbered-paragraph> element allows the numbering of 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> representation and vice versa. <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, the numbered paragraph is interpreted as being on level 1. <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. <define name="text-numbered-paragraph-attr" combine="interleave"> <ref name="text-list-attr"/> </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 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. 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 automatically acquired from some external data source. In addition to Sections can contain regular text content or the text can be contained in another file and 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 another document, 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 section that 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. <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. Section Attributes Text indices, described in chapter 7, may be considered a special kind of text section, as they share the same general structure as well as certain attributes. These are combined in the following definition: <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. <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 attribute contains the name of the section. <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. <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 the protection flag. The text:protection-key attribute specifies the password that protects the section. To avoid saving the password directly into the XML file, only a hash value of the password is stored. <define name="sectionAttr" combine="interleave"> <optional> <attribute name="text:protection-key"> <ref name="string"/> </attribute> </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, the text:condition attribute must be present. <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> 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. <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 Section Source URL These attributes identify the document or section to which the section is linked. The name of the target 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. <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 name of the target section. If the attribute is not present, the link targets the entire document. <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. <define name="text-section-source-attr" combine="interleave"> <optional> <attribute name="text:filter-name"> <ref name="string"/> </attribute> </optional> </define> DDE Source If sections are linked via DDE, their linking information is represented by <office:dde-source> 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. <define name="text-section-source-dde"> <ref name="office-dde-source"/> </define> Page-bound graphical content Within text documents, images, embedded objects and other drawing objects appear at the level of 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 their anchoring. Change Tracking This section describes how changes in text documents can be represented. Tracked Changes All tracked changes to text documents are stored in a list. The list contains an element for each change made to the document. If the <text:tracked-changes> element is absent, change tracking is not enabled. <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 this document. <define name="text-tracked-changes-attr" combine="interleave"> <optional> <attribute name="text:track-changes" a:defaultValue="true"> <ref name="boolean"/> </attribute> </optional> </define> 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. <define name="text-changed-region"> <element name="text:changed-region"> <ref name="text-changed-region-attr"/> <ref name="text-changed-region-content"/> </element> </define> 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. <define name="text-changed-region-attr" combine="interleave"> <attribute name="text:id"> <ref name="ID"/> </attribute> </define> 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, or a whole table. The inserted content is part of the text document itself and is marked by a change start and a change end element. <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> 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 a paragraph element. If the deleted text is reinserted into the document, the paragraph is joined with the paragraph where the deletion took place. <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 <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 deleted This 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 this has been deleted. Note that the deleted text, like all text in the OpenDocument format, is contained in a paragraph element. To reconstruct the original text, this paragraph is merged with its surrounding. In other words, 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. <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> Format Change A format change element represents any change in formatting attributes. The region where the change took place is marked by a change start and a change end element. <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. 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). 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 the format 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 the format 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. <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> Soft Page Break The <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. <define name="text-soft-page-break"> <element name="text:soft-page-break"> <empty/> </element> </define> 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 such declarations are optional. The detailed description for each declaration can be found in the appropriate chapter. The supported text declarations are: variable declarations – These declarations are used for variable fields. (cf. section 6.3.1). 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> Paragraph Elements Content Basic Text Content Paragraph element's children make up the text content of any document. All text contained in a paragraph 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 child elements of paragraph elements and only process their text content, and still obtain a faithful representation 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. <define name="paragraph-content" combine="choice"> <text/> </define> White-space Characters If the paragraph element or any of its child elements contains white-space characters, they are collapsed. Leading white-space characters at the paragraph start as well as trailing white-space characters 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 the preceding sibling element, as long as it is contained within the same paragraph element and the element in which it is contained processes white-space characters as described above. White-space characters at the start or end of the paragraph are ignored, regardless whether they are contained 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. 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 the paragraph 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 a single SPACE character. This element is required to represent the second and all following SPACE characters in a sequence of SPACE characters. It is not an error if the character preceding the element is not a white-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. <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 HORIZONTAL TABULATION (0x0009) in a heading or paragraph. A <text:tab> element reserves space from the current position up to the next tab-stop, as defined in the paragraph's style information. <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 make it 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 the current 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. <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. <define name="paragraph-content" combine="choice"> <element name="text:line-break"> <empty/> </element> </define> Soft Page Break The <text:soft-page-break> element represents a soft page break within a heading or paragraph. See section 2.3.1:Use Soft Page BreaksUse Soft Page Breaks for details regarding soft page breaks. <define name="paragraph-content" combine="choice"> <ref name="text-soft-page-break"/> </define> Soft Hyphens, Hyphens, and Non-breaking Blanks Soft hyphens, hyphens, and non-breaking blanks are represented by [UNICODE] characters. The [UNICODE] character... Represents... SOFT HYPHEN (00AD) soft hyphens NON-BREAKING HYPHEN (2011) non-breaking hyphens NO-BREAK SPACE (00A0) non-breaking blanks 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:class-names attributes, respectively, attached to the <text:span> element. These attributes must refer to text styles or classes. A text:style-name attribute references a single text style. A text:class-names attribute takes a whitespace 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 attribute and also should preserve it while editing. <text:span> elements can be nested. White-space characters contained in this element are collapsed. <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> Hyperlinks Hyperlinks in text documents are represented by a <text:a> element. This element also contains an event table element, <office:event-listeners>, which contains the events assigned to the hyperlink. See section 12.4 for more information on the event table element. <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"/> </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 the name of the hyperlink if one exists. This name can serve as a target for some other hyperlinks. <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. <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. <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> 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 is new. If the value of the attribute is any of the other value options, the value of the xlink:show attribute is replace. See [XLink]. <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: 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> Bookmarks and References 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. <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 this paragraph. <text:bookmark-start text:name="Mark 2"/>In front of this paragraph there is the start of a bookmark. </text:p> <text:p> This bookmark ends <text:bookmark-end text:name="Mark 2"/> amid this sentence. </text:p> References The representation of references is modeled on the XML representation of bookmarks. There are two types of reference marks, as follows: A point referenceA point reference marks a particular position in text and is represented by a single <text:reference-mark> element. A range referenceA 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:reference-mark-end> to mark the end of the range. Every reference is identified by its name, which must be unique. In a range reference, the start and end elements must use the same reference name. Point References The <text:reference-mark> element represents a point reference. <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. <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. <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 the referenced 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. 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:notes-configuration> element, which occurs inside the <office:styles> section. 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's content. 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:note-citation> element. The second child contains the note body, just as in XSL. Additionally, OpenDocument features <text:notes-configuration> elements. To achieve a similar effect to the note configuration in XSL, every note citation element must be formatted appropriately. <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> 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. <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 is referenced. Note Citation Element The <text:note-citation> element contains the formatted note citation element, either as a formatted 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, the user 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 have any attributes. The schema allows for the inclusion of notes into the note body. While this may be reasonable for some 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"> <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> Ruby A ruby is additional text that is displayed above or below some base text. The purpose of ruby is to 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 attribute references 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. <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> Text Annotation The OpenDocument format allows annotation to appear within a paragraph element. See section 12.1 for details on annotations. <define name="paragraph-content" combine="choice"> <ref name="office-annotation"/> </define> 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. Change Tracking and Change Marks Paragraphs may also contain change tracking marks. These have already been explained in the chapter on change tracking (section 4.6), and are referenced here for completeness. <define name="paragraph-content" combine="choice"> <ref name="change-marks"/> </define> Inline graphics and text-boxes Within text documents, images, embedded objects and other drawing objects may be anchored to a 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 for details on drawing objects, and section 9.2.16 for their anchoring. <define name="paragraph-content" combine="choice"> <choice> <ref name="shape"/> <ref name="draw-a"/> </choice> </define> 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 of field, each of which implements a different type of variable text element. Fields are most commonly used for: Page numbersA page number field displays the number of the page it appears on. This field is useful for footers. For every page on which the footer appears, the field assumes the current page number so that all pages are numbered correctly. Creation datesA 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 the date when it was created. Number rangesA number range field allows the user to number certain elements, for example, images or tables. 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. 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 the presentation of the field can be recomputed if necessary, for example, if the user decides to change the formatting style of the field. It is also necessary to store the presentation style of the element 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, a value 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 in additional attributes. The most common attributes of field elements are: Fixed fieldsMany fields have a variant where the content does not change after the initial value is assigned. These fields are generally marked by the attribute text:fixed. See section 6.7.2 for more information on this attribute. Formatting styleSeveral field types, particularly those representing number, date, or time data, contain a formatting style. In the OpenDocument format, this formatting style is represented by a style:data-style-name attribute. Since the user can change the presentation style for fields, 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. Document Fields OpenDocument fields can display information about the current document or about a specific part of 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 is preserved, rather than re-evaluated, when the document is edited. For example, a date field shows 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.