نام (NAME)

slice2html - ابزار تولید مستندات HTML از Slice

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

slice2html [گزینه‌ها] [فایل‌ها]

توضیحات (DESCRIPTION)

دستور slice2html از فایل‌های Slice مستندات HTML تولید می‌کند. ماکروی __SLICE2HTML__ در طول این کامپایل تعریف می‌شود.

مستندات کامل slice2html به صورت برخط در نشانی زیر در دسترس است:
https://doc.zeroc.com/ice/3.7/the-slice-language/generating-slice-documentation

ابزار slice2html منسوخ شده است؛ در حال حاضر Doxygen روش پیشنهادی برای تولید مرجع API زبان Slice است، ببینید:
https://doc.zeroc.com/api/ice/3.7/slice

گزینه‌ها (OPTIONS)

-h, --help: پیام راهنما را نمایش می‌دهد.
-v, --version: نسخه کامپایلر را نمایش می‌دهد.
-DNAME: نماد پیش‌پردازنده NAME را تعریف می‌کند.
-DNAME=DEF: نماد پیش‌پردازنده NAME را با مقدار DEF تعریف می‌کند.
-UNAME: تعریف نماد پیش‌پردازنده NAME را لغو می‌کند.
-IDIR: دایرکتوری DIR را به مسیر جستجو برای دستورات #include اضافه می‌کند.
-E: خروجی پیش‌پردازنده را در stdout چاپ می‌کند.
--output-dir DIR: فایل‌های تولیدشده را در دایرکتوری DIR قرار می‌دهد.
-d, --debug: اطلاعات اشکال‌زدایی را که نحوه عملکرد تجزیه‌کننده (parser) زبان Slice را نشان می‌دهد، چاپ می‌کند.
--hdr FILE: محتوای FILE را به ابتدای هر فایل HTML تولیدشده (به‌جز _sindex.html) اضافه می‌کند. این گزینه به شما امکان می‌دهد سرآیند HTML و سایر اطلاعات ابتدایی را با یک نسخه سفارشی جایگزین کنید تا بتوانید شیوه‌نامه‌ها (style sheets) را به صفحات تولیدشده متصل نمایید. فایل مشخص‌شده باید شامل تگ <body> باشد (اما نیازی نیست با تگ <body> پایان یابد). انتظار می‌رود FILE حاوی رشته TITLE در یک خط مجزا باشد که از ستون اول شروع می‌شود. دستور slice2html رشته TITLE را با نام دارای دامنه کامل (fully-scoped) مربوط به نماد Slice که در صفحه مربوطه مستندسازی شده است، جایگزین می‌کند.
--ftr FILE: محتوای FILE را به انتهای هر فایل HTML تولیدشده (به‌جز _sindex.html) پیوست می‌کند. این گزینه به شما امکان می‌دهد برای نمونه یک پانویس سفارشی به هر صفحه تولیدشده اضافه کنید. فایل FILE باید به تگ </body> ختم شود.
--indexhdr FILE: دستور slice2html فایلی به نام _sindex.html تولید می‌کند که شامل فهرست مطالبی از تمام نمادهای Slice با پیوند به صفحات مربوطه است. این گزینه به شما امکان می‌دهد سرآیند استاندارد را با یک سرآیند سفارشی جایگزین کنید؛ برای مثال برای الصاق یک کد JavaScript. فایل مشخص‌شده باید شامل تگ <body> باشد (اما نیازی نیست با تگ <body> پایان یابد). مقدار پیش‌فرض آن همان مقدار تعیین‌شده در --hdr (در صورت وجود) است.
--indexftr FILE: محتوای FILE را به انتهای صفحه تولیدشده sindex.html پیوست می‌کند. این گزینه به شما امکان می‌دهد برای نمونه یک پانویس سفارشی به فهرست مطالب اضافه کنید یا یک کد JavaScript را فراخوانی نمایید. فایل FILE باید به تگ </body> ختم شود. مقدار پیش‌فرض آن همان مقدار تعیین‌شده در --ftr (در صورت وجود) است.
--image-dir DIR: با این گزینه، slice2html در دایرکتوری مشخص‌شده به دنبال تصاویری می‌گردد که برای ابرپیوندهای ناوبری تولیدشده استفاده شوند. (بدون این گزینه، به جای آن پیوندهای متنی استفاده می‌شوند.) لطفاً برای مشاهده نام فایل‌های تصویری مختلف به کدهای HTML تولیدشده مراجعه کنید. (این نام‌ها با جستجوی عناصر img به‌سادگی قابل یافتن هستند.)
--logo-url URL: از URL مشخص‌شده به عنوان یک ابرپیوند برای نشان‌واره (لوگو) شرکتی که به هر صفحه اضافه می‌شود (در صورت تعیین --image-dir) استفاده می‌کند. انتظار می‌رود لوگوی شرکت در مسیر <image_dir>/logo.gif قرار داشته باشد.
--search ACTION: اگر این گزینه مشخص شود، صفحات تولیدشده دارای یک جعبه جستجو خواهند بود که به شما امکان می‌دهد صفحات تولیدشده را به یک موتور جستجو متصل کنید. با فشردن دکمه "Search"، اقدام (ACTION) مشخص‌شده اجرا می‌شود.
--index NUM: دستور slice2html زیرشاخه‌هایی برای نمادهای مختلف Slice تولید می‌کند. این گزینه کنترل می‌کند که قبل از تولید یک زیرشاخه، چه تعداد مدخل باید وجود داشته باشد. برای مثال اگر NUM روی ۳ تنظیم شود، یک زیرشاخه تنها در صورتی تولید می‌شود که سه نماد یا بیشتر در آن شاخص ظاهر شوند. مقدار پیش‌فرض ۱ است، به این معنی که زیرشاخه همیشه تولید می‌شود. برای غیرفعال کردن کامل زیرشاخه‌ها، NUM را روی ۰ تنظیم کنید.
--summary NUM: اگر این گزینه تنظیم شود، جملات خلاصه‌ای که طول آن‌ها از NUM نویسه فراتر رود، یک هشدار تولید می‌کنند.

همچنین ببینید (SEE ALSO)

slice2cpp(1), slice2cs(1), slice2java(1), slice2js(1), slice2matlab(1), slice2objc(1), slice2php(1), slice2py(1), slice2rb(1)