ASCIIDOC(1)   ASCIIDOC(1)

asciidoc - تبدیل فایل متنی AsciiDoc به HTML یا DocBook

asciidoc [OPTIONS] FILE

دستور asciidoc(1) فایل متنی AsciiDoc با نام FILE را به DocBook یا HTML تبدیل می‌کند. اگر FILE برابر با - باشد، از ورودی استاندارد استفاده می‌شود.

-a, --attribute=ATTRIBUTE

تعریف یا حذف صفت (attribute) سند. ATTRIBUTE به صورت NAME=VALUE قالب‌بندی می‌شود. صفت‌های خط فرمان بر صفت‌های سند و فایل‌های پیکربندی اولویت دارند. سایر فرم‌های قابل قبول عبارتند از: NAME (مقدار VALUE به‌طور پیش‌فرض یک رشته خالی خواهد بود)؛ NAME! (حذف صفت NAME)؛ NAME=VALUE@ (صفت‌های سند یا فایل پیکربندی بازنویسی نشوند). مقادیر حاوی فاصله باید درون علامت‌های نقل‌قول دوتایی (گیومه) قرار گیرند. این گزینه می‌تواند بیش از یک بار مشخص شود. یک صفت ویژه به نام trace خروجی اطلاعات عیب‌یابی را کنترل می‌کند.

-b, --backend=BACKEND

قالب فایل خروجی بک‌اند: docbook45، docbook5، xhtml11، html4، html5، slidy، wordpress یا latex (بک‌اند latex آزمایشی است). همچنین می‌توانید از نام‌های مستعار بک‌اند مانند html (نام مستعار برای xhtml11) یا docbook (نام مستعار برای docbook45) استفاده کنید. مقدار پیش‌فرض html است. گزینه --backend همچنین برای مدیریت افزونه‌های بک‌اند استفاده می‌شود (بخش دستورات افزونه (PLUGIN COMMANDS) را ببینید).

-f, --conf-file=CONF_FILE

استفاده از فایل پیکربندی CONF_FILE. فایل‌های پیکربندی به ترتیب مشخص‌شده در خط فرمان (پس از فایل‌های پیکربندی ضمنی) پردازش می‌شوند. این گزینه می‌تواند بیش از یک بار مشخص شود.

--doctest

اجرای doctestهای پایتون در ماژول asciidoc.

-d, --doctype=DOCTYPE

نوع سند: article، manpage یا book. نوع سند book فقط توسط بک‌اندهای docbook پشتیبانی می‌شود. نوع سند پیش‌فرض article است.

-c, --dump-conf

تخلیه و چاپ پیکربندی در خروجی استاندارد (stdout).

--filter=FILTER

مشخص کردن نام فیلتری که باید بارگذاری شود (برای بارگذاری فیلترهایی که به‌طور خودکار بارگذاری نمی‌شوند استفاده می‌شود). این گزینه می‌تواند بیش از یک بار مشخص شود. گزینه --filter همچنین برای مدیریت افزونه‌های فیلتر استفاده می‌شود (بخش دستورات افزونه (PLUGIN COMMANDS) را ببینید).

-h, --help [TOPIC]

چاپ راهنمای TOPIC (موضوع). دستور --help topics فهرستی از موضوعات راهنما را چاپ می‌کند، --help syntax خلاصه‌ای از نحو ساختار AsciiDoc را ارائه می‌دهد، و --help manpage صفحه راهنمای AsciiDoc را چاپ می‌کند.

-e, --no-conf

مستثنی کردن فایل‌های پیکربندی که به صورت ضمنی بارگذاری می‌شوند، به جز آن‌هایی که هم‌نام فایل ورودی هستند (infile.conf و infile-backend.conf).

-s, --no-header-footer

جلوگیری از چاپ سربرگ و پاورقی سند در خروجی.

-o, --out-file=OUT_FILE

نوشتن خروجی در فایل OUT_FILE. مقدار پیش‌فرض، نام پایه فایل ورودی همراه با پسوند backend است. اگر ورودی از stdin باشد، فایل خروجی به‌طور پیش‌فرض stdout خواهد بود. اگر OUT_FILE برابر با - باشد، از خروجی استاندارد استفاده می‌شود.

-n, --section-numbers

شماره‌گذاری خودکار عناوین بخش‌های مقاله HTML. مترادف با --attribute numbered.

--safe

فعال‌سازی حالت امن (safe mode). حالت امن به‌طور پیش‌فرض غیرفعال است. safe mode در AsciiDoc از پردازش بخش‌های اسکریپتی بالقوه خطرناک در فایل‌های منبع AsciiDoc صرف‌نظر می‌کند.

--theme=THEME

مشخص کردن نام پوسته (theme). مترادف با --attribute theme=THEME. گزینه --theme همچنین برای مدیریت افزونه‌های پوسته استفاده می‌شود (بخش دستورات افزونه (PLUGIN COMMANDS) را ببینید).

-v, --verbose

چاپ اطلاعات پردازش و بررسی فایل‌های پیکربندی با جزئیات کامل در stderr.

--version

چاپ شماره نسخه برنامه.

