UPMENDEX(1) General Commands Manual UPMENDEX(1)

upmendex - پردازشگر نمایه چندزبانه

upmendex [-ilqrcgf] [-s sty] [-d dic] [-o ind] [-t log] [-p no] [--] [ idx0 idx1 idx2 ...]
upmendex --help
upmendex --version

برنامه upmendex یک تولیدکننده نمایه سلسله‌مراتبی چندزبانه با کاربرد عمومی است که با upLaTeX، XeLaTeX و LuaLaTeX کار می‌کند؛ این برنامه یک یا چند فایل ورودی (.idx؛ معمولاً تولیدشده توسط قالب‌بندی‌کننده‌های متنی مانند خانواده LaTeX) را می‌پذیرد، مدخل‌ها را مرتب می‌کند و یک فایل خروجی تولید می‌کند که قابل قالب‌بندی است. این ابزار از خط‌های لاتین (شامل زبان‌های غیرانگلیسی)، یونانی، سیریلیک، هانگول کره‌ای و هان (اندیشه‌نگاشت‌های هانزی) و همچنین کانای ژاپنی پشتیبانی می‌کند. همچنین به‌صورت آزمایشی از خط‌های برهمایی (بنگالی، دیواناگری، گورموکی، گجراتی، کانادا، لائو، مالایالام، اوریا، سینهالی، تامیلی، تلوگو و تایلندی)، عربی و عبری پشتیبانی می‌کند. این برنامه تا حد زیادی با makeindex و mendex سازگار است، و قابلیت اضافی برای مدیریت خوانش کلمات کانجی (kanji) نیز در دسترس است.
قالب‌های فایل‌های ورودی و خروجی در یک فایل شیوه‌نامه (style file) مشخص می‌شوند. خوانش کلمات کانجی را می‌توان در یک فایل فرهنگ‌لغت مشخص کرد.
نمایه می‌تواند تا پنج سطح (۰، ۱، ۲، ۳ و ۴) زیرمجموعه تو در تو داشته باشد.

دریافت ورودی از stdin، حتی در صورتی که فایل‌های نمایه مشخص شده باشند.
تنظیم بر روی «مرتب‌سازی بر اساس ترتیب نویسه‌ها». به‌طور پیش‌فرض، از «مرتب‌سازی بر اساس ترتیب کلمات» استفاده می‌شود. جزئیات در ادامه شرح داده شده است.
حالت بی‌صدا؛ هیچ پیامی به stderr ارسال نمی‌شود، مگر پیام‌های خطا و هشدارها.
غیرفعال‌سازی تشکیل ضمنی بازه صفحات. به‌طور پیش‌فرض، سه یا چند صفحه متوالی به‌طور خودکار به‌صورت یک بازه خلاصه می‌شوند (مانند 1–5).
فشرده‌سازی توالی فاصله‌های میانی (فاصله(ها) و/یا تب(ها)) به یک فاصله و نادیده گرفتن فاصله‌های خالی ابتدا و انتها. به‌طور پیش‌فرض، فاصله‌های خالی در کلید نمایه حفظ می‌شوند.
تنظیم سربرگ نمایه ژاپنی بر روی سطر A (A, Ka, Sa, ...؛ ۱۰ نویسه) از جدول gojuon (هجانگار ژاپنی). به‌طور پیش‌فرض، تمام ۴۸ نویسه موجود در جدول gojuon استفاده می‌شوند.
اجبار به چاپ نویسه‌ها در خروجی، حتی اگر خط‌های نوشتاری مربوطه توسط upmendex پشتیبانی نشوند.
به‌کارگیری sty به عنوان فایل شیوه‌نامه (style file).
به‌کارگیری dic به عنوان فایل فرهنگ‌لغت. فایل فرهنگ‌لغت از فهرستی از <index_word reading> تشکیل شده است.
به‌کارگیری ind به عنوان فایل نمایه خروجی. به‌طور پیش‌فرض، نام فایل با افزودن پسوند ind به نام پایه نخستین فایل ورودی ایجاد می‌شود.
به‌کارگیری log به عنوان فایل گزارش (transcript file). به‌طور پیش‌فرض، نام فایل با افزودن پسوند ilg به نام پایه نخستین فایل ورودی ایجاد می‌شود.
تنظیم شماره صفحه آغازین فهرست نمایه خروجی بر روی no. آرگومان no می‌تواند عددی باشد یا یکی از مقادیر زیر: any (صفحه بعد از پایان محتوا)، odd (صفحه فرد بعد از پایان محتوا)، even (صفحه زوج بعد از پایان محتوا).
نمایش خلاصه گزینه‌ها و خروج.
نمایش اطلاعات نسخه و خروج.
--
آرگومان‌های پس از -- به عنوان گزینه در نظر گرفته نمی‌شوند. این قابلیت زمانی مفید است که نام فایل ورودی با '-' شروع شود..SH "فایل شیوه‌نامه (STYLE FILE)" فایل شیوه‌نامه به upmendex دربارهٔ قالب فایل‌های ورودی idx و قالب مد نظر برای فایل خروجی نهایی اطلاعات می‌دهد. این قالب با قالب برنامه‌های makeindex و mendex سازگاری رو به بالا دارد. فایل شیوه‌نامه شامل فهرستی از جفت‌های <specifier attribute> است. دو نوع مشخص‌کننده وجود دارد: ورودی و خروجی. نیازی نیست جفت‌ها با ترتیب خاصی قرار بگیرند. خطی که با ´%´ آغاز شود یک یادداشت (کامنت) است.

