Document

This is a reference for the Document model used in Doxia.

An XSD is available at:

<document outputName=.. >
  <meta>
    <title/>
    <author/>
    <authors>
      <author>
        <firstName/>
        <lastName/>
        <name/>
        <initials/>
        <title/>
        <position/>
        <email/>
        <phoneNumber/>
        <faxNumber/>
        <companyName/>
        <street/>
        <city/>
        <postalCode/>
        <country/>
        <state/>
      </author>
    </authors>
    <subject/>
    <keywords/>
    <keyWords/>
    <pageSize/>
    <generator/>
    <description/>
    <initialCreator/>
    <creator/>
    <printedBy/>
    <creationDate/>
    <creationdate/>
    <date/>
    <modifydate/>
    <printDate/>
    <printdate/>
    <template href=.. title=.. date=.. modifydate=.. />
    <hyperlinkBehaviour targetFrame=.. />
    <language/>
    <editingCycles/>
    <editingDuration/>
    <documentStatistic pageCount=.. tableCount=.. drawCount=.. imageCount=.. objectCount=.. oleObjectCount=.. paragraphCount=.. wordCount=.. characterCount=.. rowCount=.. frameCount=.. sentenceCount=.. syllableCount=.. nonWhitespaceCharacterCount=.. />
    <confidential/>
    <draft/>
  </meta>
  <toc name=.. depth=.. >
    <item name=.. ref=.. collapse=.. >
      <item>...recursion...<item>
    </item>
  </toc>
  <cover>
    <coverTitle/>
    <coverSubTitle/>
    <coverVersion/>
    <coverType/>
    <coverDate/>
    <coverdate/>
    <authors>
      <author>
        <firstName/>
        <lastName/>
        <name/>
        <initials/>
        <title/>
        <position/>
        <email/>
        <phoneNumber/>
        <faxNumber/>
        <companyName/>
        <street/>
        <city/>
        <postalCode/>
        <country/>
        <state/>
      </author>
    </authors>
    <author/>
    <projectName/>
    <projectLogo/>
    <companyName/>
    <companyLogo/>
  </cover>
</document>

document

Describes the overall document model.

Attribute Type Description
outputName String The name of the generated document, without extension.
Element Type Description
meta DocumentMeta The Meta information properties.
toc DocumentTOC The TOC (Table of Contents) information properties.
cover DocumentCover The meta data to construct a cover page for the document.

meta

Metadata is general information about a document.

The metadata elements used here were mostly inspired by the Open Document Format Specification v. 1.1, which in turn borrows heavily upon the metadata standards developed by the Dublin Core Metadata Initiative.

Element Type Description
title String The title of the document.
author String The unique author of the document, usually as a String of "firstName lastName". For more authors, you could use the <authors/> tag.
authors/author* List<DocumentAuthor> (Many) The authors of the document. The names of the entities that are primarily responsible for the content of the document.
subject String The subject of the document.
keywords String The keywords for the document, usually as a String of comma separated keywords. @deprecated use the <keyWords/> tag instead of.
keyWords/keyWord* List<String> (Many) A keyword pertaining to the document. The metadata can contain any number of keyword elements, each element specifying one keyword.
pageSize String The pagesize of the document. At least "US", "USLetter" and "A4" should be supported.
generator String A string that identifies the application or tool that was used to create or last modify the document.
description String A brief description of the document.
initialCreator String The name of the person who created the document initially.
creator String The name of the person who last modified the document.
printedBy String The name of the person who last printed the document.
creationDate Date The date and time when the document was created initially. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
creationdate String The date as String (recommended format is ISO 8601) when the document was created initially. Only used if creationDate is not set. @since 1.1.1
date Date The date and time when the document was last modified. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
modifydate String The date as String (recommended format is ISO 8601) when the document was last modified. Only used if date is not set. @since 1.1.1
printDate Date The date and time when the document was last printed. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
printdate String The date as String (recommended format is ISO 8601) when the document was last printed. Only used if printDate is not set. @since 1.1.1
template DocumentTemplate A template that was used to create the document.
hyperlinkBehaviour DocumentHyperlinkBehaviour The hyperlink-behaviour element specifies the default behavior for hyperlinks in the document.
language String The default language of the document. The language is represented by 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.
Default value is: en-US.
editingCycles long The number of editing cycles the document has been through.
Default value is: 0.
editingDuration long The total time spent editing the document.
Default value is: 0.
documentStatistic DocumentStatistic The statistics of the document, for example, the page count, word count, etc.
confidential boolean whether the content of the document is in some sense confidential.
Default value is: false.
draft boolean whether the content of the document is in some sense preliminary.
Default value is: false.

