# Appendix E. Contents of the website dump file

The dump file for a Publican-generated website contains some basic site configuration details, together with details of every document published on the site. The site configuration details are:

`<host>`
  The URL to the root of the documentation site, as set by the `host` parameter in the site configuration file.
`<def_lang>`
  The default language of the documentation on the website, as set by the `def_lang` parameter in the site configuration file.

Each document, in each language, in each format has a separate record. These records contain the following data:

`<name>`
  The title of the document, generated from the `<title>` tag in the `Book_Info.xml`, `Article_Info.xml`, or `Set_Info.xml` file unless overridden by the `docname` parameter in the `publican.cfg` file. Any spaces in the title are replaced by underscores.
`<ID>`
  A unique ID number for this document, in this format, in this language.
`<abstract>`
  A brief summary of the content of the document, generated from the `<abstract>` tag in the `Book_Info.xml`, `Article_Info.xml`, or `Set_Info.xml` file. Publican uses this same content to generate the `%description` section of the spec file when it packages a document. If the `<abstract>` is translated, this field contains the translated text.
`<format>`
  The format in which the document is produced — `html` for multi-page html, `html-single` for single-page html, `pdf` for PDF, and `epub` for EPUB.
`<language>`
  The language code for the document. Refer to Appendix G, Language codes for more information about language codes in XML.
`<name_label>`
  The name of the document as it appears in the site table of contents. This label can be set with the `web_name_label` parameter in the document's `publican.cfg` file. Otherwise, the field is empty for a document in its original language, or uses the translated title of the document in a translated language. Any spaces in the name label are replaced by underscores.
`<product>`
  The product that the document describes, generated from the `<productname>` tag in the `Book_Info.xml`, `Article_Info.xml`, or `Set_Info.xml` file unless overridden by the `product` parameter in the `publican.cfg` file. Any spaces in the product name are replaced by underscores.
`<product_label>`
  The name of the product as it appears in the site table of contents. This label can be set with the `web_product_label` parameter in the document's `publican.cfg` file. Otherwise, the field is empty for a document in its original language, or uses the translated title of the document in a translated language. Any spaces in the name label are replaced by underscores.
  If the product label is set to `UNUSED`, no heading for this product appears in the website tables of contents.
`<subtitle>`
  A one-line description of the content of the document, generated from the `<subtitle>` tag in the `Book_Info.xml`, `Article_Info.xml`, or `Set_Info.xml` file. Publican uses this same content to generate the `Summary` section of the spec file when it packages a document. If the `<subtitle>` is translated, this field contains the translated text.
`<update_date>`
  The date that the document was most recently installed on the site, in the format YYYY-MM-DD.
`<version>`
  The version of the product that the document describes (not the version of the document itself), generated from the `<productnumber>` tag in the `Book_Info.xml`, `Article_Info.xml`, or `Set_Info.xml` file unless overridden by the `version` parameter in the `publican.cfg` file.
`<version_label>`
  The version of the product as it appears in the site table of contents. This label can be set with the `web_version_label` parameter in the document's `publican.cfg` file.
  If the version label is set to `UNUSED`, no heading for this version of the product appears in the website tables of contents.

Example E.1. Sample records from a `DUMP.xml` file

These two records from a `DUMP.xml` file show the same book, the Red Hat Enterprise Linux 5 Installation Guide, in two different formats and two different languages — an English PDF version and a French multi-page HTML version.

      <record>
        <name>Installation_Guide</name>
        <ID>22</ID>
        <abstract>This manual explains how to boot the Red Hat Enterprise Linux 5 installation program (anaconda) and to install Red Hat Enterprise Linux 5 on 32-bit and 64-bit x86 systems, 64-bit POWER systems, and IBM System z. It also covers advanced installation methods such as kickstart installations, PXE installations, and installations over VNC. Finally, it describes common post-installation tasks and explains how to troubleshoot installation problems.</abstract>
        <format>pdf</format>
        <language>en-US</language>
        <name_label>Installation_Guide</name_label>
        <product>Red_Hat_Enterprise_Linux</product>
        <product_label>Red_Hat_Enterprise_Linux</product_label>
        <subtitle>Installing Red Hat Enterprise Linux 5 for all architectures</subtitle>
        <update_date>2010-10-07</update_date>
        <version>5</version>
        <version_label></version_label>
      </record>
      <record>
        <name>Installation_Guide</name>
        <ID>149</ID>
        <abstract>Ce manuel explique comment lancer le programme d'installation Red Hat Enterprise Linux 5 et comment installer Red Hat Enterprise Linux 5 sur les systèmes x86 32-bit et 64-bit, sur les systèmes POWER 64-bit, et sur les systèmes IBM System z. Il couvre aussi des méthodes d'installation avancées telles que les installations kickstart, PXE, et les installations au moyen de VNC. Finalement, ce manuel décrit les tâches communes post-installation et explique comment résoudre les problèmes liés à une installation.</abstract>
        <format>html</format>
        <language>fr-FR</language>
        <name_label>Guide_d'installation</name_label>
        <product>Red_Hat_Enterprise_Linux</product>
        <product_label>Red_Hat_Enterprise_Linux</product_label>
        <subtitle>Installation de Red Hat Enterprise Linux 5 pour toutes les architectures</subtitle>
        <update_date>2010-10-19</update_date>
        <version>5</version>
        <version_label></version_label>
      </record>

## E.1. Computing URLs from the dump file

Using the following fields, you can compute the URL of any document on the site:

- `<host>`
- `<name>`
- `<format>`
- `<language>`
- `<product>`
- `<version>`

muti-page HTML
  `<host>`/`<language>`/`<product>`/`<version>`/`<format>`/`<name>`/`index.html`
  For example, `http://docs.fedoraproject.org/en-US/Fedora/14/html/Accessibility_Guide/index.html`
single-page HTML
  `<host>`/`<language>`/`<product>`/`<version>`/`<format>`/`<name>`/`index.html`
  For example, `http://docs.fedoraproject.org/en-US/Fedora/14/html-single/Accessibility_Guide/index.html`
PDF
  `<host>`/`<language>`/`<product>`/`<version>`/`<format>`/`<name>`/`<product>`-`<version>`-`<name>`-`<language>`.`pdf`
  For example, `http://docs.fedoraproject.org/en-US/Fedora/14/pdf/Accessibility_Guide/Fedora-14-Accessibility_Guide-en-US.pdf`
EPUB
  `<host>`/`<language>`/`<product>`/`<version>`/`<format>`/`<name>`/`<product>`-`<version>`-`<name>`-`<language>`.`epub`
  For example, `http://docs.fedoraproject.org/en-US/Fedora/14/pdf/Accessibility_Guide/Fedora-14-Accessibility_Guide-en-US.epub`

Note that the `<product_label>`, `<version_label>`, and `<name_label>` fields have no significance for URLs, even when these fields are suppressed in tables of contents by the `UNUSED` setting.