a2x - Online nel cloud

PROGRAMMA:

NOME

a2x - Un gestore di toolchain per AsciiDoc (converte i file di testo Asciidoc in altri file
formati)

SINOSSI

a2x [VERSIONI] FILE SORGENTE

DESCRIZIONE

Un gestore di toolchain DocBook che traduce un file di testo AsciiDoc FILE SORGENTE in PDF,
EPUB, DVI, PS, LaTeX, XHTML (pagina singola o in blocchi), pagina man, guida HTML o testo semplice
formati usando asciido(1) e altre applicazioni (vedi sezione REQUISITI). FILE SORGENTE può
essere anche un file DocBook con estensione .xml.

VERSIONI

-un, --attributo=ATTRIBUTO
Impostato asciido(1) valore dell'attributo (scorciatoia per --asciidoc-opzioni="-un ATTRIBUTO" opzione).
Questa opzione può essere specificata più di una volta.

--asciidoc-opzioni=ASCIIDOC_OPTS
aggiuntivo asciido(1) opzioni. Questa opzione può essere specificata più di una volta.

--conf-file=CONF_FILE
Carica il file di configurazione. Vedere la sezione FILE CONF.

-D, --destinazione-dir=DESTINAZIONE_DIR
Cartella di destinazione. Il valore predefinito è FILE SORGENTE directory. Questa opzione è applicabile solo a
Formati di output basati su HTML (Chunked, epub, htmlaiuto, xhtml).

-D, --doctype=DOCTYPE
Tipo di documento DocBook: articolo, pagina man or libro. Il tipo di documento predefinito è articolo
a meno che il formato non sia pagina man (nel qual caso il valore predefinito è pagina man).

-B, --backend=BACKEND
BACKEND è il nome di un plug-in di backend installato. Quando questa opzione è specificata a2x
tentativi di caricare un nome di file a2x-backend.py dal BACKEND directory dei plugin Allora
converte il file FILE SORGENTE ad un BACKEND file di output formattato utilizzando una funzione globale
definito in a2x-backend.py detto a_BACKEND.

-F, --formato=FORMATO
Formati di output: Chunked, libro dei documenti, dvi, epub, htmlaiuto, pagina man, pdf (Impostazione predefinita), ps,
tex, testo, xhtml. L'AsciiDoc formato a2x il valore dell'attributo è impostato su FORMATO.

-H, --Aiuto
Stampa la sintassi della riga di comando e le opzioni del programma su stdout.

--icone
Utilizzare immagini di icone di navigazione o di ammonizione nei documenti di output. Il comportamento predefinito è
utilizzare il testo al posto delle icone.

--icon-dir=PERCORSO
Un percorso (relativo ai file di output) contenente ammonimenti e icone di navigazione. Predefiniti
a immagini/icone. Il --icone opzione è implicita se viene utilizzata questa opzione.

-K, --keep-artefatti
Non eliminare i file di build temporanei.

--lince
Usa il lince(1) per generare output in formato testo. Il comportamento predefinito è usare w3m(1).

-L, --no-xmlint
Non controllare l'output asciidoc con xmlint(1).

---epubcheck
Controlla l'output EPUB con epubcheck(1).

-N, --funzionamento a secco
Non fare nulla, stampa solo ciò che sarebbe stato fatto.

-R, --risorsa=RISORSA_SPEC
Specifica una risorsa. Questa opzione può essere specificata più di una volta. Vedi il RISORSE
.

-M, --risorsa-manifest=RISORSE
RISORSE contiene un elenco di risorse (una per riga). Manifesto RISORSE le voci sono formattate
proprio come --risorsa argomenti di opzione. Variabili d'ambiente e tilde home
le directory sono consentite.

--foglio di stile=FOGLIO DI STILE
Un elenco delimitato da spazi di uno o più nomi di file di fogli di stile CSS utilizzati per lo stile
Output HTML generato da DocBook XSL Stylesheets. Il valore predefinito è docbook-xsl.css.
i fogli di stile vengono elaborati in ordine di elenco. I fogli di stile devono risiedere in un valido
posizione del file di risorse. Si applica ai formati HTML: xhtml, epub, Chunked, htmlaiuto
formati.

