BIB2GLS(1) bib2gls BIB2GLS(1)

bib2gls [گزینه]+ auxfile

bib2gls برای کار با بستهٔ LaTeX به نام glossaries-extra طراحی شده است. (گزینهٔ بسته‌ای record الزامی است.) این برنامه دو کارکرد را در قالب یک ابزار ارائه می‌دهد: (۱) انتخاب مدخل‌ها از فایل‌های .bib بر اساس اطلاعات موجود در auxfile (مشابه bibtex)؛ (۲) مرتب‌سازی سلسله‌مراتبی مدخل‌ها و تلفیق فهرست‌های مکان (مشابه makeindex و xindy). پسوند .aux را می‌توان از auxfile حذف کرد.

فایل auxfile (و فایل .log متناظر با آن) باید در دایرکتوری جاری یا در دایرکتوری مشخص‌شده توسط --dir قرار داشته باشد. فایل‌های bib می‌توانند نسبت به دایرکتوری‌ای که auxfile در آن قرار دارد مشخص شوند یا در مکانی باشند که توسط kpsewhich قابل یافتن باشد..SH "گزینه‌ها (OPTIONS)"

مشخص می‌کند هنگامی که bib2gls در فایل aux به "\@input" برخورد می‌کند چه کاری انجام دهد. مقدار setting می‌تواند یکی از موارد زیر باشد:
دنبال کردن ارجاع (یعنی وارد کردن فایل طبق روال معمول).
دنبال کردن ارجاع برای هر "\@input" تا زمانی که به "\@bibgls@input" برخورد شود، و پس از آن نادیده گرفتن تمام موارد باقی‌ماندهٔ "\@input" (پیش‌فرض).
نادیده گرفتن تمام موارد "\@input" (به‌جز "\@bibgls@input" که همواره دنبال می‌شود).

دستور "\@bibgls@input" در صورت استفاده از گزینهٔ بستهٔ "bibglsaux" در فایل aux موجود خواهد بود.

تفسیر نویسهٔ "~" (تیلدا) و "\nobreakspace" به عنوان یک فاصلهٔ معمولی.
در نظر گرفتن "\citation" به عنوان یک رکورد نادیده‌گرفته‌شده.
فشرده‌سازی یک بازهٔ صریح که مکان آغاز و پایان یکسان دارد به یک رکورد معمولی (پیش‌فرض).
دستور دادن به کتابخانهٔ تجزیه‌گر TeX برای تلاش جهت تجزیهٔ بسته‌های فهرست‌شده در list. این گزینه برای بسته‌های سفارشی ساده‌ای در نظر گرفته شده است که حاوی کدهای پیچیده نیستند.
مفسر از دستورهای نشانه‌گذار datatool-base.sty برای تطبیق تعاریف محلی‌شدهٔ آن‌ها در "\DTLsortwordlist" (datatool نسخه ۳.۰+) استفاده خواهد کرد. شما به یک روش مرتب‌سازی نیاز خواهید داشت که نویسه‌های کنترلی استفاده‌شده توسط این دستورها را نادیده نگیرد.
توضیح سرآیند در ابتدای فایل .glstex شامل تاریخ تغییر فایل خواهد بود.
روشن کردن حالت اشکال‌زدایی با تنظیم داده‌شدهٔ n، که باید یک عدد صحیح غیرمنفی باشد. اگر n برابر با 0 باشد، حالت اشکال‌زدایی خاموش می‌شود. در صورت حذف، مقدار n برابر با 1 تعیین می‌شود که معادل --debug-mode io است. هر عدد مثبت تمام پیام‌های اشکال‌زدایی bib2gls را فعال خواهد کرد. میزان پیام‌های اشکال‌زدایی کتابخانهٔ تجزیه‌گر TeX به عملیات بیتی روی n بستگی دارد.
می‌تواند به جای --debug در مواردی که به‌خاطرسپاری شمارهٔ سطح دشوار است استفاده شود. مقدار setting می‌تواند فهرستی جداشده با کاما از هر یک از کلیدواژه‌های زیر باشد:
بالاترین سطح (احتمالاً منجر به یک فایل رونوشت بزرگ می‌شود). معادل روشن کردن تمام تنظیمات است.
تغییرات کدهای ردهٔ تجزیه‌گر TeX.
تعاریف دستور تجزیه‌گر TeX.
اعلان‌های تجزیه‌گر TeX.
بسط‌های تجزیه‌گر TeX (ممکن است منجر به یک فایل رونوشت بزرگ شود).
بسط‌های پشتهٔ تجزیه‌گر TeX (ممکن است منجر به یک فایل رونوشت بزرگ شود).
بسط‌های یک‌سطحی تجزیه‌گر TeX.
بسط‌های فهرست یک‌سطحی تجزیه‌گر TeX.
عملیات ورودی/خروجی تجزیه‌گر TeX (باز کردن، بستن و واکشی نشانه).
بیرون کشیدن از پشتهٔ تجزیه‌گر TeX.
پردازش ماکروی تجزیه‌گر TeX (ممکن است منجر به یک فایل رونوشت بزرگ شود).
پردازش دستور عمومی تجزیه‌گر TeX.
پردازش پشتهٔ تجزیه‌گر TeX (ممکن است منجر به یک فایل رونوشت بزرگ شود).
پردازش تفصیلی پشتهٔ تجزیه‌گر TeX (ممکن است منجر به یک فایل رونوشت بزرگ شود).
خواندن کدپوینت از فایل توسط تجزیه‌گر TeX (احتمالاً منجر به یک فایل رونوشت بزرگ می‌شود).
داده‌های تجزیه‌گر TeX (معمولاً مربوط به اشیای درونی است که ماکروی TeX مشابهی ندارند). این شامل داده‌های جمع‌آوری‌شده از فایل aux می‌شود.

