summaryrefslogtreecommitdiff
path: root/info/tex-virtual-academy-pl/idx/program.html
blob: 1765247b9ae311268a22f3e6d0cb1b299b5409d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-2">
<meta http-equiv="Content-language" content="pl">
<meta name="Author" content="W³odzimierz Macewicz">
<title> Wszystko o skorowidzach </title>
</head>
<body bgcolor=#F0F0A0>


<center>
<h1>(Prawie) wszystko o skorowidzach: plmindex (makeindex)</h1>
</center>

<h2>Spis tre¶ci</h2>

<a href=#wstep>Wstêp</a><br>
<a href=#schemat>Schemat przetwarzania</a><br>
<a href=#tworzenie>Tworzenie zbioru hase³</a><br>
<a href=#przetwarzanie>Przetwarzanie zbioru hase³</a><br>
	<dd><a href=#poziomy>Skorowidz wielopoziomowy</a>
	<dd><a href=#kolejnosc>Zmiana kolejno¶ci sortowania</a>
	<dd><a href=#odsylacze>Odsy³acze w skorowidzu, efekty dodatkowe</a>
	<dd><a href=#grupowanie>Grupowanie numerów stron</a>
	<dd><a href=#znaki>Znaki specjalne</a><br>
<a href=#postac>Definiowanie postaci skorowidza</a><br>
<dd> <a href=#definicje>U¿ywane polecenia</a>
<dd> <a href=#styl>Definiowanie zbioru poleceñ</a>
<dd> <a href=#opcje>Opcje programu</a>
<hr>

<a name=wstep><h2>Wstêp</h2></a>
Ka¿da powa¿na publikacja o charakterze naukowo-technicznym powinna posiadaæ 
skorowidz (indeks), czyli uporz±dkowany wykaz u¿ywanych,
b±d¼ definiowanych pojêæ, zawieraj±cy informacje na jakich stronach
s± one u¿ywane.

<p>
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.

<p> Do porz±dkowania zbioru hase³ s³u¿y program <strong>plmindex</strong>
(lub <tt>makeindex</tt>).
Opisuj±c proces tworzenia skorowidza powo³ujê siê na swoj±
implementacjê; program <strong>plmindex</strong>, czyli
<i>Polish (Multilanguage) index</i>. Program mo¿e byæ zastosowany
do budowy skorowidza w polskich publikacjach. Dok³adny
opis w³asno¶ci programu <strong>plmindex</strong> znajduje
siê w <a href="plmindex.html"> nastêpnym artykule tego cyklu</a>.


<a name=schemat><h2>Schemat przetwarzania</h2></a>

Tworzenie skorowidza w dokumencie przetwarzanym TeX-em
zosta³o zrealizowane wed³ug powy¿szego schematu zilustrowanego
rysunkiem:<br>
 
<p align=center><img src="tex-idx.gif"
width=320 height=510><br>

<p>Po pierwszym przetwarzaniu dokumentu otrzymujemy zbiór
dodatkowy z rozszerzeniem <code>.idx</code> (podstawowy trzon
nazwy jest identyczny z nazw± dokumentu). Zawiera on wszystkie
has³a, definiowane w dokumencie ¼ród³owym za pomoc±
polecenia <code>\index</code>. W celu zainicjowania zbioru hase³
nale¿y wywo³aæ polecenie <code>\plmindex</code>

<p>Podstawow± rol± programu <strong>plmindex</strong> jest uporz±dkowanie i 
posortowanie zbioru hase³ wygenerowanego przez pakiet LaTeX-a.
Uporz±dkowany zbiór skorowidza
do³±czamy do dokumentu podstawowego poleceniem <code>\printindex</code>.
Standardowo zbiór ten ma rozszerzenie <code>.ind</code>.


<a name=tworzenie><h2>Tworzenie zbioru hase³</h2></a>

Niezbêdny zestaw poleceñ w dokumencie umo¿liwiaj±cy utworzenie
i do³±czenie skorowidza:
<pre>
\documentclass{article}
\usepackage{makeidx}
\makeindex
\begin{document}
.
.
.
..... bqq\index{bqq}
        .... aqq\index{aqq}
