mdoc-assemble - Online nel cloud

PROGRAMMA:

NOME

mdoc assemble - Compila la documentazione per l'uso in monodotto(1)

SINOSSI

mdoc assemblare [OPZIONI]+ PERCORSI+

DESCRIZIONE

mdoc assemblare crea .albero e file .zip file da PERCORSI per l'uso nel monodotto(1)
browser della documentazione.

I file di input devono avere un formato supportato formato, specificato con il --formato opzione.

. .albero e file .zip i file vengono copiati in monodotto's fonti directory, insieme a un .fonte
file che viene utilizzato da monodotto(1) per specificare dove la documentazione deve essere esposta.

. .fonte il file ha il seguente formato:








elements -->


. /monodoc/nodo node è un nodo facoltativo che specifica dove nell'albero monodoc il
la documentazione dovrebbe essere visualizzata e //nodo gli elementi possono essere annidati a qualsiasi profondità per
creare alberi. //nodo/@etichetta è l'etichetta che verrà visualizzata all'interno dell'albero monodoc.

//nodo/@nome è il nome del nodo dell'albero monodoc e può essere utilizzato come valore di
/monodoc/source/@path valore.

//nodo/@genitore è il nome del nodo da utilizzare come nodo padre.
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml contiene un elenco di tali nomi, e questo può
essere qualsiasi //nodo/@nome valore. Se la //nodo/@genitore il valore non viene trovato, quindi viene inserito
sotto il nodo dell'albero "Varie".

. /monodoc/source/@provider l'attributo specifica quale fornitore di formato deve essere utilizzato
durante la lettura del .albero e file .zip file; questo devono obbligatoriamente: corrispondono a uno dei --formato valori.

. /monodoc/source/@basefile l'attributo specifica il prefisso del nome file per il
file di documentazione. Deve essere lo stesso prefisso utilizzato con --fuori parametro.
Ci dovrebbe essere no estensione del nome file su questo valore.

. /monodoc/source/@path l'attributo specifica il nodo padre in monodotto(1) vista ad albero
dove verrà inserita la documentazione. Vedi il
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml file per un elenco di PERCORSO valori (il
//nodo/@nome valori), oppure può essere un //nodo/@nome valore nello stesso .fonte file.

Una volta che il BASEFILE.source è stato scritto, la documentazione può essere installata in modo che
monodotto(1) visualizzerà la documentazione con il comando:

cp BASEFILE.source BASEFILE.tree BASEFILE.zip \
`pkg-config monodoc --variabile=sourcesdir`

VERSIONI

-f, --formato=FORMATO
Specifica il formato di documentazione utilizzato all'interno PERCORSI. Valido FORMATO i valori includono:
ecma, ecmaspec, errore, hb, uomo, semplicee xhtml.

Vedere la FORMATI sezione sottostante per maggiori informazioni su questi formati.

Il formato predefinito (se non ne è specificato nessuno) è ecma.

. --formato l'opzione può essere intervallata con PERCORSI per cambiare il formato utilizzato per
parametri rimanenti (fino al prossimo --formato opzione è visibile), ad esempio:

mdoc assemble -o PREFIX AB --format=man CD --format=xhtml E

assemblerà le directory A e B con la ecma formato, file C e D con la uomo
formato e directory E con la xhtml formato.

-o, --fuori=PREFISSO
Specificare il prefisso del file di output. mdoc assemblare crea i file PREFISSO.zip e
PREFISSO.albero.

-h, -?, --Aiuto
Visualizza un messaggio di aiuto ed esci.

FORMATI

Sono supportati i seguenti formati di documentazione:

ecma
. Mono ECMA Documentazione Formato, un formato di documentazione XML con un file per tipo.

Vedere la mdoc(5) pagina man per maggiori informazioni.

ecmaspec
. Mono ECMA Specificazione Documentazione FormatoQuesto non è il formato che stai cercando
per; è il formato utilizzato per rappresentare lo standard ECMA-334 (C#) all'interno monodotto(1). Esso
non viene utilizzato per visualizzare la documentazione della libreria di classi; per la documentazione della libreria di classi, utilizzare
, il ecma formato.

errore
. Errore Documentazione Formato viene utilizzato per presentare messaggi di errore dettagliati e viene utilizzato in
monodotto(1) Albero di "Riferimento agli errori del compilatore C#".

In questo formato, PERCORSI è un file di configurazione, contenente l'XML:


../../mcs/errori
cs????*.cs
2
4
CS{0:0###}


Gli elementi significano:

/ErrorProviderConfig/FilesPath
Specifica dove cercare i file.

/ErrorProviderConfig/Corrispondenza
Specifica il modello di nome file da cercare all'interno del
/ErrorProviderConfig/FilesPath directory.

/ErrorProviderConfig/ErrorNumSubstringStart
Specifica dove all'interno del nome file inizia il numero di errore.

/ErrorProviderConfig/ErrorNumSubstringLength
Specifica quanti caratteri dopo /ErrorProviderConfig/ErrorNumSubstringStart a
utilizzare per il numero di errore.

/ErrorProviderConfig/FriendlyFormatString
Specifica la formattazione/visualizzazione del nodo in monodotto(1) albero.

Per ogni file trovato, questo viene convertito in HTML con applicazione della colorazione della sintassi C#.

semplice
. Semplice Documentazione Formato il formato del file aggiunge ricorsivamente tutti i file e le directory
sotto PERCORSIQuando vengono visualizzati, i file HTML vengono visualizzati così come sono. I file di testo sono
convertito in HTML traducendo ogni nuova riga in un codice HTML elemento. Nessun altro file
il tipo è supportato.

uomo
. Uomo Pagina Documentazione Formato visualizza le pagine man di groff. (Questo è non è un un groff completo
parser e gestisce solo le strutture delle pagine man utilizzate all'interno delle pagine man mono.)

PERCORSI è un insieme di file XML contenenti:






Ci possono essere più //manpage elementi all'interno della radice /manpage elemento.

. /manpages/manpage/@nome l'attributo contiene il nome visualizzato per il nodo della vista ad albero,
che è anche l'URL della pagina man quando si utilizza monodotto(1)'s Lookup URL comando (prima
prefissando con a uomo: prefisso). Quindi, se /manpages/manpage/@nome contiene mono(1), poi
uomo:mono(1) può essere utilizzato in Lookup URL comando per visualizzare il mono(1) pagina man.

. /manpages/manpage/@page L'attributo è il nome del file che contiene la pagina man. Se questo
il file non esiste, quindi /manpages/manpage/@nome non verrà visualizzato all'interno dell'albero
vista.

xhtml
Il provider XHTML interpreta PERCORSI come un file di aiuto di Windows, file XHTML TOC e cerca
documenti di riferimento per creare la fonte della guida.

Utilizzare mdoc-assemble online utilizzando i servizi onworks.net