OASIS Openopen access

OpenDocument Format for Office Applications (OpenDocument) v1.0 (2005-05-01)

OASIS Open · OASIS Open

OASIS Open · Standards · License: Open Access

oasis, standard, oasis open, specification, open standard, oasis_opendocument-v1.0-os, opendocument, format, for, office, applications, v1.0, opendocument-v1.0-os, v1, os, 1.0

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 <[email protected]> Patrick Durusau, Society of Biblical Literature <[email protected]> Gary Edwards <[email protected]> David Faure, <[email protected]> Tom Magliery, Blast Radius <[email protected]> Daniel Vogelheim, Sun Microsystems <[email protected]> Contributors: Doug Alberg, Boeing <[email protected]> Simon Davis, National Archive of Australia <[email protected]> Paul Grosso, Arbortext <[email protected]> Phil Boutros, Stellent <[email protected]> John Chelsom, CSW Informatics <[email protected]> Jason Harrop <[email protected]> Mark Heller, New York State Office of the Attorney General <[email protected]> Paul Langille, Corel <[email protected]> Monica Martin, Drake Certivo <[email protected]> Uche Ogbuji <[email protected]> Lars Oppermann, Sun Microsystems <[email protected]> Lauren Wood <[email protected]> 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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Namespace

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

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

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

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

6 7

$Id$

8 9 10 11

-->

12 13 14 15

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

16 17

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

1 May 2005 Page 33 of 706

19 20 21 22 23 24 25 26 27 28 29 30 31 32

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

33 34 35 36 37

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

38 39 40 41 42

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

1.5 Document Processing and Conformance Documents that conform to the OpenDocument specification MAY contain elements and attributes not specified within the OpenDocument schema. Such elements and attributes must not be part 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 <style:*-properties> elements (see section 15) MAY have arbitrary attributes attached and MAY have arbitrary element content. All attributes attached to these elements and elements contained within these elements SHOULD be preserved (see section 15.1.3);

•

elements contained within the <office:meta> element MAY have arbitrary element content and SHOULD be preserved (see section 2.2.1).

Foreign elements MAY have an office:process-content attribute attached that has the value true or false. If the attribute's value is true, or if the attribute does not exist, the element's content SHOULD be processed by conforming applications. Otherwise conforming applications SHOULD NOT process the element's content, but MAY only preserve its content. If the element's content should be processed, the document itself 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.

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.

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.

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

<office:document>

Complete office document in a single n/a XML document.

<office:document-content>

Document content and automatic styles used in the content.

content.xml

1 May 2005 Page 37 of 706

Root Element

Subdocument Content

Subdoc. Name in Package

<office:document-styles>

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

<office:document-meta>

Document meta information, such as meta.xml the author or the time of the last save action.

styles.xml

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

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

meta app. script font style data sett. decls 



<office:document-content>



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



auto style 

mast body style 

 



 



<office:document-settings>



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

1 May 2005 Page 38 of 706

71 72

</element> </define>

The <office:document-content> 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 <office:document-styles> 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 <office:document-meta> root contains the meta information about a document. 91 92 93 94 95 96

The <office:document-settings> 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

1 May 2005 Page 39 of 706

109

</define>

MIME Type The <office:document> element takes an office:mimetype attribute, which indicates the type of document (text, spreadsheet etc.). This attribute is especially important for flat XML files, where this is the only way the type of document can be detected (in a package, the MIME type is also present in a separate file, see section 17.4). Its values are the MIME types that are used for the packaged variant of office documents (see section 1.7). 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 <office:meta> element, usually located at start of the document. Metadata elements may be omitted or occur multiple times. It is application-specific how to update multiple instances of the same elements. 115 116 117 118 119 120 121

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 <office:meta>. Since their semantics is not defined in this specification, conforming applications in general cannot process or display this data. Applications SHOULD preserve this data when editing the document.

1 May 2005 Page 40 of 706

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

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

text documents

•

drawing documents

•

presentation documents

•

spreadsheet documents

•

chart documents

•

image documents

All document types share the same content elements, but different document types place different restrictions on which elements may occur, and in what combinations. The document content 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

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

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.

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

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

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

1 May 2005 Page 46 of 706

331 332

</element> </define>

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 <office:settings> 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 <config:config-item-set> element. For instance the following two categories may exist: •

Document settings, for example default printer.

•

View settings, for example zoom level.

2.4.1 Sequence of Settings The <config:config-item-set> element is a container element for all types of setting elements. The settings can be contained in the element is any order. 355 356 357 358 359 360

361 362 363 364

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 <config:config-item-set> elements, that are elements that are direct children of the <office:settings> element, the name should be preceded by a namespace prefix that identifies the application the settings belong to. 372 373 374 375 376

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

2.4.2 Base Settings The <config:config-item> element contains all base settings. The value of the setting 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

<define name="config-config-item-attlist" combine="interleave"> <attribute name="config:type"> <choice> <value>boolean</value>

1 May 2005 Page 48 of 706

392 393 394 395 396 397 398 399 400 401

<value>short</value> <value>int</value> <value>long</value> <value>double</value> <value>string</value> <value>datetime</value> <value>base64Binary</value> </choice> </attribute> </define>

2.4.3 Index Access of Sequences The <config:config-item-map-indexed> element is a container element for sequences. The order specifies the index of the elements 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 <config:config-item-map-entry> element represents an entry in an indexed or named settings sequence. It is a container element for all types of setting elements. 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

1 May 2005 Page 49 of 706

2.4.5 Name Access of Sequences The <config:config-item-map-named> element is a container element for sequences, where each setting in the sequence is identified by its name. 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 <text:p>This is<?opendocument cursor-position view-id="view1"?> an example.</text:p>

2.5 Scripts A document may contain several scripts in different scripting languages. Each script is represented by a <office:script> element. All these script elements are contained in a single <office:scripts> element. Scripts do not imply a scripting language or an object model. A script can operate on the Document Object Model (DOM) of a document in OpenDocument format or on an application specific API.

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 <office:script> elements, the <office:scripts> element may also contain an <office:event-listeners> element which contains the events assigned to the document itself. Examples for these are events called when the document is opened or closed. See section 12.4 for more information on the <office:event-listeners> element. 441 442 443 444 445 446 447 448 449 450 451 452

2.5.1 Script The <office:script> element contains script language specific content. In most situations, the element contains the source code of the script, but it may also contain a compiled version of the script or a link to some external script code. 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

1 May 2005 Page 51 of 706

473 474

</optional> </define>

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

Common styles Most office applications support styles within their user interface. Within this specification, 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: •

<office:styles> for common styles

•

<office:automatic-styles> for automatic styles

•

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

•

<office:master-styles>

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

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 <office:document ...> <office:styles> ... </office:styles> <office:automatic-styles> ... </office:automatic-styles> <office:master-styles> ... </office:master-styles> </office:document>

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.

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 <meta:generator> element contains a string that identifies the application or tool that was used to create or last modify the XML document. This string SHOULD match the definition for user-agents in the HTTP protocol a specified in section 14.43 of [RFC2616]. The generator string SHOULD allow product versions to differ between all released versions of a user agent, for instance by including build ids or patch level information. Conforming applications MAY use the generator string to work around bugs that exist or existed in certain applications, but 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 <dc:title> element specifies the title of the document. 592 593 594 595 596

3.1.3 Description The <dc:description> element contains a brief description of the document. 597 598 599 600 601

1 May 2005 Page 56 of 706

3.1.4 Subject The <dc:subject> element specifies the subject of the document. 602 603 604 605 606

3.1.5 Keywords The <meta:keyword> element contains a keyword pertaining to the document. The metadata can contain any number of <meta:keyword> elements, each element specifying one keyword. 607 608 609 610 611

3.1.6 Initial Creator The <meta:initial-creator> element specifies the name of the person who created the document initially. 612 613 614 615 616

3.1.7 Creator The <dc:creator> element specifies the name of the person who last modified the document. The name of this element was chosen for compatibility with the Dublin Core, but this definition of "creator" used here differs from Dublin Core, which defines creator as "An entity primarily responsible for making the content of the resource." In OpenDocument terminology, the 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 <meta:printed-by> element specifies the name of the last person who printed the document. 625 626 627 628 629

1 May 2005 Page 57 of 706

3.1.9 Creation Date and Time The <meta:creation-date> element specifies the date and time when the document was created initially. To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss. 630 631 632 633 634

3.1.10 Modification Date and Time The <dc:date> element specifies the date and time when the document was last modified. To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss. The name of this element was chosen for compatibility with the Dublin Core. 635 636 637 638 639 640 641 642

3.1.11 Print Date and Time The <meta:print-date> element specifies the date and time when the document was last printed. To conform with [xmlschema-2], the date and time format is YYYY-MM-DDThh:mm:ss. 643 644 645 646 647

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

Template location

•

Template title

•

Template modification date and time

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

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

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

Reload URL

•

Reload delay

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

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

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

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

Target frame

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

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

•

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

•

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

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 <meta:hyperlink-behaviour> element. If the value of the meta:target-frame-name attribute is _blank, the xlink:show attribute value is new. If the value of the meta: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

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

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

3.1.16 Editing Cycles The <meta:editing-cycles> element specifies the number of editing cycles the document has been through. The value of this element is incremented every time the document is saved. The element contains the number of editing cycles as text. 726 727 728 729 730

1 May 2005 Page 61 of 706

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

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

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

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

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

1 May 2005 Page 63 of 706

813 814

</element> </define>

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

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

•

An optional meta: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

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

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 <office:meta> element. As there is no semantics specified for such foreign content, applications need not process this information other than to preserve it when editing the document.

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 <text:h> and <text:p> represent headings and paragraphs, respectively, and are collectively referred to as paragraph elements. All text content in an OpenDocument file must be contained in either of these elements.

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

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 <text:number> element. This text can be used by applications that do not support numbering of headings, but it will be ignored by applications that support numbering. 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

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 <text:p text:style-name="Heading 1"> "Heading 1" is not a conditional style. </text:p> <text:p text:style-name="Numbering 1" text:cond-style-name="Text body"> "Text body" is a conditional style. If it is contained in a numbered paragraph, it maps to "Numbering 1". This is assumed in this example. </text:p>

A paragraph may have an ID. This ID can be used to reference the paragraph from other elements. 923 924 925 926 927

4.2 Page Sequences A page sequence element <text:page-sequence> specifies a sequence of master pages that are instantiated in exactly the same order as they are referenced in the page sequence. If a text document contains a page sequence, it will consist of exactly as many pages as specified. Documents with page sequences do not have a main text flow consisting of headings and paragraphs as is the case for documents that do not contain a page sequence. Text content is

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 <style:automatic-style> <style:page-layout name="pm1">  </style:page-layout> <style:page-layout name="pm2">  </style:page-layout> </style:automatic-style> ... <style:master-styles> <style:master-page name="portrait" style:page-layout-name="pm1"/> <style:master-page name="landscape" style:page-layout-name="pm2"/> </style:master-styles> ... <office:body> <text:page-sequence> <text:page text:master-page-name="portrait"/> <text:page text:master-page-name="portrait"/> <text:page text:master-page-name="landscape"/> <text:page text:master-page-name="landscape"/> <text:page text:master-page-name="portrait"/> </text:page-sequence> <draw:frame ...> <draw:text-box ...> <text:p>Example text.</text:p> ... </draw:text-box> </draw:frame> </office:body> 928 929 930 931 932 933 934

4.2.1 Page The <text:page> 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

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

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.

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 <text:list> element and can have a value of true or false. If the value of the attribute is true and the numbering style of the preceding list is the same as the current list, the number of the first list item in the current list is the number of the last item in the preceding list incremented by one. 964 965 966 967 968 969 970

4.3.2 List Item List items contain the textual content of a list. A <text:list-item> 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

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 <text:list-item> 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 <text:number> element. This text can be used by applications that do not support numbering, but it will be ignored by applications that support numbering. See also section 4.1.1.

Example: Lists and sublists <text:list text:style-name="List 1"> <text:list-item> <text:p>This is the first list item</text:p> <text:p>This is a continuation of the first list item.</text:p> </text:list-item> <text:list-item> <text:p>This is the second list item. It contains a sub list.</text:p> <text:list> <text:list-item><text:p>This is a sub list item.</text:p> <text:list-item><text:p>This is a sub list item.</text:p> <text:list-item><text:p>This is a sub list item.</text:p> </text:list> </text:list-item> <text:list-item> <text:p>This is the third list item</text:p> </text:list-item> </text:list>

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

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 <text:numbered-paragraph> element allows the numbering of an individual paragraph, as if it was part of a list at a specified level. Numbered paragraphs may use the same continuous numbering properties that list items use, and thus form an equivalent, alternative way of specifying lists. A list in <text:list> representation could be converted into a list in <text:numbered-paragraph> representation and vice versa. 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 <text:number> element. This text can be used by applications that do not support numbering, but it will be ignored by applications that support numbering. See also section 4.1.1.

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.

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 <style:style> element. See section 14.8.3 for details. The formatting properties for sections are explained in section 15.7. Sections support two ways of linking to external content. If a section is linked to another document, the link can be through one of the following: •

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

•

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

Linking information for external content is contained in the section element's first child. A section that links to external content contains the full representation of the data source, so that processors need to understand the linking information only if they wish to update the contents of the section. 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 <text:section> element.

Section Style The text:style-name attribute refers to a section style.

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.

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

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

4.4.2 Section Source The <text:section-source> element indicates that the enclosed section is a linked section. If this element is used, it must be the first element in the <text:section> element. 1087 1088 1089 1090 1091

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

Section source URL

•

Name of linked section

•

Filter name

Section Source URL These attributes identify the document or section to which the section is linked. The name of the target section is identified by the local part of the URL, following the hash mark. The xlink:href attribute is implied because <text:section-source> elements may also link to internal sections. 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104

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

1 May 2005 Page 76 of 706

1105 1106 1107 1108

</attribute> </optional> </optional> </define>

Name of Linked Section If the link targets a section of a document, the attribute text:section name contains the name of the target section. If the attribute is not present, the link targets the entire document. 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 <office:ddesource> elements. It contains attributes that specify the application, topic and item of the DDE connection. Note that because the section contains the XML rendition of the DDE link's content, this information only needs to be processed if updated data from the DDE link are desired. 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.

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 <text:tracked-changes> 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 <text:insertion> element contains the information that is required to identify any insertion of content. This content can be a piece of text within a paragraph, a whole paragraph, or a whole table. The inserted content is part of the text document itself and is marked by a change start and a change end element.

1 May 2005 Page 78 of 706

1154 1155 1156 1157 1158

Example: Insertion of text <text:tracked-changes> <text:changed-region text:id="c001"> <text:insertion> <office:change-info> <dc:creator>Michael Brauer</dc:creator> <dc:date>1999-05-18T12:56:04</dc:date> </office:change-info> </text:insertion> </text:changed-region> </text:tracked-changes> <text:p> This is the original text<text:change-start text:change-id="c001"/>, but this has been added</text:change-end text:change-id="c001"/>. </text:p>

4.6.4 Deletion A <text:deletion> element contains content that was deleted while change tracking was enabled. The position where the text was deleted is marked by the change position element. If part of a paragraph was deleted, the text that was deleted is contained in this element as 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 <text:tracked-changes> <text:changed-region text:id="c002"> <text:deletion> <office:change-info> <dc:creator>Michael Brauer</dc:creator> <dc:date>1999-05-18T12:56:04</dc:date> </office:change-info> <text:p>, but this has been deleted</text:p> </text:deletion> </text:changed-region> </text:tracked-changes> <text:p> This is the original text<text:change text:region-id="c002"/>. </text:p>

This example shows: •

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

1 May 2005 Page 79 of 706

•

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

•

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

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

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

•

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

•

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

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

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

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

If the change mark occurred inside a header, the same procedure is followed, except the copied tags are adapted to make sure we still have well-formed XML. <text:h>abc<text:change text:id="example/>def</text:h>

becomes: <text:h>abcHello</text:h> <text:h>World!def</text:h>

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

This becomes: <text:p>abcdef</text:p> <text:h>Hello</text:h> <text:h>World!</text:h> <text:p>ghijkl</text:p>

If, in the first two cases, the deletion contains complete paragraphs, then additional empty paragraphs must be put into the <text:deletion> element to achieve the desired result.

1 May 2005 Page 80 of 706

The change that took place from <text:p>abc</text:p> <text:h>Hello</text:h> <text:h>World!</text:h> <text:p>def</text:p>

to <text:p>abc<text:change text:id="example/>def</text:p>

would be represented as: <text:changed-region text:id="example"> <text:deletion> <office:change-info>...</office:change-info> <text:p/> <text:p>Hello</text:p> <text:p>World!</text:p> <text:p/> </text:deletion> </text:changed-region>

4.6.5 Format Change A format change element represents any change in formatting attributes. The region where 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 – <text:change-start> This element marks the start of a region with content where text has been inserted or the format has been changed.

•

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

•

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

All three elements have an attribute that specifies the ID of the region to which they belong. 1172 1173 1174 1175

1 May 2005 Page 81 of 706

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

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

4.7 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).

1 May 2005 Page 82 of 706

1215 1216 1217 1218 1219 1220 1221 1222

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

<text:p>

•

<text:h>

•

<text:span>

•

<text:a>

1 May 2005 Page 84 of 706

•

<text:ref-point>

•

<text:ref-point-start>

•

<text:ref-point-end>

•

<text:bookmark>

•

<text:bookmark-start>

•

<text:bookmark-end>

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

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 <text:tab> element represents the Unicode tab character HORIZONTAL TABULATION (0x0009) in a heading or paragraph. A <text:tab> element reserves space from the current position up to the next tab-stop, as defined in the paragraph's style information. 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

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 <text:line-break> 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 <text:span> element represents portions of text that are attributed using a certain text style or class. The content of this element is the text that uses the text style. The name of the a text style or text class is the value of a text:style-name or text:classnames attributes, respectively, attached to the <text:span> element. These attributes must refer to text styles or classes. A text:style-name attribute references a single text style. A text:class-names attribute takes a whitespace separated list of text style names. The referenced text styles are applied in the order they are contained in the list. If both, text:style-name and text:class-names are present, the style referenced by the text:style-name attribute is treated as the first style in the list in text:class-names. Conforming application should support the text:class-names attribute and also should preserve it while editing. <text:span> elements can be nested. White-space characters contained in this element are collapsed. 1252 1253 1254 1255 1256 1257

1 May 2005 Page 86 of 706

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268

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

Example: Text style in OpenDocument documents: <text:p> The last word of this sentence is <text:span text:style-name="emphasize">emphasized</text:span>. </text:p>

5.1.4 Hyperlinks Hyperlinks in text documents are represented by a <text:a> element. This element also contains an event table element, <office:event-listeners>, 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 <text:a> element are: •

Name

•

Link location

•

Target frame

•

Text styles

Name A hyperlink can have a name, but it is not essential. The office:name attribute specifies the name of the hyperlink if one exists. This name can serve as a target for some other hyperlinks. 1280 1281 1282 1283 1284 1285 1286

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

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

Target Frame The office:target-frame-name attribute specifies the target frame of the link. This attribute can have one of the following values: •

_self – The referenced document replaces the content of the current frame.

•

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

•

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

•

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

•

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

To conform with the XLink Specification, an additional xlink:show attribute is attached to the <text:a> element. If the value of the attribute is _blank, the xlink:show attribute value is new. If the value of the attribute is any of the other value options, the value of the xlink:show attribute is replace. See [XLink]. 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316

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

Text Styles Every hyperlink has two text styles as follows:

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

<text:bookmark> – to mark one text position

•

<text:bookmark-start> – to mark the start position in a text range

•

<text:bookmark-end> – to mark the end position in a text range

For every <text:bookmark-start> element, there must be a <text:bookmark-end> element in the same text flow using the same text:name attribute, and vice versa. The <text:bookmark-start> element must precede the <text:bookmark-end> element. 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347

Example: Bookmarks <text:p> <text:bookmark text:name="Mark 1"/>There is a text mark in front of this

1 May 2005 Page 89 of 706

paragraph. <text:bookmark-start text:name="Mark 2"/>In front of this paragraph there is the start of a bookmark. </text:p> <text:p> This bookmark ends <text:bookmark-end text:name="Mark 2"/> amid this sentence. </text:p>

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 <text:reference-mark> element.

•

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

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

Point References The <text:reference-mark> element represents a point reference. 1348 1349 1350 1351 1352 1353 1354

Range References The <text:reference-mark-start> and <text:reference-mark-end> elements represent a range reference. 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368

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 <text:p> <text:reference-mark-start text:name="first"/>This is an <text:reference -mark-start text:name="second"/>example of a sentence <text:reference -mark-end text:name="first"/>with overlapping references. <text:reference -mark-end text:name="second"/> </text:p>

The example paragraph shows two references that cover the following text: reference “first”

“This is an example of a sentence”

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

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

5.3.1 Note Element The note element represents text notes which are attached to a certain text position. A common implementation of this concept are the footnotes and endnotes found in most word processors. A note contains a note citation element and a note body elements, which contains the note's content. In OpenDocument documents, notes are represented in a similar fashion to footnotes in [XSL]. In XSL, the first child of the note element contains the citation in the form of an <fo:inline> element. The OpenDocument schema uses the same structure but introduces a <text:notecitation> element. The second child contains the note body, just as in XSL. Additionally, OpenDocument features <text:notes-configuration> elements. To achieve a similar effect to the note configuration in XSL, every note citation element must be formatted appropriately. 1369 1370 1371 1372 1373 1374

1 May 2005 Page 91 of 706

1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

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

Note Class Each note belongs to a class which determines how the note is expected to be rendered. Currently, two note classes are supported: Footnotes and endnotes. 1392 1393 1394 1395 1396 1397 1398 1399

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

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

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

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

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

1 May 2005 Page 92 of 706

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

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 <text:ruby> element: •

Ruby base

•

Ruby text

The <text:ruby-base> element contains the text that is to be annotated. It contains any paragraph element content, like text spans. The element's text:style-name attribute references a ruby style that specifies further formatting attributes of the ruby. See section 14.8.4 for details. The <text:ruby-text > element contains the annotation text. It may contain only plain text. The element's text:style-name attribute references a text style that specifies further formatting attributes used for the text. 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415

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

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

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 <text:date> 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.

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

1 May 2005 Page 97 of 706

The attributes that may be associated with the <text:time> 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.

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 <text:page-number> 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 <text:page-count/> field described in section 6.4.17.

Page Adjustment The value of a page number field can be adjusted by a specified number, allowing the display 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

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

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

Note: To display the current page number on all pages except the first or last page, use a combination of the text:select page and text:page adjust attributes. Example: Displaying the current page number on all pages except the first page <text:page-number text:select-page="previous" text:page-adjust="1" style:num-format="1"/>

6.2.4 Page Continuation Text In some publications, a continuation reminder is printed at the bottom of the page in addition to the page number. To include a continuation reminder, use the <text:page-continuation> element. 1514 1515 1516 1517 1518 1519

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

Previous or following page

•

String value

Previous or Following Page This attribute specifies whether to check for a previous or next page and if the page exists, the continuation text is printed. 1520 1521 1522 1523 1524 1525 1526 1527

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

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.

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

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

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 <text:chapter> element are: •

Display

•

Outline level

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

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

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

Field content displayed

number

[2.4]

name

Working with Tables

number-and-name

[2.4] Working with Tables

plain-number

2.4

plain-number-and-name

2.4 Working with Tables

Outline Level This attribute is used to specify the outline level to use. The chapter field displays the chapter number or title up to the specified outline level. 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 <text:file-name> element are:

1659 1660 1661 1662 1663 1664

•

Display

•

Fixed

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

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

Fixed File Name Fields If a file name field is fixed, its value does not change when the file is edited. 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 <text:template-name> 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

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 <text:file-name> element. 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699

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

6.2.10 Sheet Name Fields For Spreadsheet documents, sheet name fields display the name of the sheet that is currently being edited. 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

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 <text:variable-decl> elements. The declaration specifies the name and the value type of the variable. To specify the name and value type of the simple variable, the following attributes are attached to the <text:variable-decl> element: •

text:name The name of the variable must be unique. The name cannot already be used for any 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 <text:variable-set> 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.

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 <text:variable-set> 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 <text:variable-get> element reads and displays the value of a simple variable. The value of this element is the value of the last preceding <text:variable-set> element with an identical text:name attribute. The element determines how the value of the variable is presented, in accordance with the chosen formatting style. The attributes that may be associated with the <text:variable-get> element are: •

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

•

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

•

style:data-style-name

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 <text:variable-input> element. This element contains the presentation of the variable's value according to the chosen formatting style. The presentation can be empty if the text:display attribute is set to none. The attributes that may be associated with the <text:variable-input> element are: •

text:name This attribute specifies the name of the variable to display. It must match the name of 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.

•

1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743

1 May 2005 Page 110 of 706

1744

</define>

6.3.5 Declaring User Variables User variables contain values that are displayed using appropriate fields. Unlike simple variables, user variables have the same value throughout a document. For this reason, the value of user variables is stored in the variable declaration itself. The attributes that may be associated with the <text:user-field-del> element are: •

text:name This attribute specifies the name of the variable to be declared. The name must be unique. It cannot already be used for any other type of variable including simple and 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 <text:user-field-get> elements. The attributes that may be associated with the <text:user-field-get> element are: •

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

•

text:display This attribute can be used to specify whether to: –

Display the formula 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.

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 <text:user-field-get> element can be used as an anchor to allow easy access to a particular user field variable. •

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 <text:user-field-input> element. Since the value of a user field variable is stored in the <text:user-field-del> element, the <text:user-field-input> element does not contain the value and value type attributes from the <text:variable-input> field. The presentation can be empty if the text:display attribute is set to none. The attributes that may be associated with the <text:user-field-input> element are: •

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

•

text:description This optional attribute contains a brief message that is presented to users when they 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.

•

1764 1765 1766 1767 1768 1769 1770 1771 1772 1773

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 <text:sequence-del> 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 <text:sequence-del> element are: •

text:name This attribute specifies the name of the variable to be declared. The name must be unique. It cannot already be used for any other type of variable including simple and user variables. See section 6.7.3 for information on using this attribute.

•

text:display-outline-level See 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.

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 <text:sequence> 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

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 <text:expression> 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. •

1812 1813

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 <text:variable-input> and <text:user-field-input> fields. However, the text input field does not change the value of any variables. The only attribute that may be associated with the <text:text-input> element is: •

text:description This attribute contains a brief message that is presented to users when they are prompted for input. The message should give users enough information about the purpose of the field 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

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 <meta:user-defined> element that has the same name. 1871 1872 1873 1874 1875 1876 1877 1878

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

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

1 May 2005 Page 119 of 706

Note: Since the <text:editing-cycles> 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 <meta:date> element. The name was chosen to avoid confusion with <text:date> 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 <meta:date> element. The name was chosen to avoid confusion with <text:date> fields. 1994 1995 1996 1997 1998 1999 2000

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.

<define name="paragraph-content" combine="choice"> <element> <choice> <name>text:page-count</name> <name>text:paragraph-count</name> <name>text:word-count</name> <name>text:character-count</name> <name>text:table-count</name> <name>text:image-count</name> <name>text:object-count</name> </choice> <ref name="common-field-num-format-attlist"/> <text/> </element> </define>

6.5 Database Fields Documents can reference databases and display database information as text content. To display database information, the OpenDocument schema uses a group of text fields, collectively called database fields. Office applications may use database tables from SQL servers, therefore database fields can be used to access any SQL database, provided that the appropriate drivers are available.

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 <text:database-display> element. The <text:database-select> and <text:database-next> 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 <text:database-row-number> element. Finally, the <text:database-name> 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

1 May 2005 Page 122 of 706

Connection Resource The <form:connection-resource> element specifies the source database by an [XLink]. Its xlink:href attribute either references a file containing a database, or it contains information on how to make a connection to a database, for instance a [JDBC] URL. See also section 11.1.20. 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

<define name="common-field-database-table-attlist" combine="interleave"> <optional> <attribute name="text:table-type"> <choice> <value>table</value> <value>query</value> <value>command</value> </choice> </attribute> </optional> </define>

6.5.2 Displaying Database Content The <text:database-display> element displays data from a database. When a new data set is added to a document, all fields that display data from that database table update their content. The attributes that may be associated with the <text:database-display> element are: •

text:database-name, text:table-name and text:table-type These attributes specify the database and database table that this field uses.

•

text:database-column-name See 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

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 <text:database-next> element changes the row in the current selection which is used for display in all following <text:database-display> fields. The next row from the current selection is chosen if it satisfies a given condition. If the next row is wanted regardless of any condition, the condition may be omitted or set to true. The attributes that may be associated with the <text:database-next> are: •

text:database-name, text:table-name and text:table-type 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

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 <text:database-next> element, the following happens: •

The <text:database-display> elements display the data from the first row of the current selection.

•

If the FIRSTNAME column of the current row reads Julie, the current row is changed. Otherwise, nothing happens.

•

If the first row is Julie, the following <text:database-display> elements display 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 <text:database-row-select> element selects a specific row from the current selection. As with the <text:database-row-next> element, a condition can be specified so that the given row is only selected if the condition is true. The attributes that may be associated with the <text:database-row-select> 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

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 <text:database-row-number> element displays the current row number for a given table. Note that the element displays the actual row number from the database and not the row number of the current selection that is used as an attribute value in the <text:database-rowselect> element. The attributes that may be associated with the <text:database-row-number> are: •

text:database-name, text:table-name and text:table-type These attributes determine the database and the database table that this field uses.

•

style:num-format and style:num-letter-sync These attributes determine how the number should be formatted. See section 6.7.8 for more information on how to use 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 <text:database-name> element displays the database and table name of the most recently used table. The attributes that may be associated with the <text:database-name> element are: •

text:database-name, text:table-name and text:table-type

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 <text:variable-page-set> 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

1 May 2005 Page 127 of 706

Displaying Page Variable Fields The <text:variable-page-get> element displays the value of the page variable. The field can be formatted in the same way as regular page number fields. 2153 2154 2155 2156 2157 2158

The attributes that may be associated with the <text:get-page-variable> element are: •

style:num-format and style:num-letter-sync These attributes determine how the number should be formatted. See section 6.7.8 for more information on how to use these attributes.

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 <text:placeholder> element are: •

Placeholder type

•

Placeholder description

Placeholder Type There are five different types of placeholder, representing the five possible types of content: text, tables, text boxes, images, or objects. The text:placeholder-type attribute represents 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

<define name="text-placeholder-attlist" combine="interleave"> <attribute name="text:placeholder-type"> <choice> <value>text</value> <value>table</value> <value>text-box</value> <value>image</value> <value>object</value>

1 May 2005 Page 128 of 706

2176 2177 2178

</choice> </attribute> </define>

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 <text:conditional-text> 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

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 <text:hidden-text> 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.

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

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

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

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

</choice> <interleave> <ref name="text-common-ref-content"/> <ref name="text-ref-content"/> </interleave> </element> </define> <define name="paragraph-content" combine="choice"> <element name="text:note-ref"> <interleave> <ref name="text-common-ref-content"/> <ref name="text-note-ref-content"/> <ref name="text-ref-content"/> </interleave> </element> </define> <define name="paragraph-content" combine="choice"> <element name="text:sequence-ref"> <interleave> <ref name="text-common-ref-content"/> <ref name="text-sequence-ref-content"/> </interleave> </element> </define> <define name="text-common-ref-content" combine="interleave"> <text/> </define>

The attributes that may be associated with the reference field elements are: •

Reference name

•

Reference format

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 <text:note-ref> 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.

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.

<define name="text-ref-content" combine="interleave"> <optional> <attribute name="text:reference-format"> <choice> <value>page</value> <value>chapter</value> <value>direction</value> <value>text</value> </choice> </attribute> </optional> </define> <define name="text-sequence-ref-content" combine="interleave"> <optional> <attribute name="text:reference-format"> <choice> <value>page</value> <value>chapter</value> <value>direction</value> <value>text</value> <value>category-and-value</value> <value>caption</value> <value>value</value> </choice> </attribute> </optional> </define>

Example: Different reference formats and displays The following table shows all possible reference formats and the resulting reference display 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

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

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 <script> element in [HTML4], so that the content of a <script> element in HTML can be imported, edited, and exported using an office application software. The source code for the script can be stored in one of the following ways: •

The <text:script> element contains the source code.

•

The source code is stored in an external file. Use the xlink:href attribute to specify the location of the source file.

The element should have either a xlink:href attribute or content, but not both. 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325

<define name="paragraph-content" combine="choice"> <element name="text:script"> <interleave> <choice> <group> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> <optional> <attribute name="xlink:type" a:defaultValue="simple"> <value>simple</value> </attribute> </optional> </group> <text/> </choice> <optional> <attribute name="script:language"> <ref name="string"/> </attribute> </optional> </interleave> </element> </define>

1 May 2005 Page 134 of 706

Script URL The xlink:href attribute specifies the location of the file that contains the script source code. The script field should have either an URL attribute or content, but not both.

Script Language The script:language attribute specifies the language in which the script source code is written, for example, JavaScript.

6.6.7 Macro Fields The macro field contains the name of a macro that is executed when the field is activated. The field also contains a description that is displayed as the field content. The only attribute that may be associated with the <text:execute-macro> element is: • 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338

Macro name

Macro Name The text:name attribute specifies the macro to invoke when the field is activated.

6.6.8 Hidden Paragraph Fields The hidden paragraph field has a similar function to the hidden text field. However, the hidden paragraph field does not have any content. It hides the paragraph in which it is contained. This allows a paragraph of formatted text to be hidden or displayed depending on whether a condition is true or false. Hidden paragraph fields are often used together with form letters. For example, if a condition depends on a database field, a hidden paragraph field can be used to selectively include paragraphs in the form letter depending on the database content. Multiple paragraph fields can be contained one paragraph. The paragraph is displayed if the condition associated with at least one hidden paragraph field is false. Alternatively, the conditions associated with several hidden paragraph fields can be combined into a single condition for a single field using logical operations on the conditions.

Note: Unlike most fields, this field does not display text, but it affects the entire paragraph in which it is contained. The attributes that may be associated with the <text:hidden-paragraph> element are:

1 May 2005 Page 135 of 706

2339 2340 2341 2342 2343 2344

•

Condition

•

Is hidden

Condition The text:condition attribute contains a Boolean expression. If the condition is true, the paragraph is hidden. If the condition is false, the paragraph is displayed. 2345 2346 2347 2348 2349

Is Hidden The text:is-hidden attribute records whether the paragraph is currently visible or not. It has the same purpose as the corresponding attribute of the hidden text field, namely to allow correct display of the paragraph without having to evaluate the condition first. The value of this attribute is overwritten with a new value as soon as the application evaluates the expression.

Note: This attribute has no function other than to ease transformation or initially display the document. 2350 2351 2352 2353 2354 2355 2356

6.6.9 DDE Connection Fields A DDE field allows information from a DDE connection to be displayed. The only parameter required for the DDE field is the name of the DDE connection that supplies the data to this field. This DDE connection element specifies the actual DDE field that appears in the text body. The field element contains the content of the most recent data that was received from the DDE connection. This may be used to render the document if the DDE connection cannot be accessed. 2357 2358 2359 2360 2361 2362 2363 2364

The only attribute that may be associated with the <text:dde-connection> element is:

1 May 2005 Page 136 of 706

•

DDE connection name

DDE Connection Name The text:name attribute specifies the name of the DDE connection to which the field refers.

6.6.10 Measure Fields Within the text contained in measure drawing objects (see section 9.2.11), a <text:measure> field displays the current measure. The draw:kind attribute specifies which part of the measure is displayed. It my have one of the following values:

2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376

•

value: The measure's value is displayed, for instance “12”

•

unit: The measure's unit is displayed, for instance “inch”

•

gap: A gap or blank is displayed if and only if the measure text's writing direction is perpendicular to the measure line. The purpose of this value is add some space between the measure line and the text if the text is displayed perpendicular to the measure line.

<define name="paragraph-content" combine="choice"> <element name="text:measure"> <attribute name="text:kind"> <choice> <value>value</value> <value>unit</value> <value>gap</value> </choice> </attribute> <text/> </element> </define>

6.6.11 Table Formula Field The table formula field is a legacy from previous versions of current office applications. It should not be used in new documents. It stores a formula to be used in tables, a function that is better performed by the table:formula attribute of the table cell.

Note: This element should not be used in new documents. The table formula field can take the following attributes: •

text:formula This attribute contains the actual expression used to compute the value of the table formula field. See section 6.7.6 for information on using this attribute.

•

text:display Use this attribute to specify one of the following: –

To display the value of the field.

–

To display the formula used to compute the value.

See section 6.7.5 for information on using this attribute. •

style:data-style-name

1 May 2005 Page 137 of 706

6.7 Common Field Attributes The attributes described in this section can be used with several field elements.

6.7.1 Variable Value Types and Values Variables and most variable fields have a current value. Every variable has a value type that must be specified when the field supports multiple value types. The value type is specified using the office:value-type attribute. 2387 2388 2389 2390 2391

Depending on the value type, the value itself is written to different value attributes. The supported value types, their respective value attributes, and how the values are encoded are described in the following table: Value Type float

Value Attribute(s)

Encoded as...

Example

office:value

Numeric value

"12.345"

percentage office:value

Numeric value

"0.50"

currency

office:value and office:currency

Numeric value and currency symbol

"100" "USD"

date

office:date-value

Date value as specified in §3.2.9 "2003-04-17" of [xmlschema-2], or date and time value as specified in §3.2.7 of [xmlschema-2]

time

office:time-value

Duration, as specified in §3.2.6 of [xmlschema-2]

boolean

office:boolean-value true or false

"true"

string

office:string-value

"abc def"

Strings

"PT03H30M00S "

The OpenDocument concept of field values and value types and their encoding in XML is modeled on the corresponding XML for table cell attributes. See section 8.1.3 for information on table cells and their attributes.

1 May 2005 Page 138 of 706

The definition of the entity %value-attlist; is as follows: 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455

<define name="common-value-and-type-attlist"> <choice> <group> <attribute name="office:value-type"> <value>float</value> </attribute> <attribute name="office:value"> <ref name="double"/> </attribute> </group> <group> <attribute name="office:value-type"> <value>percentage</value> </attribute> <attribute name="office:value"> <ref name="double"/> </attribute> </group> <group> <attribute name="office:value-type"> <value>currency</value> </attribute> <attribute name="office:value"> <ref name="double"/> </attribute> <optional> <attribute name="office:currency"> <ref name="string"/> </attribute> </optional> </group> <group> <attribute name="office:value-type"> <value>date</value> </attribute> <attribute name="office:date-value"> <ref name="dateOrDateTime"/> </attribute> </group> <group> <attribute name="office:value-type"> <value>time</value> </attribute> <attribute name="office:time-value"> <ref name="duration"/> </attribute> </group> <group> <attribute name="office:value-type"> <value>boolean</value> </attribute> <attribute name="office:boolean-value"> <ref name="boolean"/> </attribute> </group> <group> <attribute name="office:value-type"> <value>string</value> </attribute> <optional> <attribute name="office:string-value"> <ref name="string"/> </attribute> </optional>

1 May 2005 Page 139 of 706

2456 2457 2458

</group> </choice> </define>

6.7.2 Fixed The text:fixed attribute specifies whether or not the value of a field element is fixed. If the value of a field is fixed, the value of the field element to which this attribute is attached is preserved in all future edits of the document. If the value of the field is not fixed, the value of the field may be replaced by a new value when the document is edited. This attribute can be used with:

2459 2460 2461 2462 2463 2464 2465

•

Date fields

•

Time fields

•

Page number fields

•

All sender fields

•

All author fields

6.7.3 Variable Name Use the text:name attribute to specify the name of a variable when it is being declared, set, or displayed a variable. This attribute can be used with any of the following elements: •

<text:variable-del>

•

<text:variable-set>

•

<text:variable-get>

•

<text:variable-input>

•

<text:user-field-del>

•

<text:user-field-get>

•

<text:user-field-input>

•

<text:sequence-del>

•

<text:sequence>

When this attribute is being used to specify the name of a variable to display, a variable of the appropriate type with the same name must already have been declared. 2466 2467 2468 2469 2470

1 May 2005 Page 140 of 706

6.7.4 Description The text:description attribute contains a brief message that is displayed when users are prompted for input. This attribute can be used with any of the following elements:

2471 2472 2473 2474 2475 2476 2477

•

<text:placeholder>

•

<text:variable-input>

•

<text:user-field-input>

•

<text:text-input>

6.7.5 Display The text:display attribute supports up to three values as follows: •

value This value displays the value of the field. Some fields do not support this value. In these cases, the text:display attribute only takes the values value or none, and value or formula, respectively.

•

formula This value allows the display of the formula rather than the value of the field. Some fields do not support this value. In these cases, the text:display attribute only takes the values value or none, and value or formula, respectively.

•

none Several variable fields support this value, which hides the field content. This allows variables to be set in one part of the document and displayed in another part of the document.

This attribute can be used with any of the following elements:

2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488

•

<text:variable-set>

•

<text:variable-get>

•

<text:variable-input>

•

<text:user-field-get>

•

<text:expression>

<define name="common-field-display-value-none-attlist"> <optional> <attribute name="text:display"> <choice> <value>value</value> <value>none</value> </choice> </attribute> </optional> </define> <define name="common-field-display-value-formula-none-attlist">

1 May 2005 Page 141 of 706

2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508

<optional> <attribute name="text:display"> <choice> <value>value</value> <value>formula</value> <value>none</value> </choice> </attribute> </optional> </define> <define name="common-field-display-value-formula-attlist"> <optional> <attribute name="text:display"> <choice> <value>value</value> <value>formula</value> </choice> </attribute> </optional> </define>

6.7.6 Formula The text:formula attribute contains the formula or expression used to compute the value of the field. This attribute can be used with any of the following elements: •

<text:variable-set>

•

<text:user-field-del>

•

<text:sequence>

•

<text:expression>

The formula should start with a namespace prefix hat indicates the syntax and semantic used within the formula. 2509 2510 2511 2512 2513 2514 2515

6.7.7 Formatting Style The style:data-style-name attribute refers to the data style used to format the numeric value. For general information about styles, see Chapter 14. For more information about data styles, see section 14.7. For string variables this attribute must be omitted. Otherwise, this attribute is required. The name must match the name of a data style. This attribute can be used with any of the following elements: •

<text:date>

•

<text:time>

•

<text:page-number>

1 May 2005 Page 142 of 706

2516 2517 2518 2519 2520 2521 2522

•

<text:variable-set>

•

<text:variable-get>

•

<text:variable-input>

•

<text:user-field-get>

•

<text:user-field-input>

•

<text:expression>

6.7.8 Number Formatting Style Numbers that are used for number sequences such as page numbers or sequence fields can be formatted according to the number styles described in section 12.2. The number styles supported are as follows: •

Numeric: 1, 2, 3, ...

•

Alphabetic: a, b, c, ... or A, B, C, ...

•

Roman: i, ii, iii, iv, ... or I, II, III, IV,...

Note: The value of this attribute can be any of the [XSLT] number format keys 1, i, I, a, or A. Alphabetic number styles need an additional attribute to determine how to display numbers that cannot be represented by a single letter. The OpenDocument format supports: •

Synchronized letter numbering, where letters are used multiple times, for example aa, bb, cc, and so on.

•

Non-synchronized letter numbering, for example aa, ab, ac, and so on.

See section 12.2 for more information. 2523 2524 2525 2526 2527

1 May 2005 Page 143 of 706

7 Text Indices OpenDocument text documents may contain automatically generated indices. An index generally contains a sorted list of all items of a certain types, where the sorting (document position, alphabetical, etc.) and the type of items (chapter headings, tables, etc.) are determined by the specific type of index.

7.1 Index Marks There are three types of index marks that correspond to the three types of index that make use of index marks. The three types of index marks are: •

Table of content index marks

•

User-defined index marks

•

Alphabetical index marks

The XML code for index marks is similar to the code for Bookmarks and References. The following are some basic rules about index marks: •

Each index mark is represented by a start and an end element.

•

Both elements use an ID attribute to match the appropriate start and end elements.

•

The start and end elements for an index mark must be contained in the same paragraph, with the start element occurring first.

•

The attributes associated with the index mark are attached to the start element.

•

The text between the start and end elements is the text the index entry.

•

The formatting attributes for index marks can overlap.

7.1.1 Table of Content Index Marks The <text:toc-mark-start> element marks the start of a table of content index entry. The ID specified by the text:id attribute must be unique except for the matching index mark end element. There must be an end element to match the start element located in the same paragraph, with the start element appearing first. 2528 2529 2530 2531 2532

The attributes associated with the <text:toc-mark-start> element are:

2533 2534 2535

•

A text:id attribute to allow the start and end elements to be matched.

•

A text:outline-level attribute to specify the outline level of the resulting table of content index entry.

1 May 2005 Page 144 of 706

2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548

</define> <define name="text-outline-level"> <optional> <attribute name="text:outline-level"> <ref name="positiveInteger"/> </attribute> </optional> </define> <define name="text-id"> <attribute name="text:id"> <ref name="string"/> </attribute> </define>

The <text:toc-mark-end> element marks the end of a table of contents index entry. There must be a start element with the same text:id value to match the end element located in the same paragraph, with the start element appearing first. 2549 2550 2551 2552 2553

Table of content index marks also have a variant that does not enclose the text to be indexed. This is represented using the <text:toc-mark> element which contains a text:stringvalue attribute for the text of the index entry. In this situation, a text:id attribute is not necessary because there are no start and end elements to match. 2554 2555 2556 2557 2558 2559 2560 2561

7.1.2 User-Defined Index Marks The <text:user-index-mark-start> element marks the start of a user-defined index entry. The ID specified by the text:id attribute must be unique except for the matching index mark end element. There must be an end element to match the start element located in the same paragraph, with the start element appearing first. 2562 2563 2564 2565 2566 2567 2568

The <text:user-index-mark-end> element marks the end of the user-defined index entry. There must be a start element with the same text:id value to match the end element located in the same paragraph, with the start element appearing first. 2569 2570 2571 2572 2573 2574

1 May 2005 Page 145 of 706

User index marks also have a variant that does not enclose the text to be indexed. This is represented by the <text:user-index-mark> element which contains a text:stringvalue attribute for the text of the index entry. In this situation, the text:id attribute is not necessary because there are no start and end elements to match. 2575 2576 2577 2578 2579 2580 2581 2582 2583

Name of User Index There can be more than one user-defined index. In this case, the user index must be named using the text:index-name attribute. This attribute determines to which user-defined index an index mark belongs. If no name is given, the default user-defined index is used. 2584 2585 2586 2587 2588

7.1.3 Alphabetical Index Mark The <text:alpha-index-mark-start> element marks the start of an alphabetical index entry. There are two optional attributes that may contain keys for alphabetical entries, which allows structuring of entries. There is also a Boolean attribute that determines if this entry is intended to be the main entry, if there are several equal entries. The ID specified by the text:id attribute must be unique except for the matching index mark end element. There must be an end element to match the start element located in the same paragraph, with the start element appearing first. 2589 2590 2591 2592 2593 2594

The attributes associated with the <text:toc-mark-start> element are: •

A text:id attribute to allow the start and end elements to be matched.

•

Additional keys

•

Main entry

The <text:alpha-index-mark-end> element marks the end of an alphabetical index entry. There must be a start element with the same text:id value to match the end element located in the same paragraph, with the start element appearing first. 2595 2596 2597 2598 2599

1 May 2005 Page 146 of 706

Alphabetical index marks also have a variant that does not enclose the text to be indexed. This is represented using the <text:alpha-index-mark> element which contains a text:string-value attribute for the text of the index entry. In this situation, a text:id attribute is not necessary because there are no start and end elements to match. 2600 2601 2602 2603 2604 2605 2606 2607

Additional Keys The text:key1 and text:key2 attributes specify additional keys for the alphabetical index mark. If only one key is used, it must be contained in the text:key1 attribute. 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619

Phonetic Keys For ideographic languages, there sometimes is no obvious or common sorting of the language's characters. One common scheme to facilitate an alphabetical index in such languages is to sort according to a phonetic description of the search time. To achieve this in the OpenDocument file format, there are additional attributes for the string value and the two keys for phonetic descriptions. The original value and key attributes are for display, but if phonetic variants are present, they should be used for sorting the index. 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636

1 May 2005 Page 147 of 706

Main Entry If there are several index marks for the same entry, one of these entries may be declared as the main entry using the text:main-entry attribute. 2637 2638 2639 2640 2641 2642 2643

7.1.4 Bibliography Index Mark The <text:bibliography-mark> element contains the text and information for a bibliography index entry. It supports attributes for each type of bibliographical data that a bibliography index may contain. 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688

<define name="paragraph-content" combine="choice"> <element name="text:bibliography-mark"> <attribute name="text:bibliography-type"> <ref name="text-bibliography-types"/> </attribute> <zeroOrMore> <attribute> <choice> <name>text:identifier</name> <name>text:address</name> <name>text:annote</name> <name>text:author</name> <name>text:booktitle</name> <name>text:chapter</name> <name>text:edition</name> <name>text:editor</name> <name>text:howpublished</name> <name>text:institution</name> <name>text:journal</name> <name>text:month</name> <name>text:note</name> <name>text:number</name> <name>text:organizations</name> <name>text:pages</name> <name>text:publisher</name> <name>text:school</name> <name>text:series</name> <name>text:title</name> <name>text:report-type</name> <name>text:volume</name> <name>text:year</name> <name>text:url</name> <name>text:custom1</name> <name>text:custom2</name> <name>text:custom3</name> <name>text:custom4</name> <name>text:custom5</name> <name>text:isbn</name> <name>text:issn</name> </choice> <ref name="string"/> </attribute> </zeroOrMore> <text/> </element>

1 May 2005 Page 148 of 706

2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715

</define> <define name="text-bibliography-types"> <choice> <value>article</value> <value>book</value> <value>booklet</value> <value>conference</value> <value>custom1</value> <value>custom2</value> <value>custom3</value> <value>custom4</value> <value>custom5</value> <value>email</value> <value>inbook</value> <value>incollection</value> <value>inproceedings</value> <value>journal</value> <value>manual</value> <value>mastersthesis</value> <value>misc</value> <value>phdthesis</value> <value>proceedings</value> <value>techreport</value> <value>unpublished</value> <value>www</value> </choice> </define>

7.2 Index Structure An index consists of two parts: The index source, and the index body. Both of these are contained in an element of their own, which in turn form the two child elements for the index element itself. The index source is specific to the type of index it is being used for. It contains the information necessary to generate the index content. An index source has no graphical rendition. The index body is the same for all types of indices. It contains the text generated from the information in the index source. The text contained in an index body is in no way special or different from text used elsewhere in this specification. The content of the index body can be regenerated at any time from the information contained in the index source and the remainder of the document. One could say that the index source contains all the logical information about an index, while the index body contains the rendition of the index. A tool extracting structure information about a document might look only at the index source, while a rendering program might look only at an index body.

7.2.1 Index Source An index source element contains the information necessary to generate the index body. In addition to a set of flags that determine which information to include in an index, the index source contains a set of index templates. Such a template determines how an item to be contained in the index is to be rendered. For example, a table of content might look as follows: 1 Introduction.......................................................................................................7 1.1 Namespaces..................................................................................................7 1.2 Relax-NG Schema Prefix..............................................................................8

1 May 2005 Page 149 of 706

An index source for this index would contain flags indicating that chapter headers at least up to level 2 are to be included. The contained index templates would define that an entry consists of the chapter number, a space, the chapter name, a tab (with a '.' leader) and the page number. The various index templates are described together with their index elements. The index templates elements in use are described in section 7.12. The different index source elements are described together with their corresponding index elements.

7.2.2 Index Body Section The index body contains the current textual rendition of the index. The format is the same as for regular text within this specification, e.g. text sections, except that it also allows index title sections. 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728

7.2.3 Index Title Section The index title is usually contained in a section of its own. The reason for this enclosure is to enable the popular layout of having an index title across the entire page, but having the index itself in a two column layout. 2729 2730 2731 2732 2733 2734 2735 2736

7.3 Table Of Content A table of contents provides the user with a guide through the content of the document. It is typically found at the beginning of a document, contains the chapter headings with their respective page numbers. An example for a table of content may be found at the beginning of this document. The items that can be listed in a table of content are: •

Headers (as defined by the outline structure of the document), up to a selectable level

•

Table of content index marks

•

Paragraphs formatted with a set of selectable paragraph styles

1 May 2005 Page 150 of 706

The table of contents is represented by the <text:table-of-content> element. The <text:table-of-content> element supports the same style (and class) attributes as a text section (see section 4.4). 2737 2738 2739 2740 2741 2742 2743

7.3.1 Table of Content Source The <text:table-of-content-source> element specifies how the table of contents is generated. It specifies how the entries are gathered. The <text:table-of-content-source> element contains

2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757

•

an optional template for the index title

•

optional templates for index entries, one per level

•

optionally a list of styles to be used for gathering index entries

The attributes that may be associated with the <text:table-of-content-source> element are: •

Outline level

•

Use outline

•

Use index marks

•

Use index source styles

•

Index source

•

Relative tab stop position

Outline Level The text:outline-level attribute specifies which outline levels are used when generating the table of contents. The value of this attribute must be an integer greater than zero. If this attribute is omitted, all outline levels are used by default.

1 May 2005 Page 151 of 706

2758 2759 2760 2761 2762 2763 2764 2765 2766

Use Outline The text:use-outline-level attribute determines whether headings are used to generate index entries. If the value is true, the table of contents includes entries generated from headings. The text:outline-level attribute specifies up to which level headings are being included. See section 7.1 for more information on index marks. 2767 2768 2769 2770 2771 2772 2773

Use Index Marks The text:use-index-marks attribute determines whether or not index marks are used to generate index entries. If the value is true, the table of contents includes entries generated from table of content index marks. The text:outline-level attribute specifies up to which level index marks are being included. See section 7.1 for more information on index marks. 2774 2775 2776 2777 2778 2779 2780

Use Index Source Styles The text:use-index-source-styles attribute determines whether or not index entries are generated for paragraph formatted using certain paragraph styles. If the value is true, the table of contents includes an entry for every paragraph formatted with one of the styles specified in a <text:index-source-style> element. The text:outline-level attribute specifies up to which level index source styles are being included. 2781 2782 2783 2784 2785 2786 2787

1 May 2005 Page 152 of 706

Index Scope The text:index-scope attribute determines whether the table-of-content is generated for the whole document, or only for the current chapter. 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797

<define name="text-table-of-content-source-attlist" combine="interleave"> <optional> <attribute name="text:index-scope"> <choice> <value>document</value> <value>chapter</value> </choice> </attribute> </optional> </define>

Relative Tab-Stop Position The text:relative-tab-stop-position attribute determines whether the position of tab stops is relative to the left margin or to the left indent as determined by the paragraph style. This is useful for copying the same entry configuration for all outline levels because with relative tab stop positions the tabs do not need to be adjusted to the respective paragraph format. 2798 2799 2800 2801 2802 2803 2804

7.3.2 Table of Content Entry Template The <text:table-of-content-entry-template> element determines the format of an index entry for a particular outline level. For each table of content, there must not be more than one element for any outline level. (See below.) 2805 2806 2807 2808 2809

2810 2811 2812 2813

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

A table of content entry template supports the following kinds of text elements:

2814 2815 2816 2817

•

Chapter and Page Number

•

Reference Text

•

Text Span

•

Tab

•

Hyperlink start and end

1 May 2005 Page 153 of 706

2818 2819 2820 2821 2822 2823 2824

The attributes that may be associated associate with the <text:table-of-content-entrytemplate> element are: ● Template outline level ● Paragraph style

Template Outline Level This attribute specifies to which outline level the entry configuration applies. Outline levels must be unique for the template elements in one index source. 2825 2826 2827 2828 2829 2830

Paragraph Style The text:style-name attribute specifies the paragraph style to use for this template. 2831 2832 2833 2834 2835 2836

7.4 Index of Illustrations The index of illustrations lists all images and graphics in the current document or chapter. The index entries can be derived from the caption of the illustration or the name of the illustration. The attribute that may be attached to the <text:illustration-index> element is: •

text:style-name This attribute specifies the section style to use for the index of illustrations.

2837 2838 2839 2840 2841 2842 2843

1 May 2005 Page 154 of 706

7.4.1 Index of Illustration Source The <text:illustration-index-source> element specifies how the index of illustrations is generated. 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854

The attributes that may be associated with a <text:illustration-index-source> element are: •

Use caption

•

Caption sequence name

•

Caption sequence format

•

Index scope This attribute specifies whether the index applies to the entire document or only the the current chapter.

•

text:relative-tab-stop-position This attribute specifies whether the position of tab stops are interpreted relative to the left margin or the left indent.

2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878

<define name="text-illustration-index-source-attrs" combine="interleave"> <ref name="text-index-scope-attr"/> </define> <define name="text-index-scope-attr"> <optional> <attribute name="text:index-scope" a:defaultValue="document"> <choice> <value>document</value> <value>chapter</value> </choice> </attribute> </optional> </define> <define name="text-illustration-index-source-attrs" combine="interleave"> <ref name="text-relative-tab-stop-position-attr"/> </define> <define name="text-relative-tab-stop-position-attr"> <optional> <attribute name="text:relative-tab-stop-position" a:defaultValue="true"> <ref name="boolean"/> </attribute> </optional> </define>

1 May 2005 Page 155 of 706

Use Caption Each object contained in a text document has a name. In addition, images also have a caption. The image caption or the image name can be gathered for the index of illustrations. 2879 2880 2881 2882 2883 2884 2885

Caption Sequence Name Captions are associated with a sequence name. If the text:use-caption attribute is set to true, this attribute must be used to specify the sequence with which the captions are associated. If this attribute is omitted, the default sequence for the object type is used, for example the sequence “Illustration” is used for illustrations. 2886 2887 2888 2889 2890 2891 2892

Caption Sequence Format If the entries for the index of illustrations are obtained from the image captions, this attribute must be used to specify the format for the entries. 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903

<define name="text-illustration-index-source-attrs" combine="interleave"> <optional> <attribute name="text:caption-sequence-format"> <choice> <value>text</value> <value>category-and-value</value> <value>caption</value> </choice> </attribute> </optional> </define>

7.4.2 Illustration Index Entry Template The illustration index entry template element determines the format of an index entry for a particular outline level. 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913

1 May 2005 Page 156 of 706

2914 2915 2916 2917 2918 2919

The attribute that may be associated with the <text:illustration-index-entrytemplate> element is: •

Paragraph style

Paragraph Style This attribute identifies the paragraph style to use for this template. 2920 2921 2922 2923 2924

7.5 Index of Tables The index of tables lists all of the tables in the current document or chapter. It works in exactly the same way as the index of illustrations. 2925 2926 2927 2928 2929 2930 2931

7.5.1 Table Index Source The <text:table-index-source> element specifies how the index of tables is generated. The attributes that may be associated with this element are the same as those that can be associated with the <text:illustration-index-source> element. See section 7.4.1 for detailed information about these attributes. 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942

7.5.2 Table Index Entry Template The table index entry template element determines the format of an index entry for a particular outline level.

1 May 2005 Page 157 of 706

The attributes that may be associated with this element are the same as those that can be associated with the <text:illustration-index-entry-template> element. See section 7.4.2 for detailed information about these attributes. 2943 2944 2945 2946 2947

7.6 Index of Objects The index of objects lists all of the objects in the current document or chapter. It gathers its entries from the known object types. 2948 2949 2950 2951 2952 2953 2954

7.6.1 Object Index Source The <text:object-index-source> element determines which object types to include in the index of objects. It also supports the standard index source attributes. 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965

The attributes that may be associated with the <text:object-index-source> element are: •

Use attributes, text:use-*-objects

•

Index scope (see section 7.4.1) This attribute specifies whether the index applies to the entire document or only the the current chapter.

•

Relative tab stop position (see section 7.4.1) This attribute specifies whether the position of tab stops are interpreted relative to the left margin or the left indent.

2966 2967 2968 2969 2970 2971

1 May 2005 Page 158 of 706

Use Attributes The text:use-*-objects attributes specify which types of objects to include in the index of objects. There is an attribute for each type of object as follows: •

text:use-spreadsheet-objects

•

text:use-draw-objects

•

text:use-chart-objects

•

text:use-math-objects

Other objects are included or omitted using the following attribute: • 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006

text:use-other-objects

7.6.2 Object Index Entry Template The object index entry template element determines the format of an index entry for a particular outline level. 3007 3008 3009 3010 3011

1 May 2005 Page 159 of 706

7.7 User-Defined Index A user-defined index combines the capabilities of the indexes discussed earlier in this chapter. A user-defined index can gather entries from the following sources: •

Index marks

•

Paragraphs formatted using particular paragraph styles

•

Tables, images, or objects

•

Text frames

The <text:user-index> element represents a user-defined index. 3012 3013 3014 3015 3016 3017 3018

7.7.1 User-Defined Index Source The <text:user-index-source> element can contain several attributes that determine how the index entries are gathered. It also supports an attribute that determines how the outline levels of the index entries are gathered. The paragraph formats that are used as index marks are encoded in <text:index-sourcestyles> elements, just like in <text:table-of-content-source> elements. 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032

The attributes that may be associated with <text:user-index-source> elements are: •

Use attributes, text:use-*

•

Copy outline level

•

Index scope (see section 7.4.1) This attribute specifies whether the index applies to the entire document or only to the current chapter.

1 May 2005 Page 160 of 706

•

Index name In order to support several user-defined indexes with different contents, user index marks have a text:index-name attribute. The same attribute can be used with a <text:userindex-source> element to specify which index marks apply to the current index.

•

Relative tab stop position (see section 7.4.1) This attribute specifies whether the position of tab stops are interpreted relative to the left margin or the left indent.

3033 3034 3035 3036 3037 3038 3039

Use Attributes The text:use-* attributes specify which entries to include in the user-defined index. The following attributes exist:

3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067

•

text:use-index-marks

•

text:use-graphics

•

text:use-tables

•

text:use-floating-frames

•

text:use-objects

1 May 2005 Page 161 of 706

Copy Outline Levels This attribute can have a value of true or false. If the value is true, the entries are gathered at the outline level of the source element to which they refer. If the value is false, all index entries gathered are at the top outline level. For example, if an image appears in section 1.2.3, the entry for the image is located at outline level 3. 3068 3069 3070 3071 3072 3073 3074 3075

7.7.2 User-Defined Index Entry Template User index entry templates support entry elements for chapter number, page number, entry text, text spans, and tab stops. 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089

The attributes that may be associated with the <text:user-index-entry-template> elements are: •

Template outline level

•

Paragraph style

Template Outline Level The text:outline-level attribute specifies to which outline level this entry configuration applies. All <text:outline-level> elements that are contained in the same parent element must specify different outline levels. 3090 3091 3092 3093 3094

1 May 2005 Page 162 of 706

Paragraph Style The text:style-name attribute specifies the paragraph style to use for the template. 3095 3096 3097 3098 3099

7.8 Alphabetical Index An alphabetical index gathers its entries solely from index marks. 3100 3101 3102 3103 3104 3105 3106

7.8.1 Alphabetical Index Source The <text:alphabetical-index-source> element specifies how the alphabetical index is generated. 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117

The attributes that may be associated with <text:alphabetical-index-source> elements are: •

Ignore case

•

Main entry style name

•

Alphabetical separators

•

Combine entries attributes

•

Use keys as entries

•

Capitalize entries

•

Comma separated entries

•

Sort language, country and algorithm

•

Index scope (see section 7.4.1) This attribute specifies whether the index applies to the entire document or only to the current chapter.

1 May 2005 Page 163 of 706

•

Relative tab stop position (see section 7.4.1) This attribute specifies whether the position of tab stops are interpreted relative to the left margin or the left indent.

3118 3119 3120 3121

Ignore Case The text:ignore-case attribute determines whether or not the capitalization of words is ignored. If the value is true, the capitalization is ignored and entries that are identical except for character case are listed as the same entries. If the value is false, the capitalization of words is not ignored. 3122 3123 3124 3125 3126 3127 3128

Main Entry Style Name The text:main-entry-style-name attribute determines the character style to use for main entries. Subentries are formatted using the default character style determined by the paragraph style of the entries. 3129 3130 3131 3132 3133 3134 3135

Alphabetical Separators The text:alphabetical-separators attribute determines whether or not entries beginning with the same letter are grouped and separated from the entries beginning with the next letter, and so on. The value of this attribute can be true or false. If the value is true, all entries beginning with the same letter are grouped together. The index contains headings for each section, for example, A for all entries starting with the letter A, B for all entries starting with the letter B, and so on. 3136 3137 3138 3139 3140 3141 3142

1 May 2005 Page 164 of 706

Combining Entries There are several options for dealing with the common situation where there are multiple index entries for the same word or phrase, as follows:

3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160

•

Multiple entries for the same word can be combined into a single entry using the text:combine-entries attribute.

•

The pages referenced by a combined entry can be formatted as: –

As a range of numbers separated by a dash using the text:combine-entrieswith-dash attribute

–

As the start number with a pp label, or the appropriate label for the chosen language, using the text:combine-entries-with-pp attribute

Example: Combining index entries An index mark for the word “XML” occurs on pages 45, 46, 47, and 48. The entries can be formatted as follows:

Entry formatted as

Result

Separate entries

XML 45 XML 46 etc.

Simple combined entries

XML 45, 46, 47, 48

Entries combined with dash XML 45-48 Entries combined with pp

XML 45pp

Use Keys as Entries In addition to a keyword, index marks can have up to two keys. If the value of this attribute is true, the keys are used as additional entries. If the value of this attribute is false, the keys are used as subentries. 3161 3162 3163 3164

1 May 2005 Page 165 of 706

3165 3166 3167

</attribute> </optional> </define>

Capitalize Entries The text:capitalize-entries attribute determines whether or not the entries in the index are to be capitalized. 3168 3169 3170 3171 3172 3173 3174

Comma Separated Entries The text:comma-separated attribute specifies how to treat multiple index entries. Instead of listing each index entry on a separate line, multiple entries can be listed on a single line separated by a comma. If the value of this attribute is true, multiple entries are listed on a single line separated by a comma. By default, the value of this attribute is false and each index entry is displayed on a separate line. 3175 3176 3177 3178 3179 3180 3181

Sort country, Language, and Algorithm If index entries are to be sorted, these attributes can be used to specify the sorting. The attributes country and language specify the sorting locale. For some locales, there are multiple sorting algorithms in use. In this case, the algorithm attribute can be used to specify an algorithm by name. 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202

1 May 2005 Page 166 of 706

7.8.2 Auto Mark File The alphabetical index supports a so-called auto mark file. Such a file contains a list of terms, and each occurrence of such a term is to be included in the alphabetical index. The alphabetical index mark file is declared as part of the text declarations (see section 4.7). The declaration element in an XLink, which points to the resource containing the list of terms. 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214

<define name="text-alphabetical-index-auto-mark-file"> <element name="text:alphabetical-index-auto-mark-file"> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> <optional> <attribute name="xlink:type" a:defaultValue="simple"> <value>simple</value> </attribute> </optional> </element> </define>

7.8.3 Alphabetical Index Entry Template Alphabetical indexes support three levels; one level for the main index entry, and up to two additional levels for keys associated with the index entries. Alphabetical indexes also use an entry template for the alphabetical separator. 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228

The attributes that may be associated with the <text:alphabetical-index-entrytemplate> elements are: •

Template outline level

•

Paragraph style

Template Outline Level This attribute specifies whether the template applies to: •

One of the three levels 1,2,or 3

or • 3229 3230 3231 3232

The alphabetical separator

1 May 2005 Page 167 of 706

3233 3234 3235 3236 3237 3238 3239

<value>1</value> <value>2</value> <value>3</value> <value>separator</value> </choice> </attribute> </define>

Paragraph Style The text:style-name attribute specifies the paragraph style to use for the template. 3240 3241 3242 3243 3244 3245

7.9 Bibliography A bibliography index gathers its entries from bibliography index marks. The <text:bibliography> element represents a bibliography. 3246 3247 3248 3249 3250 3251 3252

7.9.1 Bibliography Index Source The <text:bibliography-source> element specifies how the bibliography is generated. 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262

7.9.2 Bibliography Entry Template Bibliography entry templates support entry elements for bibliography data, text spans, and tab stops. There is one entry template element for each type of entry. 3263 3264 3265 3266 3267 3268 3269 3270 3271

1 May 2005 Page 168 of 706

3272 3273 3274

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

The attributes that may be associated with the <text:bibliography-entry-template> elements are: •

Bibliography type

•

Paragraph style

Bibliography Type This attribute specifies to which type of bibliographical entry the template applies. This attribute must be unique among all <text:bibliography-type> elements within the same parent element. 3275 3276 3277 3278 3279

Paragraph Style The text:style-name attribute specifies the paragraph style to use for this template. 3280 3281 3282 3283 3284

7.10 index source styles Some indices can gather index entries from paragraphs formatted using certain paragraph styles. The <text:index-source-styles> element contains all of the <text:indexsource-style> elements for a particular outline level. The text:outline-levels attribute determines at which outline level to list the index entries gathered from the respective paragraph styles. There can only be one <text:index-source-style> element for each outline level. 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294

7.10.1 Index source style All paragraphs formatted using the style or class specified in the <text:index-sourcestyle> element are included in the index. 3295 3296 3297

1 May 2005 Page 169 of 706

3298 3299 3300 3301 3302

7.11 Index title template The <text:index-title-template> element determines the style and content of the index title. There can only be one <text:index-title-template> element contained in a <text:table-of-content-source> element. 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312

7.12 Index Template Entries There are eight types of index entries, as follows: •

Chapter information

•

Entry text

•

Page number

•

Fixed string

•

Bibliography information

•

Tab stop

•

Hyperlink start and end

7.12.1 Chapter Information The <text:index-entry-chapter> element displays the chapter number of the index entry. The character style for the chapter number can be included in the index entry element as a text:style-name attribute. 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322

Note: This element can only display the chapter number. To display the chapter name, the <text:index-entry-text> elements must be used.

1 May 2005 Page 170 of 706

Display Chapter Format The text:display attribute displays either the chapter number, the chapter name, or both. 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333

<define name="text-index-entry-chapter-attrs"> <optional> <attribute name="text:display" a:defaultValue="number"> <choice> <value>name</value> <value>number</value> <value>number-and-name</value> </choice> </attribute> </optional> </define>

7.12.2 Entry Text The <text:index-entry-text> element displays the text of the index entry, for example, the chapter name if the entry is derived from a header or the phrase contained in the index mark if the entry is derived from an index mark. The character style for the entry text can be included in the index entry element as a text:style-name attribute. 3334 3335 3336 3337 3338 3339 3340 3341 3342

7.12.3 Page Number The <text:index-entry-page-number> element displays the page number on which the index entry is located. The character style for the page number can be included in the index entry element as a text:style-name attribute. 3343 3344 3345 3346 3347 3348 3349 3350 3351

7.12.4 Fixed String The <text:index-entry-span> element represents a fixed string within an index entry. The character style for the entry text can be included in the index entry element as a text:stylename attribute. Unlike the <text:span> element, the <text:index-entry-span> element does not have any child elements. 3352 3353 3354 3355 3356

1 May 2005 Page 171 of 706

3357 3358 3359 3360 3361

</attribute> </optional> <text/> </element> </define>

7.12.5 Bibliography Information The <text:index-entry-bibliography> element introduces bibliography data into index entry templates. 3362 3363 3364 3365 3366

The attributes that may be associated with the <text:index-entry-bibliography> element are: •

text:style-name attribute

•

text:bibliography-data-field attribute

Text Style Name The text:style-name attribute determines the style for display of the entry. 3367 3368 3369 3370 3371 3372 3373

Bibliography Data Field Identifier The text:bibliography-data-field attribute determines which part of the bibliography data field will be displayed. 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394

<define name="text-index-entry-bibliography-attrs" combine="interleave"> <attribute name="text:bibliography-data-field"> <choice> <value>address</value> <value>annote</value> <value>author</value> <value>bibliography-type</value> <value>booktitle</value> <value>chapter</value> <value>custom1</value> <value>custom2</value> <value>custom3</value> <value>custom4</value> <value>custom5</value> <value>edition</value> <value>editor</value> <value>howpublished</value> <value>identifier</value> <value>institution</value> <value>isbn</value> <value>issn</value>

1 May 2005 Page 172 of 706

3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411

<value>journal</value> <value>month</value> <value>note</value> <value>number</value> <value>organizations</value> <value>pages</value> <value>publisher</value> <value>report-type</value> <value>school</value> <value>series</value> <value>title</value> <value>url</value> <value>volume</value> <value>year</value> </choice> </attribute> </define>

7.12.6 Tab Stop The <text:index-entry-tab-stop> element represents a tab stop within an index entry. It also contains the position information for the tab stop. 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421

The attributes that may be associated with the <text:index-entry-tab-stop> element are: •

style:leader-char

•

style:type

•

style:position

Leader Char The style:leader-char attribute specifies the leader character. 3422 3423 3424 3425 3426 3427 3428

Tab Type and Position The style:type attribute specifies the tab stop type. The <text:index-entry-tab-stop> element only supports two types of tab: left and right. If the value of this attribute is left, the style:position attribute must also be used. Otherwise, this attribute must be omitted. The style:position attribute specifies the position

1 May 2005 Page 173 of 706

of the tab. Depending on the value of the text:relative-tab-stop-position attribute in the <text:index-entry-config> element, the position of the tab is interpreted as being relative to the left margin or the left indent. 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443

<define name="text-index-entry-tab-stop-attrs" combine="interleave"> <choice> <attribute name="style:type"> <value>right</value> </attribute> <group> <attribute name="style:type"> <value>left</value> </attribute> <attribute name="style:position"> <ref name="length"/> </attribute> </group> </choice> </define>

7.12.7 Hyperlink Start and End The <text:index-entry-link-start> and <text:index-entry-link-end> elements mark the start and end of a hyperlink index entry. The character style for the hyperlink can be included in the index entry element as a text:style-name attribute. 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461

7.12.8 Example of an Index Entry Configuration The following is an example of the XML code for a table of contents called Table of Content with the following characteristics: •

It uses the top two outline levels.

•

Each entry consists of the chapter number, a closing parenthesis, the chapter title, a tab stop, and the page number.

•

For the top outline level, the page number is formatted using a style called Bold.

•

For the second outline level, a bracket is used instead of a closing parenthesis. Example: Table of Content <text:table-of-content> <text:table-of-content-source text:outline-level="2"

1 May 2005 Page 174 of 706

text:use-index-marks="false" text:index-scope="document"> <text:index-title-template text:style-name="Index 1"> Table of Content </text:index-title-template> <text:index-entry-template text:ouline-level="1" text:style-name="Contents 1"> <text:index-entry-chapter text:display="number"/> <text:index-entry-span>) </text:index-entry-span> <text:index-entry-text/> <text:index-entry-tab-stop style:type="right"/> <text:index-entry-page-number text:style-name="bold"/> </text:index-entry-template> <text:index-entry-template text:ouline-level="2" text:style-name="Contents 2"> <text:index-entry-chapter text:display="number"/> <text:index-entry-span>] </text:index-entry-span> <text:index-entry-text/> <text:index-entry-tab-stop style:type="right"/> <text:index-entry-page-number/> </text:index-entry-template> </text:table-of-content-source> <text:table-of-content-body> [... header ...] <text:p text:style-name="[...]">1) Chapter <text:tab-stop/><text:span stylename="bold"> 1 </text:span> </text:p> <text:p text:style-name="[...]">1.1] Subchapter <text:tab-stop/>1 </text:p> [... more entries ...] </text:table-of-content-body> </text:table-of-content>

1 May 2005 Page 175 of 706

8 Tables This chapter describes the table structure that is used for tables that are embedded within text documents and for spreadsheets.

8.1 Basic Table Model The structure of OpenDocument tables is similar to the structure of [HTML4] or [XSL] tables, and like these tables, they can be nested. The representation of tables is based on a grid of rows and columns. Rows take precedence over columns. The table is divided into rows and the rows are divided into cells. Each column includes a column description, but this description does not contain any cells. Table rows may be empty, and different rows might contain a different number of table cells. This is not an error, but applications might resolve this in different ways. Spreadsheet applications typically operate on large tables that have a fixed application dependent row and column number, but may have an unused area. Only the used area of the table is saved in files. When loading a table with empty or incomplete rows into a spreadsheet application, empty rows typically introduce a default row (just as in an empty sheet), and incomplete rows are filled with empty cells (just like in an empty sheet). All other applications typically have fixed size tables. Incomplete rows are basically rendered as if they had the necessary number of empty cells, and the same applies to empty rows. Empty cells typically occupy the space of an empty paragraph. Rows and columns appear in row groups and column groups. These groups specify whether or not to repeat a row or column on the next page.

8.1.1 Table Element The table element is the root element for tables. 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483

The content models for tables is rather complex. The details are explained in the section 8.2. For the moment, it can be assumed that table element's content are columns and row elements.

1 May 2005 Page 176 of 706

3484 3485 3486 3487 3488 3489 3490 3491

3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511

3512 3513 3514 3515 3516 3517 3518 3519 3520

3521 3522 3523 3524 3525 3526 3527 3528 3529

3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549

1 May 2005 Page 177 of 706

3550 3551 3552 3553 3554 3555 3556 3557 3558

Table Name The table:name attribute specifies the name of a table. 3559 3560 3561 3562 3563 3564 3565

Table Style The table:style-name attribute references a table style, i.e. an <style:style> element of type “table”. The table style describes the formatting properties of the table, such as width and background color. The table style can be either an automatic or common style. 3566 3567 3568 3569 3570 3571 3572

Example: Table Style <style:style style:name="Table 1" style:family="table"> <style:table-properties style:width="12cm" fo:background-color="light-grey"/> </style:style> <table:table table:name="Table 1" table:style-name="Table 1"> ... </table:table>

Protected The table:protected attribute specifies whether or not a table is protected from editing. If the table is protected, the table:protection-key attribute can specify a password to prevent a user from resetting the protection flag to enable editing. If a table is protected, all of the table elements and the cell elements with a style:cell-protect attribute set to true are protected. To avoid saving the password directly into the XML file, only a hash value of the password is stored within the table:protection-key attribute. 3573 3574 3575 3576

1 May 2005 Page 178 of 706

3577 3578 3579 3580 3581 3582 3583 3584

</attribute> </optional> <optional> <attribute name="table:protection-key"> <text/> </attribute> </optional> </define>

Print The table:print attribute specifies if a table is printed. It takes a Boolean value. If its value is true, the table is printed, if its value is false, the table is not printed. The default value is true. The table:print attribute will be overwritten by the table:display attribute described in section 15.8.14. That is, if the table is not displayed, it also will not be printed. If the table is printed, the table range that actually is printed can be specified by table:printrange attribute (see following section). If this attribute is not existing, the used area of the table will be printed. 3585 3586 3587 3588 3589 3590 3591

Print Ranges The table:print-ranges attribute specifies the print ranges of the table, i.e. the cells that should be printed. It contains a list of cell addresses or cell range addresses as described in section 8.3.1. 3592 3593 3594 3595 3596 3597 3598

8.1.2 Table Row The <table:table-row> element represents a row in a table. It content are elements that specify the cells of the table row. The <table:table-row> element is similar to the [XSL] <fo:table-row> element. 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609

1 May 2005 Page 179 of 706

Number of Rows Repeated The table:number-rows-repeated attribute specifies the number of rows to which a row element applies. If two or more rows are adjoining, and have the same content and properties, and do not contain vertically merged cells, they may be described by a single <table:tablerow> element that has a table:number-rows-repeated attribute with a value greater than 1. 3610 3611 3612 3613 3614 3615 3616

Row Style A table row style stores the formatting properties of a table row, such as height and background color. A row style is defined by a <style:style> element with a family attribute value of table-row. The table row style can be either an automatic or a common style. It is referenced by the table row's table:style-name attribute. 3617 3618 3619 3620 3621 3622 3623

Default Cell Style The table:default-cell-style-name attribute specifies an default cell style. Cells contained in the row without an individual cell style use these default cell style. 3624 3625 3626 3627 3628 3629 3630

Visibility The table:visibility attribute specifies whether the row is visible, filtered, or collapsed. Filtered and collapsed rows are not visible. Filtered rows are invisible, because a filter is applied to the table that does not select the table row. Collapsed rows have been made invisible by invisible in the UI directly. 3631 3632 3633 3634 3635 3636 3637

3638 3639

1 May 2005 Page 180 of 706

3640 3641 3642 3643 3644 3645

<choice> <value>visible</value> <value>collapse</value> <value>filter</value> </choice> </define>

Example: Table with three rows and three columns This example shows the OpenDocument code for a table with three rows and three columns. The first two rows of the table have a blue background. <style:style style:name="Table 1" style:family="table"> <style:table-properties style:width="12cm" fo:background-color="light-grey"/> </style:style> <style:style style:name="Col1" style:family="table-column"> <style:table-column-properties style:column-width="2cm"/> </style:style> <style:style style:name="Col2" style:family="table-column"> <style:table-column-properties style:column-width="4cm"/> </style:style> <style:style style:name="Col3" style:family="table-column"> <style:table-column-properties style:column-width="6cm"/> </style:style> <style:style style:name="Row1" style:family="table-row"> <style:table-row-properties fo:background-color="blue"/> </style:style> <table:table table:name="Table 1" table:style-name="Table 1"> <table:table-columns> <table:table-column table:style-name="Col1"/> <table:table-column table:style-name="Col2"/> <table:table-column table:style-name="Col3"/> </table:table-columns> <table:table-rows> <table:table-row table:style-name="Row1"> ... </table:table-row> <table:table-row table:style-name="Row1"> ... </table:table-row> <table:table-row> ... </table:table-row> <table:table-rows> </table:table>

8.1.3 Table Cell The <table:table-cell> and <table:covered-table-cell> elements specify the content of a table cells. They are contained in table row elements. A table cell can contain paragraphs and other text content as well as sub tables. Table cells may be empty. The <table:table-cell> element is very similar to the table cell elements of [XSL] and [HTML4], and the rules regarding cells that span several columns or rows that exist in HTML and XSL apply to the OpenDocument specification as well. This means that there are no <table:table-cell> elements in the row/column grid for positions that are covered by a merged cell, that is, that are covered by a cell that spans several columns or rows. To be able to specify cells for such positions as well, the <table:covered-table-cell> element exists. It has to appear wherever a position in the row/column grid is covered by a cell spans several rows or columns. Its position in the grid is calculated by a assuming a column and row span of 1 for all cells regardless whether they are specified by a <table:table-cell> or a

1 May 2005 Page 181 of 706

<table:covered-table-cell> element. The <table:covered-table-cell> is especially used by spreadsheet applications, where it is a common use case that a covered cell contains content. 3646 3647 3648 3649 3650 3651 3652

3653 3654 3655 3656 3657 3658 3659

3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674

Number of Cells Repeated The table:number-columns-repeated attribute specifies the number of successive columns in which a cell is repeated. It can be used to describe two or more adjoining cells with a single cell element, if they meet the following conditions: •

The cells contain the same content and properties.

•

The cells are not merged horizontally or vertically.

In this case, a table:number-columns-repeated attribute must be used to specify the number of successive columns in which the cell is repeated. This attribute is specified with either the <table:table-cell> element or the <table:covered-table-cell> element. 3675 3676 3677 3678 3679 3680 3681

Number of Rows and Columns Spanned These attributes specify the number of rows and columns that a cell spans. These attributes cane be used with the <table:table-cell> element only.

1 May 2005 Page 182 of 706

When a cell covers another cell because of a column or row span value greater than one, a <table:covered-table-cell> element must appear in the table to represent the covered cell. 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693

Cell Style A table cell style stores the formatting properties of a cell, such as the following: •

Background color

•

Number format

•

Vertical alignment

•

Borders

The table cell style can be either an automatic or a common style. The style is specified with a table:style-name attribute. If a cell does not have a cell style assigned, the application checks if a the current row has a default cell style assigned. If the current row does not have a default cell assigned style as well, the application checks if the current column has a default cell style assigned. 3694 3695 3696 3697 3698 3699 3700

Cell Content Validation The table:content-validation-name attribute specifies if a cell contains a validity check. The value of this attribute is the name of a <table:cell-content-validation> element. If the attribute is not present, the cell may have arbitrary content. 3701 3702 3703 3704 3705 3706 3707

See section 8.5.3 for more information on cell content validation and the <table:cellcontent-validation> element.

1 May 2005 Page 183 of 706

Formula Formulas allow calculations to be performed within table cells. Every formula should begin with a namespace prefix specifying the syntax and semantics used within the formula. Typically, the formula itself begins with an equal (=) sign and can include the following components: •

Numbers.

•

Text.

•

Named ranges.

•

Operators.

•

Logical operators.

•

Function calls.

•

Addresses of cells that contain numbers. The addresses can be relative or absolute, see section 8.3.1. Addresses in formulas start with a “[“ and end with a “]”. See sections 8.3.1 and 8.3.1 for information about how to address a cell or cell range.

The following is an example of a simple formula: =sum([.A1:.A5]) This formula calculates the sum of the values of all cells in the range “.A1:.A5”. The function is “sum”. The parameters are marked by a “(“ at the start and a “)” at the end. If a function contains more than one parameter, the parameters are separated by a “;”. The following is a variation of the formula shown above: =sum([.A1];[.A2];[.A3];[.A4];[.A5]) The result of this formula is the same. The components used in the formula depend on the application being used. The table:formula attribute contains a formula for a table cell. 3708 3709 3710 3711 3712 3713 3714

In addition to this, the calculated value of the formula is available as well. One of the following attributes represents the current value of the cell: •

office:value

•

office:date-value

•

office:time-value

•

office:boolean-value

•

office:string-value

1 May 2005 Page 184 of 706

Matrix When an application is performing spreadsheet calculations, a connected range of cells that contains values is called a matrix. If the cell range contains m rows and n columns, the matrix is called an m x n matrix. The smallest possible matrix is a 1 x 2 or 2 x 1 matrix with two adjacent cells. To use a matrix in a formula, include the cell range address of the matrix in the formula. In a matrix formula, only special matrix operations are possible. The number of rows and columns that a matrix spans are represented by the table:numbermatrix-rows-spanned and table:number-matrix-columns-spanned attributes, which are attached to the cell elements. 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726

Value Type The table:value-type attribute specifies the type of value that can appear in a cell. It may contain one of the following values:

3727 3728 3729 3730 3731

•

float, percentage or currency (numeric types)

•

date

•

time

•

boolean

•

string

Cell Current Numeric Value The office:value attribute specifies the current numeric value of a cell. This attribute is only evaluated for cells that contain the following data types: •

float

•

percentage

•

currency

1 May 2005 Page 185 of 706

Cell Current Currency The tableoffice:currency attribute specifies the current currency value of a cell. The value of this attribute is usually currency information such as DEM or EUR. This attribute is only evaluated for cells whose data type is currency.

Cell Current Date Value The office:date-value attribute specifies the current date value of a cell. This attribute is only evaluated for cells whose data type is date. Some application support date and time values in addition to dates.

Cell Current Time Value The office:time-value attribute specifies the current time value of a cell. This attribute is only evaluated for cells whose data type is time.

Cell Current Boolean Value The office:boolean-value attribute specifies the current Boolean value of a cell. This attribute is only evaluated for cells whose data type is boolean.

Cell Current String Value The office:string-value attribute specifies the current string value of a cell. This attribute is only evaluated for cells whose data type is string.

Table Cell Protection The table:protected attribute protects the table cells. Users can not edit the content of a cell that is marked as protected. 3732 3733 3734 3735 3736 3737 3738

This attribute is not related to the table:protected attribute for table elements (see section 8.1.1) and the table:cell-protect attribute for table cell styles (see section 15.11.14).

8.2 Advanced Table Model 8.2.1 Column Description Every column in a table has a column description element <table:table-column>. It is similar to the [XSL] <fo:table-column> element, and it's primary use is to reference a table column style that for instance specifies the table column's width. 3739 3740

1 May 2005 Page 186 of 706

3741 3742 3743 3744

Number of Columns Repeated The table:number-columns-repeated attribute specifies the number of columns to which a column description applies. If two or more columns are adjoining, and have the same properties, this attribute allows to describe them with a single <table:table-column> element. 3745 3746 3747 3748 3749 3750 3751

Column Style A table column style stores the formatting properties of a table column, such as width and background color. It is specified by a <style:style> element with a family attribute value of table-column and can be either an automatic or a common style. The style of a column is specified using a table:style-name attribute. 3752 3753 3754 3755 3756 3757 3758

Visibility The table:visibility attribute specifies whether the column is visible, filtered, or collapsed. See section 8.1.2 for more details. 3759 3760 3761 3762 3763 3764 3765

Default Cell Style The table:default-cell-style-name attribute specifies the default cell style. Cells without a style use this style when there is no default cell style specified for the cell's row as well. 3766 3767 3768 3769 3770 3771 3772

1 May 2005 Page 187 of 706

This example shows the OpenDocument code for a table with three columns. <style:style style:name="Table 1" style:family="table"> <style:table-properties style:width="12cm" fo:background-color="light-grey"/> </style:style> <style:style style:name="Col1" style:family="table-column"> <style:table-column-properties style:column-width="2cm"/> </style:style> <style:style style:name="Col2" style:family="table-column"> <style:table-column-properties style:column-width="4cm"/> </style:style> <style:style style:name="Col3" style:family="table-column"> <style:table-column-properties style:column-width="6cm"/> </style:style> <table:table table:name="Table 1" table:style-name="Table 1"> <table:table-columns> <table:table-column table:style-name="Col1"/> <table:table-column table:style-name="Col2"/> <table:table-column table:style-name="Col3"/> </table:table-columns> ... </table:table>

8.2.2 Header Columns If a table does not fit on a single page, a set of adjacent table columns can be automatically repeated on every page. To do so, their columns descriptions have to be included in a <table:table-header-columns> element. Descriptions of columns that shall not be repeated on every page can be included into a <table:table-columns> element, but don't have to. A table must not contain more than one <table:table-header-columns> element, and a <table:table-columns> must not follow another <table:table-columns> element. The only exception are tables that contain grouped columns (see 8.2.3). Such tables contain more than one <table:table-header-columns> element, provided that they are contained in different column groups and the columns contained in the elements are adjacent. Applications that do not support header columns have to process header column descriptions the same way as non header column descriptions. The <table:table-header-columns> and <table:table-columns> element are very similar to [HTML4]'s <THEAD> and <TBODY> elements for rows. 3773 3774 3775 3776 3777 3778 3779

3780 3781 3782 3783 3784 3785 3786 3787

1 May 2005 Page 188 of 706

8.2.3 Column Groups Adjacent table columns can be grouped with the <table:table-column-group> element. Every group can contain a new group, columns, and column headers. A column group can be visible or hidden. Column groups can for instance used by spreadsheet applications to group columns that are summarized, so that the individual columns that contribute to the sum can be made invisible easily, but the sum remains visible. If a set of header columns and a column group overlap, the header column group breaks the column header set. That is, the <table:table-column-group> may contain <table:table-header-columns> elements, but not vice versa. 3788 3789 3790 3791 3792 3793

Display The table:display attribute specifies whether or not the group is visible. 3794 3795 3796 3797 3798 3799 3800

8.2.4 Header Rows If a table does not fit on a single page, a set of adjacent table rows can be automatically repeated on every page. To do so, their row elements have to be included in a <table:tableheader-rows> element. Rows that shall not be repeated on every page can be included into a <table:table-rows> element, but don't have to. A table must not contain more than one <table:table-header-rows> element, and a <table:table-rows> must not follow another <table:table-rows> element. The only exception are tables that contain grouped rows (see 8.2.5). Such tables contain more than one <table:table-header-rows> element, provided that they are contained in different row groups and the rows contained in the elements are adjacent. Applications that do not support header rows have to process header rows the same way as non header rows. The <table:table-header-rows> and <table:table-rows> element are very similar to [HTML4]'s <THEAD> and <TBODY> elements. 3801 3802 3803 3804 3805 3806 3807

3808 3809 3810 3811

1 May 2005 Page 189 of 706

3812 3813 3814 3815

8.2.5 Row Groups Adjacent table rows can be grouped with the <table:table-row-group> element. Every group can contain a new group, rows, and row headers. A row group can be visible or hidden. Row groups can for instance used by spreadsheet applications to group rows that are summarized, so that the individual rows that contribute to the sum can be made invisible easily, but the sum remains visible. If a set of header rows and a row group overlap, the header row group breaks the row header set. That is, the <table:table-row-group> may contain <table:table-header-rows> elements, but not vice versa. 3816 3817 3818 3819 3820 3821

Display The table:display attribute specifies whether or not the group is visible. 3822 3823 3824 3825 3826 3827 3828

8.2.6 Subtables If a table cell only contains a single table but no paragraphs or other content, this table can be specified as subtable. It then occupies the whole cell and no other content can appear in this cell. The borders of a subtable merge with the borders of the cell that it resides in. A subtable does not contain any formatting properties. A subtable is essentially a container for some additional table rows that integrate seamlessly with the parent table. A nested table is turned into a subtable with the attribute table:is-subtable that is attached to the table element. A nested table that is not a specified to be a subtable appears as a table within a table, that is, it has borders distinct from those of the parent cell and respects the padding of the parent cell. 3829 3830 3831 3832 3833 3834 3835

1 May 2005 Page 190 of 706

Example of Representation of subtable In the OpenDocument schema, this table can be represented in either of the ways detailed in Sample 1 and Sample 2. A1 A2

B1 B2.1.1

C1 B2.2.1

B2.1.2 Sample 1 Using cells that span several rows, the preceding table is specified as follows: <style:style style:name="Table 1" style:family="table"> <style:table-properties style:width="12cm" fo:background-color="light-grey"/> </style:style> <style:style style:name="Col1" style:family="table-column"> <style:table-column-properties style:column-width="2cm"/> </style:style> <style:style style:name="Col2" style:family="table-column"> <style:table-column-properties style:column-width="4cm"/> </style:style> <style:style style:name="Col3" style:family="table-column"> <style:table-column-properties style:column-width="6cm"/> </style:style> <style:style style:name="Row1" style:family="table-row"> <style:table-row-properties fo:background-color="grey"/> </style:style> <style:style style:name="Cell1" style:family="table-cell"> <style:table-cell-properties fo:background-color="grey"/> </style:style> <table:table table:name="Table 1" table:style-name="Table 1"> <table:table-columns> <table:table-column table:style-name="Col1"/> <table:table-column table:style-name="Col2"/> <table:table-column table:style-name="Col3"/> </table:table-columns> <table:table-header-rows> <table:table-row table:style-name="Row1"> <table:table-cell> <text:p text:style="Table Caption"> A1 </text:p> </table:table-cell> <table:table-cell> <text:p text:style="Table Caption"> B1 </text:p> </table:table-cell> <table:table-cell> <text:p text:style="Table Caption"> C1 </text:p> </table:table-cell> </table:table-row> </table:table-header-rows> <table:table-rows> <table:table-row> <table:table-cell table:number-rows-spanned="2" table:style-name="Cell1"> <text:p text:style="Table Body"> A2 </text:p>

1 May 2005 Page 191 of 706

</table:table-cell> <table:table-cell> <text:p text:style="Table Body"> B2.1.1 </text:p> </table:table-cell> <table:table-cell> <text:p text:style="Table Body"> B2.2.1 </text:p> </table:table-cell> </table:table-row> <table:table-row> <table:covered-table-cell/> <table:table-cell table:number-columns-spanned="2"> <text:p text:style="Table Body"> B2.1.2 </text:p> </table:table-cell> <table:covered-table-cell/> </table:table-row> </table:table-rows> </table:table>

Sample 2 Using sub tables, the preceding table is specified as follows: <style:style style:name="Table 1" style:family="table"> <style:table-properties fo:width="12cm" fo:background-color="lightgrey"/> </style:style> <style:style style:name="Col1" style:family="table-column"> <style:table-column-properties style:column-width="2cm"/> </style:style> <style:style style:name="Col2" style:family="table-column"> <style:table-column-properties style:column-width="4cm"/> </style:style> <style:style style:name="Col3" style:family="table-column"> <style:table-column-properties style:column-width="6cm"/> </style:style> <style:style style:name="Row1" style:family="table-row"> <style:table-row-properties fo:background-color="grey"/> </style:style> <style:style style:name="Cell1" style:family="table-cell"> <style:table-cell-properties fo:background-color="grey"/> </style:style> <table:table table:name="Table 1" table:style-name="Table 1"> <table:table-columns> <table:table-column table:style-name="Col1"/> <table:table-column table:style-name="Col2"/> <table:table-column table:style-name="Col3"/> </table:table-columns> <table:table-header-rows> <table:table-row table:style-name="Row1"> <table:table-cell> <text:p text:style="Table Caption"> A1 </text:p> </table:table.cell> <table:table-cell> <text:p text:style="Table Caption"> B1 </text:p> </table:table-cell> <table:table-cell>

1 May 2005 Page 192 of 706

<text:p text:style="Table Caption"> C1 </text:p> </table:table-cell> </table:table-row> </table:table-header-rows> <table:table-rows> <table:table-row> <table:table-cell table:style-name="Cell1"> <text:p text:style="Table Body"> A2 </text:p> </table:table-cell> <table:table-cell table:number-columns-spanned="2"> <table:table is-subtable="true"> <table:table-columns> <table:table-column table:style-name="Col2"/> <table:table-column table:style-name="Col3"/> </table:table-columns> <table:rows> <table:row> <table:table-cell> <text:p text:style="Table Body"> B2.1.1 </text:p> </table:table-cell> <table:table-cell> <text:p text:style="Table Body"> B2.2.1 </text:p> </table:table-cell> </table:table-row> <table:table-row> <table:table-cell table:number-columns-spanned="2"> <text:p text:style="Table Body"> B2.1.2 </text:p> </table:table-cell> <table:covered-table-cell/> </table:table-row> </table:table-rows> </table:table> </table:table-cell> <table:covered-table-cell/> </table:table-row> </table:table-rows> </table:table>

8.3 Advanced Tables 8.3.1 Referencing Table Cells To reference table cells so called cell addresses are used. The structure of a cell address is as follows: 1. The name of the table. 2. A dot (.). 3. An alphabetic value representing the column. The letter A represents column 1, B represents column 2, and so on. AA represents column 27, AB represents column 28, and so on.

1 May 2005 Page 193 of 706

4. A numeric value representing the row. The number 1 represents the first row, the number 2 represents the second row, and so on. This means that A1 represents the cell in column 1 and row 1. B1 represents the cell in column 2 and row 1. A2 represents the cell in column 1 and row 2. For example, in a table with the name SampleTable the cell in column 34 and row 16 is referenced by the cell address SampleTable.AH16. In some cases it is not necessary to provide the name of the table. However, the dot must be present. When the table name is not required, the address in the previous example is .AH16. The structure of the address of a cell in a subtable is as follows: 1. The address of the cell that contains the subtable. 2. A dot (.). 3. The address of the cell in the subtable. For example, to reference the cell in column 1 and row 1 in a subtable that is called Subtable, and that is in column 34 and row 16 of the table SampleTable, the address is SampleTable.AH16.A1. If the name of the table contains blanks, the name should be quoted with apostrophes (').

Absolute and relative cell addressing Cells can be referenced by using either absolute addresses or relative addresses. When an operation is performed on a table cell, for example when a formula is copied, absolute cell references do not change; In contrast to this, relative cell references are adapted to the address of target cell of the copy operation. The previous example uses relative addressing. To create an absolute address, a dollar sign ($) has to be placed before each table name, column reference, and row reference. For example, the absolute address of the previous example is $SampleTable.$AH$16. Absolute and relative references can be mixed within a single cell address. For example, SampleTable.AH$16 refers to a relative table and column, but to an absolute row. Absolute addresses must contain a table name. The differentiation between absolute and relative addressing is only necessary in some situations. Where a differentiation is not required, a cell reference without the dollar signs is used. 3836 3837 3838 3839 3840 3841

Cell Range Address A cell range is a number of adjacent cells forming a rectangular shape. The rectangle stretches from the cell on the top left to the cell on the bottom right. A cell range address references a cell range. It is constructed as follow: 1. The address of the cell at the top left of the range. 2. A colon (:). 3. The address of the cell at the bottom right of the range.

1 May 2005 Page 194 of 706

For example, the address .A1:.B2 references the cell range of cells from column 1 and row 1 to column 2 and row 2. The smallest range one can specify is a single cell. In this case, the range address is the same as the cell address. 3842 3843 3844 3845 3846 3847

Cell Range Address List A cell range address list is a list of cell ranges and cell addresses. Each item in the list is separated by a space. If table names used in the list contain a blank character, the table name has to be quoted within apostrophes ('). 3848 3849 3850 3851

8.3.2 Linked Tables If a table is linked to an original table, the information about the source table is contained in a <table:table-source> element. The attributes that may be associated with the <table:table-source> element are:

3852 3853 3854 3855 3856 3857 3858

•

Mode

•

Table name

•

URL

•

Filter name

•

Filter options

•

Refresh delay

Mode The table:mode attribute specifies what data should be copied from the source table to the destination table. If the attribute's value is “copy-all” formulas and styles are copied. If the attribute's value is “copy-results-only”, only formula results and non calculated cell content will be copied. 3859 3860 3861 3862 3863 3864

<define name="table-table-source-attlist" combine="interleave"> <optional> <attribute name="table:mode" a:defaultValue="copy-all"> <choice> <value>copy-all</value> <value>copy-results-only</value>

1 May 2005 Page 195 of 706

3865 3866 3867 3868

</choice> </attribute> </optional> </define>

Table Name The table:table-name attribute specifies the name of the table in the original document. If the table name is not specified, the first table in the document is used. 3869 3870 3871 3872 3873 3874 3875

URL The original table is specified by a an XLink, where the xlink:href attribute specifies the URL of the document containing the original table. 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890

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

Filter Name The table:filter-name attribute specifies the file type of the document containing the original table. The value of this attribute is application-specific. 3891 3892 3893 3894 3895 3896 3897

Filter Options The table:filter-options attribute specifies optional settings about the file type. The value of this attribute is application-specific. 3898 3899 3900 3901

1 May 2005 Page 196 of 706

3902 3903 3904

</attribute> </optional> </define>

Refresh Delay The table:refresh-delay attribute specifies the time delay between refresh actions for the linked table. 3905 3906 3907 3908 3909 3910 3911

8.3.3 Scenario Tables A scenario is an area of a table where data from other, so called scenario tables, is linked to temporarily. If several scenarios are defined for the same area, an user might choose between the scenarios. Whether a scenario table is visible itself is controlled by table's style. Only one scenario table can be active per table. A table that contains a <table:scenario> represents a scenario table. The name of the table and the name of the scenario are the same. The scenario is displayed in the regular table preceding the scenario table. If a scenario table is existing for a table, a scenario is displayed on that table automatically. These means the the existence of a scenario table implies the existence of a scenario. The attributes that may be associated with this element are:

3912 3913 3914 3915 3916 3917

•

Scenario Ranges

•

Is Active

•

Display Border

•

Border Color

•

Copy Back

•

Copy Styles

•

Copy Formulas

•

Comment

•

Protected

Scenario Ranges The table:scenario-ranges attribute specifies the table range that is displayed as a scenario. The value of this attribute is a list of cell range addresses.

1 May 2005 Page 197 of 706

3918 3919 3920 3921 3922

Is Active The table:is-active attribute specifies whether or not the scenario that belongs to the scenario table is active. 3923 3924 3925 3926 3927

Display Border The table:display-border attribute specifies whether or not to display a border around the scenario that belongs to the scenario table. 3928 3929 3930 3931 3932 3933 3934

Border Color The table:border-color attribute specifies the color of the border that is displayed around the scenario that belongs to the scenario table. 3935 3936 3937 3938 3939 3940 3941

Copy Back The table:copy-back attribute specifies whether or not data is copied back into the scenario table if another scenario is activated. 3942 3943 3944 3945 3946 3947 3948

Copy Styles The table:copy-styles attribute specifies whether or not styles are copied from the scenario table to the destination table together with the data.

1 May 2005 Page 198 of 706

3949 3950 3951 3952 3953 3954 3955

Copy Formulas The table:copy-formulas attribute specifies whether or not formulas are copied from the scenario table to the destination table. The value of this attribute can be true or false. If the value is true, the formulas are copied. If the value is false, only the values resulting from the formulas are copied. 3956 3957 3958 3959 3960 3961 3962

Comment The table:comment attribute contains a comment about the scenario. 3963 3964 3965 3966 3967 3968 3969

Protected The table:protected attribute specifies whether or not the data that is displayed within the scenario is protected from being edited. The attribute is only evaluated if the table on which the scenario displayed is also protected (see section 8.1.1). 3970 3971 3972 3973 3974 3975 3976

8.3.4 Shapes The <table:shapes> element contains all graphic shapes with an anchor on the table this element is a child of. It is a container element and does not have any associated attributes. 3977 3978 3979 3980 3981 3982

1 May 2005 Page 199 of 706

3983

</define>

8.4 Advanced Table Cells 8.4.1 Linked Table Cells A cell range can be linked to a database range or named range of another file. In this case the information about the original database range or named range is contained in a <table:cellrange-source> element that is contained in the element of the first cell of the range. The attributes that may be associated with this element are:

3984 3985 3986 3987 3988 3989 3990

•

Name

•

Last size

•

URL

•

Filter name

•

Filter options

•

Refresh delay

Name The table:name attribute specifies the name of the source database range or named range. 3991 3992 3993 3994 3995

Last Size The table:last-column-spanned and table:last-row-spanned attributes specify the last known size of the range. If the size of the range is changed since the last operation, the values of these attributes are incorrect. 3996 3997 3998 3999 4000 4001 4002 4003

1 May 2005 Page 200 of 706

URL, Filter Name, Filter Options and Refresh Delay The attributes xlink:href, xlink:type, xlink:actuate, table:filter-name and table:filter-options are the same as for linked tables. See section 8.3.2 for details.

8.4.2 Cell Annotation The OpenDocument format allows annotation to appear within table cells. See section 12.1 for details on annotations.

8.4.3 Detective The <table:detective> element has two purposes. One the one hand, it contains information about relations that exist between table cells because of formulas and that should be highlighted in the UI. On the other hand, the element contains information about cells that are highlighted currently in the UI either because of the relations mentioned above or because of error conditions. 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013

The elements that can be contained in the <table:detective> element are: •

Detective Operation

•

Highlighted range

8.4.4 Detective Operation The <table:operation> element specifies that certain relations that exist between the cell the element is a child of and other cells should be made visible or invisible in the UI. One and the same detective operation can be applied multiple times to the same cell. In this case, the 2nd operation is applied to the resulting cells of the first operation and so on. This means that an operation not necessarily is applied to the cell the operation is defined in, but also to other cells, and that it therefor can interact with operations defined in other cells. This especially applies to operations that make relations invisible. To get a determinate behavior, operations have an index and are applied in the order of that index. The attributes associated with the <table:operation> element are:

4014 4015 4016 4017 4018 4019

•

Name

•

Index

1 May 2005 Page 201 of 706

Name The table:name attribute specifies the name of the detective operation. Possible names are trace-dependents , remove-dependents, trace-precedents, remove-precedents and trace-errors. trace-dependents and remove-dependents displays or hides cells that use the value of the current cell in their formula. Trace-precedents and removeprecedents displays or hides cells whose value is used in the formula of the current cell. Trace-errors displays cells that cause an error while calculating the result of the current cell's formula. 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030

<define name="table-operation-attlist" combine="interleave"> <attribute name="table:name"> <choice> <value>trace-dependents</value> <value>remove-dependents</value> <value>trace-precedents</value> <value>remove-precedents</value> <value>trace-errors</value> </choice> </attribute> </define>

Index The table:index attribute specifies the the order in which detective operations are applied. 4031 4032 4033 4034 4035

8.4.5 Highlighted Range The <table:highlighted-range> element specifies a cell range that is highlighted in the UI either because of an detective operations described above or because it contains an error or invalid data. The information contained in this element is not guaranteed to be up to date but reflects the state that at the time the detective operations or error conditions have been calculated. The attributes that can be associated with the <table:highlighted-range> element are: ● Cell Range Address ● Direction ● Contains Error ● Marked Invalid 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045

1 May 2005 Page 202 of 706

4046 4047 4048

Cell Range Address The table:cell-range-address attribute contains the address of a range that is highlighted currently. 4049 4050 4051 4052 4053 4054 4055

Direction The table:direction attribute specifies the direction of the relation between this cell and the highlighted range. The direction for instance might be visualized by an arrow. 4056 4057 4058 4059 4060 4061 4062 4063 4064

<define name="table-highlighted-range-attlist" combine="interleave"> <attribute name="table:direction"> <choice> <value>from-another-table</value> <value>to-another-table</value> <value>from-same-table</value> </choice> </attribute> </define>

Contains Error The table:contains-error attribute specifies whether or not the cell range contains an error. 4065 4066 4067 4068 4069 4070 4071

Marked Invalid The table:marked-invalid attribute specifies whether or not the current cell is marked invalid. This attribute cannot be used together with any other attributes. 4072 4073 4074 4075 4076

1 May 2005 Page 203 of 706

8.5 Spreadsheet Document Content 8.5.1 Document Protection The structure of a spreadsheet document may be protected by using the table:structureprotected attribute, so that users can not insert, delete, move or rename the tables in the document. The optional table:protection-key attribute may be used to specify a password that prevents users from resetting the table protection flag to allow editing. To avoid saving the password directly into the XML file, only a hash value of the password is stored. 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088

8.5.2 Calculation Settings Spreadsheet documents contain settings that affect the calculation of formulas, for example the null date or iteration settings. These settings must be saved in the document in the <table:calculation-settings> element. 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099

The attributes that may be associated with the <table:calculation-settings> element are: •

Case sensitive

•

Precision as shown

•

Search criteria must apply to whole cell

•

Automatic find labels

•

Use regular expression

•

Null year

•

Null date

•

Iteration

1 May 2005 Page 204 of 706

Case Sensitive The table:case-sensitive attribute specifies whether or not to distinguish between upper and lower case when comparison operators are applied to cell content. 4100 4101 4102 4103 4104 4105 4106

Precision as Shown The table:precision-as-shown attribute specifies whether to perform a calculation using the rounded values displayed in the spreadsheet or using all of the digits in a number. If the value of this attribute is true, calculation are performed using the rounded values displayed in the spreadsheet. If the value of this attribute is false, calculations are performed using all of the digits in the number, but the result is still displayed as a rounded number. 4107 4108 4109 4110 4111 4112 4113

Search Criteria Must Apply to Whole Cell The table:search-criteria-must-apply-to-whole-cell attribute specifies whether or not the specified search criteria, according to the regular expression used, must apply to the entire cell contents. 4114 4115 4116 4117 4118 4119 4120 4121

Automatic Find Labels The table:automatic-find-labels attribute specifies whether or not to automatically find the labels of rows and columns. 4122 4123 4124 4125 4126 4127 4128

1 May 2005 Page 205 of 706

Use Regular Expressions The table:use-regular-expressions attribute specifies whether regular expressions are enabled for character string comparisons and when searching. 4129 4130 4131 4132 4133 4134 4135 4136

Null Year The table:null-year attribute specifies the start year for year values that contain only two digits. All two digit year values are interpreted as a year that equals or follows the start year. 4137 4138 4139 4140 4141 4142 4143

Null Date The <table:null-date> element specifies the null date. The null date is the date that results in the value “0” if a date value is converted into a numeric value. The null date is specified in the element's table:date-value attribute. Commonly used values are 12/30/1899, 01/01/1900, and 01/01/1904 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159

Iteration The <table:iteration> element enables formulas with iterative (or cyclic) references to be calculated after a specific number of iterations. Formulas with iterative references are repeated until the problem is solved. If this iterative calculations are not enabled, a formula with an iterative reference in a table causes an error message. Iterative calculations are enabled and disabled with the table:status attribute. If iterative calculations are enabled, the table:steps attribute specifies the maximum number of

1 May 2005 Page 206 of 706

iterations allowed. The table:maximum-difference attribute specifies the maximum difference allowed between two calculation results. The iteration is stopped if the result is less than the value of this attribute. 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183

<define name="table-iteration"> <element name="table:iteration"> <optional> <attribute name="table:status" a:defaultValue="disable"> <choice> <value>enable</value> <value>disable</value> </choice> </attribute> </optional> <optional> <attribute name="table:steps" a:defaultValue="100"> <ref name="positiveInteger"/> </attribute> </optional> <optional> <attribute name="table:maximum-difference" a:defaultValue="0.001"> <ref name="double"/> </attribute> </optional> <empty/> </element> </define>

8.5.3 Table Cell Content Validations Table cell content validations specify validation rules for the content of table cells. The <table:content-validation> element specifies such a validation rule. All validation rules that exist in a document are contained <table:content-validations> element. The validation rules themselves are named and referenced from the table cell by its name. 4184 4185 4186 4187 4188 4189 4190

4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210

1 May 2005 Page 207 of 706

The attributes that may be associated with the <table:content-validation> element are: ● Name ● Condition ● Base cell address ● Allow empty cell ● Display list

Name The table:name attribute specifies the name of the content validation. It is used to reference the validation rule from the cell the rule should applied to. The name is created automatically by the application. 4211 4212 4213 4214 4215

Condition The table:condition attribute specifies the condition that must evaluate to “true” for all cells the validation rule is applied to. The value of this attribute should be a namespace prefix, followed by an Boolean expression. A typical syntax of the expression may be similar to the XPath syntax. The following are valid conditions: •

Condition ::= ExtendedTrueCondition | TrueFunction 'and' TrueCondition

•

TrueFunction ::= cell-content-is-whole-number() | cell-content-isdecimal-number() | cell-content-is-date() | cell-content-is-time() | cell-content-is-text()

•

ExtendedTrueCondition ::= ExtendedGetFunction | cell-content-textlength() Operator Value

•

TrueCondition ::= GetFunction | cell-content() Operator Value

•

GetFunction ::= cell-content-is-between(Value, Value) | cellcontent-is-not-between(Value, Value)

•

ExtendedGetFunction ::= cell-content-text-length-is-between(Value, Value) | cell-content-text-length-is-not-between(Value, Value) | cell-content-is-in-list( StringList )

•

Operator ::= '<' | '>' | '<=' | '>=' | '=' | '!='

•

Value ::= NumberValue | String | Formula

•

StringList ::= StringList ';' String | String

•

A Formula is a formula without an equals (=) sign at the beginning. See section 8.1.3 for more information.

1 May 2005 Page 208 of 706

4216 4217 4218 4219 4220 4221 4222

•

A String comprises one or more characters surrounded by quotation marks.

•

A NumberValue is a whole or decimal number. It must not contain comma separators for numbers of 1000 or greater.

Base Cell Address The table:base-cell-address attribute specifies the address of the base cell for relative addresses in formulas that occur within a condition. This attribute is only necessary when the condition contains a formula. The value of this attribute must be an absolute cell address that contains a table name. 4223 4224 4225 4226 4227 4228 4229

Allow Empty Cell The table:allow-empty-cell attribute specifies whether or not a cell can be empty. 4230 4231 4232 4233 4234 4235 4236

Display List The table:display-list attribute specifies whether a list of values that occurs within a condition is displayed in the UI wile entering a cell value. The value of this attribute can be none, unsorted or sort-ascending.

4237 4238 4239 4240 4241 4242 4243 4244 4245 4246

•

none: the list values are not displayed.

•

unsorted: the list values are displayed in the order they occur in the condition.

•

sort-ascending: the list values are displayed in ascending order.

<define name="table-validation-attlist" combine="interleave"> <optional> <attribute name="table:display-list" a:defaultValue="unsorted"> <choice> <value>none</value> <value>unsorted</value> <value>sort-ascending</value> </choice> </attribute> </optional>

1 May 2005 Page 209 of 706

4247

</define>

Help Message The <table:help-message> element specifies a message to display if a user selects the cell. The element has an optional table:title attribute that specifies a title of the help message. It further has an optional table:display attribute that can be used to suppress the display of the message. 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264

Error Message The <table:error-message> element specifies a message to display if a user tries to enter invalid content into a cell i.e. content where the validation rule's condition evaluates to “false”. The element has an optional table:title attribute that specifies a title of the help message. It further has an optional table:display attribute that can be used to suppress the display of the message. The table:message-type attribute, that can take the values stop, warning, or information, specifies whether the message should be displayed as error (stop), warning (warning) or information only (information). In case the message is displayed as error, the operation that caused the validation check (for instance a cursor travel to leave the cell) is stopped. 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286

<define name="table-error-message"> <element name="table:error-message"> <optional> <attribute name="table:title"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="table:display" a:defaultValue="false"> <ref name="boolean"/> </attribute> </optional> <optional> <attribute name="table:message-type" a:defaultValue="stop"> <choice> <value>stop</value> <value>warning</value> <value>information</value> </choice> </attribute> </optional> <zeroOrMore>

1 May 2005 Page 210 of 706

4287 4288 4289 4290

Error Macro As an alternative to displaying a message, a macro might be called if a cell contains invalid content. The macro in this case is specified by an <office:event-listeners> element as specified in section 12.4. The event name must be one that specifies an event that is called on invalid user input. In addition to the <office:event-listeners> element, the <table:error-macro> element specifies whether the macro should be executed or not. 4291 4292 4293 4294 4295 4296 4297 4298 4299

8.5.4 Label Ranges Label ranges can be used to assign names to rows and columns, or to parts of rows and columns, where the names themselves are specified as the content of table cells. More precisely, the label range element <table:label-range> specifies a label cell range which contain the labels, and data cell range which specifies the rows or columns whose content is referenced by the labels. There are two types of label ranges. •

Label ranges for columns

•

Label ranges for rows.

The data cell range should have the same height and vertical position like the label cell range if row labels are specified, or should have the same width and horizontal position like the label range if column labels are specified. For information on defining a cell range, see section 8.3.1. Labels can be used within formula like any other name. All label ranges that exist in a document are contained within a single <table:label-ranges> element. 4300 4301 4302 4303 4304 4305 4306

4307 4308 4309 4310 4311 4312 4313

1 May 2005 Page 211 of 706

Label Cell Range Address The table:label-cell-range-address attribute specifies the cell range address of the labels. 4314 4315 4316 4317 4318

Data Cell Range Address The table:data-cell-range-address attribute specifies the cell range address of the data. 4319 4320 4321 4322 4323

Orientation The table:orientation attribute specifies the orientation of the label range. This attribute can have a value of column or row. 4324 4325 4326 4327 4328 4329 4330 4331

<define name="table-label-range-attlist" combine="interleave"> <attribute name="table:orientation"> <choice> <value>column</value> <value>row</value> </choice> </attribute> </define>

8.5.5 Named Expressions The named expressions element <table:named-expressions> contains a collection of assignments of names to expressions, so that the names can be use to refer to the expression. The following expression can get names:

4332 4333 4334 4335 4336 4337 4338 4339 4340 4341

•

cell ranges.

•

Other expressions, for example, parts of a formula.

4342

1 May 2005 Page 212 of 706

Named Range The named range element <table:named-range> specifies a cell range that has a name assigned. For information on defining a cell range, see section 8.3.1. The table:name attribute specifies the name of the range, and the table:cell-rangeaddress attribute its address. The address can be either absolute or relative. If the cell range address is relative, the table:base-cell-address attribute must exist additionally. It specifies the base cell address for the cell range. This address must be absolute. Therefore a table name in the address is required, but the dollar signs that indicate an absolute address can be omitted. An additional table:range-usable-as attribute specifies whether the name of the range can be used within the specification of a print range, a filter, a repeating row, or a repeat column. The value of this attribute can be either: •

none, or

•

a space-separated list that consists of any of the values print-range, filter, repeatrow or repeat-column.

4343 4344 4345 4346 4347 4348

4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379

<define name="table-named-range-attlist" combine="interleave"> <attribute name="table:name"> <ref name="string"/> </attribute> <attribute name="table:cell-range-address"> <ref name="cellRangeAddress"/> </attribute> <optional> <attribute name="table:base-cell-address"> <ref name="cellAddress"/> </attribute> </optional> <optional> <attribute name="table:range-usable-as" a:defaultValue="none"> <choice> <value>none</value> <list> <oneOrMore> <choice> <value>print-range</value> <value>filter</value> <value>repeat-row</value> <value>repeat-column</value> </choice> </oneOrMore> </list> </choice> </attribute> </optional> </define>

1 May 2005 Page 213 of 706

Named Expression The named expression element <table:named-expression> contains an expression with a name, for example, a part of a formula. The table:name attribute specifies the name of the expression, and the table:expression attribute the expression itself. The expressions do not support the equal (=) sign as the first character. If the expression contains a named range or another named expression, the named range or named expression must be specified first, before the containing expression. If the expression contains a relative cell range address, the table:base-cell-address attribute must exist additionally. It specifies the base cell address for the cell range. This address must be absolute. Therefore a table name in the address is required, but the dollar signs that indicate an absolute address can be omitted. 4380 4381 4382 4383 4384 4385

4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399

Example: Named expressions element with a named range and a named expression <table:named-expressions> <table:named-range table:name="sample1" table:cell-rangeaddress=".C4" table:base-cell-address="sampletable.F1" table:area-type="none"/> <table:named-range table:name="sample2" table:cell-range-address=".$D$3:.$K$8" table:area-type="print-range filter"/> <table:named-expression table:name="sample3" table:expression="sum([.A1:.B3])"/> </table:named-expressions>

8.6 Database Ranges A database range is a named area in a table where database operations, but also some other kind of operations like filtering and sorting, can be performed. The Database Ranges element <table:database-ranges> contains a collection of all database ranges defined in a document. 4400 4401 4402 4403 4404 4405 4406

1 May 2005 Page 214 of 706

8.6.1 Database Range The <table:database-range> defines a single database range. 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427

Database Range Name The table:name attribute specifies the name of the database range on which to perform operations. Within a single document, only one database range is allowed to have no name. This database range is usually automatically created by the application and is used to filter or sort data in a cell ranges without the user explicitly creating a database range. 4428 4429 4430 4431 4432 4433 4434

Is Selection The table:is-selection attribute specifies whether the database range includes a complete database, or a selection of records from a database only. 4435 4436 4437 4438 4439 4440 4441

On Update Keep Styles The table:on-update-keep-styles attribute specifies the behavior if the database range is updated. If the attribute value is “true”, the cell styles that are assigned to the cells in the first non-label row of the database range are used for all rows with in the database range. If the attribute value is “false”, all cells in the database range get the default cell style of the document assigned.

1 May 2005 Page 215 of 706

4442 4443 4444 4445 4446 4447 4448

On Update Keep Size The table:on-update-keep-size attribute specifies the behavior of the database range if the size of the data in the data source changes. If the attribute value is true, the range retains its size. If the attribute value is false, the range does not retain its size. 4449 4450 4451 4452 4453 4454 4455

Has Persistent Data The table:has-persistent-data attribute specifies whether the current data in a database range is saved when the document itself is saved. 4456 4457 4458 4459 4460 4461 4462

Orientation The table:orientation attribute specifies the orientation of the database range. The values of this attribute are row and column. The orientation is for instance used when sorting database ranges (see 8.6.5). If the orientation is row, the sorting takes places for rows, otherwise for columns. 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472

<define name="table-database-range-attlist" combine="interleave"> <optional> <attribute name="table:orientation" a:defaultValue="row"> <choice> <value>column</value> <value>row</value> </choice> </attribute> </optional> </define>

Contains Header The table:contains-header attribute specifies whether or not the the content of the database range's first row or column should be used to specify labels. If the attribute's value is true, the content of the first cell within a row or column can be used to reference the whole row or column within many spreadsheet operations, for instance from within data pilots.

1 May 2005 Page 216 of 706

4473 4474 4475 4476 4477 4478 4479

Display Filter Buttons The table:display-filter-buttons buttons attribute specifies whether or not to display filter buttons. Filter buttons are list box controls displayed in the label cells whose list entries are the values that exist in the labeled row or column. Selecting one of these entries equals applying a filter to the database range that selects all row or columns where the cells in the labeled row or column have the selected value. 4480 4481 4482 4483 4484 4485 4486 4487

Target Range Address The table:target-range-address attribute specifies the cell range address of the database range. A differentiation between absolute and relative addresses is not possible. Therefore, a table name must be specified in the address and dollar signs are ignored. 4488 4489 4490 4491 4492

Refresh Delay The table:refresh-delay attribute specifies a time delay between automatic refresh actions. 4493 4494 4495 4496 4497 4498 4499

8.6.2 Database Source SQL The <table:database-source-sql> element describes an SQL database that contains the source data of the database range. 4500 4501 4502 4503 4504 4505

1 May 2005 Page 217 of 706

Database Name A table:database-name attribute specifies the name of the SQL database where the data is imported from. 4506 4507 4508 4509 4510

SQL Statement An table:sql-statement attribute specifies the SQL statement to use when importing data from an SQL database. 4511 4512 4513 4514 4515

Parse SQL Statement A table:parse-sql-statement attribute specifies whether or not the application will parse SQL statements. 4516 4517 4518 4519 4520 4521 4522

8.6.3 Database Source Table The database source table element <table:database-source-table> specifies that the source data of the database range is stored in a database table. 4523 4524 4525 4526 4527 4528

Database Name The table:database-name name attribute specifies the name of the database where the data is imported from. 4529 4530 4531 4532 4533

1 May 2005 Page 218 of 706

Table Name A table:database-table-name attribute specifies the database table that data is imported from. 4534 4535 4536 4537 4538

8.6.4 Database Source Query The database source query element <table:database-source-query> specifies that the source data of the database range is is the result of a database query. 4539 4540 4541 4542 4543 4544

Database Name A table:database-name attribute specifies the name of the database that data is imported from. 4545 4546 4547 4548 4549

Query Name A table:query-name attribute specifies the query to perform on the database whose data is being imported. 4550 4551 4552 4553 4554

8.6.5 Sort The sort element <table:sort> describes the sort keys that should be applied to a database range. 4555 4556 4557 4558 4559 4560 4561 4562

1 May 2005 Page 219 of 706

Bind Styles to Content The table:bind-styles-to-content attribute specifies whether or not cells retain their style attributes after a sort operation. 4563 4564 4565 4566 4567 4568 4569

Target Range Address If the optional table:target-range-address attribute is present, the result of the sort is copied into the specified cell range rather than in the source cell range specified by the database range. A differentiation between absolute and relative addresses is not possible. Therefore, a table name has to exist in the address and dollar signs are ignored. 4570 4571 4572 4573 4574 4575 4576

Case Sensitive The table:case-sensitive attribute specifies whether or not the sort operation is case sensitive. 4577 4578 4579 4580 4581 4582 4583

Language The table:language attribute specifies the natural language in which the comparison will occur. 4584 4585 4586 4587 4588 4589 4590

Country The table:country attribute specifies the country specific rules to be used in string comparisons for a particular natural language.

1 May 2005 Page 220 of 706

4591 4592 4593 4594 4595 4596 4597

Algorithm The table:algorithm attribute specifies the algorithm used to compare sort keys. The attribute's value is a an application but also language and country specific sort algorithm name like “phonetic (alphanumeric first)”. To avoid name clashed between different applications, the name should start with a namespace prefix 4598 4599 4600 4601 4602 4603 4604

8.6.6 Sort By The sort by element <table:sort-by> specifies a key or field to sort, the data type of this field, and how to sort it. 4605 4606 4607 4608 4609 4610

Field Number The table:field-number number attribute specifies the row or column number to sort by. It is the number of a row or column within the database range. 4611 4612 4613 4614 4615

Data Type The table:data-type attribute specifies the data type of the field to be sorted. It's value can be text, number, automatic or the name of user defined sort order. If the attribute value is automatic, the application must determine what type of data is in the field. User defined sort orders are for instance lists of names of months. Specifying user defined sort orders is application specific. 4616 4617 4618 4619 4620 4621

<define name="table-sort-by-attlist" combine="interleave"> <optional> <attribute name="table:data-type" a:defaultValue="automatic"> <choice> <value>text</value> <value>number</value>

1 May 2005 Page 221 of 706

4622 4623 4624 4625 4626 4627

<value>automatic</value> <ref name="string"/> </choice> </attribute> </optional> </define>

Order The table:order attribute specifies whether to sort the data in ascending or descending order. 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637

<define name="table-sort-by-attlist" combine="interleave"> <optional> <attribute name="table:order" a:defaultValue="ascending"> <choice> <value>ascending</value> <value>descending</value> </choice> </attribute> </optional> </define>

8.6.7 Subtotal Rules The subtotal rules element <table:subtotal-rules> specifies that provisional results (called subtotals) should be calculated for a database range. It contains information about the row or column provisional results should be calculated for, and also how these results are calculated. To calculate provisional results, the cell values of a row or column a grouped by their value, that is, all cells with the same content in the same field form a group. A provisional result is calculated and displayed at the end of each group. 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648

Bind Styles To Content The table:bind-styles-to-content attribute specifies whether or not cells retain their style after a subtotal calculation. This attribute is only evaluated if the table:sort-groups element is present. 4649 4650 4651 4652 4653 4654 4655

1 May 2005 Page 222 of 706

Case Sensitive The table:case-sensitive attribute specifies whether or not the case of characters is important when comparing entries, for example, when sorting groups. 4656 4657 4658 4659 4660 4661 4662

Page Breaks On Group Change The table:page-breaks-on-group-change on group change attribute specifies whether or not to insert a page break after the subtotal for each group. 4663 4664 4665 4666 4667 4668 4669 4670

8.6.8 Subtotal Sort Groups The optional sort groups element <table:sort-groups> specifies that columns or rows are sorted before grouping them, and how to sort them. It belongs to the subtotal rules element, see the previous section. 4671 4672 4673 4674 4675 4676

Data Type The table:data-type attribute specifies the data type of the column or row group to sort. See section 8.6.6 for details. 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688

<define name="table-sort-groups-attlist" combine="interleave"> <optional> <attribute name="table:data-type" a:defaultValue="automatic"> <choice> <value>text</value> <value>number</value> <value>automatic</value> <ref name="string"/> </choice> </attribute> </optional> </define>

1 May 2005 Page 223 of 706

Order The table:order attribute specifies whether to sort the group data in ascending or descending order. See section 8.6.6 for details. 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698

<define name="table-sort-groups-attlist" combine="interleave"> <optional> <attribute name="table:order" a:defaultValue="ascending"> <choice> <value>ascending</value> <value>descending</value> </choice> </attribute> </optional> </define>

8.6.9 Subtotal Rule The subtotal rule element <table:subtotal-rule> describes how to calculate the subtotals for a certain row or column. The rule contains the group field number, which specifies the column group for which the rule is used, and one or more subtotal fields, which specify a row a column where subtotals should be calculated as well as the function to use for the calculation. 4699 4700 4701 4702 4703 4704 4705 4706

Group By Field Number The table:group-by-field-number attribute specifies the field, for example, a column, that is to be grouped. It is the number of a row or column within the database range. 4707 4708 4709 4710 4711

8.6.10 Subtotal Field The subtotal field element <table:subtotal-field> contains the field number and the function that is used to calculate a provisional result. 4712 4713 4714 4715 4716 4717

Field Number The table:field-number attribute specifies the row or column a subtotal should be calculated for. It is the number of a row or column within the database range.

1 May 2005 Page 224 of 706

4718 4719 4720 4721 4722

Function The table:function attribute specifies what kind of subtotals to calculate. The following are possible values for this attribute: auto, average, count, countnums, max, min, product, stdev, stdevp, sum, var and varp. 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741

<define name="table-subtotal-field-attlist" combine="interleave"> <attribute name="table:function"> <choice> <value>auto</value> <value>average</value> <value>count</value> <value>countnums</value> <value>max</value> <value>min</value> <value>product</value> <value>stdev</value> <value>stdevp</value> <value>sum</value> <value>var</value> <value>varp</value> <ref name="string"/> </choice> </attribute> </define>

Example: Subtotal field <table:database-range table:rangeposition="sampletable.A1:sampletable.G20" table:name="sample"> <table:database-source-table table:database-name="sampleDB" table:table-name="sampleTable"/> <table:filter ...> ... </table:filter> <table:sort> <table:sort-by table:field-number=1/> </table:sort> <table:subtotal-rules> <table:sort-groups/> <table:subtotal-rule table:column-group "3"> <table:subtotal-field table:field-number="1" table:function="sum"/> </table:subtotal-rule> </table:subtotal-rules> </table:database-range>

8.7 Filters Filters specify that only rows that match certain conditions should be visible

8.7.1 Table Filter The table filter element <table:filter> describes how the data contained in a database range or data pilot tables is filtered. The condition specified in the element are applied to all rows

1 May 2005 Page 225 of 706

specified in the database range or the data pilot table. Rows where the condition does not evaluate to true are made invisible. 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751

Target Range Address If the optional table:target-range-address attribute is present, the result of the filter is copied into the specified cell range but all table rows remain visible. If the attribute is not present, the rows that do not match the filter conditions are not displayed. A differentiation between absolute and relative addresses is not possible. Therefore, a table name has to exist in the address and dollar signs are ignored. 4752 4753 4754 4755 4756 4757 4758

Condition Source The table:condition-source attribute specifies whether the condition is contained in the filter or encoded in a table range. If the value is self the condition is specified by the <table:filter> element's child elements. If the value is cell-range the condition is encoded into the cell range specified by the table:condition-source-range-address attribute. 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768

<define name="table-filter-attlist" combine="interleave"> <optional> <attribute name="table:condition-source" a:defaultValue="self"> <choice> <value>self</value> <value>cell-range</value> </choice> </attribute> </optional> </define>

Condition Source Range Address The table:condition-source-range-address attribute specifies a cell range that contains encoded conditions. The first row of the cell range has to contain the labels of the columns whose content should be filtered. The following rows contain conditions that have to evaluate to true for the cells contained in the columns. The conditions in each row are connected by an “and” operation, while the rows are connected by an “or” operation. This means that a row is of the source table is displayed if there is at least one row in the condition range where all conditions evaluate to true if they are applied to the columns specified in the first row of the condition range.

1 May 2005 Page 226 of 706

Example: If the condition source range is E1:F3 (shown yellow) and the source range is A1:C3 (shown green), only rows 2 and 3 are displayed. A

>=2

Row 2 is displayed because the cell in column A has the value 1 and the cell in column B the value 5, so all conditions of the 2nd row of the condition range evaluate to true. Row 3 is displayed because the cell in column A is larger or equal than 2, and therefor the only condition in the the 3rd row of the condition range evaluates to true. 4769 4770 4771 4772 4773 4774 4775

Display Duplicates The table:display-duplicates attribute specifies whether or not to display duplicate matches in the result. 4776 4777 4778 4779 4780 4781 4782

8.7.2 Filter And The <table:filter-and> element specifies that the logical operator AND is applied to the conditions specified by the element's child elements. 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792

8.7.3 Filter Or The <table:filter-or> element specifies that the logical operator OR is applied to the conditions specified by the element's child elements. 4793 4794 4795

1 May 2005 Page 227 of 706

4796 4797 4798 4799 4800 4801 4802

8.7.4 Filter Condition The table <table:filter-condition> element describes a single condition to apply in a filter operation. 4803 4804 4805 4806 4807 4808

Field Number The field number attribute table:field-number specifies which field to use for the condition. A field number is the number of a row or column in the source range of the filter. 4809 4810 4811 4812 4813

Value The table:value attribute specifies a value for the filter condition. 4814 4815 4816 4817 4818

Operator The operator attribute table:operator specifies what operator to use in the filter condition. This means that each cell contained in the columns specified by the field number (i.e. the table:field-number attribute) is compared with the value (i.e. the table:value attribute) using the given operator. The result of this comparison is the result of the filter sub conditions specified by the <table:filter-condition> element. The operators may or may not make use of regular expressions. The operators that use regular expressions are the following: •

match (matches)

•

!match (does not match)

In both case, the table:value attribute contains the regular expression that the table cells have to match or must not match. The relational operators that do not use regular expressions are:

1 May 2005 Page 228 of 706

•

= (Equal to)

•

!= (Not equal to)

•

< (Less than)

•

> (Greater than)

•

<= (Less than or equal to)

•

>= (Greater than or equal to)

In addition, operators “empty”, “!empty”, “bottom values”, “top values”, “bottom percent”, and “top percent” can be used. To filter for example the lowest and highest percentage values, the latter two operators can be used. 4819 4820 4821 4822 4823

Case Sensitive The table:case-sensitive case sensitive attribute determines whether a filter condition is case sensitive. 4824 4825 4826 4827 4828 4829 4830

Data Type The table:data-type attribute specifies whether comparison shall take place as text or as numeric values. 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840

<define name="table-filter-condition-attlist" combine="interleave"> <optional> <attribute name="table:data-type" a:defaultValue="text"> <choice> <value>text</value> <value>number</value> </choice> </attribute> </optional> </define>

Example:Representation of a filter <filter> <filter-or> <filter-and> <filter-condition table:field-number=1 table:operator="=" table:value="Doe"/> <filter-condition table:field-number=2 table:operator="=" table:value="John"/> </filter-and> <filter-and> <filter-condition table:field-number=1 table:operator="=" table:value="Burns"/>

1 May 2005 Page 229 of 706

<filter-condition table:field-number=2 table:operator="=" table:value="Michael"/> </filter-and> </filter-or> </filter>

8.8 Data Pilot Tables Data pilot tables allow it to analyze and evaluate data contained in spreadsheet tables. The data pilot tables element <table:data-pilot-tables> contains the collection of all data pilot tables within a document. 4841 4842 4843 4844 4845 4846 4847

8.8.1 Data Pilot Table The <table:data-pilot-table> specifies a single data pilot table. Within data pilot tables, all combinations of values that exist in selected columns are collected, and for each of these combinations a formula is applied to the cells of other columns.

Example: Given is the following source table A

1 Article

City

Country

Amount

Price

2 Main Unit Hamburg Germany

3 Monitor

Hamburg Germany

4 Printer

Paris

France

5 Monitor

Paris

France

6 Main Unit Paris

France

7 Monitor

Hamburg Germany

8 Printer

Paris

France

1 May 2005 Page 230 of 706

The following data pilot table groups the source table by the columns “County”, “City” and “Article” and calculates the sum of the “Amount” as well as of the “Price” columns for each combinations of values of these three columns. The values of the Country and City columns are shown in columns, while the ones of the Article columns are shown in rows. Article Main Unit

Monitor Printer Total

Country

City

Data

France

Paris

Sum Amount

Sum - Price

Sum Amount

Sum - Price

Total sum - Amount

Total sum - Price

Germany

Hamburg

The columns that are used for grouping (here “County”, “City” and “Article”) are called category columns. The columns for which a formula is calculated based on the value combinations of the category columns (here “Amount” and “Price”) are called data columns. The individual values that exists within a category column are called members. In general, the behavior of a data pilot is specified by fields, where each field has a name and a so called orientation. The category columns are specified by fields with the orientation “row” or “column” and the data columns are specified by fields that have the orientation “data”. In the above example, “Article” is a field with the orientation column, while “Country” and “City” are fields with the orientation row. “Amount” and “Price” are fields with “data” orientation. A third kind of fields are data layout fields. Data layout fields are not connected to a column in the source table, but have the only the purpose to change the layout of the data pilot table. In the example, “Data” is a data layout field. The order in which fields are specified is of relevance. It specified the order in which the data of category columns is grouped and results are displayed. The data pilot table below displays how the data pilot table changes if for instance the data layout field is specified before the category column fields.

Example: A data pilot with a modified layout Article Data

Country

City

Sum - Amount

France

Paris

Main Unit

Monitor Printer Total 1

Germany Hamburg

France

Total sum - Amount

Total sum - Price

Sum - Price

Paris

Germany Hamburg

9 5

55 37

1 May 2005 Page 231 of 706

The attributes associated with the data pilot table element are:

4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864

•

Data pilot table name

•

Application data

•

Grand total

•

Ignore empty rows

•

Identify categories

•

Target range address

•

Show Filter Button

•

Drill Down On Double Click

Data Pilot Table Source The source of the data pilot table is either stored in a database, that is, a database table itself, a SQL query or a named query, or it is a cell range located within the same document. It can also be provided by an external component in an implementation dependent way. The source of the data pilot table is specified by one of the following elements that are contained in the <table:data-pilot-table> element: •

<table:database-source-sql> (see section 8.6.2)

•

<table:database-source-table> (see section 8.6.3)

•

<table:database-source-query> (see section 8.6.4)

•

<table:source-cell-range> (see section 8.8.2)

•

<table:source-service> (see section 8.8.3)

Data Pilot Table Name The table:name attribute specifies the name of the data pilot table. 4865 4866 4867 4868

1 May 2005 Page 232 of 706

4869

</define>

Application Data The table:application-data attribute specifies extra information about the data pilot table, which can be used by the application, for instance within macros. This data does not influence the behavior of the data pilot. 4870 4871 4872 4873 4874 4875 4876

Grand Total The table:grand-total attribute specifies whether a grand total column, row, or both should be displayed in addition to values calculated for each combination of values in the category columns. In the above example, grand totals are enabled. They are displayed in the row and column labeled “Total”. 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888

<define name="table-data-pilot-table-attlist" combine="interleave"> <optional> <attribute name="table:grand-total" a:defaultValue="both"> <choice> <value>none</value> <value>row</value> <value>column</value> <value>both</value> </choice> </attribute> </optional> </define>

Ignore Empty Rows The table:ignore-empty-rows attribute specifies whether or not empty rows in the source range should be ignored. 4889 4890 4891 4892 4893 4894 4895

Identify Categories The table:identify-categories attribute specifies whether rows that do not contain a value in one of the category columns should use the value of the nearest ancestor row that has a value, or whether such rows should be moved into a group (or category) of its own. If the attribute's value is false, empty values form a category of its own. 4896 4897 4898 4899

1 May 2005 Page 233 of 706

4900 4901 4902

</attribute> </optional> </define>

Target Range Address The table:target-range-address attribute specifies where the target range of the data pilot table output, that is, where the data pilot table is displayed. A differentiation between absolute and relative addresses is not possible, that is, the address is interpreted as an absolute address even if it contains dollar signs. The range address must contain a table name. 4903 4904 4905 4906 4907

Buttons Within a data pilot table, some cells might be displayed as buttons to allow interactive operations on the table like changing the order of columns. The table:buttons attribute specifies all cells which should be displayed this way. Its value is a list of cell-addresses. A differentiation between absolute and relative addresses is not possible, that is, the addresses are interpreted as absolute addresses even if they contain dollar signs. All addresses must contain a table name. In the examples above, button cells are displayed with a gray background. 4908 4909 4910 4911 4912 4913 4914

Show Filter Button The table:show-filter-button attribute specifies whether a filter button is shown in the UI within the Data Pilot. A filter button displays a filter dialog if pushed. 4915 4916 4917 4918 4919 4920 4921

Drill Down On Double Click The table:drill-down-on-double-click attribute specifies how the data pilot table reacts on a double click into the data pilot table. If the attribute's value is false, a double click on a member label or the empty area next to it starts the edit mode of the table cell, like for cells outside of the data pilot table. This can then be used to rename group fields or members. If the attribute's value is true, a double click on an member label or the empty area next to it shows or hides details for that member. A double click elsewhere in a data pilot table has no effect. 4922 4923

1 May 2005 Page 234 of 706

4924 4925 4926 4927 4928 4929

8.8.2 Source Cell Range If the source of a data pilot table is a cell range, the <table:source-cell-range> element contains information about the cell range and how the data pilot table gets the data from the range. Before the source data is processed by the data pilot data, a filter may be applied to it. This filter has to be specified by a <table:filter> child element. 4930 4931 4932 4933 4934 4935 4936 4937

The only attribute that may be associated with the source cell range element is: •

Cell range address

Cell Range Address The table:cell-range-address attribute specifies the cell range containing the source data. The source cell range's address must be absolute. Therefore, the cell range address must contain a table name and dollar signs are ignored. 4938 4939 4940 4941 4942

8.8.3 Source Service The source of a data pilot table can be “service”, that is, it can be provided by an external component. The source service element <table:source-service> contains information about the service which is used to create the data pilot table. 4943 4944 4945 4946 4947 4948

The attributes that may be associated with this element are: •

Service name

•

Source name

•

Object name

•

Source username

1 May 2005 Page 235 of 706

•

Source password

Service Name The table:name attribute specifies the name of the service. The value of this attribute is implementation specific. 4949 4950 4951 4952 4953

Source Name The table:source-name attribute specifies a source name that is passed to the service implementation. Its value is application and service specific. 4954 4955 4956 4957 4958

Object Name The table:object-name attribute specifies the name of the object in the source which contains the data and is passed to the service implementation. Its value is application and service specific. 4959 4960 4961 4962 4963

Source Username The table:user-name attribute specifies the username required to access the source. It is passed to the service implementation. Its value is application and service specific. 4964 4965 4966 4967 4968 4969 4970

Source Password The table:password attribute specifies the password required to access the source. It is passed to the service implementation. Its value is application and service specific. 4971 4972 4973 4974 4975 4976

1 May 2005 Page 236 of 706

4977

</define>

8.8.4 Data Pilot Field A data pilot table's fields are specified by <table:data-pilot-field> elements. 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991

The attributes that may be associated with the data pilot field element are: •

Source field name

•

Orientation

•

Is data layout field

•

Function

•

Used hierarchy

Source Field Name For fields that specify category or data columns, the table:source-field-name attribute specifies the name or label of the column the field is connected to. If the source of the data pilot table is for instance a cell range, then the attribute's value has to be the column's label. There can be multiple <table:data-pilot-field> elements with the same value for this attribute. 4992 4993 4994 4995 4996

Orientation The table:orientation attribute specifies the orientation of the source field. If the value is data, then the field specifies a data column. If the value is row or column, then the field specifies a category column. The value hidden is used for fields that have a corresponding column in the data pilot's source, but are not visible within the data pilot table. The value page indicates that an automatic filter (i.e. one that allows to choose one of the values that are contained in the column) should be generated for the corresponding column. In this case, an additional field with row, column or data orientation has to exist for the column. If the attribute value is page, the table:selected-page attribute can be used to specify which value is selected for the filter.

1 May 2005 Page 237 of 706

4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016

<define name="table-data-pilot-field-attlist" combine="interleave"> <choice> <attribute name="table:orientation"> <choice> <value>row</value> <value>column</value> <value>data</value> <value>hidden</value> </choice> </attribute> <group> <attribute name="table:orientation"> <value>page</value> </attribute> <attribute name="table:selected-page"> <ref name="string"/> </attribute> </group> </choice> </define>

Is Data Layout Field The table:is-data-layout-field attribute specifies whether a field is an data layout field (see section 8.8.1). Data layout fields usually don't have a name. 5017 5018 5019 5020 5021 5022 5023

Function The table:function attribute specifies the function which is applied to the cell values of data columns. It is only evaluated if the value of the table:orientation attribute is data. Possible values for this attribute are: auto, average, count, countnums, max, min, product, stdev, stdevp, sum, var and varp. For category columns the attribute's value auto can be used that specifies that no function is applied at all. 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044

<define name="table-data-pilot-field-attlist" combine="interleave"> <optional> <attribute name="table:function"> <choice> <value>auto</value> <value>average</value> <value>count</value> <value>countnums</value> <value>max</value> <value>min</value> <value>product</value> <value>stdev</value> <value>stdevp</value> <value>sum</value> <value>var</value> <value>varp</value> <ref name="string"/> </choice> </attribute> </optional> </define>

1 May 2005 Page 238 of 706

Used Hierarchy If the data pilot source is provided by an external component or service, the data contained within category columns may not only grouped by its value, but it may be further divided into sub groups or hierarchies. A date value for instance might be grouped by •

“year”, “month” and “day of month”, or

•

“year”, “week” and “day of week”

If an external components supports hierarchies, it has to assign unique numbers to it. These numbers can be used in the table:used-hierarchy attribute to select the hierarchy that should be applied to the source field. The value means that no hierarchy should be applied at all. 5045 5046 5047 5048 5049 5050 5051

8.8.5 Data Pilot Level The data pilot level element <table:data-pilot-level> contains additional information about a data pilot field. 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071

The attribute that may be associated associate with the data pilot level element is: •

Show empty

Show Empty The table:show-empty attribute specifies whether or not fields that don't have any members should be displayed. If this attribute is not present, the application might or might not display such fields. 5072 5073 5074 5075

1 May 2005 Page 239 of 706

5076 5077 5078

</attribute> </optional> </define>

8.8.6 Data Pilot Subtotals The data pilot subtotals element <table:data-pilot-subtotals> contains information about the provisional results that are displayed for every member of a field and the function used to calculate the result. Several provisional results can be calculated simultaneously. If the element is not present, the application might or might not display provisional results. 5079 5080 5081 5082 5083 5084 5085

8.8.7 Data Pilot Subtotal The data pilot subtotal element <table:data-pilot-subtotal> contains information about a single provision result calculation. 5086 5087 5088 5089 5090 5091

The attribute that may be associated associate with the data pilot subtotal element is: •

Function

Function The table:function attribute specifies the function used for the subtotal. Possible functions are auto, average, count, countnums, max, min, product, stdev, stdevp, sum, var and varp. 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110

<define name="table-data-pilot-subtotal-attlist" combine="interleave"> <attribute name="table:function"> <choice> <value>auto</value> <value>average</value> <value>count</value> <value>countnums</value> <value>max</value> <value>min</value> <value>product</value> <value>stdev</value> <value>stdevp</value> <value>sum</value> <value>var</value> <value>varp</value> <ref name="string"/> </choice> </attribute> </define>

1 May 2005 Page 240 of 706

8.8.8 Data Pilot Members For category columns, it can be controlled whether certain members themselves or the information displayed for a certain member actually is displayed or not. The <table:datapilot-members> element contains such information. 5111 5112 5113 5114 5115 5116 5117

8.8.9 Data Pilot Member The data pilot member element <table:data-pilot-member> specifies which information is displayed for a certain member. 5118 5119 5120 5121 5122 5123

The attributes that may be associated with the data pilot member element are: •

Member name

•

Display

•

Show details

Member Name The table:name attribute specifies the value for which display information is specified. 5124 5125 5126 5127 5128

Display The table:display attribute specifies whether or not a data pilot member is visible at all. If this attribute is not present, the application might or might not display the member. 5129 5130 5131 5132 5133 5134 5135

1 May 2005 Page 241 of 706

Show Details The table:show-details attribute specifies whether additional fields are displayed for a member. This attribute changes the behavior of a data pilot only if there are several fields with the orientation row or column. If this is the case, and if the attribute's value is false for a field with row or column orientation that is not the last field with this orientation, then no members are displayed for all following fields with the same orientation. Instead of this, the data displayed for these fields will be summarized. 5136 5137 5138 5139 5140 5141 5142

8.8.10 Data Pilot Display Info The <table:data-pilot-display-info> element restricts the number rows that are displayed for a category field to a specific number of values of a data field. 5143 5144 5145 5146 5147 5148

Enabled The table:enabled attribute specifies whether the <table:data-pilot-display-info> element is evaluated or not. 5149 5150 5151 5152 5153

Data Field The table:data-field attribute specifies the data field whose values are taken into account. 5154 5155 5156 5157 5158

Member Count The table:member-count attribute specifies how many values from the top or from the bottom of data field's column are shown. 5159 5160 5161 5162 5163

1 May 2005 Page 242 of 706

Display Member Mode The table:display-member-mode attribute specifies whether the values specified by table:member-count should be taken from the top or from the bottom of a data field's column. 5164 5165 5166 5167 5168 5169 5170 5171

<define name="table-data-pilot-display-info-attlist" combine="interleave"> <attribute name="table:display-member-mode"> <choice> <value>from-top</value> <value>from-bottom</value> </choice> </attribute> </define>

8.8.11 Data Pilot Sort Info The <table:data-pilot-sort-info> element specifies how the members of a category field are sorted. 5172 5173 5174 5175 5176 5177

Sort Mode The table:sort-mode attribute describes how to sort the members of a single data pilot field. If the mode is data, then the members of the current category field a sorted according to their values in the data field specified by the table:data-field attribute. If the mode is manual, the user can sort the members in the field manually. If the mode is name, the members in the field are sorted by their name. 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196

<define name="table-data-pilot-sort-info-attlist" combine="interleave"> <choice> <group> <attribute name="table:sort-mode"> <value>data</value> </attribute> <attribute name="table:data-field"> <ref name="string"/> </attribute> </group> <attribute name="table:sort-mode"> <choice> <value>none</value> <value>manual</value> <value>name</value> </choice> </attribute> </choice> </define>

Sort Order The table:sort-order attribute specifies whether to sort the members ascending or descending. 5197

1 May 2005 Page 243 of 706

5198 5199 5200 5201 5202 5203 5204

<attribute name="table:order"> <choice> <value>ascending</value> <value>descending</value> </choice> </attribute> </define>

8.8.12 Data Pilot Layout Info The <table:data-pilot-layout-info> element describes how to layout the field. 5205 5206 5207 5208 5209 5210

Layout Mode The table:layout-mode attribute describes how to layout the field. It may have the following values:

5211 5212 5213 5214 5215 5216 5217 5218 5219

•

tabular-layout: Tabular layout mode is the layout, where each member's name is on the same row as the first member from the following field. Subtotals are always shown below an member's data in this mode.

•

outline-subtotals-top: In outline layout mode, the members from the following field start in the row below a member's name, like in traditional database reports. Subtotals are shown at the top (in the same row as the member's name). When the subtotals take up more than one row (manually selected, or because there are several data fields), they are always shown below the member's data, regardless of the setting.

•

outline-subtotals-bottom: Like outline-subtotals-top, except that subtotals are shown at the bottom (below the member's data, as in tabular layout mode).

<define name="table-data-pilot-layout-info-attlist" combine="interleave"> <attribute name="table:layout-mode"> <choice> <value>tabular-layout</value> <value>outline-subtotals-top</value> <value>outline-subtotals-bottom</value> </choice> </attribute> </define>

Add empty lines If the attribute table:add-empty-lines has the value true, an empty row is inserted in the data pilot table after the data (including the subtotals) for each member of the field. 5220 5221 5222 5223 5224

1 May 2005 Page 244 of 706

8.8.13 Data Pilot Field Reference The <table:data-pilot-field-reference> element describes data which can be used to modify the displayed values of data fields. 5225 5226 5227 5228 5229

Reference Field The table:field-name attribute references a category field whose members influence the displayed values of the data field the <table:data-pilot-field-reference> is part of. 5230 5231 5232 5233 5234

Reference Member Type The table:member-type attribute specifies the member of the referenced category field, whose value within the current data field has to be taken into account. If its value is next (previous) then the value of the data field for the next (previous) visible member of the referenced category field will be taken into account. If its value is named, then the table:member-name specifies the member whose value within the data field is taken into account. For previous and next, empty members are skipped. 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252

<define name="table-data-pilot-field-reference-attlist" combine="interleave"> <choice> <group> <attribute name="table:member-type"> <value>named</value> </attribute> <attribute name="table:member-name"> <ref name="string"/> </attribute> </group> <attribute name="table:member-type"> <choice> <value>previous</value> <value>next</value> </choice> </attribute> </choice> </define>

Reference Type The table:type attribute specifies the how the referenced category field influences the displayed values of the data field. It may have one of the following values: •

none: This value means that the results in the data fields are displayed unmodified.

1 May 2005 Page 245 of 706

5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267

•

member-difference: From each result, the value calculated for the category field member specified by the table:member-type and table:member-name attributes is subtracted.

•

member-percentage: Each result is divided by the value calculated for the category field member specified by the table:member-type and table:member-name attributes. Division by zero results in an error. Empty results are shown as “0”. If the table:membertype attribute has the value previous, “1” is displayed as first value. If the table:member-type attribute has the value next, “1” is displayed as last value.

•

member-percentage-difference: From each result, the value calculated for the category field member specified by the table:member-type and table:member-name attributes is subtracted, and the result is divided by this value again. Division by zero results in an error. Otherwise, the rules for member-difference apply.

•

running-total: Each result is added to the sum of the results for preceding members in the referenced category field, in the reference field's sort order, and the total sum is shown.

•

row-percentage: Each result is divided by the total result for its row in the data pilot table. If there are several data fields, the total for the result's data field is used. If there are subtotals with manually selected summary functions, the total is calculated with the data field's summary function. Division by zero results in an error.

•

column-percentage: Same as row-percentage, but the total for the result's column is used.

•

total-percentage: Same as row-percentage, but the grand total for the result's data field is used.

•

index: The row and column totals and the grand total are calculated as described above, and then are used to calculate the following expression: (original result * grand total ) / ( row total * column total ).Division by zero results in an error.

<define name="table-data-pilot-field-reference-attlist" combine="interleave"> <attribute name="table:type"> <choice> <value>none</value> <value>member-difference</value> <value>member-percentage</value> <value>member-percentage-difference</value> <value>running-total</value> <value>row-percentage</value> <value>column-percentage</value> <value>total-percentage</value> <value>index</value> </choice> </attribute> </define>

8.8.14 Data Pilot Groups The <table:data-pilot-groups> element specifies that a data pilot field is a group field. A group field allows grouping of other fields. For example, if a data pilot table contains a column field with the name “city” which has the members “Berlin”, “Munich”, “Frankfurt”, “Hamburg”, “London”, “Manchester”, “Hastings” and “Liverpool”, then one may want to group the cities by their countries. To do so, a group field with name “city2” could be added to the data pilot table, that contains two groups called “England” and “Germany”. Each group here contains a list of the names of its members. In this example, the group “England” would contain “London”, “Manchester”, “Hastings” and “Liverpool”. The group “Germany” would contain “Berlin”, “Munich”, “Frankfurt” and “Hamburg”.

1 May 2005 Page 246 of 706

Grouping may also take place for numeric or date values. 5268 5269 5270 5271 5272 5273 5274 5275

Source Field Name The table:source-field-name attribute references the field containing the data that is grouped, if this data differs from the data that is referenced by the field itself. 5276 5277 5278 5279 5280

Start If numeric or date values are grouped, the table:date-start and table:start attributes specify the start value for the grouping. All values that are lower than the start value are contained in a single group, while values that are equal to or higher than the start value are grouped as specified by the table:grouped-by and table:step attributes. If the attribute's value is auto, the lowest value of the field is taken as start value. 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296

End If numeric or date values are grouped, the table:date-end and table:end attributes specify the end value for the grouping. All values that are higher than the end value are contained in a single group, while values that are equal to or lower than the end value are grouped as specified by the table:grouped-by and table:step attributes. If the attribute's value is auto, the highest value of the field is taken as end value. 5297 5298 5299 5300 5301

1 May 2005 Page 247 of 706

5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312

Step The table:step attribute specifies the grouping of numeric values, by specifying the distance between the groups. For example, if the table:start attribute for the grouping has the value 5, and the table:step attribute has the value 2, all values that are equal to or higher than 5, but also lower than 7 are in one group. All values that are equal to or higher than 7, but also lower than 9 are in next group, and so on, until the end value is reached. 5313 5314 5315 5316 5317

Grouped By The table:grouped-by attribute specifies the grouping of the date values. Date values can be grouped by seconds, minutes, hours, days, months, quarters or years. It date values are for instance grouped by minutes, all dates or times that are within the same minute are within one group. That, is if the dates 2004-08-27T12:34:46, 2004-08-27T12:34:56 and 2004-0827T12:35:46 are given, the first two would be within one group, while the last date would be a group of its own. 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330

<define name="table-data-pilot-groups-attlist" combine="interleave"> <attribute name="table:grouped-by"> <choice> <value>seconds</value> <value>minutes</value> <value>hours</value> <value>days</value> <value>months</value> <value>quarters</value> <value>years</value> </choice> </attribute> </define>

8.8.15 Data Pilot Group If grouping takes place by specifying the member names, then the <table:data-pilotgroup> element specifies the member names of a single group. 5331 5332 5333 5334 5335 5336 5337

1 May 2005 Page 248 of 706

5338

</define>

Name The table:name attribute specifies the name of the group. 5339 5340 5341 5342 5343

8.8.16 Data Pilot Group Member The <table:data-pilot-group-member> element specifies the name of a single group member. 5344 5345 5346 5347 5348

Name The table:name attribute specifies the name of the member. 5349 5350 5351 5352 5353

8.9 Consolidation A consolidation combines data from several independent table ranges. A new table range is calculated by applying a mathematical function to all cells in the source table ranges that have the same relative address within these ranges. A consolidation is defined by the <table:consolidation> element. 5354 5355 5356 5357 5358 5359

The attributes that may be associated with this element are: •

Function

•

Source cell range addresses

•

Target cell address

•

Use label

•

Link to source data

1 May 2005 Page 249 of 706

Function The table:function attribute contains the function which is used to consolidate the data. Possible functions are auto, average, count, countnums, max, min, product, stdev, stdevp, sum, var and varp. 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378

<define name="table-consolidation-attlist" combine="interleave"> <attribute name="table:function"> <choice> <value>auto</value> <value>average</value> <value>count</value> <value>countnums</value> <value>max</value> <value>min</value> <value>product</value> <value>stdev</value> <value>stdevp</value> <value>sum</value> <value>var</value> <value>varp</value> <ref name="string"/> </choice> </attribute> </define>

Source Cell Range Addresses The table:source-cell-range-addresses attribute contains a list of cell range addresses that specify the source cell ranges. 5379 5380 5381 5382 5383

Target Cell Address The table:target-cell-address attribute contains the target cell address. 5384 5385 5386 5387 5388

Use Label The table:use-label attribute specifies whether or not labels should be used by the consolidation for rows, columns or both. Possible values are none, column, row and both. If labels are used for rows or columns, the mathematical functions is applied to cells with equally labeled rows or columns rather than to cells with the same relative cell address. 5389 5390 5391 5392 5393 5394 5395

<define name="table-consolidation-attlist" combine="interleave"> <optional> <attribute name="table:use-labels" a:defaultValue="none"> <choice> <value>none</value> <value>row</value> <value>column</value>

1 May 2005 Page 250 of 706

5396 5397 5398 5399 5400

Link to Source Data The table:link-to-source-data attribute specifies whether the data in the consolidation table range should be linked to the source data, so that it is automatically updated if any changes are made to the source data. 5401 5402 5403 5404 5405 5406 5407

8.10 DDE Links The <table:dde-links> container element stores all DDE links within a spreadsheet document. Every link contains the DDE Source and the data of the last connection. See section 12.6.3 for details. 5408 5409 5410 5411 5412 5413 5414

8.11 Change Tracking in Spreadsheets Within spreadsheet documents, changes to tables can be tracked. This section describes how this change tracking information is represented. Change tracking of tables is not supported for text documents.

8.11.1 Tracked Changes All changes that have been applied to a spreadsheet document are stored in a list. The list contains an element for each change made to the document. To track the changes to a spreadsheet document, the <table:tracked-changes> element must be present. 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427

1 May 2005 Page 251 of 706

Track Changes The table:track-changes attribute specifies whether or not the change tracking is enabled. 5428 5429 5430 5431 5432 5433 5434

8.11.2 Insertion The <table:insertion> element contains the information that is required to identify any insertion of content. This content can be one or more rows, one or more columns, or a table. 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447

The attributes that may be associated with this element are: •

ID (see section 8.11.18)

•

Acceptance State (see section 8.11.18)

•

Rejecting Change ID (see section 8.11.18)

•

Type

•

Position

•

Count

•

Table

Type The table:type attribute specifies the type of the insertion. It can be row, column or table. 5448 5449 5450 5451 5452 5453 5454 5455 5456

<define name="table-insertion-attlist" combine="interleave"> <attribute name="table:type"> <choice> <value>row</value> <value>column</value> <value>table</value> </choice> </attribute> </define>

1 May 2005 Page 252 of 706

Position The table:position attribute specifies the position where the insertion was made in the table. Depending on the insertion type, It is either the number of a row, a column or a table. 5457 5458 5459 5460 5461

Count The table:count attribute specifies the count of inserted rows, columns or tables. 5462 5463 5464 5465 5466 5467 5468

Table The table:table attribute specifies the number of the table where the insertion took place. This attribute only exists for column and row insertions. 5469 5470 5471 5472 5473 5474 5475

Example: Insertion of text in a cell <table:tracked-changes> <table:insertion table:id="c001" table:acceptance-state="pending" table:type="column" table:position="5"> <office:change-info> <dc:creator>Sascha Ballach</dc:creator> <dc:date>1999-55-18T12:56:04</dc:date> </office:change-info> </table:insertion> </table:tracked-changes>

8.11.3 Dependencies The <table:dependencies> element contains the information on which other tracked changes a tracked change depends. Every element of the tracked-changes can contain a <table:dependencies> element. 5476 5477 5478 5479 5480 5481 5482

1 May 2005 Page 253 of 706

8.11.4 Dependence The <table:dependency> element contains the information about one change action on which the parent element depends. The change action on which the current depends is referenced by an id. 5483 5484 5485 5486 5487 5488 5489 5490

8.11.5 Deletions The <table:deletions> element contains all deletions which are performed while tracking a single change to a table. 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500

8.11.6 Cell Content Deletion The <table:cell-content-deletion> element specifies that a cell content has been deleted. It contains the address of the effected cell and its former content. If a text:id attribute is present, it specifies the id of a previously tracked change for the cell that gets deleted by the current change. 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515

8.11.7 Change Deletion The <table:change-deletion> element specified the id of a previously tracked change that gets deleted by the current change. 5516 5517

1 May 2005 Page 254 of 706

5518 5519 5520 5521 5522 5523 5524 5525

8.11.8 Deletion A <table:deletion> element contains content that was deleted while change tracking was enabled. The content of a cell that was deleted is either contained in the <table:dependencies>, or in the <table:deletions> element. 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541

The attributes that may be associated with this element are: •

ID (see section 8.11.18)

•

Acceptance State (see section 8.11.18)

•

Rejecting Change ID (see section 8.11.18)

•

Type

•

Position

•

Table

•

Multi Deletion Spanned

Type The table:type attribute specifies the type of the deletion. It can be row, column or table. 5542 5543 5544 5545 5546 5547 5548 5549 5550

<define name="table-deletion-attlist" combine="interleave"> <attribute name="table:type"> <choice> <value>row</value> <value>column</value> <value>table</value> </choice> </attribute> </define>

1 May 2005 Page 255 of 706

Position The table:position attribute specifies the position where the deletion was made in the table. Depending on the deletion type, It is either the number of a row, a column or a table. 5551 5552 5553 5554 5555

Table The table:table attribute specifies the number of the table where the deletion took place. This attribute only exists for column and row deletions. 5556 5557 5558 5559 5560 5561 5562

Multi Deletion Spanned If multiple columns or rows were deleted simultaneously, each deleted row or column gets its own <table:deletion> element. The element of the first deleted row or column in this case has to carry a table:multi-deletion-spanned attribute that specifies the total number of deleted rows or columns. 5563 5564 5565 5566 5567 5568 5569

8.11.9 Cut Offs A <table:cut-offs> element contains information about previously tracked insertions or movements where parts of the new content created by this operation now gets deleted. An example for this might be a cell range that has previously been moved and that now overlaps with a row that gets deleted. 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584

1 May 2005 Page 256 of 706

8.11.10 Insertion Cut Off The <table:insertion-cut-off> element contains the information where a insertion was deleted and which. 5585 5586 5587 5588 5589 5590

The attributes that may be associated with this element are: •

ID (see section 8.11.18)

•

position

Id The table:id attribute contains the id of the insertion where parts of now get deleted. 5591 5592 5593 5594 5595

Position The table:position attribute specifies the number of the row or column within the insertion that gets deleted. 5596 5597 5598 5599 5600

8.11.11 Movement Cut Off The <table:movement-cut-off> element contains the information where a movement was deleted and which. 5601 5602 5603 5604 5605 5606

The attributes that may be associated with this element are: •

ID (see section 8.11.18)

•

start position, end position, position

1 May 2005 Page 257 of 706

Start Position, End Position, Position The table:start-position, table:end-position and table:position attributes specify the position within the movement that gets deleted. If a single row or column gets deleted, the table:position attribute contains its number. If multiple rows or columns get deleted, the table:start-position and table:end-position attributes contain the number of the first (inclusive) and last (exclusive) deleted rows or columns. 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621

Example: Deletion of a column which do not contain content <table:tracked-changes> <table:deletion table:id="c002" table:acceptance-state="pending" table:type="column" table:position="9"> <office:change-info> <dc:creator>Sascha Ballach</dc:creator> <dc:date>1999-05-18T12:56:04</dc:creator> </office:change-info> </table:deletion> </table:tracked-changes>

8.11.12 Movement A <table:movement> element contains the information that is required to identify any movement of content. This content can be a cell content or a cell range content. 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635

The attributes that may be associated with this element are: •

ID (see section 8.11.18)

•

Acceptance State (see section 8.11.18)

•

Rejecting Change ID (see section 8.11.18)

1 May 2005 Page 258 of 706

8.11.13 Target Range Address, Source Range Address The <table:source-range-address> and <table:target-range-address> specify the source and target cell address or cell range address of a movement. 5636 5637 5638 5639 5640 5641

5642 5643 5644 5645 5646 5647 5648

5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660

The attributes that may be associated with these elements are either •

Column, Row, and Table, or

•

Start column, End column, Start row, End row, Start table, and End table

Column, Row, and Table If the range address is a cell address then the three attributes table:column, table:row and table:table specify the column, row and table number of the cell. 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671

Start Column, End Column, Start Row, End Row, Start Table, and End Table If the range address is a cell range address instead of a cell address, the attributes table:start-column, table:end-column, table:start-row, table:end-row, table:start-table and table:end-table specify the start and end columns, rows and tables of the range. Start and end numbers both are inclusive. 5672

1 May 2005 Page 259 of 706

5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691

Example: Moving a cell <table:tracked-changes> <table:movement table:id="ct1"> <table:source-range-address table:column="0" table:row="0" table:table="0"/> <table:target-range-address table:column="1" table:row="1" table:table="0"/> <office:change-info> <dc:creator>Michael Brauer</dc:creator> <dc:date>2003-12-29T11:46:13,21"</dc:date> </office:change-info> </table:movement> </table:tracked-changes>

8.11.14 Change Track Cell The <table:change-track-table-cell> element contains all information of a table cell which are needed inside the change tracking elements. The element is very similar to a <table:table-cell> element, but contains some additional information. 5692 5693 5694 5695 5696 5697 5698 5699

Cell Address If the cell is a formula cell, the table:cell-address attribute is required and specifies the original address of the cell used in calculations. 5700 5701 5702 5703 5704 5705 5706

1 May 2005 Page 260 of 706

Matrix Covered If the cell is a matrix cell and not the base of the matrix the, table:matrix-covered attribute is necessary and its value has to be true to indicate that the cell is contained in a matrix. 5707 5708 5709 5710 5711 5712 5713

Formulas and Values The change track table cells additionally supports the attributes table:formula, table:number-matrix-rows-spanned, table:number-matrix-columns-spanned, office:value-type, office:value, office:date-value, office:time-value and office:string-value as described in section 8.1.3. 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733

8.11.15 Cell Content Change A <table:cell-content-change> element contains the information that is required to identify changes of the cell content. 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747

The attributes that may be associated with this element are:

1 May 2005 Page 261 of 706

•

ID (see section 8.11.18)

•

Acceptance State (see section 8.11.18)

•

Rejecting Change ID (see section 8.11.18)

8.11.16 Cell Address The <table:cell-address> element contains the address of cell that is changed. Unlike other cell addresses, the address consists of the row, column and table number of the cell. This allows specifying addresses that are outside the valid cell address range, for instance have a negative column number. 5748 5749 5750 5751 5752 5753

The attributes that may be associated with this element are: •

Column, Row, and Table number (see section 8.11.13)

8.11.17 Previous The table:previous element contains the previous cell content which is overwritten by the current change. If a text:id attribute is present, it specifies the id of a previously tracked change for the cell that gets changed again by the current change. 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763

8.11.18 Common Change Tracking Attributes Id The table:id attribute specifies the id of the tracked change. 5764 5765 5766 5767 5768

Acceptance state The table:acceptance-state attribute specifies whether the tracked change has been accepted or rejected already, or whether an acceptance or rejection is still pending. 5769

1 May 2005 Page 262 of 706

5770 5771 5772 5773 5774 5775 5776 5777 5778 5779

<optional> <attribute name="table:acceptance-state" a:defaultValue="pending"> <choice> <value>accepted</value> <value>rejected</value> <value>pending</value> </choice> </attribute> </optional> </define>

Rejecting Change Id If the table:rejecting-change-id attribute is present, then the current change has been made to the table to implement the rejection of another previously tracked change. The attribute's value is the id of this previously tracked change that has been rejected. 5780 5781 5782 5783 5784 5785 5786

1 May 2005 Page 263 of 706

9 Graphic Content This chapter provides the specification for the core elements of graphic applications like drawing or presentation applications, and for graphical objects contained in non-graphical applications, like word processor or spreadsheet applications.

9.1 Enhanced Page Features for Graphical Applications 9.1.1 Handout Master For applications that support printing handout pages, this element is a template for automatically generating the handout pages. The element <style:handout-master> can contain any types of shapes. The most useful shape is the <draw:page-thumbnail>, which is replaced by actual pages from the document. The <style:handout-master> element is contained in the <office:master-styles> element. The <office:master-styles> must not contain more than one <style:handout-master> element. 5787 5788 5789 5790 5791 5792 5793 5794 5795

The attributes that may be associated with the <style:handout-master> element are: •

Presentation Page Layout (placeholder objects)

•

Page Layout (page size, margins etc.)

•

Page Style

•

Header Declaration

•

Footer Declaration

•

Date and Time Declaration

Presentation Page Layout The attribute presentation:presentation-page-layout-name links to a <style:presentation-page-layout> element. See section 14.15 for information on the presentation page layout element. This attribute is optional. 5796 5797 5798 5799 5800 5801 5802

1 May 2005 Page 264 of 706

Page Layout The style:page-layout-name attribute specifies a page layout which contains the sizes, border and orientation of the handout master page. See section 14.3 for details on page layouts. 5803 5804 5805 5806 5807

Page Style The attribute draw:style-name assigns an additional formatting attributes to a handout master page by assigning a drawing page style. This attribute is optional. The fixed family for page styles is drawing-page. 5808 5809 5810 5811 5812 5813 5814

Header Declaration The presentation:use-header-name attribute specifies the name of the header field declaration (see section 9.11.2) that is used for all header fields (see section 9.10.1) that are displayed on the handout master page. See also section 9.1.4.

Footer Declaration The presentation:use-footer-name attribute specifies the name of the footer field declaration (see section 9.11.3) that is used for all footer fields (see section 9.10.2) that are displayed on the handout master page. See also section 9.1.4.

Date and Time Declaration The presentation:use-date-time-name attribute specifies the name of the date-time field declaration (see section 9.11.4) that is used for all date-time fields (see section 9.10.3) that are displayed on the handout master page. See also section 9.1.4.

9.1.2 Layer Sets The element <draw:layer-set> may be contained in the master styles of graphical applications. It defines a set of layers. Layers group drawing objects. Drawing objects may be assigned to these layers with the help of their draw:layer-name attribute. 5815 5816 5817 5818 5819 5820 5821

1 May 2005 Page 265 of 706

9.1.3 Layer The <draw:layer> element defines a single layer. 5822 5823 5824 5825 5826 5827

Name Each element <draw:layer> is defined and referenced by its name that is contained in the draw:name attribute . Each drawing object inside a drawing or presentation document can be assigned to a layer. Layers virtually group the object. Each object that is assigned to a layer inherits the settings of the layer. 5828 5829 5830 5831 5832

Protection The draw:protected attribute specifies whether the drawing objects contain in the layer are protected from being modified. 5833 5834 5835 5836 5837 5838 5839

Display The draw:display attribute specifies whether the drawing objects contain in the layer are visible on the screen and/or printed. 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851

<define name="draw-layer-attlist" combine="interleave"> <optional> <attribute name="draw:display" a:defaultValue="always"> <choice> <value>always</value> <value>screen</value> <value>printer</value> <value>none</value> </choice> </attribute> </optional> </define>

9.1.4 Drawing Pages The element <draw:page> is a container for content in a drawing or presentation document. Drawing pages are used for the following:

1 May 2005 Page 266 of 706

•

Forms (see section 11.1)

•

Drawings (see section 9.2)

•

Frames (see section 9.3)

•

Presentation Animations (see section 9.7)

•

Presentation Notes (see section 9.1.5)

A master page must be assigned to each drawing page. 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872

The attributes that may be associated with the <draw:page> element are: •

Page name

•

Page style

•

Master page

•

Presentation page layout

•

Header declaration

•

Footer declaration

•

Date and time declaration

•

The elements that my be included in the <draw:page> element are: •

Forms

•

Shapes

•

Animations

•

Presentation notes

1 May 2005 Page 267 of 706

Page Name The draw:name attribute specifies the name of a drawing page. This attribute is optional; if it is used, the name must be unique. If it is not used, the application may generate a unique name. 5873 5874 5875 5876 5877 5878 5879

Page Style The attribute draw:style-name assigns an additional formatting attributes to a drawing page by assigning a drawing page style. This attribute is optional. The fixed family for page styles is drawing-page. For pages inside a presentation document, attributes from Presentation Page Attributes can also be used. 5880 5881 5882 5883 5884 5885 5886

Master Page Each drawing page must have one master page assigned to it. The master page: •

Defines properties such as the size and borders of the drawing page

•

Serves as a container for shapes that are used as a common background

The draw:master-page-name attribute specifies the name of the master page assigned to the drawing page. This attribute is required. 5887 5888 5889 5890 5891

Presentation Page Layout If the drawing page was created using a presentation page layout, the attribute presentation:presentation-page-layout-name links to the corresponding <style:presentation-page-layout> element. See section 14.15 for information on the presentation page layout element. This attribute is optional. 5892 5893 5894 5895 5896 5897 5898

1 May 2005 Page 268 of 706

ID The draw:id attribute assignes a unique ID to a drawing page. 5920 5921 5922 5923 5924 5925 5926

9.1.5 Presentation Notes Each drawing page element in a presentation can have an additional presentation notes page, which contains a preview of the corresponding drawing page and additional graphic shapes. A notes page is described by the <presentation:notes> element, that may be contained in the <draw:page> element. See section 14.4.2 for more information about this element.

1 May 2005 Page 269 of 706

Example: Drawing page <office:automatic-styles> <style:style style:name="gg3434" style:family="drawing-page"> <style:drawing-page-properties presentation:page-duration="5s"> </style:style> <style:style style:name="titledia" style:family="presentation-page-layout"> <presentation:placeholder presentation:object="title" svg:x="20%" svg:y="10%" svg:width="80%" svg:height="10%"/> <presentation:placeholder presentation:object="subtitle" svg:x="20%" svg:y="30%" svg:width="80%" svg:height="60%" /> </style:style> </office:automatic-styles> ... <office:body> <draw:page office:name="Page 1" draw:style-name="gg3434" draw:master-page-name="home" presentation:page-layout-name="titeldia"> <draw:rect .../> presentation:notes> <draw:text ...>this is a note</draw:text> </presentation:notes> </draw:page> </office:body>

9.2 Drawing Shapes This section describes drawing shapes that might occur within all kind of applications. 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947

9.2.1 Rectangle The <draw:rect> element represents a rectangular drawing shape. 5948 5949 5950 5951 5952 5953

1 May 2005 Page 270 of 706

5954 5955 5956 5957 5958 5959 5960 5961 5962

The attributes that may be associated with the <draw:rect> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16.

•

Round corners

Round Corners The attribute draw:corner-radius specifies the radius of the circle used to round off the corners of the rectangle. 5963 5964 5965 5966 5967 5968 5969

Example: Rectangular drawing shape <draw:rect svg:x="2cm" svg:y="3cm" svg:width="10cm" svg:height="20cm" svg:transform="rotate(45)" draw:style-name="object-with-shadow">

9.2.2 Line The <draw:line> element represents a line. 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982

The attributes that may be associated with the <draw:line> element are: •

Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position– see section 9.2.16.

•

Start point

•

End point

1 May 2005 Page 271 of 706

Start Point The start point attributes svg:x1 and svg:y1 specify the start coordinates of the line. 5983 5984 5985 5986 5987 5988 5989 5990

End Point The end point attributes svg:x2 and svg:y2 specify the end coordinates of the line. 5991 5992 5993 5994 5995 5996 5997 5998

9.2.3 Polyline The <draw:polyline> element represents a polyline drawing shape. Some implementations may ignore the size attribute, and instead determine the size of a shape exclusively from the shape data (i.e. polygon vertices). 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014

The attributes that may be associated with the <draw:polyline> element are: •

Position, Size, View box, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Points

1 May 2005 Page 272 of 706

Points The svg:points attribute stores a sequence of points, which are connected by straight lines. Each point consists of two coordinates. The coordinates are separated by a comma and the points are separated by white spaces. 6015 6016 6017 6018 6019

9.2.4 Polygon The <draw:polygon> element represents a polygon. A polygon is a closed set of straight lines. Some implementations may ignore the size attribute, and instead determine the size of a shape exclusively from the shape data (i.e. polygon vertices). 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035

The attributes that may be associated with the <draw:polygon> element are: •

Position, Size, View box, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Points – see section 9.2.3

9.2.5 Regular Polygon The <draw:regular-polygon> element represents a regular polygon. A regular polygon is a polygon that is specified by its number of edges (that is equal to the number of its corners), rather than by arbitrary points. 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047

1 May 2005 Page 273 of 706

6048 6049 6050

The attributes that may be associated with the <draw:polygon> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Concave

•

Corners

•

Sharpness

Concave The draw:concave attribute specifies whether the polygon is convex or concave. For a convex polygon, the polygon corners are located on a single ellipse which has its center in the center of the polygon. In a concave polygon, two such ellipses are required, and corners that are located next to each other are located on different ellipses. An example for a convex polygon is a hexagon. An example for a concave polygon is a star. For concave polygons, an additional draw:sharpness attribute is required. 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063

<define name="draw-regular-polygon-attlist" combine="interleave"> <choice> <attribute name="draw:concave"> <value>false</value> </attribute> <group> <attribute name="draw:concave"> <value>true</value> </attribute> <ref name="draw-regular-polygon-sharpness-attlist"/> </group> </choice> </define>

Corners The draw:corners attribute specifies the number of polygon corners. 6064 6065 6066 6067 6068

Sharpness For concave attributes, the draw:sharpness attribute specifies the radius of the ellipse on which the inner polygon corners are located. The value is a percentage, where 0% means that all corners are located on a single ellipse, while 100% means that the inner corners are located at the center point of the polygon. In general, if r is the radius of the polygon, and s is the sharpness, the inner corners a located on a ellipse that's radius is r(100-s)/100. 6069 6070 6071 6072

1 May 2005 Page 274 of 706

6073

</define>

9.2.6 Path The <draw:path> element represents a path. A path is a shape with a user-defined outline. The shape is built using multiple drawing actions such as: •

moveto – set a new current point

•

lineto – draw a straight line

•

curveto – draw a curve using a cubic Bezier

•

arc – draw an elliptical or circular arc

•

closepath – close the current shape by drawing a line to the last moveto

Compound paths are paths with subpaths, each subpath consisting of a single moveto followed by one or more line or curve operations. Compound paths can be used for effects such as holes in objects. Some implementations may ignore the size attribute, and instead determine the size of a shape exclusively from the shape data (i.e. polygon vertices). 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089

The attributes that may be associated with the <draw:path> element are: •

Position, Size, View box, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Path data

Path Data The syntax for the attribute svg:d is described in §8 of the Scalable Vector Graphics (SVG) 1.1 Specification [SVG]. Some implementations may only supports a subset of the SVG path specification, for instance no mixtures of open and closed curves for one shape, or no elliptical arc command. 6090 6091 6092 6093 6094

1 May 2005 Page 275 of 706

9.2.7 Circle The <draw:circle> element represents a circular drawing shape. 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110

The attributes that may be associated with the <draw:circle> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Center point

•

Radius

•

Kind

•

Start angle

•

End angle

Center Point The center point attributes svg:cx and svg:cy specify the coordinates of the center point of the circle. If these optional attributes are not set, the position and size attributes are used to create them. 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120

Radius The svg:r attribute specifies the radius of the circle. If this optional attribute are not set, the position and size attributes are used to create circle. 6121 6122 6123 6124

1 May 2005 Page 276 of 706

6125 6126 6127

</attribute> </optional> </define>

Kind The draw:kind attribute specifies the appearance of the circle.

6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139

•

full specifies a full circle or ellipse, like

•

section specifies a section of a circle or ellipse, like

•

cut specifies a circle or ellipse with a cut, like

•

arc specifies a circle or ellipse arc, like

<define name="common-draw-circle-ellipse-attlist" combine="interleave"> <optional> <attribute name="draw:kind" a:defaultValue="full"> <choice> <value>full</value> <value>section</value> <value>cut</value> <value>arc</value> </choice> </attribute> </optional> </define>

Start Angle For circles where the draw:kind attribute value is section, cut or arc, the svg:startangle attribute specifies the start angle of the section, cut, or arc. 6140 6141 6142 6143 6144 6145 6146

End Angle For circles where the draw:kind attribute value is section, cut or arc, the svg:end-angle attribute specifies the end angle of the section, cut, or arc. 6147 6148 6149 6150 6151 6152 6153

9.2.8 Ellipse The <draw:ellipse> element represents an ellipse. 6154

1 May 2005 Page 277 of 706

6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169

The attributes that may be associated with the <draw:ellipse> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Center point, Kind, Start angle, End angle – see section 9.2.7

•

Radius

Radius The svg:rx and svg:rx attribute specify the horizontal and vertical radius of the ellipse. If these optional attributes are not set, the position and size attributes are used to create the ellipse. 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179

9.2.9 Connector The <draw:connector> element represents a series of lines that are connected to the glue points of two other shapes. 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192

The attributes that may be associated with the <draw:connector> element are:

1 May 2005 Page 278 of 706

•

Style, Layer, Z-Index and ID – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Type

•

Start position

•

Start shape

•

Start glue point

•

End position

•

End shape

•

End glue point

•

Line skew

Type The draw:type attribute specifies how the connection between two points is rendered. The value of this attribute can be standard, lines, line, or curve.

6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204

•

standard: a standard connector escapes the two connecting objects with straight lines and connects them with a straight perpendicular line.

•

lines: a lines connector escapes the two connecting objects with straight lines and connects them with a straight (not necessarily perpendicular) line.

•

line: a line connector draws one straight line between the two escape points of the connected objects.

•

curve: a curve connector draws a single curved line between the two escape points of the connected objects.

<define name="draw-connector-attlist" combine="interleave"> <optional> <attribute name="draw:type" a:defaultValue="standard"> <choice> <value>standard</value> <value>lines</value> <value>line</value> <value>curve</value> </choice> </attribute> </optional> </define>

Start Position The start position attributes svg:x1 and svg:y1 specify the start position of a connector. If the start position is connected to a shape, these attributes are optional because the start position defaults to the corresponding glue point on the target shape. 6205 6206 6207 6208 6209

1 May 2005 Page 279 of 706

6210 6211 6212 6213 6214

Start Shape The draw:start-shape attribute identifies the drawing shape to which the start of this connector is connected by its name. If a shape is connected to the start of a connector, the start position defaults to the corresponding glue point on the target shape. 6215 6216 6217 6218 6219 6220 6221

Start Glue Point The draw:start-glue-point attribute identifies the glue point in the start shape of the connector by its number. See section 9.2.19 for details on glue points. If this attribute is not set and the start of the connector is connected to a shape, the application may choose the glue point. If the start of the connector is not connected to a shape, this attribute is ignored. 6222 6223 6224 6225 6226 6227 6228

End Position The end position attributes svg:x2 and svg:y2 specify the end position of a connector. If the end position is connected to a shape, these attributes are optional because the end position defaults to the corresponding glue point on the target shape. 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238

1 May 2005 Page 280 of 706

End Shape The draw:end-shape attribute identifies the drawing shape to which the end of the connector is connected by its name. If a shape is connected to the end of a connector, the end position defaults to the corresponding glue point on the target shape. 6239 6240 6241 6242 6243 6244 6245

End Glue Point The draw:end-glue-point attribute identifies the glue point in the end shape of the connector by its number. See section 9.2.19 for details on glue points. If this attribute is not set and the end of the connector is connected to a shape, the application may choose the glue point. If the end of the connector is not connected to a shape, this attribute is ignored. 6246 6247 6248 6249 6250 6251 6252

Line Skew The draw:line-skew attribute controls the generation of the lines that connect the start and end points. Depending on the type of connector, this can vary from one to three distances that move the connector lines relative to their normal position. 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267

9.2.10 Caption The <draw:caption> element represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing. 6268

1 May 2005 Page 281 of 706

6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282

The attributes that may be associated with the <draw:caption> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Caption point

•

Round corners

Caption Point The caption point attributes draw:caption-point-x and draw:caption-point-y specify the position of the point that is captioned. A set of lines are rendered from the caption area. 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292

Round Corners The draw:corner-radius attribute specifies the radius of the circle used to round off the corners of the caption. 6293 6294 6295 6296 6297 6298 6299

9.2.11 Measure The <draw:measure> element represents a shape that is used to measure distances in drawings. 6300 6301 6302

1 May 2005 Page 282 of 706

6303 6304 6305 6306 6307 6308 6309 6310 6311 6312

The attributes that may be associated with the <draw:measure> element are: •

Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15

•

Text anchor, table background, draw end position – see section 9.2.16

•

Start position

•

End position

Start Position The attributes svg:x1 and svg:y1 specify the start point of the measured distance. 6313 6314 6315 6316 6317 6318 6319 6320

Draw End Position The attributes svg:x2 and svg:y2 specify the end point of the measured distance. 6321 6322 6323 6324 6325 6326 6327 6328

9.2.12 Control The <draw:control> element represents a shape that is linked to a control inside an <office:forms> element (see section 11.1). 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338

1 May 2005 Page 283 of 706

6339

</define>

The attributes that may be associated with the <draw:control> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16

•

Control

Control The attributes draw:control attribute specifies the control within a form (see section 11.5.2) that is linked to the control shape. 6340 6341 6342 6343 6344

9.2.13 Page Thumbnail The <draw:page-thumbnail> element represents a rectangular area that displays the thumbnail of a drawing page. 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354

The attributes that may be associated with the <draw:page-thumbnail> element are: •

Position, Size, Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16

•

Presentation class – see section 9.6.1

•

Page number

Page Number The draw:page-number attribute specifies the number of the page that is displayed as a thumbnail. For thumbnails on notes pages, the value of this attribute is fixed to the drawing page of the notes page. For thumbnails on handout master pages, the value of this attribute is the order in which the pages are previewed on the handout. For example, on a handout page with 4 thumbnails, the thumbnail with the lowest page number renders the first page when printing the first handout page and the fifth page when printing the second handout page and so on. 6355 6356 6357 6358 6359

1 May 2005 Page 284 of 706

6360 6361

</optional> </define>

9.2.14 Grouping The <draw:g> element represents a group of drawing shapes. 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380

The attributes that may be associated with the <draw:g> element are: •

Style, Z-Index and ID – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16

•

Position

Position For group shapes that are contained in text documents and anchored as character, the svg:y attribute specifies the vertical position of the shape. 6381 6382 6383 6384 6385 6386 6387

9.2.15 Common Drawing Shape Attributes The attributes described in this section are common to all drawing shapes.

Name The attribute draw:name assigns a name to the drawing shape. 6388 6389 6390 6391 6392

1 May 2005 Page 285 of 706

6393 6394

</optional> </define>

Position The position attributes svg:x and svg:y specify the x and y coordinates of the start position of the drawing shape. 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406

Size The attributes svg:width and svg:height specify the width and height of the drawing shape. 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418

Transformation The draw:transform attribute specifies a list of transformations that can be applied to a drawing shape. The value of this attribute is a list of transform definitions, which are applied to the drawing shape in the order in which they are listed. The transform definitions in the list must be separated by a white space and/or a comma. The types of transform definitions available include: •

matrix(<a> <b> <c> <d> <e> <f>), which specifies a transformation in the form of a transformation matrix of six values. matrix(a,b,c,d,e,f) is the equivalent of applying the transformation matrix [a b c d e f].

•

translate(<tx> [<ty>]), which specifies a translation by tx and ty.

•

scale(<sx> [<sy>]), which specifies a scale operation by sx and sy. If <sy> is not provided, it is assumed to be equal to <sx>.

•

rotate(<rotate-angle>), which specifies a rotation by <rotate-angle> about the origin of the shapes coordinate system.

•

skewX(<skew-angle>), which specifies a skew transformation along the X axis.

1 May 2005 Page 286 of 706

• 6419 6420 6421 6422 6423 6424 6425

skewY(<skew-angle>), which specifies a skew transformation along the Y axis.

View Box The svg:viewBox attribute establishes a user coordinate system inside the physical coordinate system of the shape specified by the position and size attributes. This user coordinate system is used by the svg:points attribute and the <draw:path> element. The syntax for using this attribute is the same as the [SVG] syntax. The value of the attribute are four numbers separated by white spaces, which define the left, top, right, and bottom dimensions of the user coordinate system. Some implementations may ignore the view box attribute. The implied coordinate system then has its origin at the left, top corner of the shape, without any scaling relative to the shape. 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435

Style The draw:style-name and presentation:style-name attributes specify a style for the drawing shape. If draw:style-name is used, the shape is a regular graphic shape. If presentation:style-name is used, the shape is a presentation shape as described in section 9.6. The value of both attributes is the name of a <style:style> element. If the draw:stylename attribute is used, the style must have a family value of graphic. If the presentation:style-name is used, the style must have a family value of presentation. The formatting properties of the specified style and its optional parent styles are used to format the shape. See also section 14.13.1. The draw:class-names and presentation:class-names attributes take a whitespace separated list of either graphic or presentation style names. The referenced styles are applied in the order they are contained in the list. If both, draw:style-name and draw:class-names, or both presentation:style-name and presentation:class-names are present, the style referenced by the style-name attribute is treated as the first style in the list in the classnames attribute. Conforming application should support the class-names attribute and also should preserve it while editing. 6436 6437 6438 6439 6440

1 May 2005 Page 287 of 706

6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463

Text Style The draw:text-style-name attribute specifies a style for the drawing shape that is used to format the text that can be added to this shape. The value of this attribute is the name of a <style:style> element with a family value of paragraph. 6464 6465 6466 6467 6468 6469 6470

Layer The attribute draw:layer can assign each shape to a layer. The value of this attribute must be the name of a layer inside the layer-set of the document. 6471 6472 6473 6474 6475 6476 6477

ID The draw:id attribute assigns an unique ID to a drawing shape that can be used to reference the shape. 6478 6479 6480 6481

1 May 2005 Page 288 of 706

6482 6483 6484

</attribute> </optional> </define>

Z-Index Drawing shapes are rendered in a specific order. In general, the shapes are rendered in the order in which they appear in the XML document. To change the order, use the svg:width and svg:height attribute. This attribute is optional. 6485 6486 6487 6488 6489 6490 6491

9.2.16 Common Shape Attributes for Text and Spreadsheet Documents The attributes described in this section are common to all drawing shapes contained in text and spreadsheet documents.

End Position If a drawing shape is included in a spreadsheet document and if the anchor of the shape is in a cell, then the attributes table:end-cell-address, table:end-x and table:end-y specify the end position of the shape and the size attributes are ignored. The end position is specified using the cell address of the cell in which the end position is located, and the x and y coordinates of the end position relative to the top left edge of the cell. 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508

Table Background If a drawing shape is included in a spreadsheet document, then the table:tablebackground attribute specifies whether or not the shape is in the table background. If the attribute is not existing, the shape is included in the foreground of the table. 6509

1 May 2005 Page 289 of 706

6510 6511 6512 6513 6514 6515

Text Anchor Within text documents, the anchor type attribute text:anchor-type specifies how a frame is bound to the text document. The anchor position is the point at which a frame is bound to a text document. The anchor position depends on the anchor type as explained in the following table. If the value of the text:anchortype attribute is ...

The anchor position is...

page

The page that has the Either same physical page • At the start of the number as the value of document body, the text:anchor-pageoutside any number attribute that is paragraph or frame, attached to the drawing provided a shape element. If no text:anchortext:anchor-pagepage-number number attribute is given, attribute is given. the anchor position is the page at which the Or character behind the drawing object element • Inside any paragraph appears. element that is not contained in a header, footer, footnote, or text box, if a text:anchorpage-number attribute is not given.

frame

The parent text box that In the element the current drawing shape representing the text box element is contained in. to which the drawing object is bound. For example, if an image is bound to a text box, the image element is located in the text box element.

paragraph

The paragraph that the current drawing shape element is contained in.

At the start of the paragraph element.

char

The character after the drawing shape element.

Just before the character.

The drawing shape element appears ...

Notes

The physical page number is the number assigned to the page if all pages in the document are counted starting with page 1.

1 May 2005 Page 290 of 706

6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532

If the value of the text:anchortype attribute is ...

The anchor position is...

as-char

There is no anchor position. The drawing shape behaves like a character.

The drawing shape element appears ...

Notes

At the position where the character appears in the document.

<define name="common-text-spreadsheet-shape-attlist" combine="interleave"> <ref name="common-text-anchor-attlist"/> </define> <define name="common-text-anchor-attlist" combine="interleave"> <optional> <attribute name="text:anchor-type"> <choice> <value>page</value> <value>frame</value> <value>paragraph</value> <value>char</value> <value>as-char</value> </choice> </attribute> </optional> </define>

Anchor Page Number Within text documents, the text:anchor-page-number attribute specifies the physical page number of an anchor if the drawing object is bound to a page. 6533 6534 6535 6536 6537 6538 6539

9.2.17 Common Drawing Shape Content Most drawing shapes may contain text content. The text content may contain paragraphs (see section 4.1.2) as well as lists (see section 4.3). 6540 6541 6542 6543 6544 6545 6546 6547

9.2.18 Common Shape Attribute Groups The following defined attributes are common for all shapes that supports styles and no text. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved.

1 May 2005 Page 291 of 706

6548 6549 6550 6551 6552 6553 6554 6555 6556

The following defined attributes are common for all shapes that supports styles and text. 6557 6558 6559 6560

9.2.19 Glue Points Glue points are designated points on the area of a drawing object to which a connector shape can connect. Most drawing objects have four standard glue points at the four edges of the object. Additional glue points may be added to a drawing object by inserting one or more <draw:gluepoint> elements into a drawing object element. A <draw:glue-point> element creates a single user-defined glue point if placed inside a drawing object element, for example, a <draw:rectangle> element. 6561 6562 6563 6564 6565 6566

ID The draw:id attribute contains the id of the glue point. The id a number and is used inside the draw:start-glue-point and draw:end-glue-point attributes of a <draw:connector> element. The Ids 0 to 3 are reserved for the 4 standard glue points that most drawing objects have. The glue points are numbered clockwise, starting at the top left corner of the shape. 6567 6568 6569 6570 6571

Position The svg:x and svg:y attributes specifies the position of the glue point. The coordinates are either percentage values relative to the drawing objects center or, if the draw:align attribute is also specified, absolute distance values relative to the edge specified with the draw:align attribute. 6572 6573 6574 6575 6576 6577 6578 6579

1 May 2005 Page 292 of 706

6580 6581 6582 6583 6584 6585

Align The attribute draw:align specifies the alignment behavior of the glue point if the drawing object is resized and the shape edge to which the glue point's position relates. A missing vertical or horizontal position in the attribute's value means that the glue point is horizontally or vertically centered. 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599

<define name="draw-glue-point-attlist" combine="interleave"> <attribute name="draw:align"> <choice> <value>top-left</value> <value>top</value> <value>top-right</value> <value>left</value> <value>center</value> <value>right</value> <value>bottom-left</value> <value>bottom-right</value> </choice> </attribute> </define>

Escape Direction The attribute draw:escape-direction specifies the direction in which the connection line escapes from the drawing object if a connector connects to the glue point. The value horizontal means the the connection line may escape to the left or to the right, the value vertical means that the connection line may escape up or down. The value auto means that the connection line may escape in all four directions. 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612

<define name="draw-glue-points-attlist" combine="interleave"> <attribute name="draw:escape-direction"> <choice> <value>auto</value> <value>left</value> <value>right</value> <value>up</value> <value>down</value> <value>horizontal</value> <value>vertical</value> </choice> </attribute> </define>

9.2.20 Event Listeners Drawing shapes may have event listeners attached. The event listeners that are attached to, for example, a text box or an image, are represented by an event element as described in section 12.4. This element is contained within the drawing object element, for example, the <draw:text-box> element or the <draw:image> element.

1 May 2005 Page 293 of 706

9.3 Frames A frame is a rectangular container where that contains enhanced content like text boxes, images or objects. Frames are very similar to regular drawing shapes, but support some features that are not available for regular drawing shapes, like contours, image maps and hyperlinks. In particular, a frame allows to have multiple renditions of an object. That is, a frame may for instance contain an object as well as an image. In this case, the application may choose the content that it supports best. If the application supports the object type contained in the frame, it probably will render the object. If it does not support the object, it will render the image. In general, an application must not render more than one of the content elements contained in a frame. The order of content elements dictates the document author's preference for rendering, with the first child being the most preferred. This means that applications should render the first child element that it supports. A frame must contain at least one content element. The inclusion of multiple content elements is optional. Application may preserve the content elements they don't render, but don't have to. Within text documents, frames are also used to position content outside the default text flow of a document. Frames can contain: •

Text boxes

•

Objects represented either in the OpenDocument format or in a object specific binary format

•

Images

•

Applets

•

Plug-ins

•

Floating frames

Like the formatting properties of drawing shapes, frame formatting properties are stored in styles belonging to the graphic family. The way a frame is contained in a document also is the same as for drawing shapes. 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637

1 May 2005 Page 294 of 706

6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650

The attributes that may be associated with the <draw:frame> element are: •

Position, Size (relative sizes, see below), Style, Layer, Z-Index, ID, and Transformation – see section 9.2.15.

•

Text anchor, table background, draw end position – see section 9.2.16

•

Presentation class – see section 9.6.1

•

Copy frames

The following elements may be contained in the image element: •

Event Listeners – see section 12.4.

•

Glue Points – see section 9.2.19.

•

Image Map – see section 9.3.11.

•

Alternative Text – see section 9.3.9.

•

Contour – see section 9.3.8.

Relative Sizes For frames, the width and height of the drawing object may be specified as an relative value using the style:rel-width and style:rel-height attributes. The relative value either is a percentage value, the special value scale, or the special value scale-min. The interpretation of relative values depends on the anchor of the drawing object. If the anchor for the drawing object is in a table cell, the percentage value relates to the surrounding table box. If the anchor for the drawing object is in a text box, the percentage value relates to the surrounding text box. In other cases, the percentage values relate to the width of the page or window. The value scale for the width means that the width should be calculated depending on the height, so that the ratio of with and height of the original image or object size is preserved. The value scale for the height means that the height should be calculated depending on the width, so that the ratio of with and height of the original image or object size is preserved. The value scale-min equals the value scale, except that the calculated width or height is a minimum height rather than an absolute one. To support application that don't support relative with and heights, applications that save the attributes style:rel-width or style:rel-height should also provide the real width and heights in the svg:width and svg:height/fo:min-height attributes.

1 May 2005 Page 295 of 706

6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671

<define name="common-draw-rel-size-attlist"> <ref name="common-draw-size-attlist"/> <optional> <attribute name="style:rel-width"> <choice> <ref name="percent"/> <value>scale</value> <value>scale-min</value> </choice> </attribute> </optional> <optional> <attribute name="style:rel-height"> <choice> <ref name="percent"/> <value>scale</value> <value>scale-min</value> </choice> </attribute> </optional> </define>

Copy Frames Multiple frames can be set to display the exact same underlying data: for instance for a company logo, that must appear somewhere on every page, without being part of a header or footer. A frame can be set to display the contents of another frame, referenced by the draw:copy-of attribute. This does not effect style and position information. This is, the frame that has the draw:copy-of attribute has its own style and position information and does not use the one of the referenced frame. 6672 6673 6674 6675 6676 6677 6678

9.3.1 Text Box The <draw:text-box>element represents a text box. A text box may be used to place text in a container that is outside of the normal flow of the document. 6679 6680 6681 6682 6683 6684 6685 6686

The attributes that may be associated with the <draw:text-box> element are: •

Chain

•

Round Corners

•

Minimum Height and Width

•

Maximum Height and Width

1 May 2005 Page 296 of 706

Text boxes don't support contours as described in section 9.3.8 and alternative texts as described in section 9.3.9.

Chain Text boxes can be chained, in other words, if the content of a text box exceeds its capacity, the content flows into the next text box in the chain. To chain text boxes, the attribute draw:chainnext-name is used, The value of this attribute is the name of the next text box in the chain. Chained text boxes usually are supported by text documents only. 6687 6688 6689 6690 6691 6692 6693

Round Corners The attribute draw:corner-radius specifies the radius of the circle used to round off the corners of the text-box. 6694 6695 6696 6697 6698 6699 6700

Minimum Height and Width The fo:min-height and fo:min-width attributes specify a minimum height or width for a text box. If they are existing, they overwrite the height or width of a text box specified by the svg:height and svg:width attributes of the surrounding <draw:frame> element. Their value can be either a length or a percentage. If the anchor for the text box is in a table cell, the percentage value relates to the surrounding table box. If the anchor for the text box is in a text box, the percentage value relates to the surrounding text box. In other cases, the percentage values relate to the height of the page or window. 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718

1 May 2005 Page 297 of 706

Maximum Height and Width If the width or height of a text box is specified as a minimum width or height (using the fo:minwidth or fo:min-height attributes), then the fo:max-width and fo:max-height attributes specify a maximum width and height for the text box. When these maximum values are reached, the text box stops increasing in size. The attributes' value can be either a length or a percentage. If the anchor for the text box is in a table cell, the percentage value relates to the size of the surrounding table cell. If the anchor for the text box is in a text box, the percentage value relates to the size of the surrounding text box. In other cases, the percentage values relate to the width or height of the page or window. 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736

9.3.2 Image The <draw:image> element represents an image. An image can be either: •

Contained in a document as a link to an external resource

or •

Embedded in a document

This element can be an [XLink], in which case the element contains some attributes with fixed values that describe the link semantics. While the image data may have an arbitrary format, it is recommended that vector graphics are stored in the [SVG] format and bitmap graphics in the [PNG] format. 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746

The attributes that may be associated with the <draw:image> element are: •

Image data

•

Filter name

1 May 2005 Page 298 of 706

Like most other drawing shapes, image drawing shapes may have text content. It is displayed in addition to the image data.

Image Data The image data can be stored in one of the following ways: •

The image data is contained in an external file. Use the xlink:href and associated attributes described below to link to the external file.

•

The image data is contained in the <draw:image> element. The <draw:image> then element contains an <office:binary-data> element that contains the image data in BASE64 encoding. In this situation the xlink:href attribute is not required.

6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774

<define name="common-draw-data-attlist" combine="interleave"> <group> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> <optional> <attribute name="xlink:type" a:defaultValue="simple"> <choice> <value>simple</value> </choice> </attribute> </optional> <optional> <attribute name="xlink:show" a:defaultValue="embed"> <choice> <value>embed</value> </choice> </attribute> </optional> <optional> <attribute name="xlink:actuate" a:defaultValue="onLoad"> <choice> <value>onLoad</value> </choice> </attribute> </optional> </group> </define>

6775 6776 6777 6778 6779 6780

Filter Name If required, the draw:filter-name attribute can represent the filter name of the image. This attribute contains the internal filter name that the office application software used to load the graphic. 6781 6782 6783 6784 6785 6786 6787

1 May 2005 Page 299 of 706

9.3.3 Objects A document in OpenDocument format can contain two types of objects, as follows: •

•

Objects that have an OpenDocument representation. These objects are: –

Formulas (represented as [MathML])

–

Charts

–

Spreadsheets

–

Text documents

–

Drawings

–

Presentations

Objects that do not have an XML representation. These objects only have a binary representation, An example for this kind of objects OLE objects (see [OLE]).

The <draw:object> element represents objects that have a XML representation. The <draw:object-ole> element represents objects that only have a binary representation. 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797

6798 6799 6800 6801 6802 6803 6804 6805 6806 6807

The attributes that may be associated with the <draw:object> and <draw:object-ole> elements are: •

Object data

•

Table Change Notifications

•

Class Id

Objects do not support transformations as described in section 9.2.15.

Object Data The object data can be called in one of the following ways: •

The xlink:href attribute links to the object representation, as follows:

1 May 2005 Page 300 of 706

–

For objects that have an XML representation, the link references the sub package of the object. The object is contained within this sub page exactly as it would as it is a document of its own.

–

For objects that do not have an XML representation, the link references a sub stream of the package that contains the binary representation of the object.

Application that support objects should support linking to objects that are contained within the same package. They may also support linking to object located outside the package. •

The object data is contained in the <draw:object> or <draw:object-ole> element, as follows: –

The <draw:object> element contains the XML representation of the object, for example, an <office:document> or a <math:math> element.

–

The <draw:object-ole> element contains an <office:binary-data> element, which contains the binary data for the object in BASE64 encoding.

In these situations, the xlink:href attributes are not required. The xlink:href attribute is described in section 9.3.2. It is recommended to include an image representation of the object into the frame in addition to the object itself.

Notification on Table Change Some objects, especially charts, may require a notification when a table in the document changes. To enable this notification, use the draw:notify-on-change-of-table attribute, which contains the name of the table. This attribute can be associated with the <draw:object> element. 6808 6809 6810 6811 6812 6813 6814

Class Id The draw:class-id optionally contains the OLE class id of the object (see also [OLE]). 6815 6816 6817 6818 6819

9.3.4 Applet An applet is a small Java-based program that is embedded in a document. The <draw:applet> element is based on the <applet> tag in [HTML4]. This element must contain either the draw:code or draw:object attribute. 6820 6821 6822

1 May 2005 Page 301 of 706

6823 6824 6825 6826 6827 6828 6829 6830

The attributes that may be associated with the <draw:applet> element are: •

Codebase

•

Code

•

Object

•

Categories

•

Data Point

•

Mean Value

•

Error Indicator

•

Regression Curves

10.1 Introduction to Chart Documents Chart documents are always contained within other XML documents. There are two types of chart container documents: ● Documents that do not provide data for the chart: The chart data is contained in a

<table:table> element inside the <chart:chart> element. ● Documents that provide data for the chart: The chart data may be contained in a

<table:table> element in the parent document, for example, in a spreadsheet or text document. The chart data is specified by the <chart:plot-area> element's table:cell-rangeaddress attribute. The <chart:plot-area> element represents the visualization container of all data series in the chart.

10.2 Chart The <chart:chart> element represents an entire chart, including titles, a legend, and the graphical object that visualizes the underlying data called the plot area. The data underlying the chart is represented by a table element. This element may also exist for embedded charts that get the data from the container document. In this case the chart can be rendered without getting the data from the container document.

1 May 2005 Page 366 of 706

8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448

Class The chart:class attribute specifies the chart type. The chart type is represented by a namespaced token, meaning an identifier prefixed by an XML namespace prefix, just like any attribute or element name in this specification. This specification defines a number of chart types in the chart namespace (URN: urn:oasis:names:tc:opendocument:xmlns:chart:1.0). Additional chart types may be supported by using a different namespace. The chart type may be specified more precisely with formatting properties that may be attached to chart styles. For example, a 3D bar chart with horizontal bars is specified by setting the class attribute to chart:bar and an by adding the properties for three dimensional and horizontal arrangement in the corresponding style. 8449 8450 8451 8452 8453

The pre-defined chart types are: •

line – the data points of each data series are connected through lines.

•

area – the area below a data series is filled, and additional data series are stacked.

•

circle – a circular chart is segmented according to the relative weights of the data points.

•

ring – each data series is represented as a concentric rings, with each ring rendered as if it was part of a circle chart of the series.

•

scatter – a pair of data series is used to determine x and y positions for each data point.

•

radar – a radial plot of the data points, where the value of each point determines the distance from the chart origin. The data points of a series are connected, thus forming a closed line around the center.

•

bar – each data point is depicted by a bar whose length is proportional to the data value.

•

stock – four data series are interpreted as opening, minimum, maximum and closing stock values.

1 May 2005 Page 367 of 706

•

bubble – the first two of three data series are interpreted a positions as in a scatter chart, where the area of each data point is sized relative to the value in the third data series.

•

surface – the data points are interpreted as tabular data, where each value defines a 'height' at a specific grid location. The graph may visualize these using colors for height intervals, creating color bands similar to geographical maps.

•

gantt – a pair of data series is used to determine the start and end positions for horizontal bars Example: The following table shows examples for the pre-defined chart types. Those charts that use one or two data series use two data series with the values 1;2;3;4 and 1;4;9;16 and the labels a;b;c;d. Those chart types that use more than two data series (stock and bubble) use the data series 1;2;3;4 and multiples thereof. The radar chart uses two data series with five data points.

chart:line

chart:area

chart:circle

chart:ring

chart:scatter

chart:radar

chart:bar

chart:stock

chart:bubble

1 May 2005 Page 368 of 706

chart:surface

chart:gantt

Size The svg:width and svg:height (see section 9.2.15) attributes define the extent of the entire chart. If they are omitted, the size of the chart is determined by the size of the window in which the chart is displayed. 8454 8455 8456

Column and Row Mapping The chart:column-mapping and chart:row-mapping attributes contain, if provided, a list of indexes of series. The numbers define a reordering of data that comes from a container document that provides the data for the chart. The numbering begins with 1. A list of ascending numbers beginning with 1 has no effect. To exchange two series, their numbers must be exchanged in the list. For example, 1 3 2 4 exchanges the second and the third series. The chart:column-mapping and chart:row-mapping attributes must not be used simultaneously. 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470

Style Name The chart:style-name attribute references a chart style. See section 14.16 for details. Within the style applied to the <chart:chart> element, fill properties (described in section 15.14) and the stroke properties (described in section 15.13) as well as the scale text property described in section 15.29.1 can be used.

1 May 2005 Page 369 of 706

8471 8472 8473 8474 8475 8476 8477

10.3 Title, Subtitle and Footer 10.3.1 Title The <chart:title> element represents a main title object in a chart document. This element can contain fixed text or it can contain a <table:cell-address> element pointing to the text that should be displayed as the title. This element can also be a sub-element of chart:axis, see section 10.8. In this case the title is displayed beside the axis object. 8478 8479 8480 8481 8482 8483 8484 8485

Table Range A chart title may be bound to a table cell, causing the current content of the given cell to be displayed in the chart title. 8486 8487 8488 8489 8490 8491 8492

Position and Size The common positioning attributes for drawing objects can be used on <chart:title> elements. 8493 8494 8495

Style Name The chart:style-name attribute specifies a chart style for the <chart:title> element. Within the referenced style, fill and stroke properties may be used. They are applied to the surrounding title box. See sections 15.14 and 15.13 for more information. In addition to this, text properties may be used. They are applied to the title text itself. See section 15.4. 8496 8497 8498 8499

1 May 2005 Page 370 of 706

8500 8501 8502

</attribute> </optional> </define>

10.3.2 Subtitle The <chart:subtitle> element represents a subtitle which can be used for additional title information in a chart. The structure of the <chart:subtitle> element is the same as that of the <chart:title> element. The attributes that may be associated with the <chart:subtitle> element are the same as those that may be associated with the <chart:title> element. See section 10.3.1 for more information. 8503 8504 8505 8506 8507 8508 8509 8510

10.3.3 Footer The <chart:footer> element represents a footer below the chart's plot area. The structure of the subtitle element is the same as that of the <chart:title> title element. See section 10.3.1 for more information. 8511 8512 8513 8514 8515 8516 8517 8518

10.4 Legend The <chart:legend> element determines whether or not a legend is displayed in the chart. The legend's position may be specified either as a relative or as an absolute position. The size of the legend is calculated automatically and therefore cannot be set as attribute. 8519 8520 8521 8522 8523 8524

Legend Placement The legend can be placed automatically, next to the plot area, or in one of the corners. This placement is determined by the chart:legend-position attribute, which may have the values start, end, top, bottom for legend positions next to the plot area and top-start, bottom-start, top-end or bottom-end for legend positions in the corners. If the legend is placed next to the plot area, in any of the four directions start, end, top bottom, an additional

1 May 2005 Page 371 of 706

alignment attribute chart:legend-align determines which border (start, end) or axis (center) of the legend and the plot area are to be aligned. 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556

<define name="chart-legend-attlist" combine="interleave"> <choice> <group> <attribute name="chart:legend-position"> <choice> <value>start</value> <value>end</value> <value>top</value> <value>bottom</value> </choice> </attribute> <optional> <attribute name="chart:legend-align"> <choice> <value>start</value> <value>center</value> <value>end</value> </choice> </attribute> </optional> </group> <attribute name="chart:legend-position"> <choice> <value>top-start</value> <value>bottom-start</value> <value>top-end</value> <value>bottom-end</value> </choice> </attribute> <empty/> </choice> </define>

Example: If chart:legend-position="right", the legend will be positioned to the right of the chart's plot area. The chart:legend-align values of start, center, and end will yield legend positions as depicted by the green, red, and blue boxes, respectively.

The legend position can also be given in absolute coordinates, as with any drawing object. If both a drawing position and legend placement options are available, the legend placement takes precedence and the position should reflect the automatic placement. 8557 8558 8559

Legend Expansion The legend needs to be expanded to accommodate additional legend items. The style:legend-expansion attribute determines in which direction the legend expands. Legend expansion of wide and high causes the legend to be expanded horizontally and vertically. An expansion balanced causes expansion into both directions. An expansion value

1 May 2005 Page 372 of 706

of custom with a numeric style:legend-expansion-aspect-ratio causes the legend to be expanded such that the given ratio between width and height is observed. 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579

<define name="chart-legend-attlist" combine="interleave"> <choice> <attribute name="style:legend-expansion"> <choice> <value>wide</value> <value>high</value> <value>balanced</value> </choice> </attribute> <group> <attribute name="style:legend-expansion"> <value>custom</value> </attribute> <attribute name="style:legend-expansion-aspect-ratio"> <ref name="double"/> </attribute> </group> <empty/> </choice> </define>

Legend Styling Additional styling information for the chart legend can be referenced through the chart:stylename attribute. The style may specify fill and stroke properties. They are applied to the legend object. See sections 15.14 and 15.13 for more information. In addition to this, the style may specify text properties. They are applied to the text inside the legend object. See section 15.4. 8580 8581 8582 8583 8584 8585 8586

10.5 Plot Area The <chart:plot-area> element is a container for the graphics objects that represent chart data. The main purpose of the plot area is to be a container for the series elements that represent single data series, and the axis elements. 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604

1 May 2005 Page 373 of 706

8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615

Plot Area Positioning The plot area's position and size are determined the common positioning and sizing attributes for drawing objects. If the position and size attributes are not specified, the values are calculated by the render application. 8616 8617 8618 8619

Plot Area Style The chart:style-name attribute that is set for the <chart:plot-area> element is used for all data elements contained inside the plot area, unless extra styles are specified in one of those sub elements. These data elements can be <chart:series> and <chart:data-point> elements. If the chart is three-dimensional, 3D scene properties may be applied to the plot area. See the section 15.22 - 15.26 for more information. 8620 8621 8622 8623 8624 8625 8626

Plot Area Data Attributes If a chart is embedded in a document that provides the data for the chart, the table:cellrange-address attribute reflects the ranges from which all the data for the chart comes. The range given here is interpreted by the chart as consecutive series. 8627 8628 8629 8630 8631 8632 8633

If the first row or column, or both contains labels, this is stated by the chart:data-sourcehas-labels attribute. 8634 8635 8636

1 May 2005 Page 374 of 706

8637 8638 8639 8640 8641 8642 8643 8644 8645

<choice> <value>none</value> <value>row</value> <value>column</value> <value>both</value> </choice> </attribute> </optional> </define>

The chart:series-source formatting property specified in section 15.34.1 determines whether the data table contains the data series in column-wise or row-wise fashion.

10.5.1 3D Plot Area The plot area may be displayed as an 3D scene as specified in section 9.4.1. All 3D attributes that can be applied to the <dr3d:scene> element can be applied to the <chart:plot-area> element, including the dr3d:transform attribute. It represents the rotation of a chart scene, that is the three-dimensional plot area. See section 9.4.1 for more information. In addition to this, the <chart:plot-area> element may contain a <dr3d:light> element as specified in section 9.4.2. 8646 8647 8648 8649

10.6 Wall The <chart:wall> element can be contained in the <chart:plot-area> element. It specifies a chart's wall. For two-dimensional charts, the wall spans the entire plot area. For threedimensional charts, the wall usually consists of two perpendicular rectangles. 8650 8651 8652 8653 8654 8655

Width The svg:width attributes specifies the width of the wall for three-dimensional charts. 8656 8657 8658 8659 8660 8661 8662

Style The <chart:wall> element may have a chart:style-name attribute to specify further styling information. They style may contain fill and stroke properties. See sections 15.14 and 15.13 for more information. 8663

1 May 2005 Page 375 of 706

8664 8665 8666 8667 8668 8669

10.7 Floor The <chart:floor> element can be contained in the <chart:plot-area> element. For three-dimensional charts, the <chart:floor> element is present in addition to the <chart:wall> element. 8670 8671 8672 8673 8674 8675

Size The size of the floor is determined in respect of the size of the plot area, which is always a twodimensional rectangle that serves as a bounding rectangle of the three-dimensional scene. The svg:width attribute can be used to set the width of the floor. 8676 8677 8678 8679 8680 8681 8682

Style The <chart:floor> element may have a chart:style-name attribute to specify further styling information. Fill and stroke properties can be applied to a floor. See sections 15.14 and 15.13 for more information. 8683 8684 8685 8686 8687 8688 8689

10.8 Axis The <chart:axis> element mainly contains style information, in particular scaling information. Chart data is usually structured as follows: ● Several data series each consisting of a name, for example, the name of a company. ● Values, for example, the yield of the company in different years. ● One value in each series belongs to a category, for example, the year. 8690

1 May 2005 Page 376 of 706

8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703

Dimension The chart:dimension attribute specifies along which physical axis on the chart the values of the current axis are displayed. A chart may contain more than one axis with the same dimension. For example, it may have two axes with dimension y. Data series may be attached to either axis. This way, data may be grouped for different scaling. To attach a specific axis to a data series, the axis has to be referenced by the <chart:series> element's chart:axis-name attribute. If an axis is not references by a data series, it becomes a copy of an existing axis with the same dimension. The position of an axis in a chart is determined by the rendering application and depends on the chart type. In a chart with horizontal bars, the rendering application usually paints the axis with dimension x on the bottom of the plot area. If there are two axes with dimension y, a rendering application might paint the second axis at the top of the plot area. 8704 8705 8706 8707 8708 8709 8710 8711 8712

Name The chart:name attribute can be used to assign a name to this axis, so it can be referenced from e.g. a data series. 8713 8714 8715 8716 8717 8718 8719

Style A chart:style-name attribute can be associated with an axis. Stroke properties can be applied to axes; see section 15.13. These properties affect all lines of the axis object. Text properties can also be applied to axes; see section 15.4. These properties affect the appearance of all text objects. The axis properties described in section 15.31 can also be used.

1 May 2005 Page 377 of 706

The chart style that is referenced by the chart:style-name attribute may specify a data style that is used to format the axis' labels. See section 14.1 for details. 8720 8721 8722 8723 8724 8725 8726

Example: Bar chart In this example, there are two axes with dimension y. One of these axes has the name primary-value. A data series has been attached to that named axis. There is no data attached to the second axis, therefore an axis name has not been specified, and the axis is just a copy of the first one. <chart:chart chart:class="bar"> <chart:title> <text:p>Title of my chart</text:p> </chart:title> <chart:plot-area> <chart:axis chart:dimension="x" chart:axis-name="x"/> <chart:axis chart:dimension="y" chart:axis-name="primary-value"/> <chart:axis chart:dimension="y"/> <chart:series chart:values-address="Sheet1.A1:.A7" chart:attached-axis="primary-value"/> </chart:plot-area> </chart:chart>

10.8.1 Grid The <chart:grid> element can be contained in a <chart:axis> element. It adds a grids to the axis. 8727 8728 8729 8730 8731

Class The chart:class attribute specifies whether major or minor tickmarks are used. If a major grid is applied to an axis, the major tickmarks are extended to gridlines. If a grid is minor, any minor tickmarks assigned to the axis are used. 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741

<define name="chart-grid-attlist" combine="interleave"> <optional> <attribute name="chart:class" a:defaultValue="major"> <choice> <value>major</value> <value>minor</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 378 of 706

Style Name The <chart:grid> element may have a chart:style-name attribute to specify further styling information. Stroke properties can be applied to grids, which affect the lines of the grid. See section 15.13 for information on these stroke properties. 8742 8743 8744 8745 8746 8747 8748

10.9 Series The <chart:series> element represents a data series in a chart. If the chart requires more input data like scatter and bubble charts, <chart:domain> sub-elements must be defined that mainly contain the cell-range-address of the corresponding data. 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768

Cell Range The chart:values-cell-range-address attribute allows a range to be specified that contains the values that should be visualized by this data series. 8769 8770 8771 8772 8773 8774 8775

The chart:label-cell-address attribute allows a name to be provided for the series. 8776 8777 8778 8779 8780 8781 8782

1 May 2005 Page 379 of 706

Class The chart:class attribute can be used to assign a chart type to be used for rendering the data of this <chart:series> element. A chart:class attribute for a <chart:series> element overrides the chart:class attribute for the entire chart. This allows the creation of charts with multiple sub-charts, e.g. a bar chart with one or more data series rendered as lines. For more information on the available chart classes, see section 10.2. 8783 8784 8785 8786 8787 8788 8789

Attached Axis The chart:attached-axis attribute can be used to assign the data series to a <chart:axis> element. 8790 8791 8792 8793 8794 8795 8796

Style Name Styling attributes for the data series can be assigned through the chart:style-name attribute. Fill and stroke properties may be applied for <chart:series> element, see sections 15.14 and 15.13 for information. Text properties can also be applied to the descriptive text underneath the series, see section 15.4 for information. 8797 8798 8799 8800 8801 8802 8803

10.9.1 Domain For scatter and bubble charts, one ore more <chart:domain> elements must be specified for the <chart:series> elements. For scatter charts, one <chart:domain> element is required. Its cell-range-address attribute references the x coordinate values for the scatter chart. For bubble charts, two <chart:domain> elements are required. Their cell-range-address attributes reference the x and y coordinate values for the bubble chart For both chart types, there must be at least one <chart:series> element with the necessary number of <chart:domain> sub-elements. All other <chart:series> elements can omit these. In this case, the first domain that is specified is used.

1 May 2005 Page 380 of 706

8804 8805 8806 8807 8808 8809 8810 8811 8812

10.10 Categories The element <chart:categories> element represents the range of cell addresses that contains the captions for the categories contained in each series. The element may contain a table:cell-range-address that denotes the region from which the category labels are taken from. If this attribute or the <chart:categories> element is omitted the application will evaluate the chart:data-source-has-labels attribute. 8813 8814 8815 8816 8817 8818 8819 8820 8821

10.11 Data Point If a single data point in a data series should have a specific appearance, the <chart:datapoint> element is used to apply the required properties. 8822 8823 8824 8825 8826 8827

Repetition The chart:repeated attribute serves as a simplification if more than one consecutive datapoints have the same properties. For example, the following XML-fragments have an identical meaning: <chart:series chart:style-name="ch9"> <chart:data-point/> <chart:data-point/> <chart:data-point/> <chart:data-point/> </chart:series>

and <chart:series chart:style-name="ch9"> <chart:data-point chart:repeated="4"/> </chart:series> 8828 8829

1 May 2005 Page 381 of 706

8830 8831 8832 8833 8834

Style The chart:style-name attribute referenced a chart style. Fill and stroke properties can be applied to each data point object, see sections 15.14 and 15.13. Text properties can also be applied to the descriptive text located underneath the data points, see section 15.4. 8835 8836 8837 8838 8839 8840 8841

8842

10.12 Mean Value The formatting properties of the mean-value line are stored in the <chart:mean-value> element, which may be part of a <chart:series> element. 8843 8844 8845 8846 8847 8848

Style Name The chart:style-name attribute references a chart style that contains the formatting properties for the mean-value line. 8849 8850 8851 8852 8853 8854 8855

10.13 Error Indicator The formatting properties of error-indicators are stored in the <chart:error-indicator> elements which may be part of a series. 8856 8857 8858 8859 8860 8861

1 May 2005 Page 382 of 706

Style Name The chart:style-name attribute references a chart style that contains the formatting properties for the error indicator. 8862 8863 8864 8865 8866 8867 8868

10.14 Regression Curves The formatting properties of regression-lines are stored in the <chart:regression-curve> elements which may be part of a series. 8869 8870 8871 8872 8873 8874

Style Name The chart:style-name attribute referenced a chart style that contains the formatting properties for the error indicator. The chart style especially may contain the regression type property specified in section 15.35.1. 8875 8876 8877 8878 8879 8880 8881

10.14.1 Stock Chart Markers The properties of a stock chart, i.e. the different colors for filling the candlestick-bars or the linestyles of the lines pointing to the high and low values (the range-line), are stored in separate elements. The candlestick-bars for stocks that have a higher close-value than open-value take their formatting from the <chart:stock-gain-marker> element's properties, whereas stocks which close value is lower than the open-value, use the properties stored in <chart:stockloss-marker>. 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892

1 May 2005 Page 383 of 706

8893 8894 8895 8896

Style Name The chart:style-name attribute referenced a chart style that contains the formatting properties for stock markers. 8897 8898 8899 8900 8901 8902 8903

1 May 2005 Page 384 of 706

11 Form Content A form is a container for user interface controls which a user interacts with. For example, buttons, text boxes, check boxes, and drop-down lists are user interface controls that can be contained in a form. In the XML file format, the following basic rules apply to user interface controls and forms: •

All controls must be located in a form.

•

All controls that are not hidden have to be associated with an absolute or relative position. These visual aspects of the control are represented by drawing shapes that contain a reference to the control. See section 9.2.12 for details.

•

Forms may be nested.

•

Forms are not connected with the text flow and layout of a document. This does not apply to controls.

•

Forms can be data-aware. The controls reflect the content of a database.

Forms define rules for the following form behavior: •

Submitting the form, which is similar to [HTML4].

Note: Form submission is only supported for non nested forms that contain only controls that can be converted to HTML. •

Connecting to a data source. When this happens, the controls in a form become data-aware.

•

Submitting and binding according to the [XForms] data model.

Forms are contained in the <office:forms> section of an XML document. This element may contain an arbitrary sequence of <form:form> or <xforms:model> elements. Note that controls are always declared inside a <form:form> element, while an <xforms:model> element contains only the XForms data model. Thus, the <office:forms> element may contain only <form:form> elements but no <xforms:model> element, while an <xforms:model> would typically be accompanied by an additional <form:form> element. 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916

For ease of use when using (filling out) forms, applications may focus controls initially so that the user can immediately type into the first form control. To achieve this behavior, the form:automatic-focus flag may be set to true. 8917 8918 8919

1 May 2005 Page 385 of 706

8920 8921 8922 8923

Application which support both creation and usage (filling out) of forms, the form:applydesign-mode flag determines whether the application is supposed to present the forms in this document in editable or fill-out state. 8924 8925 8926 8927 8928 8929 8930

11.1 Form The <form:form> element represents a user interface form and defines the contents and properties of the form. This element is contained in either an <office:forms> or a <form:form> element. It contains the controls and sub forms of the form, a <form:properties> element which defines the properties of the form, and an <office:events-listeners> element that contains the events for the form. 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951

The attributes that may be associated with the <form:form> are as follows: •

Name. See section 11.4.

•

Service name. See section 11.4.

•

Action

•

Target frame

•

Method

•

Encoding Type

•

Allow deletes

1 May 2005 Page 386 of 706

•

Allow inserts

•

Allow updates

•

Apply filter

•

Command type

•

Command

•

Data source

•

Master fields

•

Detail fields

•

Escape processing

•

Filter

•

Ignore result

•

Navigation mode

•

Order

•

Tabbing cycle

11.1.1 Action The xlink:href attribute represents the URI of the processing agent for the form. 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968

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

11.1.2 Target Frame The office:target-frame attribute specifies the target frame of the form. This attribute can have one of the following values: •

_self: The form replaces the content of the current frame.

•

_blank: The form is displayed in a new frame.

•

_parent: The form is displayed in the parent frame of the current frame.

1 May 2005 Page 387 of 706

8969 8970 8971 8972 8973 8974 8975

•

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

•

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

11.1.3 Method The form:method attribute specifies the HTTP method to use to submit the data in the form to the server. The value of this attribute can be get or post. The default value is get. These values are not case sensitive. 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986

11.1.4 Encoding Type If the value of the form:method attribute is post, the form:enctype attribute specifies the content type used to submit the form to the server. The default value of this attribute is application/x-www-form-urlencoded. Other suitable MIME types are also acceptable. See §17.3 of [HTML4] for more information. 8987 8988 8989 8990 8991 8992 8993 8994

11.1.5 Allow Deletes The form:allow-deletes attribute specifies whether or not data records can be deleted. It applies only if the form is data-aware. 8995 8996 8997 8998 8999 9000 9001

1 May 2005 Page 388 of 706

11.1.6 Allow Inserts The form:allow-inserts attribute specifies whether or not new data records can be inserted. It applies only if the form is data-aware. 9002 9003 9004 9005 9006 9007 9008

11.1.7 Allow Updates The form:allow-updates attribute specifies whether or not data records can be updated. 9009 9010 9011 9012 9013 9014 9015

11.1.8 Apply Filter The form:apply-filter attribute specifies whether or not filters should be applied to the form. See also the Filter attribute. 9016 9017 9018 9019 9020 9021 9022

11.1.9 Command Type The form:command-type attribute specifies the type of command to execute on the data source. The value of this attribute can be one of the following:

9023 9024 9025 9026 9027 9028 9029 9030 9031 9032

•

table: The command contains a table name. The form retrieves all of the data in the table.

•

query: The command contains the name of query. The form retrieves and executes the query.

•

command : The command contains an SQL statement. The form executes the SQL statement.

<define name="form-form-attlist" combine="interleave"> <optional> <attribute name="form:command-type" a:defaultValue="command"> <choice> <value>table</value> <value>query</value> <value>command</value> </choice> </attribute> </optional>

1 May 2005 Page 389 of 706

9033

</define>

11.1.10 Command The form:command attribute specifies the command to execute on the data source. The value is interpreted differently, depending to the value of the Command Type attribute of the form. It can be the name of a database table, the name of a query object or an SQL statement. 9034 9035 9036 9037 9038

11.1.11 Data Source The form:datasource attribute specifies the name of a data source to use for the form. The value of this attribute can be one of the following:

9039 9040 9041 9042 9043 9044 9045 9046 9047 9048

•

A URL specifying a database connection.

•

A data source name that the office application can use to establish database connections.

11.1.12 Master Fields The form:master-fields attribute is used for nested data-aware forms. It specifies the names of the columns in the result set represented by the parent form. Usually, they denote the foreign key fields of the parent form. The values of the columns are used to parameterize the data for the nested form. Each time the parent form changes the current row, the nested form queries the database again based on the values of the master fields. The attribute contains a comma separated list of field names. 9049 9050 9051 9052 9053 9054 9055

11.1.13 Detail Fields The form:detail-fields attribute is used for nested database forms. It specifies the names of the columns in detail forms that are related to columns in the parent form. The columns are used as parameters in the command for the nested form to retrieve the details for a matching master form record.

1 May 2005 Page 390 of 706

This attribute contains a comma separated list of field names. 9056 9057 9058 9059 9060 9061 9062

11.1.14 Escape Processing If the value of the form:command-type attribute is command, the form:escapeprocessing attribute specifies whether or not the application processes the command before passing it to the database driver. 9063 9064 9065 9066 9067 9068 9069

11.1.15 Filter The form:filter attribute specifies a filter for the command to base the form on. No matter whether the form is based on a query, a table, or an command, the filter is always conjunctively added to any possible existing filter. The filter usually forms a SQL “WHERE” clause, without the “WHERE” keyword. The form:apply-filter attribute specifies whether or not the filter is actually applies to the command. 9070 9071 9072 9073 9074 9075 9076

11.1.16 Ignore Result The form:ignore-result attribute specifies whether or not to discard all results that are retrieved from the underlying data source. If true, a database-bound form will discard any data it queries from the database, and thus only inserting and editing of new records is available. Essentially, this allows a mode of operation where only new data can be inserted into a database. 9077 9078 9079 9080 9081 9082 9083

1 May 2005 Page 391 of 706

11.1.17 Navigation Mode The form:navigation-mode attribute specifies how the records in a database form are navigated. The value of this attribute can be one of the following: •

none: A dedicated navigation bar is not provided by the user interface. The form must be navigated using the TAB and SHIFT/TAB keys on the keyboard.

•

current: A navigation bar is provided and the navigation is performed on the current form.

•

parent: A navigation bar is provided and the navigation is performed on the parent form of the current form.

9084 9085 9086 9087 9088 9089 9090

9091 9092 9093 9094 9095 9096 9097 9098

<define name="navigation"> <choice> <value>none</value> <value>current</value> <value>parent</value> </choice> </define>

11.1.18 Order The form:order attribute specifies a sort criteria for the command. No matter whether the form is based on a query, a table, or an command, the sorting is always conjunctively added to any possible existing sorting. The attribute value usually forms an SQL “ORDER BY” clause, without the “ORDER BY” keyword. 9099 9100 9101 9102 9103 9104 9105

11.1.19 Tabbing Cycle The form:tab-cycle attribute specifies how the application responds when the user presses the TAB key in the controls in a form. The behavior of the application depends on whether or not the form is bound to a data source. The value of this attribute can be one of the following: •

records: If a user presses the TAB key in the last control of the form, the focus moves to the first control specified in the tab order of the same form, and moves the form to the next record.

•

current: If a user presses the TAB key in the last control of the form, the focus moves to the first control specified in the tab order of the same form, while the record pointer of the form is not touched.

1 May 2005 Page 392 of 706

• 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119

page: If a user presses the TAB key in the last control of a form, the focus moves to the first control specified in the tab order for the next form.

<define name="form-form-attlist" combine="interleave"> <optional> <attribute name="form:tab-cycle"> <ref name="tab-cycles"/> </attribute> </optional> </define> <define name="tab-cycles"> <choice> <value>records</value> <value>current</value> <value>page</value> </choice> </define>

11.1.20 Connection Resource The <form:connection-resource> element specifies the source database by an [XLink]. Its xlink:href attribute either references a file containing a database, or it contains information on how to make a connection to a database, for instance a [JDBC] URL. 9120 9121 9122 9123 9124 9125 9126 9127

11.2 XForms Model The form model described in the previous chapter implies a data model where each control defines a name-value-pair, with the name being determined by the control id and the value being editable through the control. No interaction between controls is possible (save for macro programming). For applications where this kind of form logic does not suffice, W3C has introduced XForms (see [XForms]), a standard for XML-based forms. XForms is designed to be embedded in another XML format. It consists of two major parts, the XForms model which contains the form logic plus form data, and the XForms controls, which can be bound to a data model. In the OASIS Open Office 1.0 we embed the W3C XForms model as defined by the <xforms:model> element into the <office:forms> forms container. The controls (see 11.3) will be left as is, except that they receive an xforms:bind attribute, which allows to bind any OpenDocument control to a previously defined XForms model.

11.2.1 XForms Model We import the XForms model defined in [XForms]. In order to avoid duplication of the XForms schema here, we only specify the XForms model element and allow arbitrary content. 9128 9129 9130 9131 9132

1 May 2005 Page 393 of 706

11.3 Controls Controls are used to interact with forms. Each control in a form is identified by a name, though the names must not necessarily be unique. Controls are connected to a the surrounding document (and its text flow, if applicable) by binding them to a shape that acts as a placeholder for the control. See section 9.2.12 for details. In addition to the attributes defined in this file format, controls may have application-specific additional attributes. These attributes are stored in the <form:properties> element in each control. Control events are specified in the <office:event-listeners> element. When a user submits a form for processing, the names of some controls are paired with the current values of the controls and the pairs are submitted with the form. These controls are called successful controls. See section 17.13.2 of [HTML4]for more information. The file format provides elements for the following standard controls: •

Text

•

Text area

•

Password

•

File

•

Formatted text

•

Number

•

Date

•

Time

•

Fixed text

•

Combo box

•

List box

•

Button

•

Image

•

Check box

•

Radio button

•

Frame

•

Image frame

•

Hidden

•

Grid

It is also possible to define application-specific controls. These controls are described by the <form:generic-control> element.

11.3.1 Text The <form:text> element defines a control for displaying and inputting text.

1 May 2005 Page 394 of 706

9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167

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

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

11.3.2 Text Area The <form:textarea> element defines a control for displaying and inputting text on multiple lines. The <form:textarea> element may be used with plain text values (specified by the form:current-value attribute) as well as with formatted text (specified as paragraph content). If both, the form:current-value and one or more <text:p> elements are present, it's up to the application reading the document to decide which information is used. 9168 9169 9170 9171 9172 9173 9174 9175

1 May 2005 Page 395 of 706

9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189

</define> <define name="form-textarea-attlist"> <ref name="form-control-attlist"/> <ref name="common-current-value-attlist"/> <ref name="common-disabled-attlist"/> <ref name="common-maxlength-attlist"/> <ref name="common-printable-attlist"/> <ref name="common-readonly-attlist"/> <ref name="common-tab-attlist"/> <ref name="common-title-attlist"/> <ref name="common-value-attlist"/> <ref name="common-convert-empty-attlist"/> <ref name="common-data-field-attlist"/> </define>

The attributes that may be associated with the <form:textarea> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

11.3.3 Password The <form:password> element defines a control that hides the text that a user inputs using an echo character, for example, an asterisk. This type of control is usually used for inputting sensitive information such as a password. 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205

The attributes that may be associated with the <form:password> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Echo Char

Echo Char The form:echo-char attribute specifies the character that the form uses to mask the text which a user inputs in a password control. 9206

1 May 2005 Page 396 of 706

9207 9208 9209 9210 9211 9212

11.3.4 File The <form:file> element defines a control for selecting a file. 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229

The attributes that may be associated with the <form:file> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

11.3.5 Formatted Text The <form:formatted-text> element defines a control for inputting formatted text, which follows a certain formatting in both input and display. 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248

The attributes that may be associated with the <form:formatted-text> element are:

1 May 2005 Page 397 of 706

•

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Maximum Value

•

Minimum Value

•

Validation

Maximum Value The form:max-value attribute specifies the maximum value that a user can enter. 9249 9250 9251 9252 9253 9254 9255

Minimum Value The form:min-value attribute specifies the minimum value that a user can enter. 9256 9257 9258 9259 9260 9261 9262

Validation The form:validation attribute specifies whether or not the text that the user enters is validated during input. 9263 9264 9265 9266 9267 9268 9269

11.3.6 Number The <form:number> element describes a control which allows the user to enter a floating point number. The attributes that may be associated on this control are similar to those of the <form:formatted-text>, except that the data type is fixed to numeric data. 9270 9271 9272 9273 9274

1 May 2005 Page 398 of 706

9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287

</element> </define> <define name="common-numeric-control-attlist"> <ref name="form-control-attlist"/> <ref name="common-disabled-attlist"/> <ref name="common-maxlength-attlist"/> <ref name="common-printable-attlist"/> <ref name="common-readonly-attlist"/> <ref name="common-tab-attlist"/> <ref name="common-title-attlist"/> <ref name="common-convert-empty-attlist"/> <ref name="common-data-field-attlist"/> </define>

The attributes that may be associated with the <form:number> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Value and Current Value

•

Minimum and Maximum Value

Value The attributes for value and current value are the same as those for other fields, except that they can contain only floating point data. 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301

Minimum and Maximum The attributes for minimum and maximum value define the smallest and largest numerical values that are acceptable for this control. 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312

1 May 2005 Page 399 of 706

9313 9314 9315

</attribute> </optional> </define>

11.3.7 Date And Time The controls for date and time are the same as those for number values, except that they accept date and time values, respectively. They support the same attributes as the numerical field, except for the different data types of their value attributes. 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329

The attributes that may be associated with the <form:date> and <form:time> elements are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Maximum Length, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Convert Empty and Data Field. See section 11.5.22 for information about these attributes.

•

Value and Current Value

•

Minimum and Maximum Value

Value The attributes for value and current value are the same as those for <form:number>, except that they can contain only date or time data, respectively. 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349

1 May 2005 Page 400 of 706

9350 9351 9352 9353 9354 9355 9356 9357

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

Minimum and Maximum The attributes for minimum and maximum value define the smallest and largest dates (or times) that are acceptable for this control. 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385

11.3.8 Fixed Text The <form:fixed-text> element describes a control which attaches additional information to controls, or merely displays information in the application. Relations between a labeling and a labeled control can be established by specifying the form:for attribute of the label. Only one label may be associated with the same control. 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398

1 May 2005 Page 401 of 706

9399

</define>

The attributes that may be associated with the <form:fixed-text> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, For, Label, Printable, and Title. See section 11.5 for information about these attributes.

•

Multi-Line

Multi-Line The form:multi-line attribute specifies whether or not the label is displayed on multiple lines. 9400 9401 9402 9403 9404 9405 9406

11.3.9 Combo Box The <form:combobox> element defines a control which allows displaying and editing of text, and containing a list of possible values for this text. 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432

The attributes that may be associated with the <form:combobox> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Dropdown, Max Length, Printable, Read only, Size, Tab Index, Tab Stop, Title, and Value. See section 11.5 for information about these attributes.

1 May 2005 Page 402 of 706

•

Convert Empty, Data Field, List Source, and List Source Type. See section 11.5.22 for information about these attributes.

•

Automatic Completion

Automatic Completion The form:auto-complete attribute specifies whether, when the user enters text in the combobox that matches one of the list items in the combobox, the application automatically completes the text for the user. 9433 9434 9435 9436 9437 9438 9439

Item The <form:item> element defines a list item for a combobox control. 9440 9441 9442 9443 9444 9445 9446 9447 9448

The attribute that may be associated associate with the <form:item> element is: •

Label. See section 11.5 for information about this attribute.

11.3.10 List Box The <form:listbox> element defines an input control that allows a user to select one or more items from a list. It is an alternative representation for a group of radio buttons. 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468

1 May 2005 Page 403 of 706

9469 9470

The attributes that may be associated with the <form:listbox> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Dropdown, Printable, Read only, Size, Tab Index, Tab Stop, and Title. See section 11.5 for information about these attributes.

•

Bound Column, Data Field, List Source, and List Source Type. See section 11.5.22 for information about these attributes.

•

Multiple

•

XForms source

Multiple The form:multiple attribute determines whether or not a user can select multiple items from a list box. 9471 9472 9473 9474 9475 9476 9477

XForms source The form:xforms-list-source allows to dynamically create the list of choices by binding the list content to XForms (see section 11.2, as well as [XForms]). The attribute references an <xforms:bind> element, and creates a list entry for each node in the nodeset defined by that attribute. 9478 9479 9480 9481 9482 9483 9484

Option The <form:option> element defines the list items for a list box control. An item can be preselected and can contain a related value. 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495

1 May 2005 Page 404 of 706

9496

</define>

The attributes that may be associated with the <form:option> element are: •

Current Selected, Selected, Label, and Value. See section 11.5 for information about these attributes.

11.3.11 Button The <form:button> element defines a button. When pressed, a button usually triggers an action. 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516

The attributes that may be associated with the <form:button> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Button Type, Control ID, Disabled, Image Data, Printable, Tab Index, Tab Stop, Target Frame, Target Location, Title, Value and relative image position. See section 11.5 for information about these attributes.

•

Default Button

•

Toggle

•

Focus on Click

•

XForms Submission

Default Button The form:default-button attribute determines whether or not the button is the default button on the form. If a user clicks the default button or presses Return while an input control is focused, the application takes the same action. If a form contains more than one default button, the behavior of the application is undefined. 9517 9518 9519 9520 9521

1 May 2005 Page 405 of 706

9522 9523

</optional> </define>

Toggle The form:toggle attribute specifies whether a form button control, when it is operated (via mouse or keyboard), should be toggled between a "pressed" and a "not pressed" state. If this attribute is set to false, the button controls behaves like an usual push button. 9524 9525 9526 9527 9528 9529 9530

Focus on click The form:focus-on-click attribute specifies whether a form button control should grab the focus when it is clicked with the mouse. 9531 9532 9533 9534 9535 9536 9537

XForms Submission Buttons may be used to trigger an XForms submission by adding an form:xformssubmission attribute. If such a button is triggered, a previously declared XForms submission with the given name is executed. 9538 9539 9540 9541 9542 9543 9544

11.3.12 Image The <form:image> element defines a graphical button control. This element corresponds to the input element of type image in HTML 4.01. Note: HTML 4.01 only allows the button type to be submit for an image button. In office application file format, an image button can be of any type. 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554

1 May 2005 Page 406 of 706

9555 9556 9557 9558 9559 9560 9561 9562

The attributes that may be associated with the <form:image> element are: ● Name and Service Name. See section 11.4 for information about these attributes. ● Button Type, Control ID, Disabled, Image Data, Printable, Tab Index, Tab Stop, Target

Frame, Target Location, Title, and Value. See section 11.5 for information about these attributes.

11.3.13 Check Box The <form:checkbox> element defines an on/off control which a user can toggle. The control is on when the value of the form:current-state attribute associated with the control element is checked. When a user submits a form, only the controls whose current state is checked are successful. 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580

The attributes that may be associated with the <form:checkbox> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Label, Printable, Tab Index, Tab Stop, Title, Value, Visual Effect and Relative Image Position. See section 11.5 for information about these attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

•

Current State

•

Is Tristate

•

State

Current State The form:current-state attribute specifies the current state of the check box control.

1 May 2005 Page 407 of 706

The value of this attribute can be one of the following:

9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594

•

unchecked: The check box is not checked.

•

checked: The check box is checked. The value of the control is submitted with the form.

•

unknown: This value is only available when the control is in tristate mode (See the "Is Tristate" attribute) . This value may, for instance, be used in connection with a database field binding to indicate that the value is NULL.

<define name="states"> <choice> <value>unchecked</value> <value>checked</value> <value>unknown</value> </choice> </define> <define name="form-checkbox-attlist" combine="interleave"> <optional> <attribute name="form:current-state"> <ref name="states"/> </attribute> </optional> </define>

Is Tristate The form:is-tristate attribute specifies that the check box can have three states instead of the common two states. 9595 9596 9597 9598 9599 9600 9601

State The form:state attribute specifies the default state of the check box control. This state is used to initialize the control. 9602 9603 9604 9605 9606 9607 9608

11.3.14 Radio Button The <form:radio> element describes controls which act like check boxes except that when several radio buttons share the same control name they are mutually exclusive. When one button is on, all of the other buttons with the same name are off. If no radio button is initially on, the way in which the application chooses which button to turn on initially is undefined. If a group of radio buttons is bound to one database field, the reference value of the selected radio button is written into the database field.

1 May 2005 Page 408 of 706

9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628

The attributes that may be associated with the <form:radio> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Selected, Disabled, Label, Printable, Selected, Tab Index, Tab Stop, Title, Value, Visual Effect and Relative Image Position. See section 11.5 for information about these attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

11.3.15 Frame The <form:frame> element defines a frame, which may be used to arrange controls visually. This element does not have a value and it does not allow any user input. 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642

The attributes that may be associated with the <form:frame> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, For, Label, Printable, and Title. See section 11.5 for information about these attributes.

11.3.16 Image Frame The <form:image-frame> element defines a graphical control. The control displays an image, whose location is described in the control.

1 May 2005 Page 409 of 706

9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657

The attributes that may be associated with the <form:image-frame> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Image Data, Printable, Read only, and Title. See section 11.5 for information about these attributes.

•

Data Field. See section 11.5.22 for information about this attribute.

11.3.17 Hidden The <form:hidden> element defines a control that does not have a visual representation. This element is usually used as a container for information. 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667

The attributes that may be associated with the <form:hidden> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Value. See section 11.5 for information about this attribute.

11.3.18 Grid The <form:grid> element defines a control that displays table data. This control is data-aware and is bound to a form which retrieves data from a data source. The actual data to display in a grid control is determined by the parent form, which is data-aware and thus based on a certain row set. The rows in the grid contain these data rows. Each column in the grid is specified by a <form:column> element. Each column is bound to a field in the form's row set. 9668 9669 9670 9671 9672

1 May 2005 Page 410 of 706

9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683

The attributes that may be associated with the <form:grid> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Disabled, Printable, Tab Index, Tab Stop, and Title. See section 11.5 for information about these attributes.

Column The <form:column> element defines a column in a grid control. The column contains a control that displays the grid data for the column. 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696

The attributes that may be associated with the <form:column> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Label. See section 11.5 for information about this attribute.

•

Column Style

Column Style The form:text-style-name attribute specifies paragraph style that is applied to all controls with the column. See also section 9.2.12. Unlike other paragraph styles, this style may reference a data style. 9697 9698 9699 9700 9701 9702 9703

1 May 2005 Page 411 of 706

11.3.19 Value Range The new <form:value-range> element defines a control which allows the user to select a value from a continuous number range. Possible representations include scroll bars and spin buttons. 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717

The attributes that may be associated with a <form:value-range> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

•

Control ID, Current Value, Disabled, Printable, Read only, Tab Index, Tab Stop, Title and Value. See section 11.5 for information about these attributes.

•

Maximum Value

•

Minumum Value

•

Step Size

•

Page Step Size

•

Repeat Delay

•

Orientation

Maximum Value The form:max-value attribute specifies the maximum value that a user can enter. 9718 9719 9720 9721 9722 9723 9724

Minimum Value The form:min-value attribute specifies the minimum value that a user can enter. 9725 9726 9727 9728 9729 9730 9731

1 May 2005 Page 412 of 706

Step Size The form:step-size attribute specifies the increment to be used for a control representing a value. 9732 9733 9734 9735 9736 9737 9738

Page Step Size The form:page-step-size attribute specifies a second-level increment to be used for a control representing a value. In the user interface, this is usually associated with the user pressing the "Page Up" or "Page Down" key. 9739 9740 9741 9742 9743 9744 9745

Repeat Delay The form:delay-for-repeat attribute specifies a time-out to be used before a pressed mouse button results in repeating an action. 9746 9747 9748 9749 9750 9751 9752

Orientation The form:orientation attribute specifies the orientation of the control, which could be either horizontal or vertical. 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762

<define name="form-value-range-attlist" combine="interleave"> <optional> <attribute name="form:orientation"> <choice> <value>horizontal</value> <value>vertical</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 413 of 706

11.3.20 Generic Control The <form:generic-control> element defines a placeholder for a generic control. The generic control can contain any properties and any events. The application detects the type of the control and instantiates the correct control. 9763 9764 9765 9766 9767 9768 9769 9770 9771

The attributes that may be associated with the <form:generic-control> element are: •

Name and Service Name. See section 11.4 for information about these attributes.

11.4 Common Form and Control Attributes 11.4.1 Name The form:name attribute specifies the name of the form or control element. This may be used to give a form or control element an identity, which is important for scripting and for submitting the content of controls. 9772 9773 9774 9775 9776 9777 9778

11.4.2 Control Implementation A control may be given a control type attribute, which determines which concrete rendition or implementation the user agent should instantiate. For easy extensibility, the value of this attribute is a namespaced token, i.e. it is token using a namespace prefix, much like attributes in XML. 9779 9780 9781 9782 9783 9784 9785

11.4.3 Bind to XForms Any control can be bound to an XForms form (see section 11.2, as well as [XForms]) by using the xforms:bind attribute. With buttons the bind attribute refers to an <xforms:submission> element with the given ID. Pushing the button causes the appropriate XForms submission action to be performed. For all other control types, the xforms:bind

1 May 2005 Page 414 of 706

attribute refers to an <xforms:bind> element with the given ID. Any such bound control reads and writes its data as determined by the appropriate bind element. 9786 9787 9788 9789 9790 9791 9792

11.5 Common Control Attributes 11.5.1 Button Type The form:button-type attribute specifies the type of a button. This attribute is supported for the following elements: •

<form:button>

•

<form:image>

The value of this attribute can be one of the following:

9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807

•

submit: Pressing the button submits the form.

•

reset: Pressing the button resets every control in the form to its default value.

•

push: Pressing the button does not perform any action by default. The use then can add scripts to the button. and the script is run when the button is pressed.

•

url: Pressing the button loads the URL that is specified in the form:target-url attribute.

<define name="types"> <choice> <value>submit</value> <value>reset</value> <value>push</value> <value>url</value> </choice> </define> <define name="button-type"> <optional> <attribute name="form:button-type" a:defaultValue="push"> <ref name="types"/> </attribute> </optional> </define>

11.5.2 Control ID All controls except Hidden Controls have a visual representation in the host document. Thus, they need an absolute or relative position, describing the location in the document. The position is represented by a shape that contains a reference to the control element within the form element. The form:id attribute is used to uniquely identify a control element. Every control that is not hidden must have such an attribute associated with it, which in turn can be used to reference the control.

1 May 2005 Page 415 of 706

This attribute is supported for the following elements:

9808 9809 9810 9811 9812

•

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:fixed-text>

•

<form:combobox>

•

<form:listbox>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:frame>

•

<form:image-frame>

•

<form:grid>

11.5.3 Current Selected The form:current-selected attribute determines the current state of a radio button or option element. This attribute is supported for the following elements:

9813 9814 9815 9816 9817 9818 9819

•

<form:option>

•

<form:radio>

11.5.4 Value and Current Value Every control has a default value and a current value. The current value changes with user interaction; the default value of a control does not. In general, the default value is specified in a form:value attribute.

1 May 2005 Page 416 of 706

The default value is used during special events, such as resetting the form, which transfers the default value of every control to it's current value. If a control does not have an default value, the result of resetting the form is undefined. Besides storing the current value together with the control, it is also possible to bind controls to other value providers, which act as value sink and source, such as database fields (in dataaware forms) or e.g. cells in a spreadsheet document the controls live in. In this case, the current value is not stored with the control itself, but in the external instance, which may or may not store it together with the document. See section 11.5.22 for more details on database properties.

Default Value The form:value attribute specifies the default value of an input control. This attribute is supported for the following elements:

9820 9821 9822 9823 9824 9825 9826

•

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:combobox>

•

<form:option>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:hidden>

Current Value The form:current-value attribute specifies the current status of an input control. It overrides the value of a form:value attribute, if one is present. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:file>

•

<form:formatted-text>

1 May 2005 Page 417 of 706

• 9827 9828 9829 9830 9831 9832 9833

<form:combobox>

11.5.5 Disabled The form:disabled attribute specifies whether or not a control can accept user input. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:fixed-text>

•

<form:combobox>

•

<form:listbox>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:frame>

•

<form:image-frame>

•

<form:grid>

Controls that are disabled are not included in the tabbing navigation sequence and can not be focused. 9834 9835 9836 9837 9838 9839 9840

11.5.6 Dropdown The form:dropdown attribute specifies whether the list in a combo box or list box is always visible or is only visible when the user clicks the drop-down button. This attribute is supported for the following elements:

1 May 2005 Page 418 of 706

•

<form:combobox>

•

<form:listbox>

If the value is true, the list is always visible. If the value is false, the list is only visible when the user clicks the drop-down button. 9841 9842 9843 9844 9845 9846 9847

11.5.7 For The form:for attribute specifies the IDs of the controls with which control element is labeling. This attribute is supported for the following elements: •

<form:fixed-text>

•

<form:frame>

This attribute contains a comma separated list of control IDs. 9848 9849 9850 9851 9852 9853 9854

11.5.8 Image Data The form:image-data attribute links the control to an external file containing image data. This attribute is supported for the following elements:

9855 9856 9857 9858 9859 9860 9861

•

<form:button>

•

<form:image>

•

<form:image-frame>

11.5.9 Label The form:label attribute contains a label for a control such as a radio button or check box. This attribute is supported for the following elements: •

<form:fixed-text>

•

<form:item>

1 May 2005 Page 419 of 706

9862 9863 9864 9865 9866 9867 9868

•

<form:option>

•

<form:checkbox>

•

<form:radio>

•

<form:frame>

•

<form:column>

11.5.10 Maximum Length The form:max-length attribute specifies the maximum number of characters that a user can enter in an input control. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:formatted-text>

•

<form:combobox>

The default value of this attribute is unlimited, which allows a user to enter an unlimited number of characters. 9869 9870 9871 9872 9873 9874 9875

11.5.11 Printable The form:printable attribute specifies whether or not a control is printed when a user prints the document in which the control is contained. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:fixed-text>

1 May 2005 Page 420 of 706

9876 9877 9878 9879 9880 9881 9882

•

<form:combobox>

•

<form:listbox>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:frame>

•

<form:image-frame>

•

<form:grid>

11.5.12 Read only The form:readonly attribute specifies whether or not a user can modify the value of a control. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:file>

•

<form:formatted-text>

•

<form:combobox>

•

<form:listbox>

•

<form:image-frame>

Read-only controls are included in the tabbing navigation sequence. 9883 9884 9885 9886 9887 9888 9889

11.5.13 Selected The form:selected attribute specifies the default state of a radio button or option. When the control is initialized, it is in the default state specified by this attribute. This attribute is supported for the following elements: •

<form:option>

1 May 2005 Page 421 of 706

•

<form:radio>

In a group of radio buttons that share the same name, only one radio button can have this attribute set to true. 9890 9891 9892 9893 9894 9895 9896

11.5.14 Size The form:size attribute specifies the number of rows that are visible at a time in a combo box list or a list box list. This attribute is supported for the following elements:

9897 9898 9899 9900 9901 9902 9903

•

<form:combobox>

•

<form:listbox>

11.5.15 Tab Index The form:tab-index attribute specifies the tabbing navigation order of a control within a form. The tabbing order is the order in which controls are given focus when a user navigates through the form using the TAB key on the keyboard. The tabbing order can include elements that are nested in other elements. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:combobox>

•

<form:listbox>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:grid>

The rules for tabbing are similar to the tabbing rules used in HTML 4.0.

1 May 2005 Page 422 of 706

Controls that can be given focus are navigated in the order described in the following rules: 1. The controls that have a positive value for the form:tab-index attribute are navigated first. 2. The navigation starts at the control with lowest form:tab-index value and ends at the control with the highest value. Values do not have to be sequential and they do not have to begin with a particular value. 3. Controls that have the same values for the form:tab-index attribute are navigated according their position in the form. 4. Controls that do not contain the form:tab-index attribute or contain the attribute with a value of 0 are navigated next. These controls are navigated according to their position in the form. 5. Controls that have the form:disabled attribute set to true are not included in the navigation, independent on their form:tab-index value. 9904 9905 9906 9907 9908 9909 9910

11.5.16 Tab Stop The form:tab-stop attribute specifies whether or not a control is included in the tabbing navigation order. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:combobox>

•

<form:listbox>

•

<form:button>

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:grid>

If the value is false, the control is not included in the tabbing navigation. 9911 9912 9913 9914 9915 9916

1 May 2005 Page 423 of 706

9917

</define>

11.5.17 Target Frame The office:target-frame attribute specifies the link target frame of the area. This attribute is supported for the following elements:

9918 9919 9920 9921 9922 9923 9924

•

<form:button>

•

<form:image>

11.5.18 Target Location An xlink:href attribute specifies the URL that is loaded if a button is clicked. This attribute is supported for the following elements: •

<form:button>

•

<form:image>

This attribute is only evaluated if the value of the form:button-type attribute is location. 9925 9926 9927 9928 9929 9930 9931

11.5.19 Title The form:title attribute contains additional information about a control. The value of the attribute can be used as a tool tip. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

•

<form:password>

•

<form:file>

•

<form:formatted-text>

•

<form:fixed-text>

•

<form:combobox>

•

<form:listbox>

•

<form:button>

1 May 2005 Page 424 of 706

9932 9933 9934 9935 9936

•

<form:image>

•

<form:checkbox>

•

<form:radio>

•

<form:image>

•

<form:image-frame>

•

<form:grid>

11.5.20 Visual Effect The form:visual-effect attributes specifies a visual affect to apply to a control. The attribute values can be flat for a flat visual effect and 3d for a 3D effect. This attribute is supported for the following elements:

9937 9938 9939 9940 9941 9942 9943 9944 9945 9946

•

<form:checkbox>

•

<form:radio>

11.5.21 Relative Image Position The form:image-position and form:image-align together specify the position of an image to be displayed in a form control, relative to the label text. If the form:image-position attribute has the value center, the image shown in a control should be centered relative to the control's text. If the form:image-position attribute has one of the values start, end, top, bottom, the image is to be placed before, after, above, or below the text. In this case, the form:imagealign attribute specifies which border (start, end) or axis (center) of the image and the text are to be aligned. If the form:image-position attribute is not present, it is assumed to be center. The form:image-position and form:image-align attributes are supported for the following elements:

9947

•

<form:button>

•

<form:checkbox>

•

<form:radio>

<define name="common-form-relative-image-position-attlist"

1 May 2005 Page 425 of 706

9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975

combine="interleave"> <choice> <optional> <attribute name="form:image-position" a:defaultValue="center"> <value>center</value> </attribute> </optional> <group> <attribute name="form:image-position"> <choice> <value>start</value> <value>end</value> <value>top</value> <value>bottom</value> </choice> </attribute> <optional> <attribute name="form:image-align" a:defaultValue="center"> <choice> <value>start</value> <value>center</value> <value>end</value> </choice> </attribute> </optional> </group> </choice> </define>

11.5.22 Database Binding Attributes A control may be bound to a database fields. In this case, the controls becomes data-aware. The control acquires the values of a database field by going through a result set that is provided by the form. Each time there is a row change in the form, the value of the control may change. The value changes are stored in the associated database field.

Bound Column The form:bound-column attribute specifies the column values of the list source result set that are used to fill the data field values. This attribute is supported for the <form:listbox> element. 9976 9977 9978 9979 9980 9981 9982

Convert Empty To Null The form:convert-empty-to-null attribute specifies whether or not empty current values are regarded as NULL This attribute is important for data-aware controls to determine which values to store for the bound database field. This attribute is supported for the following elements: •

<form:text>

•

<form:textarea>

1 May 2005 Page 426 of 706

•

<form:formatted-text>

•

<form:combobox>

If the value of the attribute is true, an empty string in the control is regarded as the dedicated NULL value. If the value of the attribute is false, an empty string in the control is regarded as an empty string. 9983 9984 9985 9986 9987 9988 9989

Data Field The form:data-field attribute specifies the name of a result set column. The result set is determined by the form which the control belongs to. This attribute is supported for the following elements:

9990 9991 9992 9993 9994 9995 9996

•

<form:text>

•

<form:textarea>

•

<form:formatted-text>

•

<form:combobox>

•

<form:listbox>

•

<form:checkbox>

•

<form:radio>

•

<form:image-frame>

List Source The form:list-source attribute specifies the source used to populate the list in a list box or combo box. The first column of the list source result set populates the list. This attribute is supported for the following elements:

9997 9998 9999 10000 10001 10002

•

<form:combobox>

•

<form:listbox>

1 May 2005 Page 427 of 706

10003

</define>

List Source Type The form:list-source-type attribute specifies the type of data source that is used to populates the list data in a list box or combo box. This attribute is supported for the following elements: •

<form:combobox>

•

<form:listbox>

The value of this attribute can be one of the following:

10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017

•

table: The list is populated using the content of a database table.

•

query: The list is populated by executing a query.

•

sql: The list is populated by executing an SQL statement.

•

sql-pass-through: The list is populated by executing any type of statement that is passed directly to a database driver, without being interpreted by the application.

•

value-list: The list is populated with values specified by the user using the form:value attribute in the <form:option> element. This setting is only applicable to list boxes.

•

table-fields: The list is populated using the field names in a database table.

<define name="list-source-type"> <optional> <attribute name="form:list-source-type"> <choice> <value>table</value> <value>query</value> <value>sql</value> <value>sql-pass-through</value> <value>value-list</value> <value>table-fields</value> </choice> </attribute> </optional> </define>

11.6 Events HTML defines a list of standard events for controls. These events are represented by attributes, which are associated with the control elements. In the office application XML file format, these events and any additional events defined by the application component are stored as elements in an <office:event-listeners> element. For a single event element, the script:event-name attribute specifies the type of event and other attributes specify the language and the event handler.

11.6.1 Events with an Equivalent HTML Event Type The following table describes the XML events that have an equivalent event in HTML. Their names are contained in the namespace “http://www.w3.org/2001/xml-events”. The namespace prefix used in this specification is DOM. See also 12.4.1.

1 May 2005 Page 428 of 706

Value of script:eventname Attribute

Equivalent HTML Event

Description of Event

dom:change

onchange

Occurs when a control is no longer focussed and the value of the control was modified since it was given focus.

dom:DOMFocusIn

onfocus

Occurs when a control is given focus using the mouse or the TAB key.

dom:DOMFocusOut

onblur

Occurs when a control is no longer focussed as a result of moving the mouse or by tabbing navigation. It may be used with the same elements as form:on-focus.

dom:keydown

onkeydown

Occurs when a key is pressed on a control.

dom:keyup

onkeyup

Occurs when a key is released on a control.

dom:mouseover

onmouseover

Occurs when the mouse pointer is moved over the control.

dom:mousemove

onmousemove

Occurs when the mouse pointer is moved onto a control.

dom:mousedown

onmousedown

Occurs when a mouse button is pressed on a control.

dom:mouseup

onmouseup

Occurs when a mouse button is released on a control.

on-mouseout

onmouseout

Occurs when the mouse pointer is moved away from a control.

dom:reset

onreset

Occurs when a form is reset.

dom:submit

onsubmit

Occurs when a form is submitted.

11.6.2 Event Types In addition to the HTML event types, the XML file format for office applications allows additional events to be handled at run time. Value of script:eventname Attribute

Applies To

Description of Event

form:approveaction

Button or image.

Occurs before the on-performaction event takes place. Allows the user to veto the action.

form:performaction

Button or image.

Occurs when the control action is to be performed. The common interpretation of this event is “pressing the button”.

form:textchange

All controls that allow text input.

Occurs when a user changes the text in a control.

form:itemstatechange

Check box or radio button.

Occurs when the state of a check box or radio button changes.

1 May 2005 Page 429 of 706

Value of script:eventname Attribute

Applies To

Description of Event

form:mousedrag

All controls.

Occurs when a user presses and holds one of the mouse buttons and moves the mouse pointer onto a control.

form:approvereset

same objects as for form:on-reset

Occurs before the on-reset event takes place. Allows the user to veto the reset event.

form:approveupdate

All controls that Occurs before the on-update event takes can be bound to a place. Allows the user to veto the update. database field, that is controls that contain the data-field attribute.

form:update

All controls that Occurs when the content of a control that is can be bound to a bound to a database field is committed. database field, that is controls that contain the data-field attribute.

form:load

Forms.

Occurs when the form establishes a connection to the data source.

form:startrealod

Forms.

Occurs when the form is about to refresh a data source connection.

form:reload

Forms.

Occurs when the form has refreshed a data source connection.

form:startunload

Forms.

Occurs when the form is about to drop a data source connection.

form:unload

Forms.

Occurs when the form has dropped a data source connection.

form:confirmdelete

Forms.

Occurs when the user is about to delete a record.

form:approverowchang e

Forms.

Occurs before the on-rowchange event takes place. Allows the user to veto the change.

form:rowchange

Forms.

Occurs after changes to a row are complete, such as deletions, updates, and insertions.

form:approvecursormo ve

Forms.

Occurs before the form is moved to another row. Allows the user to veto the move.

form:cursormove

Forms.

Occurs after the form is moved to another row.

form:supplyparameter

Forms.

Occurs when the form needs to fill parameters to connect to a data source.

1 May 2005 Page 430 of 706

Value of script:eventname Attribute

Applies To

Description of Event

form:error

Forms, combo boxes and list boxes.

Occurs when a database-related error occurs.

form:adjust

Value Range

Occurs when the value of a Value Range element has been adjusted.

11.7 Properties The <form:properties> element may be used to store the following settings for controls and forms: •

Settings that are not known by the document format.

•

Settings that are provided by external vendors.

•

Settings that are specific to the application.

Properties consist of a name/value pair. The name identifies the property. The value can be given in a fundamental data type or as a list of fundamental data types.

11.7.1 Property Set The <form:properties> element contains the property elements. Properties are encoded using the form:property element, except for list properties, which make use of the form:list-property element. 10018 10019 10020 10021 10022 10023 10024

11.7.2 Property The <form:property> element describes a single property, and contains its name, type and value. 10025 10026 10027 10028 10029 10030

Property Name The form:property-name attribute specifies the name of a property element. 10031 10032 10033 10034

1 May 2005 Page 431 of 706

10035

</define>

Property Value and Type The value and type of form properties are represented through the common office:valuetype and suitable value attributes. See section 6.7.1for more information on these attributes. In addition to these value types, form properties can also be empty. This is represented by the special value type void. Such properties have no value attribute. 10036 10037 10038 10039 10040 10041 10042 10043

11.7.3 List Property The <form:list-property> element specifies a property that contains a list of values. A value type attribute determines which types are allowed on the list elements. The element contains a sequence of list value elements, each of which contains a value attribute suitable to the value type given in the <form:list-property> element. The value attributes are the same as those used elsewhere in the specification, except that the type attribute is attached to the container element, which the value attributes are attached to the list values. (See section 6.7.1 for more information on vale and value type attributes.) 10044 10045 10046 10047 10048 10049

List Value The list value element contains value attributes for the value type given in the containing <form:list-property> element. 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069

<define name="form-property-type-and-value-list"> <choice> <group> <attribute name="office:value-type"> <value>float</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:value"> <ref name="double"/> </attribute> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>percentage</value> </attribute> <zeroOrMore> <element name="form:list-value">

1 May 2005 Page 432 of 706

10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135

<attribute name="office:value"> <ref name="double"/> </attribute> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>currency</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:value"> <ref name="double"/> </attribute> <optional> <attribute name="office:currency"> <ref name="string"/> </attribute> </optional> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>date</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:date-value"> <ref name="dateOrDateTime"/> </attribute> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>time</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:time-value"> <ref name="duration"/> </attribute> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>boolean</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:boolean-value"> <ref name="boolean"/> </attribute> </element> </zeroOrMore> </group> <group> <attribute name="office:value-type"> <value>string</value> </attribute> <zeroOrMore> <element name="form:list-value"> <attribute name="office:string-value">

1 May 2005 Page 433 of 706

10136 10137 10138 10139 10140 10141 10142 10143 10144 10145

Example: Form properties The following contains a string property “Name” with value “Name 1”, and a string list property “Items” containing the strings “Item 1”, “Item 2”, “Item 3”. <form:properties> <form:property form:property-name="Name" office:value-type="string" office:string-value="Name 1"> <form:list-property form:property-name="Items" office:value-type="string" > <form:list-value office:string-value="Item 1"/> <form:list-value office:string-value="Item 2"/> <form:list-value office:string-value="Item 3"/> </form:list-property> </form:properties>

1 May 2005 Page 434 of 706

12 Common Content 12.1 Annotation The <office:annotation> element specifies an OpenDocument annotation. The annotation's text is contained in <text:p> and <text:list> elements. 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169

The attributes associated with the <office:annotation> element are: •

Display

•

Position, size, style, layer, z-index, id, and transformation (see section 9.2.15)

•

Text anchor, table background, draw end position (see section 9.2.16)

•

Caption point, round corners (see section 9.2.10)

Display The office:display attribute specifies whether or not the annotation is visible. 10170 10171 10172 10173 10174 10175 10176

Caption Attributes The following attributes can be attached to the <office:annotation> element to influence how it is displayed: svg:x, svg:y, svg:width, svg:height, draw:caption-point-x, OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved.

1 May 2005 Page 435 of 706

draw:caption-point-y, draw:corner-radius, table:end-cell-address, table:end-x, table:end-y, text:anchor-type, text:anchor-page-number, draw:layer, draw:style-name, draw:text-style-name, draw:transform, draw:name, draw:z-index and draw:id. Their meaning is the same as if they are applied to a <draw:caption> element (see section 9.2.10). The use of these attributes is optional.

12.1.1 Creator The optional <dc:creator> element described in section 3.1.7 specifies the author of the annotation.

12.1.2 Creation Date and Time The optional <dc:date> element described in section 3.1.9 specifies the creation date and time of the annotation.

12.1.3 Creation Date and Time String If the application only has a date string and cannot parse this string, it may write the string into the <meta:date-string> element. 10177 10178 10179 10180 10181

12.2 Number Format The OpenDocument number format consists of three parts: •

Prefix – the text that is displayed before the number

•

Display format specification, for example, A, B, C, or 1, 2, 3

•

Suffix – the text that is displayed after the number

12.2.1 Prefix and Suffix The style:num-prefix and style:num-suffix attributes specify what to display before and after the number. If the prefix and suffix do not contain alphanumeric characters, an [XSLT] format attribute can be created from the OpenDocument attributes by concatenating the values of the style:numprefix, style:num-format, and style:num-suffix attributes. 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192

1 May 2005 Page 436 of 706

10193

</define>

12.2.2 Format Specification The style:num-format attribute specifies the format of the number in the same way as the [XSLT] format attribute. The number styles supported are as follows: •

Numeric: 1, 2, 3, ...

•

Alphabetic: a, b, c, ... or A, B, C, ...

•

Roman: i, ii, iii, iv, ... or I, II, III, IV,...

The value of this attribute can be "1", "a", "A", "i", or "I". For some elements, the attribute value also can be empty. In this case, no number is displayed. 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216

12.2.3 Letter Synchronization in Number Formats If letters are used in alphabetical order for numbering, there are two ways to process overflows within a digit, as follows: •

A new digit is inserted. Its start value is A, and it is incremented every time an overflow occurs in the following digit. The numbering sequence in this case is something like a,b,c, ..., z, aa, ab, ac, ...,az, ba, ..., and so on.

•

A new digit is inserted that always has the same value as the following digit. The numbering sequence in this case is something like a, b, c, ..., z, aa, bb, cc, ..., zz, aaa, ..., and so on. This is called letter synchronization.

The style:num-letter-sync specifies whether letter synchronization shall take place. 10217 10218 10219 10220 10221 10222 10223

1 May 2005 Page 437 of 706

12.3 Change Tracking Metadata Meta-data for change tracking is contained inside an <office:change-info> element. It contains the author and creation date of a tracked change, as well as an optional comment. 10224 10225 10226 10227 10228 10229 10230 10231 10232

Creator The <dc:creator> element as described in section 3.1.7 specifies the name of the author who changed the document.

Date and Time The <dc:date> element as described in section 3.1.9 specifies the date and time when the change took place.

Comment An additional comment may be included as <text:p> elements.

12.4 Event Listener Tables Many objects such as controls, images, text boxes, or an entire document support events. An event binds the occurrence of a particular condition to an action that is executed if the condition arises. For example, if a user places the cursor over a graphic, this condition triggers an action that is supported by the office application. This event, called "on-mouse-over", can be associated with an macro that is executed whenever the condition occurs, that is, whenever a user places the cursor over a graphic. The XML representation of events and event tables is structured as follows: •

All of the event elements that are associated with an object are located in a container element called <office:event-listeners>.

•

Each event-to-action association is recorded in one <script:event-listener> element.

•

Depending on the type of action that the event triggers, the following elements are used: –

The <script:event-listener> element represents events that are bound to a macro or script.

–

The <presentation:event-listener> element represents events that are bound to an action that is specific to a presentation, for example, go to the next page. Presentation events are described in section .

The <office:event-listeners> element specifies the table of events that are associated with an object.

1 May 2005 Page 438 of 706

10233 10234 10235 10236 10237 10238 10239 10240 10241 10242

12.4.1 Event Listener The <script:event-listener> element binds an event to a macro. 10243 10244 10245 10246 10247 10248

The attributes that may be associated with the <script:event-listener> element are: •

Event name

•

Script language

•

Macro Name and Location

Event Name The script:event-name attribute specifies the name of the event. Since the available events, their names and their meanings are application and script language dependent, the name should be preceded by a namespace prefix, so that the corresponding namespace together with the event name can be used to identify the semantic of the event. For events that are specified in the DOM event model, it is recommended to use the event names described in §1.4.2 of [DOMEvents]. The corresponding namespace is "http://www.w3.org/2001/xml-events" . 10249 10250 10251 10252 10253

Script Language The script:language attribute specifies the scripting language in which the macro or script which is associated with the event is written. See also section 2.5.1. 10254 10255 10256 10257 10258

Macro Name and Location The macro code that should be called for the event can be either specified by an URI in [XLink] notation, or a simple name specified by a script:macro-name attribute. If an XLink is used,

1 May 2005 Page 439 of 706

the URI may have an arbitrary protocol, for instance one that encodes the name of a macro library name together with macro name defined in this library. Both, the XLink URI as well as a simple name, are script language dependent. 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280

<define name="script-event-listener-attlist" combine="interleave"> <choice> <attribute name="script:macro-name"> <ref name="string"/> </attribute> <group> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> <optional> <attribute name="xlink:type" a:defaultValue="simple"> <value>simple</value> </attribute> </optional> <optional> <attribute name="xlink:actuate" a:defaultValue="onRequest"> <value>onRequest</value> </attribute> </optional> </group> </choice> </define>

12.5 Mathematical Content Mathematical content is represented by MathML 2.0 (see [MathML]) 10281 10282 10283 10284 10285

10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302

<define name="mathMarkup"> <zeroOrMore> <choice> <attribute> <anyName/> </attribute> <text/> <element> <anyName/> <ref name="mathMarkup"/> </element> </choice> </zeroOrMore> </define>

12.6 DDE Connections A Dynamic Data Exchange (DDE) connection consists of the parameters for the DDE target application, a file name, and a command string. A DDE connection also takes a parameter that specifies whether it will be updated automatically or only on the user's request. Every DDE connection must be named. All elements making use of DDE connections must contain their content (or its presentation), so that documents using DDE can still be properly displayed on machines which do not support the

1 May 2005 Page 440 of 706

DDE mechanism, or where the DDE target is not available. Applications should preserve the DDE connection information even if they cannot make use of it, so that other applications can make use the DDE facilities.

12.6.1 Container for DDE Connection Declarations Within text and spreadsheet documents, DDE connection declarations are contained in one declaration element. For text documents, the element is <text:dde-connection-decls> as described in section 4.7. For spreadsheet documents, it is <table:dde-links> as described in section 8.10.

12.6.2 Declaring DDE Connections for Text Fields Every DDE connection used by a text field is declared using a declaration element. Multiple DDE fields can refer to one DDE connection by using the same name. The declaration element has no content. 10303 10304 10305 10306 10307 10308

The attributes that may be associated with the <text:dde-connection-decl> element are: •

Connection name

•

DDE target application

•

DDE target topic

•

DDE target item

•

Automatic update flag

Connection Name The office:name attribute specifies the name by which the connection will be referred. 10309 10310 10311 10312 10313

Target Application The office:dde-application attribute specifies the name of the target application to use for the DDE connection. 10314 10315 10316 10317 10318

1 May 2005 Page 441 of 706

Example: The target name for the OpenOffice.org software is soffice. Therefore, internal DDE links have the attribute text:ddeapplication="soffice".

Target Topic The office:dde-topic attribute specifies the name of the topic to use for the DDE connection. 10319 10320 10321 10322 10323

Example: The OpenOffice.org software interprets the DDE topic as the name of the file.

Target Item The office:dde-item attribute specifies which information the target application should deliver. 10324 10325 10326 10327 10328

Example: If the target application for the DDE connection is the OpenOffice.org Writer software, the item represents the name of a bookmark. OpenOffice.org delivers the current text content to the requesting application.

Automatic Update Office applications by default automatically update DDE links. If a manual update of the link is preferred, the text:automatic-update attribute my be used to specify that the DDE connection links should only be updated at the request of the user. If the value of this attribute is true, then the application is expected to automatically update the DDE links. If this value of this attribute is false, the DDE links are updated on user request only. 10329 10330 10331 10332 10333 10334 10335

12.6.3 Declaring DDE Connections for Tables The DDE connection data of tables is contained in an <office:dde-source> element. The usage of this element differs between spreadsheet and text document tables. For text document tables, the element is contained within the table's <table:table> element directly. For

1 May 2005 Page 442 of 706

spreadsheet documents, it is contained in a <table:dde-link> element, that describes a single DDE connection. The <table:dde-link> element contains the DDE source data in the <office:ddesource> element and a simple table element that might be used to cache the data of the DDE source. The table does not need a name and does not contain style information. Only the data contained in the cell attributes is used. The cells themselves remain empty. 10336 10337 10338 10339 10340 10341

The <office:dde-source> element supports office:dde-application, office:ddetopic, office:dde-item and office:automatic-update attributes as described in section 12.6.2. In addition to this, it supports the following attributes

10342 10343 10344 10345 10346 10347

•

Connection name

•

Conversion mode

Connection Name The office:name attribute specifies the name by which the connection can be referred. 10348 10349 10350 10351 10352 10353 10354

Conversion Mode The office:conversion-mode attribute specifies the method by which the DDE server converts its data into numbers. There are three possible values:

10355 10356 10357 10358 10359 10360 10361 10362

•

into-default-style-data-style: Numbers are converted into the data style which is set on the default style.

•

into-english-number: numbers are converted into the English default format.

•

keep-text: Numbers are not converted. They are treated as text.

<define name="office-dde-source-attlist" combine="interleave"> <optional> <attribute name="office:conversion-mode" a:defaultValue="into-default-style-data-style"> <choice> <value>into-default-style-data-style</value> <value>into-english-number</value> <value>keep-text</value>

1 May 2005 Page 443 of 706

10363 10364 10365 10366

</choice> </attribute> </optional> </define>

1 May 2005 Page 444 of 706

13 SMIL Animations This section describes [SMIL20] based elements and attribute that can be used within the OpenDocument format for animation effects.

13.1 Basic Animation Elements The basic animation elements are directly derived from basic animation elements specified §3.5 and §12.5 of [SMIL20], and in section §19.2 of [SVG].

13.1.1 Animate The <anim:animate> element behaves like the [SMIL20] <smil:animate> element. See §3.5.1 of [SMIL20] for details. 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378

13.1.2 Set The <anim:set> element behaves like the [SMIL20] <smil:set> element. See §3.5.2 of [SMIL20] for details. 10379 10380 10381 10382 10383 10384 10385 10386 10387

13.1.3 Animate Motion The <anim:animateMotion> element behaves as the [SVG] <svg:animateMotion> element. See §19.2.12 of [SVG] and §3.5.3 of [SMIL20] for details. 10388 10389 10390 10391 10392 10393 10394 10395

1 May 2005 Page 445 of 706

10396 10397 10398

The Motion Path The [SVG] svg:path attribute can be used to specify a path along which the element is animated. See §19.2.12 of [SVG] for details. 10399 10400 10401 10402 10403 10404 10405

Origin The [SVG] svg:origin attribute can be used to specify an origin. See §19.2.12 of [SVG] for details. 10406 10407 10408 10409 10410 10411 10412

Calc Mode The [SMIL20] smil:calcMode attribute is used to specify the interpolation mode of the animation. See §19.2.12 of [SVG] for details. 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424

<define name="anim-animate-motion-attlist" combine="interleave"> <optional> <attribute name="smil:calcMode" a:defaultValue="paced"> <choice> <value>discrete</value> <value>linear</value> <value>paced</value> <value>spline</value> </choice> </attribute> </optional> </define>

13.1.4 Animate Color The <anim:animateColor> element behaves like the [SMIL20] <smil:animateColor> element. See §3.5.4 of [SMIL20] for details. 10425 10426 10427 10428 10429 10430 10431 10432

1 May 2005 Page 446 of 706

10433 10434 10435 10436

Color Interpolation The anim:color-interpolation attribute specifies the color space that is used for color interpolation. 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446

Color Interpolation Direction The anim:color-interpolation-direction attribute specify the direction that is used for color interpolation. This is only valid for the HSL color space. 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457

<define name="anim-animate-color-attlist" combine="interleave"> <optional> <attribute name="anim:color-interpolation-direction" a:defaultValue="clockwise"> <choice> <value>clockwise</value> <value>counter-clockwise</value> </choice> </attribute> </optional> </define>

13.1.5 Animate Transform The <anim:animateTransform> element is based on the [SVG] <svg:animateTransform> element. See §19.2.14 of [SVG] for details. 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467

Transformation Type The [SVG] svg:type attribute is used to specify the transformation type. See §19.2.14 of [SVG] for details. 10468 10469

1 May 2005 Page 447 of 706

10470 10471 10472 10473 10474 10475 10476 10477 10478

<choice> <value>translate</value> <value>scale</value> <value>rotate</value> <value>skewX</value> <value>skewY</value> </choice> </attribute> </define>

13.1.6 Transition Filter The <anim:transitionFilter> element is based on the [SMIL20] <smil:transitionFilter> element. See §12.5.1 of [SMIL20] for details. 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488

Transition Type The [SMIL20] smil:type attribute is used to specify the transition type or family. See §12.8 of [SMIL20] for a list of supported types. 10489 10490 10491 10492 10493

Transition Subtype The [SMIL20] smil:subtype attribute can be used to specify the transition subtype. See §12.8 of [SMIL20] for a list of supported subtypes. 10494 10495 10496 10497 10498 10499 10500

Transition Direction The [SMIL20] smil:direction attribute can be used to specify the transition direction. See §12.4.1 of [SMIL20] for details. 10501 10502 10503 10504 10505 10506

<define name="anim-transition-filter-attlist" combine="interleave"> <optional> <attribute name="smil:direction" a:defaultValue="forward"> <choice> <value>forward</value> <value>reverse</value>

1 May 2005 Page 448 of 706

10507 10508 10509 10510

</choice> </attribute> </optional> </define>

Fade Color The [SMIL20] smil:fadeColor attribute can be used to specify the transition fade color for transitions that makes use of a start or end color. See §12.5.1 of [SMIL20] for details. 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520

<define name="anim-transition-filter-attlist" combine="interleave"> <optional> <attribute name="smil:fadeColor"> <choice> <value>forward</value> <value>reverse</value> </choice> </attribute> </optional> </define>

The Transition Mode The [SMIL20] smil:mode attribute is used to specify if the animated element will be transition in or out. See §12.5.1 of [SMIL20] for details. 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530

13.2 Animation Model Attributes The animation model uses the same concepts and syntax as specified in §3 of [SMIL20].

13.3 Common Animation Attributes Element Id The anim:id attribute defines an ID that is used to identify the element inside a document. 10531 10532 10533 10534 10535 10536 10537

1 May 2005 Page 449 of 706

13.3.1 Animation Target Attributes Target Element The [SMIL20] smil:targetElement attribute is used to specify the target element to be animated. See §3.4.1 of [SMIL20] for details. See section 9.8.2 for details about the usage of this attribute in presentation documents. 10538 10539 10540 10541 10542 10543 10544

Target Attribute The [SMIL20] smil:attributeName attribute is used to specify a target attribute by name. See §3.4.1 of [SMIL20] for details. See section 9.8.2 for details about the usage of this attribute in presentation documents. 10545 10546 10547 10548 10549

Target Element Sub Item The anim:sub-item attribute specifies an optional sub item of the target element. Possible values for this element depend on the document type and the target element type. See section 9.8.2 for details about the usage of this attribute in presentation documents. 10550 10551 10552 10553 10554 10555 10556

13.3.2 Animation Function Attributes Value List The [SMIL20] smil:values attribute specifies the values used to animate the target element. See $3.4.2 of [SMIL20] for details. 10557 10558 10559 10560 10561 10562 10563

1 May 2005 Page 450 of 706

Calc Mode The [SMIL20] smil:calcMode attribute is used to specify the interpolation mode of the animation function. See $3.4.2 of [SMIL20] for details. 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575

<define name="common-anim-spline-mode-attlist" combine="interleave"> <optional> <attribute name="smil:calcMode" a:defaultValue="discrete"> <choice> <value>discrete</value> <value>linear</value> <value>paced</value> <value>spline</value> </choice> </attribute> </optional> </define>

Key Times The [SMIL20] smil:keyTimes attribute specifies the pacing of the animation. See $3.7.1 of [SMIL20] for details. 10576 10577 10578 10579 10580 10581 10582

Key Splines The [SMIL20] smil:keySplines attribute specifies a cubic Bezier function that controls interval pacing. See $3.7.1 of [SMIL20] for details. 10583 10584 10585 10586 10587 10588 10589

Accumulation The [SMIL20] smil:accumulate attribute specifies the accumulation of the animation function. See $3.4.3 of [SMIL20] for details. 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599

1 May 2005 Page 451 of 706

Additive The [SMIL20] smil:additive attribute specifies if the additive of the animation function. See $3.4.3 of [SMIL20] for details. 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609

<define name="common-anim-add-accum-attlist" combine="interleave"> <optional> <attribute name="smil:additive"> <choice> <value>replace</value> <value>sum</value> </choice> </attribute> </optional> </define>

Formula The anim:formula attribute specifies a formula that is used as the animation function. The identifier '$' will be replaced by a value between 0 and 1 (inclusive) that represents the proportional offset into the animation element's duration. For specific document types, additional identifiers may exist. The following is the minimum supported grammar: identifier = '$' | 'pi' function = 'abs'|'sqrt'|'sin'|'cos'|'tan'|'atan'|'acos'|'asin'|'exp'|'log'

binary_function = 'min'|'max'

basic_expression = number | identifier | function '(' additive_expression ')' |

binary_function '(' additive_expression ',' additive_expression ')' | '(' additive_expression ')'

unary_expression = '-' basic_expression | basic_expression multiplicative_expression = unary_expression ( ( '*' unary_expression )* | ( '/' unary_expression )* ) additive_expression = multiplicative_expression ( ( '+' multiplicative_expression )* | ( '-' multiplicative_expression )* )

See section 9.8.2 for details about additional identifiers for presentation documents. If a anim:formula attribute is given, it overrides the smil:values, smil:to, smil:from and smil:by attributes as specified in the next section. 10610 10611 10612 10613 10614 10615 10616

1 May 2005 Page 452 of 706

Simple Animation Functions In addition to describing an animation with a list of values, a simplified version using the [SMIL20] smil:from, smil:to and smil:by attributes can be used. See §3.4.4 of [SMIL20] for details. 10617 10618 10619 10620 10621 10622 10623

10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637

13.4 Animation Timing The animation timing uses the same concepts and syntax as specified in §10 and §11 of [SMIL20] chapters.

13.4.1 Animation Timing Attributes Element Start The [SMIL20] smil:begin attribute can be used to specify the begin time of an element. See §10.3.1 of [SMIL20] for details. 10638 10639 10640 10641 10642 10643 10644

Element End The [SMIL20] smil:end attribute can be used to specify the end time of an element. See §10.3.1 of [SMIL20] for details. 10645 10646 10647 10648 10649 10650 10651

1 May 2005 Page 453 of 706

Element Duration The [SMIL20] smil:dur attribute can be used to specify the duration of an element. See §10.3.1 of [SMIL20] for details. 10652 10653 10654 10655 10656 10657 10658

Element End Syncronization The [SMIL20] smil:endsync attribute can be used to control the implicit duration of time containers, as a function of the children. See §10.3.1 of [SMIL20] for details. 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670

<define name="common-endsync-timing-attlist" combine="interleave"> <optional> <attribute name="smil:endsync"> <choice> <value>first</value> <value>last</value> <value>all</value> <value>media</value> </choice> </attribute> </optional> </define>

Repeating Elements The [SMIL20] smil:repeatCount and smil:repeatDur attributes specifies the behavior of repeated animations. See §10.3.1 of [SMIL20] for details. 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680

Fill The [SMIL20] smil:fill attribute specifies the behavior of an element after an animation is finished. See §10.3.1 of [SMIL20] for details. 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690

<define name="common-fill-timing-attlist" combine="interleave"> <optional> <attribute name="smil:fill"> <choice> <value>remove</value> <value>freeze</value> <value>hold</value> <value>auto</value> <value>default</value> <value>transition</value>

1 May 2005 Page 454 of 706

10691 10692 10693 10694

</choice> </attribute> </optional> </define>

Fill Default The [SMIL20] smil:fillDefault attribute specifies the default behavior for the smil:fill attribute. See §10.3.1 of [SMIL20] for details. 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708

<define name="common-fill-default-attlist" combine="interleave"> <optional> <attribute name="smil:fillDefault"> <choice> <value>remove</value> <value>freeze</value> <value>hold</value> <value>transition</value> <value>auto</value> <value>inherit</value> </choice> </attribute> </optional> </define>

Restart The [SMIL20] smil:restart attribute can be used to specify the restart behavior of an element. See §10.3.1 of [SMIL20] for details. 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720

<define name="common-restart-timing-attlist" combine="interleave"> <optional> <attribute name="smil:restart" a:defaultValue="default"> <choice> <value>never</value> <value>always</value> <value>whenNotActive</value> <value>default</value> </choice> </attribute> </optional> </define>

Restart Default The [SMIL20] smil:restartDefault attribute can be used to specify the default restart behavior of an element. See §10.3.1 of [SMIL20] for details. 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732

<define name="common-restart-default-attlist" combine="interleave"> <optional> <attribute name="smil:restartDefault" a:defaultValue="inherit"> <choice> <value>never</value> <value>always</value> <value>whenNotActive</value> <value>inherit</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 455 of 706

Accelerate The [SMIL20] smil:accelerate attribute can be used to specify a simple acceleration of element time. See §11.1.2 of [SMIL20] for details. 10733 10734 10735 10736 10737 10738 10739

Decelerate The [SMIL20] smil:decelerate attribute can be used to specify a simple deceleration of element time. See §11.1.2 of [SMIL20] for details. 10740 10741 10742 10743 10744 10745 10746

Auto Reverse The [SMIL20] smil:autoreverse attribute can be used to specify an automatic playback in reverse. See §11.1.2 of [SMIL20] for details. 10747 10748 10749 10750 10751 10752 10753

13.4.2 Parallel Animations The <anim:par> element is based on the [SMIL20] <smil:par> element and defines a parallel time container. See §10.3.2 of [SMIL20] for details. 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763

10764 10765 10766 10767 10768 10769

10770 10771

1 May 2005 Page 456 of 706

10772 10773 10774 10775 10776 10777 10778

13.4.3 Sequential Animations The <anim:seq> element is based on the [SMIL20] <smil:seq> element and defines a sequential time container. See §10.3.2 of [SMIL20] for details. 10779 10780 10781 10782 10783 10784 10785

13.4.4 Iterative Animations The <anim:iterate> element defines a parallel time container. The difference to a <anim:par> element is that the <anim:iterate> element does not specify effects for its target element itself. Instead of this, it iterates over possible child elements of the target element and executes all its child effects with the children of the target element as target. 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796

The Target Element The [SMIL20] smil:targetElement attribute specifies the target element to that's children the effects should be applied. See section 9.8.2 for details about the attribute's usage in presentation documents. 10797 10798 10799 10800 10801 10802 10803

The Iterate Type The anim:iterate-type attribute specifies how the iteration targets child elements are iterated. Possible values depends on the document type and the target element type. See section 9.8.2 for details about the attribute's usage in presentation documents.

1 May 2005 Page 457 of 706

10804 10805 10806 10807 10808 10809 10810

The Iterate Interval The anim:iterate-interval attribute specifies the delay between the execution of the child effects of this element. The effects of the next iterated child of the target element are started when the given time is elapsed since the effects for the previous child has been started. An iterate interval of zero seconds would have the same behavior as using a <anim:par> element. 10811 10812 10813 10814 10815 10816 10817

13.5 Media Elements 13.5.1 Audio The <anim:audio> element is based on the [SMIL20] <smil:audio> element. It allows the playback of audio streams during an animation. See §7.3.1 of [SMIL20] for details. 10818 10819 10820 10821 10822 10823 10824

Source The xlink:href attribute specifies the URI of the audio stream. 10825 10826 10827 10828 10829 10830 10831

Audio Level The anim:audio-level attribute specifies the volume during playback. Its value is a number in the range 0 (inaudible) to 1 (the system volume). 10832 10833 10834 10835

1 May 2005 Page 458 of 706

10836 10837 10838

</attribute> </optional> </define>

13.6 Special Elements 13.6.1 Command The <anim:command> element is used to send generic commands to the application during an animation. The available command types and its parameters depend on the document type and the type of the target element. See section 9.8.2 for details about the element's usage in presentation documents. 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852

Command The anim:command attribute specifies the command that will be executed at the application when this animation element is started. 10853 10854 10855 10856 10857

1 May 2005 Page 459 of 706

14 Styles Many objects in an office document have formatting properties. A formatting property influences the visual representation of an object but it does not contribute to the content or structure of the document. Examples of formatting properties are: •

Font family

•

Font size

•

Font color

•

Page margins

In the OpenDocument format, formatting properties are only stored within styles. This differs to the user interface of typical office applications, where formatting properties may be assigned to an object directly, or indirectly by applying a style to the object. Assigning formatting properties to an object directly has the same effect as assigning an unnamed style with the same properties to that object. Therefore, user interface styles remain unchanged conceptually in the OpenDocument file format, while formatting properties assigned directly to an object are assumed to be unnamed styles. In order to use unnamed styles, they are assigned a name and therefore become automatic styles. There are two main reasons for using styles to store formatting properties: 1. The format and layout of the document get separated from the document content. 2. If two or more objects have the same formatting properties and styles assigned, the formatting properties that are assigned to the objects directly can be represented by a single automatic style for all objects. This saves disk space and allows styles to integrate seamlessly into the overall document style. Within this chapter, the various style types are explained.

14.1 Style Element Some style families are very similar in structure and can be represented by the same element. For example, the <style:style> element can represent paragraph, text, and graphic styles. The individual style families that make use of these element are described separately. Within this section, the common attributes of the style element are described. 10858 10859 10860 10861 10862 10863 10864 10865 10866

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

Style name

•

Display name

1 May 2005 Page 460 of 706

•

Style family

•

Parent style

•

Next style

•

List style

•

Master page name

•

Automatically update

•

Data style name

•

Class

•

Outline numbering level

Style Name The style:name attribute identifies the name of the style. This attribute, combined with the style:family attribute, uniquely identifies a style. The <office:styles>, <office:automatic-styles> and <office:master-styles> elements each must not contain two styles with the same family and the same name. For automatic styles, a name is generated during document export. If the document is exported several times, it cannot be assumed that the same name is generated each time. In an XML document, the name of each style is a unique name that may be independent of the language selected for an office applications user interface. Usually these names are the ones used for the English version of the user interface. 10867 10868 10869 10870 10871

Display Name The style:display-name attribute specifies the name of the style as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 10872 10873 10874 10875 10876 10877 10878

Style Family The style:family attribute identifies the family of the style, for example, paragraph, text, or frame. It might have one of the following values: paragraph, text, section, table, tablecolumn, table-row, table-cell, table-page, chart, default, drawing-page, graphic, presentation, control and ruby.

1 May 2005 Page 461 of 706

Parent Style The style:parent-style-name attribute specifies the name of the parent style. If a parent style is not specified, a default parent style defined by the application is used. The parent style cannot be an automatic style and has to exist. 10879 10880 10881 10882 10883 10884 10885

Next Style The style:next-style-name attribute specifies the style to used for the next paragraph if a paragraph break is inserted in the user interface. By default, the current style is used as the next style. 10886 10887 10888 10889 10890 10891 10892

List Style A paragraph style and styles of other families that may contain paragraph properties (for instance graphic styles) can have an associated list style. This applies to automatic and common styles. The list style specified by the style:list-style-name attribute is only applied to headings and to paragraphs that are contained in a list, where the list does not specify a list style itself, and the list has no list style specification for any of its parents. The style:list-style-name attribute's value can be empty. In this case, an association with a list style that is inherited from a parent style will be removed. 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902

Master Page Name A paragraph or table style can have an associated style:master-page-name attribute. This applies to automatic and common styles. If this attribute is associated with a style, a page break is inserted when the style is applied and the specified master page is applied to the preceding page.

1 May 2005 Page 462 of 706

This attribute is ignored if it is associated with a paragraph style that is applied to a paragraph within a table. 10903 10904 10905 10906 10907 10908 10909

Automatically Update The style:auto-update attribute determines whether or not styles are automatically updated when the formatting properties of an object that has the style assigned to it are changed. For example, there might be a paragraph style that contains a formatting property specifying that paragraph text is centered, and this paragraph style is applied to a paragraph. If the user manually changes the formatting of that paragraph text to be right-aligned and the value of the style:auto-update attribute is true, then the paragraph style is automatically updated to reflect the new paragraph formatting and every paragraph that uses the paragraph style is also modified to right-align the paragraph text. This attribute can have a value of true or false. 10910 10911 10912 10913 10914 10915 10916

Data Style Name Table cell style can have an associated data style. This applies to automatic and common styles. The data style is referenced by the style:data-style-name attribute. See section 14.7 for details about data styles. 10917 10918 10919 10920 10921 10922 10923

Class A style may belong to an arbitrary class of styles. The class is an arbitrary string. The class has no meaning within the file format itself, but it can for instance be evaluated by user interfaces to show a list of styles where the styles are grouped by its name. 10924 10925 10926 10927 10928 10929 10930

1 May 2005 Page 463 of 706

Outline Numbering Level For style with family paragraph, the style:default-outline-level attribute specifies a default outline level. It takes a number like the text:outline-level attribute of the heading element <text:h>. If this attribute is existing for a paragraph style, and if the paragraph style is assigned to a paragraph by an user interface action, then office applications should convert the paragraph into a heading of the given level. However, the attribute has no effect to the differentiation of headings and paragraphs in the file format itself. The differentiation between headings and paragraphs still takes place by using either a <text:h> or a <text:p> element. If a <text:p> element references a paragraph style that has a style:default-outlinelevel attribute, the paragraph remains a paragraph and will not become a heading. 10931 10932 10933 10934 10935 10936 10937

Formatting Properties If a style has formatting attributes assigned, the style element contains one ore more formatting property container elements. See section 15 for detailed information about these element.

Sample Style Example: OpenDocument representation of the “Text body” paragraph style <style:style style:name="Text body" style:family="paragraph" style:parent-style-name="Standard"> <style:paragraph-properties fo:margin-top="0cm" fo:margin-bottom=".21cm"/> </style:style>

14.1.1 Style Mappings The <style:map> element specifies the mapping to another style, if certain conditions exist. If a style contains such mappings, it is called an conditional style. There is one element for every condition that the style uses. Conditional styles usually are supported by paragraph styles contained in text documents and table cell styles contained in spreadsheets only. Conditional styles are also supported by data styles. 10938 10939 10940 10941 10942 10943

The attributes that may be associated with the <style:map> element are: •

Condition

•

Applied style

•

Base cell address

1 May 2005 Page 464 of 706

Condition The style:condition attribute specifies the condition in which a style map should be applied. The value of this attribute is a Boolean expression. The syntax of the expression is similar to the XPath syntax. If an application detects a condition that it does not recognize, it must ignore the entire <style:map> element. The following conditions are valid for paragraph styles: •

list-level()=n, where n is a number between 1 and 10

•

outline-level()=n, where n is a number between 1 and 10

•

table() and table-header()

•

section()

•

header() and footer()

•

footnote() and endnote()

The following conditions are valid for paragraph styles: •

is-true-formula(formula)

•

cell-content-is-between(value, value)

•

cell-content-is-not-between(value, value)

•

cell-content() operator value, where operator is one of; '<', '>', '<=', '>=', '=' or '!=', and value is a numberValue, a string or a formula.

•

A numberValue is a whole or decimal number. The number cannot contain comma separators for numbers of 1000 or greater.

•

A string comprises one or more characters surrounded by quotation marks.

•

A formula is a formula (see 8.1.3) without the equals (=) sign at the beginning.

The following conditions are valid for data styles: •

value() op n, where op is a relational operator and n is a number.

•

For Boolean styles the condition value must be true and false.

The conditions that apply for different types of styles may differ. 10944 10945 10946 10947 10948

Applied Style The style:apply-style-name attribute specifies the style to apply when the condition specified by the style:condition attribute is true. If the referenced style is undefined or is an automatic style, an error occurs. 10949 10950

1 May 2005 Page 465 of 706

10951 10952 10953

Base Cell Address For table cell styles, the style:base-cell-address attribute specifies the base cell for relative addresses in formulas. This attribute only applies to cell styles where the condition contains a formula. The value of this attribute must be an absolute cell address with a table name. 10954 10955 10956 10957 10958 10959 10960

Example: Style mapping <style:style style:name="Text body" style:family="paragraph" style:parent-style-name="Standard" style:next-style-name="Text body"> <style:paragraph-properties fo:margin-top="0cm" fo:margin-bottom=".21cm"/> <style:map style:condition="footnote" style:apply-style-name="footnote"/> <style:map style:condition="heading(1)" style:apply-style-name="Heading 1"/> <style:map style:condition="heading(2)" style:apply-style-name="Heading 2"/> </style:style>

14.2 Default Styles A default style specifies default formatting properties for a certain style family. These defaults are used if a formatting property is neither specified by an automatic nor a common style. Default styles exist for all style families that are represented by the <style:style> element specified in section 14.1. Default styles are represented by the <style:default-style> element. The only attribute supported by this element is style:family. Its meaning equals the one of the same attribute for the <style:style> element, and the same properties child elements are supported depending on the style family. 10961 10962 10963 10964 10965

14.3 Page Layout The <style:page-layout> element specifies the physical properties of a page. This element contains a <style:page-layout-properties> element which specifies the formatting properties of the page and two optional elements that specify the properties of headers and footers. 10966 10967

1 May 2005 Page 466 of 706

10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979

The attributes that may be associated with the <style:page-layout> element are: •

Name

•

Page usage

Name The style:name attribute specifies the name of the page layout. 10980 10981 10982 10983 10984

Page Usage The style:page-usage attribute specifies the type of pages that the page master should generate. 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996

<define name="style-page-layout-attlist" combine="interleave"> <optional> <attribute name="style:page-usage" a:defaultValue="all"> <choice> <value>all</value> <value>left</value> <value>right</value> <value>mirrored</value> </choice> </attribute> </optional> </define>

14.3.1 Header and Footer Styles The header and footer style elements <style:header-style> and <style:footer-style> specify the formatting properties for headers and footers on a page. These elements must be contained within a page layout element. The contain a <style:header-footerproperties> element that contains the formatting properties of the header or footer. 10997 10998 10999 11000 11001 11002 11003 11004

1 May 2005 Page 467 of 706

11005 11006 11007 11008 11009 11010

14.4 Master Pages In text and spreadsheet documents, the <style:master-page> element contains the content of headers and footers. In these applications, a sequence of pages is generated by making use of a single master page or a set of master pages. In drawing and presentation documents, the <style:master-page> element is used to define master pages as common backgrounds for drawing pages. Each drawing page here is directly linked to one master page, which is specified by the draw:master-page-name attribute of the drawing pages style. Master pages are contained in the <office:master-styles> element. See also section 2.8. All document must contain at least one master page element. 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039

The attributes that may be associated with the <style:master-page> element are: •

Page name

•

Display name

•

Page layout

•

Page style

•

Next style name

1 May 2005 Page 468 of 706

The elements that my be included in the <style:master-page> element are: •

Headers and Footers

•

Forms

•

Styles

•

Shapes

•

Presentation notes

Page Name The style:name attribute specifies the name of a master page. Each master page is referenced using the page name. This attribute is required and the name specified must be unique. 11040 11041 11042 11043 11044

Display Name The style:display-name attribute specifies the name of the master as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 11045 11046 11047 11048 11049 11050 11051

Page Layout The style:page-layout-name attribute specifies a page layout which contains the sizes, border and orientation of the master page. See section 14.3 for details on page layouts. 11052 11053 11054 11055 11056

Page Style In graphic applications, additional drawing page attributes my be assigned to a drawing page using the draw:style-name attribute. This attribute is optional. The fixed family for page styles is drawing-page. This is used to define an optional background filling. 11057 11058 11059 11060 11061 11062

1 May 2005 Page 469 of 706

11063

</define>

Next Style Name For text and spreadsheet documents, the style:next-style-name attribute identifies the master page that is used for the next page if the current page is entirely filled. This attribute is optional. If the next style name is not specified, the current master page is used for the next page. The value of this attribute must be the name of another style:master-page element. 11064 11065 11066 11067 11068 11069 11070

14.4.1 Headers and Footers The header and footer elements specify the content of headers and footers. They are contained within a master page element. The <style:header> and <style:footer> elements contain the content of headers and footers. The two additional elements, <style:header-left> and <style:footer-left>, can be used to specify different content for left pages, if appropriate. If the latter two elements are missing, the content of the headers and footers on left and right pages is the same. If the style:page-usage attribute associated with the page layout has a value of all or mirrored and there are no <style:header-left> or <style:footer-left> elements, the header and footer content is the same for left and right pages. If the style:page-usage attribute has a value of left or right, the <style:headerleft> or <style:footer-left> elements are ignored. The content of headers and footers is either:

11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085

•

Standard text content, for example paragraphs, tables, or lists. Such headers and footers usually are supported by text documents.

•

A sequence of any of the following elements; <style:region-left>, <style:regioncenter> and <style:region-reight>. These elements usually are supported by spreadsheet documents.

•

Empty, which switches off the display of all headers or footers. It is not possible to switch off the display of headers or footers for left pages only.

1 May 2005 Page 470 of 706

11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130

Display The style:display attribute specifies whether the header or footer is displayed or not. 11131 11132 11133 11134 11135 11136 11137

Regions The region elements <style:region-left>, <style:region-center> and <style:region-right> specify three regions of a header or footer that are displayed left aligned, centered or right aligned. Each of these regions can contain a sequence of paragraphs.

1 May 2005 Page 471 of 706

11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152

11153 11154 11155 11156 11157 11158

14.4.2 Presentation Notes The <presentation:notes> element is usually supported only by presentation applications, where each master page as well as each drawing page in a presentation can have an additional presentation notes page. The presentation notes page contains:

11159 11160 11161 11162 11163 11164 11165 11166 11167

•

A preview of the drawing page.

•

Additional graphic shapes as contained in the <presentation:notes> element. While the <presentation:notes> may contain any kind of shapes, the only shape type that should be supported by presentation applications are text boxes (i.e. <draw:text-box> contained in a <draw:frame>).

Page Layout The style:page-layout-name attribute specifies a page layout which contains the sizes, border and orientation of the notes page. See section 14.3 for details on page layouts. 11168 11169 11170 11171 11172 11173 11174

1 May 2005 Page 472 of 706

Page Style The attribute draw:style-name assigns an additional formatting attributes to a notes page by assigning a drawing page style. This attribute is optional. The fixed family for page styles is drawing-page. 11175 11176 11177 11178 11179 11180 11181

Example: Master page containing presentation notes. <office:master-styles> ... <style:master-page style:name="home" style:page-layout="default"> <style:style style:name="title" style:family="presentation"> <style:text-properties fo:font-style="italic"/> </style:style> <style:style style:name="subtitle" style:family="presentation" style:parent-style-name="title"> <style:text-properties style:text-outline="true"/> </style:style> <draw:rectangle .../> <presentation:notes> <draw:text ...>this is a note</draw:text> </presentation:notes> </style:master-page> ... </office:master-styles>

14.5 Table Templates A table template is a set formatting properties, like borders, background color, and text properties that can be applied to a table when creating it. In contrast to other styles, it is not referenced by a table, but if a table is created, a set of table-cell styles is created from the table template. To change the formatting properties of a table, the cell styles and other styles

1 May 2005 Page 473 of 706

themselves have to be changed. Table are contained in the <style:master-styles> element. 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209

Style Name The table:name attribute specifies the name of the table template. 11210 11211 11212 11213 11214

Corner Styles The attributes table:first-row-start-column, table:first-row-end-column, table:last-row-start-column and table:last-row-end-column specify whether the cells in the four corners of the table should get the style from the row they are in or from the column. The possible values of these attributes are row and column. 11215 11216 11217 11218 11219

11220 11221 11222 11223 11224 11225

11226 11227 11228

1 May 2005 Page 474 of 706

11229 11230 11231

11232 11233 11234 11235 11236 11237

11238 11239 11240 11241 11242 11243 11244

<define name="rowOrCol"> <choice> <value>row</value> <value>column</value> </choice> </define>

14.5.1 Row and Column Styles The elements <table:first-row> and <table:last-row> specify the cell styles that shall be applied to the first and last row of a table. They have a table:style-name attribute that references these styles. The elements <table:first-col> and <table:last-col> do the same for the first and last table column. For the remaining cells, the cells styles can either be specified by the <table:body> element, or by the <table:even-rows>/<table:odd-rows> or <table:evencolumns>/<table:odd-columns> element pairs if different cell styles should be applied to even and odd rows or columns. 11245 11246 11247 11248 11249 11250

11251 11252 11253 11254 11255 11256 11257

11258 11259 11260 11261 11262 11263 11264

11265 11266 11267 11268 11269 11270 11271

11272 11273 11274 11275 11276

1 May 2005 Page 475 of 706

11277 11278

</element> </define>

11279 11280 11281 11282 11283 11284 11285

11286 11287 11288 11289 11290 11291 11292

11293 11294 11295 11296 11297 11298 11299

11300 11301 11302 11303 11304 11305 11306

11307 11308 11309 11310 11311 11312

14.6 Font Face Declaration OpenDocument font face declarations directly correspond to the @font-face font description of [CSS2] (see §15.3.1) and the <font-face> element of [SVG] (see §20.8.3), but have the following two extensions: •

OpenDocument font face declarations optionally may have an unique name This name can be used inside styles (i.e. as attribute of <stye:text-properties> element) as value of the style:font-name attribute to immediately select a font face declaration. If a font face declaration is referenced this way, the steps described in §15.5 the [CSS2] font matching algorithms for selecting a font declaration based on the font-family, font-style, font-variant, font-weight and font-size descriptors will not take place, but the referenced font face declaration is used directly.

•

Some additional font descriptor attributes exist. The are described below.

With the exception mentioned above, conforming applications should implement the CSS2 font matching algorithm as described in described in §15.5 the [CSS2], but they may also implement variants of it. They are especially allowed to implement a font matching based only on the font face declarations, that is, a font matching that is not applied to every character independently but only once for each font face declaration. This is useful for editing applications, where a font matching based on characters might be to expensive. 11313 11314

1 May 2005 Page 476 of 706

11315 11316 11317 11318 11319 11320 11321 11322 11323

14.6.1 CSS2/SVG Font Descriptors Font face declarations support the font descriptor attributes and elements described in §20.8.3 of [SVG]. 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373

<define name="style-font-face-attlist" combine="interleave"> <optional> <attribute name="svg:font-family"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="svg:font-style"> <ref name="fontStyle"/> </attribute> </optional> <optional> <attribute name="svg:font-variant"> <ref name="fontVariant"/> </attribute> </optional> <optional> <attribute name="svg:font-weight"> <ref name="fontWeight"/> </attribute> </optional> <optional> <attribute name="svg:font-stretch"> <choice> <value>normal</value> <value>ultra-condensed</value> <value>extra-condensed</value> <value>condensed</value> <value>semi-condensed</value> <value>semi-expanded</value> <value>expanded</value> <value>extra-expanded</value> <value>ultra-expanded</value> </choice> </attribute> </optional> <optional> <attribute name="svg:font-size"> <ref name="positiveLength"/> </attribute> </optional> <optional> <attribute name="svg:unicode-range"/> </optional> <optional> <attribute name="svg:units-per-em"> <ref name="integer"/> </attribute> </optional> <optional>

1 May 2005 Page 477 of 706

11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439

1 May 2005 Page 478 of 706

11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492

</attribute> </optional> <optional> <attribute name="svg:v-ideographic"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:v-alphabetic"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:v-mathematical"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:v-hanging"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:underline-position"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:underline-thickness"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:strikethrough-position"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:strikethrough-thickness"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:overline-position"> <ref name="integer"/> </attribute> </optional> <optional> <attribute name="svg:overline-thickness"> <ref name="integer"/> </attribute> </optional> </define>

11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503

11504 11505

1 May 2005 Page 479 of 706

11506 11507 11508 11509 11510 11511 11512

11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529

11530 11531 11532 11533 11534 11535 11536

11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552

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

14.6.2 Name The style:name attribute specifies the unique name of the font declaration. This name can be used inside styles (i.e. as attribute of <stye:text-properties> element) as value of the style:font-name attribute to immediately select a font face declaration 11553 11554 11555 11556 11557

1 May 2005 Page 480 of 706

14.6.3 Adornments The style:font-adornments attributes specifies adornments, like bold or italic that can be used to locate a font in addition to the family name. 11558 11559 11560 11561 11562 11563 11564

14.6.4 Font Family Generic The style:font-family-generic attribute specifies a generic font family name. See section 15.4.15 for details. 11565 11566 11567 11568 11569 11570 11571

14.6.5 Font Pitch The style:font-pitch attribute specifies whether a font has a fixed or variable width. See section 15.4.17 for details. 11572 11573 11574 11575 11576 11577 11578

11579

14.6.6 Font Character Set The style:font-charset attribute specifies the character set of a font. See section 15.4.18 for details. 11580 11581 11582 11583 11584 11585 11586

14.7 Data Styles Data styles describe how to display different types of data, for example, a number or a date. The elements and attributes that are used to represent data styles are contained in the namespace urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0. The prefix number denotes the data styles namespace.

1 May 2005 Page 481 of 706

This section describes the OpenDocument representation of the following data styles: •

Number style

•

Currency style

•

Percentage style

•

Date style

•

Boolean style

•

Text style

14.7.1 Number Style The <number:number-style> element describes the style for decimal numbers. This element can contain one of the following elements: •

<number:number>

•

<number:scientific-number>

•

<number:fraction>

These elements describe the display format of the number. The elements can be preceded or followed by <number:text> elements, which contain any additional text to be displayed before or after the number. In addition, this element can contain a <style:text-properties> element and a <style:map> element. 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606

11607 11608 11609 11610 11611 11612 11613 11614

See section 14.7.9 for information about the attributes that may be associated with the number style elements.

1 May 2005 Page 482 of 706

The following elements may be contained in the <number:number-style> element: •

Number

•

Scientific number

•

Fraction

Number The <number:number> element specifies the display properties for a decimal number. This element is contained in the <number:number-style> element. The <number:number> element can contain multiple <number:embedded-text> elements. The number:decimal-replacement and number:display-factor attributes may be used with this element. See also section 14.7.11 for information about additional attributes that may be associate with the <number:number> element. 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624

Decimal Replacement If a number style specifies that decimal places are used but the number displayed is an integer, a replacement text may be displayed instead of the decimal places. The number:decimalreplacement attribute specifies the replacement text. Some applications may supports replacement text only that consists of the same number of “-” characters as decimal places. 11625 11626 11627 11628 11629

Display Factor The number:display-factor attribute specifies a factor by which each number is scaled (divided) before displaying. A factor of 1000, for example, causes numbers to be displayed in thousands. Some applications may only support display factors of 1000 to the power of a non-negative integer number, that is 1, 1000, 1000000, 1000000000, etc. 11630 11631 11632 11633 11634 11635 11636

1 May 2005 Page 483 of 706

Embedded Text The <number:embedded-text> element specifies text that is displayed at one specific position within a number. This element is different to a grouping separator, which appears several times within a number. This element is contained in the <number:number> element. The <number:number> element can contain multiple occurrences of the <number:embedded-text> element to describe text at different positions in the number. 11637 11638 11639 11640 11641 11642

The number:position attribute specifies the position where the text appears.

Position Attribute The position is counted from right to left, from before the decimal point if one exists, or else from the end of the number. For example, position number 1 indicates that the text is inserted before the last digit. Position number 2 indicates that the text is inserted before the second last digit, and so on. 11643 11644 11645 11646 11647

Scientific Number The <number:scientific-number> element specifies the display properties for a number style that should be displayed in scientific format. This element is contained in the <number:number-style> element. The number:min-exponent-digits attribute may be used with this element. See section 14.7.11 for information on additional attributes that may be associated with the <number:scientific-number> element. 11648 11649 11650 11651 11652 11653 11654 11655

Minimum Exponent Digits The number:min-exponent-digits attribute specifies the minimum number of digits to use to display an exponent. This attribute is supported for the <number:scientific-number> element. 11656 11657 11658 11659 11660

1 May 2005 Page 484 of 706

11661 11662

</optional> </define>

Fraction The <number:fraction> element specifies the display properties for a number style that should be displayed as a fraction. This element is contained in the <number:number-style> element. The number:min-numerator-digits and number:min-denominator-digits attributes may be used with this element. See section 14.7.11 for information on the attributes that may be associated with the <number:fraction> elements. 11663 11664 11665 11666 11667 11668 11669

Minimum Numerator Digits The number:min-numerator-digits attribute specifies the minimum number of digits to use to display the numerator in a fraction. 11670 11671 11672 11673 11674 11675 11676

Minimum Denominator Digits The number:min-denominator-digits attribute specifies the minimum number of digits to use to display the denominator of a fraction. 11677 11678 11679 11680 11681 11682 11683

Denominator Value The number:denominator-value attribute specifies an integer value that is used as denominator of a fraction. If this attribute is not present, the application may choose an arbitrary denominator value. 11684 11685 11686 11687 11688 11689 11690

1 May 2005 Page 485 of 706

14.7.2 Currency Style The <number:currency-style> element describes the style for currency values. This element can contain one <number:number> element and one <number:currencysymbol> element. It can also contain <number:text> elements , which display additional text, but it cannot contain two of these elements consecutively. In addition, this element can contain a <style:text-properties> element and a <style:map> element. 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721

11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734

See section 14.7.9 for information about the attributes that may be associated with the number style elements. The following elements may be contained in the <number:currency-style> element: •

Number, see section 14.7.1.

•

Currency symbol

1 May 2005 Page 486 of 706

Currency Symbol The <number:currency-symbol> element determines whether or not a currency symbol is displayed in a currency style. The content of this element is the text that is displayed as the currency symbol. If the element is empty or contains white space characters only, the default currency symbol for the currency style or the language and country of the currency style is displayed. This element is contained in the <number:currency-style> element. 11735 11736 11737 11738 11739 11740

The number:language and number:country attributes may be used to specify the language and country of the currency symbol. See section 14.7.11 for information on the other attributes that may be associated with the currency style elements.

Currency Language and Country Attributes If the currency symbol contained in a currency style belongs to a different language or country than the currency style itself, then the number:language and number:country attributes may be used to specify the language and country of the currency symbol. 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752

14.7.3 Percentage Style The <number:percentage-style> element describes the style for percentage values. This element can contain one <number:number> element, which describes the display format for the percentage. The element can be preceded or followed by <number:text> elements, which contain any additional text to display before or after the percentage. Some applications require that at least one <number:text> element exist and that its text must contain a “%” character. In addition, the <number:percentage-style> element can contain a <style:textproperties> element and a <style:map> element. 11753 11754 11755 11756 11757 11758 11759 11760

1 May 2005 Page 487 of 706

11761 11762 11763 11764 11765 11766 11767 11768 11769

</optional> <optional> <ref name="number-and-text"/> </optional> <zeroOrMore> <ref name="style-map"/> </zeroOrMore> </element> </define>

See section 14.7.9 for information on the attributes that may be associated with the percentage style element.

14.7.4 Date Style The <number:date-style> element describes the style for date values. This element can contain one instance of each of the following elements: <number:day>, <number:month>, <number:year>, <number:era>, <number:day-of-week>, <number:week-of-year>, <number:quarter>, <number:hours>, <number:minutes>, <number:seconds>, and <number:am-pm>. The <number:date-style> element can also contain <number:text> elements, which display additional text, but it cannot contain two of these elements consecutively. In addition, it can contain a <style:text-properties> element and a <style:map> element. 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794

11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806

1 May 2005 Page 488 of 706

11807 11808 11809 11810

See section 14.7.9 for information on the attributes that may be associated with the date style elements. The <number:date-style> element can contain the following elements: •

<number:day> – day of month

•

<number:month> – month

•

<number:year> – year

•

<number:era> – era

•

<number:day-of-week> – day of week

•

<number:week-of-year> – week of year

•

<number:quarter> – quarter

Day of Month The <number:day> element specifies the day of the month in a date. If this element is used, it should be contained in the <number:date-style> element. 11811 11812 11813 11814 11815 11816 11817

The number:style attribute may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Format Attribute The number:style attribute specifies whether the day of month element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For days, if the value of the number:format-source attribute is fixed:

11818 11819 11820 11821 11822 11823 11824 11825 11826

•

short means that the day of the month is displayed using one or two digits

•

long means that the day of the month is displayed using two digits

<define name="number-day-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional>

1 May 2005 Page 489 of 706

11827

</define>

Month The <number:month> element specifies the month in a date. If used, this element must be contained in the <number:date-style> element. 11828 11829 11830 11831 11832 11833 11834

The number:textual and number:style attributes may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Textual Representation Attribute The number:textual attribute determines whether the name or number of a month is displayed in the month element of a date. If the value of this attribute value is true, the name of the month is displayed. If the attribute value is false, the number of the month is displayed. 11835 11836 11837 11838 11839 11840 11841

Possessive Form Attribute The number:possessive-gorm attribute determines whether the month is displayed as is (e.g. as in "17 January 2004") or using the possessive form (e.g. as in "17th day of January"). If the value of this attribute value is true, the name of the month is displayed in possessive form. If the attribute value is false, the number of the month is displayed as is. 11842 11843 11844 11845 11846 11847 11848

Format Attribute The number:style attribute specifies whether the month element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For months, if the value of the number:format-source attribute is fixed:

11849

•

short means that the abbreviated name of the month is displayed or the month is displayed using one or two digits

•

long means that the full name of the month is displayed or the month is displayed using two digits

1 May 2005 Page 490 of 706

11850 11851 11852 11853 11854 11855 11856 11857 11858

<optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Year The <number:year> element specifies the year in the date. If used, this element must be contained in the <number:date-style> element. 11859 11860 11861 11862 11863 11864 11865

The number:style attribute may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Format Attribute The number:style attribute specifies whether the year element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For years, if the value of the number:format-source attribute is fixed:

11866 11867 11868 11869 11870 11871 11872 11873 11874 11875

•

short means that the year is displayed using two digits

•

long means that the year is displayed using four digits

<define name="number-year-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Era The <number:era> element specifies the era in which the year is counted. If used, this element must be contained in the <number:date-style> element. 11876 11877 11878 11879 11880 11881 11882

1 May 2005 Page 491 of 706

The number:style attribute may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Format Attribute The number:style attribute specifies whether the era element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For eras, if the value of the number:format-source attribute is fixed:

11883 11884 11885 11886 11887 11888 11889 11890 11891 11892

•

short means that the abbreviated era name is used

•

long means that the full era name is used

<define name="number-era-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Day Of Week The <number:day-of-week> element specifies the day of the week in a date. If used, this element must be contained in the <number:date-style> element. 11893 11894 11895 11896 11897 11898 11899

The number:style attribute may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Format Attribute The number:style attribute specifies whether the day of week element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For days of the week, the value of the number:format-source attribute is fixed:

11900 11901 11902 11903 11904 11905

•

short means that the abbreviated name of the day is displayed

•

long means that the full name of the day is displayed

<define name="number-day-of-week-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value>

1 May 2005 Page 492 of 706

11906 11907 11908 11909

</choice> </attribute> </optional> </define>

Week Of Year The <number:week-of-year> element specifies the week of the year in the date. If used, this element must be contained in the <number:date-style> element. 11910 11911 11912 11913 11914 11915

See section 14.7.11 for information on the the attributes that may be associated with the element.

Quarter The <number:quarter> element specifies the quarter of the year in the date. If used, this element must be contained in the <number:date-style> element. 11916 11917 11918 11919 11920 11921 11922

The number:style attribute may be used with this element. See section 14.7.11 for information on the other attributes that may be associated with the element.

Format Attribute The number:style attribute specifies whether the quarter element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the date style. For quarters, if the value of the number:format-source attribute is fixed:

11923 11924 11925 11926 11927 11928 11929 11930 11931 11932

•

short means that the abbreviated name of the quarter is displayed, for example, Q1

•

long means that the full name of the quarter is displayed, for example, Quarter 1

<define name="number-quarter-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 493 of 706

14.7.5 Time Style The <number:time-style> element describes the style for time values. This element can contain one instance of any of the following elements: <number:hours>, <number:minutes>, <number:seconds> and <number:am-pm>. The <number:time-style> element can also contain <number:text> elements , which display additional text, but it cannot contain two of these elements consecutively. In addition, it can contain a <style:text-properties> element and a <style:map> element. 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957

11958 11959 11960 11961 11962 11963 11964 11965 11966

See section 14.7.9 for information on the attributes that may be associated with the time style elements. The following elements can be contained in the <number:time-style> element: •

<number:hours> – hours

•

<number:minutes> – minutes

•

<number:seconds> – seconds

•

<number:am-pm> – am/pm

Time Value Truncation If a time or duration is too large to be displayed using the default value range for a time component, (0 to 23 for <number:hours>), the number:truncate-on-overflow attribute

1 May 2005 Page 494 of 706

may be used to specify whether the time or duration value should be truncated or whether the value range becomes extended. 11967 11968 11969 11970 11971 11972 11973

Hours The <number:hours> element specifies if hours are displayed as part of a date or time. 11974 11975 11976 11977 11978 11979

Format Attribute The number:style attribute specifies whether the hours element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the time style. For hours, if the value of the number:format-source attribute is fixed:

11980 11981 11982 11983 11984 11985 11986 11987 11988 11989

•

short means that the hours are displayed using at least one digit

•

long means that the hours are displayed using at least two digits

<define name="number-hours-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Minutes The <number:minutes> element specifies if minutes are displayed as part of a date or time. 11990 11991 11992 11993 11994 11995

Format Attribute The number:style attribute specifies whether the minutes element is displayed in short or long format.

1 May 2005 Page 495 of 706

The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the time style. For minutes, if the value of the number:format-source attribute is fixed:

11996 11997 11998 11999 12000 12001 12002 12003 12004 12005

•

short means that the minutes are displayed using at least one digit

•

long means that the minutes are displayed using at least two digits

<define name="number-minutes-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Seconds The <number:seconds> element specifies if seconds are displayed as part of a date or time. 12006 12007 12008 12009 12010 12011

Format Attribute The number:style attribute specifies whether the seconds element is displayed in short or long format. The value of this attribute can be short or long. The meaning of these values depends on the value of the number:format-source attribute that is attached to the time style. For seconds, if the value of the number:format-source attribute is fixed:

12012 12013 12014 12015 12016 12017 12018 12019 12020 12021

•

short means that the seconds are displayed using at least one digit

•

long means that the seconds are displayed using at least two digits

<define name="number-seconds-attlist" combine="interleave"> <optional> <attribute name="number:style" a:defaultValue="short"> <choice> <value>short</value> <value>long</value> </choice> </attribute> </optional> </define>

Decimal Places Attribute The number:decimal-places attribute determines the number of decimal places to use when displaying fractions. If this attribute is not present or if the value of the attribute is 0, fractions are not displayed. 12022

1 May 2005 Page 496 of 706

12023 12024 12025 12026 12027 12028

AM/PM The <number:am-pm> element specifies if AM/PM is included as part of the date or time. If a <number:am-pm> element is contained in a date or time style, hours are displayed using values from 1 to 12 only. 12029 12030 12031 12032 12033

14.7.6 Boolean Style The <number:boolean-style> element describes the style for Boolean values. This element can contain one <number:boolean> element, which can be preceded or followed by <number:text> elements. In addition, it can contain a <style:text-properties> element and a <style:map> element. 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053

Boolean The <number:boolean> element contains the Boolean value of a Boolean style. 12054 12055 12056 12057 12058

1 May 2005 Page 497 of 706

14.7.7 Text Style The <number:text-style> element describes the style for displaying text. This element can contain any number of <number:text-content> elements. It can also contain <number:text> elements , which display additional text, but it cannot contain two of these elements consecutively. In addition, it can contain a <style:text-properties> element and a <style:map> element. The <number:text-content> elements represent the variable text content to display, while the <number:text> elements contain any additional fixed text to display. 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078

See section 14.7.9 for information on the attributes that may be associated with the text style elements.

Fixed Text The <number:text> element contains any fixed text for a data style. This element is contained in all data styles element. 12079 12080 12081 12082 12083

Text Content The <number:text-content> element contains the variable text content of a text style. 12084 12085 12086 12087 12088

14.7.8 Common Data Style Elements The following common style elements may be contained within data style elements:

1 May 2005 Page 498 of 706

•

Text formatting properties

•

Style mappings

Formatting Properties The <style:text-properties> element specifies the text formatting properties to apply to any text displayed in the data style. See section 15.4 for information on the formatting properties element. The purpose of specifying text formatting properties within data styles is mainly to highlight certain values (for instance negative ones) by using style mappings. For this reason, data styles usually support only very few text formatting properties, for instance a text color. There may be also restrictions for the values of text formatting properties. For instance, the only value allowed for the text color might be read.

Style Mappings The <style:map> element specifies an alternative data style to map to if a certain condition exists. See section 14.1.1 for information on the <style:map> element. The following rules exist for using style maps element with data style elements: •

The style referenced by the style:apply-style attribute must be of the same type as the style containing the map.

•

The condition must be in the format value() op n, where op is a relational operator and n is a number. For Boolean styles the condition value must be true and false.

14.7.9 Common Data Style Attributes Many of the data style attributes are applicable to more than one data style element. The following data style attributes are common to many of the data style elements: •

Name

•

Language

•

Country

•

Title

•

Volatility

•

Automatic Order

•

Format Source

•

Transliteration

Name The style:name attribute specifies the name of the data style. It can be used with all data style elements. 12089 12090 12091

1 May 2005 Page 499 of 706

12092 12093

</attribute> </define>

Language The number:language attribute specifies the language of the style. The value of the attribute is a language code in conformance with [RFC3066]. The language code is used to retrieve information about any display properties that are language-dependent. The language attribute can be used with all data style elements. If a language code is not specified, either the system settings or the setting for the system's language are used, depending on the property whose value should be retrieved. 12101 12102 12103 12104 12105 12106 12107

Country The number:country attribute specifies the country of the style. The value of the attribute is a country code in conformance with [RFC3066]. The country code is used to retrieve information about any display properties that are country-dependent. The language attribute can be used with all data style elements. If a country is not specified, either the system settings or the setting for the system's country are used, depending on the property whose value should be retrieved. 12108 12109 12110 12111 12112 12113 12114

Title The number:title attribute specifies the title of the data style. It can be used with all data style elements.

1 May 2005 Page 500 of 706

12115 12116 12117 12118 12119

Volatility Sometimes when a document is opened, not all of the styles contained in the document are actually referenced. The application may retain or discard this unused styles. This may be controlled by the style:volatile attribute, that is supported by all data style elements. If the value of the attribute is true, the application keeps the style if possible. If the value is false, the application discards the unused styles. 12120 12121 12122 12123 12124 12125 12126

Automatic Order The number:automatic-order attribute can be used to automatically order data to match the default order for the language and country of the data style. This attribute is used with the following elements: •

<number:currency-style>, where number and the currency symbols are reordered

•

<number:date-style>, where the <number:date-style> child elements that are not <number:text> or <style:text-properties> elements are reordered

The attribute value can be true or false. 12127 12128 12129 12130 12131 12132 12133

Format Source The number:format-source attribute specifies the source of the short and long display formats. It is used with the following elements: •

<number:date-style>

•

<number:time-style>

The value of this attribute can be fixed or language. If the value is fixed, the meaning of the values number:style attribute's values short and long is as described in this specification.

1 May 2005 Page 501 of 706

If the value of the number:format-source attribute is language, the meaning of short and long depends on the language and country of the date style, or, if neither of these are specified, applications should use the system settings for short and long date and time formats. 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143

<define name="common-format-source-attlist"> <optional> <attribute name="number:format-source" a:defaultValue="fixed"> <choice> <value>fixed</value> <value>language</value> </choice> </attribute> </optional> </define>

14.7.10 Transliteration The various number:transliteration-* attributes specify the native number system of the style to display the number using, for example, CJK number characters. The notation is inspired by the W3C XSLT 2.0 draft, see §12.3 of [XSLT2]. However, to be able to fully distinguish between all possible native number systems additional attributes are needed in combination. For example, Korean uses 11 different systems where the digits are not always different but short and long and formal and informal forms exist. The transliteration attributes can be used with all data style elements.

Transliteration Format The number:transliteration-format attribute specifies which number characters to use. The value of the attribute is the digit "1" expressed as a native number. If no format is specified the default ASCII representation of Arabic digits is used, other transliteration attributes present in this case are ignored. 12144 12145 12146 12147 12148 12149 12150

Transliteration Language The number:transliteration-language attribute specifies which language the native number system belongs to. The value of the attribute is a language code in conformance with [RFC3066]. If no language/country (locale) combination is specified the locale of the data style is used. 12151 12152 12153 12154 12155 12156 12157

1 May 2005 Page 502 of 706

Transliteration Country The number:transliteration-country attribute specifies which country the native number system belongs to. The value of the attribute is a country code in conformance with [RFC3066]. If no language/country (locale) combination is specified the locale of the data style is used. 12158 12159 12160 12161 12162 12163 12164

Transliteration Style The number:transliteration-style attribute specifies which style the native number system belongs to. If more than one native number system matches the transliteration-format this attribute selects one. A short style should result in a one to one mapping of Arabic digits to native number digits if possible. 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175

<define name="common-data-style-attlist" combine="interleave"> <optional> <attribute name="number:transliteration-style" a:defaultValue="short"> <choice> <value>short</value> <value>medium</value> <value>long</value> </choice> </attribute> </optional> </define>

14.7.11 Common Data Style Child Element Attributes Many of the number style attributes are applicable to more than one number style element. The following attributes are common to many of the number style elements: •

Decimal places

•

Minimum integer digits

•

Grouping separator

•

Decimal replacement

•

Minimum exponent digits

•

Minimum numerator digits

•

Minimum denominator digits

•

Calendar system

Decimal Places The number:decimal-places attribute specifies the number of decimal places to display. This attribute is supported for the following elements: •

<number:number>

1 May 2005 Page 503 of 706

•

<number:scientific-number>

If this attribute is not specified, a default number of decimal places is used. 12176 12177 12178 12179 12180 12181 12182

Minimum Integer Digits The number:min-integer-digits attribute specifies the minimum number of integer digits to display in a number, a scientific number, or a fraction. This attribute is supported for the following elements: •

<number:number>

•

<number:scientific-number>

•

<number:fraction>

If this attribute is not specified, a default number of integer digits is used. 12183 12184 12185 12186 12187 12188 12189

Grouping Separator The number:grouping attribute specifies whether or not the integer digits of a number should be grouped using a separator character. This attribute is supported for the following elements: •

<number:number>

•

<number:scientific-number>

•

<number:fraction>

The grouping character that is used and the number of digits that are grouped together depends on the language and country of the style. 12190 12191 12192 12193 12194 12195 12196

Calendar System The number:calendar attribute specifies the calendar system used to extract parts of a date. This attribute is supported for the following elements: •

<number:day>

1 May 2005 Page 504 of 706

•

<number:month>

•

<number:year>

•

<number:era>

•

<number:day-of-week>

•

<number:week-of-year>

•

<number:quarter>

The attribute may have the values gregorian, gengou, ROC, hanja_yoil, hanja, hijri, jewish, buddhist or an arbitrary string value. If this attribute is not specified, the default calendar system is used. 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213

<define name="common-calendar-attlist" combine="interleave"> <optional> <attribute name="number:calendar"> <choice> <value>gregorian</value> <value>gengou</value> <value>ROC</value> <value>hanja_yoil</value> <value>hanja</value> <value>hijri</value> <value>jewish</value> <value>buddhist</value> <ref name="string"/> </choice> </attribute> </optional> </define>

14.8 Text Styles 14.8.1 Text Styles Text styles are <style:style> elements that have the family text. They can be used within all kind of applications to specify formatting properties for piece of text. They support the text properties as described in section 15.4. 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223

14.8.2 Paragraph Styles Paragraph styles are <style:style> elements that have the family paragraph. They can be used within all kind of applications to specify formatting properties for paragraphs and headings. They support the paragraph properties described in section 15.5 as well as the text properties described in section 15.4. 12224

1 May 2005 Page 505 of 706

12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236

<group> <attribute name="style:family"> <value>paragraph</value> </attribute> <optional> <ref name="style-paragraph-properties"/> </optional> <optional> <ref name="style-text-properties"/> </optional> </group> </define>

14.8.3 Section Styles Section styles are <style:style> elements that have the family section. They can be used within text documents to specify formatting properties for a text section. They support the section properties as described in section 15.7. 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>section</value> </attribute> <optional> <ref name="style-section-properties"/> </optional> </group> </define>

14.8.4 Ruby Style A ruby style specifies how the ruby text is displayed relative to the base text. It is represented by a <style:style> element those family is ruby. The ruby style is assigned to the ruby element using a text:style-name attribute. Ruby styles support the formatting properties described in section 15.6. 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256

14.9 Enhanced Text Styles 14.9.1 Line Numbering Configuration A document can contain none or one line numbering configuration element <text:linenumbering-configuration> within the <office:styles> element. If the element is not present, a default line numbering configuration is used. The default line numbering may vary on the office application software, but every document saved by an application that supports line numbering should contain a line numbering configuration element. 12257

1 May 2005 Page 506 of 706

12258 12259 12260 12261 12262 12263 12264

The attributes that may be associated with the <text:linenumbering-configuration> element are: •

Line numbering enable

•

Number format

•

Text style

•

Increment

•

Position

•

Offset

•

Count empty lines

•

Count line in text boxes

•

Restart numbering on every page

The following element may be included in the <text:linenumbering-seperator> element: •

Separator

Line Numbering Enable The text:number-lines attribute controls whether or not lines are numbered. 12265 12266 12267 12268 12269 12270 12271

Number Format See section 12.2 for detailed information on number format attributes. The attributes described in section 12.2 can also be associated with the <text:linenumbering-configuration> element. 12272 12273 12274 12275 12276

Text Style The text:style-name attribute specifies the text style for all line numbers. The value of this attribute is the name of the text style that is applied to all line numbers.

1 May 2005 Page 507 of 706

12277 12278 12279 12280 12281 12282 12283

Increment The text:increment attribute causes line numbers that are a multiple of the given increment to be numbered. For example, if the increment is 5, only lines number 5, 10, 15, and so on are numbered. 12284 12285 12286 12287 12288 12289 12290

Position The text:position attribute determines whether the line numbers are printed on the left , right, inner, or outer margins. 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302

<define name="text-linenumbering-configuration-attlist" combine="interleave"> <optional> <attribute name="text:number-position" a:defaultValue="left"> <choice> <value>left</value> <value>rigth</value> <value>inner</value> <value>outer</value> </choice> </attribute> </optional> </define>

Offset The text:offset attribute determines the distance between the line number and the margin. 12303 12304 12305 12306 12307 12308 12309

Count Empty Lines The text:count-empty-lines attribute determines whether or not empty lines are included in the line count. If the value of this attribute is true, empty lines are included in the line count. 12310 12311 12312 12313

1 May 2005 Page 508 of 706

12314 12315 12316

</attribute> </optional> </define>

Count Lines in Text Boxes The text:count-in-text-boxes attribute determines whether or not text in text boxes is included in the line count. If the value of this attribute is true, text within text boxes is included in the line count. 12317 12318 12319 12320 12321 12322 12323

Restart Numbering on Every Page The text:restart-on-page attribute determines whether or not the line count is reset to 1 at the start of every page. If the value of this attribute is true, the line count is reset to 1 at the beginning of every page, resulting in page -specific numbering of lines. The default value of this attribute is false, resulting in document-specific numbering of lines. 12324 12325 12326 12327 12328 12329 12330

Separator The <text:linenumbering-seperator> element contains the text that is displayed as a separator. A separator is text that is displayed instead of a line number for lines where no number is displayed. This element is contained in the line numbering configuration element. If the element is not present, no separator is displayed. The element's text:increment attribute causes the separator to appear on lines that are a multiple of the given increment. For example, if the increment is 2, only lines 2, 4, 6, and so on get a separator, provided that no number is displayed already. 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340

1 May 2005 Page 509 of 706

14.9.2 Notes Configuration Element A document in OpenDocument format contains at most one notes configuration element for every notes class used in the document. If there is no note configuration element, a default note configuration is used. 12341 12342 12343 12344 12345

The attributes that may be associated with the <text:notes-configuration> element are: •

Note class

•

Citation text style

•

Citation body text style

•

Default footnote paragraph style

•

Master page

•

Start value

•

Number format

•

Numbering scheme

•

Footnote position

The following element may be included in the <text:footnotes-configuration> element: •

Footnote continuation notice (forward and backward)

Note class The note class attribute determines which note elements this notes configuration applies to. 12346 12347 12348

Citation Text Style The text:citation-style attribute specifies the text style to use for the footnote citation within the footnote. 12349 12350 12351 12352 12353 12354 12355

Citation Body Text Style The text:citation-body-style-name attribute specifies the text style to use for the footnote citation in the text flow.

1 May 2005 Page 510 of 706

12356 12357 12358 12359 12360 12361 12362

Default Note Paragraph Style The default footnote paragraph style is only used for footnotes that are inserted into an existing document. It is not used for footnotes that already exist. 12363 12364 12365 12366 12367 12368 12369

Master Page To display the footnotes at the end of the document, the pages that contain the footnotes must be instances of the master page specified by the text:master-page-name attribute. 12370 12371 12372 12373 12374 12375 12376

Start Value The start:value attribute specifies the value at which the footnote numbering starts. 12377 12378 12379 12380 12381 12382 12383

Number Format See section 12.2 for information on the number format for footnotes. 12384 12385 12386 12387 12388 12389

1 May 2005 Page 511 of 706

Numbering Scheme The text:start-numbering-at attribute specifies if footnote numbers start with a new number at the beginning of the document or at the beginning of each chapter or page.

Note: [XSLT] does not have the capability to start with new footnote numbers on every page. 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400

<define name="text-notes-configuration-content" combine="interleave"> <optional> <attribute name="text:start-numbering-at"> <choice> <value>document</value> <value>chapter</value> <value>page</value> </choice> </attribute> </optional> </define>

Footnotes Position The text:footnotes-position attribute specifies one of the following positions for footnotes: •

text: At the page where the footnote citation is located, immediately below the page's text.

•

page: The bottom of the page where the footnote citation is located.

•

section: The end of the section

•

document: The end of the document.

Note: [XSL] does not have the capability to display footnotes at the end of the document. However, an [XSLT] stylesheet may generate some other flow objects to display such footnotes. 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412

<define name="text-notes-configuration-content" combine="interleave"> <optional> <attribute name="text:footnotes-position"> <choice> <value>text</value> <value>page</value> <value>section</value> <value>document</value> </choice> </attribute> </optional> </define>

Footnote Continuation The footnote continuation elements specify:

12413 12414 12415 12416

•

Text displayed at the end of a footnote that is continued on the next page

•

Text displayed before the continued text

1 May 2005 Page 512 of 706

12417 12418 12419 12420 12421 12422 12423 12424 12425 12426

</element> </optional> </define> <define name="text-notes-configuration-content" combine="interleave"> <optional> <element name="text:note-continuation-notice-backward"> <text/> </element> </optional> </define>

Example: Footnote configuration <text:notes-configuration text:notes-type="footnote" text:citation-style="Footnote symbol" text:default-style="Footnote"> <text:note-continuation-notice-forward>" .." </text:note-continuation-notice-forward> <text:note-continuation-notice-forward>".. " </text:note-continuation-notice-forward> </text:notes-configuration>

14.9.3 Bibliography Configuration The bibliography configuration element <text:bibliography-configuration> is contained in the document's style section. It contains information how bibliography entries are displayed inline, and how they are displayed in the bibliography index. 12427 12428 12429 12430 12431 12432 12433 12434

Prefix and Suffix The text:prefix and text:suffix attributes contain a string that is displayed before and after an bibliography entry's short name or number if it occurs in the document body. 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446

Numbered Entries The text:numbered-entry attribute specifies whether a number is displayed for bibliography entries instead of their short name.

1 May 2005 Page 513 of 706

Example: With prefix and suffix "[" and "]" a bibliography entry with short name "Abc123" would be displayed as "[Abc123]" in the document body if text:numbered-entry has the value false, and for instance as “[5]”, if it has the value true. 12447 12448 12449 12450 12451 12452 12453

Sorting The text:sort-by-position attribute specifies whether bibliography entries are displayed in the order of their positions in the document, or by an arbitrary selection of entry fields, e.g. author name or publication date. In the later case, the collating order for entries is determined by the triplet language/country/sort-algorithm as specified in the attributes fo:language, fo:country and text:sort-algorithm. See also section 7.8. 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475

Sort Keys The <text:sort-key> element specifies a single sort key if bibliography entries are not displayed in document order. It has an attribute text:key, that contains the type of index entry data that should be used for sorting (see also section 7.1.4) and an attribute text:sortascending that specifies whether sorting takes pace in ascending or descending order. 12476 12477 12478 12479 12480 12481

12482 12483 12484 12485 12486 12487

<define name="text-sort-key-attlist" combine="interleave"> <attribute name="text:key"> <choice> <value>address</value> <value>annote</value>

1 May 2005 Page 514 of 706

12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525

<value>author</value> <value>bibliography-type</value> <value>booktitle</value> <value>chapter</value> <value>custom1</value> <value>custom2</value> <value>custom3</value> <value>custom4</value> <value>custom5</value> <value>edition</value> <value>editor</value> <value>howpublished</value> <value>identifier</value> <value>institution</value> <value>isbn</value> <value>issn</value> <value>journal</value> <value>month</value> <value>note</value> <value>number</value> <value>organizations</value> <value>pages</value> <value>publisher</value> <value>report-type</value> <value>school</value> <value>series</value> <value>title</value> <value>url</value> <value>volume</value> <value>year</value> </choice> </attribute> <optional> <attribute name="text:sort-ascending" a:defaultValue="true"> <ref name="boolean"/> </attribute> </optional> </define>

14.10 List Style List styles specify the formatting properties for lists. A <text:list-style> element contains a set of style elements for each list level, which are called list level styles. There are three different list level style elements, depending on whether this particular list level is to have a list label containing the list numbering, a bullet, or an image. If a list style is applied to a list but does not contain a list level specification for the suitable level, the list level style of the next lower level is used. If no suitable list level style does exist, a default style is used. 12526 12527 12528 12529 12530 12531 12532 12533

Note: List styles contain different properties than paragraph or text styles. This is why they are represented by a different element. The attributes that may be associated with the <text:list-style> element are:

1 May 2005 Page 515 of 706

•

Name

•

Display name

•

Consecutive numbering

Name The style:name attribute specifies the name of the list style. 12534 12535 12536 12537 12538

Display Name The style:display-name attribute specifies the name of the list style as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 12539 12540 12541 12542 12543 12544 12545

Consecutive Numbering The text:consecutive-numbering attribute specifies whether or not the list style uses consecutive numbering for all list levels or whether each list level restarts the numbering. 12546 12547 12548 12549 12550 12551 12552

14.10.1 Common List-Level Style Attributes The following attributes can be used on all list-level styles:

Level The text:level attribute specifies the level of the number list style. 12553 12554 12555 12556 12557

1 May 2005 Page 516 of 706

14.10.2 Number Level Style A number level style specifies a list style where the list items are preceded by numbers. 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569

The attributes that may be associated with the <text:list-level-style-number> element are: •

Level (see section 14.10.1)

•

Text style

•

Number format

•

Display levels

•

Start value

Additional formatting properties may be contained in the <style:list-level-properties> and <style:text-properties> elements. See sections 15.12 and 15.4 for details.

Text Style The text:style-name attribute specifies the name of the character style to use to format the number of the list. 12570 12571 12572 12573 12574 12575 12576

Number Format See section 12.2 for detailed information on number format attributes. The attributes described in section 12.2 can also be associated with the <text:list-level-style-number> element. The style:num-format attribute can be empty. In this case, no number is displayed. 12577 12578 12579 12580

Display Levels The text:display-levels attribute specifies the number of levels whose numbers are displayed at the current level.

1 May 2005 Page 517 of 706

12581 12582 12583 12584 12585 12586 12587

Example: Given a third-level chapter number 1.2.3. Values of text:display-number from 1 to three would achieve the following results: text:display-number display 1

1.2

1.2.3

Start Value The text:start-value attribute specifies the first number of an list item of the current level. 12588 12589 12590 12591 12592 12593 12594

14.10.3 Bullet Level Style A bullet level style element specifies a list style where the list items are preceded by bullets. 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606

The attributes that may be associated with the <text:list-level-style-bullet> element are: •

Level (see section 14.10.1)

•

Text style

•

Bullet character

•

Prefix and suffix

•

Bullet relative size

1 May 2005 Page 518 of 706

Additional formatting properties may be contained in the <style:list-level-properties> and <style:text-properties> elements. See sections 15.12 and 15.4 for details.

Text Style The text:style-name attribute specifies the name of the character style to use to format the list bullet. 12607 12608 12609 12610 12611 12612 12613

Bullet Character The bullet character attribute specifies the UNICODE character to use as the bullet in a bullet level style. Typical bullet characters are: •

U+2022

● U+25CF ➔ U+2794 ➢ U+27A2 ✗

U+2717

✔ U+2714

These characters might not be available within some fonts. 12614 12615 12616 12617 12618

Prefix and Suffix The attributes style:num-format-prefix and style:num-format-suffix specified in section 12.2 can be used to add characters before or behind the bullet character. 12619 12620 12621

Bullet Relative Size The text:bullet-relative-size attribute specifies a percentage value for the bullet size relative to the font size of the paragraphs in the bullet list. For example, if the value of the text:bullet-relative-size attribute is 75, the bullet used in the list is 75% of the font size for the paragraph. 12622

1 May 2005 Page 519 of 706

12623 12624 12625 12626 12627 12628

14.10.4 Image Level Style An image level style element specifies a list style where the list items are preceded by images. This element can be an [XLink] and can only be contained in list style elements. 12629 12630 12631 12632 12633 12634 12635 12636 12637

The following elements and attributes may be associated with the <text:list-level-styleimage> element are: •

Level (see section 14.10.1)

•

Image location

Additional formatting properties may be contained in the <style:list-level-properties> element. See section 15.12 for details.

Image Location The image data can be stored in one of the following ways (see also section 9.3.2):

12638 12639 12640 12641 12642 12643

•

The image data is located in an external file. Use the xlink:href attribute described below to specify the location of the file.

•

The image data is contained in the <text:list-level-style-image> element. The <text:list-level-style-image> element must contain an <office:binary-data> element that contains the image data in BASE64 encoding. In this situation, the xlink:href attribute is not required.

14.10.5 List Level Style Example Example: List level style <text:list-style style:name="List 1"> <text:list-level-style-number text:level="1" fo:num-format="1"/> <text:list-level-style-bullet text:level="2" text:bullet-char="-" text:style-name="Bullet Char"/>

1 May 2005 Page 520 of 706

<text:list-level-style-image text:level="3" xlink:href="bullet.gif"> <style:list-level-properties fo:width=".27cm" fo:height=".27cm" style:vertical-pos="middle" style:vertical-rel="line"/> </text:list-level-style-image> </text:list-style>

The following is the output from the above example: 1. This is the first list item. This is a continuation of the first list item. 2. This is the second list item. It contains an unordered sub list. -

This is a sub list item.

This is a sub list item. This is a sub sub list item. This is a sub sub list item.

3. This is the third list item.

14.11 Outline Style The outline style is a list style that is applied to all headings within a text document where the the heading's paragraph style does not define a list style to use itself. The way in which the OpenDocument format represents outline numbering styles is very similar to the way it represents list styles. The <text:outline-style> element contains elements that specify the style of each outline level. It can be contained within the <office:styles> element only. 12644 12645 12646 12647 12648 12649 12650

14.11.1 Outline Level Style The <text:outline-level-style> element specifies the style for each outline level. This element is contained in <text:outline-style> elements only. 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661

The attributes that may be associated with the <text:outline-level-style> element are:

1 May 2005 Page 521 of 706

•

Level

•

Text style

•

Number format

•

Display levels

•

Start value

Additional formatting properties may be contained in the <style:list-level-properties> and <style:text-properties> element. See sections 15.12 and 15.4 for details.

Level The text:level attribute specifies the level of the outline style. 12662 12663 12664 12665 12666

Text Style The text:style-name attribute specifies the name of the character style to use to format the number of the heading. 12667 12668 12669 12670 12671 12672 12673

Number Format See section 14.10.2 for information on the number format attributes. 12674 12675 12676 12677

Display Levels The text:display-levels attribute specifies the number of levels whose numbers are displayed at the current level. See also section 14.10.2. 12678 12679 12680 12681 12682 12683 12684

1 May 2005 Page 522 of 706

Start Value The text:start-value attribute specifies the first number of an heading of the current level. 12685 12686 12687 12688 12689 12690 12691

14.12 Table Styles 14.12.1 Table Styles Table styles are <style:style> elements that have the family table. They can be used within all kind of applications to specify formatting properties for tables. They support the table properties as described in section 15.8. 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>table</value> </attribute> <optional> <ref name="style-table-properties"/> </optional> </group> </define>

14.12.2 Table Column Styles Table column styles are <style:style> elements that have the family table-column. They can be used within all kind of applications to specify formatting properties for table columns. They support the table column properties as described in section 15.9. 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>table-column</value> </attribute> <optional> <ref name="style-table-column-properties"/> </optional> </group> </define>

14.12.3 Table Row Styles Table row styles are <style:style> elements that have the family table-row. They can be used within all kind of applications to specify formatting properties for table rows. They support the table properties as described in section 15.10. 12712 12713 12714 12715 12716 12717

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>table-row</value> </attribute> <optional>

1 May 2005 Page 523 of 706

12718 12719 12720 12721

14.12.4 Table Cell Styles Table styles are <style:style> elements that have the family table-cell. They can be used within all kind of applications to specify formatting properties for table cells. They support the table properties as described in section 15.11 as well as the paragraph and text properties as described in sections 15.5 and 15.4. 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>table-cell</value> </attribute> <optional> <ref name="style-table-cell-properties"/> </optional> <optional> <ref name="style-paragraph-properties"/> </optional> <optional> <ref name="style-text-properties"/> </optional> </group> </define>

14.13 Graphic Styles 14.13.1 Graphic and Presentation Styles Graphic and presentation styles are <style:style> elements that have either the family graphic or presentation. Graphic styles with family graphic may occur within all kinds of applications, graphic styles with family presentation may occur only within presentation documents. Both kind of styles support the graphic properties described in section 15.17. They may also contain paragraph and text properties as described in sections 15.5 and . 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <choice> <value>graphic</value> <value>presentation</value> </choice> </attribute> <optional> <ref name="style-graphic-properties"/> </optional> <optional> <ref name="style-paragraph-properties"/> </optional> <optional> <ref name="style-text-properties"/> </optional> </group> </define>

12757 12758 12759

1 May 2005 Page 524 of 706

12760 12761 12762

12763 12764 12765 12766

12767 12768 12769 12770 12771 12772

12773 12774 12775 12776

14.13.2 Drawing Page Style A drawing page style is a <style:style> element with family drawing-page. Within graphical applications, drawing page styles can be used to change the background of draw page. If a background is set with the help of a drawing page style, then it overrides the background of the master page that is assigned to the draw page, but not the shapes that are on the master page. Within presentation applications, the draw page style additionally may contain presentation properties, for example, the duration for which a page is displayed or fade effects. The properties that can be used in a draw page style to change the background are the ones described in section 15.14. The presentation properties that can be used in a draw page style are described in section 15.36. 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>drawing-page</value> </attribute> <optional> <ref name="style-drawing-page-properties"/> </optional> </group> </define>

12787 12788 12789 12790 12791 12792

12793 12794 12795 12796

12797 12798 12799 12800 12801 12802

1 May 2005 Page 525 of 706

14.14 Enhanced Graphic Style Elements The elements described in this section are enhanced graphic style. They cannot be used as automatic styles, that is, they have to be located in the <office:styles> section of a document. Like all other style elements, they are referenced to by a unique name. The following styles for filling graphic objects are available: •

Gradient

•

SVG Gradient

•

Hatch

•

Image

•

Opacity Gradient

•

Marker

•

Dash

•

Presentation Page Layout

14.14.1 Gradient The element <draw:gradient> defines a gradient for filling a drawing object. Gradients are not available as automatic styles. 12803 12804 12805 12806 12807 12808 12809

The attributes that may be associated with the gradient element are: •

Name

•

Display name

•

Gradient style

•

Gradient center

•

Colors

•

Intensity

•

Angle

•

Border

Name The attribute draw:name uniquely identifies a gradient inside an <office:styles> element. 12810 12811 12812 12813

1 May 2005 Page 526 of 706

12814 12815 12816

</attribute> </optional> </define>

Display Name The draw:display-name attribute specifies the name of the gradient as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 12817 12818 12819 12820 12821 12822 12823

Gradient Style The attribute draw:style specifies the style of the gradient. The gradient styles that an office application should support are linear, axial, radial, ellipsoid, square, and rectangular. 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838

<define name="common-draw-gradient-attlist" combine="interleave"> <attribute name="draw:style"> <ref name="gradient-style"/> </attribute> </define> <define name="gradient-style"> <choice> <value>linear</value> <value>axial</value> <value>radial</value> <value>ellipsoid</value> <value>square</value> <value>rectangular</value> </choice> </define>

Gradient Center If the gradient style is radial, ellipsoid, square, or rectangular, the gradient center attributes draw:cx and draw:cy specifies the center of the geometry that is used for the gradient. The values of these attributes are always percentage values. 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850

1 May 2005 Page 527 of 706

Colors The gradient interpolates between a start color and an end color, which are specified using the attributes draw:start-color and draw:end-color. 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862

Intensity The attributes draw:start-intensity and draw:end-intensity specify the intensity of the gradient's start and end color as percentage values. These attributes are optional. If the attributes are not specified, the colors are used as they are, that is at 100% intensity. 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874

Angle The draw:angle attribute specifies an angle that rotates the axis at which the gradient values are interpolated. This attribute is ignored for radial style gradients. 12875 12876 12877 12878 12879 12880 12881

Border Depending on the style of the gradient, the draw:border attribute specifies a percentage value which is used to scale a border which is filled by the start or end color only. For example, a border of 10% means that the first 10% of the gradient is colored completely in the start color and the remaining 90% are an interpolation between start and end color. 12882 12883 12884

1 May 2005 Page 528 of 706

12885 12886 12887 12888

14.14.2 SVG Gradients In addition to the gradients specified in section 14.14.1, gradient may be defined by the SVG gradient elements <linarGradient> and <radialGradient> as specified in §13.2 of [SVG]. The following rules apply to SVG gradients if they are used in documents in OpenDocument format:

12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923

•

The gradients must get a name. It is specified by the draw:name attribute.

•

For <linarGradient>, only the attributes gradientTransform, x1, y1, x2, y2 and spreadMethod will be evaluated.

•

For <radialGradient>, only the attributes gradientTransform, cx, cy, r, fx, fy and spreadMethod will be evaluated.

•

The gradient will be calculated like having a gradientUnits of objectBoundingBox, regardless what the actual value of the attribute is.

•

The only child element that is evaluated is <stop>.

•

For <stop>, only the attributes offset, stop-color and stop-opacity will be evaluated.

1 May 2005 Page 529 of 706

12924 12925 12926 12927 12928

12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977

12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989

1 May 2005 Page 530 of 706

12990 12991 12992 12993 12994 12995 12996 12997 12998

</attribute> </optional> <optional> <attribute name="svg:stop-opacity"> <ref name="double"/> </attribute> </optional> </element> </define>

12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021

<define name="common-svg-gradient-attlist" combine="interleave"> <optional> <attribute name="svg:gradientUnits" a:defaultValue="objectBoundingBox"> <value>objectBoundingBox</value> </attribute> </optional> <optional> <attribute name="svg:gradientTransform"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="svg:spreadMethod" a:defaultValue="pad"> <choice> <value>pad</value> <value>reflect</value> <value>repeat</value> </choice> </attribute> </optional> </define>

Name The attribute draw:name uniquely identifies a gradient inside an <office:styles> element. Like <draw:gradient> elements, SVG gradients are referenced by this name using the draw:fill-gradient-name attribute within a graphic style. SVG gradients cannot be referenced by a draw:opacity-name attribute. The result of referencing a SVG gradient with draw:fillgradient-name attribute and an opacity gradient with a draw:opacity-name attribute at the same time is unspecified. 13022 13023 13024 13025 13026

1 May 2005 Page 531 of 706

14.14.3 Hatch The <draw:hatch> element defines a hatch for filling graphic objects. A hatch is a simple pattern of straight lines that is repeated in the fill area. Hatches are not available as automatic styles. 13034 13035 13036 13037 13038 13039

The attributes that may be associated with the hatch element are: •

Name

•

Display name

•

Style

•

Color

•

Distance

•

Angle

•

Background

Name The draw:name attribute uniquely identifies a hatch inside an <office:styles> element. 13040 13041 13042 13043 13044

Display Name The draw:display-name attribute specifies the name of the hatch style as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 13045 13046 13047 13048 13049 13050 13051

Style The draw:style attribute specifies the style of the hatch. The hatch can have one of three styles: single, double, or triple. 13052 13053

1 May 2005 Page 532 of 706

13054 13055 13056 13057 13058 13059 13060

<choice> <value>single</value> <value>double</value> <value>triple</value> </choice> </attribute> </define>

Color The draw:color attribute specifies the color of the hatch lines. 13061 13062 13063 13064 13065 13066 13067

Distance The draw:distance attribute specifies the distance between two hatch lines. 13068 13069 13070 13071 13072 13073 13074

Angle The draw:rotation attribute specified the rotation angle of the hatch lines. 13075 13076 13077 13078 13079 13080 13081

14.14.4 Fill Image The <draw:fill-image> element specifies a link to a bitmap resource, for example, a .PNG file. This element follows the XLink specification. Fill image are not available as automatic styles. 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093

<define name="draw-fill-image"> <element name="draw:fill-image"> <ref name="draw-fill-image-attlist"/> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> <optional> <attribute name="xlink:type" a:defaultValue="simple"> <choice> <value>simple</value> </choice> </attribute>

1 May 2005 Page 533 of 706

13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111

</optional> <optional> <attribute name="xlink:show" a:defaultValue="embed"> <choice> <value>embed</value> </choice> </attribute> </optional> <optional> <attribute name="xlink:actuate" a:defaultValue="onLoad"> <choice> <value>onLoad</value> </choice> </attribute> </optional> <empty/> </element> </define>

The attributes that may be associated with the fill image element are: •

Name

•

Display name

•

Size

Name The draw:name attribute uniquely identifies a fill image inside an <office:styles> element. 13112 13113 13114 13115 13116

Display Name The draw:display-name attribute specifies the name of the fill image as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 13117 13118 13119 13120 13121 13122 13123

Size The optional attributes svg:width and svg:height specify the size of the linked image. These values are optional and are overridden by the physical size of the linked image resource. They can be used to get the size of an image before it is loaded. 13124 13125 13126 13127 13128

1 May 2005 Page 534 of 706

13129 13130 13131 13132 13133 13134 13135

</optional> <optional> <attribute name="svg:height"> <ref name="length"/> </attribute> </optional> </define>

14.14.5 Opacity Gradient The <draw:opacity> element specifies an opacity gradient for a graphic object. An opacity gradient works like a gradient, except that the opacity is interpolated instead of the color. Opacity gradients are not available as automatic styles. 13136 13137 13138 13139 13140 13141 13142

The attributes that may be associated with the <draw:opacity> element are: •

Name, Display name, Style, Opacity center, Angle, Border – see section 14.14.1.

•

Opacity

Opacity The opacity interpolates between a start and an end value. The values of the attributes draw:start and draw:end are percentages where 0% is fully transparent and 100% is fully opaque. 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154

14.14.6 Marker The element <draw:marker> represents a marker, which is used to draw polygons at the start and end points of strokes. Markers are not available as automatic styles. 13155 13156 13157 13158 13159 13160 13161 13162

1 May 2005 Page 535 of 706

See sections 9.2.4 and 9.2.15 for information on the path data and viewbox attributes that may be associated with the <draw:marker> element.

Name The draw:name attribute uniquely identifies a fill image inside an <office:styles> element. 13163 13164 13165 13166 13167

Display Name The draw:display-name attribute specifies the name of the marker as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 13168 13169 13170 13171 13172 13173 13174

14.14.7 Stroke Dash The dash element <draw:stroke-dash> represents a dash style that can be used to render strokes of shapes. Stroke dashes are not available as automatic styles. 13175 13176 13177 13178 13179 13180

The attributes that may be associated with the <draw:stroke-dash> element are: •

Name

•

Display name

•

Style

•

Dots

•

Distance

Name The attribute draw:name uniquely identifies a dash inside an <office:styles> element. 13181 13182 13183 13184 13185

1 May 2005 Page 536 of 706

Display Name The draw:display-name attribute specifies the name of the dash as it should appear in the user interface. In contrast to the style name itself, this name may contain arbitrary characters. If this attribute is not present, the display name equals the style name. 13186 13187 13188 13189 13190 13191 13192

Style The attribute draw:style specifies whether the points of a dash are round or rectangular. 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202

<define name="draw-stroke-dash-attlist" combine="interleave"> <optional> <attribute name="draw:style"> <choice> <value>rect</value> <value>round</value> </choice> </attribute> </optional> </define>

Dots The attribute pairs draw:dots1, draw:dots1-length and draw:dots2, draw:dots2length each define a repeating sequence of dots that are used to render a dash. Both sequences are used alternating. The draw:dots1 and draw:dots2 attributes specify the number of dots to draw for both sequences, and the draw:dots1-length and draw:dots2length attributes specify the length of each dot. 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224

1 May 2005 Page 537 of 706

Distance The draw:distance attribute specifies the distance between the dots of a dash. 13225 13226 13227 13228 13229 13230 13231

14.15 Presentation Page Layouts The element <style:presentation-page-layout> is a container for placeholders, which define a set of empty presentation objects, for example, a title or outline. These placeholders are used as templates for creating new presentation objects and to mark the size and position of an object if the presentation page layout of a drawing page is changed. The <style:presentation-page-layout> element has an attribute style:name. It defines the name of the page layout. If a drawing page has been created using a presentation page layout, the name of the layout is contained in the draw page's presentation:presentation-page-layout-name attribute. The optional style:display-name attribute specifies the name of the presentation page layout as it should appear in the user interface. 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246

14.15.1 Presentation Placeholder The element <presentation:placeholder> specifies a placeholder for presentation objects, for example, a title or outline. The element has the following attributes:

13247 13248 13249 13250 13251 13252

•

object: Specifies the kind of object the element is a placeholder for. The value equals the one of the presentation:class attribute for presentation shapes. See section 9.6.

•

svg:x, svg:y, svg:width, svg:height: position and size attributes as specified in section 9.2.15, with the exception that percentage values are allowed for placeholders.

1 May 2005 Page 538 of 706

13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278

14.16 Chart Styles Chart styles are <style:style> elements that have the family chart. They can be used within chart documents to specify formatting properties for the chart, but also for certain objects within a chart. They support the chart properties described in section 15.29, but also graphic, paragraph and text properties as described in sections 15.17, 15.5 and 15.4. 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297

<define name="style-style-content" combine="choice"> <group> <attribute name="style:family"> <value>chart</value> </attribute> <optional> <ref name="style-chart-properties"/> </optional> <optional> <ref name="style-graphic-properties"/> </optional> <optional> <ref name="style-paragraph-properties"/> </optional> <optional> <ref name="style-text-properties"/> </optional> </group> </define>

1 May 2005 Page 539 of 706

15 Formatting Properties A document can contain several style elements. To acquire a common set of formatting properties, all formatting properties are contained in formatting property elements which are included as a child elements of any style element. This container elements offers two important advantages, as follows: •

Formatting properties can be addressed by [CSS2] or [XSLT] stylesheets regardless of the style type.

•

Styles contain additional information that is not a formatting property, for example, the style name and parent style. It is good practice to separate this type of information.

The following formatting property elements do exist: •

•

•

•

•

•

•

•

•

•

•

•

15.1 Simple and Complex Formatting Properties 15.1.1 Simple Formatting Properties Most formatting properties are simple and can be represented as attributes of the formatting property elements. Where possible, [XSL] attributes or attributes from other specifications are used to represent formatting properties. In this specification, the namespace prefix fo is used for XSL properties, that is properties that are part of the XSL namespace. In office application, there are very often formatting properties that cannot be specified independent of other formatting properties. If this is the case, and if some of the required properties are missing, the application assumes reasonable default values.

Example: Simple style properties This example shows a formatting property container that specifies an upper paragraph margin of 1 cm as well as a lower margin of 0.5 cm:

1 May 2005 Page 540 of 706

15.1.2 Complex Formatting Properties If a formatting property is too complex to be represented by XML attributes, it is represented by an XML element. Each such property is represented by an element type of its own.

Example: Complex formatting properties This is an example of a formatting property container that specifies upper and lower margins as well as tab stop position at 2 and 4 cm. <style:paragraph-properties> <style:tab-stops> <style:tab-stop style:position="2cm"/> <style:tab-stop style:position="4cm"/> </style:tab-stops> </style:paragraph-properties>

15.1.3 Processing Rules for Formatting Properties In the OpenDocument schema the various <style:*-properties> elements may contain pre-defined formatting attributes and elements as well as custom formatting attributes and elements. The pre-defined attributes and elements have defined semantics, and are described within this chapter. Custom formatting attributes and elements are arbitrary attributes and elements inside <style:*-properties> elements. Their semantics are not defined in this specification, Conforming applications in general SHOULD preserve both, pre-defined and custom formatting attributes and elements when editing the document. 13298 13299 13300

15.2 Page Layout Formatting Properties The properties described in this section can be contained within style page layouts (see section 14.3) They are contained in a <style:page-layout-properties> element. •

Page size

•

Page number format

•

Paper tray

•

Print orientation

•

Margins

•

Border

•

Border line width

•

Padding

•

Shadow

•

Background

1 May 2005 Page 541 of 706

•

Columns

•

Print page order

•

First page number

•

Scale

•

Table centering

•

Maximum footnote height

•

Footnote separator

13301 13302 13303 13304 13305

13306 13307 13308 13309

13310 13311 13312 13313 13314

15.2.1 Page Size The fo:page-width and fo:page-height attributes specify the physical size of the page. The fo:page-width attribute must correspond to the orientation of the page. For example, if a page is printed in portrait, the fo:page-width attribute specifies the width of the shorter page side. If the page is printed in landscape, the fo:page-width attribute specifies the width of the longer page side. 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326

15.2.2 Page Number Format The style:num-format, style:num-prefix and style:num-suffix attributes specify a default number format for page styles, which is used to display page numbers within headers and footers. See section 12.2 for detailed information on number format attributes.

1 May 2005 Page 542 of 706

The style:num-format attribute can be empty. In this case, no page number will be displayed by default. 13327 13328 13329 13330 13331 13332

15.2.3 Paper Tray The style:paper-tray-name attribute specifies the paper tray to use when printing the document. The names assigned to the printer trays depend on the printer. If the value of this attribute is default, the default tray specified in the printer configuration settings is used. 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342

<define name="style-page-layout-properties-attlist" combine="interleave"> <optional> <attribute name="style:paper-tray-name"> <choice> <value>default</value> <ref name="string"/> </choice> </attribute> </optional> </define>

15.2.4 Print Orientation The style:print-orientation attribute specifies the orientation of the printed page. The value of this attribute can be portrait or landscape. 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352

<define name="style-page-layout-properties-attlist" combine="interleave"> <optional> <attribute name="style:print-orientation"> <choice> <value>portrait</value> <value>landscape</value> </choice> </attribute> </optional> </define>

15.2.5 Margins The margins attributes fo:margin, fo:margin-top, fo:margin-bottom, fo:marginleft and fo:margin-right specify the size of the page margins. See sections 15.5.17, 15.5.20 and 15.5.21 for detailed information on these attributes. Percentage values are not supported. 13353 13354 13355 13356 13357

1 May 2005 Page 543 of 706

15.2.6 Border The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-left and fo:border-right specify the border properties of the page. See section 15.5.25 for detailed information on these attributes. 13358 13359 13360

15.2.7 Border Line Width If a page contains borders, the border line width attributes style:border-line-width, style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of the border lines of the page. See section 15.5.26 for detailed information on these attributes. 13361 13362 13363

15.2.8 Padding The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the page. See section 15.5.27 for detailed information on these attributes. 13364 13365 13366

15.2.9 Shadow The shadow attribute style:shadow specifies the shadow of the page. See section 15.5.28 for detailed information on this attribute. 13367 13368 13369

15.2.10 Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the page. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 13370 13371 13372 13373 13374 13375

1 May 2005 Page 544 of 706

15.2.11 Columns The <style:columns> element specifies if the page contains columns. See section 15.7.3 for detailed information on this element. 13376 13377 13378

15.2.12 Register-truth The style:register-truth-ref-style-name attribute references a paragraph style. The line distance specified of the paragraph style is used as the reference line distance for all paragraphs that have the register-truth feature enabled. 13379 13380 13381 13382 13383 13384 13385

15.2.13 Print The style:print attribute specifies which components in a spreadsheet document to print. The value of this attribute is a list of the following values separated by blanks:

13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400

•

headers

•

grid

•

annotations

•

objects (including graphics)

•

charts

•

drawings

•

formulas

•

zero-values

<define name="style-page-layout-properties-attlist" combine="interleave"> <optional> <attribute name="style:print"> <list> <zeroOrMore> <choice> <value>headers</value> <value>grid</value> <value>annotations</value> <value>objects</value> <value>charts</value> <value>drawings</value> <value>formulas</value> <value>zero-values</value> </choice>

1 May 2005 Page 545 of 706

13401 13402 13403 13404 13405

</zeroOrMore> </list> </attribute> </optional> </define>

15.2.14 Print Page Order The style:print-page-order attribute specifies the order in which data in a spreadsheet is numbered and printed when the data does not fit on one printed page. The value of this attribute can be ttb or ltr. Use ttb to print the data vertically from the left column to the bottom row of the sheet. Use ltr to print the data horizontally from the top row to the right column of the sheet. 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415

15.2.15 First Page Number The style:first-page-number specifies the number of the first page of a text or graphical document, or for the first page of a table within a spreadsheet document. The value of this attribute can be an integer or continue. If the value is continue, the page number is the last page number incremented by 1. The default first page number is 1. 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425

<define name="style-page-layout-properties-attlist" combine="interleave"> <optional> <attribute name="style:first-page-number"> <choice> <ref name="positiveInteger"/> <value>continue</value> </choice> </attribute> </optional> </define>

15.2.16 Scale The style:scale-to and style:scale-to-pages attributes specify how the application should scale spreadsheet documents for printing. The style:scale-to attribute specifies that the document is scaled to a percentage value, where 100% equals no scaling. When using this attribute, all pages are enlarged or reduced in size while printing. The style:scale-to-pages attribute specifies the number of pages on which the the document should be printed. The document is then scaled to fit the defined number of pages.

1 May 2005 Page 546 of 706

If none of these attributes are present, the document is not scaled. 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437

15.2.17 Table Centering The style:table-centering attribute specifies how the application should center tables on the page. This attribute only applies to spreadsheet documents. The value of this attribute can be horizontal, vertical, both, or none. If this attribute is not present, the table is not centered. 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449

<define name="style-page-layout-properties-attlist" combine="interleave"> <optional> <attribute name="style:table-centering"> <choice> <value>horizontal</value> <value>vertical</value> <value>both</value> <value>none</value> </choice> </attribute> </optional> </define>

15.2.18 Maximum Footnote Height The style:footnote-max-height attribute specifies the maximum amount of space on the page that a footnote can occupy. The value of the attribute is a length, which determines the maximum height of the footnote area. If the value of this attribute is set to 0in, there is no limit to the amount of space that the footnote can occupy. 13450 13451 13452 13453 13454 13455 13456

15.2.19 Writing Mode The style:writing mode attribute specifies the writing mode that should is used by all paragraphs that appear on the page. See section 15.5.36 for details. The value page is not allowed within page layouts. 13457

1 May 2005 Page 547 of 706

13458 13459

15.2.20 Footnote Separator The <style:footnote-sep> element describes the line that separates the footnote area from the body text area on a page. The <style:footnote-sep> element supports the following attributes: •

style:width – specifies the width or thickness of the line.

•

style:rel-width – specifies the length of the line as a percentage of the body text area.

•

style:color – specifies the color of the line.

•

style:adjustment – specifies how the line is aligned on the page, that is left, right, or center.

•

style:distance-before-sep – specifies the space between the body text area and the footnote line.

•

style:distance-after-sep – specifies the space between the footnote line and the footnote text.

•

style:line-style – specifies the style of the line.

13460 13461 13462

13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495

1 May 2005 Page 548 of 706

13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512

<value>left</value> <value>center</value> <value>right</value> </choice> </attribute> </optional> <optional> <attribute name="style:distance-before-sep"> <ref name="length"/> </attribute> </optional> <optional> <attribute name="style:distance-after-sep"> <ref name="length"/> </attribute> </optional> </define>

15.2.21 Layout Grid The style:layout-grid-mode property enables Asian layout grids. It has the following values:

13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523

•

none: Disables the layout grid.

•

lines: Enables a line layout, this is, the page is divided in a fixed number of lines. The exact number of lines depends on the other grid layout properties described below. There is no space between the layout grid lines. The layout grid itself is centered on the page.

•

both: Like lines, except that the lines are divided into square cells. The number of cells per line depends on the line height, where the line height is the sum of the base height and the ruby height as specified below. Within a layout cell, nor more than one Asian UNICODE character is displayed. Asian characters that do not fit into a single cell are displayed centered into as many cells as required. Non Asian text is centered within as many cells as required.

15.2.22 Layout Grid Base Height The style:layout-grid-base-height attribute specifies the height reserved in the layout grid lines for non ruby text. 13524 13525 13526 13527 13528 13529 13530

1 May 2005 Page 549 of 706

15.2.23 Layout Grid Ruby Height The style:layout-grid-ruby-height attribute specifies the height reserved in the layout grid lines for ruby text. 13531 13532 13533 13534 13535 13536 13537

15.2.24 Layout Grid Lines The style:layout-grid-lines attribute specifies the number of layout grid lines per page. The number of lines actually displayed may be smaller than specified if the page has not enough space to display the specified number of lines with the specified line height (i.e. the sum of the base and ruby height). 13538 13539 13540 13541 13542 13543 13544

15.2.25 Layout Grid Color The style:layout-grid-color attribute specifies the color of the layout grid border lines. 13545 13546 13547 13548 13549 13550 13551

15.2.26 Layout Grid Ruby Below The style:layout-grid-ruby-below attribute specifies whether ruby text is displayed above or below the base text. 13552 13553 13554 13555 13556 13557 13558

15.2.27 Layout Grid Print The style:layout-grid-ruby-print attribute specifies whether the layout grid border lines are printed. 13559 13560

1 May 2005 Page 550 of 706

13561 13562 13563 13564 13565

15.2.28 Layout Grid Display The style:layout-grid-ruby-print attribute specifies whether the layout grid border lines are displayed. 13566 13567 13568 13569 13570 13571 13572

15.3 Header Footer Formatting Properties The properties described in this section can be contained within the header and footer style elements contained in page layouts (see section 14.3) They are contained in a <style:header-footer-properties> element. These attributes are: •

Fixed and minimum heights - see section 15.27

•

Left and right margins - see section 15.5.17

•

Bottom (for headers only) and top (for footers only) margins - see section 15.5.20.

•

Borders - see section 15.5.25 and 15.5.26

•

Shadows – see section 15.5.28

•

Backgrounds – see section 15.5.23 and 15.5.24.

•

Dynamic-Spacing

13573 13574 13575 13576 13577

13578 13579 13580 13581

13582 13583 13584 13585 13586

15.3.1 Fixed and Minimum heights The attributes svg:height and fo:min-height properties specify a fixed or a minimum height for the header or footer.

1 May 2005 Page 551 of 706

13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598

15.3.2 Margins The margins attributes fo:margin, fo:margin-top, fo:margin-bottom, fo:marginleft and fo:margin-right specify the size of the header and footer margins. See sections 15.5.17, 15.5.20 and 15.5.21 for detailed information on these attributes. Percentage values are not supported. Bottom margins are only supported for headers, top margins only for footers. 13599 13600 13601 13602 13603

15.3.3 Border The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-left and fo:border-right specify the border properties of the headers and footers. See section 15.5.25 for detailed information on these attributes. 13604 13605 13606

15.3.4 Border Line Width If a page contains borders, the border line width attributes style:border-line-width, style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of the border lines of the headers and footers. See section 15.5.26 for detailed information on these attributes. 13607 13608 13609

15.3.5 Padding The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the headers and footers. See section 15.5.27 for detailed information on these attributes. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved.

1 May 2005 Page 552 of 706

13610 13611 13612

15.3.6 Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the header or footer. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 13613 13614 13615 13616 13617 13618

15.3.7 Shadow The shadow attribute style:shadow specifies the shadow of the headers and footers. See section 15.5.28 for detailed information on this attribute. 13619 13620 13621

15.3.8 Dynamic Spacing The style:dynamic-spacing property specifies whether or not a header footers grows into the space between the page body and the header or footer before the height of the page body becomes smaller. If the value of this attribute is true, the header or footers first grows into the space between the header and footer and the page body. 13622 13623 13624 13625 13626 13627 13628

15.4 Text Formatting Properties The properties described in this section can be contained within text styles (see section 14.8.1), but also within other styles, like paragraph styles (see section 14.8.2) or cell styles (see section 14.12.4) They are contained in a <style:text-properties> element. 13629 13630 13631 13632 13633

13634 13635 13636 13637

13638 13639

1 May 2005 Page 553 of 706

13640 13641 13642

13643 13644 13645 13646

15.4.1 Font Variant Use the fo:font-variant property to switch the option to display text as small capitalized letters on or off. See §7.8.8 of [XSL] for details. For some implementations, the fo:font-variant and fo:text-transform properties are mutually exclusive. If both properties are attached used simultaneously, the result is undefined except that the fo:text-transform value is none and the fo:font-variant value is normal. 13647 13648 13649 13650 13651 13652 13653

13654 13655 13656 13657 13658 13659 13660

<define name="fontVariant"> <choice> <value>normal</value> <value>small-caps</value> </choice> </define>

15.4.2 Text Transformations Use the fo:text-transform property to describe text transformations to uppercase, lowercase, and capitalization. See §7.16.6 of [XSL] for details. For some implementations, the fo:font-variant and fo:text-transform properties are mutually exclusive. If both properties are attached used simultaneously, the result is undefined except that the fo:text-transform value is none and the fo:font-variant value is normal. 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="fo:text-transform"> <choice> <value>none</value> <value>lowercase</value> <value>uppercase</value> <value>capitalize</value> </choice> </attribute> </optional> </define>

15.4.3 Color Use the fo:color property to specify the foreground color of text. See §7.17.1 of [XSL] for details.

1 May 2005 Page 554 of 706

13673 13674 13675 13676 13677 13678 13679

15.4.4 Window Font Color Use the style:use-window-font-color property to specify whether or not the window foreground color should be as used as the foreground color for a light background color and white for a dark background color. 13680 13681 13682 13683 13684 13685 13686

15.4.5 Text Outline Use the style:text-outline property to specify whether to display an outline of text or the text itself. This attribute can have a value of true or false. 13687 13688 13689 13690 13691 13692 13693

15.4.6 Line Through Type Use the style:text-line-through-type property to specify whether text is lined through, and if so, whether a single or double line will be used. See section 15.4.28 for details. 13694 13695 13696 13697 13698 13699 13700

15.4.7 Line Through Style Use the style:text-line-through-style property to specify if and how text is lined through. This property is similar to the [CSS3Text] text-line-style property, except that it has the additional value long-dash and that it does not have the value double. Instead of this, the attribute style:text:line-through-type can be used to turn each line style into a double line. See §9.2 of [CSS3Text] for details. See also section 15.4.29. 13701 13702 13703 13704

1 May 2005 Page 555 of 706

13705 13706 13707

</attribute> </optional> </define>

15.4.8 Line Through Width Use the style:text-line-through-width property to specifies the width of a line through line. This property is very similar to the [CSS3Text] text-line-through-width property, except that it has an additional value bold. bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width. See §9.3 of [CSS3Text] for details. See also section 15.4.30. 13708 13709 13710 13711 13712 13713 13714

15.4.9 Line Through Color Use the style:text-line-through-color property to specify the color that is used to line through text. The value of this property is either font-color or a color. If the value is fontcolor, the current text color is used for underlining. 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-line-through-color"> <choice> <value>font-color</value> <ref name="color"/> </choice> </attribute> </optional> </define>

15.4.10 Line Through Text The style:text-line-through-text attribute is evaluated only if the value of style:text-line-through-style attribute is different than none. If the attribute value is not empty, the attribute value string is used for line-through instead of the line that has been specified, provided that the application supports line-through with text. If the application does not support line-through with text, the attribute is ignored, this means, style:text-linethrough-style will be evaluated only. If the application supports line-trough with single characters only, and the text-line-through-text has more than one character, the first character of the line-through-text should be used only. If the applications supports line-through with with certain characters only (like "x" or "/"), the application should use one of these characters if the text-line-through-text specifies characters that are not supported. In other words: line-through with text has an higher priority than line-through with lines, even if the line through text that is specified has to be adapted to be usable by the application. 13725 13726 13727 13728 13729 13730 13731

1 May 2005 Page 556 of 706

15.4.11 Line Through Text Style The style:text-line-through-text-style specifies a text style that is applied to the text-line-through characters. It is not applied to line through lines. If the attribute appears in an automatic style, it may reference either an automatic text style or an common style. If the attribute appears in an common style, it may reference a common style only. 13732 13733 13734 13735 13736 13737 13738

15.4.12 Text Position Use the style:text-position formatting property to specify whether text is positioned above or below the baseline and to specify the relative font height that is used for this text. This attribute can have one or two values. The first value must be present and specifies the vertical text position as a percentage that relates to the current font height or it takes one of the values sub or super. Negative percentages or the sub value place the text below the baseline. Positive percentages or the super value place the text above the baseline. If sub or super is specified, the application can choose an appropriate text position. The second value is optional and specifies the font height as a percentage that relates to the current font-height. If this value is not specified, an appropriate font height is used. Although this value may change the font height that is displayed, it never changes the current font height that is used for additional calculations. 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-position"> <list> <choice> <ref name="percent"/> <value>super</value> <value>sub</value> </choice> <optional> <ref name="percent"/> </optional> </list> </attribute> </optional> </define>

15.4.13 Font Name Use the style:font-name, style:font-name-asian and style:font-name-complex properties to assign a font to the text. The values of these attributes form the name of a font that is declared by a <style:fontface> element within the <office:font-face-decls> element. The style:font-name-asian attribute is evaluated for UNICODE characters that are CJK characters.

1 May 2005 Page 557 of 706

The style:font-name-complex attribute is evaluated for UNICODE characters that are complex text layout (CTL) characters. The style:font-name attribute is evaluated for any other UNICODE character. 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771

15.4.14 Font Family Use the fo:font-family, style:font-family-asian and style:font-familycomplex properties to specify the font family for the text. These attributes may be used instead of the font name attributes to specify the properties of a font individually. However, it is advisable to use the style:font-name attributes instead. See section 15.4.13 for information about when Asian and complex variants of the attribute are evaluated. See also §7.8.2 of [XSL]. 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788

15.4.15 Font Family Generic Use the style:font-family-generic, style:font-family-generic-asian and style:font-family-generic-complex properties to specify a generic font family name. These properties are ignored if there is no corresponding fo:font-family property attached to the same properties element. Although it is recommended to use the font name attributes (see section 15.4.13), these properties may be used instead of them to specify the properties of a font.

1 May 2005 Page 558 of 706

See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805

13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816

<define name="fontFamilyGeneric"> <choice> <value>roman</value> <value>swiss</value> <value>modern</value> <value>decorative</value> <value>script</value> <value>system</value> </choice> </define>

15.4.16 Font Style Use the style:font-style-name, style:font-style-name-asian and style:fontstyle-name-complex properties to specify a font style name. These properties are ignored if there is no corresponding fo:font-family property attached to the same properties element. Although it is recommended to use the font name attributes (see section 15.4.13), these properties may be used instead of them to specify the properties of a font. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833

1 May 2005 Page 559 of 706

15.4.17 Font Pitch Use the style:font-pitch, style:font-pitch and style:font-pitch-complex properties to specify whether a font has a fixed or variable width. These properties are ignored if there is no corresponding fo:font-family property attached to the same properties element. Although it is recommended to use the font name attributes (see section 15.4.13), these properties may be used instead of them to specify the properties of a font. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850

13851 13852 13853 13854 13855 13856 13857

<define name="fontPitch"> <choice> <value>fixed</value> <value>variable</value> </choice> </define>

15.4.18 Font Character Set Use the style:font-charset, style:font-charset-asian and style:font-charsetcomplex properties to specify the character set of a font. The value of these attributes can be x-symbol or the character encoding in the notation described in the §4.3.3 of [XML1.0]. If the value is x-symbol, all characters that are displayed using this font must be contained in the UNICODE character range 0xf000 to 0xf0ff. These properties are ignored if there is no corresponding fo:font-family property attached to the same properties element. Although it is recommended to use the font name attributes (see section 15.4.13), these properties may be used instead of them to specify the properties of a font. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13858 13859 13860 13861 13862

1 May 2005 Page 560 of 706

13863 13864

</optional> </define>

13865 13866 13867 13868 13869 13870

15.4.19 Font Size Use the fo:font-size, style:font-size-asian and style:font-size-complex properties to specify the size of font. The value of these property is either an absolute length or a percentage as described in §8.8.4 of [XSL]. In contrast to XSL, percentage values can be used within common styles only and relates to the font height of the parent style rather than to the font height of the attributes neighborhood. Absolute font heights such as medium, large, x-large, and so on, and relative font heights such as smaller, and larger are not supported. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896

15.4.20 Relative Font Size Use the style:font-size-rel, style:font-size-rel-asian and style:font-sizerel-complex properties to specify a relative font size change. These properties specify a relative font size change as a length such as +1pt, -3pt. It cannot be used within automatic styles. The size changes relates to the font size setting that applies to the parent style of the style. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated.

1 May 2005 Page 561 of 706

13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913

15.4.21 Script Type The style:script-type property may be used to specify which script dependent attributes (like fo:font-family, style:font-family-asian, style:font-family-complex) are currently active for some text. The attribute should be evaluated by applications that do not support script types to select the correct script dependent properties. Application that support script types may also evaluate the attribute and overwrite the script type they would evaluate for a certain character, but they don't have to. The usage of this property simplifies for instance transformations from and to [CSS2]/[XSL] and other formats that don't have script-dependent attributes, and also can be used to assign scripttypes to weak UNICODE characters, where application may choose different script types. The values of this property are latin, asian, complex and ignore. The value ignore can be used only within default styles. If it is set, all script-dependent attributes are applied to all script types. This would mean for example that a fo:font-family would be applied to all script types as well as a style:font-family-asian or style:font-family-complex. This simplifies saving documents with application that do not support a script type. 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:script-type"> <choice> <value>latin</value> <value>asian</value> <value>complex</value> <value>ignore</value> </choice> </attribute> </optional> </define>

15.4.22 Letter Spacing Use the fo:letter-spacing property to specify the amount of space between letters. The value of this property can be normal or it can specify a length. See §7.16.2 of [XSL] for details. 13926 13927 13928 13929 13930 13931

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="fo:letter-spacing"> <choice> <ref name="length"/> <value>normal</value>

1 May 2005 Page 562 of 706

13932 13933 13934 13935

</choice> </attribute> </optional> </define>

15.4.23 Language Use the fo:language, fo:language-asian and fo:language-complex properties to specify the language of the text. See §7.9.2 of [XSL] for details. Some applications ignore these properties if they are not specified together with the corresponding fo:country property. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. fo:language, fo:language-asian and fo:language-complex 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952

15.4.24 Country Use the fo:country, style:country-asian and style:country-complex properties to specify the country of the text. See §7.9.1 of [XSL] for details. Some application ignore these properties if they are not specified together with the corresponding fo:language property. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967

1 May 2005 Page 563 of 706

13968 13969

</optional> </define>

15.4.25 Font Style Use the fo:font-style, style:font-style-asian and style:font-style-complex properties to specify whether to use normal or italic font face. See §7.8.7 of [XSL] for details. See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986

13987 13988 13989 13990 13991 13992 13993 13994

<define name="fontStyle"> <choice> <value>normal</value> <value>italic</value> <value>oblique</value> </choice> </define>

15.4.26 Font Relief Use the style:font-relief property to specify whether the font should be embossed, engraved, or neither. 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:font-relief"> <choice> <value>none</value> <value>embossed</value> <value>engraved</value> </choice> </attribute> </optional> </define>

15.4.27 Text Shadow Use the fo:text-shadow property to specify the text shadow style to use. See §7.16.5 of [XSL] for details. Some applications may only supports a limited number of shadow effects, for instance a default text shadow style only.

1 May 2005 Page 564 of 706

14006 14007 14008 14009 14010 14011 14012

14013 14014 14015 14016 14017 14018 14019 14020

15.4.28 Underlining Type Use the style:text-underline-type property to specify whether text is underlined, and if so, whether a single or double line will be used for underlining. 14021 14022 14023 14024 14025 14026 14027

14028 14029 14030 14031 14032 14033 14034 14035

<define name="lineType"> <choice> <value>none</value> <value>single</value> <value>double</value> </choice> </define>

15.4.29 Underlining Style Use the style:text-underline-style property to specify if and how text is underlined. The value of this property is the underlining style for the text, for example, single, dotted, dash. This property is similar to the [CSS3Text] text-underline-style property, except that has the additional value long-dash and that it does not have the value double. Instead of this, the attribute style:text:underline-type can be used to turn each line style into a double line. See §9.2 of [CSS3Text] for details. 14036 14037 14038 14039 14040 14041 14042

14043 14044 14045 14046 14047 14048 14049 14050 14051

<define name="lineStyle"> <choice> <value>none</value> <value>solid</value> <value>dotted</value> <value>dash</value> <value>long-dash</value> <value>dot-dash</value>

1 May 2005 Page 565 of 706

14052 14053 14054 14055

15.4.30 Underling Width Use the style:text-underline-width property specifies the width of an underline. This property is very similar to the [CSS3Text] text-underline-width property, except that it has an additional value bold. bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width. See §9.3 of [CSS3Text] for details. 14056 14057 14058 14059 14060 14061 14062

14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077

<define name="lineWidth"> <choice> <value>auto</value> <value>normal</value> <value>bold</value> <value>thin</value> <value>dash</value> <value>medium</value> <value>thick</value> <ref name="positiveInteger"/> <ref name="percent"/> <ref name="positiveLength"/> </choice> </define>

15.4.31 Underline Color Use the style:text-underline-color property to specify the color that is used to underline text. The value of this property is either font-color or a color. If the value is font-color, the current text color is used for underlining. 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-underline-color"> <choice> <value>font-color</value> <ref name="color"/> </choice> </attribute> </optional> </define>

15.4.32 Font Weight Use the fo:font-weight, style:font-weight-asian and style:font-weightcomplex properties to specify the weight of the font. See §7.8.9 of [XSL] for details. The relative values lighter or bolder are not supported and only a few distinct numerical values are supported. Unsupported numerical values are rounded off to the next supported value.

1 May 2005 Page 566 of 706

See section 15.4.13 for information about when the Asian and complex variants of the attribute are evaluated. 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104

14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120

<define name="fontWeight"> <choice> <value>normal</value> <value>bold</value> <value>100</value> <value>200</value> <value>300</value> <value>400</value> <value>500</value> <value>600</value> <value>700</value> <value>800</value> <value>900</value> </choice> </define>

15.4.33 Text Underline Word Mode Use the style:text-underline-mode property to specify whether underlining is applied to words only or to portions of text. If underlining is applied to text portions, the spaces between words and the words are underlined. See § 9.5 of [CSS3Text] for details. 14121 14122 14123 14124 14125 14126 14127

14128 14129 14130 14131 14132 14133 14134

<define name="lineMode"> <choice> <value>continuous</value> <value>skip-white-space</value> </choice> </define>

15.4.34 Text Line Through Word Mode Use the style:text-line-through-mode property to specify whether lining through is applied to words only or to portions of text. If lining through is applied to text portions, the spaces between words and the words are line-through. See § 9.5 of [CSS3Text] for details.

1 May 2005 Page 567 of 706

14135 14136 14137 14138 14139 14140 14141

15.4.35 Letter Kerning Use the style:letter-kerning property to enable or disable kerning between characters. 14142 14143 14144 14145 14146 14147 14148

15.4.36 Text Blinking Use the style:text-blinking property to specify whether or not text blinks. 14149 14150 14151 14152 14153 14154 14155

15.4.37 Text Background Color Use the fo:background-color property to specify the background color to apply to characters. See §7.7.2 of [XSL] for details. The value of this property can be transparent or a color. See also section 15.5.23. 14156 14157 14158

15.4.38 Text Combine Use the style:text-combine property to combine characters so that they are displayed within two lines. The value of this attribute can be none, letters or lines. If the value is lines, all characters with this attribute value that immediately follow each other are displayed within two lines of approximately the same length. There can be a line break between any two characters to meet this constraint. If the value of the attribute is letters, up to 5 characters are combined within two lines. Any additional character is displayed as normal text. 14159 14160 14161

1 May 2005 Page 568 of 706

14162 14163 14164 14165 14166 14167 14168 14169

<choice> <value>none</value> <value>letters</value> <value>lines</value> </choice> </attribute> </optional> </define>

15.4.39 Text Combine Start and End Characters Use the two properties style:text-combine-start-char and style:text-combineend-char to specify a start and end character that is displayed before and after a portion of text whose style:text-combine property has a value of lines. 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181

15.4.40 Text Emphasis Use the style:text-emphasize property to emphasize text in Asian documents. The value of this attribute consists of two space-separated values. The first value represents the style to use for emphasis and it can be none, accent, dot, circle, or disc. The second value represents the position of the emphasis and it can be above or below. If the first value is none, this value can be omitted. 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-emphasize"> <choice> <value>none</value> <list> <choice> <value>none</value> <value>accent</value> <value>dot</value> <value>circle</value> <value>disc</value> </choice> <choice> <value>above</value> <value>below</value> </choice> </list> </choice> </attribute> </optional> </define>

1 May 2005 Page 569 of 706

15.4.41 Text Scale Use the style:text-scale property to decrease or increase the width of the text by scaling the font width. 14204 14205 14206 14207 14208 14209 14210

15.4.42 Text Rotation Angle The style:text-rotation-angle property specifies an angle to which text is rotated. The value of this attribute can be 0, 90, or 270. For any angle greater than 359 the remainder of a division by 360 is used. Any angle other than 0, 90 or 270 is rounded to the nearest possible value. If this attribute is specified for more than one character, all text containing these characters is rotated. 14211 14212 14213 14214 14215 14216 14217

15.4.43 Text Rotation Scale If text is rotated, the style:text-rotation-scale property specifies whether the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height. 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227

<define name="style-text-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-rotation-scale"> <choice> <value>fixed</value> <value>line-height</value> </choice> </attribute> </optional> </define>

15.4.44 Hyphenation Use the fo:hyphenate property to enable or disable automatic hyphenation. See §7.9.4 of [XSL] for details. Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count and fo:hyphenation-ladder-count independent of each other within a style. A reasonable default for fo:hyphenate in this case is false. 14228 14229

1 May 2005 Page 570 of 706

14230 14231 14232 14233 14234

15.4.45 Hyphenation Remain Char Count Use the fo:hyphenation-remain-char-count property to specify the number of characters that must be present before a hyphenation character. See §7.9.7 of [XSL] for details. Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count and fo:hyphenation-ladder-count independent of each other within a style. A reasonable default for fo:hyphenation-remain-char-count in this case is 0. 14235 14236 14237 14238 14239 14240 14241

15.4.46 Hyphenation Push Char Count Use the fo:hyphenation-push-char-count property to specify the minimum number of characters that are moved to the next line. See §7.9.6 of [XSL] for details. Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count and fo:hyphenation-ladder-count independent of each other within a style. A reasonable default for fo:hyphenation-push-char-count in this case is 0. 14242 14243 14244 14245 14246 14247 14248

15.4.47 Hidden or Conditional Text The text:display property allows text to be hidden. This can be made dependent on a condition as well. This attributes and its values are the same as for text:display attribute on text sections (see also section 4.4). The values of this attribute may be any of:

14249 14250 14251 14252

•

true – the text will be displayed normally. This is the default.

•

none – the text will be hidden.

•

condition – a condition determines whether the text will be displayed or hidden. In this case, a text:condition attribute must be present specifying the condition.

1 May 2005 Page 571 of 706

14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267

</attribute> <attribute name="text:display"> <value>none</value> </attribute> <group> <attribute name="text:display"> <value>condition</value> </attribute> <attribute name="text:condition"> <value>none</value> </attribute> </group> <empty/> </choice> </define>

15.5 Paragraph Formatting Properties The properties described in this section can be contained within paragraph styles (see section 14.8.2), but also within other styles, like cell styles (see section 14.12.4) They are contained in a <style:paragraph-properties> element. 14268 14269 14270 14271 14272

14273 14274 14275 14276

14277 14278 14279 14280 14281

15.5.1 Fixed Line Height Use the fo:line-height property to specify a fixed line height either as a length or a percentage that relates to the highest character in a line. A special value of normal activates the default line height calculation. It is also used to deactivate the effects of the style:lineheight-at-least and style:line-spacing properties. The value of this property can be a length, a percentage, or a value of normal. See §7.15.4 of [XSL] for details. 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="fo:line-height"> <choice> <value>normal</value> <ref name="nonNegativeLength"/> <ref name="percent"/> </choice> </attribute> </optional> </define>

15.5.2 Minimum Line Height Use the style:line-height-at-least property to specify a minimum line height. The value of this property is a length. There is no normal value for the property.

1 May 2005 Page 572 of 706

14293 14294 14295 14296 14297 14298 14299

15.5.3 Line Distance Use the style:line-spacing property to specify a fixed distance between two lines. There is no normal value for this property. 14300 14301 14302 14303 14304 14305 14306

15.5.4 Font-Independent Line Spacing The style:font-independent-line-spacing property specifies if font independent line spacing is used. If the attribute's value is true, then the line height is calculated only from the font height as specified by the font size attributes fo:font-size, style:font-size-asian and style:font-size-complex. If the value is false, the font metric of the actual font is taken into account. 14307 14308 14309 14310 14311 14312 14313

15.5.5 Text Align Use the fo:text-align property to specify how to align text in paragraphs. The value of this property can be start, end, left, right, center, or justify. See §7.15.9 of [XSL] for details. The values inside and outside are not supported. If there are no values specified for the fo:text-align-last and style:justify-singleword properties within the same item set element, the values of these properties are set to start and false respectively. 14314 14315 14316

14317 14318 14319 14320 14321 14322 14323 14324 14325

<define name="common-text-align"> <optional> <attribute name="fo:text-align"> <choice> <value>start</value> <value>end</value> <value>left</value> <value>right</value>

1 May 2005 Page 573 of 706

14326 14327 14328 14329 14330 14331

<value>center</value> <value>justify</value> </choice> </attribute> </optional> </define>

15.5.6 Text Align of Last Line Use the fo:text-align-last property to specify how to align the last line of a justified paragraph. See §7.15.9 of [XSL] for details. The only values of this property that are supported are start, center, or justify. This property is ignored if it not accompanied by an fo:text-align property. If there are no values specified for the fo:text-align and style:justify-single-word properties, these values of these properties is set to start and false respectively. 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="fo:text-align-last"> <choice> <value>start</value> <value>center</value> <value>justify</value> </choice> </attribute> </optional> </define>

15.5.7 Justify Single Word If the last line in a paragraph is justified, use the style:justify-single-word property to specify whether or not a single word should be justified. If there are no values specified for the fo:text-align and fo:text-align-last properties, the values of these properties are set to start. This means that specifying a style:justifysingle-word property without specifying a fo:text-align and fo:text-align-last property has no effect. 14343 14344 14345 14346 14347 14348 14349

15.5.8 Keep Together Use the fo:keep-together property to control whether the lines of a paragraph should be kept together on the same page or column (if the value is always), or whether breaks are allowed within the paragraph (if the value is auto). See §7.19.3 of [XSL] for details. 14350 14351 14352 14353 14354 14355

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="fo:keep-together"> <choice> <value>auto</value> <value>always</value>

1 May 2005 Page 574 of 706

14356 14357 14358 14359

</choice> </attribute> </optional> </define>

15.5.9 Widows Use the fo:widows property to specify the minimum number of lines allowed at the top of a page to avoid paragraph widows. See §7.19.7 of [XSL] for details. 14360 14361 14362 14363 14364 14365 14366

15.5.10 Orphans Use the fo:orphans property to specify the minimum number of lines required at the bottom of a page to avoid paragraph orphans. See See §7.19.6 of [XSL] for details. 14367 14368 14369 14370 14371 14372 14373

15.5.11 Tab Stops Use the tab stop element <style:tab-stops> to specify tab stop definitions. Every tab stop position is represented by a single <style:tab-stop> element that is contained in the <style:tab-stops> element. 14374 14375 14376

14377 14378 14379 14380 14381 14382 14383 14384 14385 14386

14387 14388 14389 14390 14391 14392 14393

The attributes that may be associated with the <style:tab-stop> elements are: •

Tab position

1 May 2005 Page 575 of 706

•

Tab type

•

Delimiter character

•

Leader type

•

Leader style

•

Leader width

•

Leader color

•

Leader text

•

Leader text style

Tab Position The style:position attribute specifies the position of a tab stop. This attribute is associated with the <style:tab-stop> element and its value is a length. 14394 14395 14396 14397 14398

Tab Type The style:type attribute specifies the type of tab stop. This attribute is associated with the <style:tab-stop> element and its value can be left, center, right or char. 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417

<define name="style-tab-stop-attlist" combine="interleave"> <choice> <optional> <attribute name="style:type" a:defaultValue="left"> <choice> <value>left</value> <value>center</value> <value>right</value> </choice> </attribute> </optional> <group> <attribute name="style:type"> <value>char</value> </attribute> <ref name="style-tab-stop-char-attlist"/> </group> </choice> </define>

Delimiter Character The style:char attribute specifies the delimiter character for tab stops of type char. This attribute is associated with the <style:tab-stop> element and it must be present if the value of the style:type attribute is char. If the value of style:type attribute is not char, it is ignored. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved.

1 May 2005 Page 576 of 706

The value of the attribute must be a single UNICODE character. 14418 14419 14420 14421 14422

Leader Type Use the style:leader-type attribute to specify whether a leader line should be drawn, and if so, whether a single or double line will be used. See also section 15.4.28. 14423 14424 14425 14426 14427 14428 14429

Leader Style Use the style:leader-style property to specify if and how a leader line is drawn. The line styles that can be used are described in section 15.4.29. 14430 14431 14432 14433 14434 14435 14436

Leader Width Use the style:leader-width property to specifies the width of a leader line. See section 15.4.30 for the values of this attribute. 14437 14438 14439 14440 14441 14442 14443

Leader Color Use the style:leader-color property to specify the color that is for the leader line. The value of this property is either font-color or a color. If the value is font-color, the current text color is used for the leader line. 14444 14445 14446 14447 14448 14449 14450 14451

<define name="style-tab-stop-attlist" combine="interleave"> <optional> <attribute name="style:leader-color"> <choice> <value>font-color</value> <ref name="color"/> </choice> </attribute>

1 May 2005 Page 577 of 706

14452 14453

</optional> </define>

Leader Text The style:leader-text attribute specifies the leader text to use for tab stops. If the attribute value is not empty, the attribute value string is used as leader instead of the line that has been specified, provided that the application supports textual leaders. If the application does not support textual, the attribute is ignored, this means, style:leader-style will be evaluated only. If the application supports textual consisting of a single characters only, and the leader text has more than one character, the first character of the leader text should be used only. If the applications supports textual leaders with with certain characters only (like "." or "_"), the application should use one of these characters if the leader-text specifies characters that are not supported. In other words: textual leaders have an higher priority than line leaders, even if the leader text that is specified has to be adapted to be usable by the application. This attribute is associated with the <style:tab-stop> element and its value must be a single UNICODE character. 14454 14455 14456 14457 14458 14459 14460

Leader Text Style The style:leader-text-style specifies a text style that is applied to a textual leader. It is not applied to leader lines. If the attribute appears in an automatic style, it may reference either an automatic text style or an common style. If the attribute appears in an common style, it may reference a common style only. 14461 14462 14463 14464 14465 14466 14467

15.5.12 Tab Stop Distance The attribute style:tab-stop-distance specifies the distance between default tab stops. A default tab stop is repeated automatically after the specified distance. Default tab stops usually are only evaluated if they are specified within a default style (see section 14.2). 14468 14469 14470 14471 14472 14473 14474

1 May 2005 Page 578 of 706

15.5.13 Hyphenation Keep Use the fo:hyphenation-keep property to enable or disable the hyphenation of the last word on a page. See §7.15.1 of [XSL] for details. Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count and fo:hyphenation-ladder-count independent of each other within a style. A reasonable default for fo:hyphenation-keep in this case is auto. 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484

15.5.14 Maximum Hyphens Use the fo:hyphenation-ladder-count property to specify the maximum number of successive lines that can contain a hyphenated word. See §7.15.2 of [XSL] for details. Some application might not support setting the properties fo:hyphenate, fo:hyphenationkeep, fo:hyphenation-remain-char-count, fo:hyphenation-push-char-count and fo:hyphenation-ladder-count independent of each other within a style. A reasonable default for fo:hyphenation-push-char-count in this case is no-limit. 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="fo:hyphenation-ladder-count"> <choice> <value>no-limit</value> <ref name="positiveInteger"/> </choice> </attribute> </optional> </define>

15.5.15 Drop Caps Use the <style:drop-cap> element to specify if the first character or more of a paragraph is displayed in a larger font. This element can be contained in a <style:paragraphproperties> element. 14495 14496 14497

14498 14499 14500 14501 14502 14503 14504 14505 14506

1 May 2005 Page 579 of 706

The attributes that may be associated with the <style:drop-cap> element are: •

Length

•

Lines

•

Distance

•

Text style

Length The style:length attribute specifies the number of characters that are dropped. The value of this attribute can be a number or word, which indicates that the first word should be dropped. 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516

Lines The style:lines attribute specifies the number of lines that the dropped characters should encircle. If the value of this attribute is 1 or 0, drop caps is disabled. 14517 14518 14519 14520 14521 14522 14523

Distance The style:distance attribute specifies the distance between the last dropped character and the first of the remaining characters of each line. The value of this attribute is a length. 14524 14525 14526 14527 14528 14529 14530

Text Style The style:style-name attribute specifies the text style to apply to the dropped characters. 14531 14532 14533

1 May 2005 Page 580 of 706

14534 14535 14536 14537

15.5.16 Register True The style:register-true property specifies whether the lines on both sides of a printed page match when a document is printed using two-sided printing, It also ensures that the text in page columns or text box columns is arranged in such a way that the text baselines seem to run from one column to another. See also section 15.2.12. 14538 14539 14540 14541 14542 14543 14544

15.5.17 Left and Right Margins Use the fo:margin-left and fo:margin-right properties to specify the left and right margins for a paragraph. See §7.10.3 and §7.10.4 of [XSL] for details. The value auto is not supported. Percentage values are only supported in common styles. They here relate to the corresponding margin of the parent style. For some applications. these two properties must be used simultaneously and also together with the fo:text-indent property. If any of the properties is missing, its value is assumed to be 0cm. 14545 14546 14547

14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566

15.5.18 Text Indent Use the fo:text-indent property to specify a positive or negative indent for the first line of a paragraph. See §7.15.11 of [XSL] for details. Percentage values are only supported in common styles. They here relate to the corresponding margin of the parent style.

1 May 2005 Page 581 of 706

For some applications. the fo:text-indent property must be used together with the fo:margin-left and fo:margin-right properties. If any of these properties is missing, its value is assumed to be 0cm. 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576

15.5.19 Automatic Text Indent Use the style:auto-text-indent property to specify that the first line of a paragraph is indented by a value that is based on the current font size. For some applications. the style:auto-text-indent property must be used together with the fo:margin-left and fo:margin-right properties. If any of these properties is missing, its value is assumed to be 0cm. If this property has a value of true and is used together with a fo:text-indent property, then the fo:text-indent property is ignored. 14577 14578 14579 14580 14581 14582 14583

15.5.20 Top and Bottom Margins Use the fo:margin-top and fo:margin-bottom properties to specify the top and bottom margins for paragraphs. See §7.10.1 and §7.10.2 of [XSL] for details. The value auto is not supported. Percentage values are only supported in common styles. They here relate to the corresponding margin of the parent style. For some applications. these two properties must be used simultaneously. If any of the properties is missing, its value is assumed to be 0cm. 14584 14585 14586

14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600

1 May 2005 Page 582 of 706

14601 14602 14603 14604 14605

15.5.21 Margins Use the fo:margin property to specify the top, bottom, left and right margins for paragraphs simultaneously. See §7.29.4 of [XSL] and sections 15.5.17 and 15.5.20 for details. 14606 14607 14608

14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619

15.5.22 Break Before and Break After Use the fo:break-before and fo:break-after properties to insert a page or column break before or after a paragraph. See §7.19.1 and §7.19.2 of [XSL] for details. The values odd-page and even-page are not supported. These two properties are mutually exclusive. If they are used simultaneously, the result is undefined. 14620 14621 14622

14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643

<define name="common-break-attlist"> <optional> <attribute name="fo:break-before"> <choice> <value>auto</value> <value>column</value> <value>page</value> </choice> </attribute> </optional> <optional> <attribute name="fo:break-after"> <choice> <value>auto</value> <value>column</value> <value>page</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 583 of 706

15.5.23 Paragraph Background Color Use the fo:background-color property to specify the background color of a paragraph. See §7.7.2 of [XSL] for details. The value of this attribute can be either transparent or it can be a color. If the value is transparent, it switches off any background image that is specified by a <style:background-image> element simultaneously. 14644 14645 14646

14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657

<define name="common-background-color-attlist"> <optional> <attribute name="fo:background-color"> <choice> <value>transparent</value> <ref name="color"/> </choice> </attribute> </optional> </define>

15.5.24 Paragraph Background Image Use the <style:background-image> element to specify a background image for a paragraph. The background image can be stored in one of the following ways (see also section 9.3.2): •

The image data is stored in an external file. Use the [XLink] attributes to specify the location of the image.

•

The image data is contained in an <office:binary-data> sub element in BASE64 encoding.

If the <style:background-image> element is empty and if there is no color specified by an fo:background-color element in the same properties element, the background color is set to transparent. 14658 14659 14660

14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673

The attributes that may be associated with the <style:background-image> element are: •

Repetition

•

Position

1 May 2005 Page 584 of 706

•

Filter

•

Opacity

Repetition The style:repeat attribute specifies whether a background image is repeated or stretched in a paragraph. This attribute is attached to the <style:background-image> element and its value can be no-repeat, repeat, or stretch. 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684

<define name="style-background-image-attlist" combine="interleave"> <optional> <attribute name="style:repeat" a:defaultValue="repeat"> <choice> <value>no-repeat</value> <value>repeat</value> <value>stretch</value> </choice> </attribute> </optional> </define>

Position The style:position attribute specifies where to position a background image in a paragraph. This attribute is attached to the <style:background-image> element and its value can be a space separated combination of top, center or bottom for the vertical position and left, center or right for the horizontal position. The vertical and horizontal positions can be specified in any order. If one position is specified, the other position defaults to center. 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705

<define name="style-background-image-attlist" combine="interleave"> <optional> <attribute name="style:position" a:defaultValue="center"> <choice> <value>left</value> <value>center</value> <value>right</value> <value>top</value> <value>bottom</value> <list> <ref name="horiBackPos"/> <ref name="vertBackPos"/> </list> <list> <ref name="vertBackPos"/> <ref name="horiBackPos"/> </list> </choice> </attribute> </optional> </define>

14706 14707 14708 14709 14710 14711 14712 14713

<define name="horiBackPos"> <choice> <value>left</value> <value>center</value> <value>right</value> </choice> </define>

1 May 2005 Page 585 of 706

14714 14715 14716 14717 14718 14719 14720

<define name="vertBackPos"> <choice> <value>top</value> <value>center</value> <value>bottom</value> </choice> </define>

Filter The style:filter-name attribute specifies the application specific filter name that is used to load the image into the document. This attribute is attached to the <style:background-image> element. 14721 14722 14723 14724 14725 14726 14727

Opacity The draw:opacity attribute specifies the opacity of the background image. The value is a percentage, where 0% is fully transparent and 100% is fully opaque. 14728 14729 14730 14731 14732 14733 14734

15.5.25 Border Use the border properties fo:border, fo:border-top, fo:border-bottom, fo:borderleft and fo:border-right to specify the border properties for paragraphs. See §7.29.3 §7.29.7 of [XSL] for details. The fo:border property applies to all four sides of a paragraph while the other properties apply to one side only. For some applications, all four borders must be set simultaneously by using either the fo:border property or by attaching all four of the other border properties to a properties element. In the latter case, if one or more of the properties is missing their values are assumed to be none. There may be also restriction regarding the border styles and widths that are supported. In addition to this, some applications may add a default padding for sides that have a border. 14735 14736 14737

14738 14739 14740 14741 14742

1 May 2005 Page 586 of 706

14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765

</attribute> </optional> <optional> <attribute name="fo:border-top"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="fo:border-bottom"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="fo:border-left"> <ref name="string"/> </attribute> </optional> <optional> <attribute name="fo:border-right"> <ref name="string"/> </attribute> </optional> </define>

15.5.26 Border Line Width If the line style for a border is double, use the border line properties style:border-linewidth, style:border-line-width-top, style:border-line-width-bottom, style:border-line-width-left and style:border-line-width-right to individually specify the width of the inner and outer lines and the distance between them. The style:border-line-width specifies the line widths of all four sides, while the other attributes specify the line widths of one side only. The value of the attributes can be a list of three space-separated lengths, as follows: •

The first value specifies the width of the inner line

•

The second value specified the distance between the two lines

•

The third value specifies the width of the outer line

The result of specifying a border line width without specifying a border width style of double for the same border is undefined. 14766 14767 14768

14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783

1 May 2005 Page 587 of 706

14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796

</attribute> </optional> <optional> <attribute name="style:border-line-width-left"> <ref name="borderWidths"/> </attribute> </optional> <optional> <attribute name="style:border-line-width-right"> <ref name="borderWidths"/> </attribute> </optional> </define>

14797 14798 14799 14800 14801 14802 14803 14804

15.5.27 Padding Use the padding properties fo:padding, fo:padding-top, fo:padding-bottom, fo:padding-left and fo:padding-right to specify the spacing around a paragraph. See §7.29.15 and §7.7.35- §7.7.38 of [XSL] for details. For some application, the value of these properties can be a non-zero value only if there is a border at the same side and the border is specified within the same properties element. If a properties element contains a padding specification for one but not all four sides, some applications may also assign a zero or a default padding to these sides depending on whether or not there is a border at that side. There might be also other restriction regarding the combination of borders and paddings. 14805 14806 14807

14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832

1 May 2005 Page 588 of 706

14833 14834 14835

</attribute> </optional> </define>

15.5.28 Shadow Use the style:shadow property to specify a shadow effect for the paragraph. The valid values for this attribute are the same as the values for the fo:text-shadow property. See section 15.4.27 for information. Some applications may only supports a limited number of shadow effects, for instance only one effect where the the horizontal and vertical positions have the same value. 14836 14837 14838

14839 14840 14841 14842 14843 14844 14845 14846

15.5.29 Keep with Next Use the fo:keep-with-next property to specify whether or not to keep the current paragraph and the next paragraph together on a page or in a column after a break is inserted. See §7.9.14 of [XSL] for details. The only supported values are auto and always. 14847 14848 14849

14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860

<define name="common-keep-with-next-attlist"> <optional> <attribute name="fo:keep-with-next"> <choice> <value>auto</value> <value>always</value> </choice> </attribute> </optional> </define>

15.5.30 Line Numbering The text:number-lines attribute controls whether or not lines are numbered. 14861 14862 14863 14864 14865 14866 14867

1 May 2005 Page 589 of 706

15.5.31 Line Number Start Value The text:line-number property specifies a new start value for line numbering. The attribute is only recognized if there is also a text:number-lines attribute with a value of true in the same properties element. 14868 14869 14870 14871 14872 14873 14874

15.5.32 Text Autospace Use the style:text-autospace property to specify whether to add space between Asian, western, and complex text. The possible values are none and ideograph-alpha. 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-autospace"> <choice> <value>none</value> <value>ideograph-alpha</value> </choice> </attribute> </optional> </define>

15.5.33 Punctuation Wrap Use the style:punctuation-wrap property to determine whether or not a punctuation mark, if one is present, can be hanging, that is, whether it can placed in the margin area at the end of a full line of text. This is a common setting in East Asian typography. 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="style:punctuation-wrap"> <choice> <value>simple</value> <value>hanging</value> </choice> </attribute> </optional> </define>

15.5.34 Line Break Use the style:line-break property to select the set of line breaking rules to use for text. If the value is strict, line breaks are forbidden between certain user and application configurable characters. If the value is normal, line breaks may occur between arbitrary characters. 14895 14896 14897 14898 14899 14900

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="style:line-break"> <choice> <value>normal</value> <value>strict</value>

1 May 2005 Page 590 of 706

14901 14902 14903 14904

</choice> </attribute> </optional> </define>

15.5.35 Vertical Alignment The style:vertical-align property specifies the vertical position of a character. By default characters are aligned according to their baseline, which is the default for most European languages. This is also the alignment used in this specification. Alternatively, characters may be vertically aligned as follows: •

bottom — To the bottom of the line.

•

top —To the top of the line.

•

middle —To the center of the line.

•

auto — Automatically, which sets the vertical alignment to suit the text rotation. Text that is rotated 0 or 90 degrees is aligned to the baseline, while text that is rotated 270 degrees is aligned to the center of the line.

The following graphic illustrates the effect of the vertical alignment property when it is set to baseline, top, bottom, and center respectively.

mgk mgk 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916

mgk mgk

<define name="style-paragraph-properties-attlist" combine="interleave"> <optional> <attribute name="style:vertical-align" a:defaultValue="auto"> <choice> <value>top</value> <value>middle</value> <value>bottom</value> <value>auto</value> </choice> </attribute> </optional> </define>

15.5.36 Writing Mode The style:writing mode attribute specifies the writing mode of a paragraph. The attribute is similar to the writing-mode attribute specified in §7.27.7 of [XSL], except hat it has the additional value page. This value specifies that the writing mode is inherited from the page that contains the paragraph. 14917 14918 14919

14920 14921 14922 14923 14924 14925 14926 14927

1 May 2005 Page 591 of 706

14928 14929 14930 14931 14932 14933 14934 14935 14936

15.5.37 Automatic Writing Mode If the style:writing-mode-automatic attribute is given for a paragraph and if its value is true, then an application is allowed to recalculate the writing mode of the paragraph based on it's content whenever the content changes. The actual value for the writing-mode should be contained in style:writing-mode attribute, so that applications that do not support an automatic writing mode calculation or use a different algorithm always know the actual value. By specifying a fo:text-align='start' attribute additionally, the text alignment can be adapted to the writing mode simultaneously. 14937 14938 14939 14940 14941 14942 14943

15.5.38 Snap To Layout The style:snap-to layout-grid attribute specifies whether the paragraph should consider the layout grid settings of the page. See section 15.2.21. 14944 14945 14946 14947 14948 14949 14950

15.5.39 Page Number If a paragraph style specifies a master page that should be applied beginning from the start of the paragraph, the style:page-number attribute specifies the page number that should be used for new page. 14951 14952 14953

14954 14955 14956 14957 14958 14959 14960 14961

1 May 2005 Page 592 of 706

15.5.40 Background Transparency 14962 14963 14964 14965 14966 14967 14968

15.6 Ruby Text Formatting Properties The properties described in this section can be used within ruby styes (see section 14.8.4 for details). They are contained in a <style:ruby-properties> element. 14969 14970 14971 14972 14973

14974 14975 14976 14977

14978 14979 14980 14981 14982

14983 14984 14985 14986

15.6.1 Ruby Position This property specifies the position of the ruby text relative to the ruby base. 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996

<define name="style-ruby-properties-attlist" combine="interleave"> <optional> <attribute name="style:ruby-position"> <choice> <value>above</value> <value>below</value> </choice> </attribute> </optional> </define>

15.6.2 Ruby Alignment This property specifies the alignment of the ruby text relative to the ruby base. 14997 14998 14999 15000 15001 15002 15003 15004 15005

<define name="style-ruby-properties-attlist" combine="interleave"> <optional> <attribute name="style:ruby-align"> <choice> <value>left</value> <value>center</value> <value>right</value> <value>distribute-letter</value> <value>distribute-space</value>

1 May 2005 Page 593 of 706

15006 15007 15008 15009

</choice> </attribute> </optional> </define>

15.7 Section Formatting Properties The properties described in this section can be used within section styes (see section 14.8.3 for details). They are contained in a <style:section-properties> element. 15010 15011 15012 15013 15014

15015 15016 15017 15018

15019 15020 15021 15022 15023

15.7.1 Section Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the section. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 15024 15025 15026 15027 15028 15029

15.7.2 Margins The margins attributes fo:margin-left and fo:margin-right specify the size of the section margins. See sections 15.5.17 for detailed information on these attributes. Percentage values are not supported. 15030 15031 15032

15.7.3 Columns The <style:columns> element contains <style:column> elements that specify each column individually (see section 15.7.4). If these elements are not present, all columns are assigned the same width. The <style:columns> can contain a <style:column-sep> element that describes the separator line between columns. See section 15.7.5 for information on this element. 15033

1 May 2005 Page 594 of 706

15034 15035

15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049

The attributes that may be associated with the <style:columns> element are: •

Column count

•

Column gap

Column Count The fo:columns-count attribute specifies the number of columns in a section. 15050 15051 15052 15053 15054

Note: This attribute has the same name as an [XSL] property but it is attached to a different element.

Column Gap If the <style:columns> element does not contain individual <style:column> elements, then the gap between columns may be specified by the fo:column-gap attribute. If there are individual column elements, this attribute is ignored. 15055 15056 15057 15058 15059 15060 15061

Note: This attribute has the same name as an [XSL] property but it is attached to a different element.

15.7.4 Column Specification The <style:column> element can be contained in a <style:columns> element, to specify details of an individual column. This element is contained in the <styles:columns> element. There can be either no column elements or there can be the same number of column elements as specified by the fo:column-count attribute.

1 May 2005 Page 595 of 706

15062 15063 15064 15065 15066

Note: In [XSL], it is not possible to specify columns individually. The attributes that may be associated with the <style:column> element are: •

Column width

•

Column left, right, upper, and lower space

Column Width Use the style:rel-width attribute to specify the width of a column. The column widths are specified as number values instead of lengths. To get the absolute column width, the space that is available for a columned area is distributed among the columns proportional to these numbers. The column width is not specified in a percentage length, but rather in terms of relative weights, that is, a number followed by a '*' character. The total space available for the entire table is distributed among its columns according to its relative widths. For example, if three columns are assigned the relative widths 1, 2 and 3, then the first column will take up 1/6 of the available width, the second will take up 1/3, and the last column will take up 1/2 of the available space. To achieve these figures, all given relative widths must be summed up (six in the example), and then each column will get as much space as the proportion of its own relative width to the sum of all relative widths indicates (3/6 = 1/2 for the last column in the example). 15067 15068 15069 15070 15071

Column Left, Right, Upper, and Lower Space For each column, its left, right, upper, and lower space may be specified. The right space of a column together with the left space of the next column corresponds to the gap between two columns. If a columned area contains a separator line between columns, the space that is occupied by the line is contained within the left and right spaces and therefore is not added to them. 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089

1 May 2005 Page 596 of 706

15090 15091 15092 15093 15094 15095 15096 15097 15098 15099

</attribute> </optional> </define> <define name="style-column-attlist" combine="interleave"> <optional> <attribute name="fo:space-after" a:defaultValue="0cm"> <ref name="length"/> </attribute> </optional> </define>

15.7.5 Column Separator The <style:column-sep> element specifies the separator line to use between columns. This element can be contained in a <style:columns> element to specify the type of separator line to use between columns. 15100 15101 15102 15103 15104

Note: [XSL] does not support column separators. The attributes that may be associated with the <style:column-sep> element are: •

Line style

•

Line width

•

Line height

•

Vertical line alignment

•

Line color

Line Style Use the style:style attribute to specify the line style of the column separator line. 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117

<define name="style-column-sep-attlist" combine="interleave"> <optional> <attribute name="style:style" a:defaultValue="solid"> <choice> <value>none</value> <value>solid</value> <value>dotted</value> <value>dashed</value> <value>dot-dashed</value> </choice> </attribute> </optional> </define>

Line Width Use the style:width attribute to specify the width of the column separator line. 15118 15119 15120

1 May 2005 Page 597 of 706

15121 15122

</attribute> </define>

Line Height Use the style:height to specify the height of the column separator line. The value of this attribute is a percentage that relates to the height of the columned area. 15123 15124 15125 15126 15127 15128 15129

Vertical Line Alignment Use the style:vertical-align attribute to specify how to vertically align a line that is less than 100% of its height within the columned area. The value of this attribute can be either top, middle, or bottom. 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140

<define name="style-column-sep-attlist" combine="interleave"> <optional> <attribute name="style:vertical-align" a:defaultValue="top"> <choice> <value>top</value> <value>middle</value> <value>bottom</value> </choice> </attribute> </optional> </define>

Line Color Use the style:color attribute to specify the color of the column separator line. 15141 15142 15143 15144 15145 15146 15147

15.7.6 Protect Sections marked with the style:protect attribute should not be changed. The user interface should prevent the user from manually making any changes. The style:protect attribute should be set by default for linked sections or indexes. Removing the protection makes these sections accessible to the user, but updating the links or the index will not preserve the changes. 15148 15149 15150 15151 15152 15153 15154

1 May 2005 Page 598 of 706

15.7.7 Don't Balance Text Columns The text:dont-balance-text-columns attribute specifies whether the text column content should be evenly distributed over all text columns or not. 15155 15156 15157 15158 15159 15160 15161

15.7.8 Writing Mode The style:writing-mode attribute specifies the writing mode that should be used for the section. See section 15.5.36 for details. 15162 15163 15164

15.7.9 Notes Configuration A section style may contain have its own notes configurations (see section 14.9.2). If this is the case, notes of the corresponding notes type are displayed at the end of the columns of the section or the section itself instead of the end of the page's columns or the end of the document. 15165 15166 15167 15168 15169

15.8 Table Formatting Properties The properties described in this section can be contained within table styles (see section 14.12.1) They are contained in a <style:table-properties> element. 15170 15171 15172 15173 15174

15175 15176 15177 15178

15179 15180 15181 15182 15183

15.8.1 Table Width Every table must have a fixed width. This width is specified by the style:width attribute. The width of a table may be also specified relative to the width of the area that the table is in. In this case, the width is specified as a percentage using the style:rel-width attribute. User

1 May 2005 Page 599 of 706

agents that support specifying the relative width of a table can specify widths in this way, but it is not essential. The reasons why every table must have a fixed width and relative widths are only an option are as follows: •

Specifying the width of a table by a percentage is useful for current web browsers and other applications where the percentage is relative to the width of a window. But it may cause problems if the percentage relates to a fixed paper width.

•

Relative widths can also cause problems for applications such as spreadsheet applications, where there is no requirement for a table to fit on a page.

However, if an application supports relative widths, it is relatively easy to program the application to calculate a fixed table width, based on a percentage. 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195

15.8.2 Table Alignment A table alignment property table:align specifies the horizontal alignment of a table. The options for a table alignment property are as follows: left — The table aligns to the left. center — The table aligns to the center. right — The table aligns to the right. margins — The table fills all the space between the left and right margins. User agents that do not support the margins value, may treat this value as left. • • • • 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207

<define name="style-table-properties-attlist" combine="interleave"> <optional> <attribute name="table:align"> <choice> <value>left</value> <value>center</value> <value>right</value> <value>margins</value> </choice> </attribute> </optional> </define>

15.8.3 Table Left and Right Margin The fo:margin-left and fo:margin-right properties specify the distance of the table from the left and right margins. See section 15.5.17 for a full explanation of left and right margin properties. An application may recognize table margins, but this is not essential.

1 May 2005 Page 600 of 706

Tables that align to the left or to the center ignore right margins, and tables align to the right or to the center ignore left margins. 15208 15209 15210

15.8.4 Table Top and Bottom Margin The fo:margin-top and fo:margin-bottom properties specify the distance of the table from the top and bottom. See section 15.5.20 for a full explanation of top and bottom margin properties. 15211 15212 15213

15.8.5 Table Margins The fo:margin property specifies the distance of the table from the left, right, top and bottom. See section 15.5.21 for a full explanation of this property. 15214 15215 15216

15.8.6 Page Number If the table style specifies a master page that should be applied beginning from the start of the table, the style:page-number attribute specifies the page number that should be used for the first page of the table. See also section 15.5.39. 15217 15218 15219

15.8.7 Break Before and Break After The fo:break-before and fo:break-after properties insert a page or column break before or after a table. See section 15.5.22 for a full explanation of these properties. 15220 15221 15222

15.8.8 Table Background and Background Image The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the table. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 15223 15224 15225 15226 15227 15228

1 May 2005 Page 601 of 706

15.8.9 Table Shadow The style:shadow property specifies that a shadow visual effect appears on a table. See section 15.5.28 for a full explanation of this property. 15229 15230 15231

15.8.10 Keep with Next The fo:keep-with-next property specifies that a table stays with the paragraph that follows it. See section 15.5.29 for a full explanation of this property. 15232 15233 15234

15.8.11 May Break Between Rows The style:may-break-between-rows property specifies that a page break may occur inside a table. 15235 15236 15237 15238 15239 15240 15241

15.8.12 Border Model Property The table:border-model property specifies what border model to use when creating a table with a border. There are two types of border model, as follows: •

Collapsing border model When two adjacent cells have different borders, the wider border appears as the border between the cells. Each cell receives half of the width of the border.

•

Separating border model Borders appear within the cell that specifies the border.

Both border models are very similar to the collapsing and separating border models of [XSL] and [CSS2]. They differ in how border widths relate to row and column widths. In OpenDocument, a row height or column width includes any space required to display borders or padding. This means that, while the width and height of the content area is less than the column width and row height, the sum of the widths of all columns is equal to the total width of the table. In XSL and CSS2, a column width or row height specifies the width or height of the content area of a cell. This means that the sum of the widths of all columns is less than the width of the table. 15242 15243 15244 15245

1 May 2005 Page 602 of 706

15246 15247 15248 15249 15250 15251

<value>collapsing</value> <value>separating</value> </choice> </attribute> </optional> </define>

15.8.13 Writing Mode The style:writing-mode attribute specifies the writing mode that should is used for the table. See section 15.5.36 for details. 15252 15253 15254

15.8.14 Display The table:display attribute specifies whether or not a table is displayed. 15255 15256 15257 15258 15259 15260 15261

15.9 Column Formatting Properties The properties described in this section can be contained within table column styles (see section 14.12.2) They are contained in a <style:table-column-properties> element. 15262 15263 15264 15265 15266

15267 15268 15269 15270

15271 15272 15273 15274 15275

15276 15277 15278 15279

15.9.1 Column Width Every table column must have a fixed width. This width is specified by the style:columnwidth attribute. The width of a column may be also specified relative to the other column widths. Applications that support specifying the relative width of a column may specify widths in this way, but it is not essential.

1 May 2005 Page 603 of 706

A relative width is specified by the style:rel-column-width property that takes a number value, followed by a '*' character. If rc is the relative with of the column, rs the sum of all relative columns widths, and ws the absolute width that is available for these columns, then the absolute with wc of the column is wc=rcws/rs. 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291

15.9.2 Optimal Table Column Width The style:use-optimal-column-width attribute specifies that the column width should be recalculated automatically if some content in the column changes. 15292 15293 15294 15295 15296 15297 15298

15.9.3 Break Before and Break After The fo:break-before and fo:break-after properties insert a page or column break before or after a table column. See section 15.5.22 for a full explanation of these properties. 15299 15300 15301

15.10 Table Row Formatting Properties The properties described in this section can be contained within table column styles (see section 14.12.3) They are contained in a <style:table-column-properties> element. 15302 15303 15304 15305 15306

15307 15308 15309 15310

15311 15312 15313 15314 15315

1 May 2005 Page 604 of 706

15.10.1 Row Height The style:row-height and style:min-row-height properties specifies the height of a table row. By default, the row height is the height of the tallest item in the row. The style:row-height property specifies a fixed row height, while the style:min-rowheight property specifies a fixed height. 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327

15.10.2 Optimal Table Row Height The style:use-optimal-row-height attribute specifies that the row height should be recalculated automatically if some content in the row changes. 15328 15329 15330 15331 15332 15333 15334

15.10.3 Row Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the table. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 15335 15336 15337 15338 15339 15340

15.10.4 Break Before and Break After The fo:break-before and fo:break-after properties insert a page or column break before or after a table column. See section 15.5.22 for a full explanation of these properties. 15341 15342 15343

1 May 2005 Page 605 of 706

15.10.5 Keep Together Use the fo:keep-together property to control whether the contents of a table cell should be kept together on the same page or column (if the value is always), or whether breaks are allowed within the cell (if the value is auto). See §7.19.3 of [XSL] for details. 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353

<define name="style-table-row-properties-attlist" combine="interleave"> <optional> <attribute name="fo:keep-together"> <choice> <value>auto</value> <value>always</value> </choice> </attribute> </optional> </define>

15.11 Table Cell Formatting Properties The properties described in this section can be contained within table cell styles (see section 14.12.4) They are contained in a <style:table-column-properties> element. 15354 15355 15356 15357 15358

15359 15360 15361 15362

15363 15364 15365 15366 15367

15.11.1 Vertical Alignment The vertical alignment property style:vertical-align is used to specify the vertical alignment of text in a table cell. The options for the vertical alignment property are as follows: • • • • 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379

top — Aligns text vertically with the top of the cell. middle — Aligns text vertically with the middle of the cell. bottom — Aligns text vertically with the bottom of the cell. automatic – The application decide how to align the text.

<define name="style-table-cell-properties-attlist" combine="interleave"> <optional> <attribute name="style:vertical-align"> <choice> <value>top</value> <value>middle</value> <value>bottom</value> <value>automatic</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 606 of 706

15.11.2 Text Align Source The style:text-align-source property specifies the source of the text-align property. If the value of this attribute is fix, the value of the fo:text-align property is used. If the value is value-type, the text alignment depends on the value-type of the cell. 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389

<define name="style-table-cell-properties-attlist" combine="interleave"> <optional> <attribute name="style:text-align-source"> <choice> <value>fix</value> <value>value-type</value> </choice> </attribute> </optional> </define>

15.11.3 Direction The style:direction property specifies the direction of characters in a cell. The most common direction is left to right (ltr). The other direction is top to bottom (ttb), where the characters in the cell are stacked but not rotated. 15390 15391 15392

15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403

15.11.4 Vertical Glyph Orientation The style:glyph-orientation-vertical property specifies the vertical glyph orientation. The property specifies an angle or automatic mode. The only possible angle is 0, which disables this feature. 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413

15.11.5 Cell Shadow The style:shadow property specifies that a shadow visual effect appears on a table cell. See section 15.5.28 for a full explanation of this property. 15414

1 May 2005 Page 607 of 706

15415 15416

15.11.6 Cell Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the table cell. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 15417 15418 15419 15420 15421 15422

15.11.7 Cell Border The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-left and fo:border-right specify the border properties of the table cell. See section 15.5.25 for detailed information on these attributes. 15423 15424 15425

15.11.8 Diagonal Lines Spreadsheet cells can also have diagonal lines, which follow the same specification as borders. style:diagonal-tl-br defines the style of "border" to use for the topleft-bottomright diagonal (see section 15.5.25 for detailed information). In case of a double line, style:diagonal-bl-tr-widths allows to specify the width of the inner and outer lines and the distance between them (see section 15.5.26 for detailed information). style:diagonal-bl-tr and style:diagonal-tl-br-widths define the same properties for the bottomleft-topright diagonal. 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447

1 May 2005 Page 608 of 706

15.11.9 Border Line Width The border line width attributes style:border-line-width, style:border-line-widthtop, style:border-line-width-bottom, style:border-line-width-left and style:border-line-width-right specify the properties of the border lines of the page. See section 15.5.26 for detailed information on these attributes. 15448 15449 15450

15.11.10 Padding The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the table cell. See section 15.5.27 for detailed information on these attributes. 15451 15452 15453

15.11.11 Wrap Option The fo:wrap-option property specifies whether text wraps within a table cell. See §7.5.13 of [XSL] for details. If wrapping is disabled, the application determines whether the clipped text is visible or hidden. If the text is hidden applications may support a scrolling mechanism to access the text. This is similar to setting a fo:overflow property to a value of auto. See also §7.20.2 of [XSL]. 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463

15.11.12 Rotation Angle The style:rotation-angle property specifies the rotation angle of the cell content in degrees. 15464 15465 15466

15467 15468 15469 15470 15471 15472 15473 15474

1 May 2005 Page 609 of 706

15.11.13 Rotation Align The style:rotation-align property specifies how the edge of the text in a cell is aligned after a rotation. There are four alignment options: "none", "bottom", "top", or "center". Alignment

Text is...

Borders and background are...

None.

Rotated.

Unchanged.

Bottom of the cell.

Rotated and may overlap with other cells if the text is longer than the length of the cell.

Positioned parallel to the text, whereby the upper or lower edge is drawn at the original position of the cell.

Top of the cell. Center of the cell. 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486

<define name="style-table-cell-properties-attlist" combine="interleave"> <optional> <attribute name="style:rotation-align"> <choice> <value>none</value> <value>bottom</value> <value>top</value> <value>center</value> </choice> </attribute> </optional> </define>

15.11.14 Cell Protect The style:cell-protect property specifies how a cell is protected. This attribute is only evaluated if the current table is protected (see section 8.1.1). The value of the attribute can be "none", "hidden-and-protected", or a space-separated list containing the values "protected" or "formula-hidden". 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504

<define name="style-table-cell-properties-attlist" combine="interleave"> <optional> <attribute name="style:cell-protect"> <choice> <value>none</value> <value>hidden-and-protected</value> <list> <oneOrMore> <choice> <value>protected</value> <value>formula-hidden</value> </choice> </oneOrMore> </list> </choice> </attribute> </optional> </define>

15.11.15 Print Content The style:print-content property specifies whether or not the cell content is printed. 15505

1 May 2005 Page 610 of 706

15506 15507 15508 15509 15510 15511

15.11.16 Decimal places The style:decimal-places attribute specifies the maximum number of decimal places that are displayed if numbers are formatted by a data style that has no setting for number of decimal places itself. See also section 14.7.9. This property is usually only evaluated if it is contained in a default style (see section 14.2). 15512 15513 15514 15515 15516 15517 15518

15.11.17 Repeat Content The style:repeat-content property specifies whether the content of a cell is displayed as many times as there is space left in the cell's writing direction. Only full instances of the text are displayed. The property has no effect for cell content that contains a line break. This property is for instance used to "fill" a table cell with "-" or "x" characters so that no other data can be entered. 15519 15520 15521 15522 15523 15524 15525

15.11.18 Shrink To Fit The style:shrink-to-fit property specifies whether the content of a cell, if necessary, gets shrunk to fit into the cell. Shrinking does mean that the cell's font size is decreased, so that the complete text fits into the cell. The property has no effect on cells where the cell content fits already into the cell. 15526 15527 15528 15529 15530 15531 15532

15.12 List-Level Style Properties The properties described in this section can be contained within the various list style level elements (see section 14.10). They are contained in a <style:list-level-properties> element.

1 May 2005 Page 611 of 706

15533 15534 15535 15536 15537

15538 15539 15540 15541

15542 15543 15544 15545 15546 15547 15548 15549 15550

Label Alignment The fo:text-align attribute specifies the horizontal alignment of a label (number) within the width specified by the text:min-label-width attribute. See also section 15.5.5, 15551 15552 15553

Start Indent The text:space-before attribute specifies the space to include before the number for all paragraphs at this level. If a paragraph has a left margin that is greater than 0, the actual position of the list label box is the left margin width plus the start indent value. This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element. The value of the attribute is an absolute value. This means that when the position of a label is calculated the start indent value of the current level is only considered. The start indent values for lower levels do not affect the label position. 15554 15555 15556 15557 15558 15559 15560

Minimum Label Width The text:min-label-width attribute specifies the minimum width of a number. This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element. The label can be aligned horizontally with the width using an fo:text-align property. See the Label Alignment attribute below for more information. 15561 15562

1 May 2005 Page 612 of 706

15563 15564 15565 15566 15567

Minimum Label Distance The text:min-label-distance attribute specifies the minimum distance between the number and the text of the list item. This attribute can be associated with an item set element that is contained in a <text:listlevel-style-*> element. 15568 15569 15570 15571 15572 15573 15574

Font Name The style:font-name attribute species the name of a font that is used to display a bullet character. See also section 15.4.13. 15575 15576 15577 15578 15579 15580 15581

Image Size The size of the image is specified by the following attributes: 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593

Vertical Alignment The vertical alignment of the image is specified by the style:vertical-pos and style:vertical-rel properties. See sections 15.27.11 and 15.27.12 for details. 15594 15595 15596 15597

1 May 2005 Page 613 of 706

15.13 Stroke Properties The following stroke properties are used to define drawing object line characteristics. They are available for drawing objects contained in all kinds of applications. •

Style

•

Dash

•

Width

•

Color

•

Start marker

•

End marker

•

Start marker width

•

End marker width

•

Start marker center

•

End marker center

•

Opacity

•

Joint

The properties described in this section can be contained within style elements <style:style> whose family is either graphic or presentation. They are contained in a <style:graphicproperties> element.

15.13.1 Stroke Style The attribute draw:stroke specifies the style of the stroke on the current object. The value none means that no stroke is drawn, and the value solid means that a solid stroke is drawn. If the value is dash, the stroke referenced by the draw:stroke-dash property is drawn. 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:stroke"> <choice> <value>none</value> <value>dash</value> <value>solid</value> </choice> </attribute> </optional> </define>

15.13.2 Dash The attribute draw:stroke-dash specifies the dash style that is used for the stroke. See section 14.14.7 for dash styles. 15609 15610 15611 15612 15613

1 May 2005 Page 614 of 706

15614 15615

</optional> </define>

15.13.3 Multiple Dashes The attribute draw:stroke-dash-names specifies a list of dash styles that are used for the stroke in addition to the dash specified by the draw:stroke-dash attribute. See section 15.13.2 for the draw:stroke-dash attribute and section 14.14.7 for dash styles. 15616 15617 15618 15619 15620 15621 15622

15.13.4 Width The attribute svg:stroke-width specifies the width of the stroke on the current object. 15623 15624 15625 15626 15627 15628 15629

15.13.5 Color The attribute svg:stroke-color specifies the color of the stroke on the current object. 15630 15631 15632 15633 15634 15635 15636

15.13.6 Start Marker The attribute draw:marker-start specifies a line start marker, which is a path that can be connected to the start of a stroke. See section 14.14.6 for markers. 15637 15638 15639 15640 15641 15642 15643

15.13.7 End Marker The attribute draw:marker-end specifies a stroke end marker, which is a path that can be connected to the end of a stroke. See section 14.14.6 for markers.

1 May 2005 Page 615 of 706

15644 15645 15646 15647 15648 15649 15650

15.13.8 Start Marker Width The attribute draw:marker-start-width specifies the width of the marker at the start of the stroke. 15651 15652 15653 15654 15655 15656 15657

15.13.9 End Marker Width The attribute draw:marker-end-width specifies the width of the marker at the end of the stroke. 15658 15659 15660 15661 15662 15663 15664

15.13.10 Start Marker Center The attribute draw:marker-start-center specifies whether or not a start marker is centered at the start of a stroke. 15665 15666 15667 15668 15669 15670 15671

15.13.11 End Marker Center The attribute draw:marker-end-center specifies whether or not an end marker is centered at the end of a stroke. 15672 15673 15674 15675 15676 15677 15678

1 May 2005 Page 616 of 706

15.13.12 Opacity The attribute svg:stroke-opacity specifies the opacity of a stroke. The value of this attribute can be a number between 0 (fully transparent) and 1 (fully opaque) or a percentage. 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691

15.13.13 Line Join The attribute draw:stroke-linejoin specifies the shape at the corners of paths or other vector shapes, when they are stroked. The values are the same as for [SVG]'s strokelinejoin attribute, except that the attribute in addition to the values supported by SVG may have the value middle, which means that the mean value between the joints is used. 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:stroke-linejoin"> <choice> <value>miter</value> <value>round</value> <value>bevel</value> <value>middle</value> <value>none</value> <value>inherit</value> </choice> </attribute> </optional> </define>

15.14 Fill Properties The following fill properties are used to define drawing object fill characteristics. They are available for drawing objects contained in all kinds of applications. •

Style

•

Color

•

Gradient

•

Gradient step count

•

Hatch

•

Solid hatch

•

Bitmap

•

Opacity

1 May 2005 Page 617 of 706

•

Fill rule

15.14.1 Fill Style The attribute draw:fill specifies the fill style for a graphic object. Graphic objects that are not closed, such as a path without a closepath at the end, will not be filled. The fill operation does not automatically close all open subpaths by connecting the last point of the subpath with the first point of the subpath before painting the fill. The attribute has the following values:

15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718

•

none: the drawing object is not filled.

•

solid: the drawing object is filled with color specified by the draw:fill-color attribute.

•

bitmap: the drawing object is filled with the bitmap specified by the draw:fill-imagename attribute.

•

gradient: the drawing object is filled with the gradient specified by the draw:fillgradient-name attribute.

•

hatch: the drawing object is filled with the hatch specified by the draw:fill-hatch-name attribute.

<define name="style-graphic-fill-properties-attlist" combine="interleave"> <optional> <attribute name="draw:fill"> <choice> <value>none</value> <value>solid</value> <value>bitmap</value> <value>gradient</value> <value>hatch</value> </choice> </attribute> </optional> </define>

15.14.2 Color The attribute draw:fill-color specifies the color of the fill for a graphic object. It is used only if the draw:fill attribute has the value solid. 15719 15720 15721 15722 15723 15724 15725

15.14.3 Secondary Fill Color The draw:secondary-fill-color attribute specifies the secondary fill color. It may be used as fill color for the extrusion. 15726 15727 15728 15729 15730 15731

1 May 2005 Page 618 of 706

15732

</define>

15.14.4 Gradient The attribute draw:fill-gradient-name specifies a gradient style that is used for filling graphic objects. It is used only if the draw:fill attribute has the value gradient. See section 14.14.1 and 14.14.2 for gradients. 15733 15734 15735 15736 15737 15738 15739

15.14.5 Gradient Step Count If a gradient is used for filling, the attribute draw:gradient-step-count can be used to set the gradient step count of the color interpolation to be a fixed value. By default, the step count is automatically calculated based on the size and resolution of the filled area. A step count less than 3 is not valid as there would be no interpolation possible. Values above 256 may not be supported or may result in performance issues. 15740 15741 15742 15743 15744 15745 15746

15.14.6 Hatch The attribute draw:fill-hatch-name specifies a hatch style that is used for filling. It is used only if the draw:fill attribute has the value hatch. See section 14.14.3 for hatches. 15747 15748 15749 15750 15751 15752 15753

15.14.7 Solid Hatch The attribute draw:fill-hatch-solid specifies whether the background of a hatch filling is solid or transparent. 15754 15755 15756 15757 15758 15759 15760

1 May 2005 Page 619 of 706

15.14.8 Fill Image The attribute draw:fill-image-name specifies a fill image that is used for filling. It is used only if the draw:fill attribute has the value bitmap. See section 14.14.4 for fill images. 15761 15762 15763 15764 15765 15766 15767

15.14.9 Fill Image Rendering Style If an image is used for filling, the bitmap image can either be rendered in the given size, stretched to the filled area, or tiled over the area. The attribute style:repeat specifies how the bitmap image should be treated. The value of the attribute can be no-repeat, repeat, or stretch. 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778

<define name="style-graphic-fill-properties-attlist" combine="interleave"> <optional> <attribute name="style:repeat"> <choice> <value>no-repeat</value> <value>repeat</value> <value>stretch</value> </choice> </attribute> </optional> </define>

15.14.10 Fill Image Size If an image is used for filling, the optional attributes draw:fill-image-width and draw:fill-image-height can be used to override the logical size of the source image data. If the value of the style:repeat attribute is stretch, these attributes are ignored. 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796

1 May 2005 Page 620 of 706

15.14.11 Fill Image Tile Reference Point If an image is used for filling, the attributes draw:fill-image-ref-point, draw:fillimage-ref-point-x and draw:fill-image-ref-point-y specify the reference position of the image. The draw:fill-image-ref-point attribute specifies the position as an alignment of the image within the filling area, while the draw:fill-image-ref-point-x and draw:fill-image-ref-point-y attributes specify an horizontal and vertical movement as percentage values, where the percentage value relates to the image width and height. If an alignment and a movement is specified at the same time, the image first is aligned and afterwards moved. These attributes are only interpreted if the value of the current style:repeat attribute is repeat. 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823

<define name="style-graphic-fill-properties-attlist" combine="interleave"> <optional> <attribute name="draw:fill-image-ref-point-x"> <ref name="percent"/> </attribute> </optional> <optional> <attribute name="draw:fill-image-ref-point-y"> <ref name="percent"/> </attribute> </optional> <optional> <attribute name="draw:fill-image-ref-point"> <choice> <value>top-left</value> <value>top</value> <value>top-right</value> <value>left</value> <value>center</value> <value>right</value> <value>bottom-left</value> <value>bottom</value> <value>bottom-right</value> </choice> </attribute> </optional> </define>

15.14.12 Fill Image Tile Translation If an image is used for filling, the attribute draw:tile-repeat-offset defines the translation of each tile in relation to the previous tile. This attribute is only interpreted if the value of the current style:repeat attribute is tiled. The value of this attribute is a percentage value representing the tiles repeat offset relative to the tiles height or width, followed by either the word horizontal or vertical. 15824 15825 15826 15827 15828

Example: Tile translation <style:graphic-properties draw:tile-repeat-offset="50% horizontal"/>

1 May 2005 Page 621 of 706

15.14.13 None and Linear Opacity The fill area of a graphic object can either have a full, a linear, or gradient opacity. Full and linear opacity is selected using the draw:opacity attribute, while gradient opacity is selected using the draw:opacity-name attribute. The draw:opacity attribute disables any transparency effect or sets a linear opacity for the fill area of a graphic object. 15829 15830 15831 15832 15833 15834 15835

15.14.14 Gradient Opacity The draw:opacity-name attribute specifies an opacity gradient that defines the opacity for the fill area of a graphic object. When applying an opacity gradient, the opacity is interpolated as defined in the referenced opacity gradient style. This fill style is rendered independently from other fill styles like gradient, image, and hatch. See section 14.14.5 for opacity gradients. The value of this attribute overrides the draw:opacity attribute. 15836 15837 15838 15839 15840 15841 15842

15.14.15 Fill Rule The svg:fill-rule specifies the algorithm which is to be used to determine what parts of the canvas are included inside the shape. See §11.3 of [SVG] for more details. 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852

<define name="style-graphic-fill-properties-attlist" combine="interleave"> <optional> <attribute name="svg:fill-rule"> <choice> <value>nonzero</value> <value>evenodd</value> </choice> </attribute> </optional> </define>

15.14.16 Symbol color The draw:symbol-color attribute defines the color to be used to draw symbols contained on the drawing object. This could be for instance arrows displayed within a control. 15853 15854 15855 15856 15857 15858

1 May 2005 Page 622 of 706

15859

</define>

15.15 Text Animation Properties Drawing objects that contain text and text boxes can have optional text animation properties. These properties always animate the complete text of a drawing object or text frame. The following attributes define the text animation: •

Animation

•

Animation direction

•

Animation start inside

•

Animation stop inside

•

Animation repeat

•

Animation delay

•

Animation setps

These properties are available for drawing objects contained in all kinds of applications.

15.15.1 Animation The attribute text:animation specifies the type of animation that is used for the text. The value of this attribute can be one of the following:

15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871

•

none, disables the text animation.

•

scroll, scrolls the text from one side to another.

•

alternate, scrolls the text from one side to another and back.

•

slide, scrolls the text from one side to the original text position and stops there.

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="text:animation"> <choice> <value>none</value> <value>scroll</value> <value>alternate</value> <value>slide</value> </choice> </attribute> </optional> </define>

15.15.2 Animation Direction The attribute text:animation-direction specifies the scroll direction of animated text. 15872 15873 15874 15875 15876 15877

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="text:animation-direction"> <choice> <value>left</value> <value>right</value>

1 May 2005 Page 623 of 706

15878 15879 15880 15881 15882 15883

15.15.3 Animation Start Inside If this attribute text:animation-start-inside is true, the text starts its animation inside the shape. If its false, the text starts its animation just outside the shapes bounding rectangle. 15884 15885 15886 15887 15888 15889 15890

15.15.4 Animation Stop Inside If this attribute text:animation-stop-inside is true, the text stops when it is inside the the shape. If its false, the text stops its animation just outside the shapes bounding rectangle. 15891 15892 15893 15894 15895 15896 15897

15.15.5 Animation Repeat The attribute text:animation-repeat specifies the number of times the animation is repeated. If the value of the attribute is 0, the animation is repeated indefinitely. 15898 15899 15900 15901 15902 15903 15904

15.15.6 Animation Delay The attribute text:animation-delay specifies a delay before the animation is started. The value of this attribute must conform to the time period format described in §3.2.6 of [xmlschema2]. 15905 15906 15907 15908 15909 15910 15911

1 May 2005 Page 624 of 706

15.15.7 Animation Steps The attribute text:animation-steps specifies the distance by which text is moved within each scrolling step. 15912 15913 15914 15915 15916 15917 15918

15.16 Text and Text Alignment Properties Drawing objects that contain text and text boxes can have optional properties that specify how the text is aligned within the drawing object. These properties are available for drawing objects contained in all kinds of applications.

15.16.1 Auto Grow Width and Height The attributes draw:auto-grow-width and draw:auto-grow-height specify whether or not to automatically increase the width and height of the drawing object if text is added to the drawing object. These attributes usually are evaluated only for text boxes. 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930

15.16.2 Fit To Size The attribute draw:fit-to-size specifies whether or not to stretch the text content of a drawing object to fill the entire object. If the value of the attribute is true, the text content is stretched. 15931 15932 15933 15934 15935 15936 15937

15.16.3 Fit To Contour The attribute draw:fit-to-contour specifies whether or not to stretch the text content of a drawing object to fill the contour of the object. If the value of the attribute is true, the text content is stretched. 15938

1 May 2005 Page 625 of 706

15939 15940 15941 15942 15943 15944

15.16.4 Text Area Vertical Align The attribute draw:textarea-vertical-align specifies the vertical alignment of the text area inside a shape. 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:textarea-vertical-align"> <choice> <value>top</value> <value>middle</value> <value>bottom</value> <value>justify</value> </choice> </attribute> </optional> </define>

15.16.5 Text Area Horizontal Align The attribute draw:textarea-horizontal-align specifies the horizontal alignment of the text area inside a shape. 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:textarea-horizontal-align"> <choice> <value>left</value> <value>center</value> <value>right</value> <value>justify</value> </choice> </attribute> </optional> </define>

15.16.6 Word Wrap The fo:wrap-option attribute specifies if text is word wrapped in a shape. 15969 15970 15971 15972 15973 15974 15975 15976 15977

15978

</define>

1 May 2005 Page 626 of 706

15.16.7 List Styles The <text:list-style> element as described in section 14.10 specifies a list style that is applied to the paragraphs contained in a text box. Although the list style has a name, it is not displayed in the user interface, even if the graphic style that contains it is a common style. Including a list style element into a graphic style has the same semantics as adding a style:list-style-name attribute (see section 14.1) to the style that references a list style that is declared outside a graphic style. The inclusion of a list style element is required in cases where a common graphic style should be associated with an automatic list style. List styles contained in a graphic style can be referenced by other graphic styles using the style:list-style-name attribute. 15979 15980 15981 15982 15983

15.17 Color Properties Drawing objects that display a bitmap graphic can have optional properties that adjust the colors of the bitmap. These properties are available for drawing objects contained in all kinds of applications.

15.17.1 Color Mode The attribute draw:color-mode affects the output of colors from a source bitmap or raster graphic. 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:color-mode"> <choice> <value>greyscale</value> <value>mono</value> <value>watermark</value> <value>standard</value> </choice> </attribute> </optional> </define>

15.17.2 Color Inversion The attribute draw:color-inversion specifies whether or not the colors in the graphic shape should be inverted. 15996 15997 15998 15999 16000 16001 16002

1 May 2005 Page 627 of 706

15.17.3 Adjust Luminance The attribute draw:luminance specifies a signed percentage value that affects the output luminance of a bitmap or raster graphic. 16003 16004 16005 16006 16007 16008 16009

15.17.4 Adjust Contrast The attribute draw:contrast specifies a signed percentage value that affects the output contrast of a bitmap or raster graphic. 16010 16011 16012 16013 16014 16015 16016

15.17.5 Adjust Gamma The attribute draw:gamma specifies a value that affects the output gamma of a bitmap or raster graphic. 16017 16018 16019 16020 16021 16022 16023

15.17.6 Adjust Red The attribute draw:red specifies a signed percentage value that affects the output of the red color space of a bitmap or raster graphic. 16024 16025 16026 16027 16028 16029 16030

15.17.7 Adjust Green The attribute draw:green specifies a signed percentage value that affects the output of the green color space of a bitmap or raster graphic. 16031 16032 16033

1 May 2005 Page 628 of 706

16034 16035 16036 16037

15.17.8 Adjust Blue The attribute draw:blue specifies a signed percentage value that affects the output of the blue color space of a bitmap or raster graphic. 16038 16039 16040 16041 16042 16043 16044

15.17.9 Adjust Opacity The attribute draw:image-opacity adjusts the opacity of an image. The value can be between 0% and 100%. See also section 15.14.13. 16045 16046 16047 16048 16049 16050 16051

15.18 Shadow Properties Most drawing objects can have a shadow. The following attributes specify how the shadow is rendered. These properties are available for drawing objects contained in all kinds of applications.

15.18.1 Shadow The attribute draw:shadow enables or disables the visibility of a shadow. 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:shadow"> <choice> <value>visible</value> <value>hidden</value> </choice> </attribute> </optional> </define>

15.18.2 Offset The attributes draw:shadow-offset-x and draw:shadow-offset-y are used to render a shadow. A copy of the shape is rendered in the single shadow color (specified by draw:shadow-color) behind the shape. The offset attributes specify the offset between the top left edge of the shape and the top left edge of the border

1 May 2005 Page 629 of 706

16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073

15.18.3 Color The attribute draw:shadow-color specifies the color in which the shadow is rendered. 16074 16075 16076 16077 16078 16079 16080

15.18.4 Opacity The attribute draw:shadow-opacity specifies the opacity in which the shadow is rendered. The value of this attribute is a percentage value. 16081 16082 16083 16084 16085 16086 16087

15.19 Connector Properties The properties described in this section are specific to connector drawing objects. These properties are available for connector drawing objects contained in all kinds of applications.

15.19.1 Start Line Spacing For standard connectors, the attributes draw:start-line-spacing-horizontal and draw:start-line-spacing-vertical increment the length of the escape line from the start shape for standard connectors. For lines connectors, these attributes specify the absolute length of the escape line from the start shape. For other connector types, they are ignored. 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097

1 May 2005 Page 630 of 706

16098 16099

</optional> </define>

15.19.2 End Line Spacing For standard connectors, the attributes draw:end-line-spacing-horizontal and draw:end-line-spacing-vertical increment the length of the escape line from the end shape. For lines connectors, they specify the absolute length of the escape line from the end shape. For other connector types, they are ignored. 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111

15.20 Measure Properties The properties described in this section are specific to measure drawing objects. These properties are available for measure drawing objects contained in all kinds of applications.

15.20.1 Line Distance The attribute draw:line-distance specifies the distance from the reference points to the measure line. 16112 16113 16114 16115 16116 16117 16118

15.20.2 Guide Overhang The guides are the two lines from the reference points to the measure line. The attribute draw:guide-overhang specifies the length that the guides are drawn after they cross the measure line. 16119 16120 16121 16122 16123 16124 16125

1 May 2005 Page 631 of 706

15.20.3 Guide Distance The attribute draw:guide-distance specifies the distance between the reference points and the start point of the guide lines. This distance does not take the attributes draw:start-guide and draw:end-guide into account, that is, the distance specified in draw:guide-distance equals the distance that is actually drawn only if draw:start-guide and draw:end-guide both are 0. 16126 16127 16128 16129 16130 16131 16132

15.20.4 Start Guide The draw:start-guide attribute specifies a length that is added to the length of the guide from the first reference point to the measure line. The guide is extended by this length at the end that points towards the reference points. 16133 16134 16135 16136 16137 16138 16139

15.20.5 End Guide The draw:end-guide attribute specifies a length that is added to the length of the guide from the second reference point to the measure line. The guide is extended by this length at the end that points towards the reference points. 16140 16141 16142 16143 16144 16145 16146

15.20.6 Placing The attribute draw:placing specifies whether the measure line is rendered below or above the edge defined by the two reference points. The value of this attribute can be below or above. 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:placing"> <choice> <value>below</value> <value>above</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 632 of 706

15.20.7 Parallel The draw:parallel attributes specifies whether the measure text is displayed parallel to the measure line or perpendicular. 16157 16158 16159 16160 16161 16162 16163

15.20.8 Text Alignment The attributes draw:measure-align and draw:measure-vertical-align determine the horizontal and vertical alignment of the measure text relative to the measure line. If value of these attributes is automatic, the application chooses the best position. 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:measure-align"> <choice> <value>automatic</value> <value>left-outside</value> <value>inside</value> <value>right-outside</value> </choice> </attribute> </optional> <optional> <attribute name="draw:measure-vertical-align"> <choice> <value>automatic</value> <value>above</value> <value>below</value> <value>center</value> </choice> </attribute> </optional> </define>

15.20.9 Unit The attribute draw:unit specifies the unit used in the textual presentation of a measure shape. 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:unit"> <choice> <value>automatic</value> <value>mm</value> <value>cm</value> <value>m</value> <value>km</value> <value>pt</value> <value>pc</value> <value>inch</value> <value>ft</value> <value>mi</value> </choice> </attribute> </optional>

1 May 2005 Page 633 of 706

16203

</define>

15.20.10 Show Unit The attribute draw:show-unit toggles the display of the unit in the textual presentation of a measure shape. 16204 16205 16206 16207 16208 16209 16210

15.20.11 Decimal Places The attribute draw:decimal-places specifies the number of decimal places that are used for the measure text. 16211 16212 16213 16214 16215 16216 16217

15.21 Caption Properties The following attributes can be used in the styles for caption shapes. These properties are available for caption objects contained in all kinds of applications. •

Type

•

Angle type

•

Angle

•

Gap

•

Escape direction

•

Escape

•

Line length

•

Fit line length

15.21.1 Type The attribute draw:caption-type specifies the geometry of the line of a caption. •

straight-line: a straight perpendicular line is drawn to the caption point.

•

angled-line: a straight line is drawn to the caption point.

•

angled-connector-line: a straight perpendicular line, followed by a straight line is drawn to the caption point.

1 May 2005 Page 634 of 706

16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:caption-type"> <choice> <value>straight-line</value> <value>angled-line</value> <value>angled-connector-line</value> </choice> </attribute> </optional> </define>

15.21.2 Angle Type The attribute draw:caption-angle-type specifies if the escape angle of the line of a caption is fixed or free. If this is set to free the application can choose the best possible angle. 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="draw:caption-angle-type"> <choice> <value>fixed</value> <value>free</value> </choice> </attribute> </optional> </define>

15.21.3 Angle The attribute draw:caption-angle specifies the escape angle of the line of a caption. It is evaluated only if draw:caption-angle-type has the value fixed. 16239 16240 16241 16242 16243 16244 16245

15.21.4 Gap The attribute draw:caption-gap specifies the distance between the text area of the caption and the start of the line. 16246 16247 16248 16249 16250 16251 16252

15.21.5 Escape Direction The attribute draw:caption-escape-direction specifies the escape direction for the line of a caption. If this is set to auto the application can choose the best direction. 16253

1 May 2005 Page 635 of 706

16254 16255 16256 16257 16258 16259 16260 16261 16262 16263

<optional> <attribute name="draw:caption-escape-direction"> <choice> <value>horizontal</value> <value>vertical</value> <value>auto</value> </choice> </attribute> </optional> </define>

15.21.6 Escape The attribute draw:caption-escape specifies the escape point of the caption line measured from the top left corner of the text area. The value can be an absolute length or an percentage. 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273

15.21.7 Line Length The attribute draw:caption-line-length specifies the length of the first caption line (i.e. the one that starts at the caption's text area). The attribute is only evaluated if draw:captionfit-line-length has the value false. 16274 16275 16276 16277 16278 16279 16280

15.21.8 Fit Line Length If the attribute draw:caption-fit-line-length is true, the application determines the best possible length for the caption line. 16281 16282 16283 16284 16285 16286 16287

15.22 3D Geometry Properties The 3D geometry properties described in this section are applicable to 3D drawing objects. These properties are available for 3D drawing objects contained in all kinds of applications.

1 May 2005 Page 636 of 706

15.22.1 Horizontal Segments If the geometry of a 3D object is generated during run-time, the dr3d:horizontal-segments attribute is used to specify the number of horizontal segments that are used to generate the geometry. Typical applications support values between 2 and 256. 16288 16289 16290 16291 16292 16293 16294

15.22.2 Vertical Segments If the geometry of a 3D object is generated during run-time, the dr3d:vertical-segments attribute is used to specify the number of vertical segments that are used to generate the geometry. Typical applications support values between 2 and 256. 16295 16296 16297 16298 16299 16300 16301

15.22.3 Edge Rounding If the geometry of a 3D object is generated during run-time, the dr3d:edge-rounding attribute is used to specify the size of an area at the edges of the geometry that is used for rounding the edges. 16302 16303 16304 16305 16306 16307 16308

15.22.4 Edge Rounding Mode The attribute dr3d:edge-rounding-mode specifies how to generate rounded edges. The value of this attribute can be correct or attractive. If the value is correct, the mathematically correct method is used. If the value is attractive, a method which preserves the visual appearance of the text is used. 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:edge-rounding-mode"> <choice> <value>correct</value> <value>attractive</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 637 of 706

15.22.5 Back Scale The attribute dr3d:back-scale specifies the proportion of the background geometry for lathe and extrude objects. For example, with a back scale of 50%, the background plane of an extrude object is half the size of the foreground plane. 16319 16320 16321 16322 16323 16324 16325

15.22.6 Depth The dr3d:depth attribute specifies the extrusion depth for extrude objects. 16326 16327 16328 16329 16330 16331 16332

15.22.7 Backface Culling The dr3d:backface-culling attribute enables or disables backface culling. 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:backface-culling"> <choice> <value>enabled</value> <value>disabled</value> </choice> </attribute> </optional> </define>

15.22.8 End Angle The attribute dr3d:end-angle specifies the rotation angle for 3D lathe objects. If it's the default (360°), the lathe object is closed and completely rotated. With smaller values it is possible to define opened lathe objects (segments). The then visible sides are closed and take into account the dr3d:back-scale and dr3d:edge-rounding attributes. With bigger values it is possible to create lathe objects with more than one rotation. This will only have a visible effect when e.g. dr3d:back-scale is used. For example, with a end angle of 270°, the lathe object will be opened by 90°. 16343 16344 16345 16346 16347 16348 16349

1 May 2005 Page 638 of 706

15.22.9 Close Front The dr3d:close-front property specifies whether a front plane shall be generated. E.g. if an ellipse is extruded, and this attribute is set, the ellipse will have an open front. The attribute can be used with extrudes and lathe objects. 16350 16351 16352 16353 16354 16355 16356

15.22.10 Close Back The dr3d:close-back property describes if a back plane shall be generated. E.g. if an ellipse is extruded, and this attribute is set, the ellipse will have an open back. The attribute can be used with extrudes and lathe objects. 16357 16358 16359 16360 16361 16362 16363

15.23 3D Lighting Properties The 3D lightning properties described in this section are applicable to 3D drawing objects. These properties are available for 3D drawing objects contained in all kinds of applications.

15.23.1 Mode The attribute dr3d:lighting-mode determines the lighting algorithm used to render the corresponding 3D object. The value of this attribute can be standard or double-sided. If the value is double-sided, the reverse sides of the objects are also lighted. 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:lighting-mode"> <choice> <value>standard</value> <value>double-sided</value> </choice> </attribute> </optional> </define>

15.23.2 Normals Kind The attribute dr3d:normals-kind specifies how the normal settings for the generated lighting. •

object: does not produce standard normals, but leaves the object-specific ones untouched.

•

flat: forces one normal per flat part

1 May 2005 Page 639 of 706

• 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384

sphere: forces normals to behave as the object would be a sphere.

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:normals-kind"> <choice> <value>object</value> <value>flat</value> <value>sphere</value> </choice> </attribute> </optional> </define>

15.23.3 Normals Direction The dr3d:normals-direction attribute is used to inverse the generated normal lighting settings. 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:normals-direction"> <choice> <value>normal</value> <value>inverse</value> </choice> </attribute> </optional> </define>

15.24 3D Texture Properties The 3D texture properties described in this section are applicable to 3D drawing objects. These properties are available for 3D drawing objects contained in all kinds of applications.

15.24.1 Generation Mode The attributes dr3d:texture-generation-mode-x and dr3d:texture-generationmode-y specify how the texture coordinates are generated.

16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408

•

object: This value specifies that the standard object projection method is used

•

parallel: This value specifies a flat parallel projection in the specified degree of freedom (X or Y).

•

sphere: This value forces projection to wrapping in X and/or Y direction

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:texture-generation-mode-x"> <choice> <value>object</value> <value>parallel</value> <value>sphere</value> </choice> </attribute> </optional> <optional> <attribute name="dr3d:texture-generation-mode-y"> <choice> <value>object</value>

1 May 2005 Page 640 of 706

16409 16410 16411 16412 16413 16414

<value>parallel</value> <value>sphere</value> </choice> </attribute> </optional> </define>

15.24.2 Kind The attribute dr3d:texture-kind is used to select whether the texture changes the luminance, intensity, or color of the shape. 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:texture-kind"> <choice> <value>luminance</value> <value>intesity</value> <value>color</value> </choice> </attribute> </optional> </define>

15.24.3 Filter The attribute dr3d:texture-filter is used to enable or disable texture filtering. 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:texture-filter"> <choice> <value>enabled</value> <value>disabled</value> </choice> </attribute> </optional> </define>

15.24.4 Mode The attribute dr3d:normals-direction is used to specify how the texture is modulated. 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:texture-mode"> <choice> <value>replace</value> <value>modulate</value> <value>blend</value> </choice> </attribute> </optional> </define>

15.25 3D Material Properties The 3D texture properties described in this section are applicable to 3D drawing objects. These properties are available for 3D drawing objects contained in all kinds of applications.

1 May 2005 Page 641 of 706

15.25.1 Colors The attributes dr3d:ambient-color, dr3d:emissive-color, dr3d:specular-color and dr3d:diffuse-color specify the four colors that define a material. 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468

15.25.2 Shininess The attribute dr3d:shininess specifies the shine of the used material. 16469 16470 16471 16472 16473 16474 16475

15.26 3D Shadow Properties The 3D shadow properties described in this section are applicable to 3D drawing objects. These properties are available for 3D drawing objects contained in all kinds of applications.

15.26.1 Shadow The attribute dr3d:shadow enables or disables a three-dimensional shadow for a threedimensional object. 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="dr3d:shadow"> <choice> <value>visible</value> <value>hidden</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 642 of 706

15.27 Frame Formatting Properties The properties described in this section apply to draw frames (see section 9.3). They can be used within graphic styles (see section 14.13.1) and they are contained in a <style:graphicproperties> element.

15.27.1 Frame Widths There are three types of frame widths; fixed widths, minimum widths and relative widths. Fixed widths are specified using the svg:width attribute, minimum widths are specified using the fo:min-width attribute and relative widths are specified using the style:rel-width attribute. The meaning of these attributes is the same as described in section 9.3, except that the attributes specify the default width for new created frames only. The style:rel-width attribute will be evaluated only for graphic styles that are applied to text boxes. 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496

15.27.2 Frame Heights There are three types of frame heights; fixed heights, minimum heights and relative heights. Fixed heights are specified using the svg:height attribute, minimum heights are specified using the fo:min-height attribute and relative heights are specified using the style:relheight attribute. The meaning of these attributes is the same as described in section 9.3, except that the attributes specify the default height for new created frames only. The style:rel-height attribute will be evaluated only for graphic styles that are applied to text boxes. See also section 15.27.1. 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506

15.27.3 Maximum Width and Height Text boxes can increase in size automatically when content is added. The fo:max-width and fo:max-height attributes specify a maximum width and height for the frame. When the maximum values are reached, the frame stops increasing in size. The attributes' value can be either a length or a percentage. If the anchor for the text box is in a table cell, the percentage value relates to the surrounding table box. If the anchor for the text box is in a text box, the percentage value relates to the surrounding text box. In other cases, the percentage values relate to the height of the page or window.

1 May 2005 Page 643 of 706

16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524

15.27.4 Left and Right Margins The fo:margin-left and fo:margin-right properties determine the left and right margins to set around a frame. See sections 15.5.17 for detailed information on these attributes. Percentage values are not supported. 16525 16526 16527

15.27.5 Top and Bottom Margins The fo:margin-top and fo:margin-bottom properties determine the top and bottom margins to set around a frame. See sections 15.5.20 for detailed information on these attributes. Percentage values are not supported. 16528 16529 16530

15.27.6 Margins The fo:margin property specifies the the margin for all four edges of a frame. See section 15.5.21 for a full explanation of this property. 16531 16532 16533

15.27.7 Print Content The style:print-content property specifies whether or not the content of a frame is printed. 16534 16535 16536 16537 16538 16539 16540

1 May 2005 Page 644 of 706

15.27.8 Protect The style:protect property specifies whether the content, size, or position of a frame is protected. The value of this property can be either none or a space separated list that consists of any of the values content, position, or size. 16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:protect"> <choice> <value>none</value> <list> <oneOrMore> <choice> <value>content</value> <value>position</value> <value>size</value> </choice> </oneOrMore> </list> </choice> </attribute> </optional> </define>

15.27.9 Horizontal Position Within text documents, the style:horizontal-pos property specifies the horizontal alignment of the frame in relation to the specific area. The value of this property can be one of the following: from-left, left, center, right, from-inside, inside, or outside. The area that the position relates to is specified by the style:horizontal-rel property. The values from-inside, inside and outside correspond to the values from-left, left, and right on pages that have an odd page number and to the opposite values on pages that have an even page number. If the property value is from-left or from-inside, the svg:x attribute associated with the frame element specifies the horizontal position of the frame. Otherwise the svg:x attribute is ignored for text documents. It is also possible to use an svg:x attribute within a graphic style. If this is the case, then the attribute specifies a default position for new frames that are created using this style. Some values may be used in connection with certain frame anchor and relation types only. 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:horizontal-pos"> <choice> <value>left</value> <value>center</value> <value>right</value> <value>from-left</value> <value>inside</value> <value>outside</value> <value>from-inside</value> </choice> </attribute> </optional> <optional> <attribute name="svg:x"> <ref name="coordinate"/>

1 May 2005 Page 645 of 706

16576 16577 16578

</attribute> </optional> </define>

The following tables display the possible values of the attributes style:horizontal-pos and style:horizontal-rel. The possible values of these alignment attributes are listed in the first column on the left, and an alignment attribute value/anchor type value match is indicated by an X. Value of style:horizon tal-pos any

Value of text:anchor-type page X

Value of style:horizon tal-rel

frame X

paragraph X

char

as-char

Value of text:anchor-type page

frame

paragraph

char

page

page-content

page-start-margin X

page-end-margin

paragraph

paragraph-content

paragraph-startmargin

paragraph-endmargin

frame

frame-content

frame-start-margin

frame-end-margin

char

as-char

15.27.10 Horizontal Relation The style:horizontal-rel property specifies the area to which the horizontal position of a frame relates. See the previous section for information on the style:horizontal-pos property. The value of this property can be one of the following: page, page-content, page-startmargin, page-end-margin, frame, frame-content, frame-start-margin, frame-endmargin, paragraph, paragraph-content, paragraph-start-margin, paragraph-endmargin, or char. OpenDocument-v1.0-os.sxw Copyright © OASIS Open 2002 - 2005. All Rights Reserved.

1 May 2005 Page 646 of 706

Some values can be used with only certain frame anchor types. The value start-margin determines the left margin, except when the horizontal position is from-inside, inside or outside and the anchor for the frame is on a page with an even page number, in which case it determines the right margin. The value end-margin determines the opposite margin to the start-margin values. 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:horizontal-rel"> <choice> <value>page</value> <value>page-content</value> <value>page-start-margin</value> <value>page-end-margin</value> <value>frame</value> <value>frame-content</value> <value>frame-start-margin</value> <value>frame-end-margin</value> <value>paragraph</value> <value>paragraph-content</value> <value>paragraph-start-margin</value> <value>paragraph-end-margin</value> <value>char</value> </choice> </attribute> </optional> </define>

15.27.11 Vertical Position The style:vertical-pos property specifies the vertical alignment of the frame in relation to a specific area. The value of this property can be one of the following: from-top, top, middle, below or bottom. The area that the position relates to is specified by the style:vertical-rel property. top, middle and bottom specify the the given corners of the frame and the reference area get aligned. below specifies that the top corner of frame is positioned below the reference area. If the value of this property is from-top, the svg:y attribute associated with the frame element specifies the vertical position of the frame. Otherwise, the svg:y attribute is ignored for text documents. It is also possible to use an svg:y attribute within a graphic style. If this is the case, the attribute specifies a default position for new frames that are created using this style. Some values may be used in connection with certain frame anchor and relation types only. 16600 16601 16602

16603 16604 16605 16606 16607 16608 16609 16610 16611 16612

<define name="common-vertical-pos-attlist"> <optional> <attribute name="style:vertical-pos"> <choice> <value>top</value> <value>middle</value> <value>bottom</value> <value>from-top</value> <value>below</value>

1 May 2005 Page 647 of 706

16613 16614 16615 16616 16617 16618 16619 16620 16621

</choice> </attribute> </optional> <optional> <attribute name="svg:y"> <ref name="coordinate"/> </attribute> </optional> </define>

The following tables display the possible values of the attributes style:vertical-pos and style:vertical-rel. The possible values of these alignment attributes are listed in the first column on the left, and an alignment attribute value/anchor type value match is indicated by an X. Value of style:vertical -pos any

Value of text:anchor-type page X

Value of style:vertical -rel

frame X

paragraph X

char X

as-char X

Value of text:anchor-type

page

page-content

frame

frame-content

paragraph

char

paragraph

paragraph-content

char

as-char

line

baseline

text

15.27.12 Vertical Relation The style:vertical-rel property specifies the area to which the vertical position of a frame relates. See the previous section for information on the style:vertical-pos property. The value of this property can be one of the following: page, page-content, frame, framecontent, paragraph, paragraph-content, line, baseline, text or char. Some values can be used with only certain frame anchor types. 16622 16623 16624

1 May 2005 Page 648 of 706

16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643

<define name="common-vertical-rel-attlist"> <optional> <attribute name="style:vertical-rel"> <choice> <value>page</value> <value>page-content</value> <value>frame</value> <value>frame-content</value> <value>paragraph</value> <value>paragraph-content</value> <value>char</value> <value>line</value> <value>baseline</value> <value>text</value> </choice> </attribute> </optional> </define>

15.27.13 Frame Anchor The text:anchor-type and text:anchor-page-number specify the default anchor for new frames and drawing objects. See section 9.2.16 for details. 16644 16645 16646

15.27.14 Border The border attributes fo:border, fo:border-top, fo:border-bottom, fo:border-left and fo:border-right specify the border properties of the frame. See section 15.5.25 for detailed information on these attributes. 16647 16648 16649

15.27.15 Border Line Width If a frame has borders, the border line width attributes style:border-line-width, style:border-line-width-top, style:border-line-width-bottom, style:borderline-width-left and style:border-line-width-right specify the properties of the border lines of the frame. See section 15.5.26 for detailed information on these attributes. 16650 16651 16652

15.27.16 Padding The padding attributes fo:padding, fo:padding-top, fo:padding-bottom, fo:paddingleft and fo:padding-right specify the padding properties of the frame. See section 15.5.27 for detailed information on these attributes.

1 May 2005 Page 649 of 706

16653 16654 16655

15.27.17 Shadow The shadow attribute style:shadow specifies the shadow of the frame. See section 15.5.28 for detailed information on this attribute. 16656 16657 16658

15.27.18 Background The background attribute fo:background-color and the background element <style:background-image> specify the background properties of the frame. See sections 15.5.23 and 15.5.24 for detailed information on this attribute and element. 16659 16660 16661 16662 16663 16664

15.27.19 Columns The <style:columns> element specifies if a text box contains columns. See section 15.7.3 for detailed information on this element. 16665 16666 16667

15.27.20 Editable Within text documents, a text box can be editable even if the document in which it is contained is a read-only document. The style:editable property specifies if a text box can be edited. 16668 16669 16670 16671 16672 16673 16674

15.27.21 Wrapping Within text documents, the style:wrap property specifies how text around a frame or graphic object is treated. For example, text can run around the left side of the frame, around the right side of the frame, or through the frame. The possible values are:

1 May 2005 Page 650 of 706

16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689

•

none: no text wraps around the drawing shape.

•

left: Text may wrap around the left side of the drawing shape.

•

right: Text may wrap around the left side of the drawing shape.

•

parallel: Text may wrap around both sides of the drawing shape.

•

dynamic: Text may wrap around both sides of the drawing shape, provided that there is sufficient space left.

•

biggest: Text may wraps around the object border where the difference to the left or right page or column border is largest.

•

run-through: Text runs through the drawing object.

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:wrap"> <choice> <value>none</value> <value>left</value> <value>right</value> <value>parallel</value> <value>dynamic</value> <value>run-through</value> <value>biggest</value> </choice> </attribute> </optional> </define>

15.27.22 Dynamic Wrap Threshold The style:wrap-dynamic-threshold attribute is evaluated only if the style:wrap attribute has a value of dynamic. It specifies the minimum distance between the page or column border and the object for which wrapping will be enabled. 16690 16691 16692 16693 16694 16695 16696

15.27.23 Paragraph-only Wrapping If the anchor position of a frame or drawing shape is a paragraph or a character, and the wrap mode specified by the style:wrap property is left, right, parallel, or dynamic, the number of paragraphs that wrap around the frame can be specified using a style:numberwrapped-paragraphs attribute. This property is only recognized by frames or styles that have a style:wrap property attached with a value of left, right, parallel, or dynamic. If the value is no-limit, there is no limit on the number of paragraphs that are allowed to wrap around a frame. 16697 16698

1 May 2005 Page 651 of 706

16699 16700 16701 16702 16703 16704 16705 16706

<attribute name="style:number-wrapped-paragraphs"> <choice> <value>no-limit</value> <ref name="positiveInteger"/> </choice> </attribute> </optional> </define>

15.27.24 Contour Wrapping Within text documents, the style:wrap-contour attribute specifies for some frame types that the text should wrap around the shape of the object in the frame rather than around the frame itself . This is called contour wrapping. 16707 16708 16709 16710 16711 16712 16713

15.27.25 Contour Wrapping Mode The style:wrap-contour-mode attribute is used to further specify how the text should wrap around the contour. This attribute is recognized only by frames/drawing shapes or styles that already have the style:wrap and style:wrap-contour attributes attached. The value of the attribute can be outside or full. If the value of the attribute is outside, the text wraps around the general area to the left and right of the shape. If the value of the attribute is full, the text wraps around the shape and fills any possible spaces and indentations in the shape. 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:wrap-contour-mode"> <choice> <value>full</value> <value>outside</value> </choice> </attribute> </optional> </define>

15.27.26 Run Through If the value of the style:wrap attribute is run-through, it can be further specified whether the content of the frame should be displayed in the background or in the foreground. The style:run-through attribute is usually used for transparent objects. The value of this attribute can be foreground or background. If the value is foreground, the frame content is displayed in front of the text. If the value is background, the frame content is displayed behind the text. 16724 16725 16726

1 May 2005 Page 652 of 706

16727 16728 16729 16730 16731 16732 16733

<choice> <value>foreground</value> <value>background</value> </choice> </attribute> </optional> </define>

15.27.27 Flow with Text The style:flow-with-text attribute specifies the behavior of drawing shapes that are positioned at a certain distance below an anchor and do not fit on the page where the anchor is. If the value of the property is true, such drawing objects follow the text flow, that is, they a displayed on the next page. If the attribute value is false, such drawing objects are displayed outside the page's text area.

Example: A graphic is to be positioned 10cm below its anchor. It is followed by only 8cm of text before the next page break. With style:flow-with-text='false' the graphics would then be positioned 2cm below the text area (somewhere in the footer); with style:flow-withtext='true' it would positioned 2cm into the text flow of the following page. 16734 16735 16736 16737 16738 16739 16740

15.27.28 Overflow behavior For text boxes contained within text document, the style:overflow-behavior property specifies the behavior of text boxes where the containing text does not fit into the text box. If the attribute's value is clip, the text that does not fit into the text box is not displayed. If the attribute value is auto-create-new-frame, a new frame will be created on the next page, with the same position and dimensions of the original frame. If the style:overflow-behavior property's value is auto-create-new-frame and the text box has a minimum width or height specified, then the text box will grow until the page bounds are reached before a new frame is created. 16741 16742 16743 16744 16745 16746 16747 16748 16749 16750

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:overflow-behavior"> <choice> <value>clip</value> <value>auto-create-new-frame</value> </choice> </attribute> </optional> </define>

15.27.29 Mirroring The style:mirror property specifies whether or not an image is mirrored before it is displayed. The mirroring can be vertical or horizontal. Horizontal mirroring can be restricted to images that are only located on either odd or even pages.

1 May 2005 Page 653 of 706

The value of this attribute can be none, vertical, horizontal, horizontal-on-odd, or horizontal-on-even. The value vertical and the various horizontal values can be specified together, separating them by a white space. 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769

<define name="style-graphic-properties-attlist" combine="interleave"> <optional> <attribute name="style:mirror"> <choice> <value>none</value> <value>vertical</value> <ref name="horizontal-mirror"/> <list> <value>vertical</value> <ref name="horizontal-mirror"/> </list> <list> <ref name="horizontal-mirror"/> <value>vertical</value> </list> </choice> </attribute> </optional> </define>

16770 16771 16772 16773 16774 16775 16776 16777

<define name="horizontal-mirror"> <choice> <value>horizontal</value> <value>horizontal-on-odd</value> <value>horizontal-on-even</value> </choice> </define>

15.27.30 Clipping The fo:clip property specifies whether to display: •

A rectangular section of an image, or

•

the entire image.

See §7.20.1 of [XSL] for details. 16778 16779 16780 16781 16782 16783 16784 16785

15.27.31 Wrap Influence on Position This attribute details how the wrapping mode (see the style:wrap attribute) influences the positioning of a frame. It is intended as a hint to the layout algorithm to help decide on the placement of frames in certain cases where several correct placements could be used. All three options describe different, correct interpretations of the layout constraints already in the format. The new hint would allow to disambiguate between these situations. 16786 16787 16788 16789

1 May 2005 Page 654 of 706

16790 16791 16792 16793 16794 16795 16796 16797

<choice> <value>iterative</value> <value>once-concurrent</value> <value>once-successive</value> </choice> </attribute> </optional> </define>

The situation in which this attribute makes a difference is when the anchor, position and wrapping mode of a frame are such that they influence each other. For example, consider a paragraph of text with two images positioned somewhat above the anchor. Without wrapping, the images overly the text and can simply be placed at the given offset from the anchor. If wrap-around is enabled, the text hidden behind the images now needs to flow around the images, making the first paragraph use more space than previously. This moves the anchor position further down. If one does the placement only once and concurrently for all objects, this is the final result. This corresponds to the object once-concurrently. If one proceeds as above, but does the process one image at a time, one arrives at the positions given to the right. This corresponds to the option oncesuccessive.

If one places the images iteratively, until a position is found which corresponds to the given offset from the anchor, one can often achieve a placement that fully satisfy all the given layout properties (at a certain price in implementation cost). This corresponds to the option iterative.

15.28 Floating Frame Formatting Properties The attributes described in this section can be assigned to a graphic style that is assigned to floating frames.

15.28.1 Display Scrollbar The draw:display-scrollbar attribute specifies whether or not vertical and horizontal scrollbars are displayed. This attribute can be assigned to automatic styles only. 16798 16799 16800 16801 16802 16803 16804

15.28.2 Display Border The draw:display-border attribute specifies whether or not a border is displayed on the floating frame. This attribute can be assigned to automatic styles only.

1 May 2005 Page 655 of 706

16805 16806 16807 16808 16809 16810 16811

15.28.3 Margins The draw:margin-horizontal and draw:margin-vertical attributes specify the horizontal and vertical margins between the border and the content of the floating frame. If these attributes are not specified, the default margins are used. These attributes can be assigned to automatic styles only. The value of these attributes must be a length in pixels. 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823

16824 16825 16826 16827 16828 16829

15.28.4 Object Formatting Properties The attributes described in this section can be assigned to a graphic style that is assigned to objects.

15.28.5 Visible Area The visible area of an object is the rectangular area of the object that is currently visible. The attributes draw:visible-area-left, draw:visible-area-top, draw:visible-areawidth and draw:visible-area-height specify a default visible area that the object has the option to use. When the entire object is visible, the values of the draw:visible-area-left and draw:visible-area-top attributes are 0 and the draw:visible-area-width and draw:visible-area-height attributes specify the size of the object. These attributes can be assigned to automatic styles only. Not all objects support these attributes. Some objects, may store and load their own visible area. 16830 16831 16832 16833 16834 16835 16836

1 May 2005 Page 656 of 706

16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851

15.28.6 Draw Aspect The draw:ole-draw-aspect attribute specifies the draw aspect that is used to display embedded OLE objects (see [OLE]). The draw aspect controls whether the object is displayed as a normal sub document, or whether the object is for instance displayed as an icon only. Within the [OLE] API, the draw aspect is an unsigned integer value that the host application passes to the object when it requests its presentation. The draw:ole-draw-aspect attribute takes a non negative integer value and has only a meaning for objects that are embedded using the [OLE] API. In this case, it's value specifies a default value for method calls that require a draw aspect. The interpretation of this integer value is left to the OLE object's discretion and not part of this specification. 16852 16853 16854 16855 16856 16857 16858

15.29 Chart Formatting Properties The properties described in this section can be applied to all charts. They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element. 16859 16860 16861 16862 16863

16864 16865 16866 16867

16868 16869 16870 16871 16872 16873 16874 16875 16876

1 May 2005 Page 657 of 706

15.29.1 Scale Text The chart:scale-text property is used to specify that all text objects in the chart should be scaled whenever the size of the chart changes. To enable scaling, set the value of this property to true. 16877 16878 16879 16880 16881 16882 16883

15.30 Chart Subtype Properties The properties described in this section can be used to customize the basic chart type set in the <chart:chart> element. They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element.

15.30.1 Three-dimensional Charts The chart:three-dimensional property specifies whether chart is displayed as a 3D scene. 16884 16885 16886 16887 16888 16889 16890

15.30.2 Chart Depth The chart:deep property is only relevant with the chart:three-dimensional property. It specifies that the data series are displayed back-to-back rather than side by side. 16891 16892 16893 16894 16895 16896 16897

15.30.3 Chart Symbol For some chart types, the data points can be denoted by symbols. The chart:symbol-type attribute determines whether a symbol is used, and whether it's a pre-defined symbol type, and image, or whether the application is free to automatically choose a type out of the set of predefined symbol types, e.g. choose one symbol per series in round-robin fashion. 16898 16899 16900 16901 16902 16903 16904

<define name="style-chart-properties-attlist" combine="interleave"> <choice> <attribute name="chart:symbol-type"> <value>none</value> </attribute> <attribute name="chart:symbol-type"> <value>automatic</value>

1 May 2005 Page 658 of 706

16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942

</attribute> <group> <attribute name="chart:symbol-type"> <value>named-symbol</value> </attribute> <attribute name="chart:symbol-name"> <choice> <value>square</value> <value>diamond</value> <value>arrow-down</value> <value>arrow-up</value> <value>arrow-right</value> <value>arrow-left</value> <value>bow-tie</value> <value>hourglass</value> <value>circle</value> <value>star</value> <value>x</value> <value>plus</value> <value>asterisk</value> <value>horizontal-bar</value> <value>vertical-bar</value> </choice> </attribute> </group> <group> <attribute name="chart:symbol-type"> <value>image</value> </attribute> <element name="chart:symbol-image"> <attribute name="xlink:href"> <ref name="anyURI"/> </attribute> </element> </group> <empty/> </choice> </define>

15.30.4 Chart Symbol Size The width and height of each symbol can be set using the attribute chart:symbol-width and chart:symbol-length. 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954

15.30.5 Bar Chart Properties The chart:vertical and chart:connect-bars properties are for bar charts only. chart:vertical determines whether the bars will be oriented horizontally or vertically. If chart:connect-bars is set to true, the data points (the top of the bars) are additionally connected by lines.

1 May 2005 Page 659 of 706

16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968

With bar charts, the properties chart:gap-width and chart:overlap can be used to specify the relative size and distance of bars. The chart:gap-width attribute contains the relative width of the gap between bars for neighboring categories. The chart:overlap attributes determines how much bars within the same category overlap. Both are integral percentages. 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980

15.30.6 Stock Chart Properties These attributes are only effective for stock charts. Stock charts display a span from minimum to maximum values as a straight line. Opening and closing courses can be displayed either as left and right tick-lines, respectively, or as colored bars, with their color depending on whether the opening value is larger than the closing value. The chart:japanese-candle-stick attribute distinguish between those two representations. Example: A stock chart in Japanese-candle-stick fashion (left), and as default (right).

16981 16982 16983 16984

1 May 2005 Page 660 of 706

16985 16986 16987 16988

15.30.7 Line Chart Properties For line chart-types, the attribute chart:interplation can be set to one of the following values:

16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009

•

none -Straight lines – don't use spline interpolation

•

cubic-spline - Cubic Splines (chart:spline-resolution determines the number of interpolated points between two data points)

•

b-spline - B-Splines (chart:spline-order determines the order of the polygons used for calculation. The chart:spline-resolution is also taken into account.)

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:interpolation" a:defaultValue="none"> <choice> <value>none</value> <value>cubic-spline</value> <value>b-spline</value> </choice> </attribute> </optional> <optional> <attribute name="chart:spline-order" a:defaultValue="2"> <ref name="positiveInteger"/> </attribute> </optional> <optional> <attribute name="chart:spline-resolution" a:defaultValue="20"> <ref name="positiveInteger"/> </attribute> </optional> </define>

15.30.8 Pie Chart Properties The chart:pie-offset attribute is only interpreted by pie charts. It determines the offset the tip of a 'pie' in a pie chart (or circle chart) has from the center of the circle. 17010 17011 17012 17013 17014 17015 17016

15.30.9 Lines The chart:lines property determines whether connecting lines between data points are shown. The line interpolation is determined by the chart:splines property. 17017 17018 17019

1 May 2005 Page 661 of 706

17020 17021 17022 17023

15.30.10 Solid Charts Bars The chart:solid-type attribute determines how the bars in three-three-dimensional bar charts should be rendered. 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:solid-type" a:defaultValue="cuboid"> <choice> <value>cuboid</value> <value>cylinder</value> <value>cone</value> <value>pyramid</value> </choice> </attribute> </optional> </define>

15.30.11 Stacked Chart Bars The attribute chart:stacked attribute causes bars in bar charts to be stacked on top of each other, instead of next to each other. If chart:percentage is set to true, the stacked bars will all be scaled to the full height of the plot area, so that the bar segments represent the percentage of their respective data point in the total bar stack. 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047

15.31 Chart Axes Properties The properties described in this section can be applied to chart axis elements (see section 10.8). They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element.

15.31.1 Linked Data Formats The chart:link-data-style-to-source attribute can only be used in chart documents that reside in a document that provides the data for the chart. If the value of the attribute is true, the number format used for rendering the axis is the format that the container document suggests based on the selected cell range. For example, if a cell range contains currencies all formatted in €, then this format will also be used at this axis. 17048 17049

1 May 2005 Page 662 of 706

17050 17051 17052 17053 17054

15.31.2 Visibility To determine whether or not an axis object is visible, use the chart:axis-visible style property. This way, a chart with scaling information can be provided without displaying the axis object. 17055 17056 17057 17058 17059 17060 17061

15.31.3 Scaling If a scaling attribute is omitted, the axis is set to adaptation mode. This means that the value is not set to a fixed value but may be changed by the render application if data changes. However, the chart:axis-logarithmic attribute is set to false. The optional chart:axis-logarithmic attribute can be used to cause logarithmic scaling on an axis. By default, proportional scaling is used. 17062 17063 17064 17065 17066 17067 17068

The following set of optional attributes further details the scaling of an axis. The properties have the following uses: chart:minimum, chart:maximum – set minimal and maximal scaling values of an axis chart:origin – determine the origin of the chart axis chart:interval-major, chart:interval-minor-divisor – set major and minor interval for ticks or markings on the axis. The chart:interval-major defines the interval value. The minor interval is determined by dividing the chart:interval-major value by the chart:interval-minor-divisor. 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081

1 May 2005 Page 663 of 706

17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095

15.31.4 Tickmarks The tickmark properties are used to specify the existence of tickmarks at an axis. The major marks are drawn with respect to the major interval that may be specified by the chart:axisinterval-major attribute. The minor tick marks refer to the chart:axis-interval-minor attribute. Inner marks are drawn towards the inside of the plot area, that is to the right for an axis displayed on the left hand side of the plot area, and to the left for an axis displayed on the right hand side of the plot area. Outer marks point in the opposite direction. If both properties are specified, one tick mark is drawn that crosses the axis. 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 17117

15.31.5 Labels The following set of properties describes how axis labels are being represented. chart:display-label determines whether labels will be displayed at all. If chart:textoverlap is set true, labels may overlap. text:line-break determines whether label lines may be broken into multiple lines. The chart:label-arrangement property allows labels to be arranged either side-by-side (i.e. all labels start on one line), or staggered (i.e., labels are distributed to two lines, with every other label starting on the same line). In case of staggered labels, one can choose between even or odd staggering, i.e. one can choose whether even or odd labels are aligned on the line that would be used for side-by-side arrangement.

1 May 2005 Page 664 of 706

17118 17119 17120 17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:display-label"> <ref name="boolean"/> </attribute> </optional> <optional> <attribute name="chart:text-overlap"> <ref name="boolean"/> </attribute> </optional> <optional> <attribute name="text:line-break"> <ref name="boolean"/> </attribute> </optional> <optional> <attribute name="chart:label-arrangement" a:defaultValue="side-by-side"> <choice> <value>side-by-side</value> <value>stagger-even</value> <value>stagger-odd</value> </choice> </attribute> </optional> </define>

15.32 Common Chart Properties The properties described in this section apply to all types of data representation objects, including the elements <chart:plot-area>, <chart:series>, and <chart:data-point>. They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element. Properties are applied in a hierarchical manner. If a property is set in the <chart:chart> element, it applies to all data points contained in the chart. If the same property is set in a <chart:series> element, it only applies to the data points contained in that specific series. To set a formatting property for one data point only, set the property in the <chart:data-point> element.

15.32.1 Stacked Text The property style:direction determines whether or not text is displayed vertically without rotating the letters. It can be applied to several text objects. The value of this property can be ltr if text goes from left to right or ttb if the text is stacked, that is goes from top to bottom. It can be applied to several text objects. See section 15.11.3 for details. 17145 17146 17147

15.32.2 Rotation Angle The style:rotation-angle property specifies the value of a rotation angle in degrees. See section 15.11.12 for information on using this property. 17148

1 May 2005 Page 665 of 706

17149 17150

15.32.3 Data Labels Data labels can be applied to data series and data points as well as to an entire chart. In the latter case, labels are shown for all data points. Data labels can consist of the following three parts: •

The value, which can be displayed as a percentage or the value itself.

•

The label of the corresponding series.

•

The legend symbol.

Value The chart:data-label-number attribute represents the value of the data label. 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:data-label-number"> <choice> <value>none</value> <value>value</value> <value>percentage</value> </choice> </attribute> </optional> </define>

Label The chart:data-label-text attribute determines whether or not to display the label of the corresponding series. The value of this attribute can be true or false. 17162 17163 17164 17165 17166 17167 17168

Legend Symbol The chart:data-label-symbol attribute determines whether or not to display the legend symbol. The value of this attribute can be true or false. 17169 17170 17171 17172 17173 17174 17175

1 May 2005 Page 666 of 706

15.33 Statistical Properties Statistical properties can be applied to data series or to an entire chart. In the latter case, the properties apply to all series in the chart. They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element.

15.33.1 Mean Value The chart:mean-value attribute determines whether or not to display a line that represents the statistical mean value of all data points of a series. The value of this attribute can be true or false. 17176 17177 17178 17179 17180 17181 17182

15.33.2 Error Category The chart:error-category attribute is used to determine which function is used to display error indicators at data points. The following functions are available: •

Variance of the values of a series assuming an equal distribution.

•

Standard-deviation of the values of a series assuming an equal distribution.

•

Use a fixed percentage of each value

•

Use a fixed percentage of the biggest value – this is called error-margin.

•

Use fixed absolute values for both directions: positive and negative

If this attribute is set to any value other than none, error indicators are shown. To determine in which direction the indicators are pointing see the attributes chart:error-upper-indicator and chart:error-lower-indicator. 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:error-category" a:defaultValue="none"> <choice> <value>none</value> <value>variance</value> <value>standard-deviation</value> <value>percentage</value> <value>error-margin</value> <value>constant</value> </choice> </attribute> </optional> </define>

Error Percentage The chart:error-percentage attribute determines the percentage that is used to display error indicators for each data point of a series. 17197

1 May 2005 Page 667 of 706

17198 17199 17200 17201 17202 17203

Error Margin The chart:error-margin attribute determines the percentage that is used to display error indicators for the biggest value in a series. 17204 17205 17206 17207 17208 17209 17210

Constant Error Lower and Upper Limit If the error category is set to constant, the chart:error-lower-limit and chart:error-upper-limmit attributes determine the absolute values in a positive and negative direction that are used to display the error indicators. 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222

Error Indicators The chart:error-lower-indicator and chart:error-upper-indicator attributes determine in which direction indicators should be drawn. 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234

1 May 2005 Page 668 of 706

15.34 Plot Area Properties The properties described in this section can be applied to chart plot area elements (see section 10.5). They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element.

15.34.1 Series Source The chart:series-source attribute determines whether the data table contains the data series in column-wise or row-wise fashion. 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:series-source" a:defaultValue="columns"> <choice> <value>columns</value> <value>rows</value> </choice> </attribute> </optional> </define>

15.35 Regression Curve Properties The properties described in this section can be applied to chart regression curves elements (see section 10.14). They can be used within chart styles (see section 14.16) and are contained in a <style:chart-properties> element.

15.35.1 Regression Type Use the chart:regression-type attribute to display a regression for a series. A regression can be used to approximate the data points in a series by a mathematical function. The following models for approximation are available: •

Linear regression – approximate the values of the series using the model: y = A·x + B.

•

Logarithmic regression – approximate the values of the series using the model: y = A·log(x) + B.

•

Exponential regression – approximate the values of the series using the model: y = A·eB·x.

•

Regression with a power function – approximate the values of the series using the model: y = A·xB.

This property is only relevant in scatter charts, because regression needs both x and y values for calculation 17245 17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256

<define name="style-chart-properties-attlist" combine="interleave"> <optional> <attribute name="chart:regression-type" a:defaultValue="none"> <choice> <value>none</value> <value>linear</value> <value>logarithmic</value> <value>exponential</value> <value>power</value> </choice> </attribute> </optional>

1 May 2005 Page 669 of 706

17257

</define>

15.36 Presentation Page Attributes The properties described in this section can be contained within style elements <style:style> whose family is drawing-page. They are contained in a <style:style-drawpageproperties> element. The following presentation properties do exist: •

Transition Type

•

Transition Style

•

Transition Speed

•

Page Duration

•

Page Visibility

•

Sound

•

Background Size

•

Background Objects Visible

•

Background Visible

•

Display Header

•

Display Footer

•

Display Page Number

•

Display Date and Time

15.36.1 Transition Type The mode of transition, for example manual, can be set using the attribute presentation:transition-type.

17258 17259 17260 17261 17262 17263 17264 17265 17266 17267 17268 17269

•

manual: slide transition and shape effects must be started separately by the user.

•

automatic: slide transition and shape effects start automatically.

•

semi-automatic: slide transition starts automatically, shape effects must be started by the user.

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="presentation:transition-type"> <choice> <value>manual</value> <value>automatic</value> <value>semi-automatic</value> </choice> </attribute> </optional> </define>

1 May 2005 Page 670 of 706

15.36.2 Transition Style The attribute presentation:transition-style specifies the way that each presentation page replaces the previous presentation page, for example left-to-right replacement, or fading. •

none: no effect is used.

•

fade-*: the pages fades from a visible or hidden state to a hidden or visible state in the specified direction.

•

move-*: the page moves in the specified direction to its final position.

•

uncover-*: the page get uncovered in the specified direction.

•

*-stripes: the page is uncovered by drawing horizontal or vertical stripes that change their size during this effect.

•

clockwise: the page is uncovered by the hand of a watch, moving clockwise.

•

counterclockwise: the page is uncovered by the hand of a watch, moving counterclockwise.

•

open-*: the page is uncovered by drawing it line by line, either horizontally or vertically, starting at the center of the page.

•

close-*: the page is uncovered by drawing it line by line, either horizontally or vertically, starting at the edge of the page.

•

wavyline-*: the page is uncovered by drawing small blocks in a snake like fashion.

•

spiralin-*: the page is uncovered by drawing blocks in a spiral fashion, starting from the edge of the page.

•

spiralout-*: the page is uncovered by drawing blocks in a spiral fashion, starting from the center of the page.

•

roll-*: the pages moves in the specified direction to its final position, pushing the old page out.

•

stretch-*: the page is uncovered by changing its size during this effect.

•

*-lines: the page is uncovered by drawing it line by line, either horizontally or vertically in a random fashion.

•

dissolve: the page is faded in by drawing small blocks in a random fashion.

•

random: an effect is chosen at random to uncover the page.

•

*-checkerboard: the page is uncovered by drawing checkerboard like blocks that increase in size horizontally or vertically.

•

interlocking-horizontal-*: the new page appears in 4 horizontal stripes (i.e. the height is divided in 4, a bit like in the horizontal-stripes effect) but those stripes come from left, right, left, and right, and cross each other in the middle of the screen.

•

interlocking-vertical-*: similar effect with vertical stripes crossing each other.

•

fly-away: the page first reduces itself to a smaller size (while remaining centered in the screen), and then "flies away" (turns around a bit and moves to the bottom-right corner of the screen). The next slide appears under it meanwhile.

1 May 2005 Page 671 of 706

17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328

•

open: Combination of open-horizontal and open-vertical, i.e. a sort of plus sign opening.

•

close: Combination of close-horizontal and close-vertical, i.e. a sort of plus sign closing.

•

melt: Small vertical stripes move down at random speed, which gives the effect of the current page "melting down".

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="presentation:transition-style"> <choice> <value>none</value> <value>fade-from-left</value> <value>fade-from-top</value> <value>fade-from-right</value> <value>fade-from-bottom</value> <value>fade-from-upperleft</value> <value>fade-from-upperright</value> <value>fade-from-lowerleft</value> <value>fade-from-lowerright</value> <value>move-from-left</value> <value>move-from-top</value> <value>move-from-right</value> <value>move-from-bottom</value> <value>move-from-upperleft</value> <value>move-from-upperright</value> <value>move-from-lowerleft</value> <value>move-from-lowerright</value> <value>uncover-to-left</value> <value>uncover-to-top</value> <value>uncover-to-right</value> <value>uncover-to-bottom</value> <value>uncover-to-upperleft</value> <value>uncover-to-upperright</value> <value>uncover-to-lowerleft</value> <value>uncover-to-lowerright</value> <value>fade-to-center</value> <value>fade-from-center</value> <value>vertical-stripes</value> <value>horizontal-stripes</value> <value>clockwise</value> <value>counterclockwise</value> <value>open-vertical</value> <value>open-horizontal</value> <value>close-vertical</value> <value>close-horizontal</value> <value>wavyline-from-left</value> <value>wavyline-from-top</value> <value>wavyline-from-right</value> <value>wavyline-from-bottom</value> <value>spiralin-left</value> <value>spiralin-right</value> <value>spiralout-left</value> <value>spiralout-right</value> <value>roll-from-top</value> <value>roll-from-left</value> <value>roll-from-right</value> <value>roll-from-bottom</value> <value>stretch-from-left</value> <value>stretch-from-top</value> <value>stretch-from-right</value> <value>stretch-from-bottom</value> <value>vertical-lines</value> <value>horizontal-lines</value>

1 May 2005 Page 672 of 706

17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344

<value>dissolve</value> <value>random</value> <value>vertical-checkerboard</value> <value>horizontal-checkerboard</value> <value>interlocking-horizontal-left</value> <value>interlocking-horizontal-right</value> <value>interlocking-vertical-top</value> <value>interlocking-vertical-bottom</value> <value>fly-away</value> <value>open</value> <value>close</value> <value>melt</value> </choice> </attribute> </optional> </define>

15.36.3 Transition Speed The attribute transition-speed controls the speed at which a presentation page is removed from display, and replaced by a new presentation page. See 17345 17346 17347 17348 17349 17350 17351 17352

15.36.4 Transition Type or Family The [SMIL20] smil:type attribute is used to specify the transition type or family. See §12.4.1 of [SMIL20] for details. See §12.8 of [SMIL20] for a list of supported types. If this attribute is present, the attributes presentation:transition-type and presentation:transition-style attributes should be ignored. 17353 17354 17355 17356 17357 17358 17359

15.36.5 Transition Subtype The [SMIL20] smil:subtype attribute is used to specify the transition subtype. See §12.4.1 of [SMIL20] for details. See §12.8 of [SMIL20] for a list of supported subtypes. 17360 17361 17362 17363 17364 17365 17366

1 May 2005 Page 673 of 706

15.36.6 Transition Direction The [SMIL20] smil:direction attribute is used to specify the transition direction. See §12.4.1 of [SMIL20] for details. 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="smil:direction" a:defaultValue="forward"> <choice> <value>forward</value> <value>reverse</value> </choice> </attribute> </optional> </define>

15.36.7 Fade Color The [SMIL20] smil:fadeColor attribute is used to specify the transition fade color for transitions that make use of a start or end color. See §12.4.1 of [SMIL20] for details. 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="smil:fadeColor"> <choice> <value>forward</value> <value>reverse</value> </choice> </attribute> </optional> </define>

15.36.8 Page Duration The attribute presentation:page-duration controls the amount of time that the presentation page is displayed. The value of this attribute must conform to the time period format described in §3.2.6 of [xmlschema-2]. 17387 17388 17389 17390 17391 17392 17393 17394

15.36.9 Page Visibility A drawing page can be marked as hidden during a presentation by using the attribute presentation:visibility. A page marked with this attribute is only shown while editing the document but not during the presentation. 17395 17396 17397 17398 17399 17400 17401 17402

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="presentation:visibility"> <choice> <value>visible</value> <value>hidden</value> </choice>

1 May 2005 Page 674 of 706

17403 17404 17405

</attribute> </optional> </define>

15.36.10 Sound Sound effects can be added to your presentation pages using the element presentation:sound. It must be included in the <style:presentation-properties> element. 17406 17407 17408 17409 17410 17411

15.36.11 Background Size The attribute draw:background-size specifies whether the background of a page is rendered on the full page or only inside the borders of the page. 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422

<define name="style-drawing-page-properties-attlist" combine="interleave"> <optional> <attribute name="draw:background-size"> <choice> <value>full</value> <value>border</value> </choice> </attribute> </optional> </define>

15.36.12 Background Objects Visible The attribute presentation:background-objects-visible specifies whether or not to hide objects on the background of the master page when displaying the presentation page. 17423 17424 17425 17426 17427 17428 17429 17430

15.36.13 Background Visible The attribute presentation:background-visible specifies whether or not to hide the background of the master page when displaying the presentation page. 17431 17432 17433 17434 17435 17436 17437

1 May 2005 Page 675 of 706

17438

</define>

15.36.14 Display Header The presentation:display-header attribute sets the visibility of presentation shapes from the master page with the presentation class header (see section 9.6.1). 17439 17440 17441 17442 17443 17444 17445

15.36.15 Display Footer The presentation:display-footer attribute sets the visibility of presentation shapes from the master page with the presentation class footer (see section 9.6.1). 17446 17447 17448 17449 17450 17451 17452

15.36.16 Display Page Number The presentation:display-page-number attribute sets the visibility of presentation shapes from the master page with the presentation class page-number (see section 9.6.1). 17453 17454 17455 17456 17457 17458 17459

15.36.17 Display Date And Time The presentation:display-date-time attribute sets the visibility of presentation shapes from the master page with the presentation class date-time (see section 9.6.1). 17460 17461 17462 17463 17464 17465 17466

1 May 2005 Page 676 of 706

16 Data Types and Schema Definitions 16.1 Data Types The following data types are used within this specification: •

W3C Schema data types as defined in [xmlschema-2] (referenced by <ref> elements named the same as the corresponding data types) –

string

–

date

–

time

–

dateTime

–

duration

–

integer

–

nonNegativeInteger

–

positiveInteger

–

double

–

anyURI

–

base64Binary

–

IDREF

Relax-NG definitions for the W3C schema data types: 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489

1 May 2005 Page 677 of 706

17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505

</define> <define name="double"> <data type="double"/> </define> <define name="anyURI"> <data type="anyURI"/> </define> <define name="base64Binary"> <data type="base64Binary"/> </define> <define name="ID"> <data type="ID"/> </define> <define name="IDREF"> <data type="IDREF"/> </define> •

custom data types (usually specializations of W3C Schema data types) –

boolean A Boolean value may have either of the values true or false.

–

dateOrDateTime A dateOrDateTime value is essentially an [xmlschema-2] date and time value with an optional time component. In other words, it may contain either a date, or a date and time value.

–

timeOrDateTime A timeOrDateTime value is essentially an [xmlschema-2] date and time value with an optional date component. In other words, it may contain either a time, or a date and time value.

–

language A language is a the same as a W3C schema language data type, except that the values a described by [RFC3066] rather than [RFC1766].

–

countryCode A countryCode is a country code in conformance with [RFC3066], as specified in [XSL].

–

languageCode A languageCode is a language code in conformance with [RFC3066], as specified in [XSL].

–

character A character value is a string with only one character.

–

length A (positive or negative) physical length, consisting of magnitude and unit, in conformance with §5.9.11 of [XSL]. Valid lengths would be “2.54cm” or “1inch”. A number without unit is not a valid length, e.g. “3.2”. The support of pixel values is optional.

–

nonNegativeLength Like length, except that the value must be zero or positive.

1 May 2005 Page 678 of 706

–

positiveLength Like length, except that the value must be positive.

–

percent (Positive or negative) percentage values in conformance with §5.9.11 of [XSL], e.g. “40%”.

–

relativeLength A relative length is a positive integer, followed by a '*' character.

–

coordinate Like a length, except that the physical length denotes a certain point.

–

distance Like a length, except that the physical length measures the distance between to points.

–

color A RGB color in conformance with §5.9.11 of [XSL], that is a RGB color in notation “#rrggbb”, where rr, gg and bb are hexadecimal digits.

–

styleName A NCName as specified in [xmlschema-2] that is the name of a style.

–

StyleNameRef A NCName as specified in [xmlschema-2] that is the name of a referenced style, or an empty value.

–

StyleNames A whitespace separated list of NCNames as specified in [xmlschema-2] that are the names of a styles.

–

VariableName A string specifying the name of a variable

–

formula A string containing a formula. Formulas don't have a predefined syntax, but should start with a namespace prefix that specifies the syntax used within the formula.

–

valueType A list of value types supported for certain generic values, such as “string” or “date”.

–

targetFrameName The name of a target frame in conformance with §6.16 of [HTML4].

–

points A sequence of points. The points are two integer coordinates separated by a comma. The points are separated by white space.

–

pathData Path data as described in §8 of [SVG].

1 May 2005 Page 679 of 706

–

vector3D A 3-element vector that is represented by floating point x,y,z coordinates. The coordinates are encapsulated between parentheses and the coordinates are noted in the order x, y and z, separated by whitespaces. If this value represents a normal, then it should be normalized.

Example: A directional vector with the coordinates x = 0.5, y = 0 and z = 1 looks like "(0.5 0 1)". –

namespacedToken A namespaced token is a token id that makes use of the XML namespace mechanism for modularization purposes.

Example: The predefined chart types make use of the chart namespace urn:oasis:names:tc:opendocument:xmlns:chart:1.0. Assuming a namespace declaration of xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0", a bar chart would be identified as chart:bar. Relax-NG definitions for custom data types: 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545

<define name="boolean"> <choice> <value>true</value> <value>false</value> </choice> </define> <define name="dateOrDateTime"> <choice> <data type="date"/> <data type="dateTime"/> </choice> </define> <define name="timeOrDateTime"> <choice> <data type="time"/> <data type="dateTime"/> </choice> </define> <define name="language"> <data type="token"> <param name="pattern">[A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*</param> </data> </define> <define name="countryCode"> <data type="token"> <param name="pattern">[A-Za-z0-9]{1,8}</param> </data> </define> <define name="languageCode"> <data type="token"> <param name="pattern">[A-Za-z]{1,8}</param> </data> </define> <define name="character"> <data type="string"> <param name="length">1</param> </data> </define> <define name="length"> <data type="string">

1 May 2005 Page 680 of 706

17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607

17608 17609 17610

1 May 2005 Page 681 of 706

17611 17612 17613 17614 17615 17616 17617

<value>_self</value> <value>_blank</value> <value>_parent</value> <value>_top</value> <ref name="string"/> </choice> </define>

17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629

<define name="valueType"> <choice> <value>float</value> <value>time</value> <value>date</value> <value>percentage</value> <value>currency</value> <value>boolean</value> <value>string</value> </choice> </define>

17630 17631 17632 17633 17634 17635 17636 17637 17638 17639

17640 17641 17642 17643 17644 17645 17646

17647 17648 17649 17650 17651 17652

16.2 Other Definitions To provide for extensibility of the format, inclusion of custom content is allowed on several occasions. The following definitions allow for inclusion of arbitrary attributes or elements (with arbitrary content models). 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662 17663 17664 17665 17666 17667

1 May 2005 Page 682 of 706

17668 17669 17670 17671

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

16.3 Relax-NG Schema Suffix Suffix for the normative Relax-NG schema: 17672

</grammar>

1 May 2005 Page 683 of 706

17 Packages This chapter describes the package format that optionally can be used in OpenDocument. It contains the following sections: •

Introduction

•

Zip File Structure

•

Encryption

•

Preview Image

•

Manifest File

17.1 Introduction As XML has no native support for binary objects such as images, [OLE] objects, or other media types, and because uncompressed XML files can get very large, OpenDocument uses a package file to store the XML content of a document together with its associated binary data, and to optionally compress the XML content. This package is a standard Zip file, whose structure is discussed below. Information about the files contained in the package is stored in an XML file called the manifest file. The manifest file is always stored at the pathname META-INF/manifest.xml. The main pieces of information stored in the manifest are as follows: •

A list of all of the files in the package.

•

The media type of each file in the package.

•

If a file stored in the package is encrypted, the information required to decrypt the file is stored in the manifest.

17.2 Zip File Structure A Zip file starts with a sequence of files, each of which can be compressed or stored in raw format. Each file has a local header immediately before its data, which contains most of the information about the file, including time-stamps, compression method and file name. The compressed file contents immediately follow, and are terminated by an optional data descriptor. The data descriptor contains the CRC and compressed size of the file, which are frequently not available when writing the local file header. If these details were included, the data descriptor can be skipped.

1 May 2005 Page 684 of 706

Each file in the archive is laid down sequentially in this format, followed by a central directory at the end of the Zip archive. The central directory is a contiguous set of directory entries, each of which contains all the information in the local file header, plus extras such as file comments and attributes. Most importantly, the central directory contains pointers to the position of each file in the archive, which makes navigation of the Zip file quick and easy. For more details about the Zip file format, see [ZIP].

17.3 Encryption The encryption process takes place in the following multiple stages: 1. A 20-byte SHA1 digest of the user entered password is created and passed to the package component. 2. The package component initializes a random number generator with the current time. 3. The random number generator is used to generate a random 8-byte initialization vector and 16-byte salt for each file. 4. This salt is used together with the 20-byte SHA1 digest of the password to derive a unique 128-bit key for each file. The algorithm used to derive the key is PBKDF2 using HMAC-SHA1 (see [RFC2898]) with an iteration count of 1024. 5. The derived key is used together with the initialization vector to encrypt the file using the Blowfish algorithm in cipher-feedback (CFB) mode. Each file that is encrypted is compressed before being encrypted. To allow the contents of the package file to be verified, it is necessary that encrypted files are flagged as 'STORED' rather than 'DEFLATED'. As entries which are 'STORED' must have their size equal to the compressed size, it is necessary to store the uncompressed size in the manifest. The compressed size is stored in both the local file header and central directory record of the Zip file.

17.4 MIME Type Stream If a MIME type for a document that makes use of packages is existing, then the package SHOULD contain a stream called "mimetype". This stream SHOULD be first stream of the package's zip file, it MUST NOT be compressed, and it MUST NOT use an 'extra field' in its header (see [ZIP]).. The purpose is to allow packaged files to be identified through 'magic number' mechanisms, such as Unix's file/magic utility. If a ZIP file contains a stream at the beginning of the file that is uncompressed, and has no extra data in the header, then the stream name and the stream content can be found at fixed positions. More specifically, one will find: •

a string 'PK' at position 0 of all zip files

1 May 2005 Page 685 of 706

•

a string 'mimetype' at position 30 of all such package files

•

the mimetype itself at position 38 of such a package.

17.5 Usage of URIs Within Packages Within a file that is contained in a package, relative URIs are used to reference other sub files of the package, but can also be used to reference files within the file system. The following restrictions exist for URIs that are used within a package: •

only sub files within the same package can be referenced.

•

URIs that reference a sub file of a package MUST be relative, and they MUST NOT contain paths that are not within the package. This especially means that sub files of a package MUST NOT be referenced by an absolute URI.

•

sub file of a package can not be referenced from outside the package, for instance from the file system or another package.

A relative-path reference (as described in §5 of [RFC2396]) that occurs in a file that is contained in a package has to be resolved exactly as it would be resolved if the whole package gets unzipped into a directory at its current location. The base URI for resolving relative-path references is the one that has to be used to retrieve the (unzipped) file that contains the relativepath reference. All other kinds of URI references, namely the ones that start with a protocol (like http:), an authority (i.e. //) or an absolute-path (i.e. /) do not need any special processing. This especially means that absolute-paths do not reference files inside the package, but within the hierarchy the package is contained in, for instance the file system. URI references inside a package may leave the package, but once they have left the package, they never can return into the package or another one.

17.6 Preview Image A thumbnail representation of a document should be generated by default when the file is saved. It should be a representation of the first page, first sheet, etc. of the document. For maximum reusability of the thumbnails they have to be generated without any effects, surrounding frames, or borders. Such effects might interfere with effects added to the thumbnails by the different file system explorers or may not be desired at all for certain use cases. The thumbnail must be saved as “thumbnail.png” in a separate folder named “Thumbnails”. The “Thumbnails” folder must not get a media type in the manifest.xml file, since it is not actually part of the document. Encrypted files are intended to be unreadable for unauthorized users that's why a thumbnail for such files must not be generated. Instead of saving a thumbnail of the first page a replacement representation that doesn't depend on the contents of the document is saved for encrypted files which makes obvious that the corresponding file is encrypted. In order to conform to the Thumbnail Managing Standard (TMS) at www.freedesktop.org, thumbnails must be saved as 24bit, non-interlaced PNG image with full alpha transparency. The required size for the thumbnails is 128x128 pixel.

1 May 2005 Page 686 of 706

17.7 Manifest File The elements and attributes in the manifest file are in the namespace: urn:oasis:names:tc:opendocument:xmlns:manifest:1.0.

17.7.1 Relax-NG Schema The normative XML Schema for OpenDocument Manifest files is embedded within this specification. It can be obtained from the specification document by concatenating all schema fragments contained in this chapters. All schema fragments have a gray background color and line numbers. The schema language used within this specification is Relax-NG (see [RNG]). Prefix for the normative Relax-NG Manifest schema: 1 2 3 4 5

<?xml version="1.0" encoding="UTF-8"?> <!-OASIS OpenDocument v1.0 OASIS standard, 1 May 2005 Relax-NG Manifest Schema

6 7

$Id$

8 9 10

11 12

-->

13 14

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

15 16

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

17 18

xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">

17.7.2 Manifest Root Element The root element is called manifest. The root element contains one fixed attribute which specifies the namespace as described above and multiple <manifest:file-entry> elements, each of which describes a single file in the package. 19 20 21 22 23 24 25

26 27 28 29 30 31

17.7.3 File Entry The <manifest:file-entry> element represents a single file within the package, and stores the files location in the package, the mime-type of the file and optionally the data required to decrypt this file.

1 May 2005 Page 687 of 706

Directories only receive <manifest:file-entry> entries if they have inherent semantics. For example, a directory that constitutes a sub-document referenced as an object from within the main document would contain a <manifest:file-entry> with a suitable media type. A directory for administrative or convenience purposes, such as a directory that contains various image files, would not receive an entry in the manifest file. 32 33 34 35 36 37 38 39

The attributes associated with a <manifest:file-entry> are as follows: •

Full path

•

Size

•

Media type

Full Path The manifest:full-path attribute describes the location of the file within the package. 40 41 42 43 44

Size The manifest:size attribute is only present if the file is stored in an encrypted format. The reason why this attribute is required is explained in section 17.3. This attribute is only used for encrypted files. 45 46 47 48 49 50 51

Media Type The manifest:media-type attribute specifies the mime type of the specified file. For a full list of mime types see http://www.isi.edu/in-notes/iana/assignments/media-types/media-types. As an example, all XML streams have the media type "text/xml". 52 53 54 55 56

1 May 2005 Page 688 of 706

17.7.4 Encryption Data The <manifest:encryption-data> element contains all of the information required to decrypt the file. 57 58 59 60 61 62 63

The <encryption-data> element contains the following elements: •

Algorithm

•

Key Derivation

Checksum Type The manifest:checksum-type attribute specifies the name of digest algorithm that can be used to check password correctness. Currently, the only supported digest algorithm is SHA1. 64 65 66 67 68

Checksum The manifest:checksum attribute specifies the base64-encoded digest that can be used to detect password correctness as specified within manifest:checksum-type attribute. 69 70 71 72 73

17.7.5 Algorithm The <manifest:algorithm> element contains information about the algorithm used to encrypt the data. 74 75 76 77 78 79

The attributes associated with <manifest:algorithm> are as follows: •

Algorithm name

•

Initialization vector

1 May 2005 Page 689 of 706

Algorithm Name The manifest:algorithm-name attribute specifies the name of the algorithm used to encrypt the file, and also specifies in which mode this algorithm was used. Currently, the only supports algorithm is the Blowfish algorithm in CFB mode. 80 81 82 83 84

Initialization Vector The manifest:initialisation-vector attribute specifies the 8 bytes used as an initialization vector to the stream cipher. The initialization vector is an 8 byte binary sequence, and so is encoded in base64 when written to the manifest file. 85 86 87 88 89

17.7.6 Key Derivation The <manifest:key-derivation> element contains the information that was used to derive the encryption key for this file from the user specified password. 90 91 92 93 94 95

The attributes associated with the <manifest:key-derivation> element are as follows: •

Key derivation name

•

Salt

•

Iteration count

Key Derivation Name The manifest:key-derivation-name attribute specifies the name of the algorithm used to derive the name. At this time, the packages only supports the use of the PBKDF2 key derivation method. For further details see [RFC2898]. 96 97 98 99 100

1 May 2005 Page 690 of 706

Salt The manifest:salt attribute specifies the 16-byte sequence used as the 'salt' by the key derivation algorithm. The salt is a 16 byte binary sequence, and thus is encoded in base64 before being written to the manifest file. 101 102 103 104 105

Iteration Count The manifest:iteration-count attribute specifies the number of iterations used by the key derivation algorithm to derive the key. 106 107 108 109 110

Sample Manifest <manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0"> <manifest:file-entry manifest:media-type="application/vnd.oasis.opendocument.text" manifest:full-path="/"/> <manifest:file-entry manifest:media-type="image/jpeg" manifest:fullpath="Pictures/100000000000032000000258912EB1C3.jpg" manifest:size="66704"> <manifest:encryption-data> <manifest:algorithm manifest:algorithm-name="Blowfish CFB" manifest:initialisation-vector="T+miu403484="/> <manifest:key-derivation manifest:key-derivationname="PBKDF2" manifest:iteration-count="1024" manifest:salt="aNYdmqv4cObAJSJjm4RzqA=="/> </manifest:encryption-data> </manifest:file-entry> <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="content.xml" manifest:size="3143"> <manifest:encryption-data> <manifest:algorithm manifest:algorithm-name="Blowfish CFB" manifest:initialisation-vector="T+miu403484="/> <manifest:key-derivation manifest:key-derivationname="PBKDF2" manifest:iteration-count="1024" manifest:salt="aNYdmqv4cObAJSJjm4RzqA=="/> </manifest:encryption-data> </manifest:file-entry> <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="styles.xml" manifest:size="5159"> <manifest:encryption-data> <manifest:algorithm manifest:algorithm-name="Blowfish CFB" manifest:initialisation-vector="bChL2No5I+A="/> <manifest:key-derivation manifest:key-derivationname="PBKDF2" manifest:iteration-count="1024" manifest:salt="/kfasyu7X0Ae+1uopdeCtA=="/> </manifest:encryption-data>

1 May 2005 Page 691 of 706

</manifest:file-entry> <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="meta.xml"/> <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="settings.xml" manifest:size="5317"> <manifest:encryption-data> <manifest:algorithm manifest:algorithm-name="Blowfish CFB" manifest:initialisation-vector="JQxEm6rD+4c="/> <manifest:key-derivation manifest:key-derivationname="PBKDF2" manifest:iteration-count="1024" manifest:salt="PlpDaxloh4KUKx+v1g4V9g=="/> </manifest:encryption-data> </manifest:file-entry> </manifest:manifest>

17.7.7 Relax-NG Schema Suffix Suffix for the normative Relax-NG Manifest schema: 111

</grammar>

1 May 2005 Page 692 of 706

Appendix A.Strict Relax NG Schema The Relax-NG (see [RNG])schema provided in this appendix equals the schema defined in chapters 1 to 16 of this specification, but restricts the content of meta information elements and formatting properties elements to the attributes and elements defined in this specification. See also section 1.5. 1 2 3 4 5

<?xml version="1.0" encoding="UTF-8"?> <!-OASIS OpenDocument v1.0 OASIS Standard, 1 May 2005 Strict Relax-NG Schema

6 7

$Id$

8 9 10

11 12

-->

13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

1 May 2005 Page 693 of 706

55 56 57 58 59 60 61

1 May 2005 Page 694 of 706

Appendix B.References [CSS2] Bert Bos, Håkon Wium Lie, Chris Lilley, Ian Jacobs, Cascading Style Sheets, level 2, http://www.w3.org/TR/1998/REC-CSS2-19980512, W3C, 1998. [CSS3Text]

Michel Suignard, CSS3 Text Module, CSS3 Text Module, W3C, 2003.

[DCMI] -, Dublin Core Metadata Element Set, Version 1.1: Reference Description, http://www.dublincore.org/documents/dces/, Dublin Core Metadata Initiative, 2003. [DOMEvents] Philippe Le Hégaret, Tom Pixley, Document Object Model (DOM) Level 3 Events Specification, http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331, W3C, 2003. [HTML4] Dave Raggett, Arnoud Le Hors, Ian Jacobs, HTML 4.01 Specification, http://www.w3.org/TR/1999/REC-html401-19991224, W3C, 1999. [JDBC] Jon Ellis, Linda Ho, Maydene Fisher, JDBC 3.0 Specification, http://java.sun.com/products/jdbc/, Sun Microsystems, Inc., 2001. [MathML] David Carlisle, Patrick Ion, Robert Miner, Nico Poppelier, Mathematical Markup Language (MathML) Version 2.0 (Second Edition), http://www.w3.org/TR/2003/REC-MathML220031021/, W3C, 2003. [MIMETYPES] , List of registered MIME types, ftp://ftp.isi.edu/in-notes/iana/assignments/mediatypes/, IANA, . [OLE]

Kraig Brockschmidt, Inside OLE, Microsoft Press, 1995, ISBN: 1-55615-843-2

[OOo] , OpenOffice.org XML File Format 1.0 Technical Reference Manual, http://xml.openoffice.org/xml_specification.pdf, Sun Microsystems, Inc., 2002. [PNG] Thomas Boutell, PNG (Portable Network Graphics) Specification, http://www.w3.org/TR/REC-png-multi.html, W3C, 1996. [RFC1766] H. Alvestrand, Tags for the Identification of Languages, http://www.ietf.org/rfc/rfc1766.txt, IETF, 1995. [RFC2048] N. Freed, J. Klensin, J. Postel, Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures, http://www.ietf.org/rfc/rfc2048.txt, IETF, 1996. [RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF, 1997. [RFC2396] T. Berners-Lee, R. Fielding, U.C. Irvine, L. Masinter, Uniform Resource Identifiers (URI): Generic Syntax, http://www.ietf.org/rfc/rfc2396.txt, IETF, 1998. [RFC2616] IETF, Hypertext Transfer Protocol -- HTTP/1.1, http://www.ietf.org/rfc/rfc2616.txt, IETF, 1999. [RFC2898] B. Kaliski, PKCS #5: Password-Based Cryptography Specification Version 2.0, http://www.ietf.org/rfc/rfc2898, IETF, 2000. [RFC3066] H. Alvestrand, Tags for the Identification of Languages, http://www.ietf.org/rfc/rfc3066.txt, IETF, 2001. [RNG] James Clark, MURATA Makoto, RELAX NG Specification, http://oasisopen.org/committees/relax-ng/spec-20011203.html, OASIS, 2001.

1 May 2005 Page 695 of 706

[SMIL20] W3C, Synchronized Multimedia Integration Language 2.0 (SMIL 2.0), http://www.w3.org/TR/smil20/, W3C, 2001. [SVG] Jon Ferraiolo, (FUJISAWA Jun), Dean Jackson, Scalable Vector Graphics (SVG) 1.1, http://www.w3.org/TR/2003/REC-SVG11-20030114/, W3C, 2003. [XForms]

W3C, XForms, http://www.w3.org/TR/xforms/, W3C, 2004.

[XLink] Steve DeRose, Eve Maler, David Orchard, XML Linking Language, http://www.w3c.org/TR/xlink/, W3C, 2001. [xml-names] Tim Bray, Dave Hollander, Andrew Layman, Namespaces in XML, http://www.w3.org/TR/REC-xml-names/, W3C, 1999. [XML1.0] Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, Eve Maler, François Yergeau , Extensible Markup Language (XML) 1.0 (Third Edition), http://www.w3.org/TR/2004/REC-xml20040204, W3C, 2004. [xmlschema-2] Paul V. Biron, Ashok Malhotra, XML Schema Part 2: Datatypes, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/, W3C, 2001. [XSL] W3C, Extensible Stylesheet Language (XSL), http://www.w3.org/TR/2001/REC-xsl20011015/, W3C, 2001. [XSLT] James Clark, XSL Transformations (XSLT) Version 1.0, http://www.w3.org/TR/1999/REC-xslt-19991116, W3C, 1999. [XSLT2] Michael Kay, XSL Transformations (XSLT) Version 2.0, http://www.w3.org/TR/2003/WD-xslt20-20031112/, W3C, 2003. [ZIP] , .ZIP File Format Specification, http://www.pkware.com/products/enterprise/white_papers/appnote.txt, PKWARE Inc., 2004.

1 May 2005 Page 696 of 706

Appendix C.MIME Types and File Name Extensions (Non Normative) The MIME types and extensions contained in this section are applicable only to office documents that are contained in a package (see section 2.1). See section 1.7 for the MIME type to use for documents that are not contained in a package. The following table contains a list of MIME types and extensions for documents that conform to this specification, that, at the time this specification is published, have been registered according to [RFC2048]. Please see [MIMETYPES] for a current list of registered MIME types. MIME type

Ext.

Description

No registered MIME types exist at the time this specification is published. The following table contains a list of MIME types and extensions for office documents that conform to this specification where a registration according to [RFC2048] is in progress at the time this specification is published. Please check [MIMETYPES] before using these MIME types. If a MIME type is not listed there, it is RECOMMENDED to use the MIME type that is the result of inserting "x-" behind the "/" character (i.e. application/x-vnd.oasis.opendocument.text). MIME type

Ext.

Description

application/vnd.oasis.opendocument.text

odt Text document

application/ vnd.oasis.opendocument.text-template

ott Text document used as template

application/vnd.oasis.opendocument.graphics

odg Graphics document (Drawing)

application/ vnd.oasis.opendocument.graphics-template

otg Drawing document used as template

application/vnd.oasis.opendocument .presentation

odp Presentation document

application/ vnd.oasis.opendocument.presentationtemplate

otp Presentation document used as template

application/vnd.oasis.opendocument .spreadsheet

ods Spreadsheet document

application/ vnd.oasis.opendocument.spreadsheettemplate

ots Spreadsheet document used as template

application/vnd.oasis.opendocument.chart

odc Chart document

application/ vnd.oasis.opendocument.chart-template

otc Chart document used as template

application/vnd.oasis.opendocument.image

odi Image document

1 May 2005 Page 697 of 706

MIME type

Ext.

Description

application/ vnd.oasis.opendocument.image-template

oti Image document used as template

application/vnd.oasis.opendocument.formula

odf Formula document

application/ vnd.oasis.opendocument.formula-template

otf Formula document used as template

application/vnd.oasis.opendocument.textmaster

odm Global Text document (see section 2.3.1)

application/vnd.oasis.opendocument.text-web

oth Text document used as template for HTML documents

1 May 2005 Page 698 of 706

Appendix D.Core Features Sets (Non Normative) The OpenDocument specification does not specify which elements and attributes conforming application must, should, or may support. The intention behind this is to ensure that the OpenDocument specification can be used by as many implementations as possible, even if these applications do not support some or many of the elements and attributes defined in this specification. Viewer applications for instance may not support all editing relates elements and attributes (like change tracking), other application may support only the content related elements and attributes, but none of the style related ones. Even typical office applications may only support a subset of the elements and attributes defined in this specification. They may for instance not support lists within text boxes or may not support some of the language related element and attributes. The follow table provides an overview which element and attributes usually are supported by typical office application. It lists the chapters and sections contained in this specification and some typical office application classes. An “X” in this table indicates that most (or at least a significant number) of the elements and attributes defined in a section usually are supported by a certain application classes. An “(X)” indicates that only a limited number of elements and attributes usually is supported. Section.

Title

Text

Spread sheet

Drawing

Presentation

Chart

Image

2.2 Document Metadata

2.3 Body Element and Document Types

2.4 Application Settings

2.5 Scripts

2.6 Font Face Declarations

2.7 Styles

2.8 Page Styles and Layout

3 Metadata Elements

4.1 Paragraphs and Basic Text Structure

X(1)

X(2)

X(3)

4.1 Headings

4.2 Page Sequences

4.3 Lists

X(2)

4.4 Text Sections

4.5 Page-bound graphical content

1 May 2005 Page 699 of 706

Section.

Title

Text

Spread sheet

Drawing

Presentation

Chart

4.6 Text Change Tracking

4.7 Text Declarations

(X)

5.1 Basic Text Content

X(1)

X(2)

X(3)

5.2 Bookmarks and References

5.3 Notes

5.4 Ruby

5.5 Text Annotation

5.6 Index Marks

5.7 Change Tracking and Change Marks

5.8 Inline graphics and textboxes

X (X)

(X)

6 Text Fields

7 Text Indices

8.1 Basic Table Model

8.2 Advanced Table Model

8.3 Advanced Tables

8.4 Advanced Table Cells

8.5 Spreadsheet Document Content

8.6 Database Ranges

8.7 Filters

8.8 Data Pilot Tables

8.9 Consolidation

8.10 Table DDE Links

8.11 Change Tracking in Spreadsheets

9.1 Enhanced Page Features for Graphical Applications 9.2 Drawing Shapes

9.3 Frames

Image

X(4)

1 May 2005 Page 700 of 706

Section.

Title

Text

Spread sheet

Drawing

Presentation

9.4 3D Shapes

9.5 Custom Shapes

9.6 Presentation Shapes

9.7 Presentation Animations

9.8 SMIL Presentation Animations

9.9 Presentation Events

9.10 Presentation Text Fields

9.11 Presentation Document Content

10 Chart Content 11 Form Content

Chart

Image

X X

12.1 Annotation

X(5)

X(1)

12.2 Number Format for page numbers, etc.

12.3 Change Tracking Metadata

12.4 Event Listener Tables

12.5 Mathematical Content

12.6 DDE Connections

13 SMIL Animations

14.1 Style Element

14.2 Default Styles

14.3 Page Layout

14.4 Master Pages

14.5 Table Templates

14.6 Font Face Declaration

14.7 Data Styles

14.8 Text Styles

X(6)

14.9 Enhanced Text Styles

14.10 List Style

1 May 2005 Page 701 of 706

Section.

Title

Text

Spread sheet

Drawing

Presentation

14.11 Outline Style

14.12 Table Styles

14.13 Graphic Styles

14.14 Enhanced Graphic Style Elements

14.15 Presentation Page Layouts

Chart

Image

14.16 Chart Styles

15.2 Page Layout Formatting Properties

15.3 Header Footer Formatting Properties

(X)

15.4 Text Formatting Properties

15.5 Paragraph Formatting Properties

15.6 Ruby Text Formatting Properties

15.7 Section Formatting Properties

15.8 Table Formatting Properties (X)

15.9 Column Formatting Properties

(X)

15.10 Table Row Formatting Properties

(X)

15.11 Table Cell Formatting Properties

(X)

15.12 List-Level Style Properties

15.13 Stroke Properties

X(7)

15.14 Fill Properties

X(7)

15.15 Text Animation Properties

X(7)

15.16 Text Alignment Properties

X(7)

15.17 Color Properties

X(7)

15.18 Shadow Properties

X(7)

1 May 2005 Page 702 of 706

Section.

Title

Text

Spread sheet

Drawing

Presentation

Chart

15.19 Connector Properties

X(7)

15.20 Measure Properties

X(7)

15.21 Caption Properties

X(7)

15.22 3D Geometry Properties

X(7)

15.23 3D Lighting Properties

X(7)

15.24 3D Texture Properties

X(7)

15.25 3D Material Properties

X(7)

15.26 3D Shadow Properties

X(7)

15.27 Frame Formatting Properties

(X)

15.28 Floating Frame Formatting Properties

15.29 Chart Formatting Properties

15.30 Chart Subtype Properties

15.31 Chart Axes Properties

15.32 Common Chart Properties

15.33 Statistical Properties

15.34 Plot Area Properties

15.35 Regression Curve Properties

15.36 Presentation Page Attributes

Image

(1) within table cells (2) within text boxes (3) within some chart objects (4) only frames that contain images (5) within text (6) only automatic styles (7) only for drawing shapes

1 May 2005 Page 703 of 706

Appendix E.Changes From Previous Specification Versions (Non Normative) E.1. Changes from “Open Office Specification 1.0 Committee Draft 1” The following are the changes since the “Open Office Specification 1.0 Committee Draft 1”: •

The name of this specification has been changed to “Open Document Format for Office Applications (OpenDocument) 1.0”.

•

The namespace URIs (section 1.3) have been adapted to the new specification name.

•

The MIME type recommendations have been moved into a non normative appendix (appendix C) and have been adapted to the new specification name.

•

Various new definitions have been added. Among them are: –

Custom Shapes (section 9.5)

–

SMIL Animations (section 9.8 and chapter 13)

–

Support for XForms (section 11.2)

•

Various errors in the schema and descriptions have been corrected.

•

Some descriptions have been rewritten for easier understanding.

E.2. Changes from “Open Document Format for Office Applications (OpenDocument) 1.0 Committee Draft 2” The following are the changes since the “Open Document Format for Office Applications (OpenDocument) 1.0 Committee Draft 2”: •

•

Namespaces for compatible elements and attributes have been added as follows: –

urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0 for attributes that are compatible with [XSL];

–

urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0 for elements and attributes that are compatible with [SVG];

–

urn:oasis:names:tc:opendocument:xmlns:smil-compatible:1.0 for attributes that are compatible with [SMIL20].

The following namespaces are not imported any longer: –

http://www.w3.org/1999/XSL/Format

–

http://www.w3.org/2000/svg

–

http://www.w3.org/2001/SMIL20/

The attribute xforms:submission specified in section 11.3.11 has been renamed to form:xforms-submission.

1 May 2005 Page 704 of 706

•

Information for Custom Shapes (section 9.5), SMIL Animations (sections 9.8 and chapter 13) and Presentation Text Fields (section 9.10) has been added to the core feature set table in appendix D; the chapter numbers in the table have been updated.

1 May 2005 Page 705 of 706

Appendix F.Notices OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification, can be obtained from the OASIS Executive Director. OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director.

Copyright © OASIS Open 2005. All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself does not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

1 May 2005 Page 706 of 706

OpenDocument Format for Office Applications (OpenDocument) v1.0 (2005-05-01)

Related documents