.
.
.
\printindex
\end{document}
</pre>
Po przetworzeniu pakietem LaTeX2e otrzymamy nastêpuj±cy zbiór skorowidza:
<pre>
\indexentry{bqq}{1}
\indexentry{aqq}{1}
</pre>

<p>
Poszczególne has³a sa definiowane poleceniem <code>\index{...}</code>. 
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. 

<p>W zbiorze hase³
ka¿de zdefiniowane pojêcie jest umieszczane jako pierwszy argument polecenia
<code>\indexentry</code>, 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.<br>

<center>
<table border>
<tr>
    <td> definicja b³êdna </td> <td> definicja poprawna </td>
								   </tr>
<tr>
    <td> <code>aqq \index{aqq}
         </code>               </td> <td> <code>aqq\index{aqq}
				         </code>               </td>
								   </tr>
</table>
</center>

<a name=przetwarzanie><h2> Przetwarzanie zbioru hase³ </h2></a>

Zbiór zawieraj±cy listê wszystkich hase³ nale¿y przetworzyæ programem
<strong>plmindex</strong>. W najprostszym przypadku linia wywo³ania programu wygl±da nastêpuj±co:
<pre>
<strong>plmindex</strong> <i>zbiór</i>
</pre>
Has³a definiowane w zbiorze <i>zbiór</i><code>.idx</code> zostan± 
pogrupowane (usuniête wielokrotne definicje na tej samej stronie)
oraz posortowane i zapisane do zbioru <i>zbiór</i><code>.ind</code>. 
W naszym przyk³adzie,
uporz±dkowany zbiór (rozszerzenie <code>.ind</code>)
bêdzie wygl±da³ nastêpuj±co:
<pre>
\begin{theindex}

  \item aqq, 1

  \indexspace

  \item bqq, 1

\end{theindex}
</pre>
Podczas powtórnego przetwarzania dokumentu pakietem LaTeX2e, powy¿szy zbiór
zostanie do³±czony w miejscu wyst±pienia polecenia <code>\printindex</code>.

<a name=poziomy><h3>Skorowidz wielopoziomowy</h3></a>

Program <strong>plmindex</strong> pozwala na zdefiniowanie trójpoziomowej 
struktury has³a.
Znakiem odzielaj±cym poziomy jest <code>!</code> (wykrzyknik). Przyk³adowe
polecenia:
<pre>
krowa\index{ssaki!parzysto-kopytne!krowa}
koñ\index{ssaki!nieparzysto-kopytne!koñ}
tapir\index{ssaki!nieparzysto-kopytne!tapir}
s± ssakami\index{ssaki}
</pre>
okre¶lenia: <code>parzysto-kopytne</code> i <code>nieparzysto-kopytne</code> 
s± has³ami podrzêdnymi has³a <code>ssaki</code> i samodzielnie
nie wyst±puj± (nie s± definiowane w sposób jawny). Nazwy <code>krowa</code>, 
<code>koñ</code> i <code>tapir</code>
stanowi± najni¿szy poziom.

<p>
Po przetworzeniu programem <strong>plmindex</strong> zbiór <code>.ind</code> wygl±da nastêpuj±co:
<pre>
\begin{theindex}

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

\end{theindex}
</pre>
Numery stron s± umieszczane tylko wtedy je¶li has³o jest wprowadzone
w <b>sposób jawny</b> do indeksu (np. 
has³o <code>parzysto-kopytne</code> zostanie utworzone automatycznie, 
i nie zostanie opatrzone numerem strony).

<p>Ostatecznie po wydrukowaniu powy¿szy fragment skorowidza wygl±da 
nastêpuj±co:
<img src="fig1.gif" align="middle">

<a name=kolejnosc><h3>Zmiana kolejno¶ci sortowania</h3></a>

