mdoc-assemble - Online in de cloud

PROGRAMMA:

NAAM

mdoc assemble - Compileer documentatie voor gebruik in monodoc(1)

KORTE INHOUD

mdoc monteren [OPTIES]+ PADEN+

PRODUCTBESCHRIJVING

mdoc monteren creëert .boom en .zip bestanden van PADEN voor gebruik in de monodoc(1)
documentatiebrowser.

De invoerbestanden moeten een ondersteund formaat, gespecificeerd met de --formaat optie.

De .boom en .zip bestanden worden gekopieerd naar monodoc's bronnen directory, naast een .bron
bestand dat wordt gebruikt door monodoc(1) om te specificeren waar de documentatie moet worden weergegeven.

De .bron bestand heeft het volgende formaat:








elements -->


De /monodoc/node node is een optioneel knooppunt dat specificeert waar in de monodoc-boom de
documentatie moet worden weergegeven, en //knooppunt elementen kunnen tot elke diepte worden genest
bomen maken. //knooppunt/@label is het label dat wordt weergegeven in de monodoc-boom.

//knooppunt/@naam is de naam van het monodoc-boomknooppunt en kan worden gebruikt als de waarde van de
/monodoc/bron/@pad waarde.

//knooppunt/@ouder is de knooppuntnaam die als bovenliggend knooppunt moet worden gebruikt.
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml bevat een lijst met dergelijke namen, en dit kan
zijn een //knooppunt/@naam waarde. Als de //knooppunt/@ouder waarde niet wordt gevonden, wordt deze ingevoegd
onder het boomknooppunt "Diverse".

De /monodoc/source/@provider attribuut specificeert welke formatprovider moet worden gebruikt
bij het lezen van de .boom en .zip bestanden; dit Dan moet je corresponderen met een van de --formaat waarden.

De /monodoc/source/@basefile attribuut specificeert het voorvoegsel van de bestandsnaam voor het
documentatiebestanden. Dit moet hetzelfde voorvoegsel zijn als gebruikt bij de --uit parameter.
Er zou moeten zijn geen bestandsnaamextensie op deze waarde.

De /monodoc/bron/@pad attribuut specificeert het bovenliggende knooppunt in monodoc(1) Boomstructuurweergave
waar de documentatie zal worden ingevoegd. Zie de
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml bestand voor een lijst van PATH waarden (de
//knooppunt/@naam waarden), of het kan een zijn //knooppunt/@naam waarde in hetzelfde .bron bestand.

Wanneer de BASEFILE.bron is geschreven, kan de documentatie zo worden geïnstalleerd dat
monodoc(1) zal de documentatie weergeven met de opdracht:

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

OPTIES

-f, --formaat=FORMAT
Specificeert het documentatieformaat dat daarin wordt gebruikt PADEN. Geldig FORMAT waarden omvatten:
ecma, ecmaspec, fout, hb, man, simpel en xhtml.

Zie de FORMATS sectie hieronder voor meer informatie over deze formaten.

Het standaardformaat (als er geen is opgegeven) is ecma.

De --formaat optie kan worden afgewisseld met PADEN om het formaat dat voor de
resterende parameters (tot de volgende --formaat optie wordt gezien), bijvoorbeeld:

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

zal mappen samenstellen A en B met de ecma formaat, bestanden C en D met de man
formaat en map E met de xhtml formaat.

-o, --uit=VOORVOEGSEL
Geef het voorvoegsel van het uitvoerbestand op. mdoc monteren maakt de bestanden aan PREFIX.zip en
PREFIX.boom.

-h, -?, --help
Geef een helpbericht weer en sluit af.

FORMATS

De volgende documentatieformaten worden ondersteund:

ecma
De Mono ECMA Documentatie Formaat, een XML-documentatieformaat met één bestand per type.

Zie de mdoc(5) man-pagina voor meer informatie.

ecmaspec
De Mono ECMA Specificaties Documentatie Formaat. Dit is niet het formaat dat u zoekt
voor; het is het formaat dat wordt gebruikt om de ECMA-334 (C#) standaard binnenin weer te geven monodoc(1). Het
wordt niet gebruikt om klassebibliotheekdocumentatie weer te geven; gebruik voor documentatie over de klassenbibliotheek
de ecma formaat.

fout
De Fout Documentatie Formaat wordt gebruikt om gedetailleerde foutmeldingen weer te geven en wordt gebruikt in
monodoc(1)'s "C# Compiler Error Reference" -boom.

In dit formaat PADEN is een configuratiebestand met de XML:


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


De elementen betekenen:

/ErrorProviderConfig/FilesPath
Geeft aan waar naar bestanden moet worden gezocht.

/ErrorProviderConfig/Match
Specificeert het bestandsnaampatroon waarnaar moet worden gezocht in het
/ErrorProviderConfig/FilesPath directory.

/ErrorProviderConfig/ErrorNumSubstringStart
Geeft aan waar binnen de bestandsnaam het foutnummer begint.

/ErrorProviderConfig/ErrorNumSubstringLength
Specificeert hoeveel tekens erna /ErrorProviderConfig/ErrorNumSubstringStart naar
gebruiken voor het foutnummer.

/ErrorProviderConfig/FriendlyFormatString
Specificeert de opmaak/weergave van het knooppunt in het monodoc(1) boom.

Voor elk gevonden bestand wordt het geconverteerd naar HTML met toegepaste C#-syntaxiskleuring.

simpel
De Eenvoudig Documentatie Formaat bestandsformaat voegt recursief alle bestanden en mappen toe
onder PADEN. Wanneer ze worden weergegeven, worden HTML-bestanden weergegeven zoals ze zijn. Tekstbestanden zijn
omgezet in HTML door elke nieuwe regel naar HTML te vertalen element. Geen ander bestand
soort wordt ondersteund.

man
De Man Pagina Documentatie Formaat geeft groff man-pagina's weer. (Dit is niet een volledige groff
parser, en verwerkt alleen de manpaginaconstructies die binnen de mono-manpagina's worden gebruikt.)

PADEN is een set XML-bestanden met daarin:






Er kunnen meerdere zijn // manpagina elementen binnen de wortel /manpagina element.

De /manpages/manpage/@naam attribuut bevat de weergavenaam voor het boomweergaveknooppunt,
wat ook de URL is van de manpagina bij gebruik monodoc(1) die van Lookup URL opdracht (voor
voorafgegaan door een Mens: voorvoegsel). Dus als /manpages/manpage/@naam bevat mono(1)dan
Mens:mono(1) kan worden gebruikt in de Lookup URL opdracht om de mono(1) man pagina.

De /manpages/manpagina/@pagina attribuut is de bestandsnaam die de manpagina bevat. Als dit
bestand bestaat dus niet /manpages/manpage/@naam wordt niet weergegeven in de boomstructuur
uitzicht.

xhtml
De XHTML-provider interpreteert PADEN als een Windows Help-bestand XHTML TOC-bestand en zoekt naar
documenten waarnaar wordt verwezen om de Help-bron te maken.

Gebruik mdoc-assemble online met behulp van onworks.net-services