mdassembler(1) General Commands Manual mdassembler(1)

mdassembler - کامپایل مستندات برای استفاده در مرورگر monodoc

mdassembler OPTIONS* DIRS+

ابزار mdassembler منسوخ شده و با mdoc(1) جایگزین گردیده است. صفحه راهنمای mdoc-assemble(1) را ببینید.

برنامه mdassembler فایل‌های .tree و .zip را برای استفاده در مرورگر مستندات monodoc ایجاد می‌کند.

فایل‌های .tree و .zip در دایرکتوری sources برنامه monodoc کپی می‌شوند و در کنار یک فایل .source قرار می‌گیرند که توسط monodoc برای مشخص کردن محل نمایش مستندات استفاده می‌شود. صفت /monodoc/source/@basefile در فایل .source پیشوند نام فایل را برای فایل‌های مستندات تعیین می‌کند. این مقدار باید همان پیشوندی باشد که با پارامتر --out استفاده شده است.

مستندات موجود در DIRS در قالب مستندات Mono ECMA هستند. بخش قالب مستندات Mono ECMA در زیر را ببینید.
مستندات موجود در DIRS در قالب مستندات مشخصات ECMA هستند. بخش قالب مستندات مشخصات Mono ECMA در زیر را ببینید.
مستندات موجود در DIRS در قالب «خطا» (error) هستند. بخش قالب مستندات خطا در زیر را ببینید.
نمایش اطلاعات مربوط به آرگومان‌های برنامه.
مستندات موجود در DIRS در قالب صفحات راهنما (man page) هستند. بخش قالب مستندات صفحات راهنما در زیر را ببینید.
تعیین پیشوند فایل خروجی. mdassembler فایل‌های PREFIX.zip و PREFIX.tree را ایجاد می‌کند.
مستندات موجود در DIRS در قالب «ساده» (simple) هستند. بخش قالب مستندات ساده در زیر را ببینید.
مستندات موجود در DIRS در قالب XHTML هستند. بخش قالب مستندات XHTML در زیر را ببینید.

قالب‌های مستندات زیر پشتیبانی می‌شوند:

یک قالب مستندات XML با یک فایل به ازای هر نوع (type).

برای اطلاعات بیشتر به صفحه راهنمای mdoc(5) مراجعه کنید.

این قالبی نیست که به دنبال آن هستید.

این قالب برای نمایش استاندارد ECMA-334 (C#) در monodoc استفاده می‌شود. از آن برای نمایش مستندات کتابخانه کلاس‌ها استفاده نمی‌شود؛ برای مستندات کتابخانه کلاس‌ها، از قالب --ecma استفاده کنید.

برای ارائه پیام‌های خطای دقیق استفاده می‌شود و در شاخه «C# Compiler Error Reference» در monodoc به کار می‌رود. DIRS در اینجا یک دایرکتوری نیست، بلکه یک فایل پیکربندی شامل XML زیر است:

<ErrorProviderConfig>
    <FilesPath>../../mcs/errors</FilesPath>
    <Match>cs????*.cs</Match>
    <ErrorNumSubstringStart>2</ErrorNumSubstringStart>
    <ErrorNumSubstringLength>4</ErrorNumSubstringLength>
    <FriendlyFormatString>CS{0:0###}</FriendlyFormatString>
</ErrorProviderConfig>

مقدار /ErrorProviderConfig/FilesPath محل جستجوی فایل‌ها را تعیین می‌کند، /ErrorProviderConfig/Match الگوی نام فایل برای جستجو در /ErrorProviderConfig/FilesPath را مشخص می‌کند، /ErrorProviderConfig/ErrorNumSubstringStart و /ErrorProviderConfig/ErrorNumSubstringLength کنترل می‌کنند کدام بخش از نام فایل به عنوان شماره خطا استفاده شود، و /ErrorProviderConfig/FriendlyFormatString نحوه قالب‌بندی و نمایش گره را در درخت monodoc کنترل می‌کند.

به ازای هر فایل یافت‌شده، آن فایل همراه با رنگ‌آمیزی قواعد نگارشی (syntax coloring) زبان C# به HTML تبدیل می‌شود.

فایل‌های متنی را با تبدیل هر خط جدید به یک عنصر <br> در HTML، به HTML تبدیل می‌کند.

صفحات راهنما را برای نمایش به HTML تبدیل می‌کند.

فایل XHTML را بدون تغییر کپی می‌کند.

برای نصب مستندات خود جهت استفاده در monodoc:

ایجاد یک فایل PREFIX.source
با محتوای زیر: 
<?xml version="1.0"?>
<monodoc>
  <source provider="FORMAT" basefile="PREFIX" path="PATH"/>
</monodoc>
که در آن FORMAT قالب مستندات موجود در فایل PREFIX.tree است، مانند ecma یا simple. مقدار PREFIX نام پایه (basename) فایل‌های .tree و .zip است که mdassembler ایجاد می‌کند. مقدار PATH همان «مسیر» در درخت monodoc است که باید شامل مستندات باشد. فایل @prefix@/lib/monodoc/monodoc.xml را برای فهرستی از مقادیر PATH ببینید (مقادیر //node/@name ).

همچنین ببینید: http://www.mono-project.com/docs/tools+libraries/tools/monodoc/generating-documentation

ایجاد مستندات خود
همچنین صفحه راهنمای monodocer(1) را ببینید، برای مثال: 
monodocer -assembly:foo.dll -path:foo/en
سرهم‌بندی مستندات
mdassembler --ecma foo/en PREFIX
اطمینان حاصل کنید که در اینجا از همان PREFIX استفاده می‌کنید که در بالا استفاده کردید.
نصب مستندات با استفاده از دستور
cp PREFIX.source PREFIX.tree PREFIX.zip \
`pkg-config monodoc --variable=sourcesdir`
(به بک‌تیک‌های استفاده‌شده در دستور pkg-config توجه کنید!) این کار فایل‌های .source ، .tree و .zip را به دایرکتوری sources برنامه monodoc کپی می‌کند که به monodoc امکان می‌دهد مستندات را نمایش دهد.

mdcs2ecma(1), mdnormalizer(1), mdoc(1), mdoc-assemble(1), mdvalidator(1), monodocer(1), monodocs2html(1)

برای جزئیات بیشتر به http://lists.ximian.com/mailman/listinfo/mono-docs-list مراجعه کنید.

همچنین ببینید: http://www.mono-project.com و http://www.mono-project.com/docs/tools+libraries/tools/mdassembler