پارامتر سبک فایل ورودی

"\\indexentry"
دستوری با یک آرگومان از مدخل نمایه که قرار است پردازش شود.
´{´
جداکنندهٔ آغازین که شروع مدخل نمایه را مشخص می‌کند.
´}´
جداکنندهٔ پایانی که پایان مدخل نمایه را مشخص می‌کند.
´(´
جداکنندهٔ آغازین که شروع بازهٔ صفحه را مشخص می‌کند.
´)´
جداکنندهٔ پایانی که پایان بازهٔ صفحه را مشخص می‌کند.
´!´
جداکننده‌ای که سطح پایین‌تر را مشخص می‌کند.
´@´
نمادی که مشخص می‌کند توالی بعدی قرار است به‌صورت رشته‌های نمایه در فایل خروجی نمایش داده شود.
´|´
نمادی که مشخص می‌کند توالی بعدی باید به‌عنوان نام دستور پیوست‌شده به شمارهٔ صفحه به کار رود.
"-"
جداکنندهٔ میان سطوح صفحه برای شیوه‌ای با شماره صفحات چندسطحی.
"rnaRA"
اولویت نمایش برای شمارهٔ صفحه. ´R´ و ´r´ متناظر با اعداد رومی هستند. ´n´ متناظر با ارقام عربی است. ´A´ و ´a´ متناظر با الفبای لاتین هستند.
´"´
نویسهٔ گریز برای پارامترهای upmendex.
´\\´
نویسهٔ گریز برای خط‌های عمومی.

پارامتر سبک فایل خروجی

