.\"
.\" mdoc-export-html manual page.
.\" (C) 2008 Novell, Inc.
.\" Author:
.\" Jonathan Pryor (jpryor@novell.com)
.\"
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.TH "mdoc-export-html" 1
.SH "نام (NAME)"
mdoc export-html \- تبدیل مستندات XML در قالب \fBmdoc\fR(5) به HTML
.SH "خلاصه دستور (SYNOPSIS)"
\fBmdoc export-html\fR [OPTION]* DIRECTORIES
.SH "توضیحات (DESCRIPTION)"
دستور \fBmdoc export-html\fR از فایلهای XML مستندات با قالببندی \fBmdoc\fR(5) درون دایرکتوریهای \fIDIRECTORIES\fR، فایلهای HTML ایجاد میکند.
.SH "گزینهها (OPTIONS)"
.TP
.B \-\-default\-template
نوشتن XSLT پیشفرض مورد استفاده در \fIstdout\fR.
.TP
\fB\-\-ext\fR=\fIEXTENSION\fR
پسوند فایل مورد استفاده برای فایلهای ایجادشده.
.Sp
مقدار پیشفرض \fIhtml\fR است.
.TP
\fB\-\-force-update\fR
تولید همیشگی فایلهای جدید. در صورت عدم تعیین،
تنها در صورتی فایل خروجی جدید تولید میشود که فایل مستندات
مبدأ جدیدتر از فایل خروجی مقصد باشد.
.TP
\fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR
نوشتن فایلهای ایجادشده در دایرکتوری \fIDIRECTORY\fR.
.TP
\fB\-\-template\fR=\fIFILE\fR
یک فایل XSLT برای استفاده در تولید فایلهای ایجادشده.
.Sp
در صورت عدم تعیین، از الگوی تولیدشده توسط \fI\-\-dump\-template\fR استفاده میکند.
.Sp
برای اطلاعات بیشتر، بخش \fITEMPLATE FORMAT\fR در زیر را ببینید.
.TP
\fB\-\-with\-profile\fR=\fIPROFILE\fR
تنها پردازش انواع و اعضای درون پروفایل داتنت \fIPROFILE\fR.
میتواند چندین بار مشخص شود. در صورت عدم تعیین، تمام انواع و اعضا،
صرفنظر از نسخه، پردازش میشوند.
.Sp
پروفایلهای معتبر عبارتند از:
.nf
monotouch
net_1_0
net_1_1
net_2_0
net_3_0
net_3_5
net_4_0
silverlight
.fi
.TP
\fB\-\-with\-version\fR=\fIVERSION\fR
تنها پردازش انواع و اعضای درون نسخه اسمبلی \fIVERSION\fR.
میتواند چندین بار مشخص شود. در صورت عدم تعیین، تمام انواع و اعضا،
صرفنظر از نسخه، پردازش میشوند.
.Sp
مقدار \fIVERSION\fR یک نسخه اسمبلی است، مانند 2.0.5.0.
.TP
\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
نمایش پیام راهنما و خروج.
.SH "قالب الگو (TEMPLATE FORMAT)"
فایل الگو یک XSLT است که باید سند XML ورودی زیر را پردازش کند:
.nf
Collection Title
Page Title
Page Summary
Type Declaration
Type Remarks
Type Members
Documentation Copyright
.fi
HTML تولیدشده همچنین از چندین کلاس CSS استفاده میکند. شما میتوانید از الگوی نامگذاریشده \fIcreate-default-style\fR موجود در خروجی \fI\-\-default\-template\fR برای تولید این کلاسها استفاده کنید، یا اینکه کلاسهای CSS زیر را به طور صریح تعریف کنید:
.RS
.ne 8
.TP
.I .CollectionTitle
.TP
.I .PageTitle
.TP
.I .Summary
.TP
.I .Signature
.TP
.I .Remarks
.TP
.I .Members
.TP
.I .Copyright
.TP
.I .Section
.TP
.I .SectionBox
.TP
.I .NamespaceName
.TP
.I .NamespaceSummary
.TP
.I .MemberName
.TP
.I .MemberSignature
.TP
.I .MemberBox
.TP
.I .Subsection
.TP
.I .SubsectionBox
.TP
.I .SignatureTable
.TP
.I .EnumerationsTable
.TP
.I .CodeExampleTable
.TP
.I .MembersListing
.TP
.I .TypesListing
.TP
.I .InnerSignatureTable
.TP
.I .TypePermissionsTable
.ne
.RE
.PP
.SH "پیوندهای HTML (HTML LINKS)"
تمام اعضای درون فایل HTML دارای یک صفت \fIid\fR هستند
تا پیوند دادن به یک عضو خاص امکانپذیر باشد. مقدار صفت
\fIid\fR همان شناسه رشتهای عضو مشخصشده است.
.PP
برای اطلاعات بیشتر، بخش \fICREF FORMAT\fR در \fBmdoc\fR(5) را ببینید.
.SH "فهرستهای پستی (MAILING LISTS)"
.TP
برای جزئیات بیشتر به http://lists.ximian.com/mailman/listinfo/mono-docs-list مراجعه کنید.
.SH "وبگاه (WEB SITE)"
برای جزئیات بیشتر به http://www.mono-project.com/docs/tools+libraries/tools/mdoc مراجعه کنید.