The icon, title and description for application help on http://help.gnome.org/users/ comes from the index.page

An index.page like this would look great on the website:

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="guide"
      id="index">

  <info>
    <!-- The text title is used on the help.gnome.org/users/ -->
    <title type="text">Title which is used on help.gnome.org/users/</title>

    <!-- The link title is used for links from other pages and for breadcrumbs -->
    <title type="link">This title should contain only text</title>

    <!-- Bunnies die when you don't have a license, see https://wiki.gnome.org/DocumentationProject/Licensing -->
    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

    <desc>Description of the help and project which is used on help.gnome.org/users/. Keep it under three sentences, and feel free to use it to explain why a user might want to read this help specifically.</desc>
  </info>

  <title>
    <!-- The icon which is shown on help.gnome.org/users/ next to the title -->
    <media type="image" mime="image/png" its:translate="no" src="media/icon.png" />
    Title which is shown in Yelp
  </title>

</page>

Icons

Icons are 48×48 pixels in size. They can usually be found in <project-repository>/data/icons or in gnome-icon-theme/gnome/48x48/apps.

The icons are taken by the website from <title><media /></title>, where they are marked as untranslatable.

Titles

If there is a <info><title type="text"></title></info>, the title will be taken from there. Otherwise, it will fall back to the <title></title>.

A link title should also be used so that breadcrumbs and links to do not include a large icon: <info><title type="link"></title></info>

Descriptions

Descriptions for the website are taken from the <info><desc></desc></info>.

Other stuff

The icon will needs to be added to the help/Makefile.am: ../Makefile

Example

You may also want to include <revision> and <credit> tags in the <info>.

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="guide"
      id="index">

  <info>
    <title type="text">Disk Usage Analyzer help</title>
    <title type="link">Disk Usage Analyzer</title>

    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

    <desc><app>Disk Usage Analyzer</app> is a graphical storage device
    scanner.</desc>
  </info>

  <title>
    <media type="image" mime="image/png" its:translate="no" src="media/icon.png" />
    Disk Usage Analyzer
  </title>

</page>

DocumentationProject/Guide/Website (last edited 2014-10-01 10:28:28 by EkaterinaGerasimova)