برای مثال: "bib2gls --debug-mode io,catcode,sty-data mydoc"

تنظیم کدگذاری نویسهٔ پیش‌فرض برای فایل‌های ورودی و خروجی. در صورت حذف، کدگذاری پیش‌فرض JVM فرض می‌شود.
فایل‌ها نسبت به directory سنجیده می‌شوند. (این گزینه دایرکتوری کاری فعلی را تغییر نمی‌دهد.)
عدم نوشتن "\glsnoexpandfields" در فایل .glstex.
اجبار به روشن بودن حالت ارجاع بین‌منبعی.
افزودن فیلد group به مدخل‌ها.
نمایش پیام راهنما و خروج.
عدم تجزیهٔ فایل لاگ برای بسته‌های فهرست‌شده در list. توجه داشته باشید که --packages این گزینه را لغو می‌کند؛ بنابراین اگر یک بسته هم در --ignore-packages و هم در --packages فهرست شده باشد، مفسر پشتیبانی شدن آن را بررسی خواهد کرد. این گزینه عملکردی تجمعی دارد. تنها بسته‌های شناخته‌شده را می‌توان در list گنجاند.
استفاده از کتابخانهٔ تجزیه‌گر TeX برای تفسیر دستورهای شناخته‌شدهٔ (La)TeX (پیش‌فرض).
فهرست کردن تمام بسته‌های شناخته‌شده برای کتابخانهٔ تجزیه‌گر TeX و سپس خروج (با کد خروج 0). هر یک از بسته‌های فهرست‌شده را می‌توان در --packages یا --ignore-packages استفاده کرد.
استفاده از فایل منبع زبان برای lang (که باید یک برچسب محلی IETF باشد).
تنظیم کدگذاری نویسه برای فایل‌های log (که ممکن است با کدگذاری فایل‌های LaTeX سند یکسان نباشد).
تنظیم فایل رونوشت.
قاعده برای ادغام مکان‌های ایجادشده با گزینهٔ بستهٔ record=nameref (نیازمند glossaries-extra.sty نسخه 1.37+). مقدار rule می‌تواند یکی از موارد زیر باشد: hcounter، href، title یا location.
ادغام رکوردهای wrglossary یک مدخل برای مکان‌های صفحهٔ یکسان. (جهت استفاده به همراه گزینهٔ بستهٔ indexcounter.)
فعال کردن درج خودکار یک گروه خالی برای تغییر حالت ریاضی ("$").

