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

convertgls2bib [option]+ texfile bibfile

توضیحات (DESCRIPTION)

یک فایل .tex حاوی تعاریف واژه‌نامه با استفاده از دستورهایی نظیر "\newglossaryentry" و "\newacronym" را به یک فایل .bib با قالب موردنیاز برای bib2gls تبدیل می‌کند. به‌همراه bib2gls توزیع شده است.

گزینه‌ها (OPTIONS)

گزینه‌های عمومی (GENERAL OPTIONS)

--help یا -h: نمایش پیام راهنما و خروج.
--version یا -v: نمایش اطلاعات نسخه و خروج.
--silent یا --quiet یا -q: فرونشاندن تمامی پیام‌ها به‌جز خطاها.
--verbose: فعال‌کردن حالت پرگو (verbose).
--no-verbose: غیرفعال‌کردن حالت پرگو (verbose).
--debug [n]: نمایش پیام‌های اشکال‌زدایی.
--debug-mode setting: می‌تواند به‌جای --debug در مواردی که به‌خاطرسپاری شماره سطح دشوار است استفاده شود. مقدار آن مشابه گزینهٔ --debug-mode در bib2gls است.
--no-debug: غیرفعال‌کردن حالت اشکال‌زدایی. معادل --debug 0.
--log-file filename: ثبت پیام‌ها در فایل داده‌شده. اساساً برای پیام‌های اشکال‌زدایی در نظر گرفته شده است، بنابراین فعال‌سازی حالت اشکال‌زدایی به‌طور خودکار یک فایل گزارش ایجاد می‌کند، اما در غیر این صورت فایلی ایجاد نخواهد شد مگر اینکه از این گزینه استفاده شود.

گزینه‌های کدگذاری و محلی‌سازی (ENCODING AND LOCALISATION OPTIONS)

--texenc name: تنظیم کدگذاری نویسه‌ها روی name برای فایل‌های ورودی .tex.
--bibenc name: تنظیم کدگذاری نویسه‌ها روی name برای فایل‌های خروجی .bib.
--locale lang tag: استفاده از فایل‌های منبع زبان مرتبط با برچسب زبانِ داده‌شده lang tag. اگر فایل مناسبی وجود نداشته باشد، فایل en (انگلیسی) استفاده خواهد شد.

گزینه‌های فیلترکردن (FILTERING OPTIONS)

--preamble-only یا -p: تنها دیباچه (preamble) سند را تجزیه می‌کند. بدین معنا که در صورت مواجهه با "\begin{document}"، تجزیه متوقف می‌شود.
--no-preamble-only: تجزیهٔ تمام سند (پیش‌فرض).
--ignore-fields list یا -f list: نادیده‌گرفتن تمام فیلدهای موجود در list که با کاما از هم جدا شده‌اند. اگر فهرست شامل sort، type یا category باشد، به‌طور خودکار گزینهٔ متناظر --ignore-sort، --ignore-type یا --ignore-category را اعمال می‌کند. هر مورد در فهرست باید فیلد را با کلید اصلی حساس به کوچک و بزرگی حروف مشخص کند.
این گزینه تجمعی است.
--no-ignore-fields: تأثیر --ignore-fields را لغو می‌کند.
--ignore-category: فیلد category را حذف می‌کند. در صورت استفاده از --split-on-category پیش‌فرض است.
--no-ignore-category: فیلد category را حذف نمی‌کند. پیش‌فرض است، مگر اینکه از --split-on-category استفاده شود.
--ignore-type: فیلد type را حذف می‌کند. در صورت استفاده از --split-on-type پیش‌فرض است.
--no-ignore-type: فیلد type را حذف نمی‌کند. پیش‌فرض است، مگر اینکه از --split-on-type استفاده شود.
--ignore-sort: نادیده‌گرفتن فیلد sort (پیش‌فرض).
--no-ignore-sort: فیلد sort را نادیده نمی‌گیرد.

گزینه‌های فایل خروجی (OUTPUT FILE OPTIONS)