author

An author of the document.

Element Type Description
firstName String The first name of the author.
lastName String The last name of the author.
name String The full name of the author, usually as a String of "firstName lastName". @since 1.1.1
initials String The initials of the author.
title String The title of the author.
position String The position of the author.
email String The email address of the author.
phoneNumber String The telephone number of the author.
faxNumber String The fax number of the author.
companyName String The name of the company that employs the author.
street String The street name of the address of the author.
city String The city name of the address of the author.
postalCode String The postal code of the address of the author.
country String The country of the address of the author.
state String The state or province of the address of the author, if applicable.

template

A template that was used to create the document.

Attribute Type Description
href String The location of the document template.
title String The name of the document template.
date Date The date and time when the template was last modified, prior to being used to create the current document. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
modifydate String The date as String (recommended format is ISO 8601) when the template was last modified. Only used if date is not set. @since 1.1.1

hyperlinkBehaviour

Specifies the default behavior for hyperlinks in the document.

Attribute Type Description
targetFrame String The name of the default target frame.

Specifies the name of the default target frame in which to display a document referenced by a hyperlink.

This attribute can have one of the following values:

_self
The referenced document replaces the content of the current frame.
_blank
The referenced document is displayed in a new frame.
_parent
The referenced document is displayed in the parent frame of the current frame.
_top
The referenced document is displayed in the topmost frame, that is the frame that contains the current frame as a child or descendent but is not contained within another frame.
A frame name
The referenced document is displayed in the named frame. If the named frame does not exist, a new frame with that name is created.

Default value is: _self.

documentStatistic

Statistical attributes of the document.

Attribute Type Description
pageCount long The number of pages in the document.
Default value is: 0.
tableCount long The number of tabels in the document.
Default value is: 0.
drawCount long The number of drawings in the document.
Default value is: 0.
imageCount long The number of images in the document.
Default value is: 0.
objectCount long The number of objects in the document.
Default value is: 0.
oleObjectCount long The number of ole-objects in the document.
Default value is: 0.
paragraphCount long The number of paragraphs in the document.
Default value is: 0.
wordCount long The number of words in the document.
Default value is: 0.
characterCount long The number of characters in the document.
Default value is: 0.
rowCount long The number of rows in the document.
Default value is: 0.
frameCount long The number of frames in the document.
Default value is: 0.
sentenceCount long The number of sentences in the document.
Default value is: 0.
syllableCount long The number of syllables in the document.
Default value is: 0.
nonWhitespaceCharacterCount long The number of non-whitespace-characters in the document.
Default value is: 0.

toc

A Table Of Content for the document.

Attribute Type Description
name String The name to use for the Table of Contents.
depth int The level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.
Default value is: 0.
Element Type Description
item* List<DocumentTOCItem> (Many) TOC item.

item

A menu item.

Attribute Type Description
name String The name to use for the toc.
ref String The ref to use for the item.
collapse boolean Whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC. By default, all children are expanded up to the depth given in DocumentTOC.
Default value is: false.
Element Type Description
item* List<DocumentTOCItem> (Many) A table of content item containing sub-items.

cover

Contains meta-data information for the document cover page.

Element Type Description
coverTitle String The title to appear on the cover.
coverSubTitle String a sub-title to appear on the cover.
coverVersion String The version of the project that appears on the cover page.
coverType String The type of the document. This might be used on the cover page to specify the type of information contained in the document (eg 'User Guide', 'Manual', etc.).
coverDate Date The date to appear on the cover. Use the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS" in xml.
coverdate String The date as String (recommended format is ISO 8601) to appear on the cover. Only used if coverDate is not set. @since 1.1.1
authors/author* List<DocumentAuthor> (Many) The authors that appear on the cover page. Only used if author is not given.
author String A shortcut for the unique author that appears on the cover page. For more authors, you could use the <authors/> tag. @since 1.1.1
projectName String The name of the project.
projectLogo String The location of an image file that represents the project logo.
companyName String The name of the entity that is responsible for the content of the document, or a copyright holder.
companyLogo String The location of an image file that represents the company logo.