Product SiteDocumentation Site

Sommario dei comandi

Opzioni di comando
publican --help
visualizza l'help
publican --man
visualizza le pagine di man relative
publican --help_actions
visualizza l'elenco delle azioni
publican --v
viusalizza il numero di versione di Publican
--config file
specifica un file di configurazione per un documento, in alternativa al file publican.cfg, predefinito
--nocolours
disabilita la colorazione ANSI nei messaggi di log di Publican
--quiet
disabilita tutti i messaggi di log
Azioni
publican build
trasforma gli XML in un documento. Opzioni:
--formats
una lista di formati di compilazione, separati da virgole (necessario)
--langs
una lista di lingue, separate da virgole (necessario)
--embedtoc
inserisce la tabella dei contenuti in una presentazione HTML
--publish
imposta per pubblicazione il contenuto creato
--novalid
salta il controllo di vaidità DTD durante la creazione di un documento
publican bump --lang=CODICE_LINGUA
incrementa di una unità, <pubsnumber> nel file Book_Info.xml, dove CODICE_LINGUA è la lingua in cui sono redatti i file XML

Importante — Nessun supporto alle lingue tradotte

In Publican 2.6, bump funziona solo con la versione originale, non tradotta, del documento. Future versioni di Publican includeranno supporto anche per le lingue tradotte.
publican clean
rimuove le cartelle temporanee dalla cartella di un documento
publican clean_ids
indenta ordinatamente i file XML e ricrea gli ID degli elementi
publican clean_set
rimuove le copie locali di libri remoti, parte di un set
publican create
crea un nuovo libro, articolo o set. Opzioni:
--name
il nome del documento (necessario)
--product
il prodotto documentato
--version
la versione del prodotto documentato
--edition
l'edizione del documento
--brand
il brand per il documento
--lang
la lingua in cui gli XML verranno redatti
--type
il tipo di documento — article, book, o set
publican create_brand
crea un nuovo brand. Opzioni:
--name
il nome del documento (necessario)
--lang
la lingua in cui gli XML verranno redatti
publican create_site
crea un sito web di documentazione. Opzioni:
--site_config
il nome del file di configurazione del sito da creare (necessario)
--db_file
il nome del file di database del sito da creare (necessario)
--toc_path
percorso alla cartella in cui creare il file toc.html di primo livello (necessario)
--tmpl_path
percorso alla cartella template (/usr/share/publican/templates, per impostazione)
publican help_config
visualizza l'elenco dei parametri per il file publican.cfg
publican install_book
installa un documento sul sito web di documentazione
--site_config
il nome del file di configurazione del sito (necessario)
--lang
la lingua del documento da installare (necessario)
publican install_brand
configura un brand per installazione. Opzioni:
--path
percorso ai file Common Content di Publican. Per impostazione predefinita, /usr/share/publican/Common_Content nei Sistemi Operativi Linux e %SystemDrive%/%ProgramFiles%/Publican/Common_Content nei sistemi operativi Windows — tipicamente, C:/Program Files/Publican/Common_Content
publican lang_stats
genera un rapporto di traduzione per una lingua
--langs
una lista di lingue, separate da virgole
publican old2new
crea un file publican.cfg basato sul Makefile di un documento di Publican 0
publican package
crea il pacchetto di un documento o di un brand, per distribuzione. Opzioni:
--lang
la lingua in cui creare il pacchetto (necessario per documenti, irrilevante per brand)
--desktop
specifica che il pacchetto RPM di un documento è creato per uso desktop (irrilevante per brand)
--brew
invia il pacchetto al sistema di compilazione Brew (irrilevante al di fuori di Red Hat)
--cvs
specifica di importare il pacchetto SRPM nel CVS specificato
--scratch
usato unsieme all'opzione --brew per specificare uno scratch build (irrilevante al di fuori di Red Hat)
--short_sighted
crea il pacchetto RPM privo del numero di versione di prodotto nel nome di file dell'RPM
--binary
crea il pacchetto RPM binario invece del pacchetto SRPM sorgente
publican print_banned
visualizza l'elenco dei tag DocBook non permessi da Publican
publican print_known
visualizza l'elenco dei tag DocBook supportati da Publican.
publican print_tree
viusalizza la struttura ad albero dei file XML di un documento
publican print_unused
visualizza l'elenco dei file XML non inclusi in tag <xi:include> in un libro, articolo o set
publican remove_book
rimuove un documento da un sito web di documentazione
--site_config
il nome del file di configurazione del sito (necessario)
--lang
il documento in lingua da rimuovere (necessario)
publican rename
rinomina un documento. Opzioni:
--name
il nuovo titolo per il documento
--product
il nuovo prodotto cui si riferisce il documento
--version
la nuova versione di prodotto cui si riferisce il documento
publican site_stats --site_config=nome_del_file_di configurazione_del_sito
genera un report statistico di un sito per documentazione. Opzione
--site_config
il nome del file di configurazione del sito (necessario)
publican update_pot
aggiorna i file POT in un documento
publican update_po
aggiorna i file PO in un documento
--langs
lista delle lingue, separate da virgole, da aggiornare o ‘all’ per aggiornare tutte le lingue (necessario)
publican update_site --site_config=nome_del_file_di_configurazione_del_sito.cfg
rigenera il contenuto modellato di un sito di documentazione. Opzione:
--site_config
il nome del file di configurazione del sito (necessario)

B.1. Comandi interni

Publican usa internamente i comandi di questa sezione. Normalmente non occorre eseguirli direttamente.
publican update_db -add
Aggiunge le voci al database di un sito web generato da Publican, con le seguenti opzioni:
--site_config
il nome del file di configurazione del sito
--lang
la lingua di pubblicazione del documento
--formats
un elenco di formati, separati da virgole, in cui pubblicare il documento, per esempio, pdf,html-single
--name
il titolo del documento
--name_label
il titolo del documento, come dovrebbe apparire nelle tabelle dei contenuti del sito.
--product
il prodotto descritto dal documento
--product_label
il prodotto descritto dal documento, come dovrebbe apparire nelle tabelle dei contenuti del sito.
--version
la versione del prodotto documentato
--version_label
la versione del prodotto descritto dal documento, come dovrebbe apparire nelle tabelle dei contenuti del sito.
--subtitle
il sottotitolo del documento
--abstract
l'abstract del documento
Per esempio: 
publican update_db --add --lang en-US --formats html,pdf --name Foo \
--name_label "foo is good" --version 0.1 --version_label UNUSED \
--product Bar --product_label "To the bar" \
--subtitle "A guide to Bar Foo" \
--abstract "There once was a Foo from Bar ..." \
--site_config /usr/share/bar/foo.cfg
publican update_db --del
rimuove le voci dal database di un sito web generato da Publican, con le seguenti opzioni:
--site_config
il nome del file di configurazione del sito
--lang
la lingua di pubblicazione del documento
--name
il titolo del documento
--product
il prodotto descritto dal documento
--version
la versione del prodotto documentato
Per esempio: 
publican update_db --del --lang en-US --name Foo --version 0.1 --product Bar \
--site_config /usr/share/bar/foo.cfg