PHP Classes

File: xml_synopsis.txt

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in Bookmark in
  Classes of Skrol29  >  OpenTBS  >  xml_synopsis.txt  >  Download  
File: xml_synopsis.txt
Role: Documentation
Content type: text/plain
Description: a small synopsis of XML structure for the OpenOffice and Ms Office documents
Class: OpenTBS
make LibreOffice, OpenOffice & Ms Office documents
Author: By
Last change: Comes with OpenTBS 1.9.1
Date: 11 months ago
Size: 26,719 bytes


Class file image Download
Synopsis of XML files stored in the archives supported by OpenTBS.
Version 2013-01-08

Extensions:  odt, odg, ods, odf, odp, docx, xlsx and pptx

This file is incomplete, feel free to send your own comments to:

OpenOffice Documents (.ODT, .ODS, .ODG, .ODF, .ODP, .ODM)
LibreOffice Documents

All simple quotes "'" in texts are coded with "'" but they are automatically replaced by the OpenTBS plugin.

The main information is stored in the file 'content.xml'.
The pictures are stored in the directory 'Pictures' and should be registered into the file 'META-INF/manifest.xml'. (OpenTBS does it automatically for you when you use parameter "addpic")
Since OpenOffice 3.2, if a picture is not registered in the Manifest file, then it can produce a message error when opening the document.
Video and sound cannot be stored in OpenOffice documents.

Main file: "content.xml":

      <text:p text:style-name="Standard">
        Normal new lines are made with a new paragraphs <text:p>...</text:p>
        Simple new lines are made with <text:line-break/>
        Tabs are made with <text:tab/>
        Page-breaks are made with a new paragraph having a style which has the attribute fo:break-before="page" or fo:break-after="page".
		Note that the page-break does not work if the attribute is in the paragraph element. A "break-before" at the first page, or a "break-after" on the last page has no effect.
        Local styles (bold, color,...) are made with <text:span text:style-name="T1">...</text:span>
	  <text:h>...</text:h> A paragraph typed as Header
	  <text:list>...</text:list> A list of items
	  <table:table>...</table:table> A table

<text:p> ... </text:p>
  <text:section text:style-name="Sect1" text:name="Section1">
    <text:p> ... </text:p>
    <text:p> ... </text:p>
<text:p> ... </text:p>

Slides in a presentation
<draw:page ....>

Table in a document:
  <table:table-column ... />
  <table:table-column ... />
  <table:table-column ... />
    <table:table-cell> ... </table:table-cell>
    <table:table-cell table:number-columns-spanned="2"> ... </table:table-cell>
	<table:covered-table-cell/> // virtual column that is covered by the span
    <table:table-cell> ... </table:table-cell>

* Merging cells vertically:

<table:table-cell table:number-rows-spanned="2" office:value-type="string">
		<text:span> CONTENT OF THE CELL </text:span>

Cell that are not displayed because of vertical merging or horizontal mergin, are replaced with
But such entities seems to be optionnal: LibreOffice display correclty the table if they are ommited.

Attributes  table:number-rows-spanned="1" seems to be supported and has no effect.
* Merging cells horizontally:

<table:table-cell table:number-columns-spanned="2" office:value-type="string">
		<text:span> CONTENT OF THE CELL </text:span>


Comments in ODS workbooks (OpenOffice Calc):

<table:table-row table:style-name="ro2">
  <table:table-cell ...> ... </table:table-cell>
  <table:table-cell office:value-type="float" office:value="3.6">
    <office:annotation draw:style-name="gr1" draw:text-style-name="P1" svg:width="2.899cm" svg:height="0.991cm" svg:x="9.632cm" svg:y="2.786cm" draw:caption-point-x="-0.61cm" draw:caption-point-y="1.511cm">
      <text:p text:style-name="P1">Here is my comment.</text:p>
  <table:table-cell ...> ... </table:table-cell>

Comments in ODT documents (OpenOffice Write):

<text:p text:style-name="Standard">
  Here is the start of the text and now 
    <text:p text:style-name="P1">
      <text:span text:style-name="T1">Here is my comment.</text:span>
  comment is just inserted there.

