.\" 
.\" mdassembler manual page.
.\" (C) 2006 Jonathan Pryor
.\" Author:
.\"   Jonathan Pryor (jonpryor@vt.edu)
.\"
.de Sp \" فاصله عمودی (هنگامی که نمی‌توان از .PP استفاده کرد)
.if t .sp .5v
.if n .sp
..
.TH "mdassembler" 1
.SH "نام (NAME)"
mdassembler \- کامپایل مستندات برای استفاده در مرورگر monodoc
.SH "خلاصه دستور (SYNOPSIS)"
.B mdassembler
OPTIONS*
DIRS+
.SH "توضیحات (DESCRIPTION)"
ابزار \fImdassembler\fR منسوخ شده و با \fBmdoc\fR(1) جایگزین گردیده است. صفحه راهنمای
\fBmdoc-assemble\fR(1) را ببینید.
.PP
برنامه
.I mdassembler
فایل‌های
.I .tree
و 
.I .zip
را برای استفاده در مرورگر مستندات
.B monodoc
ایجاد می‌کند.
.PP
فایل‌های 
.I .tree
و
.I .zip
در دایرکتوری 
.I sources
برنامه monodoc کپی می‌شوند و در کنار یک فایل 
.I .source
قرار می‌گیرند که توسط 
.B monodoc
برای مشخص کردن محل نمایش مستندات استفاده می‌شود.
صفت 
.I /monodoc/source/@basefile
در فایل 
.I .source
پیشوند نام فایل را برای فایل‌های مستندات تعیین می‌کند. این مقدار باید همان پیشوندی باشد که با پارامتر 
.B \-\-out
استفاده شده است.
.PP
.SH "گزینه‌ها (OPTIONS)"
.TP
.I \-\-ecma
مستندات موجود در 
.I DIRS
در قالب مستندات Mono ECMA هستند.
بخش 
.B قالب مستندات Mono ECMA
در زیر را ببینید.
.TP
.I \-\-ecmaspec
مستندات موجود در 
.I DIRS
در قالب مستندات مشخصات ECMA هستند.
بخش 
.B قالب مستندات مشخصات Mono ECMA
در زیر را ببینید.
.TP
.I \-\-error
مستندات موجود در
.I DIRS
در قالب «خطا» (error) هستند.
بخش 
.B قالب مستندات خطا
در زیر را ببینید.
.TP
.I \-\-help
نمایش اطلاعات مربوط به آرگومان‌های برنامه.
.TP
.I \-\-man
مستندات موجود در
.I DIRS
در قالب صفحات راهنما (man page) هستند.
بخش 
.B قالب مستندات صفحات راهنما
در زیر را ببینید.
.TP
.I \-o, \-\-out PREFIX
تعیین پیشوند فایل خروجی.
.B mdassembler
فایل‌های
.I PREFIX.zip
و 
.I PREFIX.tree
را ایجاد می‌کند.
.TP
.I \-\-simple
مستندات موجود در
.I DIRS
در قالب «ساده» (simple) هستند.
بخش 
.B قالب مستندات ساده
در زیر را ببینید.
.TP
.I \-\-xhtml, \-\-hb
مستندات موجود در
.I DIRS
در قالب XHTML هستند.
بخش 
.B قالب مستندات XHTML
در زیر را ببینید.
.PP
.SH "قالب‌ها (FORMATS)"
قالب‌های مستندات زیر پشتیبانی می‌شوند:
.SS قالب مستندات Mono ECMA
یک قالب مستندات XML با یک فایل به ازای هر نوع (type).
.PP
برای اطلاعات بیشتر به صفحه راهنمای \fBmdoc\fR(5) مراجعه کنید.
.SS قالب مستندات مشخصات Mono ECMA
این قالبی نیست که به دنبال آن هستید.
.PP
این قالب برای نمایش استاندارد ECMA-334 (C#) در 
\fBmonodoc\fR استفاده می‌شود. از آن برای نمایش مستندات کتابخانه کلاس‌ها استفاده نمی‌شود؛ 
برای مستندات کتابخانه کلاس‌ها، از قالب
.B \-\-ecma
استفاده کنید.
.SS قالب مستندات خطا
برای ارائه پیام‌های خطای دقیق استفاده می‌شود و در شاخه «C# Compiler Error Reference» در 
\fBmonodoc\fR به کار می‌رود.  
.I DIRS
در اینجا یک دایرکتوری نیست، بلکه یک فایل پیکربندی شامل XML زیر است:

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

مقدار
.I /ErrorProviderConfig/FilesPath
محل جستجوی فایل‌ها را تعیین می‌کند،
.I /ErrorProviderConfig/Match
الگوی نام فایل برای جستجو در 
\fI/ErrorProviderConfig/FilesPath\fR را مشخص می‌کند،
.I /ErrorProviderConfig/ErrorNumSubstringStart
و
.I /ErrorProviderConfig/ErrorNumSubstringLength
کنترل می‌کنند کدام بخش از نام فایل به عنوان شماره خطا استفاده شود، و
.I /ErrorProviderConfig/FriendlyFormatString
نحوه قالب‌بندی و نمایش گره را در درخت 
.B monodoc
کنترل می‌کند.
.PP
به ازای هر فایل یافت‌شده، آن فایل همراه با رنگ‌آمیزی قواعد نگارشی (syntax coloring) زبان C# به HTML تبدیل می‌شود.
.SS قالب مستندات ساده
فایل‌های متنی را با تبدیل هر خط جدید به یک عنصر 
.I <br>
در HTML، به HTML تبدیل می‌کند.
.SS قالب مستندات صفحات راهنما
صفحات راهنما را برای نمایش به HTML تبدیل می‌کند.
.SS قالب مستندات XHTML
فایل XHTML را بدون تغییر کپی می‌کند.
.SH "مثال‌ها (EXAMPLES)"
برای نصب مستندات خود جهت استفاده در monodoc:
.TP
.I ایجاد یک فایل PREFIX.source
با محتوای زیر:
.nf

<?xml version="1.0"?>
<monodoc>
  <source provider="FORMAT" basefile="PREFIX" path="PATH"/>
</monodoc>

.fi
که در آن FORMAT قالب مستندات موجود در فایل 
.I PREFIX.tree
است، مانند 
\fIecma\fR یا \fIsimple\fR.
مقدار
.I PREFIX
نام پایه (basename) فایل‌های 
.I .tree
و
.I .zip
است که 
.B mdassembler
ایجاد می‌کند.
مقدار
.I PATH
همان «مسیر» در درخت monodoc است که باید شامل مستندات باشد.
فایل 
.I @prefix@/lib/monodoc/monodoc.xml
را برای فهرستی از مقادیر PATH ببینید
(مقادیر
.I //node/@name
).
.sp
همچنین ببینید: http://www.mono-project.com/docs/tools+libraries/tools/monodoc/generating-documentation
.TP
.I ایجاد مستندات خود
همچنین صفحه راهنمای
.BR monodocer (1)
را ببینید، برای مثال:
.nf

	monodocer -assembly:foo.dll -path:foo/en

.fi
.TP
.I سرهم‌بندی مستندات
.nf

	mdassembler --ecma foo/en PREFIX

.fi
اطمینان حاصل کنید که در اینجا از همان 
.I PREFIX
استفاده می‌کنید که در بالا استفاده کردید.
.TP
.I نصب مستندات با استفاده از دستور
.nf

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

.fi
(به بک‌تیک‌های استفاده‌شده در دستور 
.B pkg-config
توجه کنید!)
این کار فایل‌های 
.I .source
،
.I .tree
و 
.I .zip
را به دایرکتوری 
.I sources
برنامه 
.B monodoc
کپی می‌کند که به 
.B monodoc
امکان می‌دهد مستندات را نمایش دهد.
.SH "همچنین ببینید (SEE ALSO)"
\fBmdcs2ecma\fR(1), 
\fBmdnormalizer\fR(1), 
\fBmdoc\fR(1), 
\fBmdoc-assemble\fR(1), 
\fBmdvalidator\fR(1), 
\fBmonodocer\fR(1), 
\fBmonodocs2html\fR(1)
.SH "فهرست‌های پستی (MAILING LISTS)"
.TP
برای جزئیات بیشتر به http://lists.ximian.com/mailman/listinfo/mono-docs-list مراجعه کنید.
.SH "وب‌گاه (WEB SITE)"
همچنین ببینید: http://www.mono-project.com
و
http://www.mono-project.com/docs/tools+libraries/tools/mdassembler