گزینه‌های --filter، --backend و --theme در asciidoc(1) برای نصب، حذف و فهرست کردن افزونه‌های فیلتر، بک‌اند و پوسته AsciiDoc استفاده می‌شوند. نحو دستورات:

asciidoc OPTION install ZIP_FILE [PLUGINS_DIR]
asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR]
asciidoc OPTION list
asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE

که در آن:

OPTION

گزینه --filter، --backend یا --theme در asciidoc(1) که نوع افزونه را مشخص می‌کند.

PLUGIN_NAME

یک نام افزونه یکتا که فقط شامل کاراکترهای الفبایی-عددی یا خط زیر (underscore) است.

ZIP_FILE

یک فایل فشرده Zip حاوی منابع افزونه؛ نام آن باید با نام افزونه شروع شود، به عنوان مثال my_filter-1.0.zip فیلتر my_filter را بسته‌بندی می‌کند.

PLUGINS_DIR

پوشه‌ای که شامل افزونه‌های نصب‌شده است. هر افزونه در زیرپوشه اختصاصی خود که نامی هم‌نام با افزونه دارد قرار می‌گیرد. مقدار پیش‌فرض PLUGINS_DIR برابر است با $HOME/.asciidoc/filters (برای افزونه‌های فیلتر) یا $HOME/.asciidoc/backends (برای افزونه‌های بک‌اند) یا $HOME/.asciidoc/themes (برای افزونه‌های پوسته).

PLUGIN_SOURCE

نام پوشه حاوی فایل‌های منبع افزونه یا نام یک فایل منبع تکی.

دستورات افزونه به شرح زیر عمل می‌کنند:

install

ایجاد یک زیرپوشه در PLUGINS_DIR با نامی مشابه با افزونه و سپس استخراج محتویات ZIP_FILE درون آن.

remove

حذف زیرپوشه افزونه PLUGIN_NAME و تمامی محتویات آن از PLUGINS_DIR.

list

فهرست کردن نام‌ها و مکان‌های تمام افزونه‌های فیلتر یا پوسته نصب‌شده (شامل افزونه‌های استانداردی که در پوشه پیکربندی سراسری نصب شده‌اند).

build

ایجاد یک فایل افزونه به نام ZIP_FILE حاوی فایل‌ها و زیرپوشه‌های مشخص‌شده توسط PLUGIN_SOURCE. نام فایل‌ها و پوشه‌هایی که با نقطه شروع می‌شوند نادیده گرفته می‌شوند.

SOURCE_DATE_EPOCH

اگر متغیر محیطی SOURCE_DATE_EPOCH روی یک برچسب زمانی یونیکس (UNIX timestamp) تنظیم شده باشد، صفت‌های {docdate}، {doctime}، {localdate} و {localtime} در منطقه زمانی UTC محاسبه می‌شوند و هر برچسب زمانی که جدیدتر از SOURCE_DATE_EPOCH باشد با SOURCE_DATE_EPOCH جایگزین می‌گردد. (این کار به نرم‌افزارهایی که از AsciiDoc استفاده می‌کنند کمک می‌کند تا ساخت بازتولیدپذیر داشته باشند.)

asciidoc asciidoc_file_name.txt

تولید ساده یک فایل html از asciidoc_file_name.txt موجود در دایرکتوری فعلی با استفاده از asciidoc.

asciidoc -b html5 asciidoc_file_name.txt

استفاده از سوییچ -b برای به‌کارگیری یکی از بک‌اندهای پیشنهادی یا بک‌اند دیگری که روی رایانه خود نصب کرده‌اید.

asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt

استفاده از سوییچ -a برای تنظیم صفت‌ها از خط فرمان. با این دستور، AsciiDoc راهنمای کاربری مستقل HTML خود را شامل CSS، جاوااسکریپت و تصاویر جاسازی‌شده، از قالب مقاله AsciiDoc تولید کرد.

asciidoc -b html5 -d manpage asciidoc.1.txt

تولید صفحه راهنمای (manpage) دستور asciidoc با استفاده از بک‌اند html5.

0

موفقیت‌آمیز.

1

شکست (خطای نحو یا نحوه استفاده؛ خطای پیکربندی؛ شکست در پردازش سند؛ خطای غیرمنتظره).

فایل BUGS موجود در توزیع AsciiDoc را ببینید.

دستور AsciiDoc در ابتدا توسط Stuart Rackham نوشته شد. افراد زیادی در توسعه آن مشارکت داشته‌اند.

گیت‌هاب: https://github.com/asciidoc/asciidoc-py3

وب‌سایت اصلی: https://asciidoc.org

a2x(1)

حق نشر © 2002-2013 Stuart Rackham.

حق نشر © 2013-2022 مشارکت‌کنندگان AsciiDoc.

استفاده آزاد از این نرم‌افزار تحت شرایط مجوز عمومی همگانی گنو (GNU General Public License) منتشر شده توسط بنیاد نرم‌افزارهای آزاد مجاز است؛ یا نسخه ۲ مجوز، یا (به انتخاب شما) هر نسخه بالاتر.

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

07/17/2024