(Prawie) wszystko o skorowidzach: plmindex (makeindex)

Jedną z zalet TeX-a jest możliwość automatycznego tworzenia zbiorów dodatkowych, zawierających informacje związane z przetwarzanym tekstem. Utworzony zbiór możemy przetworzyć innym programem; przy ponownym uruchomieniu TeX-a może on zostać dołączony do dokumentu podstawowego.

Do porządkowania zbioru haseł służy program plmindex (lub makeindex). Opisując proces tworzenia skorowidza powołuję się na swoją implementację; program plmindex, czyli Polish (Multilanguage) index. Program może być zastosowany do budowy skorowidza w polskich publikacjach. Dokładny opis własności programu plmindex znajduje się w następnym artykule tego cyklu.

Schemat przetwarzania

Po pierwszym przetwarzaniu dokumentu otrzymujemy zbiór dodatkowy z rozszerzeniem .idx (podstawowy trzon nazwy jest identyczny z nazwą dokumentu). Zawiera on wszystkie hasła, definiowane w dokumencie źródłowym za pomocą polecenia \index. W celu zainicjowania zbioru haseł należy wywołać polecenie \plmindex

Podstawową rolą programu plmindex jest uporządkowanie i posortowanie zbioru haseł wygenerowanego przez pakiet LaTeX-a. Uporządkowany zbiór skorowidza dołączamy do dokumentu podstawowego poleceniem \printindex. Standardowo zbiór ten ma rozszerzenie .ind.

Tworzenie zbioru haseł

\documentclass{article}
\usepackage{makeidx}
\makeindex
\begin{document}
.
.
.
..... bqq\index{bqq}
        .... aqq\index{aqq}
.
.
.
\printindex
\end{document}

\indexentry{bqq}{1}
\indexentry{aqq}{1}

Poszczególne hasła sa definiowane poleceniem \index{...}. Najwygodniej jest umieszczać polecenia tworzące hasła w momencie pisania dokumentu. Trudno sobie wyobrazić automat wprowadzający wskazane słowa do skorowidza, ponieważ hasła powinny występować w swojej podstawowej formie (np. rzeczowniki w mianowniku), a nie w formie wynikającej z kontekstu; pozostaje ,,ręczne'' definiowanie hasła przy okazji jego istotnego wystąpienia.

W zbiorze haseł każde zdefiniowane pojęcie jest umieszczane jako pierwszy argument polecenia \indexentry, drugim argumentem jest numer strony na której ono wystąpiło (wg. aktualnego formatu pisania numerów stron). Należy dbać o to, aby między wystąpieniem danego hasła, a poleceniem wprowadzającym je do skorowidza nie nastąpiło przejście do nowej strony.

plmindex zbiór

\begin{theindex}

  \item aqq, 1

  \indexspace

  \item bqq, 1

\end{theindex}

krowa\index{ssaki!parzysto-kopytne!krowa}
koń\index{ssaki!nieparzysto-kopytne!koń}
tapir\index{ssaki!nieparzysto-kopytne!tapir}
są ssakami\index{ssaki}

Po przetworzeniu programem plmindex zbiór .ind wygląda następująco:

\begin{theindex}

  \item ssaki, 1
    \subitem nieparzysto-kopytne
      \subsubitem koń, 1
      \subsubitem tapir, 1
    \subitem parzysto-kopytne
      \subsubitem krowa, 1

\end{theindex}

Ostatecznie po wydrukowaniu powyższy fragment skorowidza wygląda następująco:

Zmiana kolejności sortowania

\index{hasło do sortowania@hasło do indeksu}

\index{sort@index!sort-1@index-1!sort-2@index-2}

\index{alfa@{\itshape alfa}}

\begin{theindex}

  \item {\itshape alfa}, 1

\end{theindex}

\def\seename{p.}
\def\see#1#2{#2, ({\itshape \seename~#1}\/)}

aqq\index{aqq|see{bqq}}

  \item aqq, \see{bqq}{1}

aqq, 1, (p. bqq)