اگر mfirstuc نسخه 2.08+، glossaries نسخه 4.50+ و glossaries-extra نسخه 1.49+ شناسایی شوند، حالت پیش‌فرض --no-mfirstuc-math-protection خواهد بود، زیرا دیگر نیازی به این محافظت نخواهد بود..IP "--mfirstuc-protection fields|all (یا -u fields|all)" 4 درج یک گروه خالی در صورتی که فیلدها با دستورهای مشکل‌ساز خاصی شروع شوند، جهت محافظت در برابر دستورهای تغییر وضعیت حروف مانند "\Gls".

حالت پیش‌فرض اعمال این عمل برای تمام فیلدها است. برای انجام آن تنها روی زیرمجموعه‌ای از فیلدها، مقدار fields را با فهرستی از فیلدهای جداشده با ویرگول مشخص کنید (مانند name,short,long). کلیدواژه all بیانگر همه فیلدها است.

اگر mfirstuc نسخه 2.08+، glossaries نسخه 4.50+ و glossaries-extra نسخه 1.49+ شناسایی شوند، حالت پیش‌فرض --no-mfirstuc-protection خواهد بود، زیرا دیگر نیازی به این محافظت نخواهد بود.

بررسی هر فیلد مشخص‌شده در list برای یافتن متن‌های پیوند تودرتو که ممکن است مشکل‌ساز باشند. (فهرست پیش‌فرض: name، text، plural، first، firstplural، short، shortplural، long، longplural، symbol).

اگر none باشد، بررسی را غیرفعال می‌کند.

