Introduction to Mallard

Information element

About

The <info> element contains metadata about a page or section such as the names of authors and editors of the page, the version number of the package you are documenting, links to any guide pages if necessary, alternative titles and a short description of the page.

The <info> element is the right place to link your topic back to your index. You may then want to add an alternative title, for example a different title to be shown for links to the page.

Use the <revision> element to keep track of which version of the software the documentation was written and when it was last updated.

This is also the right place to license the page and add a short description which will show up in the guide pages which contain the topic.

<info> can be only at the start of a page or section.

Example

<info>
  <link type="guide" xref="index" group="info"/>
  <credit type="author">
    <name>Jack Giant</name>
    <email>jackgiant@gnome.org</email>
  </credit>

  <license href="http://creativecommons.org/licenses/by-sa/3.0/us/">
    <p>This work is licensed under a
    <link href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative
    Commons Attribution-Share Alike 3.0 United States License</link>.</p>
    <p>As a special exception, the copyright holders give you permission to
    copy, modify, and distribute the example code contained in this document
    under the terms of your choosing, without restriction.</p>
  </license>

  <desc>Include metadata and automatic links for pages and sections.</desc>
</info>

Learn more 

For more on the Mallard info element see http://projectmallard.org/1.0/mal_info.