dtplite - Online nel cloud

PROGRAMMA:

NOME

dtplite - Processore di markup DocTools leggero

SINOSSI

dtplite -o produzione ?opzioni? formato file di input

dtplite convalidare file di input

dtplite -o produzione ?opzioni? formato directoryinput

dtplite -unione -o produzione ?opzioni? formato directoryinput

_________________________________________________________________________________________________

DESCRIZIONE

L'applicazione descritta da questo documento, dtplite, è il successore dell'estremamente
semplice mpexpand. Influenzato nella sua funzionalità dal dtp processore doctools è molto
più potente di mpexpand, ma ancora facile da usare; decisamente più facile di dtp con il suo
una miriade di sottocomandi e opzioni.

dtplite si basa sul pacchetto doctools, come gli altri due processori.

USO CASI
dtplite è stato scritto pensando ai seguenti tre casi d'uso.

[1] Convalida di un singolo documento, ovvero verifica che sia stato scritto in valido
formato doctools. Questa modalità può essere utilizzata anche per ottenere una versione preliminare del
output formattato per un singolo documento, per la visualizzazione in un browser, nroff, ecc.,
consentire la correzione della formattazione.

[2] Generazione della documentazione formattata per un singolo pacchetto, ovvero tutte le
pagine man, oltre a un sommario e un indice di parole chiave.

[3] Un'estensione della precedente modalità di funzionamento, un metodo per la facile generazione di
un albero di documentazione per diversi pacchetti, e soprattutto di una tabella unificata di
indice dei contenuti e delle parole chiave.

Oltre a quanto sopra, vogliamo anche utilizzare le funzionalità di personalizzazione fornite dal
formattatore HTML. Non è l'unico formato che l'applicazione dovrebbe essere in grado di generare, ma
anticipiamo che sia il più comunemente usato, ed è uno dei pochi che fornisce
ganci di personalizzazione.

Permettiamo al chiamante di specificare una stringa di intestazione, una stringa di piè di pagina, un foglio di stile e dati per
una barra di collegamenti di navigazione nella parte superiore del documento generato. Mentre tutto può essere impostato come
purché il motore di formattazione fornisca un parametro motore appropriato (vedi sezione
VERSIONI) gli ultimi due hanno un'elaborazione interna che li rende specifici per l'HTML.

COMANDO LINE
dtplite -o produzione ?opzioni? formato file di input
Questo è il modulo per il caso d'uso [1]. Il Opzioni verrà spiegato più avanti, nella sezione
VERSIONI.

sentiero produzione (nel)
Questo argomento specifica dove scrivere il documento generato. Può essere il
percorso di un file o di una directory, oppure -. L'ultimo valore fa sì che l'applicazione
scrivi il documentato generato a stdout.

Se l' produzione non esiste allora [file dirname $output] deve esistere e
deve essere una directory scrivibile. Il documento generato verrà scritto su a
file in quella directory, e il nome di quel file sarà derivato da
file di input, l' formato, e il valore dato a option -est (se presente).

(percorso|maniglia) formato (nel)
Questo argomento specifica il motore di formattazione da utilizzare durante l'elaborazione del
input, e quindi il formato del documento generato. Vedi sezione FORMATI
per le possibilità riconosciute dall'applicazione.

sentiero file di input (nel)
Questo argomento specifica il percorso del file da elaborare. deve esistere,
deve essere leggibile e scritto in doctools formato.

dtplite convalidare file di input
Questa è una forma più semplice per il caso d'uso [1]. Il formato "convalida" non genera output
vengono eseguiti solo controlli di sintassi. In quanto tale la specifica di un output
file o altre opzioni non sono necessarie e vengono tralasciate.

dtplite -o produzione ?opzioni? formato directoryinput
Questo è il modulo per il caso d'uso [2]. Differisce dalla forma per il caso d'uso [1] per
avere i documenti di input specificati tramite una directory anziché un file. Il
altri argomenti sono identici, tranne che per produzione, che ora deve essere il percorso per
una directory esistente e scrivibile.

I documenti di input sono tutti file in directoryinput o una qualsiasi delle sue sottodirectory
che sono stati riconosciuti da fileutil::tipofile come contenente testo in doctools formato.

dtplite -unione -o produzione ?opzioni? formato directoryinput
Questo è il modulo per il caso d'uso [3]. L'unica differenza rispetto al modulo per il caso d'uso [2]
è l'opzione aggiuntiva -unione.