Headers and footers in a document :

Header and footer contents are saved in the "sytles.xml" file:
You can choose for each page to hide or display the header and footer. Nevertheless, the contents is always the same for each page.

<office:document-styles ...>
    <style:master-page ...>
        <text:p text:style-name="Header">here is the header</text:p>
        <text:p text:style-name="Footer">here is the footer</text:p>

Header and footer contents are saved in "content.xml" file.
They are defined as available styles and can be use for any slide and for the whole document in the "handout" view which is a set of several slide.

      <presentation:header-decl presentation:name="hdr1">Here is my header</presentation:header-decl>
      <presentation:footer-decl presentation:name="ftr1">Here is my footer for slide 1</presentation:footer-decl>
      <presentation:footer-decl presentation:name="ftr2">Here is my footer</presentation:footer-decl>
      <draw:page ... presentation:use-footer-name="ftr1">
The location of the chart is defined in the main subfile "contents.xml":

<text:p text:style-name="Standard">
  <draw:frame draw:name="My name" text:anchor-type="paragraph" svg:x="2.401cm" svg:y="1.379cm" svg:width="14.102cm" svg:height="7.622cm" draw:z-index="0">
    <draw:object xlink:href="./Object 1" xlink:type="simple" xlink:show="embed" xlink:actuate="onLoad" />
    <draw:image xlink:href="./ObjectReplacements/Object 1" xlink:type="simple" xlink:show="embed" xlink:actuate="onLoad" />
    <svg:title>My title</svg:title>
    <svg:desc>My description</svg:desc>

An image preview is saved in the file "ObjectReplacements/Object 1", and this image will be displayed
automatically instead of the real Chart view until the chart is manually changed in the document.
In order to avoid this preview, the followings must be deteled :
- the file "ObjectReplacements/Object 1",
- the reference <draw:image> in the "contents.xml" file,
- the reference <draw:image> in the "META-INF/manifest.xml" file.

Data and properties of the chart are saved into the corresponding subdirectory "Object 1".
Data are saved in "Object 1/contents.xml" in a table that groups data of all series of the chart.

<table:table table:name="local-table">

    <table:table-column />
    <table:table-column table:number-columns-repeated="3" />

      <table:table-cell><text:p /></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>column 1</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>column 2</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>column 3</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>ligne 1</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="9.1"><text:p>9.1</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="3.2"><text:p>3.2</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="4.54"><text:p>4.54</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>ligne 2</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="2.4"><text:p>2.4</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="8.8"><text:p>8.8</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="9.65"><text:p>9.65</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>ligne 3</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="3.1"><text:p>3.1</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="1.5"><text:p>1.5</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="3.7"><text:p>3.7</text:p></table:table-cell>
      <table:table-cell office:value-type="string"><text:p>ligne 4</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="4.3"><text:p>4.3</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="9.02"><text:p>9.02</text:p></table:table-cell>
      <table:table-cell office:value-type="float" office:value="6.2"><text:p>6.2</text:p></table:table-cell>


<text:p text:style-name="Standard">
  <draw:frame draw:style-name="fr1" draw:name="Frame1" text:anchor-type="paragraph" svg:width="4.535cm" draw:z-index="0">
    <draw:text-box fo:min-height="2.461cm">
      <text:p text:style-name="Frame_20_contents">Message in a textbox</text:p>
  Usual text