-in, --verboso
Stampa i dettagli operativi su stderr. Un secondo -v opzione applica l'opzione verbose a
comandi della toolchain.

--versione
Stampa la versione del programma su stdout.

--xsltproc-opts=XSLTPROC_OPTS
aggiuntivo xsltproc(1) opzioni. Questa opzione può essere specificata più di una volta.

--file-xsl=FILE_XSL
Sostituisci il foglio di stile XSL integrato con il foglio di stile XSL personalizzato FILE_XSL.

--fop
Usa FOP per generare PDF. Il comportamento predefinito è usare dblatex(1). --fop opzione
è implicito se viene utilizzata questa opzione.

--fop-opzioni=FOP_OPTS
aggiuntivo stupido(1) opzioni. Se questa opzione è specificata, FOP viene utilizzato per generare PDF.
Questa opzione può essere specificata più di una volta.

--dblatex-opzioni=DBLATEX_OPTS
aggiuntivo dblatex(1) opzioni. Questa opzione può essere specificata più di una volta.

--opzioni-backend=INDIETROEND_OPTS
Opzioni per il plugin di backend specificato da --backend opzione. Questa opzione potrebbe essere
specificato più di una volta.

Le opzioni possono essere impostate anche nel file sorgente AsciiDoc. Se FILE SORGENTE contiene un commento
riga che inizia con // a2x: quindi il resto della riga verrà trattato come a2x
opzioni della riga di comando. Per esempio:

// a2x opzioni predefinite.
// a2x: -dbook --epubcheck
// Sopprime la cronologia delle revisioni negli output di dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· Le opzioni che si estendono su più righe di commento di questo tipo verranno concatenate.

· Tra le iniziali possono apparire zero o più spazi bianchi // ed a2x:.

· Le opzioni della riga di comando hanno la precedenza sulle opzioni impostate nel file sorgente.

USCITA FILE

I file di output vengono scritti nella directory specificata dal --destinazione-dir opzione. se no
--destinazione-dir l'opzione è impostata i file di output vengono scritti su FILE SORGENTE directory.

I file di output hanno lo stesso nome del FILE SORGENTE ma con un nome file appropriato
estensione: .html per xhtml; .epub per epub; .hhp per htmlaiuto; .pdf per pdf; .testo per
testo, .xml per libro dei documenti. Per convenzione le pagine man non hanno l'estensione .man (sezione della pagina man
Solo il numero). I nomi delle directory HTML in blocchi hanno l'estensione .chunked; Aiuto HTML in blocchi
i nomi delle directory hanno l'estensione .htmlhelp.

I file esistenti con lo stesso nome vengono sovrascritti.

Oltre a generare file HTML, xhtml, epub, Chunked ed htmlaiuto i formati assicurano
i file di risorse vengono copiati nelle posizioni corrette della directory di destinazione.

RISORSE

Le risorse sono file (tipicamente CSS e immagini) richiesti dagli output basati su HTML
(xhtml, epub, Chunked, htmlaiuto Formati). a2x scansiona i file HTML generati e costruisce a
elenco dei CSS e dei file immagine richiesti. È possibile specificare file di risorse aggiuntivi
usando esplicitamente il --risorsa opzione.

a2x cerca i file di risorse nelle seguenti posizioni nel seguente ordine:

1. il FILE SORGENTE directory.

2. Directory delle risorse specificate dal --risorsa opzione (ricerca ricorsiva).