Ciascuna di queste chiamate unirà i documenti generati provenienti dall'elaborazione dell'input
documenti sotto directoryinput o una qualsiasi delle sue sottodirectory ai file sotto
produzione. In questo modo è possibile costruire in modo incrementale l'unificato
documentazione per qualsiasi numero di pacchetti. Nota che è necessario percorrere
tutti i pacchetti due volte per ottenere riferimenti incrociati completamente corretti (per i formati
sostenerli).

VERSIONI
Questa sezione descrive tutte le opzioni disponibili per l'utente dell'applicazione, con il
eccezione delle opzioni -o e a -unione. Questi due sono stati già descritti, nella sezione
COMANDO LINE.

-escludere stringa
Questa opzione specifica un modello di esclusione (glob). Qualsiasi file identificato come manpage
per elaborare che corrispondono al modello di esclusione vengono ignorati. L'opzione può essere fornita
più volte, ogni utilizzo aggiunge un modello aggiuntivo all'elenco delle esclusioni.

-est stringa
Se il nome di un file di output deve essere derivato dal nome di un file di input è
userà il nome del formato come estensione per impostazione predefinita. Questa opzione qui sarà
sovrascrivere questo tuttavia, costringendolo a utilizzare stringa come estensione del file. Questa opzione
viene ignorato se il nome del file di output è completamente specificato tramite l'opzione -o.

Se utilizzato più volte, è rilevante solo l'ultima definizione.

-intestazione filetto
Questa opzione può essere utilizzata se e solo se selezionata formato fornisce un motore
parametro denominato "intestazione". Prende il contenuto del file specificato e lo assegna
li a quel parametro, per qualunque uso da parte del motore. Il motore HTML inserirà
il testo subito dopo il tag . Se sono presenti i pulsanti di navigazione (vedi opzione
-navi sotto), quindi l'HTML generato per loro viene aggiunto ai dati dell'intestazione
originato qui prima dell'assegnazione finale al parametro.

Se utilizzato più volte, è rilevante solo l'ultima definizione.

-piè di pagina filetto
Come -intestazione, tranne che: Eventuali pulsanti di navigazione vengono ignorati, i corrispondenti
il parametro motore richiesto è denominato "piè di pagina" e i dati vengono inseriti appena prima
il tag .

Se utilizzato più volte, è rilevante solo l'ultima definizione.

Stile filetto
Questa opzione può essere utilizzata se e solo se selezionata formato fornisce un motore
parametro denominato "meta". Quando specificato genererà un pezzo di codice HTML
dichiarando il filetto come foglio di stile per il documento generato e assegnalo a
il parametro. Il motore HTML lo inserirà nel documento, subito dopo il
etichetta .

Quando si elabora una directory di input, il file del foglio di stile viene copiato nell'output
directory e l'HTML generato farà riferimento alla copia, per rendere il risultato più
autonomo. Durante l'elaborazione di un file di input non abbiamo una posizione per copiare il
foglio di stile e quindi fai riferimento ad esso come specificato.

Se utilizzato più volte, è rilevante solo l'ultima definizione.

-tocc sentiero
Questa opzione specifica un file doctoc da usare per il sommario invece di
generando il nostro.

Se utilizzato più volte, è rilevante solo l'ultima definizione.

-pre+toc percorso etichetta|testo

-post+toc percorso etichetta|testo
Questa opzione specifica file doctoc aggiuntivi (o testi) da utilizzare nella navigazione
bar.

Il posizionamento e la gestione di più usi è come per le opzioni -prenavi e a -postnavi,
vedi sotto.

-navi URL etichetta

-prenavi URL etichetta
Usa questa opzione per specificare un pulsante di navigazione con etichetta per visualizzare e il URL a
Collegamento a. Questa opzione può essere utilizzata se e solo se selezionata formato fornisce un
parametro del motore denominato "header". L'HTML generato per questo viene aggiunto a
qualunque dato abbiamo ottenuto dall'opzione -intestazione prima di essere inserito nel generato
documenti.

Se utilizzato più volte, tutte le definizioni vengono raccolte e viene visualizzata una barra di navigazione
creato, con la prima definizione mostrata sul bordo sinistro e l'ultima definizione
a destra.