"\\begin{theindex}\n"
دیباچهٔ فایل خروجی.
"\n\n\\end{theindex}\n"
پس‌درآمد فایل خروجی.
"\n \\setcounter{page}{"
پیشوند شمارهٔ صفحه در صورتی که صفحهٔ آغازین تعیین شده باشد.
"}\n"
پسوند شمارهٔ صفحه در صورتی که صفحهٔ آغازین تعیین شده باشد.
"\n\n \\indexspace\n"
رشته‌هایی برای درج فاصلهٔ عمودی پیش از بخش جدیدی از نمایه.
""
پیشوند عنوان برای حرف سربرگ تازه ظاهرشده.
""
مشابه lethead_prefix. (سازگار با makeindex)
""
پسوند عنوان برای حرف سربرگ تازه ظاهرشده.
""
مشابه lethead_suffix. (سازگار با makeindex)
0
پرچمی برای کنترل خروجی حروف سربرگ در خط‌های لاتین، یونانی و سیریلیک. ´0´، ´1´، ´-1´ و ´2´ به ترتیب نشان‌دهندهٔ عدم خروجی، حروف بزرگ، حروف کوچک و عنوان (titlecase) هستند.
0
مشابه lethead_flag. (توجه: makeindex از نام متفاوت headings_flag استفاده می‌کند)
0
مشابه lethead_flag. (سازگار با makeindex)
"(standard heading characters)"
نویسه‌های سربرگ خط مشخص‌شده با string 2. یکی از نام‌های خط باید در string 1 مشخص شود: ´kana´، ´hangul´، ´hanzi´، ´devanagari´، ´bengali´، ´gurmukhi´، ´gujarati´، ´oriya´، ´tamil´، ´telugu´، ´kannada´، ´malayalam´، ´sinhala´، ´thai´ یا ´lao´. (توسعه‌یافته توسط upmendex)
""
نویسه‌های سربرگ کانا که توسط یک رشته مشخص می‌شوند. به‌طور پیش‌فرض، این مورد توسط letter_head و گزینهٔ خط فرمان -g کنترل می‌شود. (توسعه‌یافته توسط upmendex) hangul_head <string> "ㄱㄴㄷㄹㅁㅂㅅㅇㅈㅊㅋㅌㅍㅎ"
نویسه‌های سربرگ هانگول (Hangul) مشخص‌شده توسط یک رشته. (توسعه‌یافته در upmendex)
""
رشته‌های سربرگ هانزی (کانجی، هانجا) مشخص‌شده توسط یک رشته، که حاصل پیوند دادن موارد با جداکنندهٔ ´;´ است. (توسعه‌یافته در upmendex)
"ऄअआइईउऊऋऌऍऎएऐऑऒओऔकखगघङचछजझञटठडढणतथदधनपफबभमयरलळवशषसह"
نویسه‌های سربرگ دواناگری مشخص‌شده توسط یک رشته. (آزمایشی، توسعه‌یافته در upmendex)
"กขฃคฅฆงจฉชซฌญฎฏฐฑฒณดตถทธนบปผฝพฟภมยรฤลฦวศษสหฬอฮ"
نویسه‌های سربرگ خط تایلندی مشخص‌شده توسط یک رشته. (آزمایشی، توسعه‌یافته در upmendex)
"\n \\item "
"\n \\subitem "
"\n \\subsubitem "
"\n \\subsubsubitem "
"\n \\subsubsubsubitem "
دنبالهٔ دستور درج‌شده میان دو مدخل سطح اولیه، دو ثانویه و غیره.
"\n \\subitem "
"\n \\subsubitem "
"\n \\subsubsubitem "
"\n \\subsubsubsubitem "
دنبالهٔ دستور درج‌شده میان مدخل‌های سطح اولیه و ثانویه، ثانویه و ثالثیه و غیره.
"\n \\subitem "
"\n \\subsubitem "
"\n \\subsubsubitem "
"\n \\subsubsubsubitem "
دنبالهٔ دستور درج‌شده میان مدخل‌های سطح اولیه و ثانویه، ثانویه و ثالثیه و غیره، هنگامی که مدخل سطح بالاتر فاقد شماره صفحه است.
", "
", "
", "
", "
", "
رشتهٔ جداکننده میان مدخل‌های سطح اولیه، ثانویه و غیره با نخستین شماره صفحه.
", "
رشتهٔ جداکننده میان شماره صفحات که به‌طور معمول برای هر سطحی از مدخل‌ها استفاده می‌شود.
"--"
رشتهٔ جداکننده میان صفحات جهت نمایش محدودهٔ صفحات.
""
رشتهٔ جداکنندهٔ خروجی در انتهای فهرست شماره صفحات.
""
رشته‌ای که در صورت متوالی بودن دو صفحه، به جای delim_n و شماره صفحهٔ بعدی درج می‌شود.
تنها زمانی عمل می‌کند که پارامتر تعریف شده باشد.
""
رشته‌ای که در صورت متوالی بودن سه صفحه، به جای delim_r و شماره صفحهٔ سوم درج می‌شود. این پارامتر بر suffix_mp اولویت دارد.
تنها زمانی عمل می‌کند که پارامتر تعریف شده باشد.
""
رشته‌ای که در صورت متوالی بودن سه یا چند صفحه، به جای delim_r و شماره صفحهٔ آخر درج می‌شود.
تنها زمانی عمل می‌کند که پارامتر تعریف شده باشد.
"\\"
پیشوند برای دستور دربرگیرنده (encapsulating command) هنگامی که دستور دربرگیرنده به شماره صفحه اضافه می‌شود.
"{"
پیشوند درست پیش از شماره صفحه هنگامی که دستور دربرگیرنده به شماره صفحه اضافه می‌شود.
"}".
پسوند پس از شماره صفحه هنگامی که دستور دربرگیرنده به شماره صفحه اضافه می‌شود.
72
حداکثر تعداد نویسه‌های یک خط. در صورت فراتر رفتن از این تعداد، خطوط شکسته می‌شوند.
""
فضای تورفتگی که در ابتدای خط شکسته درج می‌شود.
16
طول فضای تورفتگی که در ابتدای خط شکسته درج می‌شود. symhead_positive <string> "Symbols"
رشته‌ای برای خروجی به عنوان سربرگ نمادها هنگامی که lethead_flag یا heading_flag یا headings_flag عددی مثبت باشد.
"symbols"
رشته‌ای برای خروجی به عنوان سربرگ نمادها هنگامی که lethead_flag یا heading_flag یا headings_flag عددی منفی باشد.
""
رشته‌ای برای خروجی به عنوان سربرگ نمادها هنگامی که symbol_flag غیر صفر باشد.
در صورت تعیین، این گزینه نسبت به symhead_positive و symhead_negative اولویت دارد. (توسعه‌یافته توسط (up)mendex)
"Numbers"
رشته‌ای برای خروجی به عنوان سربرگ اعداد هنگامی که lethead_flag یا heading_flag یا headings_flag عددی مثبت و symbol_flag برابر ۲ باشد.
"numbers"
رشته‌ای برای خروجی به عنوان سربرگ اعداد هنگامی که lethead_flag یا heading_flag یا headings_flag عددی منفی و symbol_flag برابر ۲ باشد.
1
پرچم خروجی نماد. اگر ´0´ باشد، سربرگی برای نمادها و اعداد چاپ نمی‌شود. اگر ´1´ باشد، نمادها و اعداد به عنوان یک گروه از نمادها خروجی داده می‌شوند. اگر ´2´ باشد، نمادها و اعداد به صورت جداگانه خروجی داده می‌شوند. (توسعه‌یافته توسط (up)mendex)
1
پرچم سربرگ برای کانای ژاپنی. اگر ´1´ یا ´2´ باشد، به ترتیب از Katakana و Hiragana استفاده می‌شود. (توسعه‌یافته توسط (up)mendex)
0
پرچم روش مرتب‌سازی برای مدخل‌های نمایه متشکل از خط ژاپنی و غیرژاپنی (برای مثال خط لاتین). اگر غیر صفر باشد، یک فاصله (U+0020) بین دنباله ژاپنی و دنباله غیرژاپنی در فرایند مرتب‌سازی درج می‌شود. (توسعه‌یافته توسط (up)mendex)
"SNLGCJKHDbpgotukmsTlah"
ترتیب خط‌ها و نمادها. حروف ´S´، ‏´N´، ‏´L´، ‏´G´، ‏´C´، ‏´J´، ‏´K´، ‏´H´، ‏´D´، ‏´b´، ‏´p´، ‏´g´، ´o´، ‏´t´، ‏´u´، ‏´k´، ‏´m´، ‏´s´، ´T´، ‏´l´، ‏´a´ و ´h´ به ترتیب نمایانگر رسم‌الخط‌های نماد، عدد، Latin ،Greek ،Cyrillic، کانای ژاپنی (Kana)، هانگول کره‌ای (Hangul)، هانزی (Hanzi)، Devanagari ،Bengali ،Gurmukhi ،Gujarati ،Oriya ،Tamil ،Telugu ،Kannada ،Malayalam، Sinhala ،Thai ،Lao، عربی (Arabic) و عبری (Hebrew) هستند. ´@´ نمایانگر رسم‌الخط‌هایی است که به‌طور صریح مشخص نشده‌اند و ترتیب آن‌ها توسط icu_rules یا icu_locale پیکربندی می‌شود. لطفاً مطمئن شوید که در صورت symbol_flag=1، حروف ´S´ و ´N´ در کنار یکدیگر قرار دارند، زیرا اعداد به عنوان بخشی از نمادها دسته‌بندی می‌شوند. (توسعه‌یافته توسط upmendex)
""
سرآغاز (Preamble) بلوک رسم‌الخط در فایل خروجی، که توسط string 2 مشخص می‌شود. یکی از نام‌های خط زیر باید در string 1 مشخص شود: ´latin´، ‏´cyrillic´، ‏´greek´، ‏´kana´، ‏´hangul´، ‏´hanzi´، ´devanagari´، ‏´bengali´، ‏´gurmukhi´، ‏´gujarati´، ‏´oriya´، ´tamil´، ‏´telugu´، ‏´kannada´، ‏´malayalam´، ‏´sinhala´، ´thai´، ‏´lao´، ‏´arabic´ یا ´hebrew´. (توسعه‌یافته توسط upmendex)
""
پایان‌بخش (Postamble) بلوک رسم‌الخط در فایل خروجی، که توسط string 2 مشخص می‌شود. یکی از نام‌های خط زیر باید در string 1 مشخص شود: ´latin´، ‏´cyrillic´، ‏´greek´، ‏´kana´، ‏´hangul´، ‏´hanzi´، ´devanagari´، ‏´bengali´، ‏´gurmukhi´، ‏´gujarati´، ‏´oriya´، ´tamil´، ‏´telugu´، ‏´kannada´، ‏´malayalam´، ‏´sinhala´، ´thai´، ‏´lao´، ‏´arabic´ یا ´hebrew´. (توسعه‌یافته توسط upmendex)
""
لوکال در تطبیق‌دهنده ICU (ICU collator). به‌طور پیش‌فرض، "root sort order" تنظیم شده است. (توسعه‌یافته توسط upmendex)
""
قواعد تطبیق سفارشی در تطبیق‌دهنده ICU. نویسه‌های یونیکد در کدگذاری UTF-8 و توالی‌های گریز زیر پذیرفته می‌شوند: \Uhhhhhhhh (هگزادسیمال ۸ رقمی [0-9A-Fa-f])، \uhhhh (هگزادسیمال ۴ رقمی)، \xhh (هگزادسیمال ۲ رقمی)، \x{h...} (هگزادسیمال ۱ تا ۸ رقمی) و \ooo (اکتال ۳ رقمی [0-7]). اگر icu_rules و icu_locale به طور هم‌زمان مشخص شوند، قواعد تطبیق تعیین‌شده توسط icu_rules به قواعد تطبیق تعیین‌شده توسط icu_locale اضافه می‌شوند. به‌طور پیش‌فرض، از locale استفاده می‌شود. (توسعه‌یافته توسط upmendex)
مرجع: https://unicode-org.github.io/icu/userguide/collation/customization، http://www.unicode.org/reports/tr35/tr35-collation.html#Rules
""
مشخصه‌ها در تطبیق‌دهنده ICU. موارد زیر در دسترس هستند: "alternate:shifted", "alternate:non-ignorable", "strength:primary", "strength:secondary", "strength:tertiary", "strength:quaternary", "strength:identical", "french-collation:on", "french-collation:off", "case-first:off", "case-first:upper-first", "case-first:lower-first", "case-level:on", "case-level:off", "normalization-mode:on", "normalization-mode:off", "numeric-ordering:on", "numeric-ordering:off" (توسعه‌یافته توسط upmendex)
مرجع: https://unicode-org.github.io/icu/userguide/collation/customization/#default-options، http://www.unicode.org/reports/tr35/tr35-collation.html#Setting_Options

