نام (NAME)

edtx2dtx - تبدیل فایلهای .edtx به .dtx

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

edtx2dtx filename.edtx > filename.dtx

توضیحات (DESCRIPTION)

این ابزار قطعه‌های کد را در یک جفت \begin{macrocode} و \end{macrocode} (کامنت‌شده و با دندانه‌گذاری مناسب) محصور می‌کند. یک قطعه کد، هر توالی از خطوط است که با یک نویسه کامنت منفرد (احتمالاً دندانه‌دار) (%) آغاز نشده باشد؛ به این معنی که هم خطوط غیرکامنت و هم خطوطی که با چندین نویسه کامنت شروع می‌شوند به عنوان کد به حساب می‌آیند، و خطوط مستندات نیز ممکن است دارای دندانه‌گذاری باشند.

بخشی از فایل که باید پردازش شود باید توسط یک جفت \begin{macrocode} و \end{macrocode} مشخص گردد. به عبارت دیگر، هر چیزی قبل از \begin{macrocode} به عنوان سرایند در نظر گرفته شده و تغییر نمی‌کند، و هر چیزی بعد از \end{macrocode} به عنوان پسایند در نظر گرفته شده و تغییر داده نمی‌شود. در واقع، هر تعدادی از جفت‌های \begin{macrocode} — \end{macrocode} مجاز است. (این سامانه اجازه می‌دهد گرداننده (driver) همان‌طور که هست باقی بماند، و همچنین چسباندن یک فایل .dtx را درون یک فایل .edtx آسان می‌کند، زیرا اجرای این ابزار بر روی یک .dtx فایل را تغییر نمی‌دهد.)

علاوه بر این، این ابزار نخستین رخداد <filename>.edtx در سرایند را، که به دنبال آن یک یادداشت اختیاری درون پرانتز آمده است، با <filename>.dtx به همراه یادداشتی در مورد نحوه تولید فایل جایگزین می‌کند.

گزینه‌ها (OPTIONS)

-c, --comment: نویسه کامنت ورودی؛ مقدار پیش‌فرض % است. (هر نویسه کامنت ورودی در سرایند و پسایند با نویسه کامنت خروجی جایگزین خواهد شد، که همواره % است.)

-b, --begin-macrocode regex

-e, --end-macrocode regex: از این گزینه‌ها برای تغییر نشانگرهای ورودی پیش‌فرض \begin{macrocode} و \end{macrocode} استفاده کنید. (نشانگرهای خروجی همواره \begin{macrocode} و \end{macrocode} هستند.) نشانگرها باید به عنوان عبارات باقاعده‌ای که کل خط را مطابقت می‌دهند مشخص شوند. نشانگرهای ورودی در فایل باقی نمی‌مانند، یعنی با نشانگرهای خروجی جایگزین می‌شوند.

-B, --Begin-macrocode regex

-E, --End-macrocode regex: مانند -b و -e، اما نشانگرهای ورودی در خروجی نگه داشته می‌شوند.
-s, --strip-empty: اگر این گزینه مشخص شود، خطوط خالی در خروجی گنجانده نمی‌شوند.
-h, --help: نمایش راهنما و خروج.
-V, --version: نمایش شماره نسخه و خروج.

مثال‌ها (EXAMPLES)

اگر input.edtx دقیقاً مشابه یک فایل dtx باشد، فقط بدون \begin{macrocode} و \end{macrocode} در اطراف هر قطعه کد:

edtx2dtx input.edtx > output.dtx

ابزار Memoize از فراخوانی زیر برای تولید یک .dtx از کد مستندشده پایتون در memoize-extract.py استفاده می‌کند. مقدار -c ابزار edtx2dtx را با کامنت‌های پایتون سازگار می‌سازد. گزینه -B هر آنچه پیش از عبارت شماره نسخه قرار دارد را به عنوان سرایند مشخص کرده و عبارت شماره نسخه را در خروجی نگه می‌دارد. به طور مشابه، -E تعیین می‌کند که پردازش باید هنگام برخورد با متغیرهای محلی Emacs متوقف شود (که دست‌نخورده در خروجی حفظ می‌شوند).

edtx2dtx -s -c '#' -B '^__version__' -E '^# Local Variables:' $< \

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

easydoctex.el