Czasami zdarza siê, ¿e has³o powinno byæ umieszczone w innym miejscu
ni¿ wynika to z porz±dku leksykograficznego (np. polecenie
TeX-a poprzedzone znakiem <code>\</code> umieszczamy w miejscu 
wynikaj±cym z nazwy polecenia, ignoruj±c znak <code>\</code>). W tym wypadku
polecenie <code>\index</code> ma nastêpuj±c± skladniê:
<pre>
\index{has³o do sortowania@has³o do indeksu}
</pre>
okre¶lenie
<code>has³o do sortowania</code> s³u¿y programowi <strong>plmindex</strong> jako wzorzec do nadania
porz±dku leksykograficznego, natomiast <code>has³o do indeksu</code>
znajdzie siê w spisie. W przypadku hase³ wielopoziomowych
polecenie mo¿e wygl±daæ nastêpuj±co:
<pre>
\index{sort@index!sort-1@index-1!sort-2@index-2}
</pre>
Innym powodem u¿ycia tej konstrukcji mo¿e byæ chêæ zmiany kroju
pisma jakim sk³adane jest dane has³o (np. wyró¿nienie s³owa kluczowego):
<pre>
\index{alfa@{\itshape alfa}}
</pre>
Zbiór <code>.ind</code> wygl±da nastêpuj±co:
<pre>
\begin{theindex}

  \item {\itshape alfa}, 1

\end{theindex}
</pre>

<a name=odsylacze><h3>Odsy³acze w skorowidzu, efekty dodatkowe</h3></a>

Definiuj±c has³o skorowidza, mo¿emy w tym momencie zwróciæ
uwagê czytelnika na inne has³o, s³u¿y do tego operator
<i>encapsulacji</i>, którym jest znak <code>|</code>.<br>
Przyk³ad:
<pre>
\def\seename{p.}
\def\see#1#2{#2, ({\itshape \seename~#1}\/)}

aqq\index{aqq|see{bqq}}
</pre>
da nam nastêpuj±ce has³o w skorowidzu:
<pre>

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

</pre>
które w dokumencie wynikowym, bêdzie wygl±da³o nastêpuj±co:
<dl>
<dd>    aqq, 1, (<i>p. bqq</i>)
</dl>
£atwo widaæ, ¿e napis po znaku <code>|</code> jest traktowany
jako makropolecenie (jego argumentem aktualnym jest zawsze numer strony).
W przypadku konstrukcji <code>see</code> definiowany jest w³asny parametr
okre¶laj±cy has³o podobne -- parametr drugi (numer strony) jest pobierany
z listy parametrów aktualnych, ale nie jest wykorzystywany 
(w przeciwnym wypadku pojawi³by siê jako blok <code>{1}</code>.

<p>
Za pomoc± <i>enkapsulacji</i> 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:
<dl>
<dd><i>italic</i> has³o u¿ywane w przyk³adzie
<dd><b>bold</b> miejsce zdefniowania pojêcia
<dd> pozosta³e sk³adane czcionk± standardow±
</dl>
Przyk³ad:
<pre>
\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
</pre>
i rezultat:
<pre>

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

</pre>

<a name="grupowanie"><h3>Grupowanie numerów stron</h3></a>

U¿ywaj±c polecenia <code>\index</code> mo¿emy zadeklarowaæ, ¿e
dane has³o jest opisywane na kilku stronach. Pocz±tek
opisu has³a zaznaczamy:
<pre>
strona 1: aqq\index{aqq|(}
</pre>
a koñczymy
<pre>
strona 3: aqq\index{aqq|)}
</pre>
w wyniku dzia³ania programu <strong>plmindex</strong> i ponownego przetwarzania LaTeX-em
otrzymamy:
<pre>
    aqq, 1-3
</pre>
je¿eli miêdzy konstrukcj± 
<code>\index{...|(}</code>, a <code>\index...|)}</code>
pojawi siê normalna definicja tego samego has³a to zostanie
ona zignorowana (jako zawieraj±ca siê w zadanym zakresie). Je¿eli konstrukcja
zamykaj±ca nie wyst±pi, to ostatnia definicja has³a spe³ni t± rolê. 

<p>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 <strong>plmindex</strong> z opcj± <a href=#optr>
-r</a>, która wy³±czy standardowe grupowanie numerów stron.

