نام (NAME)

mdoc export-html - تبدیل مستندات XML در قالب mdoc(5) به HTML

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

mdoc export-html [OPTION]* DIRECTORIES

توضیحات (DESCRIPTION)

دستور mdoc export-html از فایل‌های XML مستندات با قالب‌بندی mdoc(5) درون دایرکتوری‌های DIRECTORIES، فایل‌های HTML ایجاد می‌کند.

گزینه‌ها (OPTIONS)

--default-template

نوشتن XSLT پیش‌فرض مورد استفاده در stdout.

--ext=EXTENSION

پسوند فایل مورد استفاده برای فایل‌های ایجادشده.

مقدار پیش‌فرض html است.

--force-update

تولید همیشگی فایل‌های جدید. در صورت عدم تعیین، تنها در صورتی فایل خروجی جدید تولید می‌شود که فایل مستندات مبدأ جدیدتر از فایل خروجی مقصد باشد.

-o, --out=DIRECTORY

نوشتن فایل‌های ایجادشده در دایرکتوری DIRECTORY.

--template=FILE

یک فایل XSLT برای استفاده در تولید فایل‌های ایجادشده.

در صورت عدم تعیین، از الگوی تولیدشده توسط --dump-template استفاده می‌کند.

برای اطلاعات بیشتر، بخش TEMPLATE FORMAT در زیر را ببینید.

--with-profile=PROFILE

تنها پردازش انواع و اعضای درون پروفایل دات‌نت PROFILE. می‌تواند چندین بار مشخص شود. در صورت عدم تعیین، تمام انواع و اعضا، صرف‌نظر از نسخه، پردازش می‌شوند.

پروفایل‌های معتبر عبارتند از:

monotouch
net_1_0
net_1_1
net_2_0
net_3_0
net_3_5
net_4_0
silverlight

--with-version=VERSION

تنها پردازش انواع و اعضای درون نسخه اسمبلی VERSION. می‌تواند چندین بار مشخص شود. در صورت عدم تعیین، تمام انواع و اعضا، صرف‌نظر از نسخه، پردازش می‌شوند.

مقدار VERSION یک نسخه اسمبلی است، مانند 2.0.5.0.

-h, -?, --help

نمایش پیام راهنما و خروج.

قالب الگو (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 استفاده می‌کند. شما می‌توانید از الگوی نام‌گذاری‌شده create-default-style موجود در خروجی --default-template برای تولید این کلاس‌ها استفاده کنید، یا اینکه کلاس‌های CSS زیر را به طور صریح تعریف کنید:

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

تمام اعضای درون فایل HTML دارای یک صفت id هستند تا پیوند دادن به یک عضو خاص امکان‌پذیر باشد. مقدار صفت id همان شناسه رشته‌ای عضو مشخص‌شده است.

برای اطلاعات بیشتر، بخش CREF FORMAT در mdoc(5) را ببینید.

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

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

وب‌گاه (WEB SITE)

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