--overwrite: بازنویسی روی فایل‌های .bib موجود. پیش‌فرض است، مگر اینکه از --split-on-type استفاده شده باشد.
--no-overwrite: فایل‌های .bib موجود را بازنویسی نمی‌کند. در صورت استفاده از --split-on-type پیش‌فرض است.
--split-on-type یا -t: مدخل‌ها را با توجه به فیلد type به فایل‌های جداگانه تقسیم می‌کند. این گزینه به‌طور خودکار --ignore-type و --no-overwrite را اعمال می‌کند.
--no-split-on-type: مدخل‌ها را با توجه به فیلد type به فایل‌های جداگانه تقسیم نمی‌کند (پیش‌فرض).
--split-on-category یا -c: مدخل‌ها را با توجه به فیلد category به فایل‌های جداگانه تقسیم می‌کند. این گزینه به‌طور خودکار --ignore-category و --no-overwrite را اعمال می‌کند.
--no-split-on-category: مدخل‌ها را با توجه به فیلد category به فایل‌های جداگانه تقسیم نمی‌کند (پیش‌فرض).

گزینه‌های تطبیق (ADJUSTMENT OPTIONS)

--absorb-see: ادغام "\glssee" و "\glsxtrindexseealso" در داده‌ها (پیش‌فرض).
--no-absorb-see: "\glssee" و "\glsxtrindexseealso" را در داده‌ها ادغام نمی‌کند.
--index-conversion یا -i: هر مدخلی که معمولاً به @entry تبدیل می‌شد اما فاقد شرح باشد یا شرح آن صرفاً روی "\nopostdesc" یا "\glsxtrnopostpunc" تنظیم شده باشد، به @index تبدیل شده و فیلد description حذف خواهد شد.
--no-index-conversion: عدم استفاده از @index به‌جای @entry در صورتی که شرح خالی باشد یا صرفاً شامل "\nopostdesc" یا "\glsxtrnopostpunc" باشد (پیش‌فرض).
--space-sub value یا -s value: جایگزین‌کردن فاصله‌ها در برچسب‌ها با value.
--field-map mappings یا -m mappings: افزودن نگاشت کلید مبدأ به برچسب فیلد مقصد. این آرگومان باید فهرستی جداشده با کاما از جفت‌های src-field=dest-field باشد. این گزینه تجمعی است.
گزینهٔ منسوخ‌شدهٔ --key-map مترادفی برای --field-map است.
--no-field-map: تمام نگاشت‌های اعمال‌شده با --field-map را لغو می‌کند. گزینهٔ منسوخ‌شدهٔ --no-key-map مترادفی برای --field-map است.
--internal-field-map mappings: نگاشت‌های داده‌شده را به مجموعهٔ پیش‌فرض نگاشت‌های فیلد داخلی به کلید اضافه می‌کند. (برای نمونه، desc برچسب فیلد داخلی برای کلید description است.) این گزینه تجمعی است.
این گزینه تنها زمانی نیاز است که برچسب فیلد داخلی در آرگومان دستوری مانند "\glssetnoexpandfield" ارائه شده باشد.

نیازمندی‌ها (REQUIRES)

جاوا ۸ (Java 8) و یک توزیع TeX.

مجوز (LICENSE)

مجوز GPLv3+‎: گنو GPL نسخه ۳ یا بالاتر http://gnu.org/licenses/gpl.html این یک نرم‌افزار آزاد است: شما برای تغییر و بازتوزیع آن آزاد هستید. هیچ‌گونه ضمانتی وجود ندارد، تا حدی که قانون اجازه می‌دهد.

مطالعه پیشنهادی (RECOMMENDED READING)

راهنمای bib2gls:

texdoc bib2gls

راهنمای glossaries-extra:

texdoc glossaries-extra

راهنمای glossaries:

texdoc glossaries

نویسنده (AUTHOR)

Nicola L. C. Talbot, https://www.dickimaw-books.com