re:document

The re:document element is primarily a secondary root tag, this is because the XML specification considers each XML file to contain one document, whatever the structure and type of that information. To prevent the confusion that could arise from this situation the re:document element, contains all the data necessary to output a single deliverable output. In the future this could allow the re:ality XML file format to contain information for more than one document without infringement of the XML specification.

XML Tag 

<re:document 
	version=''
	language-code=''
	country-code=''
	category-code=''
	uid=''
	display-name='' >
	... 
</re:document >

DTD 

<!ELEMENT re:document (re:metadata?,
		re:outputs,
		re:colors?,
		re:styles?,
		re:masterpages?,
		re:content)>

	<!ATTLIST re:document
		version NMTOKEN #FIXED "1.0"
		display-name CDATA #REQUIRED
		uid NMTOKEN #REQUIRED 
		language-code NMTOKEN #REQUIRED 
		country-code NMTOKEN #REQUIRED 
		category-code CDATA #REQUIRED 
		domain-id CDATA #IMPLIED 
		job-id CDATA #IMPLIED 
		input-id CDATA #IMPLIED 
	>

NOTE The attributes domain-id, job-id and input-id (in the DTD) are for internal usage only these attributes should not be set and are only documented here for completeness. These values are automatically assigned at run time, if a value is placed in any of these attributes then they will be ignored and over written with the correct data.

Reference examples

010_010 , 010_015

Children

re:metadata, re:outputs, re:colors, re:styles, re:masterpages, re:content

Attributes

version, language-code, country-code, category-code, uid,
display-name

Style Properties

None

version

The version attribute specifies the re:ality xml file format version number, for this release the value should be set to '1.0'. The version attribute, will only increment for significant file format changes, and where possible the updated file format will be backwards compatible.

display-name

The display-name represents a human readable name for a document to be displayed under the file system; this is not the name of the file however.

uid

The uid attribute value represents a Universal IDentifier. A UID is an identifier that is unique across both space and time, with respect to the space of all UIDs. The UID is used to reliably identifying all instances of a document regardless of time. For example suppose you have a document, which is called 'myReport.xml', with the uid attribute set to '12345'. This document is then run through the system in January. Then in March you need to update the document and run it again. Although this is an update (and some or all of the content might have changed) the uid attribute would still be set to '12345', as this is still a revision of the base document. The uid attribute allows for speedy grouping of individual documents across time.

language-code

The language-code attribute specifies the written language that the content element primarily contains. This should be one of the ISO 639-2, 3 letter language codes.

For a list of ISO 639-2 language see:
Library of Congress: Codes for the Representation of Names of Languages
http://www.loc.gov/standards/iso639-2/englangn.html

country-code

The country-code attribute specifies the primary country of distribution for this documents content. This should be one of the ISO 3166, 3 ('A 3') letter country names.
For a list of ISO 3166 country code see:
Download a list from ISO http://www.iso.org/iso/en/prods-services/iso3166ma/index.html

category-code

The category-code attribute specifies a secondary grouping for a document type. A secondary grouping type is user defined, this instructs the system how this document should be categorised. For example suppose you have three documents one is a covering letter and the other two are data sheets. The first category-code (for the covering letter) could be ҃overingLetterӠand the second (for data sheets) could be ҄ataSheetsӠthis would allow filtering of the outputs by type.