3. Directory delle risorse specificate dal --risorsa-manifest opzione (cercato in modo ricorsivo
nell'ordine in cui appaiono nel file manifest).

4. Le directory delle immagini stock e dei fogli di stile in asciido(1) file di configurazione
directory (ricerca ricorsiva).

5. La directory di destinazione.

Quando viene trovato un file di risorse, viene copiato nella directory di destinazione relativa corretta.
Le sottodirectory di destinazione mancanti vengono create automaticamente.

Esistono due meccanismi distinti per specificare risorse aggiuntive:

1. Una directory di risorse che verrà cercata in modo ricorsivo per i file di risorse mancanti.

2. Un file di risorse che verrà copiato nella directory di destinazione dell'output.

Le risorse sono specificate con --risorsa valori di opzione che possono essere uno dei seguenti
formati:


[= ]
. =

Dove:


Specifica una directory (assoluta o relativa al FILE SORGENTE) che viene cercato
ricorsivamente per i file di risorse mancanti. Per eliminare l'ambiguità il nome
dovrebbe terminare con un carattere separatore di directory.


Specifica un file di risorse (assoluto o relativo al FILE SORGENTE) che sarà
copiato in . Se non è specificato allora è il
lo stesso del .


Specifica la destinazione del file di origine copiato. Il il percorso è
relativo alla directory di destinazione (non sono consentiti percorsi assoluti). La posizione
della directory di destinazione dipende dall'output FORMATO (Vedi USCITA FILE
sezione per i dettagli):

a pezzi, htmlhelp
La directory di output in blocchi.

epub
La directory OEBPS archiviata.

xhtml
L'uscita DESTINAZIONE_DIR.

. =
Quando si aggiungono risorse ai file EPUB, il tipo MIME viene dedotto da
file> estensione, se il tipo MIME non può essere indovinato si verifica un errore. Il
. = la sintassi delle risorse può essere utilizzata per impostare in modo esplicito i tipi MIME. è
l'estensione del nome del file, è il tipo MIME corrispondente.

Esempi di opzioni di risorse:

--risorsa ../immagini/
--resource doc/LEGGIMI.txt=LEGGIMI.txt
--risorsa ~/images/tigre.png=immagini/tigre.png
--resource .ttf=applicazione/x-font-ttf

ESEMPI

a2x -f pdf doc/source-highlight-filter.txt
Genera il file doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
Crea file HTML ../doc/team.html, utilizza icone di ammonizione e cerca ricorsivamente il
../images/ directory per eventuali risorse mancanti.

a2x -f pagina man doc/asciidoc.1.txt
Genera manpage doc/asciidoc.1.

REQUISITI

a2x utilizza i seguenti programmi:

· Asciido: http://asciidoc.org/

· xsltproc: (tutti i formati tranne il testo): http://xmlsoft.org/XSLT/

· DocBook XSL Fogli di stile (tutti i formati tranne il testo):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (formati pdf, dvi, ps, tex): http://dblatex.sourceforge.net/

· FOP (formato pdf — generatore di file PDF alternativo): http://xmlgraphics.apache.org/fop/

· w3m (formato testo): http://w3m.sourceforge.net/index.en.html

· Lynx (formato testo — generatore di file di testo alternativo): http://lynx.isc.org/

· epubcheck (formato epub — validatore di file EPUB): http://code.google.com/p/epubcheck/

Vedi anche l'ultimo file README.

CONF FILE

Un file di configurazione contiene codice Python eseguibile che sovrascrive il globale
parametri di configurazione in a2x.py. I file di configurazione opzionali vengono caricati nel
seguente ordine:

1. a2x.conf dalla directory contenente il a2x.py eseguibile.

2. a2x.conf dalla directory di configurazione globale di AsciiDoc. Salta questo passaggio se lo siamo
l'esecuzione di una copia installata localmente (non a livello di sistema).

3. a2x.conf dalla directory di configurazione AsciiDoc $HOME/.asciidoc.

4. il CONF_FILE specificato in --conf-file opzione.

Di seguito sono riportati i valori delle opzioni del file di configurazione predefinito:

# Dizionario della variabile d'ambiente opzionale passato a
# programmi in esecuzione. Se impostato su Nessuno, l'esistente
# ambiente è utilizzato.
ENV = Nessuno

# Eseguibili esterni.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # generazione pdf.
FOP = 'fop' # generazione pdf (opzione --fop).
W3M = 'w3m' # generazione del testo.
LYNX = 'lynx' # generazione del testo (se non w3m).
XMLLINT = 'xmllint' # Imposta su '' per disabilitare.
EPUBCHECK = 'epubcheck' # Imposta su '' per disabilitare.
# Opzioni predefinite dell'eseguibile esterno.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Usa a2x online utilizzando i servizi onworks.net