Open Document Format for Office Applications (OpenDocument) v1.0 OASIS Standard, 1 May 2005 Document identifier: OpenDocument-v1.0-os.sxw Location: http://docs.oasis-open.org/office/v1.0 Editors: Michael Brauer, Sun Microsystems Patrick Durusau, Society of Biblical Literature Gary Edwards David Faure, Tom Magliery, Blast Radius Daniel Vogelheim, Sun Microsystems Contributors: Doug Alberg, Boeing Simon Davis, National Archive of Australia Paul Grosso, Arbortext Phil Boutros, Stellent John Chelsom, CSW Informatics Jason Harrop Mark Heller, New York State Office of the Attorney General Paul Langille, Corel Monica Martin, Drake Certivo Uche Ogbuji Lars Oppermann, Sun Microsystems Lauren Wood 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 1 of 706 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.oasisopen.org/committees/office. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 2 of 706 Table of Contents 1 Introduction..................................................................................................................................31 1.1 Introduction...........................................................................................................................31 1.2 Notation.................................................................................................................................31 1.3 Namespaces.........................................................................................................................31 1.4 Relax-NG Schema...............................................................................................................33 1.5 Document Processing and Conformance............................................................................ 34 1.6 White-Space Processing and EOL Handling.......................................................................35 1.7 MIME Types and File Name Extensions..............................................................................35 2 Document Structure.....................................................................................................................37 2.1 Document Roots...................................................................................................................37 2.1.1 Document Root Element Content Models....................................................................38 2.1.2 Document Root Attributes.............................................................................................39 2.2 Document Metadata.............................................................................................................40 2.2.1 Pre-Defined vs. Custom Metadata............................................................................... 40 2.2.2 Sample Metadata..........................................................................................................41 2.3 Body Element and Document Types....................................................................................41 2.3.1 Text Documents............................................................................................................42 2.3.2 Drawing Documents......................................................................................................43 2.3.3 Presentation Documents...............................................................................................44 2.3.4 Spreadsheet Documents...............................................................................................45 2.3.5 Chart Documents..........................................................................................................46 2.3.6 Image Documents.........................................................................................................46 2.4 Application Settings..............................................................................................................47 2.4.1 Sequence of Settings....................................................................................................47 2.4.2 Base Settings................................................................................................................48 2.4.3 Index Access of Sequences..........................................................................................49 2.4.4 Map Entry......................................................................................................................49 2.4.5 Name Access of Sequences.........................................................................................50 2.4.6 Cursor Position Setting.................................................................................................50 2.5 Scripts...................................................................................................................................50 2.5.1 Script.............................................................................................................................51 2.6 Font Face Declarations........................................................................................................51 2.7 Styles....................................................................................................................................52 2.7.1 Location of Styles .........................................................................................................52 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 3 of 706 2.8 Page Styles and Layout........................................................................................................55 3 Meta Data Elements....................................................................................................................56 3.1 Pre-Defined Metadata Elements..........................................................................................56 3.1.1 Generator......................................................................................................................56 3.1.2 Title................................................................................................................................56 3.1.3 Description....................................................................................................................56 3.1.4 Subject..........................................................................................................................57 3.1.5 Keywords.......................................................................................................................57 3.1.6 Initial Creator ................................................................................................................57 3.1.7 Creator...........................................................................................................................57 3.1.8 Printed By......................................................................................................................57 3.1.9 Creation Date and Time................................................................................................58 3.1.10 Modification Date and Time........................................................................................58 3.1.11 Print Date and Time....................................................................................................58 3.1.12 Document Template....................................................................................................58 3.1.13 Automatic Reload........................................................................................................59 3.1.14 Hyperlink Behavior......................................................................................................60 3.1.15 Language.....................................................................................................................61 3.1.16 Editing Cycles.............................................................................................................61 3.1.17 Editing Duration...........................................................................................................62 3.1.18 Document Statistics....................................................................................................62 3.2 User-defined Metadata.........................................................................................................64 3.3 Custom Metadata.................................................................................................................65 4 Text Content.................................................................................................................................66 4.1 Headings, Paragraphs and Basic Text Structure.................................................................66 4.1.1 Headings.......................................................................................................................66 4.1.2 Paragraphs....................................................................................................................67 4.1.3 Common Paragraph Elements Attributes.....................................................................67 4.2 Page Sequences...................................................................................................................68 4.2.1 Page..............................................................................................................................69 4.3 Lists.......................................................................................................................................70 4.3.1 List Block.......................................................................................................................70 4.3.2 List Item.........................................................................................................................71 4.3.3 List Header....................................................................................................................72 4.3.4 Numbered Paragraphs..................................................................................................73 4.4 Text Sections........................................................................................................................73 4.4.1 Section Attributes..........................................................................................................74 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 4 of 706 4.4.2 Section Source..............................................................................................................76 4.4.3 DDE Source..................................................................................................................77 4.5 Page-bound graphical content..............................................................................................77 4.6 Change Tracking..................................................................................................................77 4.6.1 Tracked Changes..........................................................................................................78 4.6.2 Changed Regions..........................................................................................................78 4.6.3 Insertion.........................................................................................................................78 4.6.4 Deletion.........................................................................................................................79 4.6.5 Format Change.............................................................................................................81 4.6.6 Change Info...................................................................................................................81 4.6.7 Change Marks...............................................................................................................81 4.7 Text Declarations..................................................................................................................82 5 Paragraph Elements Content.......................................................................................................84 5.1 Basic Text Content...............................................................................................................84 5.1.1 White-space Characters................................................................................................84 5.1.2 Soft Hyphens, Hyphens, and Non-breaking Blanks......................................................86 5.1.3 Attributed Text...............................................................................................................86 5.1.4 Hyperlinks......................................................................................................................87 5.2 Bookmarks and References.................................................................................................89 5.2.1 Bookmarks....................................................................................................................89 5.2.2 References....................................................................................................................90 5.3 Notes.....................................................................................................................................91 5.3.1 Note Element................................................................................................................91 5.4 Ruby......................................................................................................................................93 5.5 Text Annotation....................................................................................................................94 5.6 Index Marks..........................................................................................................................94 5.7 Change Tracking and Change Marks...................................................................................94 5.8 Inline graphics and text-boxes..............................................................................................94 6 Text Fields...................................................................................................................................95 6.1 Common Characteristics of Field Elements........................................................................ 95 6.2 Document Fields...................................................................................................................96 6.2.1 Date Fields....................................................................................................................96 6.2.2 Time Fields....................................................................................................................97 6.2.3 Page Number Fields.....................................................................................................99 6.2.4 Page Continuation Text..............................................................................................100 6.2.5 Sender Fields..............................................................................................................101 6.2.6 Author Fields...............................................................................................................104 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 5 of 706 6.2.7 Chapter Fields.............................................................................................................104 6.2.8 File Name Fields.........................................................................................................105 6.2.9 Document Template Name Fields..............................................................................106 6.2.10 Sheet Name Fields....................................................................................................107 6.3 Variable Fields....................................................................................................................107 6.3.1 Declaring Simple Variables.........................................................................................108 6.3.2 Setting Simple Variables.............................................................................................108 6.3.3 Displaying Simple Variables.......................................................................................109 6.3.4 Simple Variable Input Fields.......................................................................................110 6.3.5 Declaring User Variables............................................................................................111 6.3.6 Displaying User Variables...........................................................................................111 6.3.7 User Variable Input Fields...........................................................................................112 6.3.8 Declaring Sequence Variables....................................................................................113 6.3.9 Using Sequence Fields...............................................................................................114 6.3.10 Expression Fields......................................................................................................115 6.3.11 Text Input Fields.......................................................................................................116 6.4 Metadata Fields..................................................................................................................116 6.4.1 Initial Creator...............................................................................................................116 6.4.2 Document Creation Date............................................................................................117 6.4.3 Document Creation Time............................................................................................117 6.4.4 Document Description.................................................................................................117 6.4.5 User-Defined Document Information..........................................................................117 6.4.6 Print Time....................................................................................................................118 6.4.7 Print Date....................................................................................................................118 6.4.8 Printed By....................................................................................................................119 6.4.9 Document Title............................................................................................................119 6.4.10 Document Subject.....................................................................................................119 6.4.11 Document Keywords.................................................................................................119 6.4.12 Document Revision Number.....................................................................................119 6.4.13 Document Edit Duration............................................................................................120 6.4.14 Document Modification Time....................................................................................120 6.4.15 Document Modification Date.....................................................................................120 6.4.16 Document Modified By..............................................................................................121 6.4.17 Document Statistics Fields........................................................................................121 6.5 Database Fields..................................................................................................................121 6.5.1 Database Field Data Source.......................................................................................122 6.5.2 Displaying Database Content......................................................................................123 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 6 of 706 6.5.3 Selecting the Next Database Row..............................................................................124 6.5.4 Selecting a Row Number............................................................................................125 6.5.5 Displaying the Row Number........................................................................................126 6.5.6 Display Current Database and Table..........................................................................126 6.6 More Fields.........................................................................................................................127 6.6.1 Page Variable Fields...................................................................................................127 6.6.2 Placeholders................................................................................................................128 6.6.3 Conditional Text Fields...............................................................................................129 6.6.4 Hidden Text Field........................................................................................................130 6.6.5 Reference Fields.........................................................................................................131 6.6.6 Script Fields................................................................................................................134 6.6.7 Macro Fields................................................................................................................135 6.6.8 Hidden Paragraph Fields............................................................................................135 6.6.9 DDE Connection Fields...............................................................................................136 6.6.10 Measure Fields..........................................................................................................137 6.6.11 Table Formula Field..................................................................................................137 6.7 Common Field Attributes....................................................................................................138 6.7.1 Variable Value Types and Values...............................................................................138 6.7.2 Fixed............................................................................................................................140 6.7.3 Variable Name............................................................................................................140 6.7.4 Description .................................................................................................................141 6.7.5 Display.........................................................................................................................141 6.7.6 Formula.......................................................................................................................142 6.7.7 Formatting Style..........................................................................................................142 6.7.8 Number Formatting Style............................................................................................143 7 Text Indices................................................................................................................................144 7.1 Index Marks........................................................................................................................144 7.1.1 Table of Content Index Marks.....................................................................................144 7.1.2 User-Defined Index Marks..........................................................................................145 7.1.3 Alphabetical Index Mark..............................................................................................146 7.1.4 Bibliography Index Mark.............................................................................................148 7.2 Index Structure...................................................................................................................149 7.2.1 Index Source...............................................................................................................149 7.2.2 Index Body Section.....................................................................................................150 7.2.3 Index Title Section......................................................................................................150 7.3 Table Of Content................................................................................................................150 7.3.1 Table of Content Source.............................................................................................151 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 7 of 706 7.3.2 Table of Content Entry Template................................................................................153 7.4 Index of Illustrations...........................................................................................................154 7.4.1 Index of Illustration Source.........................................................................................155 7.4.2 Illustration Index Entry Template................................................................................156 7.5 Index of Tables...................................................................................................................157 7.5.1 Table Index Source.....................................................................................................157 7.5.2 Table Index Entry Template........................................................................................157 7.6 Index of Objects..................................................................................................................158 7.6.1 Object Index Source...................................................................................................158 7.6.2 Object Index Entry Template......................................................................................159 7.7 User-Defined Index.............................................................................................................160 7.7.1 User-Defined Index Source.........................................................................................160 7.7.2 User-Defined Index Entry Template...........................................................................162 7.8 Alphabetical Index..............................................................................................................163 7.8.1 Alphabetical Index Source..........................................................................................163 7.8.2 Auto Mark File.............................................................................................................167 7.8.3 Alphabetical Index Entry Template.............................................................................167 7.9 Bibliography........................................................................................................................168 7.9.1 Bibliography Index Source..........................................................................................168 7.9.2 Bibliography Entry Template.......................................................................................168 7.10 index source styles...........................................................................................................169 7.10.1 Index source style.....................................................................................................169 7.11 Index title template...........................................................................................................170 7.12 Index Template Entries....................................................................................................170 7.12.1 Chapter Information..................................................................................................170 7.12.2 Entry Text..................................................................................................................171 7.12.3 Page Number............................................................................................................171 7.12.4 Fixed String...............................................................................................................171 7.12.5 Bibliography Information...........................................................................................172 7.12.6 Tab Stop....................................................................................................................173 7.12.7 Hyperlink Start and End............................................................................................174 7.12.8 Example of an Index Entry Configuration.................................................................174 8 Tables.........................................................................................................................................176 8.1 Basic Table Model..............................................................................................................176 8.1.1 Table Element.............................................................................................................176 8.1.2 Table Row ..................................................................................................................179 8.1.3 Table Cell ...................................................................................................................181 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 8 of 706 8.2 Advanced Table Model.......................................................................................................186 8.2.1 Column Description ....................................................................................................186 8.2.2 Header Columns.........................................................................................................188 8.2.3 Column Groups...........................................................................................................189 8.2.4 Header Rows...............................................................................................................189 8.2.5 Row Groups.................................................................................................................190 8.2.6 Subtables ....................................................................................................................190 8.3 Advanced Tables................................................................................................................193 8.3.1 Referencing Table Cells..............................................................................................193 8.3.2 Linked Tables..............................................................................................................195 8.3.3 Scenario Tables..........................................................................................................197 8.3.4 Shapes........................................................................................................................199 8.4 Advanced Table Cells .......................................................................................................200 8.4.1 Linked Table Cells.......................................................................................................200 8.4.2 Cell Annotation ...........................................................................................................201 8.4.3 Detective.....................................................................................................................201 8.4.4 Detective Operation....................................................................................................201 8.4.5 Highlighted Range.......................................................................................................202 8.5 Spreadsheet Document Content........................................................................................204 8.5.1 Document Protection..................................................................................................204 8.5.2 Calculation Settings....................................................................................................204 8.5.3 Table Cell Content Validations...................................................................................207 8.5.4 Label Ranges..............................................................................................................211 8.5.5 Named Expressions....................................................................................................212 8.6 Database Ranges...............................................................................................................214 8.6.1 Database Range .........................................................................................................215 8.6.2 Database Source SQL ...............................................................................................217 8.6.3 Database Source Table .............................................................................................218 8.6.4 Database Source Query..............................................................................................219 8.6.5 Sort .............................................................................................................................219 8.6.6 Sort By ........................................................................................................................221 8.6.7 Subtotal Rules ............................................................................................................222 8.6.8 Subtotal Sort Groups ..................................................................................................223 8.6.9 Subtotal Rule ..............................................................................................................224 8.6.10 Subtotal Field ...........................................................................................................224 8.7 Filters..................................................................................................................................225 8.7.1 Table Filter..................................................................................................................225 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 9 of 706 8.7.2 Filter And.....................................................................................................................227 8.7.3 Filter Or ......................................................................................................................227 8.7.4 Filter Condition ...........................................................................................................228 8.8 Data Pilot Tables................................................................................................................230 8.8.1 Data Pilot Table...........................................................................................................230 8.8.2 Source Cell Range......................................................................................................235 8.8.3 Source Service............................................................................................................235 8.8.4 Data Pilot Field............................................................................................................237 8.8.5 Data Pilot Level...........................................................................................................239 8.8.6 Data Pilot Subtotals.....................................................................................................240 8.8.7 Data Pilot Subtotal......................................................................................................240 8.8.8 Data Pilot Members.....................................................................................................241 8.8.9 Data Pilot Member......................................................................................................241 8.8.10 Data Pilot Display Info..............................................................................................242 8.8.11 Data Pilot Sort Info....................................................................................................243 8.8.12 Data Pilot Layout Info................................................................................................244 8.8.13 Data Pilot Field Reference........................................................................................245 8.8.14 Data Pilot Groups......................................................................................................246 8.8.15 Data Pilot Group........................................................................................................248 8.8.16 Data Pilot Group Member.........................................................................................249 8.9 Consolidation......................................................................................................................249 8.10 DDE Links.........................................................................................................................251 8.11 Change Tracking in Spreadsheets...................................................................................251 8.11.1 Tracked Changes......................................................................................................251 8.11.2 Insertion.....................................................................................................................252 8.11.3 Dependencies............................................................................................................253 8.11.4 Dependence..............................................................................................................254 8.11.5 Deletions....................................................................................................................254 8.11.6 Cell Content Deletion................................................................................................254 8.11.7 Change Deletion........................................................................................................254 8.11.8 Deletion.....................................................................................................................255 8.11.9 Cut Offs.....................................................................................................................256 8.11.10 Insertion Cut Off......................................................................................................257 8.11.11 Movement Cut Off..................................................................................................257 8.11.12 Movement...............................................................................................................258 8.11.13 Target Range Address, Source Range Address.....................................................259 8.11.14 Change Track Cell..................................................................................................260 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 10 of 706 8.11.15 Cell Content Change...............................................................................................261 8.11.16 Cell Address............................................................................................................262 8.11.17 Previous..................................................................................................................262 8.11.18 Common Change Tracking Attributes.................................................................... 262 9 Graphic Content.........................................................................................................................264 9.1 Enhanced Page Features for Graphical Applications........................................................264 9.1.1 Handout Master...........................................................................................................264 9.1.2 Layer Sets...................................................................................................................265 9.1.3 Layer............................................................................................................................266 9.1.4 Drawing Pages............................................................................................................266 9.1.5 Presentation Notes......................................................................................................269 9.2 Drawing Shapes..................................................................................................................270 9.2.1 Rectangle....................................................................................................................270 9.2.2 Line..............................................................................................................................271 9.2.3 Polyline........................................................................................................................272 9.2.4 Polygon........................................................................................................................273 9.2.5 Regular Polygon..........................................................................................................273 9.2.6 Path.............................................................................................................................275 9.2.7 Circle...........................................................................................................................276 9.2.8 Ellipse..........................................................................................................................277 9.2.9 Connector....................................................................................................................278 9.2.10 Caption......................................................................................................................281 9.2.11 Measure.....................................................................................................................282 9.2.12 Control.......................................................................................................................283 9.2.13 Page Thumbnail........................................................................................................284 9.2.14 Grouping....................................................................................................................285 9.2.15 Common Drawing Shape Attributes......................................................................... 285 9.2.16 Common Shape Attributes for Text and Spreadsheet Documents..........................289 9.2.17 Common Drawing Shape Content............................................................................291 9.2.18 Common Shape Attribute Groups.............................................................................291 9.2.19 Glue Points................................................................................................................292 9.2.20 Event Listeners.........................................................................................................293 9.3 Frames................................................................................................................................294 9.3.1 Text Box......................................................................................................................296 9.3.2 Image..........................................................................................................................298 9.3.3 Objects........................................................................................................................300 9.3.4 Applet..........................................................................................................................301 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 11 of 706 9.3.5 Plugins.........................................................................................................................303 9.3.6 Parameters..................................................................................................................304 9.3.7 Floating Frame............................................................................................................304 9.3.8 Contour........................................................................................................................305 9.3.9 Alternative Text...........................................................................................................306 9.3.10 Hyperlinks..................................................................................................................306 9.3.11 Client Side Image Maps............................................................................................308 9.4 3D Shapes..........................................................................................................................312 9.4.1 Scene..........................................................................................................................312 9.4.2 Light.............................................................................................................................316 9.4.3 Cube............................................................................................................................317 9.4.4 Sphere.........................................................................................................................317 9.4.5 Extrude........................................................................................................................318 9.4.6 Rotate..........................................................................................................................319 9.5 Custom Shape....................................................................................................................319 9.5.1 Enhanced Geometry...................................................................................................320 9.5.2 Enhanced Geometry - Extrusion Attributes................................................................323 9.5.3 Enhanced Geometry - Path Attributes........................................................................329 9.5.4 Enhanced Geometry - Text Path Attributes................................................................333 9.5.5 Enhanced Geometry – Equation.................................................................................334 9.5.6 Enhanced Geometry - Handle Attributes....................................................................336 9.6 Presentation Shapes..........................................................................................................340 9.6.1 Common Presentation Shape Attributes....................................................................340 9.7 Presentation Animations.....................................................................................................342 9.7.1 Sound..........................................................................................................................342 9.7.2 Show Shape................................................................................................................343 9.7.3 Show Text...................................................................................................................347 9.7.4 Hide Shape..................................................................................................................347 9.7.5 Hide Text.....................................................................................................................347 9.7.6 Dim..............................................................................................................................348 9.7.7 Play..............................................................................................................................348 9.7.8 Effect groups...............................................................................................................349 9.8 SMIL Presentation Animations...........................................................................................349 9.8.1 Recommended Usage Of SMIL..................................................................................349 9.8.2 Document Dependent SMIL Animation Attribute Values........................................... 350 9.8.3 SMIL Presentation Animation Attributes.....................................................................353 9.9 Presentation Events...........................................................................................................355 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 12 of 706 9.10 Presentation Text Fields...................................................................................................358 9.10.1 Header Field..............................................................................................................358 9.10.2 Footer Field...............................................................................................................358 9.10.3 Date and Time Field..................................................................................................359 9.11 Presentation Document Content......................................................................................359 9.11.1 Presentation Declarations.........................................................................................359 9.11.2 Header field declaration............................................................................................359 9.11.3 Footer field declaration.............................................................................................360 9.11.4 Date and Time field declaration................................................................................360 9.11.5 Presentation Settings................................................................................................361 9.11.6 Show Definitions.......................................................................................................365 10 Chart Content...........................................................................................................................366 10.1 Introduction to Chart Documents..................................................................................... 366 10.2 Chart.................................................................................................................................366 10.3 Title, Subtitle and Footer..................................................................................................370 10.3.1 Title............................................................................................................................370 10.3.2 Subtitle......................................................................................................................371 10.3.3 Footer........................................................................................................................371 10.4 Legend..............................................................................................................................371 10.5 Plot Area...........................................................................................................................373 10.5.1 3D Plot Area..............................................................................................................375 10.6 Wall...................................................................................................................................375 10.7 Floor..................................................................................................................................376 10.8 Axis...................................................................................................................................376 10.8.1 Grid............................................................................................................................378 10.9 Series................................................................................................................................379 10.9.1 Domain......................................................................................................................380 10.10 Categories.......................................................................................................................381 10.11 Data Point.......................................................................................................................381 10.12 Mean Value.....................................................................................................................382 10.13 Error Indicator.................................................................................................................382 10.14 Regression Curves.........................................................................................................383 10.14.1 Stock Chart Markers...............................................................................................383 11 Form Content...........................................................................................................................385 11.1 Form.................................................................................................................................386 11.1.1 Action........................................................................................................................387 11.1.2 Target Frame............................................................................................................387 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 13 of 706 11.1.3 Method.......................................................................................................................388 11.1.4 Encoding Type..........................................................................................................388 11.1.5 Allow Deletes.............................................................................................................388 11.1.6 Allow Inserts..............................................................................................................389 11.1.7 Allow Updates...........................................................................................................389 11.1.8 Apply Filter................................................................................................................389 11.1.9 Command Type.........................................................................................................389 11.1.10 Command................................................................................................................390 11.1.11 Data Source............................................................................................................390 11.1.12 Master Fields...........................................................................................................390 11.1.13 Detail Fields............................................................................................................390 11.1.14 Escape Processing..................................................................................................391 11.1.15 Filter........................................................................................................................391 11.1.16 Ignore Result...........................................................................................................391 11.1.17 Navigation Mode.....................................................................................................392 11.1.18 Order.......................................................................................................................392 11.1.19 Tabbing Cycle.........................................................................................................392 11.1.20 Connection Resource..............................................................................................393 11.2 XForms Model..................................................................................................................393 11.2.1 XForms Model...........................................................................................................393 11.3 Controls.............................................................................................................................394 11.3.1 Text...........................................................................................................................394 11.3.2 Text Area...................................................................................................................395 11.3.3 Password...................................................................................................................396 11.3.4 File.............................................................................................................................397 11.3.5 Formatted Text..........................................................................................................397 11.3.6 Number......................................................................................................................398 11.3.7 Date And Time..........................................................................................................400 11.3.8 Fixed Text.................................................................................................................401 11.3.9 Combo Box................................................................................................................402 11.3.10 List Box....................................................................................................................403 11.3.11 Button......................................................................................................................405 11.3.12 Image......................................................................................................................406 11.3.13 Check Box...............................................................................................................407 11.3.14 Radio Button............................................................................................................408 11.3.15 Frame......................................................................................................................409 11.3.16 Image Frame...........................................................................................................409 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 14 of 706 11.3.17 Hidden.....................................................................................................................410 11.3.18 Grid..........................................................................................................................410 11.3.19 Value Range............................................................................................................412 11.3.20 Generic Control.......................................................................................................414 11.4 Common Form and Control Attributes.............................................................................414 11.4.1 Name.........................................................................................................................414 11.4.2 Control Implementation.............................................................................................414 11.4.3 Bind to XForms.........................................................................................................414 11.5 Common Control Attributes..............................................................................................415 11.5.1 Button Type...............................................................................................................415 11.5.2 Control ID..................................................................................................................415 11.5.3 Current Selected.......................................................................................................416 11.5.4 Value and Current Value...........................................................................................416 11.5.5 Disabled.....................................................................................................................418 11.5.6 Dropdown..................................................................................................................418 11.5.7 For.............................................................................................................................419 11.5.8 Image Data................................................................................................................419 11.5.9 Label..........................................................................................................................419 11.5.10 Maximum Length....................................................................................................420 11.5.11 Printable..................................................................................................................420 11.5.12 Read only................................................................................................................421 11.5.13 Selected..................................................................................................................421 11.5.14 Size..........................................................................................................................422 11.5.15 Tab Index................................................................................................................422 11.5.16 Tab Stop..................................................................................................................423 11.5.17 Target Frame..........................................................................................................424 11.5.18 Target Location.......................................................................................................424 11.5.19 Title..........................................................................................................................424 11.5.20 Visual Effect............................................................................................................425 11.5.21 Relative Image Position..........................................................................................425 11.5.22 Database Binding Attributes................................................................................... 426 11.6 Events...............................................................................................................................428 11.6.1 Events with an Equivalent HTML Event Type..........................................................428 11.6.2 Event Types..............................................................................................................429 11.7 Properties..........................................................................................................................431 11.7.1 Property Set..............................................................................................................431 11.7.2 Property.....................................................................................................................431 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 15 of 706 11.7.3 List Property..............................................................................................................432 12 Common Content.....................................................................................................................435 12.1 Annotation.........................................................................................................................435 12.1.1 Creator.......................................................................................................................436 12.1.2 Creation Date and Time............................................................................................436 12.1.3 Creation Date and Time String.................................................................................436 12.2 Number Format................................................................................................................436 12.2.1 Prefix and Suffix.......................................................................................................436 12.2.2 Format Specification.................................................................................................437 12.2.3 Letter Synchronization in Number Formats..............................................................437 12.3 Change Tracking Metadata..............................................................................................438 12.4 Event Listener Tables.......................................................................................................438 12.4.1 Event Listener...........................................................................................................439 12.5 Mathematical Content......................................................................................................440 12.6 DDE Connections.............................................................................................................440 12.6.1 Container for DDE Connection Declarations............................................................441 12.6.2 Declaring DDE Connections for Text Fields.............................................................441 12.6.3 Declaring DDE Connections for Tables ...................................................................442 13 SMIL Animations......................................................................................................................445 13.1 Basic Animation Elements...............................................................................................445 13.1.1 Animate.....................................................................................................................445 13.1.2 Set.............................................................................................................................445 13.1.3 Animate Motion.........................................................................................................445 13.1.4 Animate Color...........................................................................................................446 13.1.5 Animate Transform...................................................................................................447 13.1.6 Transition Filter.........................................................................................................448 13.2 Animation Model Attributes..............................................................................................449 13.3 Common Animation Attributes.........................................................................................449 13.3.1 Animation Target Attributes......................................................................................450 13.3.2 Animation Function Attributes...................................................................................450 13.4 Animation Timing.............................................................................................................453 13.4.1 Animation Timing Attributes......................................................................................453 13.4.2 Parallel Animations...................................................................................................456 13.4.3 Sequential Animations..............................................................................................457 13.4.4 Iterative Animations..................................................................................................457 13.5 Media Elements................................................................................................................458 13.5.1 Audio.........................................................................................................................458 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 16 of 706 13.6 Special Elements..............................................................................................................459 13.6.1 Command..................................................................................................................459 14 Styles........................................................................................................................................460 14.1 Style Element...................................................................................................................460 14.1.1 Style Mappings..........................................................................................................464 14.2 Default Styles...................................................................................................................466 14.3 Page Layout......................................................................................................................466 14.3.1 Header and Footer Styles.........................................................................................467 14.4 Master Pages....................................................................................................................468 14.4.1 Headers and Footers.................................................................................................470 14.4.2 Presentation Notes....................................................................................................472 14.5 Table Templates...............................................................................................................473 14.5.1 Row and Column Styles............................................................................................475 14.6 Font Face Declaration......................................................................................................476 14.6.1 CSS2/SVG Font Descriptors.....................................................................................477 14.6.2 Name.........................................................................................................................480 14.6.3 Adornments...............................................................................................................481 14.6.4 Font Family Generic.................................................................................................481 14.6.5 Font Pitch..................................................................................................................481 14.6.6 Font Character Set....................................................................................................481 14.7 Data Styles.......................................................................................................................481 14.7.1 Number Style............................................................................................................482 14.7.2 Currency Style...........................................................................................................486 14.7.3 Percentage Style.......................................................................................................487 14.7.4 Date Style..................................................................................................................488 14.7.5 Time Style.................................................................................................................494 14.7.6 Boolean Style............................................................................................................497 14.7.7 Text Style..................................................................................................................498 14.7.8 Common Data Style Elements................................................................................. 498 14.7.9 Common Data Style Attributes.................................................................................499 14.7.10 Transliteration.........................................................................................................502 14.7.11 Common Data Style Child Element Attributes....................................................... 503 14.8 Text Styles........................................................................................................................505 14.8.1 Text Styles................................................................................................................505 14.8.2 Paragraph Styles.......................................................................................................505 14.8.3 Section Styles...........................................................................................................506 14.8.4 Ruby Style.................................................................................................................506 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 17 of 706 14.9 Enhanced Text Styles.......................................................................................................506 14.9.1 Line Numbering Configuration..................................................................................506 14.9.2 Notes Configuration Element....................................................................................510 14.9.3 Bibliography Configuration........................................................................................513 14.10 List Style.........................................................................................................................515 14.10.1 Common List-Level Style Attributes.......................................................................516 14.10.2 Number Level Style................................................................................................517 14.10.3 Bullet Level Style....................................................................................................518 14.10.4 Image Level Style...................................................................................................520 14.10.5 List Level Style Example........................................................................................520 14.11 Outline Style...................................................................................................................521 14.11.1 Outline Level Style..................................................................................................521 14.12 Table Styles....................................................................................................................523 14.12.1 Table Styles.............................................................................................................523 14.12.2 Table Column Styles...............................................................................................523 14.12.3 Table Row Styles....................................................................................................523 14.12.4 Table Cell Styles.....................................................................................................524 14.13 Graphic Styles................................................................................................................524 14.13.1 Graphic and Presentation Styles............................................................................524 14.13.2 Drawing Page Style.................................................................................................525 14.14 Enhanced Graphic Style Elements................................................................................526 14.14.1 Gradient...................................................................................................................526 14.14.2 SVG Gradients........................................................................................................529 14.14.3 Hatch.......................................................................................................................532 14.14.4 Fill Image.................................................................................................................533 14.14.5 Opacity Gradient.....................................................................................................535 14.14.6 Marker.....................................................................................................................535 14.14.7 Stroke Dash.............................................................................................................536 14.15 Presentation Page Layouts............................................................................................538 14.15.1 Presentation Placeholder........................................................................................538 14.16 Chart Styles....................................................................................................................539 15 Formatting Properties..............................................................................................................540 15.1 Simple and Complex Formatting Properties....................................................................540 15.1.1 Simple Formatting Properties...................................................................................540 15.1.2 Complex Formatting Properties................................................................................541 15.1.3 Processing Rules for Formatting Properties.............................................................541 15.2 Page Layout Formatting Properties.................................................................................541 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 18 of 706 15.2.1 Page Size..................................................................................................................542 15.2.2 Page Number Format...............................................................................................542 15.2.3 Paper Tray.................................................................................................................543 15.2.4 Print Orientation........................................................................................................543 15.2.5 Margins......................................................................................................................543 15.2.6 Border........................................................................................................................544 15.2.7 Border Line Width.....................................................................................................544 15.2.8 Padding.....................................................................................................................544 15.2.9 Shadow......................................................................................................................544 15.2.10 Background.............................................................................................................544 15.2.11 Columns..................................................................................................................545 15.2.12 Register-truth...........................................................................................................545 15.2.13 Print.........................................................................................................................545 15.2.14 Print Page Order.....................................................................................................546 15.2.15 First Page Number..................................................................................................546 15.2.16 Scale........................................................................................................................546 15.2.17 Table Centering.......................................................................................................547 15.2.18 Maximum Footnote Height..................................................................................... 547 15.2.19 Writing Mode...........................................................................................................547 15.2.20 Footnote Separator.................................................................................................548 15.2.21 Layout Grid..............................................................................................................549 15.2.22 Layout Grid Base Height.........................................................................................549 15.2.23 Layout Grid Ruby Height.........................................................................................550 15.2.24 Layout Grid Lines....................................................................................................550 15.2.25 Layout Grid Color....................................................................................................550 15.2.26 Layout Grid Ruby Below.........................................................................................550 15.2.27 Layout Grid Print.....................................................................................................550 15.2.28 Layout Grid Display.................................................................................................551 15.3 Header Footer Formatting Properties..............................................................................551 15.3.1 Fixed and Minimum heights......................................................................................551 15.3.2 Margins......................................................................................................................552 15.3.3 Border........................................................................................................................552 15.3.4 Border Line Width.....................................................................................................552 15.3.5 Padding.....................................................................................................................552 15.3.6 Background...............................................................................................................553 15.3.7 Shadow......................................................................................................................553 15.3.8 Dynamic Spacing......................................................................................................553 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 19 of 706 15.4 Text Formatting Properties...............................................................................................553 15.4.1 Font Variant...............................................................................................................554 15.4.2 Text Transformations................................................................................................554 15.4.3 Color..........................................................................................................................554 15.4.4 Window Font Color...................................................................................................555 15.4.5 Text Outline...............................................................................................................555 15.4.6 Line Through Type....................................................................................................555 15.4.7 Line Through Style....................................................................................................555 15.4.8 Line Through Width...................................................................................................556 15.4.9 Line Through Color...................................................................................................556 15.4.10 Line Through Text...................................................................................................556 15.4.11 Line Through Text Style..........................................................................................557 15.4.12 Text Position...........................................................................................................557 15.4.13 Font Name...............................................................................................................557 15.4.14 Font Family.............................................................................................................558 15.4.15 Font Family Generic...............................................................................................558 15.4.16 Font Style................................................................................................................559 15.4.17 Font Pitch................................................................................................................560 15.4.18 Font Character Set..................................................................................................560 15.4.19 Font Size.................................................................................................................561 15.4.20 Relative Font Size...................................................................................................561 15.4.21 Script Type..............................................................................................................562 15.4.22 Letter Spacing.........................................................................................................562 15.4.23 Language.................................................................................................................563 15.4.24 Country....................................................................................................................563 15.4.25 Font Style................................................................................................................564 15.4.26 Font Relief...............................................................................................................564 15.4.27 Text Shadow...........................................................................................................564 15.4.28 Underlining Type.....................................................................................................565 15.4.29 Underlining Style.....................................................................................................565 15.4.30 Underling Width......................................................................................................566 15.4.31 Underline Color.......................................................................................................566 15.4.32 Font Weight.............................................................................................................566 15.4.33 Text Underline Word Mode.....................................................................................567 15.4.34 Text Line Through Word Mode...............................................................................567 15.4.35 Letter Kerning..........................................................................................................568 15.4.36 Text Blinking...........................................................................................................568 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 20 of 706 15.4.37 Text Background Color...........................................................................................568 15.4.38 Text Combine..........................................................................................................568 15.4.39 Text Combine Start and End Characters................................................................569 15.4.40 Text Emphasis........................................................................................................569 15.4.41 Text Scale...............................................................................................................570 15.4.42 Text Rotation Angle................................................................................................570 15.4.43 Text Rotation Scale.................................................................................................570 15.4.44 Hyphenation............................................................................................................570 15.4.45 Hyphenation Remain Char Count...........................................................................571 15.4.46 Hyphenation Push Char Count...............................................................................571 15.4.47 Hidden or Conditional Text.....................................................................................571 15.5 Paragraph Formatting Properties.....................................................................................572 15.5.1 Fixed Line Height......................................................................................................572 15.5.2 Minimum Line Height................................................................................................572 15.5.3 Line Distance.............................................................................................................573 15.5.4 Font-Independent Line Spacing................................................................................573 15.5.5 Text Align..................................................................................................................573 15.5.6 Text Align of Last Line..............................................................................................574 15.5.7 Justify Single Word...................................................................................................574 15.5.8 Keep Together...........................................................................................................574 15.5.9 Widows......................................................................................................................575 15.5.10 Orphans...................................................................................................................575 15.5.11 Tab Stops................................................................................................................575 15.5.12 Tab Stop Distance...................................................................................................578 15.5.13 Hyphenation Keep...................................................................................................579 15.5.14 Maximum Hyphens.................................................................................................579 15.5.15 Drop Caps...............................................................................................................579 15.5.16 Register True ..........................................................................................................581 15.5.17 Left and Right Margins............................................................................................581 15.5.18 Text Indent..............................................................................................................581 15.5.19 Automatic Text Indent.............................................................................................582 15.5.20 Top and Bottom Margins.........................................................................................582 15.5.21 Margins....................................................................................................................583 15.5.22 Break Before and Break After.................................................................................583 15.5.23 Paragraph Background Color..................................................................................584 15.5.24 Paragraph Background Image................................................................................584 15.5.25 Border......................................................................................................................586 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 21 of 706 15.5.26 Border Line Width...................................................................................................587 15.5.27 Padding...................................................................................................................588 15.5.28 Shadow....................................................................................................................589 15.5.29 Keep with Next........................................................................................................589 15.5.30 Line Numbering.......................................................................................................589 15.5.31 Line Number Start Value.........................................................................................590 15.5.32 Text Autospace.......................................................................................................590 15.5.33 Punctuation Wrap...................................................................................................590 15.5.34 Line Break...............................................................................................................590 15.5.35 Vertical Alignment...................................................................................................591 15.5.36 Writing Mode...........................................................................................................591 15.5.37 Automatic Writing Mode.........................................................................................592 15.5.38 Snap To Layout.......................................................................................................592 15.5.39 Page Number..........................................................................................................592 15.5.40 Background Transparency......................................................................................593 15.6 Ruby Text Formatting Properties.....................................................................................593 15.6.1 Ruby Position............................................................................................................593 15.6.2 Ruby Alignment.........................................................................................................593 15.7 Section Formatting Properties..........................................................................................594 15.7.1 Section Background..................................................................................................594 15.7.2 Margins......................................................................................................................594 15.7.3 Columns....................................................................................................................594 15.7.4 Column Specification................................................................................................595 15.7.5 Column Separator.....................................................................................................597 15.7.6 Protect.......................................................................................................................598 15.7.7 Don't Balance Text Columns....................................................................................599 15.7.8 Writing Mode.............................................................................................................599 15.7.9 Notes Configuration..................................................................................................599 15.8 Table Formatting Properties.............................................................................................599 15.8.1 Table Width...............................................................................................................599 15.8.2 Table Alignment........................................................................................................600 15.8.3 Table Left and Right Margin.....................................................................................600 15.8.4 Table Top and Bottom Margin..................................................................................601 15.8.5 Table Margins............................................................................................................601 15.8.6 Page Number............................................................................................................601 15.8.7 Break Before and Break After...................................................................................601 15.8.8 Table Background and Background Image.............................................................. 601 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 22 of 706 15.8.9 Table Shadow...........................................................................................................602 15.8.10 Keep with Next........................................................................................................602 15.8.11 May Break Between Rows......................................................................................602 15.8.12 Border Model Property............................................................................................602 15.8.13 Writing Mode...........................................................................................................603 15.8.14 Display.....................................................................................................................603 15.9 Column Formatting Properties.........................................................................................603 15.9.1 Column Width...........................................................................................................603 15.9.2 Optimal Table Column Width...................................................................................604 15.9.3 Break Before and Break After...................................................................................604 15.10 Table Row Formatting Properties..................................................................................604 15.10.1 Row Height..............................................................................................................605 15.10.2 Optimal Table Row Height......................................................................................605 15.10.3 Row Background.....................................................................................................605 15.10.4 Break Before and Break After.................................................................................605 15.10.5 Keep Together.........................................................................................................606 15.11 Table Cell Formatting Properties...................................................................................606 15.11.1 Vertical Alignment...................................................................................................606 15.11.2 Text Align Source....................................................................................................607 15.11.3 Direction..................................................................................................................607 15.11.4 Vertical Glyph Orientation.......................................................................................607 15.11.5 Cell Shadow............................................................................................................607 15.11.6 Cell Background......................................................................................................608 15.11.7 Cell Border..............................................................................................................608 15.11.8 Diagonal Lines.........................................................................................................608 15.11.9 Border Line Width...................................................................................................609 15.11.10 Padding.................................................................................................................609 15.11.11 Wrap Option..........................................................................................................609 15.11.12 Rotation Angle.......................................................................................................609 15.11.13 Rotation Align........................................................................................................610 15.11.14 Cell Protect............................................................................................................610 15.11.15 Print Content.........................................................................................................610 15.11.16 Decimal places......................................................................................................611 15.11.17 Repeat Content.....................................................................................................611 15.11.18 Shrink To Fit..........................................................................................................611 15.12 List-Level Style Properties.............................................................................................611 15.13 Stroke Properties............................................................................................................614 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 23 of 706 15.13.1 Stroke Style.............................................................................................................614 15.13.2 Dash........................................................................................................................614 15.13.3 Multiple Dashes.......................................................................................................615 15.13.4 Width.......................................................................................................................615 15.13.5 Color........................................................................................................................615 15.13.6 Start Marker.............................................................................................................615 15.13.7 End Marker..............................................................................................................615 15.13.8 Start Marker Width..................................................................................................616 15.13.9 End Marker Width...................................................................................................616 15.13.10 Start Marker Center...............................................................................................616 15.13.11 End Marker Center................................................................................................616 15.13.12 Opacity..................................................................................................................617 15.13.13 Line Join................................................................................................................617 15.14 Fill Properties..................................................................................................................617 15.14.1 Fill Style...................................................................................................................618 15.14.2 Color........................................................................................................................618 15.14.3 Secondary Fill Color................................................................................................618 15.14.4 Gradient...................................................................................................................619 15.14.5 Gradient Step Count...............................................................................................619 15.14.6 Hatch.......................................................................................................................619 15.14.7 Solid Hatch..............................................................................................................619 15.14.8 Fill Image.................................................................................................................620 15.14.9 Fill Image Rendering Style..................................................................................... 620 15.14.10 Fill Image Size......................................................................................................620 15.14.11 Fill Image Tile Reference Point............................................................................621 15.14.12 Fill Image Tile Translation....................................................................................621 15.14.13 None and Linear Opacity......................................................................................622 15.14.14 Gradient Opacity...................................................................................................622 15.14.15 Fill Rule.................................................................................................................622 15.14.16 Symbol color.........................................................................................................622 15.15 Text Animation Properties..............................................................................................623 15.15.1 Animation................................................................................................................623 15.15.2 Animation Direction.................................................................................................623 15.15.3 Animation Start Inside.............................................................................................624 15.15.4 Animation Stop Inside.............................................................................................624 15.15.5 Animation Repeat....................................................................................................624 15.15.6 Animation Delay......................................................................................................624 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 24 of 706 15.15.7 Animation Steps......................................................................................................625 15.16 Text and Text Alignment Properties.............................................................................. 625 15.16.1 Auto Grow Width and Height..................................................................................625 15.16.2 Fit To Size...............................................................................................................625 15.16.3 Fit To Contour.........................................................................................................625 15.16.4 Text Area Vertical Align..........................................................................................626 15.16.5 Text Area Horizontal Align......................................................................................626 15.16.6 Word Wrap..............................................................................................................626 15.16.7 List Styles................................................................................................................627 15.17 Color Properties..............................................................................................................627 15.17.1 Color Mode .............................................................................................................627 15.17.2 Color Inversion........................................................................................................627 15.17.3 Adjust Luminance....................................................................................................628 15.17.4 Adjust Contrast........................................................................................................628 15.17.5 Adjust Gamma........................................................................................................628 15.17.6 Adjust Red...............................................................................................................628 15.17.7 Adjust Green...........................................................................................................628 15.17.8 Adjust Blue..............................................................................................................629 15.17.9 Adjust Opacity.........................................................................................................629 15.18 Shadow Properties.........................................................................................................629 15.18.1 Shadow....................................................................................................................629 15.18.2 Offset.......................................................................................................................629 15.18.3 Color........................................................................................................................630 15.18.4 Opacity....................................................................................................................630 15.19 Connector Properties......................................................................................................630 15.19.1 Start Line Spacing...................................................................................................630 15.19.2 End Line Spacing....................................................................................................631 15.20 Measure Properties........................................................................................................631 15.20.1 Line Distance...........................................................................................................631 15.20.2 Guide Overhang......................................................................................................631 15.20.3 Guide Distance........................................................................................................632 15.20.4 Start Guide..............................................................................................................632 15.20.5 End Guide...............................................................................................................632 15.20.6 Placing.....................................................................................................................632 15.20.7 Parallel....................................................................................................................633 15.20.8 Text Alignment........................................................................................................633 15.20.9 Unit..........................................................................................................................633 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 25 of 706 15.20.10 Show Unit..............................................................................................................634 15.20.11 Decimal Places.....................................................................................................634 15.21 Caption Properties..........................................................................................................634 15.21.1 Type.........................................................................................................................634 15.21.2 Angle Type..............................................................................................................635 15.21.3 Angle.......................................................................................................................635 15.21.4 Gap..........................................................................................................................635 15.21.5 Escape Direction.....................................................................................................635 15.21.6 Escape.....................................................................................................................636 15.21.7 Line Length..............................................................................................................636 15.21.8 Fit Line Length........................................................................................................636 15.22 3D Geometry Properties.................................................................................................636 15.22.1 Horizontal Segments...............................................................................................637 15.22.2 Vertical Segments...................................................................................................637 15.22.3 Edge Rounding........................................................................................................637 15.22.4 Edge Rounding Mode..............................................................................................637 15.22.5 Back Scale..............................................................................................................638 15.22.6 Depth.......................................................................................................................638 15.22.7 Backface Culling.....................................................................................................638 15.22.8 End Angle................................................................................................................638 15.22.9 Close Front..............................................................................................................639 15.22.10 Close Back............................................................................................................639 15.23 3D Lighting Properties....................................................................................................639 15.23.1 Mode........................................................................................................................639 15.23.2 Normals Kind...........................................................................................................639 15.23.3 Normals Direction....................................................................................................640 15.24 3D Texture Properties....................................................................................................640 15.24.1 Generation Mode.....................................................................................................640 15.24.2 Kind.........................................................................................................................641 15.24.3 Filter........................................................................................................................641 15.24.4 Mode........................................................................................................................641 15.25 3D Material Properties....................................................................................................641 15.25.1 Colors......................................................................................................................642 15.25.2 Shininess.................................................................................................................642 15.26 3D Shadow Properties....................................................................................................642 15.26.1 Shadow....................................................................................................................642 15.27 Frame Formatting Properties.........................................................................................643 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 26 of 706 15.27.1 Frame Widths..........................................................................................................643 15.27.2 Frame Heights.........................................................................................................643 15.27.3 Maximum Width and Height...................................................................................643 15.27.4 Left and Right Margins............................................................................................644 15.27.5 Top and Bottom Margins.........................................................................................644 15.27.6 Margins....................................................................................................................644 15.27.7 Print Content...........................................................................................................644 15.27.8 Protect.....................................................................................................................645 15.27.9 Horizontal Position..................................................................................................645 15.27.10 Horizontal Relation................................................................................................646 15.27.11 Vertical Position....................................................................................................647 15.27.12 Vertical Relation....................................................................................................648 15.27.13 Frame Anchor.......................................................................................................649 15.27.14 Border....................................................................................................................649 15.27.15 Border Line Width.................................................................................................649 15.27.16 Padding.................................................................................................................649 15.27.17 Shadow..................................................................................................................650 15.27.18 Background...........................................................................................................650 15.27.19 Columns................................................................................................................650 15.27.20 Editable.................................................................................................................650 15.27.21 Wrapping...............................................................................................................650 15.27.22 Dynamic Wrap Threshold.....................................................................................651 15.27.23 Paragraph-only Wrapping.....................................................................................651 15.27.24 Contour Wrapping.................................................................................................652 15.27.25 Contour Wrapping Mode.......................................................................................652 15.27.26 Run Through.........................................................................................................652 15.27.27 Flow with Text.......................................................................................................653 15.27.28 Overflow behavior.................................................................................................653 15.27.29 Mirroring................................................................................................................653 15.27.30 Clipping.................................................................................................................654 15.27.31 Wrap Influence on Position...................................................................................654 15.28 Floating Frame Formatting Properties...........................................................................655 15.28.1 Display Scrollbar.....................................................................................................655 15.28.2 Display Border.........................................................................................................655 15.28.3 Margins....................................................................................................................656 15.28.4 Object Formatting Properties..................................................................................656 15.28.5 Visible Area.............................................................................................................656 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 27 of 706 15.28.6 Draw Aspect............................................................................................................657 15.29 Chart Formatting Properties...........................................................................................657 15.29.1 Scale Text...............................................................................................................658 15.30 Chart Subtype Properties...............................................................................................658 15.30.1 Three-dimensional Charts.......................................................................................658 15.30.2 Chart Depth.............................................................................................................658 15.30.3 Chart Symbol..........................................................................................................658 15.30.4 Chart Symbol Size..................................................................................................659 15.30.5 Bar Chart Properties...............................................................................................659 15.30.6 Stock Chart Properties............................................................................................660 15.30.7 Line Chart Properties..............................................................................................661 15.30.8 Pie Chart Properties................................................................................................661 15.30.9 Lines........................................................................................................................661 15.30.10 Solid Charts Bars..................................................................................................662 15.30.11 Stacked Chart Bars...............................................................................................662 15.31 Chart Axes Properties....................................................................................................662 15.31.1 Linked Data Formats...............................................................................................662 15.31.2 Visibility...................................................................................................................663 15.31.3 Scaling.....................................................................................................................663 15.31.4 Tickmarks................................................................................................................664 15.31.5 Labels......................................................................................................................664 15.32 Common Chart Properties..............................................................................................665 15.32.1 Stacked Text...........................................................................................................665 15.32.2 Rotation Angle.........................................................................................................665 15.32.3 Data Labels.............................................................................................................666 15.33 Statistical Properties.......................................................................................................667 15.33.1 Mean Value.............................................................................................................667 15.33.2 Error Category.........................................................................................................667 15.34 Plot Area Properties.......................................................................................................669 15.34.1 Series Source..........................................................................................................669 15.35 Regression Curve Properties.........................................................................................669 15.35.1 Regression Type.....................................................................................................669 15.36 Presentation Page Attributes..........................................................................................670 15.36.1 Transition Type.......................................................................................................670 15.36.2 Transition Style.......................................................................................................671 15.36.3 Transition Speed.....................................................................................................673 15.36.4 Transition Type or Family.......................................................................................673 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 28 of 706 15.36.5 Transition Subtype..................................................................................................673 15.36.6 Transition Direction.................................................................................................674 15.36.7 Fade Color...............................................................................................................674 15.36.8 Page Duration.........................................................................................................674 15.36.9 Page Visibility..........................................................................................................674 15.36.10 Sound....................................................................................................................675 15.36.11 Background Size...................................................................................................675 15.36.12 Background Objects Visible..................................................................................675 15.36.13 Background Visible...............................................................................................675 15.36.14 Display Header......................................................................................................676 15.36.15 Display Footer.......................................................................................................676 15.36.16 Display Page Number...........................................................................................676 15.36.17 Display Date And Time.........................................................................................676 16 Data Types and Schema Definitions.......................................................................................677 16.1 Data Types........................................................................................................................677 16.2 Other Definitions...............................................................................................................682 16.3 Relax-NG Schema Suffix.................................................................................................683 17 Packages..................................................................................................................................684 17.1 Introduction.......................................................................................................................684 17.2 Zip File Structure..............................................................................................................684 17.3 Encryption.........................................................................................................................685 17.4 MIME Type Stream..........................................................................................................685 17.5 Usage of URIs Within Packages......................................................................................686 17.6 Preview Image..................................................................................................................686 17.7 Manifest File.....................................................................................................................687 17.7.1 Relax-NG Schema....................................................................................................687 17.7.2 Manifest Root Element..............................................................................................687 17.7.3 File Entry...................................................................................................................687 17.7.4 Encryption Data.........................................................................................................689 17.7.5 Algorithm...................................................................................................................689 17.7.6 Key Derivation...........................................................................................................690 17.7.7 Relax-NG Schema Suffix..........................................................................................692 Appendix A. Strict Relax NG Schema..........................................................................................693 Appendix B. References...............................................................................................................695 Appendix C. MIME Types and File Name Extensions (Non Normative)..................................... 697 Appendix D. Core Features Sets (Non Normative)......................................................................699 Appendix E. Changes From Previous Specification Versions (Non Normative)......................... 704 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 29 of 706 E.1. Changes from “Open Office Specification 1.0 Committee Draft 1”......................................704 E.2. Changes from “Open Document Format for Office Applications (OpenDocument) 1.0 Committee Draft 2”.......................................................................................................................704 Appendix F. Notices......................................................................................................................706 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 30 of 706 1 Introduction 1.1 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 an 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 an 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. 1.2 Notation Within this specification, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT ", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC2119] if they appear in uppercase bold letters. 1.3 Namespaces Table 1 lists the namespaces that are defined by the OpenDocument format and their default prefixes. For more information about XML namespaces, please refer to the Namespaces in XML specification [xml-names]. Table 1: XML Namespaces defined by the OpenDocument schema Prefix Description Namespace office For all common pieces of information urn:oasis:names:tc:opendocument:xmlns: that are not contained in another, office:1.0 more specific namespace. 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 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 31 of 706 Prefix Description Namespace text For elements and attributes that may urn:oasis:names:tc:opendocument:xmlns: occur within text documents and text text:1.0 parts of other document types, such as the contents of a spreadsheet cell. 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 2lists 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 fo Description For attributes that are compatible to attributes defined in [XSL]. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. Namespace urn:oasis:names:tc:opendocument:xmlns: xsl-fo-compatible:1.0 1 May 2005 Page 32 of 706 Prefix Description Namespace 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 1.4 Relax-NG Schema The normative XML Schema for the OpenDocument format is embedded within this specification. It can be obtained from the specification document by concatenating all schema fragments contained in chapters 1 to 16. All schema fragments have a gray background color and line numbers. The schema language used within this specification is Relax-NG (see [RNG]). The 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: 1 2 3 4 5 12 13 14 15 1.5 Document Processing and Conformance Documents that conform to the OpenDocument specification MAY contain elements and attributes not specified within the OpenDocument schema. Such elements and attributes must not be part of a namespace that is defined within this specification and are called foreign elements and attributes. Conforming applications either MUST read documents that are valid against the OpenDocument schema if all foreign elements and attributes are removed before validation takes place, or MUST 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 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 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 MUST be valid against the OpenDocument schema if the unknown element is replaced with its content only. Conforming applications MUST read documents containing processing instructions and SHOULD preserve them. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 34 of 706 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 by the OpenDocument schema. See also appendix D. 43 44 45 46 47 48 49 1.6 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 . The same applies to the HORIZONTAL TABULATION and LINE FEED characters if they are contained in an attribute value. 1.7 MIME Types and File Name Extensions Appendix C contains a list of MIME types and file name extensions to be used for office documents that conform to this specification and that are contained in a package (see section 2.1). This MIME types and extensions either have been registered following the procedures described in [RFC2048], or a registration is in progress. For office documents that conform to this specification but are not contained in a package, it is RECOMMENDED to use the MIME type text/xml. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 35 of 706 It is RECOMMENDED that only MIME types and extensions that have been registered according to [RFC2048] are used for office documents that conform to this specification. It is also RECOMMENDED that the MIME types and extensions listed in appendix C are used where appropriate. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 36 of 706 2 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. 2.1 Document Roots A document root element is the primary element of a document in OpenDocument format. It contains the entire document. All types of documents, for example, text documents, spreadsheets, and drawing documents use the same types of document root elements. The OpenDocument format supports the following two ways of document representation: • As a single XML document. • As a collection of several subdocuments within a package (see section 17), each of which stores part of the complete document. Each subdocument has a different document root 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 Complete office document in a single n/a XML document. Document content and automatic styles used in the content. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. content.xml 1 May 2005 Page 37 of 706 Root Element Subdocument Content Subdoc. Name in Package Styles used in the document content and automatic styles used in the styles themselves. Document meta information, such as meta.xml the author or the time of the last save action. styles.xml Application-specific settings, such as settings.xml the window size or printer information. The definitions of the root elements described in the table above are analogous to the definition of , except that the child element specification is suitably restricted. 50 51 52 53 54 55 56 57 58 2.1.1 Document Root Element Content Models The content models of the five root elements is summarized in the following table. Note that 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 app. script font style data sett. decls         auto style  mast body style          The root contains a complete document: 59 60 61 62 63 64 65 66 67 68 69 70 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 38 of 706 71 72 The root contains only the document content, along with the automatic styles needed for the document content: 73 74 75 76 77 78 79 80 81 The root contains all named styles of a document, along with the automatic styles needed for the named styles: 82 83 84 85 86 87 88 89 90 The root contains the meta information about a document. 91 92 93 94 95 96 The root contains application specific settings to be applied when processing this document. 97 98 99 100 101 102 2.1.2 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's optional to validate the document, but the document must be well formed. 103 104 105 106 107 108 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 39 of 706 109 MIME Type The 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). 110 111 112 113 114 2.2 Document Metadata Metadata is general information about a document. In the OpenDocument format, all of the metadata elements are contained in an element, usually located at start of the document. Metadata elements may be omitted or occur multiple times. It is application-specific how to update multiple instances of the same elements. 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 2.2.1 Pre-Defined vs. Custom Metadata In the OpenDocument schema the metadata is comprised of pre-defined metadata elements, user defined metadata, as well as custom metadata elements. The pre-defined metadata elements have defined semantics. They SHOULD be processed and updated by editing applications. They can be referenced from within the document through the use of suitable text fields. User-defined metadata is a more generic mechanism which specifies a triplet of name, type, 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 . 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 40 of 706 2.2.2 Sample Metadata Example: Sample metadata of a document in OpenDocument format Title of the document Description/Comment for the document User Name 1999-10-18T12:34:56 User Name 1999-10-19T15:16:17 User Name 1999-10-20T16:17:18 Description of the document PT5H10M10S First keyword Second keyword Third keyword de-DE Value 1 1.234 2.3 Body Element and Document Types The document body contains an element to indicate which type of content this document contains. Currently supported document types are: • text documents • drawing documents • presentation documents • spreadsheet documents • chart documents • image documents All document types share the same content elements, but different document types place different restrictions on which elements may occur, and in what combinations. The document content is typically framed by a prelude and epilogue, which contain additional information for a specific type of document, like form data or variable declarations. 132 133 134 135 136 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 41 of 706 2.3.1 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. 137 138 139 140 141 142 143 144 145 146 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. 147 148 149 150 151 152 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. 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 42 of 706 177 178 179 180 181 182 183 184 185 186 187 188 189 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. 190 191 192 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. 193 194 195 196 197 198 199 2.3.2 Drawing Documents The content of drawing document consists of a sequence of draw pages. 200 201 202 203 204 205 206 207 208 209 210 211 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 43 of 706 212 213 214 215 The main document content contains a sequence of draw pages. 216 217 218 219 220 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. 221 222 223 2.3.3 Presentation Documents The content of presentation document consists of a sequence of draw pages. 224 225 226 227 228 229 230 231 232 233 234 235 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. 236 237 238 239 240 The main document content contains a sequence of draw pages. 241 242 243 244 245 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. 246 247 248 249 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 44 of 706 2.3.4 Spreadsheet Documents The content of spreadsheet documents mainly consists of a sequence of tables. Additionally, a spreadsheet document may contain forms, change tracking information and various kinds 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. 250 251 252 253 254 255 256 257 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. 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 The main document is a list of tables. 277 278 279 280 281 The epilogue of spreadsheet documents contains declarations for named expressions, database ranges, data pilot tables, consolidation operations and DDE links. 282 283 284 285 286 287 288 289 290 291 292 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 45 of 706 293 294 295 296 297 298 299 300 301 302 2.3.5 Chart Documents The content of chart documents mainly consists of a chart element. 303 304 305 306 307 308 309 310 311 312 313 314 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. 315 316 317 318 The main document is a chart element only. 319 320 321 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. 322 323 324 2.3.6 Image Documents The content of an image document is a frame element only. The frame element must contain a single image element. 325 326 327 328 329 330 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 46 of 706 331 332 333 334 335 336 Image Document Content Model The image document prelude is empty. 337 338 339 The main document content contains a frame only. 340 341 342 There are no image documents specific epilogue elements. 343 344 345 2.4 Application Settings Application settings are contained in a element. 346 347 348 349 350 351 352 353 354 The settings for office applications may be divided into several categories each represented by a element. For instance the following two categories may exist: • Document settings, for example default printer. • View settings, for example zoom level. 2.4.1 Sequence of Settings The element is a container element for all types of setting elements. The settings can be contained in the element is any order. 355 356 357 358 359 360 361 362 363 364 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 47 of 706 365 366 367 368 369 370 371 Config Name The config:name attribute identifies the name of the setting container. For top level elements, that are elements that are direct children of the element, the name should be preceded by a namespace prefix that identifies the application the settings belong to. 372 373 374 375 376 Example: 0 2.4.2 Base Settings The element contains all base settings. The value of the setting is stored in the element. 377 378 379 380 381 382 Config Name The config:name attribute identifies the name of the setting. 383 384 385 386 387 Config Type The config:type attribute identifies the data type of setting. 388 389 390 391 boolean OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 48 of 706 392 393 394 395 396 397 398 399 400 401 short int long double string datetime base64Binary 2.4.3 Index Access of Sequences The element is a container element for sequences. The order specifies the index of the elements 402 403 404 405 406 407 408 409 Config Name The config:name attribute identifies the name of the setting sequence. 410 411 412 413 414 2.4.4 Map Entry The element represents an entry in an indexed or named settings sequence. It is a container element for all types of setting elements. 415 416 417 418 419 420 Config Name The config:name attribute identifies the name of the setting sequence. 421 422 423 424 425 426 427 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 49 of 706 2.4.5 Name Access of Sequences The element is a container element for sequences, where each setting in the sequence is identified by its name. 428 429 430 431 432 433 434 435 Config Name The config:name attribute identifies the name of the setting sequence. 436 437 438 439 440 2.4.6 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, MUST 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 MUST 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 This is an example. 2.5 Scripts A document may contain several scripts in different scripting languages. Each script is represented by a element. All these script elements are contained in a single element. Scripts do not imply a scripting language or an object model. A script can operate on the Document Object Model (DOM) of a document in OpenDocument format or on an application specific API. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 50 of 706 Scripts cannot modify a document while the document is loading. However, some events are called immediately after the document is loaded. In addition to elements, the element may also contain an 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 element. 441 442 443 444 445 446 447 448 449 450 451 452 2.5.1 Script The 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. 453 454 455 456 457 458 459 460 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. 461 462 463 464 465 2.6 Font Face Declarations A document in OpenDocument format may contain font face declarations. A font face declaration provides information about the fonts used by the author of a document, so that these fonts or fonts that are very close to these fonts may be located on other systems. See section 14.6 for details. 466 467 468 469 470 471 472 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 51 of 706 473 474 2.7 Styles The OpenDocument format supports the following types of styles: • Common styles Most office applications support styles within their user interface. Within this specification, 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 styles An 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 styles A master style is a common style that contains formatting information and additional content that is displayed with the document content when the style is applied. An example of a 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 an 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. 2.7.1 Location of Styles Common and automatic styles have the same XML representation, but they are contained within two distinct container elements, as follows: • for common styles • for automatic styles • Master styles are contained within a container element of its own: • OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 52 of 706 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 53 of 706 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 The following examples illustrate the different types of OpenDocument styles. Example: OpenDocument styles ... ... ... OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 54 of 706 2.8 Page Styles and Layout The style and layout of the pages in a document is determined by: • Page Layouts • Master Pages A page layout describes the physical properties or geometry of a page, for example, page size, margins, header height, and footer height. A master page is a template for pages in a document. It contains a reference to a page layout which specifies the physical properties of the page and can also contain static content that 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 55 of 706 3 Meta Data Elements The metadata elements borrow heavily upon the metadata standards developed by the Dublin Core Metadata Initiative (http://www.dublincore.org). Metadata elements drawn directly from the Dublin Core work use its namespace prefix (see section 1.3). 3.1 Pre-Defined Metadata Elements There is a set of pre-defined metadata elements which should be processed and updated by the applications. Metadata elements may be omitted or occur multiple times. It is application-specific how to update multiple instances of the same elements. 3.1.1 Generator The 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 MUST 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 MUST NOT export the original identifier belonging to the application that created the document. 587 588 589 590 591 3.1.2 Title The element specifies the title of the document. 592 593 594 595 596 3.1.3 Description The element contains a brief description of the document. 597 598 599 600 601 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 56 of 706 3.1.4 Subject The element specifies the subject of the document. 602 603 604 605 606 3.1.5 Keywords The element contains a keyword pertaining to the document. The metadata can contain any number of elements, each element specifying one keyword. 607 608 609 610 611 3.1.6 Initial Creator The element specifies the name of the person who created the document initially. 612 613 614 615 616 3.1.7 Creator The 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. 617 618 619 620 621 622 623 624 3.1.8 Printed By The element specifies the name of the last person who printed the document. 625 626 627 628 629 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 57 of 706 3.1.9 Creation Date and Time The 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. 630 631 632 633 634 3.1.10 Modification Date and Time The 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. 635 636 637 638 639 640 641 642 3.1.11 Print Date and Time The 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. 643 644 645 646 647 3.1.12 Document Template The 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 element are: • Template location • Template title • Template modification date and time OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 58 of 706 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. 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 simple onRequest 3.1.13 Automatic Reload The 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 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 element is presented as an XLink. An xlink:href attribute identifies the URL of the replacement document. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 59 of 706 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. 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 simple replace onLoad 3.1.14 Hyperlink Behavior The element specifies the default behavior for hyperlinks in the document. The only attribute that may be associated with the 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 60 of 706 • _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 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:targetframe-name attribute is any of the other value options, the value of the xlink:show attribute is replace. 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 new replace 3.1.15 Language The 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. 721 722 723 724 725 3.1.16 Editing Cycles The 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. 726 727 728 729 730 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 61 of 706 3.1.17 Editing Duration The 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. 731 732 733 734 735 3.1.18 Document Statistics The 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 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 736 737 738 739 740 741 742 743 744 745 746 Document Statistics Attributes Text meta:page-count meta:table-count meta:draw-count meta:image-count meta:ole-object-count meta:paragraph-count meta:word-count meta:character-count meta:row-count meta:frame-count meta:sentence-count meta:syllable-count meta:non-whitespace-character-count Spreadsheet meta:page-count meta:table-count meta:image-count meta:cell-count meta:object-count Graphic meta:page-count meta:image-count meta:object-count OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 62 of 706 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 63 of 706 813 814 3.2 User-defined Metadata The 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: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). • • (see 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. 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 float date time boolean string OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 64 of 706 3.3 Custom Metadata In addition to the pre-defined metadata elements, applications should also preserve any additional content found inside the 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 65 of 706 4 Text Content 4.1 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 and 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. 4.1.1 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. 855 856 857 858 859 860 861 862 863 864 865 866 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. 867 868 869 870 871 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. 872 873 874 875 876 877 878 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 66 of 706 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. 879 880 881 882 883 884 885 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. 886 887 888 889 890 891 892 Formatted Heading Number If a heading has a numbering applied, the text of the formatted number can be included in a 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. 893 894 895 896 897 4.1.2 Paragraphs Paragraphs are the basic unit of text. 898 899 900 901 902 903 904 905 4.1.3 Common Paragraph Elements Attributes The paragraph elements have text:style-name, text:class-names and text:condstyle-name attributes. These attributes must reference paragraph styles. 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 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 67 of 706 styles (see section 14.1.1). If a conditional style is applied to a paragraph, the text:stylename attribute contains the name of the style that was the result of the conditional 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. 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 Example: Styles and conditional styles "Heading 1" is not a conditional style. "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. A paragraph may have an ID. This ID can be used to reference the paragraph from other elements. 923 924 925 926 927 4.2 Page Sequences A page sequence element 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 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 68 of 706 included within text boxes for documents with page sequences. The only other content that is permitted are drawing objects. Example: Page Sequence ... ... Example text. ... 928 929 930 931 932 933 934 4.2.1 Page The element specifies a single page within a page sequence. 935 936 937 938 939 940 Master Page Name The text:master-page-name attribute specifies the master page that is instantiated. 941 942 943 944 945 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 69 of 706 4.3 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. 4.3.1 List Block A list is represented by the 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 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: 946 947 948 949 950 951 952 953 954 955 956 • Style name • Continue numbering Style Name The optional text:style-name attribute specifies the name of the list style that is applied to the list. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 70 of 706 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. 957 958 959 960 961 962 963 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 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. 964 965 966 967 968 969 970 4.3.2 List Item List items contain the textual content of a list. A element can contain paragraphs or lists. A list item cannot contain headings or tables. 971 972 973 974 975 976 977 978 979 980 981 982 983 984 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 71 of 706 985 986 987 988 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 element is: • Start value Start Value The numbering of the current list can be restarted at a certain number. The text:startvalue 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. 989 990 991 992 993 994 995 Formatted Number If a list item has a numbering applied, the text of the formatted number can be included in a 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 This is the first list item This is a continuation of the first list item. This is the second list item. It contains a sub list. This is a sub list item. This is a sub list item. This is a sub list item. This is the third list item 4.3.3 List Header A list header is a special kind of list item. It contains one or more paragraphs that are displayed before a list. The paragraphs are formatted like list items but they do not have a preceding number or bullet. The list header is represented by the list header element. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 72 of 706 996 997 998 999 1000 4.3.4 Numbered Paragraphs In some instances, it is desirable to specify a list not as a structural element comprising of several list items, but to determine on a per-paragraph level whether the paragraph is numbered, and at which level. To facilitate this, the 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 representation could be converted into a list in representation and vice versa. 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 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. 1013 1014 1015 1016 1017 1018 1019 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. 1020 1021 1022 1023 1024 1025 The text of a formatted number can be included in a 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. 4.4 Text Sections A text section is a named region of paragraph-level text content. Sections start and end on paragraph boundaries and can contain any number of paragraphs. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 73 of 706 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 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. 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 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 continuos numbering should be set such that display and behavior are the same as with the original list not interrupted by sections. 4.4.1 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: 1039 1040 1041 The remaining attributes in this section are specific to the element. Section Style The text:style-name attribute refers to a section style. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 74 of 706 1042 1043 1044 1045 1046 1047 1048 Section Name Every section must have a name that uniquely identifies the section. The text:name attribute contains the name of the section. 1049 1050 1051 1052 1053 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. 1054 1055 1056 1057 1058 1059 1060 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. 1061 1062 1063 1064 1065 1066 1067 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 75 of 706 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. 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 true none condition 4.4.2 Section Source The element indicates that the enclosed section is a linked section. If this element is used, it must be the first element in the element. 1087 1088 1089 1090 1091 The attributes that may be associated with the 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 elements may also link to internal sections. 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 simple embed OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 76 of 706 1105 1106 1107 1108 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. 1109 1110 1111 1112 1113 1114 1115 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. 1116 1117 1118 1119 1120 1121 1122 4.4.3 DDE Source If sections are linked via DDE, their linking information is represented by 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. 1123 1124 1125 4.5 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. 4.6 Change Tracking This section describes how changes in text documents can be represented. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 77 of 706 4.6.1 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 element is absent, change tracking is not enabled. 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 Track Changes This attribute determines whether or not user agents should track and record changes for this document. 1136 1137 1138 1139 1140 1141 1142 4.6.2 Changed Regions For every changed region of a document, there is one entry in the list of tracked changes. This entry contains a list of all changes that were applied to the region. The start and end of this region are marked by the start and end elements that are described in the next section. 1143 1144 1145 1146 1147 1148 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. 1149 1150 1151 1152 1153 4.6.3 Insertion The 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 78 of 706 1154 1155 1156 1157 1158 Example: Insertion of text Michael Brauer 1999-05-18T12:56:04 This is the original text, but this has been added. 4.6.4 Deletion A 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. 1159 1160 1161 1162 1163 1164 1165 1166 Example: Deletion of text Michael Brauer 1999-05-18T12:56:04 , but this has been deleted This is the original text. This example shows: • Deleted text = , but this has been deleted This text is contained in the element within the element. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 79 of 706 • Current text = This is the original text. This text is contained in the 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 element as if the beginning and final tags were missing. • If the change mark is inside a header, proceed as above, except adapt the inserted tags to math their new counterparts. • Otherwise, simply copy the text content of the element in place of the change mark. Example: Given the following change: ... Hello World! The first (and most common) case occurs if a change mark is inside a regular paragraph: abcdef becomes: abcHello World!def The third case occurs when a change occurs outside of a paragraph. In this case, the deleted text is simply copied verbatim. abcdef def would be represented as: ... Hello World! 4.6.5 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. 1167 1168 1169 1170 1171 Note: A format change element does not contain the actual changes that took place. 4.6.6 Change Info The change info element contains meta information who made the change and when. It is also used for spreadsheet documents, and thus described in a section 12.3 (Change Tracking Metadata). 4.6.7 Change Marks There are three elements that mark the start and the end of a changed region, as follows: • Change start element – This element marks the start of a region with content where text has been inserted or the format has been changed. • Change end element – This element marks the end of a region with content where text has been inserted or the format has been changed. • Change position element – 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. 1172 1173 1174 1175 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 81 of 706 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 4.7 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: 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 • 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). OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 82 of 706 1215 1216 1217 1218 1219 1220 1221 1222 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 83 of 706 5 Paragraph Elements Content 5.1 Basic Text Content Paragraph element's children make up the text content of any document. All text contained in 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. 1223 1224 1225 5.1.1 White-space Characters If the paragraph element or any of its child elements contains white-space characters, they are collapsed, in other words they are processed in the same way that [HTML4] processes them. 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 processing takes place within the following elements: • • • • OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 84 of 706 • • • • • • Note: In [XSL], white-space processing of a paragraph of text can be enabled by attaching an fo:white-space="collapse" attribute to the element that corresponds to the paragraph element. 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. 1226 1227 1228 1229 1230 1231 1232 1233 1234 Tab Character The element represents the Unicode tab character HORIZONTAL TABULATION (0x0009) in a heading or paragraph. A element reserves space from the current position up to the next tab-stop, as defined in the paragraph's style information. 1235 1236 1237 1238 1239 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. 1240 1241 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 85 of 706 1242 1243 1244 1245 1246 Note: The text:tab-ref attribute is only a hint to help non-layouting processors to determine the tab/tab-stop association. Layouters should determine the tab positions solely based on the style information. Line Breaks The element represents a line break in a heading or paragraph. 1247 1248 1249 1250 1251 5.1.2 Soft Hyphens, Hyphens, and Non-breaking Blanks Soft hyphens, hyphens, and non-breaking blanks are represented by UNICODE characters. The UNICODE character... Represents... SOFT HYPHEN (00AD) soft hyphens NON-BREAKING HYPHEN (2011) non-breaking hyphens NO-BREAK SPACE (00A0) non-breaking blanks 5.1.3 Attributed Text The element represents portions of text that are attributed using a certain text style or class. The content of this element is the text that uses the text style. The name of the a text style or text class is the value of a text:style-name or text:classnames attributes, respectively, attached to the 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. elements can be nested. White-space characters contained in this element are collapsed. 1252 1253 1254 1255 1256 1257 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 86 of 706 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 Example: Text style in OpenDocument documents: The last word of this sentence is emphasized. 5.1.4 Hyperlinks Hyperlinks in text documents are represented by a element. This element also contains an event table element, , which contains the events assigned to the hyperlink. See section 12.4 for more information on the event table element. 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 The attributes that may be associated with the 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. 1280 1281 1282 1283 1284 1285 1286 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 87 of 706 Link Location The xlink:href attribute specifies the URL for the target location of the link. 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 simple onRequest 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 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]. 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 new replace Text Styles Every hyperlink has two text styles as follows: OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 88 of 706 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 • 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 5.2 Bookmarks and References 5.2.1 Bookmarks Bookmarks can either mark a text position or a text range. A text range can start at any text position and end at another text position. In particular, a bookmark can start in the middle of one paragraph and end in the middle of another paragraph. The XML element used to represent a bookmark varies depending on the type of bookmark, as follows: • – to mark one text position • – to mark the start position in a text range • – to mark the end position in a text range For every element, there must be a element in the same text flow using the same text:name attribute, and vice versa. The element must precede the element. 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 Example: Bookmarks There is a text mark in front of this OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 89 of 706 paragraph. In front of this paragraph there is the start of a bookmark. This bookmark ends amid this sentence. 5.2.2 References The representation of references is modeled on the XML representation of bookmarks. There are two types of reference marks, as follows: • A point reference A point reference marks a particular position in text and is represented by a single element. • A range reference A range reference marks a range of characters in text and is represented by two elements; to mark the start of the range and 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 element represents a point reference. 1348 1349 1350 1351 1352 1353 1354 Range References The and elements represent a range reference. 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 90 of 706 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 This is an example of a sentence with overlapping references. 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. 5.3 Notes Notes consist of a 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 element, which occurs inside the section. 5.3.1 Note Element The note element represents text notes which are attached to a certain text position. A common implementation of this concept are the footnotes and endnotes found in most word processors. A note contains a note citation element and a note body elements, which contains the note'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 element. The OpenDocument schema uses the same structure but introduces a element. The second child contains the note body, just as in XSL. Additionally, OpenDocument features elements. To achieve a similar effect to the note configuration in XSL, every note citation element must be formatted appropriately. 1369 1370 1371 1372 1373 1374 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 91 of 706 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 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. 1392 1393 1394 1395 1396 1397 1398 1399 footnote endnote Footnote Reference ID The footnote reference ID is used by references to footnotes to identify the footnote that is referenced. Note Citation Element The 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 element. Note Body The 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. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 92 of 706 Footnote example This paragraph contains a footnote 1 This footnote has a generated sequence number . This paragraph contains a footnote * This footnote has a fixed citation , too 5.4 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 element: • Ruby base • Ruby text The 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 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. 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 93 of 706 1416 1417 1418 1419 5.5 Text Annotation The OpenDocument format allows annotation to appear within a paragraph element. See section 12.1 for details on annotations. 1420 1421 1422 5.6 Index Marks Index marks are used to mark text areas for inclusion into text indices. They are similar in structure to bookmarks and references. They are discussed in detail section 7.1, together with text indices. 5.7 Change Tracking and Change Marks Paragraphs may also contain change tracking marks. These have already been explained in the chapter on change tracking (section 4.6), and are referenced here for completeness. 1423 1424 1425 5.8 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 an 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. 1426 1427 1428 1429 1430 1431 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 94 of 706 6 Text Fields OpenDocument text documents or OpenDocument text content embedded in other types of documents can contain variable text elements called fields. There are several different types of field, each of which implements a different type of variable text element. Fields are most commonly used for: • Page numbers A 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 dates A creation date field displays the date on which the current document was created. This field is useful for document templates. Every document created using the template contains the date when it was created. • Number ranges A 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. 6.1 Common Characteristics of Field Elements Each field type is represented by a corresponding element type. A field in a document is encoded as a single element of the appropriate type. The content of the element is the textual representation of the current field value as it would be displayed or printed. Therefore, ignoring all field elements and displaying only the textual content of the elements provides an approximate text-only version of the document. The value of a field is usually stored in an attribute. It is necessary to store the value so that 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 fields Many 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 style Several field types, particularly those representing number, date, or time data, contain a OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 95 of 706 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. 6.2 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. The group of document fields includes: • Date and time fields • Page number fields • Sender and author fields • Chapter fields • File name fields • Document template fields 6.2.1 Date Fields Date fields display the current date. The date can be adjusted to display a date other than the current date. For example, the date can be changed on a document that was edited late at night so that it displays the date of the following day or several days later. This element contains the presentation of the date field value, depending on the data style specified. The default date is the current date. The value of this element can be preserved using the text:fixed attribute described in section 6.7.2. 1432 1433 1434 1435 1436 1437 The attributes that may be associated with the element are: • Date value • Date adjustment • Fixed (see section 6.7.2) • Formatting style (see section 6.7.7). The formatting style must be a date data style, see section 14.7 for more information. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 96 of 706 1438 1439 1440 1441 1442 1443 Date Value The text:date-value attribute specifies a particular date value. For example, if the date field is marked fixed, this attribute can be used to specify the date on which the field was marked as fixed. This attribute can also be used to specify a future date. Some applications support date and time in addition to date-only values. The date value should conform with the date formats described in §3.2.7 and §3.2.9 of [xmlschema-2]. If no value is specified, the current date is assumed, even if the field is marked fixed. 1444 1445 1446 1447 1448 1449 1450 Date Adjustment The value of a date field can be adjusted by a certain time period, which is specified using the text:date-adjust attribute. If the time period is negative, it gets subtracted from the value of the date field, yielding a date before the current date. The value of this attribute must conform to the time period format described in §3.2.6 of [xmlschema-2]. The value can be preceded by an optional minus sign to indicate a negative time duration. 1451 1452 1453 1454 1455 1456 1457 6.2.2 Time Fields Time fields display the current time. They are very similar to the date fields described in the previous section, supporting the same attributes except that for time fields, they are called text:time-value and text:time-adjust attributes. This element contains the presentation of the time field value, depending on the data style specified. The default time is the current time. The value of this element can be preserved using the text:fixed attribute described in section 6.7.2. 1458 1459 1460 1461 1462 1463 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 97 of 706 The attributes that may be associated with the element are: 1464 1465 1466 1467 1468 1469 • Time value • Time adjustment • Fixed (see section 6.7.2) • Formatting style (see section 6.7.7). The formatting style must be a time data style, see section 14.7 for more information. Time Value The text:time-value attribute records the time at which the document was last edited. Some applications support date and time in addition to date-only values. The value of this attribute must conform with either the “dateTime” or “time” data types described in §3.2.7 and §3.2.8 of [xmlschema-2]. If no value is specified, the current time is assumed, even if the field is marked fixed. 1470 1471 1472 1473 1474 1475 1476 Time Adjustment The value of a time field can be adjusted by a certain time period, which is specified using the text:time-adjust attribute. The value of this attribute must conform to the time period format described in §3.2.6 of [xmlschema-2]. The value can be preceded by an optional minus sign to indicate a negative time duration. Positive values adjust the time to a time in the future, while negative values adjust the time to a time in the past. The duration is truncated to full minutes. 1477 1478 1479 1480 1481 1482 1483 Example: Time adjust attributes and their effects If the attribute text:time-adjust="PTM15", the time field displays a time which is 15 minutes later than the actual time specified by the time field value. If the attribute text:time-adjust="-PTH1", the time field displays a time which is one hour before the actual time specified by the time field value. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 98 of 706 6.2.3 Page Number Fields Page number fields display the current page number. These fields are particularly useful in headers and footers. E.g., if a page number field is inserted into a footer, the current page number is displayed on every page on which the footer appears. The attributes that may be associated with the element are: 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 • Page adjustment • Display previous or following page numbers • Fixed (see section 6.7.2) • Formatting style (see section 6.7.8) Page numbers can be formatted according to the number format described in section 2.9. If a number style is not specified, the page numbers are formatted according to the number style defined in the current page style. Note: To display the total number of pages in a document, use the field described in section 6.4.17. Page Adjustment The value of a page number field can be adjusted by a specified number, allowing the display of page numbers of following or preceding pages. The adjustment amount is specified using the text:page-adjust attribute. When this attribute is used, the application: 1. Adds the value of the attribute to the current page number. 2. Checks to see if the resulting page exists. 3. If the page exists, the number of that page is displayed. 4. If the page does not exist, the value of the page number field remains empty and no number is displayed. 1496 1497 1498 1499 1500 1501 1502 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 99 of 706 Display Previous or Following Page Numbers The text:select-page attribute is used to display the number of the previous or the following page rather than the number of the current page. 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 previous current next Note: To display the current page number on all pages except the first or last page, use a combination of the text:select page and text:page adjust attributes. Example: Displaying the current page number on all pages except the first page 6.2.4 Page Continuation Text In some publications, a continuation reminder is printed at the bottom of the page in addition to the page number. To include a continuation reminder, use the element. 1514 1515 1516 1517 1518 1519 The attributes associated with the element are: • Previous or following page • String value Previous or Following Page This attribute specifies whether to check for a previous or next page and if the page exists, the continuation text is printed. 1520 1521 1522 1523 1524 1525 1526 1527 previous next OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 100 of 706 String Value This attribute specifies the continuation text to display. If this attribute is omitted, the element content is used. 1528 1529 1530 1531 1532 1533 1534 6.2.5 Sender Fields There are several fields which contain information about the sender of the current document, for example, name and email address. The information about the sender is taken from the OpenDocument user information dialog. If a sender field is marked fixed using the text:fixed attribute, the original sender information in the sender fields is preserved. (cf. section 6.7.2) Otherwise, the information is updated each time the file is edited, causing the fields to change value when the document is edited by a different user. First Name This element represents the first name of the sender. 1535 1536 1537 1538 1539 1540 Last Name This element represents the last name of the sender. 1541 1542 1543 1544 1545 1546 Initials This element represents the initials of the sender. 1547 1548 1549 1550 1551 1552 Title This element represents the title of the sender. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 101 of 706 1553 1554 1555 1556 1557 1558 Position This element represents the position of the sender. 1559 1560 1561 1562 1563 1564 Email Address This element represents the email address of the sender. 1565 1566 1567 1568 1569 1570 Private Telephone Number This element represents the private telephone number of the sender. 1571 1572 1573 1574 1575 1576 Fax Number This element represents the facsimile number of the sender. 1577 1578 1579 1580 1581 1582 Company Name This element represents the name of the company that employs the sender. 1583 1584 1585 1586 1587 1588 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 102 of 706 Office Telephone Number This element represents the office telephone number of the sender. 1589 1590 1591 1592 1593 1594 Street This element represents the street name of the address of the sender. 1595 1596 1597 1598 1599 1600 City This element represents the city name of the address of the sender. 1601 1602 1603 1604 1605 1606 Postal Code This element represents the postal code of the address of the sender. 1607 1608 1609 1610 1611 1612 Country This element represents the country of the address of the sender. 1613 1614 1615 1616 1617 1618 State or Province This element represents the state or province of the address of the sender, if applicable. 1619 1620 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 103 of 706 1621 1622 1623 1624 6.2.6 Author Fields There are two elements available to display the author of a document. One element displays the full name of the author and the other element displays the initials of the author. The value of author fields can be fixed using the text:fixed attribute. Marking an author field as fixed preserves the original field content. Otherwise, the field content changes each time the document is updated, to reflect the last author of the document. Name of the Author This element represents the full name of the author. 1625 1626 1627 1628 1629 1630 Initials of the Author This element represents the initials of the author. 1631 1632 1633 1634 1635 1636 6.2.7 Chapter Fields Chapter fields display one of the following: • The name of the current chapter • The number of the current chapter • Both the name and number of the current chapter If the chapter field is placed inside a header or footer, it displays the current chapter name or number on every page. 1637 1638 1639 1640 1641 1642 The attributes that may be associated with the element are: • Display • Outline level OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 104 of 706 Display The text:display attribute specifies the information that the chapter field should display. 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 name number number-and-name plain-number-and-name plain-number Example: If the current chapter number is 2.4, the chapter title is Working with Tables, the prefix is [, and suffix is ], the possible display options and results are as follows: Value of text:display attribute Field content displayed number [2.4] name Working with Tables number-and-name [2.4] Working with Tables plain-number 2.4 plain-number-and-name 2.4 Working with Tables Outline Level This attribute is used to specify the outline level to use. The chapter field displays the chapter number or title up to the specified outline level. 1654 1655 1656 1657 1658 6.2.8 File Name Fields File name fields display the name of the file that is currently being edited. The attributes that may be associated with the element are: 1659 1660 1661 1662 1663 1664 • Display • Fixed OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 105 of 706 Display The text:display attribute specifies how much of the file name to display. The following display options are allowed: • The full file name including the path and the extension • The file path only • The file name only • The file name and the extension The filename might be an URI, either because an URI has been used to retrieve the file, or the application internally uses URIs and therefor converts even system specific paths into an URI. If this is the case, and if the the path, the name or the extension cannot be evaluated from the URI, then the URI should be displayed unmodified. 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 full path name name-and-extension Fixed File Name Fields If a file name field is fixed, its value does not change when the file is edited. 1677 1678 1679 6.2.9 Document Template Name Fields The document template name field displays information about the document template in use, such as the template title or the file name. The only attribute that may be associated with the element is: • 1680 1681 1682 1683 1684 1685 Display Display This attribute specifies which information about the document template to display. The following display options are allowed: • The full file name including the path and the extension OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 106 of 706 • The file path only • The file name only • The file name and the extension • The title • The area of the document template The latter two values can be used for template dialogs. The values are a superset of the display values available for the element. 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 full path name name-and-extension area title 6.2.10 Sheet Name Fields For Spreadsheet documents, sheet name fields display the name of the sheet that is currently being edited. 1700 1701 1702 1703 1704 6.3 Variable Fields OpenDocument text documents can contain variables, which are processed or displayed using variable fields. A variable is a name/value pair. The variable name is used throughout the document to identify a particular variable, and therefore variable names cannot be reused for different types of variables. Most variable fields support different value types, such as numbers, dates, strings, and so on. In the OpenDocument file format, a variable must be declared at the beginning of a document. There are three types of variables: • Simple variables Simple variables, usually called variables, can take different values at different positions throughout a document. Simple variables can be set using either setter or input fields. Setter fields contain an expression, which is used to compute the new value of the variable. Input fields prompt the user for the new value. Simple variables can be used to display different text in recurring elements, such as headers or footers. • User variables User variables have the same value throughout a document. If a user variable is set anywhere within the document, all fields in the document that display the user variable have OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 107 of 706 the same value. In the office application user interface, a user variable can be set at any occurrence of a user field, or by using user variable input fields. In the OpenDocument file format, the value of the user variable can only be set after the variable is declared. • Sequence variables Sequence variables are used to number certain items in an OpenDocument text document, for example, images or tables. Expression and text input fields are also variable fields, but they are not associated with any particular variables. Since their functionality is closely related to that of the variable fields, they are also described in this section of the manual. Variables must be declared before they can be used. The variable declarations are collected in container elements for the particular variable type. The OpenDocument code for declaring variables is described in the following section. 6.3.1 Declaring Simple Variables Simple variables are declared using elements. The declaration specifies the name and the value type of the variable. To specify the name and value type of the simple variable, the following attributes are attached to the element: • text:name The name of the variable must be unique. The name cannot already be used for any other type of variable. See section 6.7.3 for information on using this attribute. • office:value-type See section 6.7.1 for information on using this attribute. 1705 1706 1707 1708 1709 1710 6.3.2 Setting Simple Variables Simple variables can be set using variable setter elements. This element contains the presentation of the value of the variable, which can be empty if the text:display attribute is set to none. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to set. It must match the name of a variable that has already been declared. See section 6.7.3 for information on using this attribute. • text:formula This attribute contains the formula to compute the value of the variable field. If the formula equals the content of the field element, this attribute can be omitted. See section 6.7.6 for information on using this attribute. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 108 of 706 • office:value-type and the appropriate value attribute See section 6.7.1 for information on using these attributes. Note: A simple variable should not contain different value types at different places in a document. However, an implementation may allow the use of different value types for different instances of the same variable. In the case of the numeric value types float, percentage, and currency, the value is automatically converted to the different value type. For value types that are stored internally as numbers, such as date, time, and boolean types, the values are reinterpreted as numbers of the respective types. If a variable is used for both string and non-string types, the behavior is undefined, therefore this practice is not recommended. • text:display This attribute can be used to specify whether or not to display the value of the element. If the text:display attribute is set to value, the value of the variable is displayed. If the attribute is set to none, the value is not displayed. See section 6.7.5 for information on using this attribute. • style:data-style-name This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 6.3.3 Displaying Simple Variables The element reads and displays the value of a simple variable. The value of this element is the value of the last preceding element with an identical text:name attribute. The element determines how the value of the variable is presented, in accordance with the chosen formatting style. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to display. The name must match the name of a preceding element. See section 6.7.3 for information on using this attribute. • text:display This attribute can be used to specify whether to display the formula for a simple variable or the computed value of the variable. See section 6.7.5 for information on using this attribute. • style:data-style-name OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 109 of 706 This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 6.3.4 Simple Variable Input Fields As an alternative to setting simple variables using formulas in variable setter elements, the user can be prompted for variable values. To do this, use the element. This element contains the presentation of the variable's value according to the chosen formatting style. The presentation can be empty if the text:display attribute is set to none. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to display. It must match the name of a variable that was already declared. See section 6.7.3 for information on using this attribute. • text:description This optional attribute contains a brief message that is presented to users when they are prompted for input. The message should give users enough information about the variable or the use of the value within the document to enable them to choose an appropriate value. See section 6.7.4 for information on using this attribute. • office:value-type and the appropriate value attribute See section 6.7.1 for information on using these attributes. • text:display This attribute can be used to specify whether to display or hide the value of the variable through the variable input field. See section 6.7.5 for information on using this attribute. • style:data-style-name This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 110 of 706 1744 6.3.5 Declaring User Variables User variables contain values that are displayed using appropriate fields. Unlike simple variables, user variables have the same value throughout a document. For this reason, the value of user variables is stored in the variable declaration itself. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to be declared. The name must be unique. It cannot already be used for any other type of variable including simple and sequence variables. See section 6.7.3 for information on using this attribute. • text:formula This attribute contains the formula to compute the value of the user variable field. If the formula is the same as the content of the field element, this attribute can be omitted. See section 6.7.6 for information on using this attribute. • office:value-type and the appropriate value attribute See section 6.7.1 for information on using these attributes. 1745 1746 1747 1748 1749 1750 1751 1752 1753 6.3.6 Displaying User Variables The content of user variables can be displayed using elements. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to display. The name must match the name of a preceding element. See section 6.7.3 for information on using this attribute. • text:display This attribute can be used to specify whether to: – Display the formula used to compute the value of the user variable. – Display the value of the user variable. – Hide the user variable fields. • See section 6.7.5 for information on using this attribute. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 111 of 706 Note: Since the office application user interfaces usually allow users to edit a user field variable by clicking on any user field, a hidden element can be used as an anchor to allow easy access to a particular user field variable. • style:data-style-name This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 6.3.7 User Variable Input Fields An alternative method of setting user variables is to use input fields, similar to the input fields for simple variables. A user variable can be set in this way using the element. Since the value of a user field variable is stored in the element, the element does not contain the value and value type attributes from the field. The presentation can be empty if the text:display attribute is set to none. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to set. It must match the name of a variable that has already been declared. See section 6.7.3 for information on using this attribute. • text:description This optional attribute contains a brief message that is presented to users when they are prompted for input. The message should give users enough information about the variable or the use of the value within the document, to enable them to choose an appropriate value. See section 6.7.4 for information on using this attribute. • style:data-style-name This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 112 of 706 6.3.8 Declaring Sequence Variables Sequence variables are used to number items within an OpenDocument text document. Sequence variables are most commonly used for sequential numbering. However, expression formulas can be included in sequence fields to support more advanced sequences. See section 6.3.9 for more information on Using Sequence Fields and their uses. Sequence variables are declared using the element. To facilitate chapter-specific numbering, attributes can be attached to a sequence variable to specify a chapter level and a separation character. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable to be declared. The name must be unique. It cannot already be used for any other type of variable including simple and user variables. See section 6.7.3 for information on using this attribute. • text:display-outline-level See following section Outline Level for information about this attribute. • text:separation-character See following section Separation Character for information about this attribute. 1774 1775 1776 1777 1778 1779 1780 1781 Outline Level Sequences can be numbered by chapter. To use this feature, use the text:displayoutline-level attribute to specify an outline level that determines which chapters to reference for the chapter-specific numbering. All chapters that are at or below the specified outline level reset the value of the sequence to zero, the default value. Also, the chapter number of the last chapter at or below the specified outline level is prepended to the sequence number. Choosing an outline level of zero results in a straight sequence of all sequence elements for that sequence variable. 1782 1783 1784 1785 1786 Separation Character If sequences are numbered by chapter, this attribute is used to choose a character to separate the chapter number from the sequence number. If the value of the text:display-outline-level attribute is a non-zero value, a separation character may be specified. The default separation character is ".".Otherwise, if the value of text:display-outline-level is zero, this attribute must be omitted. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 113 of 706 1787 1788 1789 1790 1791 1792 1793 Example: Sequence variable The sequence variable 3.7.36#5 with a value of 5 is declared using: Attribute Value text:display-outline-level 3 text:separation-character # 6.3.9 Using Sequence Fields Once a sequence variable is declared, it can be used in sequence fields throughout the document. Most sequence fields simply increment and display the sequence variable. However, sequence fields can also assume a new start value at any given position in a document. This start value is computed using a formula which is contained in the sequence field. If a sequence field without a start value is added, the office application software automatically inserts an expression of the type variable+1. Sequence fields are most commonly used for simple counting sequences. However, the ability to provide arbitrary expressions supports more complex sequences. To form a sequence of even numbers, all sequence elements for that particular variable need to contain a formula incrementing the value by two, for example, variable+2. A sequence with a starting value of 1 and all subsequent elements using the formula variable*2 yields all powers of two. Since different sequence elements for the same sequence variable may contain different formulas, complex sequences may be constructed. The attributes that may be associated with the element are: • text:name This attribute specifies the name of the variable that the field is to display. It must match the name of a sequence variable that was already declared. See section 6.7.3 for information on using this attribute. • text:formula This optional attribute contains a formula to compute the value of the sequence field. If this attribute is omitted, an expression containing the content of the element is used. See section 6.7.6 for information on using this attribute. • style:num-format and style:num-letter-sync These attributes specify the numbering style to use. If a numbering style is not specified, the numbering style is inherited from the page style. See section 6.7.8 for information on these attributes. • text:ref-name See the following section Reference Name for more information about this attribute. 1794 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 114 of 706 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 Reference Name Sequence fields can be the target of references, as implemented using reference fields. See section 6.6.5 for more information about reference fields. To enable a reference field to identify a particular sequence field, the sequence field must contain an additional attribute containing a name. No two sequence fields can have the same reference name. If the sequence field is not the target of a reference, this attribute can be omitted. 1805 1806 1807 1808 1809 1810 1811 6.3.10 Expression Fields Expression fields contain expressions that are evaluated and the resulting value is displayed. The value of the expression is formatted according to the chosen formatting style. The attributes that may be associated with the element are: • text:formula This attribute contains the actual expression used to compute the value of the expression field. See section 6.7.6 for information on using this attribute. • office:value-type and the appropriate value attribute See section 6.7.1 for information on using these attributes. • text:display Use this attribute to specify one of the following: – To display the value of the field. – To display the formula used to compute the value. See section 6.7.5 for information on using this attribute. • style:data-style-name This attribute specifies the data style to use to format a numeric, Boolean, or date/time variable. If a data style is not specified, a standard data style is used. See section 6.7.7 for information on using this attribute. 1812 1813 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 115 of 706 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 6.3.11 Text Input Fields A text input field is a variable field. From the point of view of the user interface, a text input field is similar to the and fields. However, the text input field does not change the value of any variables. The only attribute that may be associated with the element is: • text:description This attribute contains a brief message that is presented to users when they are prompted for input. The message should give users enough information about the purpose of the field and how it is used within the document, to enable them to choose an appropriate value. See section 6.7.4 for information on using this attribute. 1825 1826 1827 1828 1829 1830 6.4 Metadata Fields Metadata fields display meta information about the document, such as, the document creation date or the time at which the document was last printed. The names of the metadata field elements correspond to the metadata elements described in Chapter 3. All metadata field elements can be marked as fixed using the text:fixed attribute. (Cf. section 6.7.2) Several metadata fields display a date or a time. The elements for these fields require an associated text:date-value or a text:time-value attribute, and optionally, they can also have a style:data-style-name attribute. See section 6.7.1 for more information on these attributes. 6.4.1 Initial Creator This element represents the name of the author who created the original document. 1831 1832 1833 1834 1835 1836 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 116 of 706 6.4.2 Document Creation Date This element represents the date on which the document was created. 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 6.4.3 Document Creation Time This element represents the time at which the document was created. 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 6.4.4 Document Description This element contains a brief description of the document. 1865 1866 1867 1868 1869 1870 6.4.5 User-Defined Document Information This element contains user-defined information about the document. It displays the information provided within a element that has the same name. 1871 1872 1873 1874 1875 1876 1877 1878 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 117 of 706 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 6.4.6 Print Time This element represents the time at which the document was last printed. 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 6.4.7 Print Date This element represents the date on which the document was last printed. 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 118 of 706 1933 1934 1935 6.4.8 Printed By This element represents name of the last person who printed the document. 1936 1937 1938 1939 1940 1941 6.4.9 Document Title This element represents the title of the document. 1942 1943 1944 1945 1946 1947 6.4.10 Document Subject This element represents the subject of the document. 1948 1949 1950 1951 1952 1953 6.4.11 Document Keywords This element contains a list of keywords used to describe the document. 1954 1955 1956 1957 1958 1959 6.4.12 Document Revision Number This element contains the document revision number. When the document is created, the revision number is set to 1. Each time the document is saved, the document revision number is incremented. 1960 1961 1962 1963 1964 1965 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 119 of 706 Note: Since the field can not be formatted, the revision number can be read from the element content. Therefore, no extra attribute is needed. 6.4.13 Document Edit Duration Every time a document is edited, the office application records the duration between the time the document is opened and the time the document is closed. It then adds the duration to an internal counter, thereby keeping track of the total time that has been spent editing the document. 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 6.4.14 Document Modification Time This element represents the time at which the document was last modified. This element displays the information from the element. The name was chosen to avoid confusion with fields. 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 6.4.15 Document Modification Date This element represents the date on which the document was last modified. This element displays the information from the element. The name was chosen to avoid confusion with fields. 1994 1995 1996 1997 1998 1999 2000 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 120 of 706 2001 2002 2003 2004 2005 2006 2007 6.4.16 Document Modified By This element represents the name of the person who last modified the document. 2008 2009 2010 2011 2012 2013 6.4.17 Document Statistics Fields These fields display how many objects of a certain type a document contains. They can be used to display the number of 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 • pages, • paragraphs, • words, • characters, • tables, • images, or • embedded objects. text:page-count text:paragraph-count text:word-count text:character-count text:table-count text:image-count text:object-count 6.5 Database Fields Documents can reference databases and display database information as text content. To display database information, the OpenDocument schema uses a group of text fields, collectively called database fields. Office applications may use database tables from SQL servers, therefore database fields can be used to access any SQL database, provided that the appropriate drivers are available. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 121 of 706 A database may contain the following components: • Tables, which store the actual data. • Queries, which extract a subset of data from one or more tables. • Forms, which present the data. • Reports, which summarize the database content. Database forms and reports are not relevant to text content, therefore they are not discussed in this chapter. From the point of view of embedding database information in OpenDocument text documents, queries and tables are considered the same. Therefore for the remainder of this section, the phrase database table refers to both database tables and database queries. Database fields alone do not retrieve information from a database. In addition to the database fields, a set of database rows is also added to the document. When new data is added to the document, all database fields belonging to the added database table are updated. Using the office application user interface, database rows can be added in one of the following ways: • Manually, using a data source browser and the data to fields function. • Using the Form Letter menu item on the File menu. This menu item adds each row in the chosen data set into a newly created copy of the form letter. To display data from a database table use the element. The and elements can be used to determine which row within the current selection should be displayed. The current row number for a particular table can be displayed using the element. Finally, the field displays the name of the most recently used database, which is the address book file database by default. 6.5.1 Database Field Data Source A database field's source can either be the name of a database, or an URI containing database connection resource data. If the source is a database name, then this name is used by all of the office application components to identify a database. All database fields contain a database name or connection resource, and most database fields also contain the name of a database table, which must be stored in the database. An additional attribute determines whether the database table refers to an SQL table, an OpenDocument query, or the result of a SQL command. 2029 2030 2031 2032 Database Name The text:database-name attribute specifies the source database by its name. 2033 2034 2035 2036 2037 2038 2039 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 122 of 706 Connection Resource The element specifies the source database by an [XLink]. Its xlink:href attribute either references a file containing a database, or it contains information on how to make a connection to a database, for instance a [JDBC] URL. See also section 11.1.20. 2040 2041 2042 Database Table Name The text:table-name attribute specifies a table within the source database. 2043 2044 2045 2046 2047 Database Type The text:table-type attribute determines whether the database table refers to an SQL table, an OpenDocument query, or the result of a SQL command. 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 table query command 6.5.2 Displaying Database Content The element displays data from a database. When a new data set is added to a document, all fields that display data from that database table update their content. The attributes that may be associated with the element are: • text:database-name, text:table-name and text:table-type These attributes specify the database and database table that this field uses. • text:database-column-name See following section Column Name for information about this attribute. • style:data-style-name If the column specifies a numeric, Boolean, date, or time value, the data is formatted according to the appropriate data style. If no data style is specified, the data style assigned to this column in is used. See section 6.7.7 for more information about using this attribute. 2059 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 123 of 706 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 Column Name The text:column-name attribute specifies the column from which to display the data. The value of this attribute must be a column contained in the specified database. 2071 2072 2073 2074 2075 6.5.3 Selecting the Next Database Row The element changes the row in the current selection which is used for display in all following fields. The next row from the current selection is chosen if it satisfies a given condition. If the next row is wanted regardless of any condition, the condition may be omitted or set to true. The attributes that may be associated with the are: • text:database-name, text:table-name and text:table-type These attributes specify the database and the database table that this field uses. • text:condition See following section Condition for information about this attribute. 2076 2077 2078 2079 2080 2081 2082 2083 Condition The text:condition attribute specifies the condition expression. The expression is evaluated and if the result interpreted as a Boolean value is true, the next row is used as the new current row. Database field values can be used in the expression by enclosing in square brackets the database name, the table name, and the column name, separated by dots. If the text:condition attribute is not present, it is assumes that the formula true, meaning that the next row is selected unconditionally. 2084 2085 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 124 of 706 2086 2087 2088 2089 2090 Example: text:formula='ooo-w:[address book file.address.FIRSTNAME] == "Julie"' This example specifies a condition that is true if the current row from an address book database table is the address for a person named Julie. If the condition shown in this example is used in a element, the following happens: • The elements display the data from the first row of the current selection. • If the FIRSTNAME column of the current row reads Julie, the current row is changed. Otherwise, nothing happens. • If the first row is Julie, the following elements display data from the second row. Otherwise, they display data from the first row. See section 6.7.6 for more information on the formula syntax of a text:condition attribute, which is the same as that of the text:formula attribute. 6.5.4 Selecting a Row Number The element selects a specific row from the current selection. As with the element, a condition can be specified so that the given row is only selected if the condition is true. The attributes that may be associated with the are: • text:database-name, text:table-name and text:table-type These attributes determine the database and the database table that this field uses. • text:condition This attribute specifies the condition expression. See section 6.5.3 for a full explanation of how to use this attribute. • text:row-number See the following section Selecting the Row Number about this attribute. 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 125 of 706 Selecting the Row Number This attribute specifies the row number to select when a condition is true. 2106 2107 2108 2109 2110 2111 2112 6.5.5 Displaying the Row Number The element displays the current row number for a given table. Note that the element displays the actual row number from the database and not the row number of the current selection that is used as an attribute value in the element. The attributes that may be associated with the are: • text:database-name, text:table-name and text:table-type These attributes determine the database and the database table that this field uses. • style:num-format and style:num-letter-sync These attributes determine how the number should be formatted. See section 6.7.8 for more information on how to use this attribute. • text:value This attribute specifies the current row number. The number changes when new data is added to the current document. 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 6.5.6 Display Current Database and Table Office applications may keeps track of the last database and table that was used in the document. In other words, the table that is used by the last field that was inserted into the document. The element displays the database and table name of the most recently used table. The attributes that may be associated with the element are: • text:database-name, text:table-name and text:table-type OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 126 of 706 These attributes determine the database and the database table that this field uses. 2127 2128 2129 2130 2131 2132 6.6 More Fields 6.6.1 Page Variable Fields Page variables allow an alternative page numbering scheme to be defined. There is only one page variable, and it is set by any set page variable field in the document. The value of the page variable is increased on each page, in the same way as regular page numbers. Setting Page Variable Fields To set a page variable field, use the element. 2133 2134 2135 2136 2137 2138 Turning Page Variables On or Off At the beginning of a document, the page variable is inactive. The text:active attribute can be used to disable a page variable after it was used in the document. 2139 2140 2141 2142 2143 2144 2145 Page Variable Adjustment The text:page-adjust attribute determines the page adjustment. The value of the active page variable is the current page number plus the closest page adjustment value that was previously set. 2146 2147 2148 2149 2150 2151 2152 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 127 of 706 Displaying Page Variable Fields The element displays the value of the page variable. The field can be formatted in the same way as regular page number fields. 2153 2154 2155 2156 2157 2158 The attributes that may be associated with the element are: • style:num-format and style:num-letter-sync These attributes determine how the number should be formatted. See section 6.7.8 for more information on how to use these attributes. 2159 2160 2161 6.6.2 Placeholders The OpenDocument format uses placeholder fields to indicate locations in a document where the user must fill in some information. For example in a letter template, a section of the document can be reserved for the address of the recipient. A placeholder field displays text informing the user about the purpose of the placeholder and sometimes includes a description. Placeholder fields can represent different text elements, such as text or tables. This element contains some brief text which is displayed with the placeholder. 2162 2163 2164 2165 2166 2167 The attributes that may be associated with the element are: • Placeholder type • Placeholder description Placeholder Type There are five different types of placeholder, representing the five possible types of content: text, tables, text boxes, images, or objects. The text:placeholder-type attribute represents the content type. This attribute is mandatory and it indicates which type of text content the placeholder represents. The value of the attribute can be text, text-box, image, table, or object. 2168 2169 2170 2171 2172 2173 2174 2175 text table text-box image object OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 128 of 706 2176 2177 2178 Placeholder Description In addition to the brief text stored in the element content, may be associated a text:description attribute with the placeholder element. This attribute is optional. The purpose of the attribute is to contain a more elaborate description of the purpose of the placeholder than the description stored in the element content. See section 6.7.4 for information on using the text:description attribute. 2179 2180 2181 6.6.3 Conditional Text Fields Text fields can be used to display one text or another, depending on a condition. Conditional text fields are given a condition and two text strings. If the condition is true, one of the text strings is displayed. If the condition is false, the other text string is displayed. 2182 2183 2184 2185 2186 2187 The attributes that may be associated with the element are: • Condition • Text to display if the condition is true • Text to display if the condition is false • Current condition The text:condition attribute contains a Boolean expression. Depending on the result, the value of the text:display-if-true or text:display-if-false attribute is displayed. 2188 2189 2190 2191 2192 Text to Display if the Condition is True The text:string-value-if-true attribute contains the text string to display if the condition is true. 2193 2194 2195 2196 2197 OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 129 of 706 Text to Display if the Condition is False The text:string-value-if-false attribute contains the text string to display if the condition is false. 2198 2199 2200 2201 2202 Current Value and Condition The text:current-value attribute contains the evaluation result of the condition given by the expression in the text:condition attribute. Explicitly giving the result allows applications to delay evaluating the result until necessary. This attribute is valuable for the following reasons: 2203 2204 2205 2206 2207 2208 2209 • If the expression is costly to evaluate, for example, the expression contains references to several databases. • To allow transformations to correctly display the state of the document without having to parse and evaluate the condition. Note: The value of this attribute is overwritten with a new value as soon as the application evaluates the expression. This attribute has no function other than to ease transformation or initially display the document. 6.6.4 Hidden Text Field The hidden text field is closely related to the conditional text field. It displays fixed text, except when the condition is true when it does not display anything. 2210 2211 2212 2213 2214 2215 The attributes that may be associated with the element are: • Condition • Text • Is hidden Condition The text:condition attribute contains a Boolean expression. If the expression evaluates to true, the text is hidden. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 130 of 706 2216 2217 2218 2219 2220 Text The text:string-value attribute specifies the text to display if the condition is false. 2221 2222 2223 2224 2225 Is Hidden The text:is-hidden attribute specifies whether or not the field is currently visible. The purpose of this attribute is similar to that of the text:current-value attribute in the text:condition field. Recording the result allows transformations to correctly represent the document without having to parse the condition expression or evaluate the condition when loading the document. 2226 2227 2228 2229 2230 2231 2232 Note: The value of this attribute is overwritten with a new value as soon as the application evaluates the expression. This attribute has no function other than to ease transformation or initially display the document. 6.6.5 Reference Fields The OpenDocument format uses four types of reference field and each type is represented by its own element. The reference field types are based on the type of element they refer to; notes, bookmarks, references, and sequences. Every reference contains a reference format which determines what information about the referenced target is displayed. For example, references can display: • The page number of the referenced target • The chapter number of the referenced target • Wording indicating whether the referenced target is above or below the reference field In addition, each reference field must identify its target which is usually done using a name attribute. Bookmarks and references are identified by the name of the respective bookmark or reference. Footnotes, endnotes, and sequences are are assigned names by the application used to create the OpenDocument file format automatically. 2233 2234 2235 2236 2237 text:reference-ref text:bookmark-ref OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 131 of 706 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 The attributes that may be associated with the reference field elements are: • Reference name • Reference format Reference Name The text:ref-name attribute identifies the referenced element. Since bookmarks and references have a name, this name is used by the respective reference fields. Footnotes, endnotes, and sequences are are identified by a name that is usually generated automatically. 2265 2266 2267 2268 2269 2270 2271 Note Class For elements, the text:note-class attribute determines whether the field references a foot- or an endnote. 2272 2273 2274 Reference Format The text:reference-format attribute determines what information about the reference is displayed. If the reference format is not specified, the page format is used as the default. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 132 of 706 All types of reference fields support the following values for this attribute formats: • page, which displays the number of the page on which the referenced item appears. • chapter, which displays the number of the chapter in which the referenced item appears. • direction, which displays whether the referenced item is above or below the reference field. • text, which displays the text of the referenced item. References to sequence fields support the following three additional values: 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 • category-and-value, which displays the name and value of the sequence. • caption, which displays the caption in which the sequence is used. • value, which displays the value of the sequence. page chapter direction text page chapter direction text category-and-value caption value Example: Different reference formats and displays The following table shows all possible reference formats and the resulting reference display that can be used to refer to the table itself. The left column lists the value of the text:referenceformat attribute and the right column OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved. 1 May 2005 Page 133 of 706 Reference format Reference display page 134 chapter 3.7.27 text Table 2: Examples of reference formats direction above category-and-value Table 1 caption Examples of reference formats value 1 6.6.6 Script Fields A script field stores scripts or sections of scripts. The field can be used to store and edit scripts that are attached to the document. The primary purpose of this field is to provide an equivalent to the