نام (NAME)

dtxgen - تولید قالب برای پرونده‌های خوداستخراج‌کنندهٔ dtx. در LaTeX

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

dtxgen [options] basename.[sty,cls]

توضیحات (DESCRIPTION)

برنامهٔ dtxgen یک قالب برای پرونده‌های dtx. خوداستخراج‌کننده، بر اساس مدل شرح داده شده توسط Joseph Wright در (www.texdev.net20091006a-model-dtx-file) ایجاد می‌کند. این برنامه برای کسانی که قصد ایجاد یک پروندهٔ منبع مستندسازی‌شدهٔ لاتک (.dtx یا Documented LaTeX Source) جدید دارند مفید است.

مثال کاربرد:

dtxgen -n 'your name' -m 'your@email.ad' myclass.cls

این اسکریپت متغیرهایی مانند:

‣

نام و نشانی رایانامهٔ نویسنده،

‣

توضیحی کوتاه دربارهٔ کلاس یا بسته‌ای که از پروندهٔ dtx. تولید می‌شود،

‣

یک تاریخ

را از متغیرهای محیطی یا از گزینه‌های خط فرمان دریافت کرده و در کنار موارد دیگر، قالبی برای پروندهٔ dtx. به همراه چند مثال کمینه ایجاد می‌کند. البته کاربر باید آن مثال‌ها را با کار واقعی خود جایگزین کند، اما تاریخ‌ها، نام پایه (basename)، نام نویسنده و نشانی رایانامه از پیش در جای خود قرار دارند و بسته به این که در آرگومان از پسوند cls. یا sty. استفاده کرده باشید، قالب‌بندی آن متناسب با پروندهٔ منبع یک کلاس یا بسته انجام می‌شود.

اگر در محیط خود نام و نشانی رایانامه‌تان را در متغیرهای NAME و EMAIL تعریف کرده باشید، می‌توانید به سادگی دستور زیر را اجرا کنید:

dtxgen myclass.cls

و در نهایت پنج پرونده دریافت خواهید کرد: myclass.dtx، myclass.cls، myclass.pdf، README.md و Makefile.

گزینه‌ها (OPTIONS)

دستور dtxgen گزینه‌های زیر را تشخیص می‌دهد:

-h,--help

-n,--name=X نام شما (نام کوچک و به دنبال آن نام خانوادگی). همچنین، می‌توانید یک مقدار پیش‌فرض در متغیر محیطی |NAME| تنظیم کنید؛ اگر چنین کنید و همچنان از این گزینه استفاده نمایید، مقدار این گزینه اولویت خواهد داشت.

-m,--mail=X نشانی رایانامهٔ شما. همچنین، می‌توانید یک مقدار پیش‌فرض در متغیر محیطی |EMAIL| تنظیم کنید؛ اگر چنین کنید و همچنان از این گزینه استفاده نمایید، مقدار این گزینه اولویت خواهد داشت.

-c,--class=X تنها برای قالب‌های کلاس: یک |

-v,--version=X تنظیم نسخهٔ اولیه؛ به‌طور پیش‌فرض از 1.00 استفاده خواهد شد.

-d,--date=X تنظیم تاریخ نسخهٔ اولیه. به‌طور پیش‌فرض، از تاریخ جاری استفاده خواهد شد. تاریخ باید در قالب |yyyymmdd| وارد شود، هرچند به شیوهٔ LaTeX ذخیره خواهد شد: |yyyy/mm/dd|.

-f,--format=X قالب Latex مورد استفاده برای کامپایل. پیش‌فرض pdflatex است، اما ممکن است به قالب دیگری مانند xelatex یا lualatex نیاز داشته باشید.

-i,--history

Makefile

از Makefile می‌توان برای کامپایل نسخه‌های جدید کار خود استفاده کرد؛ این پرونده شامل هدف‌های (target) زیر است:

all

نویسندگان (AUTHORS)

Wybo Dekker (wybodekker@me.com)

کپی‌رایت و تکثیر (COPYRIGHT)

تحت مجوز عمومی همگانی گنو (GNU General Public License) منتشر شده است (www.gnu.orgcopyleftgpl.html)