<info> <name>Shaun McCance</name> <email>shaunm@gnome.org</email> <years>2008-2009</years> <desc>Record revision numbers, dates, and statuses.</desc> </info> <synopsis>`mal_info_revision = element revision { attribute version { text } ?, attribute docversion { text } ?, attribute pkgversion { text } ?, attribute date { xsd:date } ?, attribute status { "stub" | "incomplete" | "draft" | "outdated" | "review" | "candidate" | "final" } ?, attribute * - (mal:* | local:*) { text } *, mal_block_title ?, mal_block_desc ?, mal_external * }` </synopsis>

Use the `revision` information to record information about revisions of a document, page, or section. The `revision` element allows you to specify version numbers, the revision date, and the revision status. Other information can be recorded with attributes or elements from external namespaces. Multiple `revision` elements can be used to record the revision history.

You can use the `title` and `desc` elements in a `revision` element to provide a title and description of that revision. This is not necessarily the same as the title and description of the page or section as of that revision.

Notes <list> <item>

The `revision` element contains an optional `title` element, an optional `desc` element, and any number of elements from external namespaces.

</item>

<item>

The `revision` element can occur in any `info` element.

</item>

<item>

The `version` attribute records the version number of the page or section.

</item>

<item>

The `docversion` attribute can be used to record the version number of the enclosing document.

</item>

<item>

The `pkgversion` attribute can be used to record the version number of the package containing this document.

</item>

<item>

The `date` attribute records the date this revision was made.

</item>

<item>

The `status` attribute records the status of the page or section as of the given revision. The following values are allowed:

`"stub"` | contains little to no real content
`"incomplete"` | outline of all information, but lacking content
`"draft"` | all content available, but unpolished
`"outdated"` | was once complete or nearly complete, but needs to be revised to reflect changes
`"review"` | ready to be reviewed by editors
`"candidate"` | reviewed and awaiting a final approval
`"final"` | approved and ready for publication or distribution

</item>

<item>

The `revision` element can have attributes from external namespaces. See for more information on external-namespace attributes.

</item> </list>
Processing Expectations

As an informational element, the `revision` element is not necessarily displayed directly on the page or section in which it appears. Some tools may show revision on a separate informational page or dialog. Tools designed for editors might show revision information directly.

When a `revision` element is displayed or processed, tools should process only those child elements that they understand, and ignore everything else.

Comparison to Other Formats

The `revision` element is similar to the `revision` element in DocBook. In DocBook, `revision` elements must occur inside a `revhistory` element. In Mallard, they are placed directly in an `info` element. DocBook provides more specific child elements for structured content, as well as for block content for detailed remarks. Mallard allows such information to be encoded with elements from external namespaces when needed.