<a name=znaki><h3>Znaki specjalne</h3></a>

W wy¿ej opisywanych konstrukcjach znaki <code>|</code>,
<code>|</code>,
<code>!</code> i
<code>@</code> mia³y znaczenie specjalne, je¿eli chcemy
w ha¶le skorowidza u¿yæ jednego z wy¿ej wymienionych znaków
nale¿y poprzedziæ go znakiem <code>"</code> np.

<pre>
aqq!aqq\index{aqq"!aqq}
</pre>
wprowadzi do skorowidza has³o:
<pre>
aqq!aqq, 1
</pre>

<a name=postac><h2>Definiowanie postaci skorowidza</h2></a>

Program <strong>plmindex</strong> porz±dkuj±c zbiór hase³ wstawia szereg 
poleceñ. Mo¿emy mieæ wp³yw zarówno na ich zestaw, jak  i na ich definicjê. 

W³a¶ciwo¶ci programu mo¿emy zmieniaæ na trzy sposoby:

<dl>
<dt> <a name=definicje><b>zmieniæ standardowe definicje u¿ywanych poleceñ 
(makroinstrukcji)</b></a>

<dd>Program <strong>plmindex</strong> zanurza zbiór posortowanych i posegregowanych hase³
w ¶rodowisku <code>index</code>. U¿ycie ¶rodowiska powoduje
zdefiniowanie podrozdzia³u o nazwie zdefiniowanej przez makroinstrukcjê
<code>\indexname</code>. Standardowo warto¶ci± polecenia
jest napis <code>Index</code>, je¿eli chcemy zmieniæ napis
nale¿y zmieniæ definicjê tego polecenia np:
<pre>
\renewcommand\indexname{Skorowidz}
</pre>
Do definiowania sposobu prezentacji hase³ na ró¿nych
poziomach u¿ywane s± nastêpuj±ce makroinstrukcje:<br>
</dl>
<table border>
<tr> <th>poziom</th> <th> nazwa</th> <th>standardowa definicja</th> </tr>
<tr> <td>1</td> <td>\item</td> <td>\par\hangindent 40\p@</td></tr>
<tr> <td>2</td> <td>\subitem</td> <td>\par\hangindent 40\p@ \hspace*{20\p@}</td></tr>
<tr> <td>3</td> <td>\subsubitem</td> <td>\par\hangindent 40\p@ \hspace*{30\p@}</td></tr>
</table><br>
<dl>
<dd>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:<br>
<code>\indexspace</code> o warto¶ci<br>
<code>\par\vskip10\p@ \@plus5\p@ \@minus 3\p@\relax</code><p>

<dt> <a name=styl><b>zmieniæ zestaw poleceñ (makroinstrukcji)</b></a>
<dd>
Mo¿emy utworzyæ specjalny zbiór zawieraj±cy szereg poleceñ
steruj±cych programem <strong>plmindex</strong>. Program <strong>plmindex</strong> wczytuje ten zbiór
je¿eli jest zdefiniowana opcja <code>-s</code> (p. <a href=#style>opcje</a>);
standardowym rozszerzeniem nazwy jest <code>.mst</code>.
W zbiorze tym mo¿na zdefiniowaæ nastêpuj±ce warto¶ci:<p>
</dl>
<table border>
<tr><th>Nazwa</th><th>Warto¶æ standardowa</th><th>Opis</th></tr>
<tr><td nowrap><code>preamble</code> <i>string</i>        </td>
		<td nowrap>"\\begin{theindex}\n"		</td>
			<td>pocz±tek zbioru</td></tr>
<tr><td nowrap><code>postamble</code> <i>string</i>       </td>
		<td nowrap>"\n\n\\end{theindex}\n"	</td>
			<td>koniec zbioru</td></tr>
<tr><td nowrap><code>setpage_prefix</code> <i>string</i>  </td>
		<td nowrap>"\n  \\setcounter{page}{" 	</td>
			<td>pocz±tek polecenia
 							definiuj±cy
 							zmianê warto¶ci numeru
							strony</td></tr>
<tr><td nowrap><code>setpage_suffix</code> <i>string</i>  </td>
		<td nowrap>"}\n"				</td>
			<td>koniec definicji 
 							polecenia zmiany
							numeru strony</td></tr>
<tr><td nowrap><code>group_skip</code> <i>string</i>      </td>
		<td nowrap>"\n\n  \\indexspace\n"</td>
			  <td> polecenie wstawiane przed rozpoczêciem
			  grupy hase³</td></tr>
<tr><td nowrap><code>headings_flag</code> <i>string</i>   </td>
		<td nowrap>0				</td>
			<td>flaga aktywuj±ca
 							wstawianie poleceñ
							przy zmianie
							pierwszego znaku 
							hase³, warto¶æ
							pozytywna (&gt;0)
							wstawiany bêdzie
							znak w postaci du¿ej
							litery, je¶li &lt;0
							znak ma³ej litery</td></tr>
<tr><td nowrap><code>heading_prefix</code> <i>string</i>  </td>
		<td nowrap>""				</td>
			<td>ci±g znaków, który
 							bêdzie poprzedza³
							w.m. znak</td></tr>
<tr><td nowrap><code>symhead_positive</code> <i>string</i> </td>
		<td nowrap>"Symbols"			</td>
			<td>nazwa grupy
 							hase³ nie zaczynaj±cych
							siê liter± (wstawiany
							je¶li flaga &gt;0)</td></tr>
<tr><td nowrap><code>symhead_negative</code> <i>string</i> </td>
		<td nowrap>"symbols"			</td>
			<td>nazwa grupy
 							hase³ nie zaczynaj±cych
							siê liter± (wstawiany
							je¶li flaga &lt;0)</td></tr>
<tr><td nowrap><code>numhead_positive</code> <i>string</i> </td>
		<td nowrap>"Numbers"			</td>
			<td>nazwa grupy
 							hase³ zaczynaj±cych
							siê cyfr± (wstawiany
							je¶li flaga &lt;0)</td></tr>
<tr><td nowrap><code>numhead_negative</code> <i>string</i> </td>
		<td nowrap>"numbers"			</td>
			<td>nazwa grupy
 							hase³ zaczynaj±cych
							siê cyfr± (wstawiany
							je¶li flaga &lt;0)</td></tr>
<tr><td nowrap><code>item_0</code> <i>string</i>          </td>
		<td nowrap>"\n  \\item "		</td>
			<td>polecenie wstawiane
 						miêdzy dwie pozycje
						na poziomie 0</td></tr>

<tr><td nowrap><code>item_1</code> <i>string</i>          </td>
		<td nowrap>"\n     \\subitem "	</td>
			<td>polecenie wstawiane miêdzy dwie
 						pozycje na poziomie 1</td></tr>

<tr><td nowrap><code>item_2</code> <i>string</i>          </td>
		<td nowrap>"\n       \\subsubitem " </td>
			<td>polecenie wstawiane
 						   miêdzy dwie pozycje
						   na poziomie 2</td></tr>
<tr><td nowrap><code>item_01</code> <i>string</i>        </td>
		<td nowrap>"\n    \\subitem "	   </td>
			<td>polecenie wstawiane miêdzy
 						   pozycje poziomu 0 i 1</td></tr>
<tr><td nowrap><code>item_x1</code> <i>string</i>         </td>
		<td nowrap>"\n    \\subitem "	   </td>
			<td>polecenie wstawiane miêdzy
 						   pozycje poziomu 0 i 1, 
						   je¶li pozycja poziomu 0
						   nie wyst±pi³a w sposób
						   jawny (nie bêdzie opatrzona
						   numerem strony)</td></tr>
<tr><td nowrap><code>item_12</code> <i>string</i>         </td>
		<td nowrap>"\n    \\subsubitem "	   </td>
			<td>polecenie wstawiane miêdzy
 						   pozycje poziomu 1 i 2</td></tr>
<tr><td nowrap><code>item_x2</code> <i>string</i>         </td>
		<td nowrap>"\n    \\subsubitem "	   </td>
			<td>polecenie wstawiane miêdzy
 						   pozycje poziomu 1 i 2
						   je¶li pozycja poziomu 1
						   nie wyst±pi³a w sposób
						   jawny (nie bêdzie opatrzona
						   numerem strony)</td></tr>
<tr><td nowrap><code>delim_0</code> <i>string</i>         </td>
		<td nowrap>", "			   </td>
			<td>separator miêdzy has³em
 						   poziomu 0,
 						   a pierwszym numerem strony</td></tr>
<tr><td nowrap><code>delim_1</code> <i>string</i>         </td>
		<td nowrap>", "			   </td>
			<td>separator miêdzy has³em
 						   poziomu 1, a pierwszym
						   numerem strony</td></tr>
<tr><td nowrap><code>delim_2</code> <i>string</i>         </td>
		<td nowrap>", "			   </td>
			<td>separator miêdzy has³em
 						   poziomu 2, a pierwszym
						   numerem strony</td></tr>
<tr><td nowrap><code>delim_n</code> <i>string</i>         </td>
		<td nowrap>", "			   </td>
			<td>separator miêdzy 
 						   kolejnymi numerami stron
						   (wszystkie poziomy hase³)</td></tr>
<tr><td nowrap><code>delim_r</code> <i>string</i>         </td>
		<td nowrap>"--"			   </td>
			<td>separator odzielaj±cy
            					   numery zakresów stron
						   wystêpowania has³a</td></tr>
<tr><td nowrap><code>delim_t</code> <i>string</i>         </td>
		<td nowrap>""			   </td>
			<td>ci±g znaków umieszczany
 						   na koñcu listy numerów
						   stron</td></tr>
<tr><td nowrap><code>encap_prefix</code> <i>string</i>    </td>
		<td nowrap>"\\"			   </td>
			<td>pierwsza czê¶æ ci±gu
 						   znaków wstawiana 
						   przy u¿ywaniu
						   znaku steruj±cego 
						   enkapsulacji
						   (<code>|</code>)</td></tr>
<tr><td nowrap><code>encap_infix</code> <i>string</i>     </td>
		<td nowrap>"{"		</td>
			<td>druga czê¶æ
 						   znaków wstawiana 
						   przy u¿ywaniu
						   znaku steruj±cego 
						   enkapsulacji
						   (<code>|</code>)</td></tr>
<tr><td nowrap><code>encap_suffix</code> <i>string</i>    </td>
		<td nowrap>"}"		</td>
			<td>ci±g znaków zamykaj±cy
 					polecenie enkapsulacji</td></tr>
<tr><td nowrap><code>line_max</code> <i>number</i>        </td>
		<td nowrap>72		</td>
			<td>maksymalna liczba znakow w linii
 					(je¶li definicja has³a bêdzie
					 d³u¿sza, zostanie przeniesiona do 
					 nastêpnej linii)</td></tr>
<tr><td nowrap><code>indent_space</code> <i>string</i>    </td>
		<td nowrap>"\t\t"	</td>
			<td>ci±g znaków wstawiany na pocz±tku
 					,,³amanej linii''</td></tr>
<tr><td nowrap><code>indent_length</code> <i>number</i>   </td>
		<td nowrap>16		</td>
			<td>okre¶lenie szeroko¶ci w.m.
					 ci±gu znaków (potrzebne do
					 prowadzenia pozycji w bie¿±cej
					 linii</td></tr>
</table>
<dl>
<p>Przyk³ad:
Zawatro¶æ zbioru <code>.mst</code>
<pre>
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"
</pre>
daje nastêpuj±cy efekt:
<pre>
\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}
</pre>
makroinstrukcja <code>\bold</code> zosta³a zdefiniowana jako:<br>
<code>\def\bold#1{{\bfseries #1}}</code><p>


<dt> <a name=opcje><b>zmieniæ sposób dzia³ania programu <strong>plmindex</strong> definiuj±c parametry
	wywo³ania (opcje)</b></a>
<dd>
Program <strong>plmindex</strong> posiada szereg parametrów wywo³ania. Ogólna 
postaæ wygl±da nastêpuj±co:
<pre>
<strong>plmindex</strong> [&lt;opt&gt;] [&lt;idx0&gt; ...]
</pre>
<code>&lt;opt&gt;</code> mog± przyjmowaæ jedn± z nastêpuj±cych warto¶ci:<p>
</dl>
<table border>
<tr> <th> opcja</th> <th> opis</th> </tr>
<tr><td> -l </td><td> podczas sortowania ignoruj spacje miêdzy s³owami has³a;
			np. has³o <code>aqq bqq</code> zostanie potraktowane
			tak jak  <code>aqqbqq</code>
			</td></tr>
<tr><td> -i </td><td> jako zbioru hase³ u¿yj standardowego strumienia (stdin)
			</td></tr>
<tr><td> -q </td><td> nie wy¶wietlaj komunikatów
			</td></tr>
<tr><td> <a name="optr">-r</a> </td><td> nie grupuj numerów stron; np. 
			je¿eli has³o wyst±pi
		    na stronie 1, 2 i 3 to w skorowidzu
		    <b>nie zostanie</b> to przedstawione jako 1-3, natomiast
		    has³a grupowane w sposób jawny (p. <a href=#grupowanie>
			grupowanie numerów stron</a>), bêd± mia³y pogrupowane
			numery stron
			</td></tr>
<tr><td> -c </td><td> ci±g spacji i tabulatorów jest zamieniany na 
		jedn± spacjê
			</td></tr>
<tr><td nowrap> <a name=optL>-L</a> <i>lang</i> </td><td> wybór jêzyka, determinuj±cego porz±dek
                                leksykograficzny
				<table border=0>
				<tr><td><i>lang</i> </td><td> <code>english</code></td></tr>
				<tr><td> </td><td> <code>PL-latin2</code></td></tr>
			        <tr><td> </td><td> <code>PL-mazowia</code></td></tr>
			        <tr><td> </td><td> <code>PL-cp1250</code></td></tr>
			        <tr><td> </td><td> <code>PL-cp852</code></td></tr>
				</table><td></tr>
<tr><td nowrap> -s <i>sty</i>  </td><td> 
<a name="style">nazwa zbioru</a> definicji (standardowe rozszerzenie
					<code>.mst</code>)
								</td></tr>
<tr><td nowrap> -o <i>ind</i>  </td><td> nazwa zbiory wyj¶ciowego (standardowo taka
					jak zbiór wej¶ciowy z
					rozszerzeniem <code>.ind</code>)
								</td></tr>
<tr><td> -? <br>-h  </td><td> wy¶wietlenie listy opcji</td></tr>
<tr><td> <a name=optw>-! </td><td> opcja procedur specjalnych (zale¿y od 
		    wybranego jêzyka; dla jêzyka polskiego
		    oznacza, ¿e liczby (cyfry) bêda umieszczane
		    w miejscu wynikaj±cym z napisu reprezentuj±cego
		    ich warto¶ci; np. cyfra 1 zostanie potraktowana
		    tak jak napis <code>jeden</code>) (czywi¶cie
		    mo¿na wymusiæ inn± <a href=#kolejnosc>kolejno¶æ</a>
			sortowania)</td></tr>
<tr><td nowrap> -t <i>log</i>  </td><td> <i>log</i> zbiór zawieraj±cy
			dodatkowe komunikaty (standardowo nazwa taka jak
					zbiór wej¶ciowy z  rozszerzeniem 
					<code>.ilg</code>)
								</td></tr>
<tr><td nowrap> -p <i>num</i>  </td><td> <i>num</i> 
			pocz±tkowa warto¶æ licznika stron<br>
</table>
<dl>
<dd>&lt;idx0&gt; - zbiór hase³ (standardowe rozszerzenie <code>.idx</code>)<br>
</dl>

<hr>
<em>Opracowa³: W³odzimierz Macewicz; zmiany 05.05.2014 (StaW)</em>
<hr>
</body>
</html>