upmendex در مقایسه با makeindex، از یک ویژگی اضافی برای ساده‌سازی فرآیند مدیریت نمایه‌های ژاپنی برخوردار است. کاربران می‌توانند از زحمت تعیین دستی خوانش (تلفظ) برای هر کلمهٔ کانجی (kanji) صرف‌نظر کنند.
کلمات کانجی ژاپنی معمولاً بر اساس هجاهای خوانش آن‌ها (´Yomi´) مرتب می‌شوند که می‌توان آن‌ها را با خط‌های کانا (هیراگانا، کاتاکانا) نشان داد. upmendex کلمات نمایه‌ای را که مستقیماً در فایل ورودی به صورت عبارت کانا مشخص شده‌اند می‌پذیرد، و همچنین تبدیل کلمات نمایه از کانجی یا نمادها به خط‌های آوانگار را با ارجاع به فرهنگ‌لغت‌های ژاپنی انجام می‌دهد.

نمونه‌هایی از ساده‌سازی درونی هجاها در زیر نشان داده شده است.


かぶしきがいしゃ かふしきかいしや
マッキントッシュ まつきんとつしゆ
ワープロ わあふろ

فایل فرهنگ‌لغت شامل فهرستی با ساختار <´index_word´ ´reading´> است. کلمهٔ نمایه را می‌توان به هر خطی (کانجی، کانا و غیره) نوشت، و خوانش می‌تواند به هر خط آوانگاری مانند خط‌های هیراگانا یا کاتاکانا باشد. جداکنندهٔ بین کلمهٔ نمایه و خوانش آن، یک یا چند نویسهٔ تب (tab) یا فاصله (space) است.
نمونه‌ای از یک فرهنگ‌لغت ژاپنی در زیر نشان داده شده است.


