Pakiet redefiniuje mechanizm tworzenia skorowidza (index), a jego główną zaletą jest możliwość tworzenia kilku zestawów skorowidzów.
W przypadku załadowania pakietu, ale używania tylko jednego -- domyślnego -- skorowidza należy użyć polecenia \makeindex, które tworzy dla niego odpowiednie mechanizmy.
polecenie | Opis | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
\newindex{n1}{n2}{n3}{n4} \newindex*{n1}{n2}{n3}{n4} \newindex[n0]{n1}{n2}{n3}{n4} \newindex[n0]*{n1}{n2}{n3}{n4} |
gdzie:
| ||||||||||
\renewindex... | analogicznie jak \newindex -- pozwala na zmianę cech skorowidza już zdefiniowanego | ||||||||||
\makeindex | polecenie tworzy mechanizmy dla domyślnego skorowidza | ||||||||||
\index[nazwa skorowidza]{hasło} \index*[nazwa skorowidza]{hasło} \index{hasło} \index*{hasło} | polecenie wprowadza hasło do skorowidza (domyślnego lub wskazanego jeśli podana jest jego nazwa w parametrze opcjonalnym); wersja ,,gwiazdkowa'' wstawia również hasło do tekstu (w przypadku języka polskiego może mieć to sens jedynie dla rzeczowników w mianowniku lub czasowników w bezokoliczniku) | ||||||||||
\disableindex{lista nazw} | wyłącza aktywność wymienionych w parametrze skorowidzów (nazwy oddzielamy przecinkiem) (hasła nie są wyprowadzane do zbioru) -- polecenie powinno być użyte przed poleceniem \makeindex lub \newindex. Uwaga! polecenie nie wyłącza ładowania gotowego zbioru skorowidza przetworzonego programem makeindex | ||||||||||
\printindex[nazwa skorowidza] | polecenie dołącza do dokumentu wskazany skorowidz; oczekiwane jest istnienie zbioru o rozszerzeniu nazwy określonym przez przedostatni parametr polecenia \newindex, zbiór ten tworzy program makeindex (plmindex dla jęz. polskiego) np. makeindex x.adx -o a.and | ||||||||||
\shortindexingon | definiuje synonim polecenia \index jako _ (podkreślenie) i \index* jako ^ (circumflex); przedefiniowanie znaków specjalnych _^ dotyczy wyłącznie trybu tekstowego. Zamiast \index[nazwa skorowidza]{hasło} możemy użyć: _[nazwa skorowidza]{hasło} | ||||||||||
\shortindexingoff | wyłącza definicję synonimów | ||||||||||
\proofmodetrue | hasła wprowadzane do skorowidza są prezentowane na marginesie | ||||||||||
\proofmodefalse | (domyślnie użyta) hasła wprowadzane do skorowidza nie są prezentowane na marginesie | ||||||||||
\indexproofstyle{polecenia formatujące} | polecenia formatujące określają sposób prezentacji hasła na marginesie |
W pakiecie zostały przedefiniowane: środowisko theindex, polecenia: \addcontents, \markright i \markboth -- ale wyłącznie na użytek reimplementacji mechanizmów tworzenia skorowidzów, i nie powinno mieć to skutków ubocznych.
Pakiet jest dostępny pod adresem: ftp://ftp.gust.org.pl/TeX/macros/latex/contrib/index