Product SiteDocumentation Site

Contenuto del file dump di un sito

Il file dump di un sito web generato da Publican contiene i dettagli di alcune configurazioni di base, insieme con i dettagli di ogni documento pubblicato sul sito. I dettagli di configurazione del sito sono:
<host>
L'URL alla radice del sito di documentazione, come impostato dal parametro host, nel file di configurazione del sito.
<def_lang>
La lingua predefinita della documentazione sul sito web, come impostato dal parametro def_lang, nel file di configurazione del sito.
Ogni documento, in ogni lingua, in ogni formato ha un record separato. Questi record contengono i seguenti dati:
<name>
Il titolo del documento, generato dal tag <title> in Book_Info.xml, Article_Info.xml o Set_Info.xml, superato dal parametro docname nel file publican.cfg. Ogni spazio presente nel titolo è sostituito con un carattere trattino basso.
<ID>
Un numero ID unico per il documento, in un certo formato e lingua.
<abstract>
Una breve descrizione generale del contenuto del documento, generato dal tag <abstract> in Book_Info.xml, Article_Info.xml o Set_Info.xml. Publican usa questo stesso contenuto per generare la sezione %description del file spec, usato per creare il pacchetto RPM di un documento. Se l'<abstract> è tradotto, questo campo contiene il testo tradotto.
<format>
Il formato in cui il documento è prodotto — html per html in pagine multiple, html-single per html in pagina singola, pdf per PDF ed epub per EPUB.
<language>
Il codice linguistico per il documento. Fare riferimento all'Appendice F, Codici di lingua, per maggiori informazioni su questi codici in XML.
<name_label>
Il nome del documento che appare nella tabella dei contenuti del sito. Il nome può essere impostato con il parametro web_name_label nel file publican.cfg del documneto. Diversamente, il campo è vuoto per un documento in linuga originale o contiene il titolo del documento tradotto. Ogni spazio presente nel nome è sostituito con il carattere trattino basso.
<product>
Il prodotto descritto dal documento, generato dal tag <productname> in Book_Info.xml, Article_Info.xml o Set_Info.xml, se non generato dal parametro product nel file publican.cfg. Ogni spazio presente nel nome è sostituito con il carattere trattino basso.
<product_label>
Il nome del prodotto che appare nella tabella dei contenuti del sito. Il nome può essere impostato con il parametro web_product_label nel file publican.cfg del documneto. Diversamente, il campo è vuoto per un documento in linuga originale o contiene il titolo del documento tradotto. Ogni spazio presente nel nome è sostituito con il carattere trattino basso.
Se il nome di prodotto è impostato con UNUSED, non viene visualizzata alcuna intestazione nella tabella dei contenuti del sito.
<subtitle>
Un'unica riga descrittiva del contenuto del documento, generato dal tag <subtitle> in Book_Info.xml, Article_Info.xml o Set_Info.xml. Publican usa questo stesso contenuto per generare la sezione Summary del file spec, usato per creare il pacchetto RPM di un documento. Se il <subtitle> è tradotto, questo campo contiene il testo tradotto.
<update_date>
La data di più recente installazione del documento, sul sito, nel formato YYYY-MM-DD.
<version>
La versione del prodotto descritto dal documento (non la versione del documento), generata dal tag <productnumber> in Book_Info.xml, Article_Info.xml o Set_Info.xml, se non generata dal parametro version nel file publican.cfg.
<version_label>
La versione del prodotto che compare nella tabella dei contenuti del sito. La versione può essere impostata con il parametro web_version_label nel file publican.cfg del documento.
Se la versione è impostata con UNUSED, non viene visualizzata alcuna intestazione per questa versione del prodotto, nella tabella dei contenuti del sito.
Esempio D.1. Record d'esempio da un file DUMP.xml
Questi due record da un file DUMP.xml, visualizzano lo stesso libro, Red Hat Enterprise Linux 5 Installation Guide, in due formati e due lingue differenti — una versione PDF in lingua inglese ed una versione HTML multi-pagine, in lingua francese. 
  <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>

D.1. Ricavare gli URL dai file dump

Usando i seguenti campi, si può ricavare l'URL di ogni documento sul sito:
  • <host>
  • <name>
  • <format>
  • <language>
  • <product>
  • <version>
HTML multi-pagine
<host>/<language>/<product>/<version>/<format>/<name>/index.html
Per esempio, http://docs.fedoraproject.org/en-US/Fedora/14/html/Accessibility_Guide/index.html
HTML singola-pagina
<host>/<language>/<product>/<version>/<format>/<name>/index.html
Per esempio, 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
Per esempio, 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
Per esempio, http://docs.fedoraproject.org/en-US/Fedora/14/pdf/Accessibility_Guide/Fedora-14-Accessibility_Guide-en-US.epub
Notare che i campi <product_label>, <version_label> e <name_label> sono privi di significato per gli URL, anche quando sono esplicitamente rimossi dalla tabella dei contenuti con l'impostazione UNUSED.