漢字 かんじ
読み よみ
環境 かんきょう
$ ドル

در اینجا، هر کلمهٔ نمایه مجاز است تنها یک Yomi داشته باشد. اگرچه برخی از کلمات کانجی (مانند «表») ممکن است بیش از یک Yomi داشته باشند (مانند «ひょう» و «おもて»)، تنها یکی از آن‌ها می‌تواند در فرهنگ‌لغت ثبت شود. هنگامی که به Yomiهای متفاوتی نیاز باشد، باید به‌طور صریح با عبارت کانا (مانند \index{ひょう@表} یا \index{おもて@表}) در فایل ورودی مشخص شوند.
علاوه بر این، با تعیین نام فایل در متغیر محیطی INDEXDEFAULTDICTIONARY، به یک فایل فرهنگ‌لغت به‌طور خودکار ارجاع داده می‌شود. فرهنگ‌لغت تعیین‌شده توسط این متغیر محیطی می‌تواند همراه با فایل(های) مشخص‌شده توسط گزینهٔ -d استفاده شود.

upmendex به‌طور پیش‌فرض نمایه‌ها را همان‌گونه که هستند مرتب می‌کند (´sort by word order´). با تنظیم گزینهٔ -l، فاصله‌های میان کلمات در یک نمایه پیش از اجرای روال مرتب‌سازی حذف می‌شوند (´sort by character order´).
حتی هنگام مرتب‌سازی بر اساس ترتیب نویسه‌ها، نمایه در خروجی با توالی اصلی و بدون حذف فاصله‌ها باقی می‌ماند.
در ادامه یک نمونه نشان داده شده است.

