<headers> (Revision Headers)

This element represents the list of revision headers.

This section contains many references to history, versions, and revisions, and it is helpful to clarify the relationships here. In general, a series of changes (revisions) can be made to a spreadsheet. When a batch of those revisions is saved to disk, the version number of the spreadsheet is incremented. The batch of changes is saved to the revision history, which is persisted on disk with the file in the form of different log files and headers.

There are some attributes that deal with history which may seem redundant (such as diskRevisions, and history, among others) - these are there for backwards compatibility with older versions of spreadsheet applications and do not need to be used for creating new files.

Child Elements

Subclause

<header> (Header)

§3.11.1.1

Attributes

Description

<diskRevisions> (Disk Revisions)

A Boolean value indicating that this shared workbook file contains revisions. True when the workbook does have revisions, false otherwise.

Note:

The possible values for this attribute are defined by the XML Schema boolean datatype.

<exclusive> (Exclusive Mode)

A Boolean value indicating that this shared workbook is in exclusive mode.

A workbook is in exclusive mode when a user has a lock on it for appending revisions to the file.

Note:

The possible values for this attribute are defined by the XML Schema boolean datatype.

<guid> (Last Revision GUID)

The globally unique identifier of the last set of revisions. This shall match the GUID for the most recent <header>.

The possible values for this attribute are defined by the ST_Guid simple type (§3.18.41).

<history> (History)

A Boolean value indicating that this shared workbook maintains a revision history. True if a history is maintained, false otherwise.

Note:

The possible values for this attribute are defined by the XML Schema boolean datatype.

<keepChangeHistory> (Keep Change History)

A Boolean value indicating whether the revision history should be kept for this shared workbook. True if the history should be kept, false otherwise.

The possible values for this attribute are defined by the XML Schema boolean datatype.

<lastGuid> (Last GUID)

Unique identifier of the last set of revisions that was saved into the file.

Note: The spreadsheet application may have certain modes, such as a timed save mode, where the application doesn't do a full save, but instead just appends the most recent revision records. In cases like this, for a new user that opens such a file while it is being edited, the file that was loaded from disk will only have the changes that were saved during a full save. To get the current state of the file which includes edits by other users, the spreadsheet application would need to apply all the revisions from lastGuid to guid.

The possible values for this attribute are defined by the ST_Guid simple type (§3.18.41).

<preserveHistory> (Preserve History)

An integer representing the number of days the spreadsheet application will keep the change history for this workbook.

The possible values for this attribute are defined by the XML Schema unsignedInt datatype.

<protected> (Protected)

A Boolean value indicating whether the change tracking in this shared workbook can be removed. True if the tracking can be removed, false otherwise.

The possible values for this attribute are defined by the XML Schema boolean datatype.

<revisionId> (Revision Id)

The current revision number of this shared workbook.

The possible values for this attribute are defined by the XML Schema unsignedInt datatype.

<shared> (Shared Workbook)

A Boolean value indicating that this workbook is shared. True when the workbook is shared, false otherwise.

Note:

The possible values for this attribute are defined by the XML Schema boolean datatype.

<trackRevisions> (Track Revisions)

A Boolean value indicating that revisions are tracked in this shared workbook. True when revisions are tracked, false otherwise.

Note:

The possible values for this attribute are defined by the XML Schema boolean datatype.

<version> (Version)

An integer representing the current version of this shared workbook. The integer should begin counting from 1 for the first version.

The possible values for this attribute are defined by the XML Schema int datatype.

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_RevisionHeaders">
	<sequence>
	<element name="header" type="CT_RevisionHeader" minOccurs="1" maxOccurs="unbounded"/>
	</sequence>
	<attribute name="guid" type="ST_Guid" use="required"/>
	<attribute name="lastGuid" type="ST_Guid" use="optional"/>
	<attribute name="shared" type="xsd:boolean" default="true"/>
	<attribute name="diskRevisions" type="xsd:boolean" default="false"/>
	<attribute name="history" type="xsd:boolean" default="true"/>
	<attribute name="trackRevisions" type="xsd:boolean" default="true"/>
	<attribute name="exclusive" type="xsd:boolean" default="false"/>
	<attribute name="revisionId" type="xsd:unsignedInt" default="0"/>
	<attribute name="version" type="xsd:int" default="1"/>
	<attribute name="keepChangeHistory" type="xsd:boolean" use="optional" default="true"/>
	<attribute name="protected" type="xsd:boolean" use="optional" default="false"/>
	<attribute name="preserveHistory" type="xsd:unsignedInt" default="30"/>
</complexType>