Special to .ODF (OpenOffice Math Formula):
Any comment in the formula must be entered between text delimiters which are the double quotes (").
Newlines are made with the keyword 'newline' outside the text delimiter. 

Binary contents is saved as a file in "Pictures/"
Short synopsis of the control in the document:
<text:p ...>
  <draw:frame ...>
    <draw:text-box ...>
      <text:p ...>
        <draw:a ...>
           <draw:frame draw:style-name="fr1" draw:name="images1" text:anchor-type="paragraph" svg:width="0.847cm" svg:height="0.847cm" draw:z-index="0">
              <draw:image xlink:href="Pictures/100000000000002000000020A0D29467.jpg" xlink:type="simple" xlink:show="embed" xlink:actuate="onLoad"/>

Ms Office Document (.DOCX, .XLSX, .PPTX)

Ms Word Document (.DOCX)

The main file is usually "word/document.xml", but its actual location is defined in the file "[Content_Types].xml", in the element:
  <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>

Note: I've test to change the "word/document.xml" name in both the "[Content_Types].xml" file and the archive, but this makes 
  Word 2010 to be unable to open the document, saying it is corrupted.

Synopsis of the main file "word/document.xml": (DOCX)

    <w:p> // New paragraph
        // Parameters of the paragraph
        <w:rPr> ... </w:rPr> // Set of parameters for a Run
          // Start a new section. Sections are a set of page layout (margin, columns, ...) available until the next section.
          <w:type w:val="continuous"/> // May be present whe the section is defined manually.
        <w:pageBreakBefore/> // Page break before the paragraph (way #1)
        // New run item. A run item is a set of content having common layout properties.
        <w:rPr> Set of parameters for a Run. Examples: <w:i/> is italic, <w:b/> is bold. </w:rPr>
        <w:t> Your text is here</w:t>
        // Simple new lines are made with <w:br/>
        // Page breaks can also be made with <w:br w:type="page"/> (way #2)
      <w:tab/> // Tabs are placed between <w:r> elements.
	  <w:r><w:t xml:space="preserve"> Next text </w:t></w:r> // spaces between entities are dealt using attribute xml:space="preserve"


What are attributes "w:rsidR" and "w:rsidRPr" for?
"w:rsidR" is a Revision ID. Each new user on a doc has a new id, 
and each of its modification is marked with its RsID.
 More info:

Synopsis of a table inserted in a Word document: (DOCX)

      <w:gridCol ... /> // principally define colmun widths
      <w:gridCol ... />
      <w:tc> ... </w:tc>
      <w:tc> ... </w:tc>


* Merging cells vertically:

		<w:vMerge w:val="restart"/>  // marks the cell to start a new cell-merging
		<w:vMerge w:val="continue"/> // marks the cell to continue the cell-mergin (the cell is merged with a previous one having "restart" or "continue")
		<w:vMerge/> // same as above
		// no <w:vMerge> entity means the cell is not merged. 

* Merging cells horizontally:

		<w:gridSpan w:val="2"/> // It works like "colspan" in HTML.
Headers and footers: (DOCX)

The headers and footers files are usually "word/header1.xml" and "word/footer1.xml".
They exists only if header/footer is defined.
There also may have an optional couple of XML files for odd numbered pages (usually "word/header2.xml" and "word/footer2.xml").
And an optional couple of files for the first page (usually "word/header3.xml" and "word/footer3.xml").

The actual type and locations of Headers and Footers are defined in the main document "word/document.xml"
Close to the bottom of it may have :
  <w:headerReference w:type="default" r:id="rId13"/>
  <w:footerReference w:type="default" r:id="rId14"/>
  <w:headerReference w:type="first" r:id="rId15"/>
  <w:footerReference w:type="first" r:id="rId16"/>

Relation files

The information related to r:id are stored in the file "word/_rels/document.xml.rels"
<Relationships xmlns="">
  <Relationship Id="rId8" Type="" Target="media/image1.png"/>
  <Relationship Id="rId13" Type="" Target="header1.xml"/>

Locations are also appering in the file "[Content_Types].xml", in the elements like:
  <Override PartName="/word/header1.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml"/>
  <Override PartName="/word/footer1.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml"/>
Some referenced header/footers may have no actual files because of no data.

Example of header source:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<w:hdr ...>
    <w:pPr><w:pStyle w:val="my_header"/></w:pPr>
      <w:t>here is the text of the header</w:t>

Comments, footnotes and endnotes: (DOCX)
Like headers and footers, they are aslo saved in separated XML files.

  <w:r><w:t xml:space="preserve">Here is a </w:t></w:r>
  <w:bookmarkStart w:id="0" w:name="mybookmark"/>
  <w:bookmarkEnd w:id="0"/>


      <mc:Choice Requires="wps">
          <wp:anchor ...>
          <v:shapetype ...>
          <v:shape ...>
            <v:textbox ...>
                <w:p> <w:r> <w:t>Here s a text box.</w:t>  </w:r> </w:p>

Charts: (DOCX)

The first chart is saved under "word/charts/chart1.xml", and so on for the next ones.
The XML file of the chart contains a copy of the data used for the chart.
If the chart is designed manually, then "chart1.xml" also contains references to cells of an Ms Excel files that is used by Ms Word for managing series.
The Excel file is emmbeded in the Docx file, for exemple: "word/embeddings/Worksheet_Microsoft_Excel1.xlsx"
The path of the Excel file is saved into "word/charts/_rels/chart1.xml.rels".
Nevertheless the references to that Exvel file are optional and can be deleted from the XML of the chart.

Title of the chart, the axes and the series are saved in "chart1.xml".
Other custom text boxes are saved in a shape file. For example : "word/drawings/drawing1.xml"

Example of a series saved in the XML (the tags are different for an XY series):

  <c:idx val="0"/>
  <c:order val="0"/>
      <c:strCache><c:ptCount val="1"/><c:pt idx="0"><c:v>Here is the name of the Series</c:v></c:pt></c:strCache>
    <a:solidFill><a:srgbClr val="9999FF"/></a:solidFill>
    <a:ln w="12700"><a:solidFill><a:srgbClr val="000000"/></a:solidFill><a:prstDash val="solid"/></a:ln>
  <c:invertIfNegative val="0"/>
        <c:ptCount val="4"/>
        <c:pt idx="0"><c:v>Category A</c:v></c:pt>
        <c:pt idx="1"><c:v>Category B</c:v></c:pt>
        <c:pt idx="2"><c:v>Category C</c:v></c:pt>
        <c:pt idx="3"><c:v>Category D</c:v></c:pt>
        <c:ptCount val="4"/>
        <c:pt idx="0"><c:v>20.399999999999999</c:v></c:pt>
        <c:pt idx="1"><c:v>27.4</c:v></c:pt>
        <c:pt idx="2"><c:v>90</c:v></c:pt>
        <c:pt idx="3"><c:v>20.399999999999999</c:v></c:pt>

Ms Excel SpreadSheet (XLSX)

An Excel workbook can have one or several worksheets. The contents of cells are saved in worksheets.
Worksheets files are named 'xl/worksheets/sheet1.xml', and also sheet2.xml, sheet3.xml...
The file names are not the names defined in Excel by the user, they are internal names. But it seems
that there is always at least a worksheet named 'sheet1.xml'.

All string values of cells are stored in the file 'xl/sharedStrings.xml'. The cells contains
in fact the index of the string in the sharedStrings.xml file. This separation will probably
make difficulties  to merge an Excel sheet. 

All sheets of the workbook are listed in the file "xl/workbook.xml".

Synopsis of a sheet file like "xl/worksheets/sheet1.xml": (XLSX)
    <row r="2" spans="2:2" ht="90">
      // A range of one row in wich several cells are defined
      <c r="B2" s="1" t="s">
		/* Definition of a cell:
         * Attribute r is the address if the cell in the sheet (format A1). This attribute is optional.
         * Attribute s is the style of the cell (the format). Styles are saved into the file 'xl/styles.xml' but I have not found the link yet.
         * Attribute t is the type of data, by default it is numerical
         * t="s" means that the displayed value is a string, the saved value is the index if the string taken in file sharedStrings.xml.
        <f>B13+B14</f> //the formula. If there is no formula, this tag is absent.
        <v>0</v> //the inner value without formatting. If t="s" then the value is in fact the index of the string in the "xl/sharedStrings.xml" file.

Synopsis of the Shared String file "xl/sharedStrings.xml": (XLSX)
    <t>value or text</t>

Headers and footers: (XLSX)
Like as DCX, they can be up to 6 headers/footers for each sheet.
Header and footers are saved in the sheet file.

  <headerFooter differentOddEven="1" differentFirst="1">
    <oddHeader>My header for odd page in this sheet</oddHeader>
    <evenHeader>My header for even page in this sheet</evenHeader>
    <firstHeader>My header for first page in this sheet</firstHeader>

Ms PowerPoint Presentation (PPTX)

Think to set all texts to "Tools\Language\No check" when you edit the PowerPoint presentation, otherwise some TBS fields
can be split by XML tags about the language and spell checking.

Slides are listed in the file 'ppt/_rels/presentation.xml.rels', where an internal id is affected to them.

The first slide is quite always corresponding to the file 'ppt/slides/slide1.xml'.

Synopsis of a slide file like "ppt/slides/slide1.xml": (PPTX)


            <a:pPr eaLnBrk="1" hangingPunct="1"/>
              <a:t>Some text here</a:t>


Headers and footers: (PPTX)

They can be headers and footers for each slide, and aslo an header and footer for the "handout" view, wich is a set of several slides.
Header and footer of each slide is saved in the sub-file of the slide ("ppt/slides/slide1.xml" for example).
Header and footer of the handout is saved ins ubs-file "ppt/handoutMasters/handoutMaster1.xml".

Binary contents is saved as a file in "word/media/" , "ppt/media/" , "xl/media/"

Word : (DOCX)
image link saved into "word/_rels/document.xml.rels":
  <Relationship Id="rId6" Type="" Target="media/image1.png"/>

They are two ways to insert a picture.

1) VML: (old classic way)
(short synopsis)
  <v:shapetype ...>
  <v:shape style="width:89.25pt;height:119.25pt" ...> // this element contains the size of the picture
    <v:imagedata r:id="rId6" o:title=""/> // this element contains the link to the picture internal file

2) DrawingML: (the new way that includes 2D/3D effects)
(short synopsis)
  <wp:inline ...>
    <wp:extent cx="1130400" cy="1512000" /> // this element gives the size of the shape box that contains the picture
	<wp:docPr id="1" name="Image 1" descr="My description" title="My title"/> // this optional element gives the description and title of the image
	<wp:docPr id="1" name="Image 0" descr="2884414-my_picture.jpg">
	  <a:hlinkClick xmlns:a="" r:id="rId4" tooltip="My tooltip"/> // this optional element gives the URL and tooltip of the link if any. In Word 2007 you cannot customize the title and desciption
    <a:graphic ...>
      <a:graphicData ...>
        <pic:pic ...>

            <a:blip r:embed="rId4" /> // this element contains the link to the picture internal file

          <pic:spPr ...>
               <a:off x="0" y="0" />
               <a:ext cx="1130400" cy="1512000" /> // this element gives the size of the picture inside its shape box, it can be rescaled to fit in the shape box
            <a:prstGeom prst="rect"><a:avLst /></a:prstGeom>
            <a:noFill />
            <a:ln><a:noFill /></a:ln>


Powerpoint: (PPTX)

(short synopsis)
	  <p:cNvPr id="4" name="Image 3" descr="My description" title="My title">  // this optional element gives the description and title of the image
		<a:hlinkClick r:id="rId2" action="ppaction://hlinkfile" tooltip="My toolip"/>
		<a:blip r:embed="rId2">
			<a:off x="2667000" y="4365104" />
			<a:ext cx="3810000" cy="1200150" />

Excel: (XLSX)
The presence of pictures in the sheet is mentioned with a single <drawing> entity at the bottom of the <worksheet> entity.
The <drawing> entity carries a reference id, which is defined the Rels file of the sheet.
All properties of all the pictures in a sheet are finally saved in a third XML file. 

* File "xl\worksheets\sheet1.xml"
<worksheet ...>
  <drawing r:id="rId2"/> (only one entity for all pictures in the sheet)

* File "xl\worksheets\_rels\sheet1.xml.rels"
<Relationship Id="rId2" Type="" Target="../drawings/drawing1.xml"/> (only one entity for all pictures in the sheet)

* File "xl\drawings\drawing1.xml"
(short synopsis, one entity per picture in the sheet)
<xdr:twoCellAnchor ...>
			<xdr:cNvPr id="2" name="Image 1" descr="xxx my description" title="xxx my title"/>
			<a:blip xmlns:r="" r:embed="rId1">