L'URL può essere relativo. In tal caso si assume che sia relativo al main
file (TOC e indice delle parole chiave) e verranno trasformati per consentire a tutti gli altri di collegarsi ancora
propriamente.

-postnavi URL etichetta
Usa questa opzione per specificare un pulsante di navigazione con etichetta per visualizzare e il URL a
Collegamento a. Questa opzione può essere utilizzata se e solo se selezionata formato fornisce un
parametro del motore denominato "header". L'HTML generato per questo viene aggiunto a
qualunque dato abbiamo ottenuto dall'opzione -intestazione prima di essere inserito nel generato
documenti.

Se utilizzato più volte, tutte le definizioni vengono raccolte e viene visualizzata una barra di navigazione
creato, con l'ultima definizione mostrata sul bordo destro e la prima definizione
a fianco.

L'URL può essere relativo. In tal caso si assume che sia relativo al main
file (TOC e indice delle parole chiave) e verranno trasformati per consentire a tutti gli altri di collegarsi ancora
propriamente.

FORMATI
All'inizio il formato l'argomento verrà trattato come un percorso a un file tcl contenente il codice
per il motore di formattazione richiesto. L'argomento sarà trattato come il nome di uno dei
i formati predefiniti elencati di seguito se e solo se il percorso non esiste.

Note: a limitazione: Se si tratta il formato come percorso dello script tcl che implementa il
motore ha avuto successo, quindi questo script deve implementare non solo l'API del motore per
doctools, cioè doctools_api, ma per doc_api e a docidx_api anche. Altrimenti il
la generazione di un sommario e di un indice di parole chiave fallirà.

Elenco dei formati predefiniti, ovvero come previsto dal pacchetto doctools:

nroff Il processore genera l'output *roff, il formato standard per le manpage unix.

html Il processore genera output HTML, per l'utilizzo e la visualizzazione tramite browser web. Questo
motore è attualmente l'unico a fornire i vari parametri motore richiesti
per l'ulteriore personalizzazione dell'output.

tmm Il processore genera output TMML, il Tcl Manpage Markup Language, un derivato
di XML.

latice Il processore genera un output LaTeX.

wiki Il processore genera markup Wiki come inteso da wiki.

stratagemma Il processore estrae le informazioni fornite da manpage_begin. Questo formato è
utilizzato internamente per estrarre i metadati da cui sia il sommario che
l'indice delle parole chiave è derivato da.

nullo Il processore non genera alcun output. Questo è equivalente a convalidare.

DIRECTORY STRUTTURE
In questa sezione descriviamo le strutture di directory generate dall'applicazione sotto
produzione durante l'elaborazione di tutti i documenti in un directoryinput. In altre parole, questo è solo
rilevanti per i casi d'uso [2] e [3].

[2] La seguente struttura di directory viene creata durante l'elaborazione di un singolo set di input
documenti. L'estensione del file utilizzata è per l'output in HTML, ma non è rilevante
alla struttura ed era solo usato per avere nomi di file corretti.

produzione/
toc.html
index.html
file /
percorso/a/FOO.html

L'ultima riga nell'esempio mostra il documento generato per un file FOO situato in

inputdirectory/percorso/a/FOO

[3] Quando si uniscono molti pacchetti in un insieme unificato di documenti, la directory generata
la struttura è un po' più profonda:

produzione
.tocc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1/
...
FOO2/
toc.html
file /
percorso/a/BAR.html

Ciascuna delle directory FOO1, ... contiene i documenti generati per il pacchetto
FOO1, ... e segue la struttura mostrata per il caso d'uso [2]. L'unica eccezione è
che non esiste un indice per pacchetto.

I file ".tocc"".idx", E".xrf"contengono lo stato interno del tutto
output e verrà letto e aggiornato alla successiva invocazione. Il loro contenuto non lo farà
essere documentato. Rimuovi questi file quando tutti i pacchetti desiderati per l'output sono stati
elaborato, ovvero quando l'output è completo.

I file ".tocdoc", E".idxdoc", sono file intermedi in doctoc e docidx
markup, rispettivamente, contenente il sommario principale e l'indice delle parole chiave per
l'insieme dei documenti prima della loro conversione nel formato di output prescelto. Loro sono
lasciati sul posto, cioè non cancellati, per servire come dimostrazioni di doctoc e docidx
marcatura.

Usa dtplite online utilizzando i servizi onworks.net