Product SiteDocumentation Site

Parametri di publican.cfg

Ogni libro, articolo, documento, set o brand ha un file publican.cfg nella propria cartella radice. I parametri che possono essere configurati nel file publican.cfg sono:
docname
il nome del documento, impostato con l'opzione --name
version
la versione del prodotto, impostata con l'opzione --version
xml_lang
la lingua dei file XML sorgenti, impostata con l'opzione --lang
edition
il numero di edizione della documentazione, impostato con l'opzione --edition
type
il tipo di documento — un <article>, <book> o <set> DocBook, impostato con l'opzione --type
brand
il brand del documento, impostato con l'opzione --brand
product
il prodotto a cui è rivolta la documentazione, impostato con l'opzione --product
arch
l'architettura hardware del computer per il documento
books
una lista di book, separati da virgole, parte di un set remoto
brew_dist
il target usato per compilare il pacchetto RPM desktop in Brew. (Per impostazione: docs-5E)
bridgehead_in_toc
specifica se includere bridgehead nelle tabelle dei contenuti. (Per impostazione: 0bridgehead non sono inclusi)
chunk_first
specifica se visualizzare la prima sezione sulla stessa pagina del parent nelle presentazioni in HTML. (Per impostazione: 0 — la prima sezione inizia su una nuova pagina HTML)
chunk_section_depth
il livello a partire da cui le sottosezioni sono visualizzati su una stessa pagina, nelle presentazioni HTML. (Per impostazione: 4)
classpath
il percorso ai file jar indispensabili a FOP. (Per impostazione, nei Sistemi Oprativi Linux: /usr/share/java/ant/ant-trax-1.7.0.jar:/usr/share/java/xmlgraphics-commons.jar:/usr/share/java/batik-all.jar:/usr/share/java/xml-commons-apis.jar:/usr/share/java/xml-commons-apis-ext.jar)
common_config
il percorso all'installazione di Publican. (Per impostazione nei Sistemi Operativi Linux: /usr/share/publican; nei sistemi operativi Windows: %SystemDrive%/%ProgramFiles%/publican — solitamente C:/Program Files/publican)
common_content
il percorso ai file Common Content di Publican. (Per impostazione nei Sistemi Operativi Linux: /usr/share/publican/Common_Content: nei sistemi operativi Windows: %SystemDrive%/%ProgramFiles%/publican/Common_Content — solitamente C:/Program Files/publican/Common_Content)
condition
condizioni di filtraggio degli XML prima della trasformazione
confidential
contrassegna un documento come confidenziale. (Per impostazione: 0 — non confidenziale)
confidential_text
imposta il testo con cui contrassegnare come confidenziale un documento. (Per impostazione: CONFIDENTIAL)
cvs_branch
il branch CVS in cui importare il pacchetto SRPM
cvs_pkg
il pacchetto CVS in cui importare l'SRPM. Il parametro accetta la stringa __LANG__, sostituendola con il codice della lingua durante l'elaborazione del pacchetto
cvs_root
la root CVS in cui importare il pacchetto SRPM
debug
specifica se visualizzare il messaggi di debug generati da Publican. (Per impostazione: 0 — messaggi disabilitati)
def_lang
la lingua predefinita per il sito web gestito via Publican. Le tabelle dei contenuti, per le altre lingue, sono collegate ai documenti in lingua predefinita in assenza di traduzioni. (Per impostazione: en-US — inglese degli Stati Uniti d'America)
doc_url
URL del team di documentazione del pacchetto. (Per impostazione: https://fedorahosted.org/publican)
dt_obsoletes
un pacchetto che il pacchetto desktop rende obsoleto
dt_requires
un pacchetto richiesto dal pacchetto desktop, per esempio, un pacchetto di menu del desktop, per documentazione. Fare riferimento alla Sezione 3.8.1.3, «Voci nel menu del desktop per i documenti».
dtdver
la versione del DTD (Document Type Definition) di DocBook XML su cui si basa il progetto. (Per impostazione: 4.5)
ec_id
l'ID del plugn d'aiuto di Eclipse. (Per impostazione: prodotto.nomedoc)
ec_name
il nome del plugin d'aiuto di Eclipse. (Per impostazione: prodotto nomedoc)
ec_provider
il nome del fornitore del plugin d'aiuto di Eclipse. (Per impostazione: Publican-versione Publican)
generate_section_toc_level
il livello di profondità delle sezioni per cui generare una tabella di contenuti. (Per impostazione: 0 — nessun indice nelle sezioni)
ignored_translations
traduzioni da ignorare
license
la licenza usata dal pacchetto. (Per impostazione: GNU Free Documentation License)
mainfile
il nome del file XML contenente il nodo XML radice di <article>, <book> o <set>, ed il nome del file .ent corrispondente, che contiene le entità del documento. Per esempio, se si imposta mainfile: master, Publican cerca il nodo XML radice in master.xml e le entità del documento in master.ent.
Se mainfile non è impostato, Publican cerca il nodo XML radice in un file che corrisponde al <title> del documento in Article_Info.xml, Book_Info.xml o Set_Info.xml, e poi cerca le entità in un file con il nome corrispondente.
max_image_width
la largezza massima consentita alle immagini nel documento, se non specificato diversamente con il tag <imagedata> per una certa immagine. (Per impostazione: 444 — larghezza di 444 pixel)

Importante — 444 pixel è la massima larghezza di sicurezza

Non usare il parametro max_image_width se le immagini contengono importanti informazioni. Le immagini più larghe di 444 pixel potrebbero presentarsi male nei documenti HTML e PDF e rendersi inusabili, in quanto superando i margini esse verrebbero rappresentate incomplete.
Viceversa, le immagini più larghe di 444 pixel che vengono scalate in un browser web o in un visualizzatore PDF, perdono in qualità.
Per preservare la qualità delle immagini, si raccomanda di tagliare o riscalare le immagini ad una larghezza inferiore a 444 pixel, prima di includerle in un documento.
menu_category
la categora del desktop menu (come difinito dal file .menu corrispondente), in cui far comparire un documento quando installato da un pacchetto RPM per desktop. Fare riferimento alla Sezione 3.8.1.3, «Voci nel menu del desktop per i documenti».
os_ver
il sistema operativo per cui creare il pacchetto. (Per impostazione: .el5 — Red Hat Enterprise Linux 5)
prod_url
URL del prodotto cui si applica il documento. (Per impostazione: https://fedorahosted.org/publican)
release
il numero di release del pacchetto. (Per impostazione: il valore in xml_lang, ricavato dal tag title in xml_lang/TYPE_Info.xml o Project-Id-Version in lang/TYPE_Info.po)
repo
il repository da cui scaricare libri remoti, parte di un set distribuito
scm
il sistema controllo di versione usato nel repository che contiene i libri remoti, parte di un set distribuito. (Per impostazione: SVN)
show_remarks
specifica se visualizzare gli avvisi nelle presentazioni. (Per impostazione: 0 — avvisi non visibili)
show_unknown
specifica se segnalare i tag sconosciuti durante l'elaborazione degli XML. (Per impostazione: 1 — tag sconosciuti segnalati)
src_url
URL in cui trovare i tarball dei file sorgenti
strict
use strict mode (Per impostazione: 0 — non strict) attualmente la modalità strict non è abilitata
tmp_dir
la cartella di output di Publican. (Per impostazione: tmp)
toc_section_depth
la profondità di livello delle sezioni incluse nella tabella dei contenuti. (Per impostazione: 2)
web_brew_dist
il target di compilazione brew da usare per il pacchetto RPM web. (Per impostazione: docs-5E)
web_formats
un elenco di formati, separati da virgole, da includere nel pacchetto RPM per web. Vedere la Sezione 3.8.2, «Il comando publican package».
web_home
specifca che il documento è la home page di un sito di documentazione, non un documento standard

Importante — web_home è deprecato

In Publican 2.2, web_home è sostituito da web_type: home. Supporto a web_home sarà interrotto in future versioni di Publican.
web_name_label
sostituisce il nome di book che appare nel menu di un sito web gestito da Publican
web_obsoletes
pacchetti resi obsoleti dal pacchetto RPM web
web_product_label
sostituisce il nome di prodottto che appare nel menu di un sito web gestito da Publican
web_type
specifica che il documento è un contenuto descrittivo di un sito web gestito da Publican e non una documentazione di prodotto. Questo contenuto include la home page del sito (web_type: home), pagine descrittive di prodotto (web_type: product) e di versione (web_type: version). Vedere il Capitolo 6, Creare un sito web con Publican.
web_version_label
sostituisce il numero di versione che appare nel menu di un sito web gestito da Publican