Za pomocą enkapsulacji można zrealizować rozróżnianie typu występującego hasła, np. miejsce definicji odróżniamy od normalnego wystąpienia użyciem innej czcionki przy podawaniu numeru strony; i tak:

italic hasło używane w przykładzie

bold miejsce zdefniowania pojęcia

pozostałe składane czcionką standardową

\def\italic#1{{\itshape #1}}
\def\bold#1{{\bfseries #1}}

\def\idxb#1{\index{#1|bold}}
\def\idxi#1{\index{#1|italic}}
\let\idx=\index

aqq\idxb{aqq}		%miejsce definicji
aqq\idx{aqq}		%normalne wystąpienie 
aqq\idxi{aqq}		%użycie w przykładzie

  \item aqq, 1, \bold{1}, \italic{1}

strona 1: aqq\index{aqq|(}

strona 3: aqq\index{aqq|)}

    aqq, 1-3

Standardowo, jeżeli hasło występuje na kolejnych stronach to numery stron są grupowane (efekt taki jak w powyższym przykładzie). Używanie powyższej konstrukcji ma sens, jeśli chcemy uzyskać ten efekt tylko dla wybranych haseł, wtedy należy wywołać program plmindex z opcją -r, która wyłączy standardowe grupowanie numerów stron.

Znaki specjalne

aqq!aqq\index{aqq"!aqq}

aqq!aqq, 1

zmienić standardowe definicje używanych poleceń (makroinstrukcji)

Program plmindex zanurza zbiór posortowanych i posegregowanych haseł w środowisku index. Użycie środowiska powoduje zdefiniowanie podrozdziału o nazwie zdefiniowanej przez makroinstrukcję \indexname. Standardowo wartością polecenia jest napis Index, jeżeli chcemy zmienić napis należy zmienić definicję tego polecenia np:

\renewcommand\indexname{Skorowidz}

Do definiowania sposobu prezentacji haseł na różnych poziomach używane są następujące makroinstrukcje:

między grupy haseł (między hasła zaczynające się od różnych znaków -- ale tylko na najwyższym poziomie) jest wstawiane polecenie:
\indexspace o wartości
\par\vskip10\p@ \@plus5\p@ \@minus 3\p@\relax

zmienić zestaw poleceń (makroinstrukcji)

Możemy utworzyć specjalny zbiór zawierający szereg poleceń sterujących programem plmindex. Program plmindex wczytuje ten zbiór jeżeli jest zdefiniowana opcja -s (p. opcje); standardowym rozszerzeniem nazwy jest .mst. W zbiorze tym można zdefiniować następujące wartości:

Przykład: Zawatrość zbioru .mst

delim_0	"~~"
delim_1	"~~"
delim_2	"~~"
headings_flag 1
heading_prefix "{\\par\\goodbreak\\vskip2ex\\par\\large\\bf\\noindent "
heading_suffix "}\\par\\nobreak\\vskip 1.5ex"

daje następujący efekt:

\begin{theindex}
{\par\goodbreak\vskip2ex\par\large\bf\noindent A}\par\nobreak\vskip 1.5ex
  \item a~~\bold{16}, \see{odsyłacz}{16}, \bold{25}
    \subitem effect~~\bold{20}
      \subsubitem new~~\bold{20}
      \subsubitem overlay~~\bold{20}
      \subsubitem replace~~\bold{20}
    \subitem href~~\bold{25}
      \subsubitem \#~~\bold{19}

.
.
.

  \indexspace
{\par\goodbreak\vskip2ex\par\large\bf\noindent Z}\par\nobreak\vskip 1.5ex
  \item zlecenie poszukiwania~~54
  \item zmiana czcionki~~28
  \item znaki specjalne~~92

\end{theindex}

makroinstrukcja \bold została zdefiniowana jako:
\def\bold#1{{\bfseries #1}}

zmienić sposób działania programu plmindex definiując parametry wywołania (opcje)

Program plmindex posiada szereg parametrów wywołania. Ogólna postać wygląda następująco:

plmindex [<opt>] [<idx0> ...]

<opt> mogą przyjmować jedną z następujących wartości:

<idx0> - zbiór haseł (standardowe rozszerzenie .idx)

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.