تفسیر "~" (تیلدا) و "\nobreakspace" به عنوان فاصله نشکن (پیش‌فرض).
عدم بررسی موارد رخداد "\citation" در فایل .aux (پیش‌فرض).
عدم فروپاشی بازه صریحی که مکان شروع و پایان یکسان دارد به یک رکورد عادی.
مفسر از تعریف عادی دستورهای نشانه‌گذار مرتب‌سازی datatool-base.sty استفاده خواهد کرد.
توضیح سرآیند در ابتدای فایل .glstex شامل تاریخ ویرایش فایل نخواهد بود (پیش‌فرض).
غیرفعال کردن حالت اشکال‌زدایی. (معادل --debug 0)
نوشتن "\glsnoexpandfields" در فایل .glstex (پیش‌فرض).
عدم تحمیل فعال‌سازی حالت ارجاع متقابل بین‌منبعی (پیش‌فرض).
عدم افزودن فیلد group به مدخل‌ها (پیش‌فرض).
عدم تلاش برای تفسیر دستورهای (La)TeX. کتابخانه TeX Parser Library همچنان برای تجزیه فایل‌های aux و bib استفاده خواهد شد.
عدم ادغام رکوردهای wrglossary یک مدخل.
غیرفعال کردن درج خودکار گروه خالی برای تغییر حالت ریاضی ("$").
غیرفعال کردن درج خودکار گروه خالی برای تمامی فیلدها.
عدم بررسی متن‌های پیوند تودرتو که ممکن است مشکل‌ساز باشند. (معادل --nested-link-check none)
نادیده گرفتن دستورهای تغییر کد دسته (catcode) مشاهده‌شده در فایل aux.
عدم نوشتن "\provideignoredglossary*" در فایل .glstex برای معرفی واژه‌نامه‌های ناشناخته به جز در موارد مستندشده (گزینه‌های منبع master، secondary و trigger-type). این تنظیم پیش‌فرض است.
عدم افزودن فیلد شمارش رکوردها به مدخل‌ها (پیش‌فرض). این گزینه به‌طور خودکار --no-record-count-unit را نیز اعمال می‌کند.
عدم افزودن فیلد شمارش واحد رکوردها به مدخل‌ها (پیش‌فرض).
عدم جایگزینی نویسه‌های علامت نقل‌قول (پیش‌فرض).
قوانین عادی ادغام مکان اعمال می‌شوند (پیش‌فرض).
عدم بررسی مکان‌های پایان‌یافته با ".0" (پیش‌فرض).
بالانویس‌های متنی ("\textsuperscript") یا زیرنویس‌ها ("\textsubscript") به نویسه‌های بالانویس/زیرنویس یونیکد تبدیل نخواهند شد. به عنوان مثال، "\textsuperscript{2}" به "<sup>2</sup>" تبدیل شده و نشانه‌گذاری آن حذف می‌شود و فقط نویسه 2 باقی می‌ماند.
فاصله‌های خالی ابتدا و انتهای فیلدها را حذف نکن (پیش‌فرض). این گزینه --trim-only-fields و --trim-fields را لغو می‌کند.
غیرفعال کردن حالت پرگو (verbose). (برخی از پیام‌ها همچنان در خروجی استاندارد STDOUT نوشته خواهند شد.)
عدم صدور هشدار در صورت یافت شدن فیلدهای داخلی غیر-bib در فایل .bib. استفاده از این فیلدهای داخلی ممکن است نتایج غیرمنتظره‌ای به همراه داشته باشد، بنابراین تنها در صورتی از این گزینه استفاده کنید که تمهیدات لازم را اندیشیده باشید.
عدم صدور هشدار در صورت یافت شدن انواع مدخل‌های ناشناخته در فایل .bib.
پیروی از دستورهای شناخته‌شده تغییر کد دسته (catcode) مشاهده‌شده در فایل aux.
به کتابخانه تحلیل‌گر TeX دستور می‌دهد فرض کند بسته‌های مشخص‌شده در list توسط سند استفاده شده‌اند. توجه داشته باشید که تنها تعداد محدودی از بسته‌ها توسط کتابخانه تحلیل‌گر TeX پشتیبانی می‌شوند. این گزینه اثر تجمعی دارد، بنابراین --packages wasysym,pifont با --packages wasysym --packages pifont یکسان است.

می‌توانید فهرست بسته‌های پشتیبانی‌شده را با --list-known-packages مشاهده کنید.

نوشتن "\provideignoredglossary*" در فایل .glstex برای معرفی واژه‌نامه‌های ناشناخته.
تنها نمایش پیام‌های خطا. تمام پیام‌های دیگر صرفاً در فایل رونوشت (transcript) نوشته می‌شوند.
افزودن فیلدهای شمارش رکورد به مدخل‌ها.
قاعده مورد استفاده توسط --record-count و --record-count-unit را تعیین می‌کند. این گزینه به‌طور خودکار --record-count را اعمال می‌کند.

مقدار rule می‌تواند این موارد باشد: "all" یا "a" (شمارش تمام رکوردها)، "non-ignored" یا "n" (شمارش تمام رکوردهای نادیده‌گرفته‌نشده)، "f/"regex"/" (تنها شمارش رکوردهایی که قالب آن‌ها با عبارت باقاعده regex مطابقت دارد)، "c/"regex"/" (تنها شمارش رکوردهایی که نام شمارنده آن‌ها با عبارت باقاعده regex مطابقت دارد)، یا "f/"regex1"/c/"regex2"/"op (تنها شمارش رکوردهایی که قالب آن‌ها با عبارت باقاعده regex1 و/یا نام شمارنده آن‌ها با عبارت باقاعده regex2 مطابقت دارد). بخش op اختیاری است. در صورت مشخص شدن می‌تواند یکی از این موارد باشد: "and" (قالب و شمارنده هر دو باید مطابقت داشته باشند)، "or" (قالب یا شمارنده باید مطابقت داشته باشند). اگر op حذف شود، AND در نظر گرفته می‌شود.

