mdoc-assemble - Online di Cloud

PROGRAM:

NAMA

mdoc assemble - Kompilasi dokumentasi untuk digunakan di monodoc(1)

RINGKASAN

mdoc berkumpul [OPSI]+ JALAN+

DESKRIPSI

mdoc berkumpul menciptakan .pohon dan Zip. file dari JALAN untuk digunakan dalam monodoc(1)
penjelajah dokumentasi.

File input harus memiliki dukungan format, ditentukan dengan --format .

The .pohon dan Zip. file disalin ke monodoc's sumber direktori, di samping a .sumber
file yang digunakan oleh monodoc(1) untuk menentukan di mana dokumentasi harus ditampilkan.

The .sumber file memiliki format berikut:








elements -->


The /monodoc/simpul node adalah node opsional yang menentukan di mana di pohon monodoc the
dokumentasi harus ditampilkan, dan //simpul elemen dapat disarangkan ke kedalaman apa pun untuk
membuat pohon. //simpul/@label adalah label yang akan ditampilkan di dalam pohon monodoc.

//simpul/@nama adalah nama dari simpul pohon monodoc, dan dapat digunakan sebagai nilai dari
/monodoc/sumber/@path nilai.

//simpul/@induk adalah nama simpul yang akan digunakan sebagai simpul induk.
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml berisi daftar nama seperti itu, dan ini bisa
menjadi apa saja //simpul/@nama nilai. jika //simpul/@induk nilai tidak ditemukan, lalu dimasukkan
di bawah simpul pohon "Berbagai".

The /monodoc/source/@provider atribut menentukan penyedia format mana yang harus digunakan
saat membaca .pohon dan Zip. file; ini harus sesuai dengan salah satu --format nilai-nilai.

The /monodoc/source/@basefile atribut menentukan awalan nama file untuk
file dokumentasi. Ini harus awalan yang sama seperti yang digunakan dengan --keluar parameter.
Seharusnya ada tidak ekstensi nama file pada nilai ini.

The /monodoc/sumber/@path atribut menentukan simpul induk di monodoc(1) tampilan pohon
di mana dokumentasi akan dimasukkan. Lihat
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml file untuk daftar PATH nilai (
//simpul/@nama nilai), atau mungkin a //simpul/@nama nilainya sama .sumber file.

Setelah BASEFILE.sumber telah ditulis, dokumentasi dapat diinstal sehingga
monodoc(1) akan menampilkan dokumentasi dengan perintah:

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

PILIHAN

-f, --format=FORMAT
Menentukan format dokumentasi yang digunakan dalam JALAN. Sah FORMAT nilai meliputi:
ekma, ecmaspec, kesalahan, hb, pria, sederhana, dan xhtml.

Lihat FORMAT bagian di bawah ini untuk informasi lebih lanjut tentang format ini.

Format default (jika tidak ada yang ditentukan) adalah ekma.

The --format opsi dapat disisipkan dengan JALAN untuk mengubah format yang digunakan untuk
parameter yang tersisa (sampai berikutnya --format opsi terlihat), misalnya:

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

akan merakit direktori A dan B pada pengatur terkenal. Pengatur ini menawarkan bantuan hukum kepada traderapabila trader berselisih dengan broker yang terdaftar dengan mereka. ekma format, file C dan D pada pengatur terkenal. Pengatur ini menawarkan bantuan hukum kepada traderapabila trader berselisih dengan broker yang terdaftar dengan mereka. pria
format, dan direktori E pada pengatur terkenal. Pengatur ini menawarkan bantuan hukum kepada traderapabila trader berselisih dengan broker yang terdaftar dengan mereka. xhtml Format.

-o, --keluar=AWALAN
Tentukan awalan file keluaran. mdoc berkumpul membuat file Awalan.zip dan
PREFIX.pohon.

-h, -?, --membantu
Tampilkan pesan bantuan dan keluar.

FORMAT

Format dokumentasi berikut ini didukung:

ekma
The Mono ECMA Dokumentasi dibentuk, format dokumentasi XML dengan satu file per jenis.

Lihat mdoc(5) halaman manual untuk informasi lebih lanjut.

ecmaspec
The Mono ECMA Spesifikasi Dokumentasi dibentuk. Ini bukan format yang Anda cari
untuk; itu adalah format yang digunakan untuk mewakili standar ECMA-334 (C#) di dalam monodoc(1). Dia
tidak digunakan untuk menampilkan dokumentasi perpustakaan kelas; untuk dokumentasi perpustakaan kelas, gunakan
itu ekma Format.

kesalahan
The error Dokumentasi dibentuk digunakan untuk menyajikan pesan kesalahan terperinci, dan digunakan dalam
monodocPohon "Referensi Kesalahan Kompilator C#" (1).

Dalam format ini, JALAN adalah file konfigurasi, yang berisi XML:


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


Unsur-unsur itu berarti:

/ErrorProviderConfig/FilesPath
Menentukan tempat untuk mencari file.

/ErrorProviderConfig/Match
Menentukan pola nama file yang akan dicari di dalam
/ErrorProviderConfig/FilesPath direktori.

/ErrorProviderConfig/ErrorNumSubstringStart
Menentukan di mana dalam nama file nomor kesalahan dimulai.

/ErrorProviderConfig/ErrorNumSubstringLength
Menentukan berapa banyak karakter setelah /ErrorProviderConfig/ErrorNumSubstringStart untuk
gunakan untuk nomor kesalahan.

/ErrorProviderConfig/FriendlyFormatString
Menentukan format/tampilan node di monodoc(1) pohon.

Untuk setiap file yang ditemukan, itu dikonversi ke HTML dengan pewarnaan sintaks C# yang diterapkan.

sederhana
The Sederhana Dokumentasi dibentuk format file secara rekursif menambahkan semua file dan direktori
di bawah JALAN. Saat ditampilkan, file HTML ditampilkan apa adanya. File teks adalah
diubah menjadi HTML dengan menerjemahkan setiap baris baru ke dalam HTML elemen. Tidak ada file lain
jenis didukung.

pria
The Pria Halaman Dokumentasi dibentuk menampilkan halaman manual groff. (Ini adalah tidak groff penuh
parser, dan hanya menangani konstruksi halaman manual yang digunakan dalam halaman manual mono.)

JALAN adalah kumpulan file XML yang berisi:






Mungkin ada beberapa //halaman manual elemen di dalam root /halaman manual elemen.

The /manpages/manpage/@nama atribut berisi nama tampilan untuk simpul tampilan pohon,
yang juga merupakan URL halaman manual saat menggunakan monodoc(1) Lookup URL perintah (sebelum
awalan dengan man: awalan). Jadi, jika /manpages/manpage/@nama mengandung mono(1), kemudian
man:mono(1) dapat digunakan di Lookup URL perintah untuk melihat mono(1) halaman manual.

The /manpages/manpage/@halaman atribut adalah nama file yang berisi halaman manual. Jika ini
file tidak ada, maka /manpages/manpage/@nama tidak akan ditampilkan di dalam pohon
melihat.

xhtml
Penyedia XHTML menerjemahkan JALAN sebagai file Bantuan Windows XHTML TOC file dan mencari
dokumen referensi untuk membuat sumber bantuan.

Gunakan mdoc-assemble online menggunakan layanan onworks.net