.TH TEXDOCTK 1 .SH "نام (NAME)" texdoctk \- رابط گرافیکی برای دسترسی آسان‌تر به مستندات بسته‌ها و برنامه‌های TeX .SH "خلاصه دستور (SYNOPSIS)" .B texdoctk \-[aq] .SH "توضیحات (DESCRIPTION)" برنامهٔ .B texdoctk یک رابط گرافیکی کاربر (GUI) برای دسترسی آسان‌تر به بخش بزرگی از حجم انبوه مستندات و راهنماهای آموزشی بسته‌ها و برنامه‌ها برای TeX و مشتقات مختلف آن (عمدتاً LaTeX) است. این برنامه بهینه‌سازی شده و در توزیع‌های teTeX و fpTeX گنجانده شده و همچنین در TeXLive نیز در دسترس است. .PP مستندات در ۱۷ دسته‌بندی گروه‌بندی شده‌اند؛ دکمهٔ هجدهم در پنل اصلی به صورت پیش‌فرض غیرفعال است و برای استفاده در افزوده‌های محلی در نظر گرفته شده است (به بخش .B پیکربندی (CONFIGURATION) در زیر مراجعه کنید). .PP در پنجرهٔ تنظیمات، یک جعبهٔ علامت‌زدن در منوهای مبدل html->ps و text->ps برای فعال/غیرفعال کردن تغییر مسیر خروجی می‌بینید. دلیل این امر آن است که برخی مبدل‌ها خروجی خود را به‌طور پیش‌فرض در یک فایل نمی‌نویسند، بلکه به خروجی استاندارد (stdout) می‌فرستند؛ بنابراین به یک تغییر مسیر نیاز است، مانند: .PP a2ps myfile.txt >myfile.ps .SH "گزینه‌ها (OPTIONS)" .TP .I "\-v" حالت پُرگو (verbose): برخی پیام‌های نمایشگر را که در غیر این صورت به stderr فرستاده می‌شوند، همراه با برخی پنجره‌های بازشوی هشدار فعال می‌کند. این مورد را می‌توان در یک فایل پیکربندی نیز تنظیم کرد. .TP .I "\-a" نمایش خودکار (autoview): در صورتی که یک جعبهٔ فهرست (listbox) تنها شامل یک مورد باشد، نمایشگر را به‌طور خودکار اجرا می‌کند (این حالت اغلب در نتایج جستجو رخ می‌دهد). این مورد را نیز می‌توان در یک فایل پیکربندی تنظیم کرد. .SH "پیکربندی (CONFIGURATION)" .PP پیکربندی توسط فایل پیکربندی پیش‌فرض سیستم ($TEXMFMAIN)/texdoctk/texdocrc.defaults کنترل می‌شود، هرچند بیشتر مدخل‌های آن می‌توانند توسط فایل اختیاری خود کاربران ~/.texdocrc و/یا گزینه‌های خط فرمان بازنویسی شوند. .SS منوی تنظیمات و فایل‌های پیکربندی .PP منوی Settings برای تغییر تنظیمات قابل تعریف توسط کاربر در \fBtexdoctk\fP، چه برای مدت زمان اجرای برنامه یا به‌عنوان پیش‌فرض‌های جدید به کار می‌رود. مورد دوم هدف دکمهٔ Save است که فایل شخصی کاربر ~/.texdocrc را ایجاد کرده یا بازنویسی می‌کند. پیش‌فرض‌های سیستم را نمی‌توان با منوی Settings ویرایش کرد. .TP مسیرها (Paths) مسیرهای نوع TEXMF در سیستم گزارش می‌شوند، و کاربر می‌تواند نام زیرپوشه‌ای از $HOMETEXMF را که مستندات شخصی در آن ذخیره می‌شوند مشخص کند. .TP رفتار کلی نمایشگر (General viewer behaviour) .I Suppress error messages تغییر وضعیت حالت پرگو (گزینه \-v را ببینید)؛ پیش‌فرض خاموش است. .I Autostart viewer for one-item listboxes اجرای خودکار نمایشگر در صورتی که جعبهٔ فهرست تنها شامل یک مورد باشد (گزینه \-a را ببینید). .I Use text viewer for unknown file format یعنی برخورد با فایل به عنوان متن ساده. \fBtexdoctk\fP باید قالب‌های معمول فایل را تشخیص دهد و نام‌هایی مانند README را نیز به متن ساده مرتبط سازد، اما برخی مستندات ممکن است نام‌های دلخواه و نامعمول داشته باشند. پیش‌فرض روشن است؛ در صورت خاموش بودن، تلاش برای مشاهدهٔ چنین فایل‌هایی خطایی ایجاد خواهد کرد. این کلید بر چاپ تأثیری ندارد: قالب‌های شناخته‌نشده را نمی‌توان چاپ کرد. .I Change viewer colours تغییر رنگ‌های نمایشگر با استفاده از سه‌گانه‌های RGB در قالب #rrggbb یا نام‌های استانداردشده. .TP DVI/PostScript/PDF/HTML/متن ساده (Plain text) برای فایل‌های متنی، \fBtexdoctk\fP یک نمایشگر داخلی فراهم می‌کند. اگر این نمایشگر غیرفعال شود، اما نمایشگر جایگزینی تعیین نشده باشد، \fBtexdoctk\fP سعی می‌کند محتوای متغیر محیطی $PAGER را بخواند. اگر می‌خواهید مستندات را چاپ کنید، به مبدل‌هایی برای تبدیل فایل‌های غیر PS به PostScript نیاز خواهید داشت. در اینجا چند پیشنهاد آورده شده است: \& dvi->ps: dvips (بخشی از teTeX است) (http://www.radicaleye.com/dvips.html) \& pdf->ps: pdf2ps (http://www.cs.wisc.edu/~ghost) یا Acrobat Reader (http://www.adobe.com) \& html->ps: html2ps (http://user.it.uu.se/~jan/html2ps.html) \& plain text->ps: a2ps (http://www-inf.enst.fr/~demaille/a2ps) منوهای مبدل html->ps و text->ps برای روشن/خاموش کردن تغییر مسیر خروجی به کار می‌روند. این امر به دلیل آن است که برخی مبدل‌ها خروجی خود را به‌طور پیش‌فرض درون یک فایل نمی‌نویسند بلکه به stdout می‌فرستند، بنابراین به تغییر مسیر نیاز است؛ مانند: .B a2ps myfile.txt >myfile.ps .PP فایل پیکربندی سراسری سیستم ($TEXMFMAIN)/texdoctk/texdocrc.defaults است و تنها باید توسط مدیر نصب و با استفاده از هر ویرایشگر متنی قابل نوشتن باشد. فایل پیکربندی اختیاری کاربر ~/.texdocrc است و می‌تواند همهٔ تنظیمات را بازنویسی کند به جز آن تنظیمات سیستمی که کل فرایند نصب را تحت تأثیر قرار می‌دهند. روش ترجیحی برای تغییر آن از طریق منوی Settings است. .SS پایگاه‌های داده برنامهٔ \fBtexdoctk\fP با یک فایل پایگاه داده پیش‌فرض به نام ($TEXMFMAIN)/texdoctk/texdoctk.dat با قالبی ویژه ارائه می‌شود. این فایل به ۱۷ بخش تقسیم شده که متناظر با ۱۷ دکمه‌ای هستند که به‌طور پیش‌فرض فعال می‌باشند. هر بخش با یک خط آغاز می‌شود: @\fIsection_name\fP که در آن .I section_name متنی است که روی دکمه ظاهر می‌شود. پس از این عنوان، مدخل‌های توصیفی برای هر سند می‌آیند که دارای این قالب هستند: \fIpackage-label\fP;Short description for listbox (opt. \fIpackage-name\fP);path in doc directory;optional keywords (بدون شکستن خط!). کامنت‌ها (که با # آغاز می‌شوند) و خط‌های خالی توسط برنامه نادیده گرفته می‌شوند. فیلد دوم متنی است که در جعبه‌های فهرست انتخاب \fBtexdoctk\fP نمایش داده می‌شود و معمولاً می‌خواهید نام بسته را در پرانتز همراه با آن بیاورید؛ فیلد اول یک برچسب \fBیکتا\fP برای بسته جهت استفادهٔ داخلی برنامه است که معمولاً یکسان با نام بسته انتخاب می‌شود، اما اگر بیش از یک فایل مستندات همراه با یک بسته ارائه شده باشد می‌تواند متفاوت باشد. .PP مدیر سیستم احتمالاً بسته‌های اضافی را در ساختار درختی texmf محلی نصب خواهد کرد. مستندات متناظر می‌توانند توسط یک پایگاه داده اضافی به نام $TEXMFLOCAL/texdoctk/texdoctk-local.dat در دسترس قرار گیرند. علاوه‌بر این، کاربران فردی نیز ممکن است بسته‌های اضافی را در یک زیرپوشهٔ texmf در $HOME خود نصب کنند، که برای آن می‌توانند خودشان یک پایگاه داده جداگانه به عنوان $TEXMFHOME/texdoctk/texdoctk-pers.dat ایجاد نمایند. پس از ایجاد چنین فایل‌هایی، باید دستور texhash اجرا شود. .PP هر دو نوع پایگاه داده باید همان ساختار پایگاه داده سیستم را داشته باشند، اگرچه نیازی نیست (و نباید) شامل همهٔ بخش‌های آن باشند در صورتی که مدخل‌های اضافی وجود نداشته باشد. برای مثال، اگر بستهٔ .I foo به ساختار محلی اضافه شود به گونه‌ای که فایل مستندات آن ($TEXMFLOCAL)/doc/latex/foo/foo.dvi باشد و تصمیم گرفته شود که در دسته‌بندی موجود Graphics بهترین همخوانی را دارد، texdoctk-local.dat به شکل زیر خواهد بود: @Graphics .br foo;Create bells and whistles (foo);latex/foo/foo.dvi;decoration سپس مدخل مربوط به .I foo به انتهای فهرست مدخل‌ها در دسته‌بندی Graphics اضافه خواهد شد. دکمهٔ ۱۸ام را نیز می‌توان به همین روش اما با استفاده از یک نام دسته‌بندی جدید فعال کرد؛ مدخل‌های احتمالی در ابتدای پایگاه داده که به هیچ دسته‌ای اختصاص داده نشده‌اند به دستهٔ پیش‌فرض Miscellaneous اختصاص خواهند یافت، که باعث می‌شود دکمهٔ ۱۸ام با این برچسب فعال شود. توجه داشته باشید که نمی‌توانید بیش از ۱۸ دسته‌بندی داشته باشید؛ اگر تعداد بیشتری وجود داشته باشد، تنها آخرین موردی که تعریف شده نمایش داده شده و استفاده خواهد شد. .PP اگر مستندات به جای یک فایل مستندات مناسب، در درون فایل .sty گنجانده شده باشد، کلمات کلیدی اختیاری باید بلافاصله پس از نقطه-ویرگول با \-?\- شروع شوند، که در آن ? یکی از مقادیر 0، 1، 2 یا 3 است؛ این‌ها پرچم‌هایی هستند که نشان می‌دهند دستورالعمل‌ها در کدام بخش از فایل .sty قرار گرفته‌اند و باید به \fBtexdoctk\fP در استخراج مستندات از استایل و ارائهٔ آن بدون کدهای برنامه (که معمولاً کاربرد چندانی ندارند) کمک کنند. .TP 0 مکان مشخصی ندارد، در میان کدها پراکنده است .TP 1 در انتها، پس از \\endinput؛ برخی فایل‌های .sty دارای مستندات مرتب و سازمان‌یافته‌ای در پسِ انتهای کد واقعی هستند، جایی که TeX هنگام کامپایل آن را نمی‌بیند .TP 2 در ابتدا، خاتمه‌یافته با %%%%%%؛ در برخی موارد دیگر، اطلاعات نحوهٔ استفاده در ابتدای .sty به صورت یادداشتی قرار دارد که با خطی پر از علامت % خاتمه یافته است .TP 3 همانند 2، اما با یک خط خالی به‌عنوان پایان‌بخش .PP برای نمونه‌های متعدد به پایگاه دادهٔ سیستم مراجعه کنید. .SH "فایل‌ها (FILES)" .PP \& $TEXMFMAIN/texdoctk/texdocrc.defaults فایل پیکربندی سراسری سیستم .PP \& ~/.texdocrc فایل پیکربندی شخصی (اختیاری)؛ همچنین می‌تواند از منوی Settings ایجاد شود .PP \& $TEXMFMAIN/texdoctk/texdoctk.dat فایل پایگاه داده پیش‌فرض برای فایل‌های مستندات توزیع .PP \& $TEXMFLOCAL/texdoctk/texdoctk-local.dat فایل پایگاه داده محلی (اختیاری) برای فایل‌های مستندات .PP \& $TEXMFHOME/texdoctk/texdoctk-pers.dat فایل پایگاه داده شخصی (اختیاری) کاربران فردی برای فایل‌های مستندات .SH "گزارش باگ‌ها (BUGS)" جای‌گیری ویجت‌ها در پنجره‌های سطح بالای موضوعات هنگام کشیده شدن یا کوچک شدن پنجره نامطلوب می‌شود. .PP قلم در برچسب‌های کادر منوی Settings به قلم پیش‌فرض مقید نشده است؛ این موضوع برای نمونه در صفحه‌نمایش‌های با وضوح بالا که قلم برچسب‌ها بزرگ‌نمایی نمی‌شود، به چشم می‌آید. .PP خروجی خطای Netscape و Mozilla حتی اگر حالت بی‌صدا (quiet mode) تنظیم شده باشد، در stderr نوشته خواهد شد. .SH "نویسندگان (AUTHORS)" برنامهٔ .B texdoctk توسط Thomas Ruedas نوشته شده است. .PP این صفحهٔ راهنما در ابتدا توسط Adrian Bunk برای سیستم دبیان گنو/لینوکس نوشته شده بود (اما ممکن است توسط دیگران نیز استفاده شود). اکنون توسط Thomas Ruedas نگهداری می‌شود. .SH "کپی‌رایت و تکثیر (COPYRIGHT)" کپی‌رایت (C) 2000-2004 Thomas Ruedas .br این نرم‌افزار آزاد است؛ برای شرایط تکثیر به سورس برنامه نگاه کنید. هیچ‌گونه ضمانتی وجود ندارد؛ حتی برای قابلیت فروش یا تناسب با یک هدف خاص.