افزودن فیلدهای شمارش واحد رکورد به مدخل‌ها. این گزینه به‌طور خودکار --record-count را اعمال می‌کند.
جایگزینی نویسه‌های نقل‌قول تکی و دوگانه ("'" و """) با "\bibglsaposchar" و "\bibglsdoublequotechar" در مقادیر فیلدها و اطلاعات گروه نوشته‌شده در فایل .glstex.
مشخص می‌کند کدام قالب‌های مکان باید همواره حفظ شوند، حتی اگر سبب ایجاد مورد تکراری جزئی شوند. تنها موارد کاملاً تکراری ادغام خواهند شد.
انتقال به سطح بالاتر برای مکان‌های بخشی که به ".0" ختم می‌شوند (برای بخش‌های عمیق‌تر از فصل یا chapter). این عمل به‌صورت بازگشتی اعمال می‌شود.

به عنوان مثال، اگر یک رکورد دارای شمارنده "subsection" و مکان 2.0.0 باشد، این مقدار ابتدا با شمارنده "section" و مکان 2.0 جایگزین می‌شود، اما چون این مقدار هنوز دارای مکان بخشی منتهی به ".0" است، تابع مجدداً اعمال شده و شمارنده به "chapter" و مکان به 2 تغییر می‌یابد (بنابراین مکان subsection 2.0.0 در نهایت به عنوان chapter 2 ثبت می‌شود). فایل لاگ (و حالت پرگو) شامل یک خط به ازای هر تغییر در این بازگشت خواهد بود..IP "--shortcuts option" 4 هنگام جستجوی وابستگی‌ها، دستورهای میانبر بررسی شوند. مقادیر مجاز option عبارتند از: acronyms (یا acro)، ac، abbreviations (یا abbr)، all (یا true)، none (یا false). این گزینه تنظیم مشخص‌شده در auxfile را نادیده می‌گیرد.

تنظیم نگاشت‌های قالب مکان.
تنها پیام‌های خطا نمایش داده شوند. تمامی پیام‌های دیگر فقط در فایل رونوشت (transcript) نوشته می‌شوند. (مترادف --quiet.)
بالانویس متن ("\textsuperscript") یا زیرنویس متن ("\textsubscript") در صورت موجود بودن از نویسه‌های بالانویس/زیرنویس یونیکد استفاده خواهند کرد. برای نمونه، "\textsuperscript{2}" به U+00B2 (دو بالانویس) تبدیل خواهد شد.
تنظیم رمزگذاری نویسه‌ها برای فایل‌های glstex. این گزینه تنظیم مشخص‌شده در auxfile را نادیده می‌گیرد.
حذف فاصله‌های خالی ابتدا و انتهای تمام فیلدها به‌جز موارد فهرست‌شده. این گزینه انباشتی است اما توسط --trim-fields و --no-trim-fields لغو می‌شود. این گزینه نباید همراه با --trim-only-fields استفاده شود.
حذف فاصله‌های خالی ابتدا و انتهای تمام فیلدها. این گزینه --trim-only-fields و --no-trim-fields را لغو می‌کند.
حذف فاصله‌های خالی ابتدا و انتها تنها از فیلدهای فهرست‌شده. این گزینه انباشتی است اما توسط --trim-fields و --no-trim-fields لغو می‌شود. این گزینه نباید همراه با --trim-except-fields استفاده شود.
فعال کردن حالت پرگو (verbose).
نمایش اطلاعات نگارش و خروج.
هشدار در صورت یافت شدن فیلدهای درونی غیر-bib در فایل .bib.
هشدار در صورت یافت شدن هرگونه نوع مدخل ناشناخته در فایل .bib.

جاوا ۸ یا بالاتر و یک توزیع TeX.

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

راهنمای bib2gls:

texdoc bib2gls

راهنمای glossaries-extra:

texdoc glossaries-extra

راهنمای glossaries:

texdoc glossaries

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

2025-11-13 perl v5.40.3