نام (NAME)

monodocs2html - ترجمه مستندات XML برنامه Monodoc به HTML

خلاصه دستور (SYNOPSIS)

monodocs2html -source:SOURCE_DIR -dest:DEST_DIR [OPTIONS]*

توضیحات (DESCRIPTION)

دستور monodocs2html منسوخ شده و با mdoc(1) جایگزین گردیده است. به صفحه راهنمای mdoc-export-html(1) مراجعه کنید.

برنامه monodocs2html ابزاری است که مستندات HTML را از فایل‌های XML مستندات Monodoc ایجاد می‌کند.

گزینه‌ها (OPTIONS)

-dest:DEST_DIR: نوشتن فایل‌های HTML در دایرکتوری DEST_DIR .
-dumptemplate: تخلیه قالب پیش‌فرض صفحه در خروجی استاندارد به طوری که بتوانید از آن به عنوان پایه‌ای برای یک قالب جدید جهت استفاده با گزینه -template بهره ببرید.
-ext:FILE_EXTENSION: FILE_EXTENSION پسوند فایل برای فایل‌های تولیدشده است.
مقدار پیش‌فرض html است.
-?, -help: نمایش اطلاعات آرگومان‌های برنامه.
-onlytype:TYPE: تولید HTML تنها برای نوع TYPE .
-source:SOURCE_DIR: SOURCE_DIR دایرکتوری پایه‌ای است که حاوی مستندات XML برنامه Monodoc می‌باشد.
این دایرکتوری باید شامل یک فایل index.xml ، فایل‌های namespace-name.xml (یکی برای هر فضای نام)، و دایرکتوری‌های namespace-name (یکی برای هر فضای نام) باشد که این دایرکتوری‌ها فایل‌های type.xml حاوی مستندات monodoc را در خود جای داده‌اند.
-template:TEMPLATE: تولید HTML با استفاده از قالب صفحه TEMPLATE .
-V, -version: نمایش اطلاعات نسخه و مجوز.

قالب الگو (TEMPLATE FORMAT)

فایل الگو یک فایل XSLT است که باید سند XML ورودی زیر را پردازش کند:

<Page>
  <CollectionTitle>Collection Title</CollectionTitle>
  <PageTitle>Page Title</PageTitle>
  <Summary>Page Summary</Summary>
  <Signature>Type Declaration</Signature>
  <Remarks>Type Remarks</Remarks>
  <Members>Type Members</Members>
  <Copyright>Documentation Copyright</Copyright>
</Page>

کد HTML تولیدشده همچنین از کلاس‌های CSS زیر استفاده می‌کند که باید به منظور قالب‌بندی مناسب خروجی تعریف شوند:

.CollectionTitle
.PageTitle
.Summary
.Signature
.Remarks
.Members
.Copyright
.Section
.SectionBox
.NamespaceName
.NamespaceSummary
.MemberName
.MemberSignature
.MemberBox
.Subsection
.SubsectionBox
.SignatureTable
.EnumerationsTable
.CodeExampleTable
.MembersListing
.TypesListing
.InnerSignatureTable
.TypePermissionsTable

پیوندهای HTML (HTML LINKS)

تمامی اعضا در فایل HTML دارای یک صفت id هستند تا امکان پیوند دادن به یک عضو خاص فراهم شود. مقدار صفت id همان شناسه رشته‌ای (String ID) عضو مشخص‌شده است. برای اطلاعات بیشتر بخش STRING ID FORMAT در صفحه راهنمای monodocer را مشاهده کنید.

فهرست‌های پستی (MAILING LISTS)

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

وب‌گاه (WEB SITE)

برای جزئیات بیشتر به http://www.mono-project.com مراجعه کنید