این دستور mdoc-assemble است که می تواند در ارائه دهنده هاست رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان ما مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
mdoc assemble - کامپایل اسناد برای استفاده در monodoc(1)
خلاصه
mdoc مونتاژ [OPTIONS]+ PATHS+
شرح
mdoc مونتاژ ایجاد .درخت و وبلاگ فایل ها را از راه ها برای استفاده در monodoc(1)
مرورگر اسناد
فایل های ورودی باید دارای پشتیبانی باشند قالب، مشخص شده با --قالب گزینه.
La .درخت و وبلاگ فایل ها در آن کپی می شوند monodoc's منابع دایرکتوری، در کنار الف .منبع
فایلی که توسط monodoc(1) برای تعیین محل نمایش اسناد.
La .منبع فایل دارای فرمت زیر است:
elements -->
La /monodoc/node گره یک گره اختیاری است که مشخص می کند در درخت monodoc کجاست
اسناد باید نمایش داده شود، و //گره عناصر ممکن است در هر عمقی تو در تو باشند
درختان را ایجاد کنید //node/@label برچسبی است که در درخت monodoc نمایش داده می شود.
//node/@name نام گره درخت مونودوک است و ممکن است به عنوان مقدار از استفاده شود
/monodoc/source/@path ارزش.
//node/@parent نام گره برای استفاده به عنوان گره والد است.
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml حاوی لیستی از این نام ها است، و این می تواند
هر گونه باشد //node/@name ارزش. اگر //node/@parent مقدار پیدا نشد، سپس درج می شود
در زیر گره درخت "مختلف".
La /monodoc/source/@provider ویژگی مشخص می کند که کدام ارائه دهنده فرمت باید استفاده شود
هنگام خواندن .درخت و وبلاگ فایل ها؛ این باید مطابق با یکی از --قالب ارزش ها.
La /monodoc/source/@basefile ویژگی پیشوند نام فایل را مشخص می کند
فایل های مستند این باید همان پیشوندی باشد که با the استفاده می شود -- خارج پارامتر.
باید باشد نه پسوند نام فایل روی این مقدار.
La /monodoc/source/@path ویژگی گره والد را مشخص می کند monodocنمای درختی (1)
جایی که اسناد درج خواهد شد. را ببینید
$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml فایل برای لیستی از PATH ارزش ها (
//node/@name مقادیر)، یا ممکن است یک باشد //node/@name ارزش در همان .منبع فایل.
هنگامی که BASEFILE.source نوشته شده است، اسناد را می توان به گونه ای نصب کرد که
monodoc(1) مستندات را با دستور نمایش می دهد:
cp BASEFILE.source BASEFILE.tree BASEFILE.zip \
"pkg-config monodoc --variable=sourcesdir".
OPTIONS
-f, --قالب=FORMAT
فرمت اسناد مورد استفاده در داخل را مشخص می کند راه ها. معتبر FORMAT مقادیر عبارتند از:
اکما, ecmaspec, خطا, hb, مرد, سادهو xhtml.
مشاهده فرمها بخش زیر برای اطلاعات بیشتر در مورد این فرمت ها.
فرمت پیش فرض (اگر هیچ کدام مشخص نشده باشد) است اکما.
La --قالب گزینه ممکن است در هم آمیخته شود راه ها برای تغییر فرمت استفاده شده برای
پارامترهای باقی مانده (تا بعدی --قالب گزینه دیده می شود)، به عنوان مثال:
mdoc assemble -o PREFIX AB --format=man CD --format=xhtml E
دایرکتوری ها را جمع آوری خواهد کرد A و B با اکما فرمت، فایل ها C و D با مرد
فرمت و دایرکتوری E با xhtml فرمت.
-o, -- خارج=پیشوند
پیشوند فایل خروجی را مشخص کنید. mdoc مونتاژ فایل ها را ایجاد می کند PREFIX.zip و
PREFIX.tree.
-h, -?, --کمک
نمایش یک پیام راهنما و خروج.
فرمها
فرمت های اسناد زیر پشتیبانی می شوند:
اکما
La مونو ECMA مستندات قالب، یک فرمت اسناد XML با یک فایل در هر نوع.
مشاهده mdoc(5) صفحه مرد برای اطلاعات بیشتر.
ecmaspec
La مونو ECMA مشخصات مستندات قالب. این قالبی نیست که شما به دنبال آن هستید
برای؛ این قالبی است که برای نشان دادن استاندارد ECMA-334 (C#) در داخل استفاده می شود monodoc(1). آی تی
برای نمایش اسناد کتابخانه کلاس استفاده نمی شود. برای مستندات کتابخانه کلاس، استفاده کنید
la اکما فرمت.
خطا
La خطا مستندات قالب برای ارائه پیام های خطای دقیق استفاده می شود و در استفاده می شود
monodocدرخت "C# Compiler Error Reference" (1).
در این قالب، راه ها یک فایل پیکربندی است که حاوی XML است:
../../mcs/errors
cs؟؟؟؟*.cs
2
4
CS{0:0###}
عناصر به این معنی است:
/ErrorProviderConfig/FilesPath
محل جستجوی فایل ها را مشخص می کند.
/ErrorProviderConfig/Match
الگوی نام فایل را برای جستجو در داخل مشخص می کند
/ErrorProviderConfig/FilesPath دایرکتوری.
/ErrorProviderConfig/ErrorNumSubstringStart
مشخص می کند که شماره خطا از کجا در نام فایل شروع می شود.
/ErrorProviderConfig/ErrorNumSubstringLength
تعداد کاراکترهای بعد را مشخص می کند /ErrorProviderConfig/ErrorNumSubstringStart به
برای شماره خطا استفاده کنید
/ErrorProviderConfig/FriendlyFormatString
فرمت/نمایش گره را مشخص می کند monodoc(1) درخت
برای هر فایل یافت شده، با رنگ آمیزی سی شارپ به HTML تبدیل می شود.
ساده
La ساده مستندات قالب فرمت فایل به صورت بازگشتی همه فایل ها و دایرکتوری ها را اضافه می کند
در زیر راه ها. هنگامی که نمایش داده می شود، فایل های HTML همانطور که هستند نمایش داده می شوند. فایل های متنی هستند
با ترجمه هر خط جدید به HTML به HTML تبدیل می شود عنصر فایل دیگری وجود ندارد
نوع پشتیبانی می شود.
مرد
La مرد صفحه مستندات قالب صفحات groff man را نمایش می دهد. (این هست نه یک غوغا کامل
تجزیه کننده، و فقط ساختارهای صفحه man استفاده شده در صفحات مرد تک را کنترل می کند.)
راه ها مجموعه ای از فایل های XML شامل:
ممکن است متعدد باشد //مانپیج عناصر درون ریشه /manpage عنصر
La /manpages/manpage/@name ویژگی شامل نام نمایش گره نمای درختی است،
که در هنگام استفاده آدرس صفحه man نیز می باشد monodoc(1). گرین کارت آمریکا URL دستور (قبل از
پیشوند با a مرد: پیشوند). بنابراین، اگر /manpages/manpage/@name شامل تک(1)، و سپس
مرد:تک(1) می تواند در استفاده شود گرین کارت آمریکا URL دستور مشاهده تک(1) صفحه مرد
La /manpages/manpage/@page ویژگی نام فایلی است که حاوی صفحه man است. اگر این
پس فایل وجود ندارد /manpages/manpage/@name در درخت نمایش داده نخواهد شد
چشم انداز.
xhtml
ارائه دهنده XHTML تفسیر می کند راه ها به عنوان یک فایل راهنمای ویندوز فایل XHTML TOC و به دنبال
اسناد ارجاع شده برای ایجاد منبع کمک.
از mdoc-assemble آنلاین با استفاده از خدمات onworks.net استفاده کنید