sort by word order sort by character order
X Window Xlib
Xlib XView
XView X Window

علاوه بر این، دو روش مرتب‌سازی را می‌توان برای نمایه‌هایی اعمال کرد که شامل هر دو خط کانای ژاپنی و سایر خط‌ها (مانند خط لاتین) هستند. با تنظیم priority به 0 (پیش‌فرض) و 1 در یک فایل سبک (style file)، به ترتیب یک فاصله میان کانای ژاپنی و سایر خط‌ها پیش از شروع روال مرتب‌سازی درج می‌شود یا درج نمی‌شود.
در ادامه یک نمونه نشان داده شده است.

priority=0 priority=1
index sort indファイル
indファイル index sort
upmendex به متغیرهای محیطی زیر ارجاع می‌دهد:
دایرکتوری محل قرارگیری فایل‌های شیوه‌نامه نمایه (index style).
فایل شیوه‌نامه نمایه که به عنوان پیش‌فرض به آن ارجاع داده می‌شود.
دایرکتوری محل قرارگیری فایل‌های واژه‌نامه (dictionary).
فایل واژه‌نامه‌ای که به طور خودکار خوانده می‌شود.

مشخصات دقیق با makeindex سازگار است.

هنگامی که عبارت شماره صفحه جمع استفاده می‌شود، فایل‌های .idx باید همراه با ترتیب شماره صفحات مشخص شوند. در غیر این صورت، ممکن است شماره‌های صفحه نادرستی در خروجی ظاهر شوند.

tex(1), latex(1), makeindex(1), mendex(1).
مولفه‌های بین‌المللی برای یونیکد (ICU): http://icu.unicode.org, https://unicode-org.github.io/icu

این صفحه راهنما توسط Takuji Tanaka بر اساس صفحه راهنمای mendex نوشته‌شده توسط Japanese TeX Development Community به نگارش درآمده است.