mdoc-assemble — Online w chmurze

PROGRAM:

IMIĘ

mdoc assemble — Kompiluje dokumentację do wykorzystania w monodokument(1)

STRESZCZENIE

mdoc montować [OPCJE]+ ŚCIEŻKI+

OPIS

mdoc montować tworzy .drzewo i .zamek błyskawiczny plików z ŚCIEŻKI do użytku w monodokument(1)
przeglądarka dokumentacji.

Pliki wejściowe muszą mieć obsługiwany plik format, określony za pomocą --format opcja.

Opona .drzewo i .zamek błyskawiczny kopiowane są pliki monodokument's źródła katalog, obok a .źródło
plik używany przez monodokument(1) określenie, gdzie dokumentacja powinna być wystawiona.

Opona .źródło plik ma następujący format:

<? Xml version = "1.0"?>






elements -->


Opona /monodoc/węzeł węzeł jest opcjonalnym węzłem, który określa, gdzie w drzewie monodoc znajduje się plik
należy wyświetlić dokumentację oraz //węzeł elementy mogą być zagnieżdżane na dowolnej głębokości
tworzyć drzewa. //węzeł/@etykieta to etykieta, która będzie wyświetlana w drzewie monodoc.

//węzeł/@nazwa to nazwa węzła drzewa monodoc i może być używana jako wartość parametru
/monodoc/source/@ścieżka wartość.

//węzeł/@rodzic to nazwa węzła, która ma być używana jako węzeł nadrzędny.
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml zawiera listę takich nazw, a to może
być dowolnym //węzeł/@nazwa wartość. jeśli //węzeł/@rodzic wartość nie zostanie znaleziona, wówczas jest wstawiana
w węźle drzewa „Różne”.

Opona /monodoc/source/@dostawca atrybut określa, którego dostawcy formatu należy użyć
podczas czytania .drzewo i .zamek błyskawiczny akta; Ten musi odpowiada jednemu z --format wartości.

Opona /monodoc/source/@plik bazowy atrybut określa przedrostek nazwy pliku dla
pliki dokumentacji. Musi to być ten sam przedrostek, który jest używany z --na zewnątrz parametr.
Powinno być Nie rozszerzenie nazwy pliku na tę wartość.

Opona /monodoc/source/@ścieżka atrybut określa węzeł nadrzędny w monodokument(1) widok drzewa
gdzie będzie umieszczona dokumentacja. Zobacz
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml plik z listą PATH wartości (tzw
//węzeł/@nazwa wartości) lub może to być a //węzeł/@nazwa wartość w tym samym .źródło plik.

Po PLIKBASE.źródło został napisany, dokumentację można zainstalować w taki sposób
monodokument(1) wyświetli dokumentację za pomocą polecenia:

cp BASEFILE.source BASEFILE.tree BASEFILE.zip \
`pkg-config monodoc --variable=katalog źródłowy`

OPCJE

-f, --format=FORMAT
Określa format dokumentacji używany w ramach ŚCIEŻKI. Ważny FORMAT wartości obejmują:
ekma, ecmasspec, błąd, hb, mężczyzna, prosty, xhtml.

Zobacz FORMATY sekcję poniżej, aby uzyskać więcej informacji na temat tych formatów.

Domyślny format (jeśli nie został określony) to ekma.

Opona --format opcja może być przeplatana ŚCIEŻKI aby zmienić format używany dla
pozostałe parametry (do następnego --format opcja jest widoczna), np.:

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

będzie montować katalogi A i B z ekma format, pliki C i D z mężczyzna
formularz i katalog E z xhtml Format.

-o, --na zewnątrz=PREFIKSÓW
Określ przedrostek pliku wyjściowego. mdoc montować tworzy pliki PREFIKS.zip i
PREFIKS.drzewo.

-h, -?, --help
Wyświetl komunikat pomocy i wyjdź.

FORMATY

Obsługiwane są następujące formaty dokumentacji:

ekma
Opona Mono ECMA Dokumenty utworzony, format dokumentacji XML z jednym plikiem na typ.

Zobacz mdoc(5) strona podręcznika, aby uzyskać więcej informacji.

ecmasspec
Opona Mono ECMA Specyfikacja Dokumenty utworzony. To nie jest format, którego szukasz
Do; jest to format używany do reprezentowania standardu ECMA-334 (C#). monodokument(1). Ono
nie służy do wyświetlania dokumentacji biblioteki klas; do dokumentacji biblioteki klas użyj
dotychczasowy ekma Format.

błąd
Opona Błąd Dokumenty utworzony służy do prezentowania szczegółowych komunikatów o błędach i jest używany w
monodokument(1) drzewo „Odniesienia do błędów kompilatora C#”.

W tym formacie ŚCIEŻKI to plik konfiguracyjny zawierający kod XML:


../../mcs/błędy
cs????*.cs
2
4
CS{0:0###}


Elementy oznaczają:

/ErrorProviderConfig/Ścieżka plików
Określa, gdzie szukać plików.

/ErrorProviderConfig/Dopasuj
Określa wzorzec nazwy pliku, który ma być wyszukiwany w pliku
/ErrorProviderConfig/Ścieżka plików katalogiem.

/ErrorProviderConfig/ErrorNumSubstringStart
Określa, gdzie w nazwie pliku zaczyna się numer błędu.

/ErrorProviderConfig/ErrorNumSubstringLength
Określa liczbę znaków po /ErrorProviderConfig/ErrorNumSubstringStart do
użyj numeru błędu.

/ErrorProviderConfig/FriendlyFormatString
Określa formatowanie/wyświetlanie węzła w pliku monodokument(1) drzewo.

Każdy znaleziony plik jest konwertowany do formatu HTML z zastosowanym kolorowaniem składni C#.

prosty
Opona Prosty Dokumenty utworzony format pliku rekurencyjnie dodaje wszystkie pliki i katalogi
pod ŚCIEŻKI. Po wyświetleniu pliki HTML są wyświetlane w niezmienionej postaci. Pliki tekstowe są
konwertowane na HTML poprzez tłumaczenie każdego nowego wiersza na HTML element. Żaden inny plik
typ jest obsługiwany.

mężczyzna
Opona Mężczyzna Strona Dokumenty utworzony wyświetla strony podręcznika groffa. (To jest nie pełny grof
parser i obsługuje tylko konstrukcje stron podręcznika używane w monostronach podręcznika.)

ŚCIEŻKI to zestaw plików XML zawierający:

<? Xml version = "1.0"?>




Może być ich wiele //strona podręcznika elementy w korzeniu /strona podręcznika elementem.

Opona /manpages/manpage/@nazwa atrybut zawiera nazwę wyświetlaną węzła widoku drzewa,
który jest także adresem URL strony podręcznika podczas używania monodokument(1) Lookup URL polecenie (wcześniej
z przedrostkiem a człowiek: prefiks). Zatem jeśli /manpages/manpage/@nazwa zawiera mono(1), następnie
człowiek:mono(1) może być używany w Lookup URL polecenie, aby wyświetlić mono(1) strona podręcznika.

Opona /manpages/manpage/@strona atrybut to nazwa pliku zawierającego stronę podręcznika. Jeśli to
plik nie istnieje w takim razie /manpages/manpage/@nazwa nie będą wyświetlane w drzewie
widok.

xhtml
Dostawca XHTML interpretuje ŚCIEŻKI jako plik pomocy systemu Windows, plik XHTML TOC i szuka
dokumenty odniesienia, aby utworzyć źródło pomocy.

Użyj mdoc-assemble online, korzystając z usług onworks.net