نام (NAME)

collateindex.pl - تولید پرونده‌های نمایه DocBook

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

collateindex.pl [-f] [-g] [-i id] [-I scope] [-N]
[-o file] [-p] [-P file] [-q] [-s name]
[-S scope] [-t name] [-x] file

توضیحات (DESCRIPTION)

collateindex.pl داده‌های نمایه را برای پرونده‌های XML یا SGML مربوط به DocBook ایجاد می‌کند.

گزینه‌ها (OPTIONS)

-f

نوشتن پرونده خروجی را اجباری می‌کند، حتی اگر به نظر برسد که به صورت دستی ویرایش شده است.

-g

گروه‌بندی مدخل‌ها با IndexDiv بر اساس حرف اول اصطلاح (یا ویژگی SortAs آن). (ممکن است برای تمام محیط‌های زبانی پاسخگو نباشد.)

-i id

شناسه (ID) مورد استفاده برای برچسب <index>.

-I scope

دامنه ضمنی؛ باید یکی از مقادیر "all"، "local" یا "global" باشد. مدخل‌های نمایه‌ای (IndexTerms) که دامنه‌ای مشخص نکرده باشند، این دامنه ضمنی را دریافت می‌کنند. در صورت عدم تعیین، مقدار "all" فرض می‌شود.

-N

نمایه جدید (یک پرونده نمایه خالی تولید می‌کند).

-o file

خروجی در file نوشته می‌شود. در حالت پیش‌فرض به خروجی استاندارد (stdout) ارسال می‌شود.

-p

پیوند دادن به نقاط درون سند. حالت پیش‌فرض پیوند به نزدیک‌ترین بخش دربرگیرنده است.

-P file

خواندن دیباچه از file. محتوای file قبل از برچسب <index> درج خواهد شد.

-q

اجرا در حالت بی‌صدا.

-s name

نام‌گذاری IndexDiv که شامل نمادها است. مقدار پیش‌فرض "Symbols" است. در صورت عدم استفاده از -g بی‌اثر است.

-S scope

دامنه نمایه؛ باید یکی از مقادیر "all"، "local" یا "global" باشد. در صورت عدم تعیین، مقدار "all" فرض می‌شود.

-t name

عنوان نمایه.

-x

ایجاد یک SetIndex.

-V

نمایش نسخه برنامه و خروج.

file

پرونده حاوی داده‌های نمایه که با شیوه‌نامه DSSSL HTML مربوط به DocBook تولید شده است (معمولاً با نام HTML.index).

مثال (EXAMPLE)

collateindex.pl -o index.sgml HTML.index

وضعیت خروج (EXIT STATUS)

0

موفقیت‌آمیز

1

شکست یا خطا

نویسنده (AUTHOR)

Norm Walsh <ndw@nwalsh.com>

به‌روزرسانی‌های جزئی توسط Adam Di Carlo <adam@onshore.com> و Peter Eisentraut <peter_e@gmx.net>