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
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!--Copyright C 1999, 2000, 2001, 2002, 2003
Free Software Foundation, Inc.
Portions of texi2html
Copyright C 1999, 2000 Lionel Cons
Copyright C 1999, 2000 Karl Berry
Copyright C 1999, 2000 Olaf Bachmann
Copyright C 2002, 2003 Patrice Dumas
Copyright C 2001, 2002, 2003 Derek Price
Copyright C many others.
Portions of this manual
Copyright C 1999, 2000 Karl Heinz Marbaise (manual)
Copyright C 2003 Patrice Dumas (manual)
Copyright C 2003 Derek Price (manual)
Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and
this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified
versions of this manual under the conditions for verbatim
copying, provided that the entire resulting derived work is
distributed under the terms of a permission notice
identical to this one.
Permission is granted to copy and distribute translations
of this manual into another language, under the above
conditions for modified versions, except that this
permission notice may be stated in a translation approved
by the Free Software Foundation.
-->
<!-- Created on February, 3 2005 by texi2html 1.76 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people <dev@texi2html.cvshome.org>
Send bugs and suggestions to <users@texi2html.cvshome.org>
-->
<head>
<title>Texi2HTML - Texinfo to HTML v1.76: Texi2HTML</title>
<meta name="description" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML">
<meta name="keywords" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.76">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="settitle">Texi2HTML</h1>
<p>Copyright © 1999, 2000, 2001, 2002, 2003
Free Software Foundation, Inc.
</p>
<table>
<tr><td><p> Portions of <code>texi2html</code>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 1999, 2000 Lionel Cons<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Berry<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 1999, 2000 Olaf Bachmann<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 2002, 2003 Patrice Dumas<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 2001, 2002, 2003 Derek Price<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © many others.<br>
</p></td></tr>
<tr><td> </td><td>
</td></tr>
<tr><td> </td><td>
</td></tr>
<tr><td><p> Portions of this manual
</p></td></tr>
<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Heinz Marbaise (manual)<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 2003 Patrice Dumas (manual)<br>
</p></td></tr>
<tr><td> </td><td><p> Copyright © 2003 Derek Price (manual)<br>
</p></td></tr>
</table>
<p>Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and
this permission notice are preserved on all copies.
</p>
<p>Permission is granted to copy and distribute modified
versions of this manual under the conditions for verbatim
copying, provided that the entire resulting derived work is
distributed under the terms of a permission notice
identical to this one.
</p>
<p>Permission is granted to copy and distribute translations
of this manual into another language, under the above
conditions for modified versions, except that this
permission notice may be stated in a translation approved
by the Free Software Foundation.
</p>
<a name="Top"></a>
<a name="SEC_Top"></a>
<p>This manual, last updated 1 February 2005, describes version 1.76
of the <code>texi2html</code> Perl script which converts
<a href="http://www.texinfo.org">Texinfo</a> into <a href="http://w3c.org">HTML</a>.
</p>
<p>Please send bug reports concerning this manual to the Texi2HTML user
discussion list <a href="mailto:user@texi2html.cvshome.org">user@texi2html.cvshome.org</a>. Please state the exact
version of the manual which contains the bug, as given above.
</p>
<table><tr><td> </td><td><pre class="example"><strong>This manual is currently under construction and of course incomplete. ;-)</strong>
</pre></td></tr></table>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC1">1. Overview</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td><td> </td><td align="left" valign="top">
Obtaining a copy of the <code>texi2html</code>
source code distribution
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> Installing <code>texi2html</code>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> Description of the command line options
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC14">5. Overview of initialization files content and loading</a></td><td> </td><td align="left" valign="top"> What kind of variables and subroutines appear
in init files and how they are called
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC17">6. Fine tuning of the page layout</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a></td><td> </td><td align="left" valign="top"> Fine tuning of the <acronym>HTML</acronym> elements
associated with the texinfo constructs
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC84">A. Internationalization</a></td><td> </td><td align="left" valign="top"> Help translating !
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC87">B. Command Line Option Index</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC88">C. Variable Index</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC89">D. Concept Index</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr></table>
<hr size="1">
<a name="Overview"></a>
<a name="SEC1"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC2" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[ << ]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 1. Overview </h1>
<p><a href="http://www.texinfo.org">Texinfo</a> is the official
documentation format of the <a href="http://www.gnu.org">GNU</a>
project. It uses a single source file to produce both
online information and printed output.
</p>
<p>It is often desirable to have a way to produce
<acronym>HTML</acronym> from Texinfo sources, as GNU-Info files are
produced. It is much simpler to run a converter than it is to
rewrite all the documentation in <acronym>HTML</acronym>, especially
considering that there is so much Texinfo documentation in
the world.
</p>
<p>Some time ago <code>makeinfo</code> wasn't able to produce
<acronym>HTML</acronym> output format, but people still wanted documentation in
<acronym>HTML</acronym>. This was the birthing hour for
<code>texi2html</code>. The basic purpose of <code>texi2html</code>
is to convert Texinfo documents into <acronym>HTML</acronym>.
</p>
<p>Since then, <acronym>HTML</acronym> support in <code>makeinfo</code> has improved, but
<code>texi2html</code> is still stronger in many areas, including the degree to
which it allows customization. With <code>texi2html</code>, some important
aspects of the resulting <acronym>HTML</acronym> files may be specified via command
line options, and configuration files provide an even finer degree of control
over the final output, allowing most every aspect of the final output not
specified in the Texinfo input file to be specified. Configuration files are
written in <code>perl</code>, like the main program, and anything which may be
specified on the command line may also be specified within a configuration
file.
</p>
<p>For an example of the kind of pages <code>texi2html</code> is capable of
producing, have a look at the following sites:
<a href="http://www.singular.uni-kl.de/Manual/html/">the Singular Manual</a>,
<a href="http://ccvs.cvshome.org/docs/manual">the Cederqvist (CVS Manual)</a>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
<hr size="6">
<a name="whytexi2html"></a>
<a name="SEC2"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC1" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 1.1 Why <code>texi2html</code> and not <code>makeinfo</code>? </h2>
<p>You would like to produce <acronym>HTML</acronym> files from your existing Texinfo
files? There are two programs you can use to do this. The first is
<code>makeinfo</code> (see <a href="texinfo.html#Generating-HTML">(texinfo)Generating HTML</a>).
The second is <code>texi2html</code>.
</p>
<p>The design goal of <code>makeinfo</code>'s <acronym>HTML</acronym> output was to produce
readable <acronym>HTML</acronym> output. It is now possible to use <acronym>CSS</acronym>
for <acronym>HTML</acronym> customization. Another possibility is to use intermediate
formats, like docbook or <code>mekeinfo</code> <acronym>XML</acronym>
and <acronym>XSL</acronym> stylesheets to customize the resulting document. Still the
output produced by <code>makeinfo</code> isn't customizable.
</p>
<p>The current development of <code>texi2html</code> tries to
provide for producing the more interesting and sophisticated <acronym>HTML</acronym>
pages that today's Internet users have come to expect.
The goal behind <code>texi2html</code> is to generate attractive <acronym>HTML</acronym> by
default but also to allow users considerable freedom to affect the final
style and design of the output <acronym>HTML</acronym> pages. This is achieved via
command line options and flexible configuration files.
</p>
<p>In contrast to the <acronym>HTML</acronym> produced by <code>makeinfo --html</code> (the
<code>makeinfo</code> program is part of the Texinfo distribution), the
<code>texi2html</code> program, among other differences, allows for the
customization of the entire page layout, including headers, footers, style
sheets, etc., allows for customization of the low level <acronym>HTML</acronym>
formatting, provides for splitting documents at various levels, and provides
for using the <code>latex2html</code> program to convert <code>@tex</code> sections of
the Texinfo source.
</p>
<p>The focus on <acronym>HTML</acronym> is still present but with the help of the
customization files it is now possible to use <code>texi2html</code> to
produce other formats as well. <code>texi2html</code> may for example be
turned into a texinfo to roff translator with the help of a customization file
provided with the distribution.
</p>
<p><code>texi2html</code> should reasonably convert all Texinfo
4.8 constructs. If you find it does not, please send a bug report to the
<a href="mailto:users@texi2html.cvshome.org">users@texi2html.cvshome.org</a> email list.
</p>
<hr size="6">
<a name="Obtaining-texi2html"></a>
<a name="SEC3"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC2" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC4" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC4" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 2. Obtaining <code>texi2html</code> </h1>
<p>The latest version of the source code for <code>texi2html</code> should be
available from <a href="http://texi2html.cvshome.org">texi2html.cvshome.org</a>.
</p>
<hr size="6">
<a name="Installation"></a>
<a name="SEC4"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC3" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 3. Installation of <code>texi2html</code> </h1>
<p>To install <code>texi2html</code>, you must first obtain a copy of the
source distribution. See section <a href="#SEC3">Obtaining <code>texi2html</code></a>.
</p>
<p><code>texi2html</code> also requires <code>perl</code> version
5.004 or above. The current version has not been tested
extensively on versions of <code>perl</code> below 5.6, however.
</p>
<p><code>texi2html</code> is a standard Automake-based distribution.
If you have a source version, you should run <code>./configure</code>
to regenerate the executable <tt>`texi2html'</tt> file. <code>./configure</code>
accepts options to select the installation directory for the <tt>`texi2html'</tt>
file, the default directories <code>texi2html</code> will use to look for
configuration files, and other details. Run <code>./configure --help</code> for
more information.
</p>
<p>Running <code>./configure</code> combines four files into the final
<tt>`texi2html'</tt> program file:
</p><ul class="toc">
<li> <tt>`texi2html.pl'</tt> contains the base program,
</li><li> <tt>`MySimple.pm'</tt> handles the command line options,
</li><li> <tt>`texi2html.init'</tt> is the default configuration file, and
</li><li> <tt>`T2h_i18n.pm'</tt> is used for internationalization.
</li><li> <tt>`translations.pl'</tt> contains the translations of the strings used in
documents.
</li></ul>
<p>Running <code>./configure</code> also builds the <code>make</code> configuration
files (<tt>`Makefile'</tt>s). To make the documentation run <code>make</code>.
</p>
<p><code>make install</code> performs the installation to the locations specified to
the <code>./configure</code> script. This usually involves placing the actual
<tt>`texi2html'</tt> file someplace in your path, such as <tt>`/usr/local/bin'</tt> or
<tt>`/usr/bin'</tt>.
</p>
<p>Installing <code>texi2html</code> in your path should be sufficient
to run it. To use default initialization files, or a configuration file for
LaTeX2HTML when using <code>latex2html</code> to convert <code>@tex</code> sections
(see section <a href="#SEC12">Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a>), install them in the package data directory
specified to configure. This is <tt>`/usr/local/share/texi2html/'</tt> by default,
but depends on the value of the <a name="IDX1"></a>
<samp>`--pkgdatadir=<var>dir</var>'</samp> option passed to
the <code>./configure</code> script. Files used for strings customization and
internationalization are also searched for in the <tt>`i18n'</tt> directory
of this directory. See section <a href="#SEC13">Use initialization files for fine tuning</a> for more.
</p>
<hr size="6">
<a name="Invoking-texi2html"></a>
<a name="SEC5"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC4" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC6" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC4" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 4. Invoking <code>texi2html</code> </h1>
<p>To produce an <acronym>HTML</acronym> manual, run <code>texi2html</code> with a Texinfo
file as an argument. For example, this manual is created with:
</p>
<table><tr><td> </td><td><pre class="example">$ texi2html texi2html.texi
</pre></td></tr></table>
<p>The behaviour of <code>texi2html</code> may be changed with command line
options. These command line options are always associated with corresponding
<code>perl</code> variables which may appear in init files, and these
variables are presented in this chapter each time a switch is described.
</p>
<p>Boolean command line switches always have a corresponding negated switch,
obtained by prepending <samp>`no'</samp> or <samp>`no-'</samp> to the switch name. For example
<a name="IDX2"></a>
<samp>`--nomenu'</samp> does the reverse of <a name="IDX3"></a>
<samp>`--menu'</samp>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td><td> </td><td align="left" valign="top"> The <acronym>HTML</acronym> output may be split at
different levels
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td><td> </td><td align="left" valign="top"> Customizing page layout
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td><td> </td><td align="left" valign="top"> Specifying initialization files for fine tuning
</td></tr>
</table>
<hr size="6">
<a name="Splitting-output"></a>
<a name="SEC6"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC5" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC7" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.1 Specifying where to split the generated document </h2>
<p>The <acronym>HTML</acronym> manual resulting from the processing of the Texinfo source
may be split into files at different levels. This is specified with the
option <a name="IDX4"></a>
<samp>`--split'</samp> which takes an argument, namely the level of splitting
(variable: <a name="IDX5"></a>
<code>$SPLIT</code>). This level may be:
</p>
<dl compact="compact">
<dt> <samp>`chapter'</samp></dt>
<dd><p>The document is split at <code>@chapter</code>, <code>@appendix</code>, or <code>@unnumbered</code>.
</p></dd>
<dt> <samp>`section'</samp></dt>
<dd><p>The document is split at the same places as it is using the <samp>`chapter'</samp>
argument, and also at <code>@section</code>, <code>@appendixsec</code> or
<code>@unnumberedsec</code>.
</p></dd>
<dt> <samp>`node'</samp></dt>
<dd><p>The document is split at every sectioning command. It is not necessarily
split at each node, if the <code>@node</code> structure doesn't correspond with
the sectioning command structure (see below).
</p></dd>
<dt> <samp>`none'</samp></dt>
<dd><p>The document isn't split. This is the default.
</p></dd>
</dl>
<p>There are two kinds of commands which may be used to define sectioning
elements in Texinfo: <code>@node</code> and the structuring commands (<code>@top</code>,
<code>@section</code>, <code>@appendixsubsec</code>, and so on). A node just preceding
a structuring command is considered to be part of the same sectioning element
as that command. If the <code>@node Top</code> isn't associated with a structuring
command it also defines a sectioning element.
</p>
<p>By default, nodes which aren't associated with a structuring command are not
considered to be sectioning commands. They are always considered to be part
of a sectioning element defined by a structuring command. It is possible to
change this behaviour via the <a name="IDX6"></a>
<samp>`--use-nodes'</samp> option (variable
<a name="IDX7"></a>
<code>$USE_NODES</code>). In this case, nodes not associated with structuring
commands are also considered to be sectioning commands defining a sectioning
element.
</p>
<p>This default behaviour mimics <code>texi2dvi</code> behaviour, which ignores
<code>@node</code> commands for the purprose of sectioning, while the second
looks like <code>makeinfo</code> behaviour (see <a href="texinfo.html#Two-Paths">(texinfo)Two Paths</a>).
</p>
<p>As an illustration, the following table shows how a sample Texinfo document is
divided into sectioning elements when <a name="IDX8"></a>
<samp>`--use-nodes'</samp> is used and not:
</p>
<table>
<tr><td><p> Texinfo code
</p></td><td>
</td><td>
<p>default case
</p></td><td>
</td><td>
<p>with <a name="IDX9"></a>
<samp>`--use-nodes'</samp>
</p></td></tr>
<tr><td>
<br>
<br>
<table><tr><td> </td><td><pre class="example">@node node1
@chapter node 1
node1 text
@node node2
node2 text
@node node3
node3 text
@chapter node 3
chapter text
</pre></td></tr></table></td><td>
</td><td>
<p>first element:
</p>
<table><tr><td> </td><td><pre class="example">@node node1
@chapter node 1
node1 text
@node node2
node2 text
</pre></td></tr></table>
<p>second element:
</p>
<table><tr><td> </td><td><pre class="example">@node node3
node3 text
@chapter node 3
chapter text
</pre></td></tr></table>
</td><td>
</td><td>
<p>first element:
</p>
<table><tr><td> </td><td><pre class="example">@node node1
@chapter node 1
node1 text
</pre></td></tr></table>
<p>second element:
</p>
<table><tr><td> </td><td><pre class="example">@node node2
node2 text
</pre></td></tr></table>
<p>third element:
</p>
<table><tr><td> </td><td><pre class="example">@node node3
node3 text
@chapter node 3
chapter text
</pre></td></tr></table>
</td></tr>
</table>
<hr size="6">
<a name="Output-files"></a>
<a name="SEC7"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC6" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC8" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.2 Setting output file and directory names </h2>
<p>The manual name is constructed by stripping the <samp>`.texi'</samp>,
<samp>`.txi'</samp>, <samp>`.texinfo'</samp>, or <samp>`.txinfo'</samp> extension from the Texinfo file
name.
</p>
<p>By default, <code>texi2html</code> generates the manual file in the current
directory if the manual isn't split. A <samp>`.html'</samp> file extension is appended
to the manual name.
</p>
<p>If the manual is split the files are put in a directory named after the
manual name. The file name is constructed using the manual name as basename.
An underscore followed by a number is appended
to the basename for each files corresponding with sectioning elements, with the
exception of the top element. For the top element there nothing appended.
The files containing special elements pages
have an underscore and a 3 letter code corresponding to their content
(<samp>`toc'</samp> for table of contents, <samp>`abt'</samp> for about, <samp>`ovr'</samp> for
overview) appended. Lastly, an <samp>`.html'</samp> file extension is appended.
</p>
<p>Thus, if the texinfo file <tt>`afile.texi'</tt> is processed and split at chapters
into 3 files, the generated files (in directory <tt>`afile'</tt>) will be:
</p>
<table><tr><td> </td><td><pre class="example">afile.html --> <code>@node Top</code> or <code>@top</code> section
afile_1.html --> Chapter 1
afile_2.html --> Chapter 2
afile_toc.html --> Table of Contents
afile_abt.html --> About Page
</pre></td></tr></table>
<p>This default behavior may be modified by several command line options. If the
output isn't split, the prefix file name may be overrided by the
<a name="IDX10"></a>
<samp>`--output'</samp> command line option (variable <a name="IDX11"></a>
<code>$OUT</code>). If the output
is split, and <a name="IDX12"></a>
<samp>`--output'</samp> is set, the files are placed in the directory
specified by the argument to the option.
</p>
<p>The basename may be overridden with <a name="IDX13"></a>
<samp>`--prefix'</samp> (variable
<a name="IDX14"></a>
<code>$PREFIX</code>). If <a name="IDX15"></a>
<samp>`--short-ext'</samp> is given, <samp>`.htm'</samp> is appended
instead of <samp>`.html'</samp> in the final step (variable <a name="IDX16"></a>
<code>$SHORTEXTN</code>).
The <a name="IDX17"></a>
<samp>`--top-file'</samp> option
overrides the top element file name (variable <a name="IDX18"></a>
<code>$TOP_FILE</code>). This can
be used to name the top element file <samp>`index.html'</samp>. Similarly,
<a name="IDX19"></a>
<samp>`--toc-file'</samp> changes the name of the table of contents file (variable
<a name="IDX20"></a>
<code>$TOC_FILE</code>).
</p>
<p>Reusing the example above, but this time calling <code>texi2html</code> like so:
</p>
<table><tr><td> </td><td><pre class="example">$ texi2html -split chapter -prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi
</pre></td></tr></table>
<p>we get, in <tt>`manual'</tt>:
</p>
<table><tr><td> </td><td><pre class="example">index.htm --> <code>@node Top</code> or <code>@top</code> section
manual_1.htm --> Chapter 1
manual_2.htm --> Chapter 2
contents.htm --> Table of Contents
manual_abt.htm --> About Page
</pre></td></tr></table>
<p>The file names generated by <code>texi2html</code> differ from those generated
by <code>makeinfo</code>. <code>makeinfo</code> uses the node name to construct
the file names while splitting at nodes. It is possible to get the same
behaviour out of <code>texi2html</code> by specifying the
<a name="IDX21"></a>
<samp>`--node-files'</samp> option (variable <a name="IDX22"></a>
<code>$NODE_FILES</code>). If the output
isn't split at nodes, <code>texi2html</code> will still output files named after
the nodes, without real content but redirecting to the right file.
The default is false for this option.
This trick enables the generated <acronym>HTML</acronym> manual to be a
target for the cross-references of other manuals generated by
<code>makeinfo</code> or <code>texi2html</code>.
</p>
<hr size="6">
<a name="Expansion"></a>
<a name="SEC8"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC7" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC9" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.3 Specifying which regions get expanded </h2>
<p>The default for <code>texi2html</code> is to expand the <code>@ifhtml</code>,
<code>@html</code>, and <code>@menu</code> regions, all the <code>@ifnot</code> regions
except <code>@ifnothtml</code>, and no other <code>@if</code> regions.
</p>
<p>It is possible to expand other regions by setting <a name="IDX23"></a>
<samp>`--if<region>'</samp>,
where <samp>`<region>'</samp> is replaced by the literal name of the region (for
example, <samp>`--iftex'</samp>). Symetrically, if <a name="IDX24"></a>
<samp>`--no-if<region>'</samp> is
specified, the <samp>`<region>'</samp> region is ignored. The configuration file
array, <a name="IDX25"></a>
<code>@EXPAND</code>, holds the names of regions which should be
expanded. The only region name present in <code>@EXPAND</code> in the default case
is <samp>`html'</samp>.
</p>
<p>If <a name="IDX26"></a>
<samp>`--nomenu'</samp> is set, the <code>@menu</code> sections are not expanded
(variable <a name="IDX27"></a>
<code>$SHOW_MENU</code>). The default is to expand <code>@menu</code>
sections.
</p>
<hr size="6">
<a name="Texinfo-related-options"></a>
<a name="SEC9"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC8" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.4 Command line options related to Texinfo language features </h2>
<p>Miscalleneous Texinfo related things may be specified via command line options.
</p>
<dl compact="compact">
<dt> <a name="IDX28"></a>
<p><samp>`--lang=<var>lang</var>'</samp>
</p></dt>
<dd><p>Sets the document language similar to the Texinfo directive,
<code>@documentlanguage <var>lang</var></code> (variable <a name="IDX29"></a>
<code>$LANG</code>).
The default is <samp>`en'</samp>, that is, use the english language strings.
</p></dd>
<dt> <a name="IDX30"></a>
<p><samp>`-D<var>var</var>'</samp>
</p></dt>
<dd><p>Sets <var>var</var>. Equivalent to, <code>@set <var>var</var> 1</code>, in Texinfo.
</p></dd>
<dt> <a name="IDX31"></a>
<p><samp>`-U<var>var</var>'</samp>
</p></dt>
<dd><p>Clears <var>var</var>. Equivalent to, <code>@clear <var>var</var></code>, in Texinfo.
</p></dd>
<dt> <a name="IDX32"></a>
<p><samp>`-P<var>dir</var>'</samp>
</p></dt>
<dd><p>Prepend <var>dir</var> to the list of directories to search for
<code>@include</code> files (the associated array is <a name="IDX33"></a>
<code>@PREPEND_DIRS</code>,
empty in the default case).
</p></dd>
<dt> <a name="IDX34"></a>
<p><samp>`-I<var>dir</var>'</samp>
</p></dt>
<dd><p>Append <var>dir</var> to the list of directories to search for
<code>@include</code> files (the associated array is <a name="IDX35"></a>
<code>@INCLUDE_DIRS</code>,
empty in the default case).
</p></dd>
</dl>
<p>The include files are always searched for in the current directory.
</p>
<hr size="6">
<a name="Page-layout-options"></a>
<a name="SEC10"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC9" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC11" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.5 Page layout related command line options </h2>
<p>If the <a name="IDX36"></a>
<samp>`--frames'</samp> option is specified, <acronym>HTML</acronym> frames
are used. A file describing the frame layout is generated, and the
document page is associated with a frame where the short table of
content appears (variable <a name="IDX37"></a>
<code>$FRAMES</code>). The default is not
to use frames.
</p>
<p>It is also possible to suppress the section navigation panel with
<a name="IDX38"></a>
<samp>`--nosec-nav'</samp> (variable <a name="IDX39"></a>
<code>$SECTION_NAVIGATION</code>, the default
is to output all the navigation panels), and to specify
whether footnotes should appear at the foot of the same page which contains
the reference to the note or on a separate page with
<a name="IDX40"></a>
<samp>`--separated-footnotes'</samp> (variable <a name="IDX41"></a>
<code>$SEPARATED_FOOTNOTES</code>).
The default is to have separated footnotes.
</p>
<hr size="6">
<a name="Style-options"></a>
<a name="SEC11"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC10" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC12" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.6 Customizing the <acronym>HTML</acronym> and text style </h2>
<p>Miscalleneous style changes may be achieved with command line options.
</p>
<dl compact="compact">
<dt> <a name="IDX42"></a>
<p><samp>`--doctype=<var>DTD</var>'</samp>
</p></dt>
<dt> <a name="IDX43"></a>
<p><samp>`--frameset-doctype=<var>DTD</var>'</samp>
</p></dt>
<dd><p>You can specify the document DTD by setting these options.
<a name="IDX44"></a>
<samp>`--frameset-doctype'</samp> applies to the file describing the frames when
frames are used (corresponding variables are <a name="IDX45"></a>
<code>$DOCTYPE</code> and
<a name="IDX46"></a>
<code>$FRAMESET_DOCTYPE</code>).
</p>
<p>The default for the document doctype is:
</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
</pre></td></tr></table><p>And for the frameset doctype:
</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd">
</pre></td></tr></table>
</dd>
<dt> <a name="IDX47"></a>
<p><samp>`--iso'</samp>
</p></dt>
<dd><p>If this option is set, ISO8859 entities are used for some special symbols,
like Copyright © (variable <a name="IDX48"></a>
<code>$USE_ISO</code>). It is the default.
</p>
</dd>
<dt> <a name="IDX49"></a>
<p><samp>`--css-include=<var>file</var>'</samp>
</p></dt>
<dd><p>This command line switch provides for the inclusion of an external
Cascading Style Sheet (<acronym>CSS</acronym>) file. More than one file may be
specified, and <samp>`-'</samp> stands for the standard input (array
<a name="IDX50"></a>
<code>@CSS_FILES</code>).
</p>
<p>The option use is the same than for <code>makeinfo</code> and is described
extensively in <a href="texinfo.html#HTML-CSS">(texinfo)HTML CSS</a>.
Briefly, the <acronym>CSS</acronym> <code>@import</code> lines from the external file
<acronym>CSS</acronym> file are pasted before the
<code>texi2html</code> <acronym>CSS</acronym> rules, and the external file <acronym>CSS</acronym>
rules are pasted after the <code>texi2html</code> <acronym>CSS</acronym> rules.
</p>
</dd>
<dt> <a name="IDX51"></a>
<p><samp>`--html-xref-prefix=<var>path</var>'</samp>
</p></dt>
<dd><p>This option sets the base directory for external <acronym>HTML</acronym> texinfo manuals
(variable <a name="IDX52"></a>
<code>$EXTERNAL_DIR</code>). Defaults to <samp>`../'</samp>.
</p>
</dd>
<dt> <a name="IDX53"></a>
<p><samp>`--def-table'</samp>
</p></dt>
<dd><p>If this option is set, <acronym>HTML</acronym> tables are used to format definition
commands, rather than <acronym>HTML</acronym> definition tables (variable
<a name="IDX54"></a>
<code>$DEF_TABLE</code>). Default is false.
</p>
</dd>
<dt> <a name="IDX55"></a>
<p><samp>`--short-ref'</samp>
</p></dt>
<dd><p>If this option is set, cross-references are given without section numbers
(variable <a name="IDX56"></a>
<code>$SHORT_REF</code>). Default is false.
</p>
</dd>
<dt> <a name="IDX57"></a>
<p><samp>`--number'</samp>
</p></dt>
<dd><p>If this option is set, sections are numbered (variable
<a name="IDX58"></a>
<code>$NUMBER_SECTIONS</code>). This is the default.
</p>
</dd>
<dt> <a name="IDX59"></a>
<p><samp>`--toc-links'</samp>
</p></dt>
<dd><p>If this option is set, links from headings to <acronym>TOC</acronym> entries are
created (variable <a name="IDX60"></a>
<code>$TOC_LINKS</code>). Default is false.
</p></dd>
</dl>
<hr size="6">
<a name="Expanding-TeX-regions"></a>
<a name="SEC12"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC11" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC13" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML </h2>
<p>It is possible to use <a href="http://www.latex2html.org/">LaTeX2HTML</a>
to process <code>@tex</code> regions and <code>@math{}</code> commands. This is an
attractive way to display mathematical constructs in the <acronym>HTML</acronym>
manual. The <a name="IDX61"></a>
<samp>`--l2h'</samp> option activates this feature (variable
<var>$L2H</var>). It is usually desirable to expand <code>@tex</code> sections when this
option is specified (see section <a href="#SEC8">Specifying which regions get expanded</a>). The default is not to use this
feature.
</p>
<p>The <a name="IDX62"></a>
<samp>`--l2h-l2h=<var>program</var>'</samp> option enables changing the name/location
of the LaTeX2HTML program processing TeX regions (variable
<a name="IDX63"></a>
<code>$L2H_L2H</code>). The default is <code>latex2html</code>.
</p>
<a name="IDX64"></a>
<p><samp>`--l2h-tmp'</samp> sets the directory used for temporary
files, this name shouldn't contain a dot <samp>`.'</samp>
(variable is <a name="IDX65"></a>
<code>$L2H_TMP</code>). Defaults to the current dir.
</p>
<p>The file specified by <a name="IDX66"></a>
<samp>`--l2h-file'</samp> is
used as LaTeX2HTML init file. It is searched at the same places than
init files (see section <a href="#SEC13">Use initialization files for fine tuning</a>), and the default is <tt>`l2h.init'</tt>.
</p>
<hr size="6">
<a name="Using-init-files"></a>
<a name="SEC13"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC12" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 4.8 Use initialization files for fine tuning </h2>
<p>Initialization variables are read first from
<tt>`/usr/local/share/texi2html/Config'</tt> (the exact location being
changeable with the <a name="IDX67"></a>
<samp>`--pkgdatadir=dir'</samp> option of the
<code>configure</code> script, see <a href="#SEC4">Installation of <code>texi2html</code></a>),
<tt>`/usr/local/etc/texi2html/Config'</tt> (the exact location being
changeable with the <a name="IDX68"></a>
<samp>`--sysconfdir=dir'</samp> option of the
<code>configure</code> script, see <a href="#SEC4">Installation of <code>texi2html</code></a>), from <tt>`./Config'</tt>
then from <tt>`$HOME/.texi2html/Config'</tt>. Any command-line option
can override the corresponding option set in init file, and the
option <a name="IDX69"></a>
<samp>`--init-file'</samp> specifies an init file to be loaded, with
later settings overriding earlier ones.
</p>
<p>The init files specified with <a name="IDX70"></a>
<samp>`--init-file'</samp> are searched
first in the current directory, then in the <tt>`$HOME/.texi2html/'</tt>
directory, in the <tt>`/usr/local/etc/texi2html/'</tt> directory and lastly
in the <tt>`/usr/local/share/texi2html/'</tt> directory.
</p>
<p>A file is also included based on the language selected,
by <a name="IDX71"></a>
<code>$LANG</code>, <a name="IDX72"></a>
<samp>`--lang'</samp> or <code>@documentlanguage</code>.
If no language was selected <samp>`en'</samp> is considered to be
the language. All the files with name the language name in
<tt>`/usr/local/share/texi2html/i18n/'</tt>,
<tt>`/usr/local/etc/texi2html/i18n/'</tt>,
<tt>`$HOME/.texi2html/i18n/'</tt> and then <tt>`./i18n/'</tt> are included.
</p>
<p>The default initialization options are defined in the
<tt>`texi2html.init'</tt> file contained in the <code>texi2html</code>
distribution (which gets included near the beginning of the
<code>texi2html</code> script that gets installed).
</p>
<p>To customize <code>texi2html</code> it is best if you copy the
appropriate sections from the <tt>`texi2html.init'</tt>
contents into an appropriate local initialization file,
make the necessary changes there, and then have
<code>texi2html</code> read this initialization file by one of
the means described above.
</p>
<hr size="6">
<a name="Initialization-files"></a>
<a name="SEC14"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC13" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC15" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 5. Overview of initialization files content and loading </h1>
<p>The initialization files are <code>perl</code> files, read as explained
in <a href="#SEC13">Use initialization files for fine tuning</a>. You don't need to know much of <code>perl</code>
to do some simple changes in variable values, however, to be able to
really take advantage of all the features of the initialization file,
a good knowledge of <code>perl</code> is required.
</p>
<p>In initialization file two kind of variables appear. These are normal
variables (including arrays and hashes) and references on functions.
The later permits the dynamic redefinition of functions used to produce
the <acronym>HTML</acronym> manual. You should be able to change the value of some
normal variables without a deep knowledge of <code>perl</code>, by looking
at the existing examples. The possible mistakes in that case could be
omitted <samp>`;'</samp>, and bad quoting.
</p>
<p>Initialization file are loaded from the main program by
the mean of a <code>require</code>, while in the <code>Texi2HTML::Config</code>
namespace. This means that the namespace of the main program and
the namespace of inititalization files are distinct, which ensures
that no name clash should happen. The variables are declared with the
<code>our</code> specifier, such that it should be possible to use the
<code>use strict</code> pragma in the initialization file code.
</p>
<p>To avoid messing with the variables in the <code>main</code> namespace
all the global variables which could be of use in the init files
are in the <code>Texi2HTML</code> namespace. Notice that the functions
of the main program are still in the <code>main</code> namespace.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC15">5.1 Redefining functions in initialization files</a></td><td> </td><td align="left" valign="top"> Function redefinition is achieved with
redefinition of references on functions.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC16">5.2 Conventions used for function prototypes</a></td><td> </td><td align="left" valign="top"> Conventions used in that manual for function
reference prototypes display.
</td></tr>
</table>
<hr size="6">
<a name="Redefining-functions"></a>
<a name="SEC15"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC14" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC16" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 5.1 Redefining functions in initialization files </h2>
<p>To redefine a function you must replace the corresponding funtion
reference with a reference on your function.
Thus you should write your function, give it a name you
are certain it is unique in the <code>Texi2HTML::Config</code> namespace,
and override the value of the function reference with your own
function reference. When another function from the main program
(or from another functions of an initialization file) calls the reference,
your function will be used.
</p>
<p>For example the function
reference corresponding with the function called when doing an
anchor is called <a name="IDX73"></a>
<code>$anchor</code>. Thus if you want to override the
corresponding function
you could write:
</p>
<table><tr><td> </td><td><pre class="example"># override the function reference
$anchor = \&my_own_function;
# the function reference now refers to
sub my_own_function {
# process arguments and return an html anchor
}
</pre></td></tr></table>
<hr size="6">
<a name="Function-prototypes"></a>
<a name="SEC16"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC15" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 5.2 Conventions used for function prototypes </h2>
<p>As the functions are defined by a reference name, we will always
use the reference name in function prototypes. For the function arguments
we will use <code>\@array</code> for a reference on an array and similarly
<code>\%hash</code> for a reference on a hash.
</p>
<p>Thus, the prototype for the function associated with the function
reference <samp>`$formatting_function'</samp> will be:
</p>
<dl>
<dt><u>Function Reference:</u> $text <b>formatting_function</b><i> $arg1 \@arg2</i>
<a name="IDX74"></a>
</dt>
<dd><p><code>formatting_function</code> takes as first argument <var>$arg2</var>,
as second argument a reference on an array <var>\@arg2</var>
and returns the formatted text <var>$text</var>.
</p></dd></dl>
<p>To redefined the corresponding function, you should write:
</p>
<table><tr><td> </td><td><pre class="example">$formatting_function = \&my_formatting_function
sub my_formatting_function($ $)
{
my $arg1 = shift;
my $arg2 = shift;
# prepare $formatted_text
.....
return $formatted_text
}
</pre></td></tr></table>
<hr size="6">
<a name="Changing-the-page-layout"></a>
<a name="SEC17"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC16" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC18" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 6. Fine tuning of the page layout </h1>
<p>Some features of the page layout might be specified with command line
options, the corresponding variables are described in
<a href="#SEC10">Page layout related command line options</a>.
Fine tuning of the page layout may be achieved
with redefinition of other variables and function references in the
initialization files.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC18">6.1 The different categories of pages and sectioning elements</a></td><td> </td><td align="left" valign="top"> The different categories of pages.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td><td> </td><td align="left" valign="top"> The elements of a page.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC21">6.3 Customization of the navigation panels buttons</a></td><td> </td><td align="left" valign="top"> How to change the navigation panel.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC25">6.4 Main program variables and usefull functions</a></td><td> </td><td align="left" valign="top"> The available main program variables and some
usefull functions from the main program.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC32">6.5 Preparing the output</a></td><td> </td><td align="left" valign="top"> Setting variables before the document
production but after the texinfo parsing.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC33">6.6 Finalizing the output</a></td><td> </td><td align="left" valign="top"> Cleaning after document generation.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td><td> </td><td align="left" valign="top"> Customizing css lines.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC36">6.9 Customizing the sections</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC38">6.11 Special pages formatting</a></td><td> </td><td align="left" valign="top"> Customizing table of contents, top, about page.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#SEC46">6.13 Generation of external files for index entries</a></td><td> </td><td align="left" valign="top"> Putting index entries in external files.
</td></tr>
</table>
<hr size="6">
<a name="The-different-pages"></a>
<a name="SEC18"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC17" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC19" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.1 The different categories of pages and sectioning elements </h2>
<p>The following sectioning elements can be associated with pages:
</p>
<dl compact="compact">
<dt> <em>Normal elements</em></dt>
<dd><p>These are normal sections or nodes. Their association with pages is
determined by the splitting of the document. See section <a href="#SEC6">Specifying where to split the generated document</a>.
</p></dd>
<dt> <em>Top element</em></dt>
<dd><p>The top element is the higher element in the document structure.
If there is a <code>@top</code> section it is the element associated with
that section. Otherwise it is the element associated with the
<code>@node Top</code>. If there is no <code>@node Top</code> the first element is the
top element.
</p>
<p>The top element is formatted differently than a normal element if there
is a <code>@top</code> section or the <code>@node Top</code> isn't associated
with a sectioning command.
</p></dd>
<dt> <em>Misc elements</em></dt>
<dd><p>These elements are associated with pages if the document is split.
There are four misc elements:
</p><ol>
<li> Table of contents
</li><li> Short table of contents, also called Overview
</li><li> Footnotes page
</li><li> About page
</li></ol>
<p>The <em>About page</em> shouldn't be present for documents consisting
in only one sectioning element. The <em>Footnote page</em> should only
be present if the footnotes appear on a separated page
(see section <a href="#SEC10">Page layout related command line options</a>), however a footnote element is present if
the document isn't split. The <em>Table of contents</em> should only
be formatted if <code>@contents</code> is present in the document.
Similarly the <em>Overview</em> should only appear if <code>@shortcontents</code>
or <code>@summarycontents</code> is present.
</p></dd>
</dl>
<hr size="6">
<a name="The-page-layout"></a>
<a name="SEC19"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC18" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.2 Page layout and navigation panel overview </h2>
<p>A page is broken up in three parts. A page header, the sections
and a page footer. A common element in the page layout is a navigation
panel with icons or text linking to other sections or pages. Another
common element is a rule, separating sections or footer. The navigation
panel and the rules may be part of the sections or part of headers or
footers. You may use the variables <a name="IDX75"></a>
<code>$SMALL_RULE</code>,
<a name="IDX76"></a>
<code>$DEFAULT_RULE</code>, <a name="IDX77"></a>
<code>$MIDDLE_RULE</code> and <a name="IDX78"></a>
<code>$BIG_RULE</code>
for rules of different sizes.
The defaults are
</p><table><tr><td> </td><td><pre class="example">$SMALL_RULE = '<hr size="1">';
$DEFAULT_RULE = '<hr>';
$MIDDLE_RULE = '<hr size="2">';
$BIG_RULE = '<hr size="6">';
</pre></td></tr></table>
<p>In the header some important meta data may be defined, like the
title or style information, and textual informations may be present
in comments. All this doesn't appear directly in the displayed
<acronym>HTML</acronym>, though.
</p>
<p>The page layout is mainly controlled by functions, the precise functions
called depending on the document splitting. The navigation panel, however,
can be customized with variables.
</p>
<a name="SEC20"></a>
<h3 class="subheading"> Element labels </h3>
<p><a name="Element-labels"></a>
</p>
<p>There are 19 items associated with elements. Each of these
is associated with a name and a reference to the
element they represent, when such an element exists.
The element is either a global element or an element relative to the current
element. The relative elements are found with respect with the document
structure defined by the section structuring commands (<code>@chapter</code>,
<code>@unnumbered</code>…) or by the nodes (in that case the node
directions are specified on node line or in menu organization).
These items are called <em>element labels</em>. They may be associated with
a button (see section <a href="#SEC23">Specifying the buttons formatting</a>), and used in the formatting functions
(see section <a href="#SEC25">Main program variables and usefull functions</a>).
</p>
<p>Here is the list:
</p>
<dl compact="compact">
<dt> <em><samp>` '</samp></em></dt>
<dd><p>An empty button
</p></dd>
<dt> <em>Top</em></dt>
<dd><p>Top element. The associated name is <a name="IDX79"></a>
<code>$TOP_HEADING</code> if that variable is
defined. This variable is not set by default.
</p></dd>
<dt> <em>Contents</em></dt>
<dd><p>Table of contents
</p></dd>
<dt> <em>About</em></dt>
<dd><p>About (help) page
</p></dd>
<dt> <em>Overview</em></dt>
<dd><p>Overview, short table of contents
</p></dd>
<dt> <em>First</em></dt>
<dd><p>First element in reading order
</p></dd>
<dt> <em>Last</em></dt>
<dd><p>Last element in reading order
</p></dd>
<dt> <em>Index</em></dt>
<dd><p>The first chapter with <code>@printindex</code>. The associated name
is <a name="IDX80"></a>
<code>$INDEX_CHAPTER</code>, if the variable is set. This variable is not set
by default.
</p></dd>
<dt> <em>This</em></dt>
<dd><p>The current element
</p></dd>
<dt> <em>Back</em></dt>
<dd><p>Preceding element in reading order
</p></dd>
<dt> <em>FastBack</em></dt>
<dd><p>Beginning of this chapter or previous chapter if the element is a chapter
</p></dd>
<dt> <em>Prev</em></dt>
<dd><p>Previous section on the same level
</p></dd>
<dt> <em>NodePrev</em></dt>
<dd><p>Previous node
</p></dd>
<dt> <em>Forward</em> </dt>
<dd><p>Next element in reading order
</p></dd>
<dt> <em>FastForward</em></dt>
<dd><p>Next chapter
</p></dd>
<dt> <em>Next</em></dt>
<dd><p>Next section on the same level
</p></dd>
<dt> <em>NodeNext</em></dt>
<dd><p>Next node
</p></dd>
<dt> <em>Following</em></dt>
<dd><p>Next node in node reading order
</p></dd>
<dt> <em>Up</em></dt>
<dd><p>Up section
</p></dd>
<dt> <em>NodeUp</em></dt>
<dd><p>Up node
</p></dd>
</dl>
<hr size="6">
<a name="Navigation-panel"></a>
<a name="SEC21"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC19" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC22" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.3 Customization of the navigation panels buttons </h2>
<p>A lot of customization of the navigation panel may be achieved without
redefining functions, with variables redefinition.
In case it isn't enough, it is also possible to redefine the function
doing the navigation panel formatting.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td><td> </td><td align="left" valign="top"> Variables controlling the navigation panel
at a global level
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC24">6.3.3 Changing the navigation panel formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="General-purpose-variables"></a>
<a name="SEC22"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC21" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC23" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.3.1 Controlling the navigation panel panel at a high level </h3>
<p>The global formatting of the navigation panels may be
changed with the following variables:
</p>
<dl compact="compact">
<dt> <code>$VERTICAL_HEAD_NAVIGATION</code>
<a name="IDX81"></a>
</dt>
<dd><p>A vertical navigation panel will be used for the header navigation
panel if this variable is true.
</p></dd>
<dt> <code>$ICONS</code>
<a name="IDX82"></a>
</dt>
<dd><p>Icons are used instead of
textual buttons if this variable is true.
</p></dd>
<dt> <code>$SECTION_NAVIGATION</code>
<a name="IDX83"></a>
</dt>
<dd><p>If this variable is false there is no section navigation, no navigation
panels for the elements within the pages, only at
the beginning and the end of the page (see section <a href="#SEC10">Page layout related command line options</a>).
</p></dd>
</dl>
<hr size="6">
<a name="Button-specifications"></a>
<a name="SEC23"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC22" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC24" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.3.2 Specifying the buttons formatting </h3>
<p>Several arrays and hashes enable a precise control on the buttons and
their display.
The following arrays determine the buttons present in navigation panels:
</p>
<dl compact="compact">
<dt> <code>@SECTION_BUTTONS</code>
<a name="IDX84"></a>
</dt>
<dd><p>This array is used for the navigation panel buttons present at the begining
of sectioning elements. If split at node or section they are also used
at the page footer, and in the case of section navigation at the page header.
</p></dd>
<dt> <code>@SECTION_FOOTER_BUTTONS</code>
<a name="IDX85"></a>
</dt>
<dt> <code>@NODE_FOOTER_BUTTONS</code>
<a name="IDX86"></a>
</dt>
<dd><p>This array is used for the navigation panel buttons present at the footer
of pages when split at node or at section.
</p>
<p>If <a name="IDX87"></a>
<code>$WORDS_IN_PAGE</code> is set and the output is split at nodes, these
buttons are only present if there are more than <a name="IDX88"></a>
<code>$WORDS_IN_PAGE</code>
words in the sectioning element text. This counting is very rough and include
punctuation marks, html elements, numbers. The default is to include the
buttons after 300 words.
</p></dd>
<dt> <code>@CHAPTER_BUTTONS</code>
<a name="IDX89"></a>
</dt>
<dd><p>This array is used for the buttons appearing at the page footer if split at
chapter, and at the page header if split at chapter and there is no section
navigation.
</p></dd>
<dt> <code>@MISC_BUTTONS</code>
<a name="IDX90"></a>
</dt>
<dd><p>These buttons appear at the beginning of special and sections
and at the end of these section pages if the output is split.
</p></dd>
</dl>
<p>The array specify the buttons displayed in navigation panels,
and how the button is displayed.
Each element is associated with
a button of the navigation panel from left to right.
The signification of the array element value is the following:
</p>
<dl compact="compact">
<dt> <em>reference on a function</em></dt>
<dd><p>The function is called with first argument a filehandle reference on the
current file and second argument a boolean true if the navigation
panel should be vertical.
</p></dd>
<dt> <em>reference on a scalar</em></dt>
<dd><p>The scalar value is printed. For some possibly
usefull scalars, <a href="#SEC26">Accessing elements informations</a>.
</p></dd>
<dt> <em>reference on an array</em></dt>
<dd><p>In this case the first array element should be a reference on text and the
second element an element label. In that case a link to the
element associated with the element label with the scalar value
text is generated.
</p>
<p>For example if the buttons array element is
</p><table><tr><td> </td><td><pre class="example">[ 'Next', \$Texi2HTML::NODE{Next} ]
</pre></td></tr></table>
<p>The button will be a link to the next section with text
<a name="IDX91"></a>
<code>$Texi2HTML::NODE{Next}</code>.
</p></dd>
<dt> <em>element label</em></dt>
<dd><p>If icons are not used, the button is a link to the corresponding
element which text is defined by the value associated with the
element label in the <a name="IDX92"></a>
<code>%NAVIGATION_TEXT</code> hash, surrounded
by <samp>`['</samp> and <samp>`]'</samp>. If the element label is <samp>` '</samp>, there is
no <samp>`['</samp> and <samp>`]'</samp>.
The element of the <code>%NAVIGATION_TEXT</code> hash are defined
dynamically, in the <code>init_out</code> function reference
(see section <a href="#SEC32">Preparing the output</a>).
</p>
<p>If icons are used, the button is an image with file determined by
the value associated with the element label in the <a name="IDX93"></a>
<code>%ACTIVE_ICONS</code>
hash if the the link really leads to an element, or in the <a name="IDX94"></a>
<code>%PASSIVE_ICONS</code>
hash if there is no element to link to. Of course if there is a link to the
element the icon links to that element.
</p></dd>
</dl>
<hr size="6">
<a name="Panel-formatting-function"></a>
<a name="SEC24"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC23" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.3.3 Changing the navigation panel formatting </h3>
<p>If you are not satisfied with this scheme, it is possible to
control exactly the formatting of navigation panels by redefining a function
reference. The function controlling the display of navigation panel is
associated with the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_navigation</b><i> $filehandle \@buttons $vertical</i>
<a name="IDX95"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>\@buttons</var> is an array reference which should hold the specification of
the buttons for that navigation panel. <var>$vertical</var> is true if the
navigation panel should be vertical.
</p></dd></dl>
<hr size="6">
<a name="Program-variables"></a>
<a name="SEC25"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC24" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC26" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.4 Main program variables and usefull functions </h2>
<p>In the functions
controlling the page layout some global variables set by the main
program are available, with value corresponding with the current
layout element.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td><td> </td><td align="left" valign="top"> Accessing information related with the
different elements
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC27">6.4.2 Accessing global informations</a></td><td> </td><td align="left" valign="top"> Accessing global informations, like date,
title…
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td><td> </td><td align="left" valign="top"> main program usefull functions
</td></tr>
</table>
<hr size="6">
<a name="Elements-hashes"></a>
<a name="SEC26"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC25" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC27" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.4.1 Accessing elements informations </h3>
<p>Four hashes are available, with key the elements labels (as described
in <a href="#Element-labels">Element labels</a>) and values:
</p>
<dl compact="compact">
<dt> <code>%Texi2HTML::NAME</code>
<a name="IDX96"></a>
</dt>
<dd><p>The formatted element name
</p></dd>
<dt> <code>%Texi2HTML::HREF</code>
<a name="IDX97"></a>
</dt>
<dd><p>The element hypertext reference
</p></dd>
<dt> <code>%Texi2HTML::NODE</code>
<a name="IDX98"></a>
</dt>
<dd><p>The element node name
</p></dd>
<dt> <code>%Texi2HTML::NO_TEXI</code>
<a name="IDX99"></a>
</dt>
<dd><p>The element name after removal of texi commands
</p></dd>
</dl>
<hr size="6">
<a name="Global-informations"></a>
<a name="SEC27"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC26" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC31" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.4.2 Accessing global informations </h3>
<p>Three kinds of global informations are available, miscalleneous global
strings, flags set by <code>@set</code> and special flags and section lines.
</p>
<a name="SEC28"></a>
<h4 class="subsubheading"> Global strings </h4>
<p>The <a name="IDX100"></a>
<code>%Texi2HTML::THISDOC</code> hash holds some global informations:
</p>
<dl compact="compact">
<dt> <code>fulltitle</code></dt>
<dd><p>title set by <code>@title</code>. If there is no <code>@title</code> other
possibilities are tried (<code>@settitle</code>, <code>@shorttitlepage</code>…).
</p></dd>
<dt> <code>title</code></dt>
<dd><p>title set by <code>@settitle</code>, or <code>fulltitle</code>.
</p></dd>
<dt> <code>title_no_texi</code></dt>
<dd><p>title without texi formatting
</p></dd>
<dt> <code>title_texi</code></dt>
<dd><p>title with texi commands
</p></dd>
<dt> <code>author</code></dt>
<dd><p>Authors list set by <code>@author</code>.
</p></dd>
<dt> <code>authors</code></dt>
<dd><p>A reference on an array containing each author set by <code>@author</code>.
</p></dd>
<dt> <code>copying</code></dt>
<dd><p>Text appearing in <code>@copying</code> with all the texinfo commands removed,
put in comments.
</p></dd>
<dt> <code>program</code></dt>
<dd><p>The name and version of <code>texi2html</code>.
</p></dd>
<dt> <code>program_homepage</code></dt>
<dd><p>Homepage for <code>texi2html</code>.
</p></dd>
<dt> <code>program_authors</code></dt>
<dd><p>Authors of <code>texi2html</code>.
</p></dd>
<dt> <code>file_base_name</code></dt>
<dd><p>base name of the texinfo manual file.
</p></dd>
<dt> <code>destination_directory</code></dt>
<dd><p>Destination directory for the resulting files.
</p></dd>
<dt> <code>toc_file</code></dt>
<dd><p>The file name of the table of contents.
</p></dd>
<dt> <code>today</code></dt>
<dd><p>The date.
</p></dd>
</dl>
<p>It also holds the arg of the following commands, associated with the command
name: kbdinputstyle, paragraphindent, setchapternewpage, headings,
footnotestyle,
exampleindent, firstparagraphindent, everyheading, everyfooting,
evenheading, evenfooting, oddheading, oddfooting.
</p>
<a name="SEC29"></a>
<h4 class="subsubheading"> Flags </h4>
<p>Flags defined by <code>@set</code> may be accessed through the
<a name="IDX101"></a>
<code>%main::value</code> hash. The key is the flag name, the value is the
flag value at the end of the document.
</p>
<p>Special flags are set by the main program. They correspond with a texinfo
command, like <code>@setfilename</code>, or <code>@settitle</code>,
<code>@author</code>… The corresponding flag is the command name with
<samp>`_'</samp> appended, for example, <code>_titlefont</code> corresponds with
<code>@titlefont</code>. Like other flags they are available in
<a name="IDX102"></a>
<code>%main::value</code>.
</p>
<a name="SEC30"></a>
<h4 class="subsubheading"> Section lines </h4>
<p>The following array references or arrays holds formatted lines:
</p>
<dl compact="compact">
<dt> <code>$Texi2HTML::THIS_SECTION</code>
<a name="IDX103"></a>
</dt>
<dd><p>Lines of the current element.
</p></dd>
<dt> <code>$Texi2HTML::THIS_HEADER</code>
<a name="IDX104"></a>
</dt>
<dd><p>Lines of the current element appearing before the element label (anchors).
</p></dd>
<dt> <code>$Texi2HTML::OVERVIEW</code>
<a name="IDX105"></a>
</dt>
<dd><p>Lines of short table of contents. See section <a href="#SEC38">Special pages formatting</a>.
</p></dd>
<dt> <code>$Texi2HTML::TOC_LINES</code>
<a name="IDX106"></a>
</dt>
<dd><p>Lines of table of contents. See section <a href="#SEC38">Special pages formatting</a>.
</p></dd>
</dl>
<hr size="6">
<a name="Global-functions"></a>
<a name="SEC31"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC27" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC32" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.4.3 Function usefull in page formatting </h3>
<p>The usefull function is a function used to print an array of lines, which
also counts the number of words in the array, if needed.
</p>
<dl>
<dt><u>Function:</u> $words_number <b>main::print_lines</b><i> $filehandle \@lines_array</i>
<a name="IDX107"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>\@lines_array</var> is the array line the function should write to the file.
If this argument is omitted, the function uses <a name="IDX108"></a>
<code>$Texi2HTML::THIS_SECTION</code>.
<var>$words_number</var> is the number of words in the array, only defined if
split at nodes and <a name="IDX109"></a>
<code>$WORDS_IN_PAGE</code> is defined.
</p></dd></dl>
<hr size="6">
<a name="Output-initialization"></a>
<a name="SEC32"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC31" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC33" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.5 Preparing the output </h2>
<p>After the texinfo file has been parsed, some information is available
which can be used to modify some variables and prepare the outputting.
For example the document language, the document encoding,
values set with <code>@set</code> or <code>@setfilename</code> and other similar
@-commands are not known before the texinfo parsing.
</p>
<p>The following function reference may be redefined to be called after
texinfo processing and before document generation:
</p>
<dl>
<dt><u>Function Reference:</u> $encoding <b>init_out</b>
<a name="IDX110"></a>
</dt>
<dd><p>This function perform the initialization of variables and any other
task before document outputting. It returns the encoding used for the
output files.
</p></dd></dl>
<p>In the default case the <a name="IDX111"></a>
<code>$BODYTEXT</code> (see section <a href="#SEC35">Customizing the page header</a>)
and the hashes <a name="IDX112"></a>
<code>%NAVIGATION_TEXT</code> (see section <a href="#SEC23">Specifying the buttons formatting</a>) and
<a name="IDX113"></a>
<code>%BUTTONS_GOTO</code> (see section <a href="#SEC43">Formatting of about text</a>) are initialized.
</p>
<p>To perform the default initializations and also add more code, you could
do as in the following example (save the default function reference and call
it in your own function) :
</p>
<table><tr><td> </td><td><pre class="example">my $default_init_out = $init_out;
$init_out = \&makeinfo_like_init_out;
sub makeinfo_like_init_out()
{
my $encoding = &$default_init_out();
$NAVIGATION_TEXT{'Following'} = ' &gt; ';
return $encoding;
}
</pre></td></tr></table>
<hr size="6">
<a name="Output-finalization"></a>
<a name="SEC33"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC32" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC34" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.6 Finalizing the output </h2>
<p>If you want to do some cleaning after the document was generated (close
files, write at the end of files and so on), the following function
reference may be redefined:
</p>
<dl>
<dt><u>Function Reference:</u> <b>finish_out</b>
<a name="IDX114"></a>
</dt>
<dd><p>This function is called after the document generation.
</p></dd></dl>
<p>The default is to do nothing.
</p>
<hr size="6">
<a name="css"></a>
<a name="SEC34"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC33" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC35" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.7 Customizing the <code>texi2html</code> css lines </h2>
<p>It is possible to modify the <code>texi2html</code> css lines by modifying
the entries or adding to the <a name="IDX115"></a>
<code>%css_map</code> hash. Each key is a css
selector, the corresponding value is a style string.
</p>
<p>The whole css text is in the variable <a name="IDX116"></a>
<code>$CSS_LINES</code>. If this
variable is defined the variable value is used instead of being
constructed using the <a name="IDX117"></a>
<code>%css_map</code> entries. For example if you don't
want any css entries, set
</p>
<table><tr><td> </td><td><pre class="example">$CSS_LINES = '';
</pre></td></tr></table>
<p>It is also possible to change completely the way <a name="IDX118"></a>
<code>$CSS_LINES</code> are
generated by redefining the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> <b>css_lines</b><i> \@import_lines \@rule_lines</i>
<a name="IDX119"></a>
</dt>
<dd><p>This function should be used to construct the <a name="IDX120"></a>
<code>$CSS_LINES</code>.
<var>\@import_lines</var> are the <code>@import</code> lines of the
files specified with <a name="IDX121"></a>
<samp>`--include-css'</samp>,
and <var>\@rule_lines</var> are the css commands lines of these files.
See section <a href="#SEC11">Customizing the <acronym>HTML</acronym> and text style</a>.
</p></dd></dl>
<hr size="6">
<a name="Customizing-header"></a>
<a name="SEC35"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC34" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC36" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.8 Customizing the page header </h2>
<p>It is possible to add lines to the text within the <code><head></code>
<acronym>HTML</acronym> elements, by defining the variable <a name="IDX122"></a>
<code>$EXTRA_HEAD</code>.
Similarly it is possible to add text just after the <code><body></code>
element with the variable <a name="IDX123"></a>
<code>$AFTER_BODY_OPEN</code>.
These variables are empty by default.
</p>
<p>The encoding of the texinfo file is defined by <a name="IDX124"></a>
<code>$DOCUMENT_ENCODING</code>
if no <code>@documentencoding</code> appears in the document.
The default is a <samp>`en-ascii'</samp> encoding.
The encoding of the resulting document is defined by
<a name="IDX125"></a>
<code>$ENCODING</code>. The default is the <code>$DOCUMENT_ENCODING</code>.
</p>
<p>The description of the document may be specified in
<a name="IDX126"></a>
<code>$DOCUMENT_DESCRIPTION</code>. If this variable is undef, the text
associated with <code>@documentdescription</code> is used, and if there isn't
such test a default description is constructed using the document title and
the name of the first section of the file.
</p>
<p>The <code><body></code> element attributes may be set by defining the
variable <a name="IDX127"></a>
<code>$BODYTEXT</code>. If you want to define that variable
dynamically, you should use the <code>init_out</code> function reference
(see section <a href="#SEC32">Preparing the output</a>).
</p>
<p>The default functions call the function associated with
<a name="IDX128"></a>
<code>$print_head_navigation</code> to format the navigation panel for the
page header. Thus you can control parts of the formatting by
redefining the function reference.
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_head_navigation</b><i> $filehandle \@buttons</i>
<a name="IDX129"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>\@buttons</var> is an array reference which should hold the specification of
the buttons for the navigation panel.
</p></dd></dl>
<p>If you want even more control, you can have full control over the page header
formatting by redefining three function references. The function associated
with <a name="IDX130"></a>
<code>$print_page_head</code> is called for all the pages, and after that,
the function associated with <a name="IDX131"></a>
<code>$print_chapter_header</code> is called
if the document is split at chapters, or the function associated with
<a name="IDX132"></a>
<code>$print_section_header</code> is called if the document is split at sections.
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_page_head</b><i> $filehandle</i>
<a name="IDX133"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function should print the page head, including the <code><body></code>
element.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_chapter_header</b><i> $filehandle</i>
<a name="IDX134"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function is called if the document is split at chapters, after
<code>print_page_head</code>.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_section_header</b><i> $filehandle</i>
<a name="IDX135"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function is called if the document is split at sections, after
<code>print_page_head</code>.
</p></dd></dl>
<hr size="6">
<a name="Customizing-section"></a>
<a name="SEC36"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC35" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC37" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.9 Customizing the sections </h2>
<p>The functions associated with the following function references are used for
the formatting of sections:
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_section</b><i> $filehandle $first_in_page $previous_is_top</i>
<a name="IDX136"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>$first_in_page</var> is true if this section is the first section in the page.
<var>$previous_is_top</var> is true if this section is the section following the
Top section.
This function should print the current section.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>end_section</b><i> $filehandle $last_element_or_before_top</i>
<a name="IDX137"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>$last_element_or_before_top</var> is true if this section precedes the top
element or is the last one in page, or before the special elements.
</p></dd></dl>
<hr size="6">
<a name="Customizing-footer"></a>
<a name="SEC37"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC36" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC38" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.10 Customizing the page footer </h2>
<p>It is possible to add text just before the <code></body></code>
element with the variable <a name="IDX138"></a>
<code>$PRE_BODY_CLOSE</code>. Nothing is added
by default.
</p>
<p>The default functions call the function associated with
<a name="IDX139"></a>
<code>$print_foot_navigation</code> to format the navigation panel for the
page footer. Thus you can control parts of the formatting by
redefining the function reference.
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_foot_navigation</b><i> $filehandle \@buttons</i>
<a name="IDX140"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>\@buttons</var> is an array reference which should hold the specification of
the buttons for the navigation panel.
</p></dd></dl>
<p>If you want even more control, you can have full control the page footer
formatting by redefining three function references.
The function associated with <a name="IDX141"></a>
<code>$print_chapter_footer</code> is called
if the document is split at chapters, or the function associated with
<a name="IDX142"></a>
<code>$print_section_footer</code> is called if the document is split at sections.
After that the function associated
with <a name="IDX143"></a>
<code>$print_page_foot</code> is called.
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_page_foot</b><i> $filehandle</i>
<a name="IDX144"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function should print the page foot, including the <code></body></code>
element.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_chapter_footer</b><i> $filehandle</i>
<a name="IDX145"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function is called if the document is split at chapters, before
<code>print_page_foot</code>.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_section_footer</b><i> $filehandle</i>
<a name="IDX146"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
This function is called if the document is split at sections, before
<code>print_page_foot</code>.
</p></dd></dl>
<hr size="6">
<a name="Special-pages"></a>
<a name="SEC38"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC37" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.11 Special pages formatting </h2>
<p>For the special elements, two things must be formatted: the content
and the page layout
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC39">6.11.1 Customizing the content of the special pages</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Special-pages-content"></a>
<a name="SEC39"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC38" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC40" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.11.1 Customizing the content of the special pages </h3>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC40">6.11.1.1 Top element text formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC42">6.11.1.3 Formatting of footnotes text</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC43">6.11.1.4 Formatting of about text</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Top-element-text"></a>
<a name="SEC40"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC39" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC41" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 6.11.1.1 Top element text formatting </h4>
<p>The top element formatting is controlled by three function which also
controls the layout of the top element page or section. The associated
function references are:
</p>
<dl>
<dt><u>Function Reference:</u> <b>print_Top_header</b><i> $filehandle $begin_page</i>
<a name="IDX147"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>$begin_page</var> is true if the element is the first in a page.
This function should begin the Top element. At the time this function is called
the top element text hasn't been parsed.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_Top</b><i> $filehandle $has_top_heading</i>
<a name="IDX148"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>$has_top_heading</var> is true if there is a <code>@heading</code> command or
<code>@titlefont</code> command appearing in the Top element text.
This function should be used to format the Top element text and navigation
panel.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>print_Top_footer</b><i> $filehandle $end_page</i>
<a name="IDX149"></a>
</dt>
<dd><p><var>$filehandle</var> is the opened filehandle the function should write to.
<var>$end_page</var> is true if the element is the last in a page.
This function should end the Top element.
</p></dd></dl>
<hr size="6">
<a name="Contents-and-Overview-text"></a>
<a name="SEC41"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC40" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC42" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 6.11.1.2 Table of contents and Short table of contents </h4>
<p>Several variables may be used to control the formatting of table of contents
and short table of contents:
</p>
<dl compact="compact">
<dt> <code>$DO_CONTENTS</code>
<a name="IDX150"></a>
</dt>
<dd><p>If the variable is true a table of contents is done even if there is no
<code>@contents</code> command.
</p></dd>
<dt> <code>$DO_SCONTENTS</code>
<a name="IDX151"></a>
</dt>
<dd><p>If the variable is true a short table of contents is done even if there is no
<code>@summarycontents</code> command.
</p></dd>
<dt> <code>$BEFORE_OVERVIEW</code>
<a name="IDX152"></a>
</dt>
<dd><p>The variable value is inserted before the short table of contents text.
</p></dd>
<dt> <code>$AFTER_OVERVIEW</code>
<a name="IDX153"></a>
</dt>
<dd><p>The variable value is inserted after the short table of contents text.
</p></dd>
<dt> <code>$BEFORE_TOC_LINES</code>
<a name="IDX154"></a>
</dt>
<dd><p>The variable value is inserted before the table of contents text.
</p></dd>
<dt> <code>$AFTER_TOC_LINES</code>
<a name="IDX155"></a>
</dt>
<dd><p>The variable value is inserted after the table of contents text.
</p></dd>
<dt> <code>$TOC_LIST_STYLE</code>
<a name="IDX156"></a>
</dt>
<dd><p>This should contain a css style used for the list style if the tables of
content are formatted with a list.
</p></dd>
<dt> <code>$TOC_LIST_ATTRIBUTE</code>
<a name="IDX157"></a>
</dt>
<dd><p>This should contain an attribute text used for the list element if the tables of
content are formatted with a list.
</p></dd>
</dl>
<p>More control on the table of contents and short table of contents formatting
may be achieved by redefining a function with the following associated
function reference:
</p>
<dl>
<dt><u>Function Reference:</u> <b>toc_body</b><i> \@elements </i>
<a name="IDX158"></a>
</dt>
<dd><p><var>\@elements</var> is an array reference contining informations about
all the elements of the document. Each of the entry of this array is an hash
reference which entries correspond with different informations
about the element. Interesting keys have the following meaning:
</p>
<dl compact="compact">
<dt> <code>top</code></dt>
<dd><p>true if the element is the top element,
</p></dd>
<dt> <code>index_page</code></dt>
<dd><p>true if the element is an index page added because of index splitting,
</p></dd>
<dt> <code>toc_level</code></dt>
<dd><p>level of the element in the table of content. Highest level
is 1 for the top element and for chapters, appendix and so on,
2 for section, unnumberedsec and so on...
</p></dd>
<dt> <code>tocid</code></dt>
<dd><p>label used for reference linking to the element in table of
contents,
</p></dd>
<dt> <code>file</code> </dt>
<dd><p>the file containing the element, usefull to do href to that file
in case the document is split,
</p></dd>
<dt> <code>text</code></dt>
<dd><p>text of the element, with section number,
</p></dd>
<dt> <code>name</code></dt>
<dd><p>text of the element, without section number.
</p></dd>
</dl>
<p>This function doesn't return anything but should fill the array corresponding
with the
<a name="IDX159"></a>
<code>$Texi2HTML::TOC_LINES</code> and
<a name="IDX160"></a>
<code>$Texi2HTML::OVERVIEW</code> references with the table of contents and short
table of contents.
</p>
</dd></dl>
<hr size="6">
<a name="Footnotes-text"></a>
<a name="SEC42"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC41" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC43" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 6.11.1.3 Formatting of footnotes text </h4>
<p>The footnotes text is allready formatting when <code>@footnote</code> commands
are expanded. See section <a href="#SEC82">Customizing the footnotes formatting</a>.
</p>
<hr size="6">
<a name="About-text"></a>
<a name="SEC43"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC42" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC44" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h4 class="subsubsection"> 6.11.1.4 Formatting of about text </h4>
<p>The default about element contains an explaination of the buttons used
in the document (<code>@SECTION_BUTTONS</code>, <a href="#SEC23">Specifying the buttons formatting</a>) and
an example locating the buttons targets in an example.
The formatting of this text may be influenced by the following
hashes and variables:
</p>
<dl compact="compact">
<dt> <code>$PRE_ABOUT</code> </dt>
<dt> <code>$AFTER_ABOUT</code></dt>
<dd><p>This variable may be a scalar or a function reference.
If it is a scalar, the value is used.
If this is a function reference it is expanded and the returned text is
used. The text is added before or after the main about text.
</p></dd>
<dt> <code>%BUTTONS_GOTO</code></dt>
<dd>
<p>The keys of this hash are element labels (see <a href="#Element-labels">Element labels</a>). The value
is the text associated with the element label in the about text.
The element of the hash are defined
dynamically, you should in the <code>init_out</code> function reference
(see section <a href="#SEC32">Preparing the output</a>).
</p>
</dd>
<dt> <code>%BUTTONS_EXAMPLE</code></dt>
<dd>
<p>The keys of this hash are element labels (see <a href="#Element-labels">Element labels</a>). The value
is the text associated with the element label in the about example,
typically a section number.
</p>
</dd>
</dl>
<p>If this is not enough and you want to control exactly the formatting of
the about text, you can redefine the function associated with the following
function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $about_text <b>print_about</b>
<a name="IDX161"></a>
</dt>
<dd><p>This function should return the about text.
</p></dd></dl>
<hr size="6">
<a name="Special-pages-layout"></a>
<a name="SEC44"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC43" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC45" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 6.11.2 Customizing the layout of the special pages </h3>
<p>The formatting of each of the special pages, or section in case
the document is not split, is controlled by a function.
The associated function reference is called accordingly:
</p>
<dl compact="compact">
<dt> <code>print_Top</code>
<a name="IDX162"></a>
</dt>
<dt> <code>print_Top_header</code>
<a name="IDX163"></a>
</dt>
<dt> <code>print_Top_footer</code>
<a name="IDX164"></a>
</dt>
<dd><p>Formatting of top element page or section. It is also used for the formatting
of the top element text (see section <a href="#SEC40">Top element text formatting</a>).
</p></dd>
<dt> <code>print_Toc</code>
<a name="IDX165"></a>
</dt>
<dd><p>Formatting of table of contents page or section
</p></dd>
<dt> <code>print_Overview</code>
<a name="IDX166"></a>
</dt>
<dd><p>Formatting of short table of contents page or section
</p></dd>
<dt> <code>print_About</code>
<a name="IDX167"></a>
</dt>
<dd><p>Formatting of about (help) page or section
</p></dd>
<dt> <code>print_Footnotes</code>
<a name="IDX168"></a>
</dt>
<dd><p>Formatting of footnotes section or page in case footnotes are on a
separated page or the document isn't split.
</p></dd>
</dl>
<p>In the default case, <a name="IDX169"></a>
<code>$print_Top</code> calls <a name="IDX170"></a>
<code>$print_Top_header</code> for
the header and <a name="IDX171"></a>
<code>$print_Top_footer</code> for the footer of top element.
All the other function call <a name="IDX172"></a>
<code>$print_misc</code> which in turn calls
<a name="IDX173"></a>
<code>$print_misc_header</code> for the headers and <a name="IDX174"></a>
<code>$print_misc_footer</code>
for the footers.
</p>
<hr size="6">
<a name="File-names"></a>
<a name="SEC45"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC44" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC46" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.12 Customizing the file names </h2>
<p>It is possible to specify the file names with more control than with the
command line options (see section <a href="#SEC7">Setting output file and directory names</a>).
First the extension may be overrided by the variable <a name="IDX175"></a>
<code>$EXTENSION</code>
value.
Two function references enable
further customization. One is usefull in case <a name="IDX176"></a>
<code>$NODE_FILES</code> is true
and it is used to customize the node file name itself and is also used
to produce a file name with a redirection leading to the node file.
</p>
<dl>
<dt><u>Function Reference:</u> ($node_file $redirection_node_file) <b>node_file_name</b><i> $node</i>
<a name="IDX177"></a>
</dt>
<dd><p><var>$node</var> is a hash reference with the following interesting keys (there
are much more keys):
</p><dl compact="compact">
<dt> <code>texi</code></dt>
<dd><p>The texinfo node name.
</p></dd>
<dt> <code>with_section</code></dt>
<dd><p>True if associated with a section.
</p></dd>
</dl>
<p>The result is the node file name <var>$node_file</var>, and the file containing
a redirection to the node <var>$redirection_node_file</var>.
</p></dd></dl>
<p>The other is usefull if <code>$NODE_FILES</code> isn't true. It is used to
customize the file associated with each element.
</p><dl>
<dt><u>Function Reference:</u> $file <b>element_file_name</b><i> $element $is_top $docu_name</i>
<a name="IDX178"></a>
</dt>
<dd><p><var>$element</var> is a hash reference with the following interesting keys (there
are much more keys):
</p><dl compact="compact">
<dt> <code>texi</code></dt>
<dd><p>The texinfo element name.
</p></dd>
<dt> <code>number</code></dt>
<dd><p>The number associated with a section.
</p></dd>
<dt> <code>doc_nr</code></dt>
<dd><p>A number incremented whenever a new file should begin, based on how the
document is split (see section <a href="#SEC6">Specifying where to split the generated document</a>).
</p></dd>
<dt> <code>text</code></dt>
<dd><p>The element text.
</p></dd>
<dt> <code>name</code></dt>
<dd><p>The element text without section number.
</p></dd>
</dl>
<p><var>$is_top</var> is true if the element is considered as the top element.
<var>$docu_name</var> is the basename of the texinfo manual.
The result is the element file name.
</p></dd></dl>
<hr size="6">
<a name="External-index-files"></a>
<a name="SEC46"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC45" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 6.13 Generation of external files for index entries </h2>
<p>Within the document, <code>@printindex</code> commands are expanded as explained
in <a href="#SEC78">Customizing the formatting of index lists</a>. In case you want to do something special with index
entries, outside of the document, you should first set the variable
<a name="IDX179"></a>
<code>$IDX_SUMMARY</code> true. After that some function reference will be called
for each non empty index. For each index there are 3 function
references, one called for initialization, one called for each index entry
and the last one called for finalazation.
</p>
<dl>
<dt><u>Function Reference:</u> <b>index_summary_file_begin</b><i> $index_name $is_printed</i>
<a name="IDX180"></a>
</dt>
<dd><p><var>$index_name</var> is the two letters name for the index.
This function
is called for each index
appearing in the document, before
<code>index_summary_file_entry</code>.
<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>index_summary_file_entry</b><i> $index_name $entry_text $entry_reference $formatted_entry $texi_entry $entry_element_reference $entry_element_header $is_printed</i>
<a name="IDX181"></a>
</dt>
<dd><p>This function is called for each entry of an index. <var>index_name</var> is the
name of the index. <var>$entry_text</var> is the entry in plain text,
<var>$formatted_entry</var> is the index entry formatted, <var>$texi_entry</var> is the
entry with texinfo commands. <var>$entry_reference</var> is the reference placed
at the index entry place, in the form <samp>`file#id'</samp>.
<var>$entry_element_header</var> is the formatted header of the element containing
the index entry. <var>entry_element_header</var> is the reference to the
beginning of the element containing the index entry, in the form
<samp>`file#id'</samp>.
<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> <b>index_summary_file_end</b><i> $index_name $is_printed</i>
<a name="IDX182"></a>
</dt>
<dd><p><var>$index_name</var> is the two letters name for the index. This function
is called for each index appearing in the document, after
<code>index_summary_file_entry</code>.
<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index.
</p></dd></dl>
<hr size="6">
<a name="Customizing-HTML"></a>
<a name="SEC47"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC46" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC48" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 7. Customizing <acronym>HTML</acronym> and text style in init files </h1>
<p>Some simple customization may be achieved with the redefinition of the
variables
associated with the command line options. For the description and an
explanation of the meaning of these variables, <a href="#SEC11">Customizing the <acronym>HTML</acronym> and text style</a>.
</p>
<p>Other variables and hash entries can be modified in initialization file
to achieve more customization.
Lastly, functions references corresponding with functions called from
the main program and initialization files may
be redefined.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC48">7.1 Three contexts for expansions: preformatted, normal and string</a></td><td> </td><td align="left" valign="top"> there are three different contexts for command
expansion: normal text, preformatted text and
strings.
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC54">7.4 Formatting of special simple commands</a></td><td> </td><td align="left" valign="top"> Formatting of <code>@anchor</code>, <code>@image</code>, <code>@sp</code>, <code>@acronym</code>, <code>@abbr</code>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC55">7.5 Processing special characters in text</a></td><td> </td><td align="left" valign="top"> Some characters are processed specially
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> <code>texi2html</code> write some strings in the output
different for each languages
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC57">7.7 References</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td><td> </td><td align="left" valign="top"> <code>@center</code>, <code>@flushleft</code>…
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td><td> </td><td align="left" valign="top"> <code>@example</code>, <code>@display</code>…
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC65">7.11 Customizing the formatting of lists and tables</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC68">7.12 Definition commands formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC71">7.13 Customizing headings formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC72">7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</a></td><td> </td><td align="left" valign="top"> <code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC73">7.15 Menu formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC76">7.16 Indices formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC79">7.17 Floats and lists of floats</a></td><td> </td><td align="left" valign="top"> <code>@float</code> and <code>@listoffloats</code>
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC82">7.18 Customizing the footnotes formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td><td> </td><td align="left" valign="top"> You can handle specifically other commands
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr></table>
<hr size="6">
<a name="Three-contexts"></a>
<a name="SEC48"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC47" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC49" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.1 Three contexts for expansions: preformatted, normal and string </h2>
<p>There are three contexts of interest, one is the normal context, the other
is a special context, called the <em>preformatted</em> context and the last is
the string context. The preformatted
context occurs when the spacing between words is kept. This is the
case, for example, in <code>@display</code> or <code>@example</code> regions, and in
menu comments (see section <a href="#SEC73">Menu formatting</a>). The preformatted regions are usually
rendered in <code><pre></code> elements in <acronym>HTML</acronym>.
The string context occurs when rendering strings without formatting elements,
in comments or titles for example.
</p>
<hr size="6">
<a name="Commands-without-argument"></a>
<a name="SEC49"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC48" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC50" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.2 Customizing the formatting of commands without argument </h2>
<p>This includes the commands whose name is a nonletter character like <code>@@</code>,
the commands with lettered characters and braces
but whose braces should be empty, like <code>@TeX{}</code>, or some commands
associated with accentted letters like <code>@AA{}</code>. If there happens to
be something within the braces, it is put after the command, thus
</p><table><tr><td> </td><td><pre class="example">@TeX{something}
</pre></td></tr></table><p>leads to the same than
</p><table><tr><td> </td><td><pre class="example">@TeX{} something
</pre></td></tr></table>
<p>Each of these categories of commands have three associated hashes, one
for normal
context, the other for preformatted context and the last in strings. The
keys of the hashes are the
command names, the associated value is the text replacing the command.
</p>
<p>The hashes are:
</p><table>
<tr><td><p> command type </p></td><td><p> normal text </p></td><td><p> preformatted text </p></td><td><p> string
</p></td></tr>
<tr><td><p> one nonlettered character </p></td><td> <a name="IDX183"></a>
<p><code>%simple_map</code> </p></td><td> <a name="IDX184"></a>
<p><code>%simple_map_pre</code> </p></td><td> <a name="IDX185"></a>
<p><code>%simple_map_texi</code>
</p></td></tr>
<tr><td><p> nothing in braces </p></td><td> <a name="IDX186"></a>
<p><code>%things_map</code> </p></td><td> <a name="IDX187"></a>
<p><code>%pre_map</code> </p></td><td> <a name="IDX188"></a>
<p><code>%texi_map</code>
</p></td></tr>
</table>
<p>To change the <acronym>HTML</acronym> resulting from these constructs, just change the
value. For example, if you want <code>&shy;</code> to be outputted for <code>@-</code>
in normal and preformatted context, write in your init file:
</p>
<table><tr><td> </td><td><pre class="example">$simple_map{'-'} = '&shy;';
$simple_map_pre{'-'} = '&shy;';
</pre></td></tr></table>
<hr size="6">
<a name="Style-and-accent-commands"></a>
<a name="SEC50"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC49" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC51" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.3 Customizing accent, style and other simple commands </h2>
<p>The formatting of the <acronym>HTML</acronym> produced by style and indicatric
commands (<code>@tt</code>, <code>@code</code>,
<code>@email</code>, <code>@titlefont</code>), the accentuation related
commands taking argument (<code>@'</code>, <code>@udotaccent</code>, <code>@dotless</code>)
and miscalleneous commands (<code>@email</code>, <code>@verb</code>, <code>@w</code>,
<code>@uref</code>, <code>@math</code>, <code>@asis</code>) is controlled by two hash in the
default case,
<a name="IDX189"></a>
<code>%style_map</code> for normal context, <a name="IDX190"></a>
<code>%style_map_pre</code> for
preformatted context and <a name="IDX191"></a>
<code>%style_map_texi</code> in string context.
</p>
<p>The key of the hashes are the command names. There are two possibilities for
the values corresponding with two interfaces. The values may be strings or
hash references, and you can chose the interface depending on the one you
prefer. The interface with hash reference is a bit more flexible but might also
be regarded as more complex. If you don't like either of these interfaces you
can define your own.
</p>
<p>Some remarks are in order:
</p>
<ul class="toc">
<li>
The nonlettered accent commands which following character is considered
to be the argument (like in <code>@`a</code>) should be keys of the
hash <a name="IDX192"></a>
<code>%accent_map</code> hash, even if no value is associated.
</li><li>
<code>@math</code> is handled differently if LaTeX2HTML is used.
</li></ul>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC53">7.3.3 Defining the style and indicatric commands interface</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Hash-reference-interface"></a>
<a name="SEC51"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC50" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC52" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.3.1 An interface for commands formatting with a hash reference </h3>
<p>The key of the hashes are the command names. The value determine how the command argument
is formatted. This value is a reference on a hash. In this hash each key
corresponds with a type of information for the formatting, and the value is
the corresponding information. For example, in
</p>
<table><tr><td> </td><td><pre class="example">$style_map{'command'} = { 'args' => ['code'], 'attribute' => 'code'};
</pre></td></tr></table>
<p>the arguments for <code>@command</code> are interpreted as specified by
the values associated with the <samp>`args'</samp> key while the attribute associated
with that command is <samp>`code'</samp>.
</p>
<p>The following keys in the hashes associated with each command have the
following meaning:
</p>
<dl compact="compact">
<dt> <samp>`args'</samp></dt>
<dd><p><a name="Reference-hash-args"></a>
The value associated is a reference on an array. Each element of the array
defines how the arguments (separated by <samp>`,'</samp> in the texinfo code) for
the @-command should be
formatted. The possibilities are
</p><dl compact="compact">
<dt> <code>normal</code></dt>
<dd><p>for normal text,
</p></dd>
<dt> <code>code</code></dt>
<dd><p>for text with <samp>`---'</samp>, <samp>`--'</samp>, <samp>`'''</samp> and <samp>```'</samp> kept as is,
</p></dd>
<dt> <code>keep</code></dt>
<dd><p>if the texinfo should be kept as is, without interpretation of the @-commands.
</p></dd>
</dl>
<p>For example, we have
</p><table><tr><td> </td><td><pre class="example">$style_map{'email'}->{'args'} = ['code', 'normal'];
</pre></td></tr></table>
<p>because <samp>`---'</samp>, <samp>`--'</samp>, <samp>`'''</samp> and <samp>```'</samp> should be kept as is in
the first argument of <code>@email</code>.
</p>
<p>The default is <samp>`['normal']'</samp>.
</p>
</dd>
<dt> <samp>`attribute'</samp></dt>
<dd>
<p>If the associated value is a word, it is considered to be an <acronym>HTML</acronym>
element name, and the argument is enclosed between the element opening
and the element closing. For example, if the value is <code>elem</code>, the
resulting <acronym>HTML</acronym> is <code><elem><var>arg</var></elem></code>.
</p>
<p>If the text is a word followed by some text,
the word and is interpreted as above, and the
text is considered to be the attributes text of the element.
Thus <code>elem class="elem"</code> leads to
<code><elem class="elem"><var>arg</var></elem></code>.
</p>
<p>This works only if there is only one argument.
</p>
</dd>
<dt> <samp>`begin'</samp></dt>
<dd>
<p>The associated value is added in front of the text.
</p>
</dd>
<dt> <samp>`begin'</samp></dt>
<dd>
<p>The associated value is added after the text.
</p>
</dd>
<dt> <samp>`quotes'</samp></dt>
<dd>
<p>If the corresponding value is true, the result is
enclosed in quotes <a name="IDX193"></a>
<code>$OPEN_QUOTE_SYMBOL</code> and
<a name="IDX194"></a>
<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults
<samp>``'</samp> and <samp>`''</samp>.
</p>
</dd>
<dt> <samp>`function'</samp> </dt>
<dd>
<p>The corresponding value should be a function reference. The corresponding
function is called with the following arguments:
</p>
<dl compact="compact">
<dt> <code>$command</code></dt>
<dd><p>The @-command name
</p></dd>
<dt> <code>$args</code></dt>
<dd><p>A reference on an array containing the arguments of the @-command.
</p></dd>
<dt> <code>$style_stack</code></dt>
<dd><p>A reference on an array containing the name of the @-commands containing
the @-command being formatted.
</p></dd>
<dt> <code>$state</code></dt>
<dd><p>A reference on a hash containing a lot of informations about the context
of the @-command.
</p></dd>
<dt> <code>$line_nr</code></dt>
<dd><p>An opaque structure containing the information about the line number of the
@-command. It can be used to call <code>main::echo_error</code> or
<code>main::echo_warning</code> with first argument a message, and second argument
<code>$line_nr</code>.
</p></dd>
</dl>
</dd>
</dl>
<hr size="6">
<a name="String-interface"></a>
<a name="SEC52"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC51" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC53" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.3.2 An interface for commands formatting with a string </h3>
<p>The keys of the hashes are the command names. The value determine
how the command argument
is formatted. If the value begins with <samp>`"'</samp>, the result is
enclosed in quotes <a name="IDX195"></a>
<code>$OPEN_QUOTE_SYMBOL</code> and
<a name="IDX196"></a>
<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults
<samp>``'</samp> and <samp>`''</samp>.
</p>
<p>The command argument is allready formatted as <acronym>HTML</acronym>.
The remaining of the value text
(or the value text if there were no <samp>`"'</samp>) is interpreted as follow:
</p>
<ul>
<li>
If the text is empty the argument of the command is left as is.
</li><li>
If the text is a <samp>`&'</samp> followed by a name,
like <samp>`&function'</samp>, the name is considered to be a function name,
and this function is called to format the argument of the command. The
first argument of the function is the command name, the second is
the command argument. For example, if the value associated with the
(fictituous) command <code>@foo</code> is <code>&my_func</code>
and we have:
<table><tr><td> </td><td><pre class="example">sub my_func
{
my @args = split /,\s*/ $_[1];
return "$_[0]: $args[0]" if ($args[1] = 1);
return "$args[0]";
}
</pre></td></tr></table>
<p>The result of
</p><table><tr><td> </td><td><pre class="example">@foo{truc, 1}
@foo{truc, bidule}
</pre></td></tr></table>
<p>will be
</p><table><tr><td> </td><td><pre class="example">foo: truc
truc
</pre></td></tr></table></li><li>
If the text is a word, it is considered to be an <acronym>HTML</acronym> element
name, and the argument is enclosed between the element opening
and the element closing. For example, if the value is <code>elem</code>, the
resulting <acronym>HTML</acronym> is <code><elem><var>arg</var></elem></code>.
Similarly <code>"quoted</code> leads to
<code>`<quoted><var>arg</var></quoted>'</code>.
</li><li>
If the text is a word followed by some text,
the word and is interpreted as above, and the
text is considered to be the attributes text of the element.
Thus <code>elem class="elem"</code> leads to
<code><elem class="elem"><var>arg</var></elem></code>.
</li></ul>
<hr size="6">
<a name="Define-your-own-interface"></a>
<a name="SEC53"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC52" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC54" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.3.3 Defining the style and indicatric commands interface </h3>
<p>If you don't like this scheme, it is possible to change how those commands
are processed by redefining the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $resulting_text <b>style</b><i> $style $command $text $args $no_close $no_open $line_nr $state $style_stack</i>
<a name="IDX197"></a>
</dt>
<dd><p><var>$command</var> is the @-command, <var>$style</var> is the value associated with
the <var>$command</var> in the <code>%style_map</code>, <code>%style_map_pre</code>
or <code>%style_map_texi</code> hashes.
The <var>$text</var> is the text appearing within the @-command braces.
<var>args</var> is a reference on an array contening the command arguments
formatted according to the same conventions than with the reference hash style
(provided the value associated with the @-command is a hash reference with a
<var>$arg</var> key as described in <a href="#Reference-hash-args">Reference hash args</a>).
If <var>$text</var> is split in paragraphs each paragraph is passed through
the function, and <var>$no_close</var> is true if it is not the last paragraph,
while <var>$no_open</var> is true if it is not the first paragraph.
<var>$line_nr</var>
is an opaque structure containing the information about the line number of the
@-command. It can be used to call <code>main::echo_error</code> or
<code>main::echo_warning</code> with first argument a message, and second argument
<code>$line_nr</code>.
<var>$state</var>
is a reference on a hash containing a lot of informations about the context
of the @-command.
<var>$style_stack</var>
is a reference on an array containing the name of the @-commands containing
the @-command being formatted.
</p>
</dd></dl>
<hr size="6">
<a name="Anchors-images-and-spaces"></a>
<a name="SEC54"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC53" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC55" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.4 Formatting of special simple commands </h2>
<p>The formatting of special simple commands is controlled by functions. To
customize the output, the corresponding function references should be
redefined. All these functions return a formatted text.
</p>
<p>The formatting of anchors is controlled by <a name="IDX198"></a>
<code>$anchor</code>, but the function
associated with the function reference does more, it is usefull
to produce a reference target or link.
</p><dl>
<dt><u>Function Reference:</u> $anchor <b>anchor</b><i> $identifier $href $text $attributes</i>
<a name="IDX199"></a>
</dt>
<dd><p>If <var>$identifier</var> is not empty, this value should be used to create
a target for links (typically associated with a name or id
attribute in <acronym>HTML</acronym>).
The <var>$href</var> argument specifies a hpertextual reference which should be
used to link to a target.
In case both <var>$identifier</var> and <var>$href</var> are given the text produced
should be both a target for <var>$identifier</var> and a link to <var>$href</var>.
<var>$text</var> is the text to be displayed.
<var>$attributes</var> are additional attributes.
It should be reasonable to assume that the attributes are for a <code><a></code>
<acronym>HTML</acronym> element.
</p></dd></dl>
<p>The formatting of <code>@image</code> is controlled by:
</p><dl>
<dt><u>Function Reference:</u> $image <b>image</b><i> $file_path $basename $preformatted $file_name</i>
<a name="IDX200"></a>
</dt>
<dd><p><var>$file_path</var> is the image file name with the path, <var>$basename</var> is the
alternate text or the file name without extension if no alternate text is
given. <var>$preformatted</var> is true if the image
appears in preformatted text. <var>$file_name</var> is the file name without path
but with extension.
</p></dd></dl>
<p>The formatting of <code>@sp</code> is controlled by:
</p><dl>
<dt><u>Function Reference:</u> $sp <b>sp</b><i> $number $preformatted</i>
<a name="IDX201"></a>
</dt>
<dd><p><var>$number</var> is the numeric argument of <code>@sp</code>.
<var>$preformatted</var> is true if the <code>@sp</code> appears in preformatted text.
</p></dd></dl>
<p>The formatting of <code>@acronym</code> and <code>@abbr</code> is controlled by:
</p><dl>
<dt><u>Function Reference:</u> $acronym <b>acronym_like</b><i> $acronym_texi $acronym_text $with_explanation \@explanation_lines $explanation_text $explanation_simply_formatted</i>
<a name="IDX202"></a>
</dt>
<dd><p><var>$acronym_texi</var> is the acronym argument with texinfo @-commands,
<var>$acronym_text</var> is formatted.
</p>
<p>The other arguments are related with
the explanation, the second arg of the acronym. <var>$with_explanation</var> is
true if the second argument of the acronym command is present. If an
explanation exists, coming from previous <code>@acronym</code> or as an arg of this
command, the other args are defined: <var>\@explanation_lines</var> is a
reference on an array containing the unformatted explanation lines,
<var>$explanation_text</var> is the explanation text formatted,
<var>$explanation_simply_formatted</var> is the explanation with a light formatting,
unabling in <acronym>HTML</acronym> (or <acronym>XML</acronym>) the explanation to be in an
attribute.
</p></dd></dl>
<hr size="6">
<a name="Text"></a>
<a name="SEC55"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC54" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC56" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.5 Processing special characters in text </h2>
<p>Some characters are processed especially in text: <samp>`---'</samp>, <samp>`--'</samp>,
<samp>```'</samp> and <samp>`'''</samp>. This is done only if in normal text and not in
some commands (<code>@code</code>, <code>@env</code>…). A function reference
is called to process those characters in text
</p>
<dl>
<dt><u>Function Reference:</u> $processed_text <b>normal_text</b><i> $text</i>
<a name="IDX203"></a>
</dt>
<dd><p>The function processes <samp>`---'</samp>, <samp>`--'</samp>, <samp>```'</samp> and <samp>`'''</samp>
in <var>$text</var> and returns <var>$processed_text</var>. The default is to
change <samp>`---'</samp> to <samp>`--'</samp>, <samp>`--'</samp> to <samp>`-'</samp>, and <samp>```'</samp> and
<samp>`'''</samp> to <samp>`"'</samp>.
</p></dd></dl>
<p>Some characters are special in <acronym>HTML</acronym> (<samp>`&'</samp>, <samp>`"'</samp>,
<samp>`<'</samp> and <samp>`>'</samp>) and should be protected.
This is done by the function associated with the function reference
</p>
<dl>
<dt><u>Function Reference:</u> $protected_text <b>protect_text</b><i> $text</i>
<a name="IDX204"></a>
</dt>
<dd><p>The function processes the unprotected text <var>$text</var> and returns
the resulting protected text <var>$protected_text</var>.
</p></dd></dl>
<p>Empty lines are processed by the following function reference, which could
be usefull if empty lines are to be removed for example
</p>
<dl>
<dt><u>Function Reference:</u> $resulting_text <b>empty_line</b><i> $empty_line</i>
<a name="IDX205"></a>
</dt>
<dd><p>This function processes an <var>$empty_line</var> and returns the resulting
text <var>$resulting_text</var>. Empty lines are left as is by default.
</p></dd></dl>
<hr size="6">
<a name="Strings"></a>
<a name="SEC56"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC55" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC57" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.6 Customizing strings written by <code>texi2html</code> </h2>
<p><code>texi2html</code> writes some strings in the generated document at
various places, at the page footers, on the help page, for special
section headings, buttons alt text and so on. These strings are
customizable. The string chosen depends on the language of the
document (set by <a name="IDX206"></a>
<samp>`--lang'</samp>, <a name="IDX207"></a>
<code>$LANG</code> or
<code>@documentlanguage</code>). This is the basis for internationalization
as it allows for strings translations.
</p>
<p>The strings are found in a hash reference, <a name="IDX208"></a>
<code>$LANGUAGES</code>.
Each key is a language code. The associated value is also a hash
reference. The key is an english string and the associated value
is the string replacing the english string, if present. For example,
we have
</p>
<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = {
' Up ' => 'Plus haut',
};
</pre></td></tr></table>
<p>It means that whenever the string <samp>` Up '</samp> is to be written
and the language is <samp>`fr'</samp>, <samp>`Plus haut'</samp> is written. It is possible
to customize the english strings by redefining the <samp>`en'</samp> language hash.
</p>
<p>When a string contains a <samp>`%'</samp> followed by <samp>`{'</samp> <var>name</var> <samp>`}'</samp>
it means that the string will be expanded by <code>texi2html</code>. For
example, if we have
</p>
<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = {
'See %{node_file_href}' => 'Voir %{node_file_href}',
};
</pre></td></tr></table>
<p><samp>`%{node_file_href}'</samp> will be expanded to an href for a node in a
file by <code>texi2html</code> in the string. A <samp>`%%'</samp> will be expanded
as <samp>`%'</samp>.
</p>
<p>For more on internationalization, see <a href="#SEC84">Internationalization</a>.
</p>
<hr size="6">
<a name="References"></a>
<a name="SEC57"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC56" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC58" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.7 References </h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC59">7.7.2 Reference to an internal node</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Reference-to-external-manual"></a>
<a name="SEC58"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC57" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC59" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.7.1 Reference to external manual </h3>
<p>The references are produced with two function references, one for the
hypertextual reference construction, the other for the full reference to
external manual.
</p>
<dl>
<dt><u>Function Reference:</u> $href <b>external_href</b><i> $node $node_identifier $xml_node_identifier $manual_file_name</i>
<a name="IDX209"></a>
</dt>
<dd><p><var>$node</var> is the node name, with @-commands. <var>$node_identifer</var> is the
node name mapped to an identifier acceptable as a file name.
<var>$xml_node_identifier</var> is the
node name mapped to an identifier acceptable as an <acronym>XML</acronym> identifier.
Those identifiers are built as explained in <a href="texinfo.html#HTML-Xref">(texinfo)HTML Xref</a>,
thus allowing for cross references to external manuals. <var>$file</var> is the
manual or file name of the external reference. This function should return an
href leading to the external manual.
</p>
<p>The default for this function is to make a reference compatible with
<code>makeinfo</code> (see <a href="texinfo.html#HTML-Xref">(texinfo)HTML Xref</a>).
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $text <b>external_ref</b><i> $command $section $book $node_and_file $href $cross_ref_name</i>
<a name="IDX210"></a>
</dt>
<dd><p>This function formats a reference to an external texinfo manual.
The <var>$command</var> is the ref command (<code>ref</code>, <code>xref</code> or
<code>pxref</code>, in text, at sentence beginning or in parenthesis).
The optionnal <var>$section</var> argument is the section in the book and
<var>book</var> is the book title.
<var>$node_and_file</var> is the node and file name formatted according to the
convention used in info: <samp>`(file)node'</samp>. <var>$href</var> it an hypertextual
reference to the distant manual constructed using the above function.
<var>$cross_ref_name</var> is an optionnal cross
reference name appearing in the reference command. This function returns
the text corresponding with the external html manual reference.
This function returns the full formatted text of the external reference.
</p></dd></dl>
<hr size="6">
<a name="Internal-reference"></a>
<a name="SEC59"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC58" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC60" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.7.2 Reference to an internal node </h3>
<p>A function reference is available for internal references.
</p>
<dl>
<dt><u>Function Reference:</u> $text <b>internal_ref</b><i> $command $href $short_name $name $is_section</i>
<a name="IDX211"></a>
</dt>
<dd><p>This function formats a reference to a node in the current manual.
The <var>$command</var> is the ref command (<code>ref</code>, <code>xref</code> or
<code>pxref</code>, in text, at sentence beginning or in parenthesis).
<var>$href</var> it an hypertextual reference linking to the corresponding
node or section. <var>$short_name</var> and <var>$name</var> hold the text for the
reference but <var>$short_name</var> can be the node name which is assumed to
be shorter than the section name.
<var>$is_section</var> is a boolean true if the reference is a reference to a
section. This function returns the full formatted text of the internal
reference.
</p></dd></dl>
<hr size="6">
<a name="Alignement-commands"></a>
<a name="SEC60"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC59" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC61" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.8 Commands used for centering and flushing of text </h2>
<p>When a command controlling the alignement of text is used (<code>@center</code>,
<code>@flushleft</code> and <code>@flushright</code>), the main program takes
care of opening and closing paragraphs. The alignement commands are the
key of the <a name="IDX212"></a>
<code>%paragraph_style</code> hash.
The value is used in the function doing the formatting of the paragraphs.
See section <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>.
</p>
<p>A function references allows for a customization of the formatting of the text
appearing in the command block.
</p>
<dl>
<dt><u>Function Reference:</u> $result <b>paragraph_style_command</b><i> $command $text</i>
<a name="IDX213"></a>
</dt>
<dd><p><var>$command</var> is the command name, <var>$text</var> is the text appearing within
the command. This function returns a formatted text.
The default is to return the text unmodified.
</p></dd></dl>
<hr size="6">
<a name="Paragraph-and-preformatted-region"></a>
<a name="SEC61"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC60" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC62" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.9 Formatting or not a paragraph or a preformatted region </h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Paragraph-and-preformatted-formatting"></a>
<a name="SEC62"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC61" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC63" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.9.1 Paragraph and preformatted region formatting </h3>
<p>The formatting of a paragraph region or a preformatted region, is controlled
by function references:
</p>
<dl>
<dt><u>Function Reference:</u> $paragraph_text <b>paragraph</b><i> $text $alignement $formatting_command $formatting_command_formatted \$paragraph_number $format $item_number $enumerate_style $number</i>
<a name="IDX214"></a>
</dt>
<dd><p>This function formats a paragraph. <var>$text</var> is the text of the paragraph,
<var>$alignement</var> is the empty string when no alignement command has
been seen, otherwise it is the current alignement command name.
See section <a href="#SEC60">Commands used for centering and flushing of text</a>.
</p>
<p>The remaining arguments are usefull when the paragraph appears within a
list or table. It is usefull whenever the paragraph has to be formatted
differently when appearing in such environments.
Moreover in that case the format command (<code>@itemize</code>…)
may have
an associated formatting command.
<var>$formatting_command</var> is this formatting command
(like <code>@minus</code>).
<var>$formatting_command_formatted</var> is the command formatted in html
in case the formatting command is a leading command (like <code>@minus</code>)
which should be leading the first paragraph.
<var>\$paragraph_number</var> is a reference on the number of
paragraphs in that format command. The corresponding variable should be
increased when a paragraph is added. <var>$format</var> is the format command.
See section <a href="#SEC66">Formatting individual table and list items</a>.
</p>
<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of
the item in the list, <var>$enumerate_style</var> is the argument of the enumerate,
<var>$number</var> is the number or letter corresponding with this item.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $preformatted_text <b>preformatted</b><i> $text $style $region_name $formatting_command $formatting_command_formatted \$preformatted_number $format $item_number $enumerate_style $number</i>
<a name="IDX215"></a>
</dt>
<dd><p>This function formats a preformatted region. <var>$text</var> is the text of the
preformatted region, <var>$style</var> is the css style associated with that
preformatted region (See section <a href="#SEC34">Customizing the <code>texi2html</code> css lines</a>). <var>$region_name</var> is the
name of the command opening
the preformatted region (<code>example</code>…, see <a href="#SEC64">Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a>)
or a identifier for the preformatted context (for example
<code>menu-comment</code>, see <a href="#SEC73">Menu formatting</a>).
The alignment commands are not taken into account, as the spaces are
preserved in preformatted regions, you should flush and center by hand.
</p>
<p>The remaining arguments are usefull when the preformatted region appears
within a list or table. It is usefull whenever the preformatted region
has to be formatted
differently when appearing in such environments.
Moreover in that case the format command (<code>@itemize</code>…)
may have
an associated formatting command.
<var>$formatting_command</var> is this formatting command
(like <code>@minus</code>).
<var>$formatting_command_formatted</var> is the command formatted in html
in case the formatting command is a leading command (like <code>@minus</code>)
which should be leading the first preformatted region.
<var>\$preformatted_number</var> is a reference on the number of
preformatted regions in that format command. The corresponding variable
should be increased when a preformatted region is added. <var>$format</var> is the
format command.
See section <a href="#SEC66">Formatting individual table and list items</a>.
</p>
<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of
the item in the list, <var>$enumerate_style</var> is the argument of the enumerate,
<var>$number</var> is the number or letter corresponding with this item.
</p></dd></dl>
<hr size="6">
<a name="Avoiding-paragraphs"></a>
<a name="SEC63"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC62" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC64" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.9.2 Avoiding paragraphs in formats </h3>
<p>It is possible to avoid that a format closes the previous paragraph or
preformatted region and reopens one, by putting the format command in a
hash, <a name="IDX216"></a>
<code>%format_in_paragraph</code> with a true value.
</p>
<hr size="6">
<a name="Complex-formats"></a>
<a name="SEC64"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC63" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC65" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…) </h2>
<p>Here we see how a whole complex format is formatted. For the formatting
of the text, see <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>.
</p>
<p>The formatting of the complex formats is ultimately controlled by a
function, however the default for this function uses a hash reference and
changing the hash reference values should be enough in most cases. This
hash reference is called <a name="IDX217"></a>
<code>$complex_format_map</code>. It has a key for each
of the complex format commands (<code>example</code>, <code>smallexample</code>,
<code>lisp</code>, <code>smalllisp</code>, <code>display</code>, <code>smalldisplay</code>,
<code>format</code>, <code>smallformat</code>).
</p>
<p>The associated value is also a reference on a hash. The keys are <code>begin</code>
and <code>end</code>. An eval of <code>begin</code> should lead to the beginning of the
formatted <acronym>HTML</acronym>, an eval of <code>end</code> should lead to the end of the
formatted <acronym>HTML</acronym>. The enclosed text will be formatted as described in
<a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>, and the name of the complex
format will be available to the function formatting the text.
</p>
<p>If you aren't satisfied with this scheme, you can redefine the following
function reference for a better control over the complex format formatting:
</p>
<dl>
<dt><u>Function Reference:</u> $complex_format_text <b>complex_format</b><i> $format_name $preformatted_text</i>
<a name="IDX218"></a>
</dt>
<dd><p><var>$format_name</var> is the complex format name, <var>$preformatted_text</var> is the
text allready formatted as described in <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>.
This function returns the whole complex format.
</p></dd></dl>
<hr size="6">
<a name="Lists-tables"></a>
<a name="SEC65"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC64" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC66" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.11 Customizing the formatting of lists and tables </h2>
<p>The formatting of lists and tables is done at two levels:
</p><ul class="toc">
<li>
At the level of the whole region (table or list),
</li><li>
At the level of the individual items, rows or cells of the list or table.
</li></ul>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Table-and-list-items"></a>
<a name="SEC66"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC65" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC67" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.11.1 Formatting individual table and list items </h3>
<p>In texinfo it is possible to give <code>@itemize</code> or table command (hereafter
called a <em>format command</em>) a <em>formatting command</em>.
For example <code>@minus</code> is the formatting command here:
</p><table><tr><td> </td><td><pre class="example">@table @minus
</pre></td></tr></table>
<p>The default is to apply the command to the text item, however it is possible
to avoid it.
The hash <a name="IDX219"></a>
<code>%special_list_commands</code> has an entry for each of the
format command. Each of these entries is a hash reference. If a formatting
command is a key of the hash reference, then the formatting command is not
applied to the text item for that format command. For example, if we have:
</p>
<table><tr><td> </td><td><pre class="example">$special_list_commands{'itemize'} = { 'bullet' => '' };
</pre></td></tr></table>
<p>and we have the following <code>@itemize</code>:
</p><table><tr><td> </td><td><pre class="example">@itemize @bullet
@item an item
@end itemize
</pre></td></tr></table>
<p>then <code>@bullet</code> will not be applied to <code>an item</code>.
</p>
<dl compact="compact">
<dt> <em>lists</em></dt>
<dd><p>The items of lists are formatted using the following function reference:
</p><dl>
<dt><u>Function Reference:</u> $list_item <b>list_item</b><i> $text $format $command $formatted_command $item_number $enumerate_style $number</i>
<a name="IDX220"></a>
</dt>
<dd><p>This function formats the text between <code>@item</code> commands. <var>$text</var>
is the text corresponding with the item. <var>$format</var> is the type of format,
<samp>`itemize'</samp> or <samp>`enumerate'</samp>. <var>$command</var> is the formatting command
given in argument to <code>@itemize</code>, <var>$formatted_command</var> is this command
formatted if it is a leading command, like <code>@minus</code>.
</p>
<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of
the item in the list, <var>$enumerate_style</var> is the argument of the enumerate,
<var>$number</var> is the number or letter corresponding with this item.
</p></dd></dl>
</dd>
<dt> <em>two column tables</em></dt>
<dd><p>The two columns tables (<code>@table</code>, <code>@ftable</code> and <code>@vtable</code>),
items are formatted using two function references,
one for the first line located on the <code>@item</code> line corresponding
with the first column, the other for the text appearing on the
following lines, corresponding with the second column text.
</p>
<dl>
<dt><u>Function Reference:</u> $table_item <b>table_item</b><i> $item_text $index_label_text $format $command $formatted_command</i>
<a name="IDX221"></a>
</dt>
<dd><p>This function is used to format the text on the <code>@item</code> line.
<var>$text_item</var> is the text line. In case there is an index entry
associated with the <code>@item</code> (as with <code>@ftable</code> and
<code>@vtable</code>), <var>$index_label_text</var> is the text inserted at
the place where an index entry appears. See section <a href="#SEC77">Formatting of index entries</a>.
<var>$format</var> is the type of format,
<samp>`table'</samp>, <samp>`ftable'</samp> or <samp>`vtable'</samp>. <var>$command</var> is the formatting command
given in argument to the table format command, <var>$formatted_command</var> is
this command formatted if it is a leading command, like <code>@minus</code>.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $table_line <b>table_line</b><i> $text</i>
<a name="IDX222"></a>
</dt>
<dd><p>This function is used to format the text on the lines following
the <code>@item</code> line. <var>$text</var> is the corresponding text.
</p></dd></dl>
</dd>
<dt> <em>multitable</em></dt>
<dd><p>The multitable elements formatting is controlled by the functions associated
with two function references. One for a cell, and the other for a row.
</p>
<dl>
<dt><u>Function Reference:</u> $multitable_cell <b>cell</b><i> $text</i>
<a name="IDX223"></a>
</dt>
<dd><p>This function is used to format the text of a multitable cell, the text
following a <code>@item</code> or a <code>@tab</code>.
<var>$text</var> is the corresponding text.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $multitable_row <b>row</b><i> $text $item_command</i>
<a name="IDX224"></a>
</dt>
<dd><p>This function is used to format a multitable row. <var>$text</var> is
the row text, with cells allready formatted with the <a name="IDX225"></a>
<code>$cell</code>
function reference. <var>$item_command</var> is the command used to introduce
the row, such that it is possible to distinguish between <code>@item</code> and
<code>@headitem</code>.
</p></dd></dl>
</dd>
</dl>
<hr size="6">
<a name="Whole-table-list"></a>
<a name="SEC67"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC66" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.11.2 Formatting of a whole table or list </h3>
<p>If the Texinfo command is a key of the <a name="IDX226"></a>
<code>%format_map</code>, the associated
value is used to specify the formatting of the construct, otherwise a function
is called.
The value in <code>%format_map</code> associated with a command is interpreted
similarly with values associated with more simpler commands:
</p>
<ul class="toc">
<li>
If the text is a word, it is considered to be an <acronym>HTML</acronym> element
name, and the whole table or list is enclosed between the element opening
and the element closing.
</li><li>
If the text is a word followed by some text,
the word and is interpreted as above, and the
text is considered to be the attributes text of the element.
</li><li>
If the text is empty nothing is added to the text.
</li></ul>
<p>In case the <code>%format_map</code> isn't used, a function reference called
<code>$table_list</code>
should be redefined, the associated function will be called each time
a command isn't found in <code>%format_map</code>.
</p>
<dl>
<dt><u>Function Reference:</u> $whole_table_list <b>table_list</b><i> $command $text</i>
<a name="IDX227"></a>
</dt>
<dd><p><var>$command</var> is the Texinfo command name, <var>$text</var> is the formatted
items.
</p></dd></dl>
<p>If you still want to use <a name="IDX228"></a>
<code>%format_map</code> but differently from
the default, it is possible to redefine the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $whole_table_list <b>format</b><i> $command $format $text</i>
<a name="IDX229"></a>
</dt>
<dd><p><var>$command</var> is the @-command, <var>$format</var> is the entry associated with
<var>$command</var> in <code>%format_map</code>. <var>$text</var> is the formatted items.
</p></dd></dl>
<hr size="6">
<a name="Definitions"></a>
<a name="SEC68"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC67" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC69" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.12 Definition commands formatting </h2>
<p>The formatting of definition commands is controlled by a hash and four
functions. The hash describes how the text on the definition line is
interpreted, the functions control the formatting of the definition line
and the definition function text.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC70">7.12.2 Customization of the definition formatting</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Definition-line"></a>
<a name="SEC69"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC68" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC70" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.12.1 Customizing the interpretation of a definition line </h3>
<p>The keys of the hash <a name="IDX230"></a>
<code>%def_map</code> are definition command names.
There are two types of entries:
</p>
<ul class="toc">
<li> If the command is a shortcut for
another definition command the value is a text and the definition
command is replaced by the text.
<p>For example if we have:
</p><table><tr><td> </td><td><pre class="example">$def_map{'deftruc'} = '@defvr {A truc}';
</pre></td></tr></table>
<p>and a line like
</p><table><tr><td> </td><td><pre class="example">@deftruc var
</pre></td></tr></table>
<p>the line will be transformed in
</p><table><tr><td> </td><td><pre class="example">@defvr {A truc} var
</pre></td></tr></table>
</li><li>
If the command isn't a shortcut, it is associated with an array
reference. The first element is <samp>`f'</samp>, <samp>`v'</samp> or <samp>`t'</samp> corresponding
with the index type (<samp>`f'</samp> for function, <samp>`v'</samp> for variable,
<samp>`t'</samp> for type).
<p>The remaining of the array describes how to interpret the text following
the definition command on the definition command line.
The entry item specify what corresponds
with the next bracketed item or word. Currently the possibilities are
<samp>`category'</samp>, <samp>`name'</samp>, <samp>`type'</samp>, <samp>`class'</samp> and <samp>`arg'</samp>.
</p>
<p>For example if we have
</p><table><tr><td> </td><td><pre class="example">def_map{'defvr'} = [ 'v', 'category', 'name' ];
</pre></td></tr></table>
<p>The first bracketed item following <code>@defvr</code> is considered
to be the category and the next one is the name. The index associated
with the definition line is the variables index.
</p></li></ul>
<hr size="6">
<a name="Definition-formatting"></a>
<a name="SEC70"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC69" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC71" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.12.2 Customization of the definition formatting </h3>
<p>Four functions are used when formatting a definition command:
</p>
<dl compact="compact">
<dt> category name</dt>
<dd><dl>
<dt><u>Function Reference:</u> $category <b>definition_category</b><i> $category_or_name $class $style</i>
<a name="IDX231"></a>
</dt>
<dd><p>This function precise a category or an index entry name associating a class
<var>$class</var> (if given) with <var>$category_or_name</var>. The <var>$style</var> of the
definition may be <samp>`f'</samp>, for function, <samp>`v'</samp>, for variable or <samp>`t'</samp>,
for type.
</p></dd></dl>
</dd>
<dt> formatting of the definition line</dt>
<dd><dl>
<dt><u>Function Reference:</u> $line <b>def_line</b><i> $category $name $type $arguments $index_label</i>
<a name="IDX232"></a>
</dt>
<dd><p>This function formats the definition line. <var>$category</var> is the category
formatted with <a name="IDX233"></a>
<code>$definition_category</code>, <var>$name</var>, <var>$type</var> and
<var>arguments</var> are the element of the definition line. <var>$index_label</var> is
the text inserted at the place where an index entry appears.
See section <a href="#SEC77">Formatting of index entries</a>.
</p></dd></dl>
</dd>
<dt> definition text</dt>
<dd><dl>
<dt><u>Function Reference:</u> $definition_text <b>def_item</b><i> $text</i>
<a name="IDX234"></a>
</dt>
<dd><p>This function formats the definition text, <var>$text</var>.
</p></dd></dl>
</dd>
<dt> the whole definition</dt>
<dd><dl>
<dt><u>Function Reference:</u> $definition <b>def</b><i> $text</i>
<a name="IDX235"></a>
</dt>
<dd><p>This function formats the whole definition. The definition line and text
formatted by the above functions are in <var>$text</var>.
</p></dd></dl>
</dd>
</dl>
<hr size="6">
<a name="Headings"></a>
<a name="SEC71"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC70" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC72" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.13 Customizing headings formatting </h2>
<p>A function controls the formatting of sectioning element headings,
with the corresponding function reference:
</p><dl>
<dt><u>Function Reference:</u> $heading_text <b>heading</b><i> \%element_reference</i>
<a name="IDX236"></a>
</dt>
<dd><p>The <var>\%element_reference</var> is a reference on a hash corresponding
with the sectioning element. The following keys are of interest:
</p><dl compact="compact">
<dt> <code>text</code></dt>
<dd><p>The heading text
</p></dd>
<dt> <code>name</code></dt>
<dd><p>The heading text without section number
</p></dd>
<dt> <code>node</code></dt>
<dd><p>true if the sectioning element is a node without associated structuring command
</p></dd>
<dt> <code>level</code></dt>
<dd><p>The level of the element in the document tree. <samp>`0'</samp> is for <code>@top</code>,
<samp>`1'</samp> for <code>@chapter</code> and so on
</p></dd>
<dt> <code>tag_level</code></dt>
<dd><p>the sectioning element name, with <code>@raisesections</code> and
<code>@lowersections</code> taken into account
</p></dd>
</dl>
</dd></dl>
<hr size="6">
<a name="Special-regions"></a>
<a name="SEC72"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC71" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC73" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>) </h2>
<p>Regions corresponding with raw text, like <code>@verbatim</code>, <code>@html</code>
or <code>@tex</code> are formatted according to the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $raw_region <b>raw</b><i> $command $text</i>
<a name="IDX237"></a>
</dt>
<dd><p><var>$command</var> is the command name, <var>$text</var> is the raw text.
</p></dd></dl>
<p>If LaTeX2HTML is used, <code>@tex</code> regions are handled differently,
from within the main program.
</p>
<p>The <code>@cartouche</code> command formatting is controlled by the
function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $cartouche <b>cartouche</b><i> $text</i>
<a name="IDX238"></a>
</dt>
<dd><p><var>$text</var> is the text appearing within the cartouche.
</p></dd></dl>
<p>The formatting of <code>@quotation</code> is controlled by two function references.
The first one is usefull in case the <code>@quotation</code> has an argument, as
it allows to prepend a string to the quotation text:
</p>
<dl>
<dt><u>Function Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $style $text</i>
<a name="IDX239"></a>
</dt>
<dd><p><var>$style</var> is the first argument of the <code>@quotation</code> if there are
two arguments. <var>$text</var> is the second argument or the first if there is
one argument. There are still @-commands in these strings. This function
can return a string which will be prepended to the quotation text.
</p></dd></dl>
<p>The whole quotation is formatted by:
</p>
<dl>
<dt><u>Function Reference:</u> $quotation <b>quotation</b><i> $quotation_text $argument_text $argument_style_texi $argument_style_id</i>
<a name="IDX240"></a>
</dt>
<dd><p><var>$quotation_text</var> is the quotation text, formatted, with the text
prepended by the function above. <var>$argument_text</var> is the second argument
of the <code>@quotation</code> or the first if there is one argument, formatted.
The other arguments are defiend if there are two arguments for the
<code>@quotation</code>, <var>$argument_style_texi</var> is this argument, with
@-commands, and <var>$argument_style_id</var> is this argument transformed in
an identifier which can be used as an <acronym>XML</acronym> identifier.
</p></dd></dl>
<hr size="6">
<a name="Menus"></a>
<a name="SEC73"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC72" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC74" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.15 Menu formatting </h2>
<p>To understand how the formatting of menus is controlled, the different
parts of a menu are first described, then how to control the formatting
of each of these parts.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC74">7.15.1 The structure of a menu</a></td><td> </td><td align="left" valign="top"> A menu consists in menu entry and menu
comments
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Menu-parts"></a>
<a name="SEC74"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC73" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC75" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.15.1 The structure of a menu </h3>
<p>In <code>texi2html</code>, a menu is considered to be composed of 2 parts, the
<em>menu entries</em> and the <em>menu comments</em>. Menu entries are further
divided in an <em>entry link</em> and optionnaly an <em>entry description</em>.
The entry link consists in a node name and an optionnal menu entry
name.
</p>
<p>A menu entry begins with <samp>`*'</samp> at the beginning of the line. It begins
with the entry link, followed by the description. The description spans until
the next menu entry, or some text begining at the first character of a line
or an empty line, not contained within a command block which begun in the
description. An empty line or a line with text at the first character
starts a menu comment, which spans until the next menu entry.
</p>
<p>Here is an illustration of these rules:
</p>
<table><tr><td> </td><td><pre class="example">@menu
* node name: entry name. description begins
description continues
* another menu entry::
description begins
description continues
A menu comment, after an empty line
* node:: description begins
A menu comment. The line starts at the first character
* last entry:: description begins <em>text
of the description, even if the line begins at the first character,
because we are in @emph</em>.
@end menu
</pre></td></tr></table>
<hr size="6">
<a name="Menu-formatting"></a>
<a name="SEC75"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC74" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.15.2 The formatting of the different menu components </h3>
<p>In the default case, the name of the section corresponding with the
node is used instead of the node name. If <a name="IDX241"></a>
<code>$NODE_NAME_IN_MENU</code> is
true, however, node names are used. If <a name="IDX242"></a>
<code>$AVOID_MENU_REDUNDANCY</code>
is true and menu entry equal menu description the description isn't printed.
This is the default. Likewise, if node or section name equal entry name,
do not print entry name.
</p>
<p>A symbol, <a name="IDX243"></a>
<code>$MENU_SYMBOL</code> is put at the beginning of menu entries
when the node name is used. The default is <samp>`&bull;'</samp>.
If <a name="IDX244"></a>
<code>$UNNUMBERED_SYMBOL_IN_MENU</code> is true it is
also put at the beginning of unnumbered section names. This is not
done by default.
</p>
<p>The menu comments are considered to be preformatted text. The style
associated with this preformatted text is determined by
<a name="IDX245"></a>
<code>$MENU_PRE_STYLE</code>. Default is <samp>`font-family: serif'</samp>.
The css class associated with menu comments is <code>menu-comments</code>.
</p>
<p>Three function references are associated with the formatting of the
different parts of a menu:
</p><dl>
<dt><u>Function Reference:</u> $link <b>menu_link</b><i> $section \%state $href $node $name $ending</i>
<a name="IDX246"></a>
</dt>
<dd><p><var>$section</var> is the section name corresponding with the link, <var>$href</var>
is the link hypertextual reference. <var>$href</var> may be absent. <var>\%state</var>
holds informations about the current context. The only key which could be
of interest is <code>preformatted</code>, true if the context is a preformatted
context. See section <a href="#SEC48">Three contexts for expansions: preformatted, normal and string</a>.
<var>$node</var> is the node name, <var>$name</var> is the
name of the node, and <var>$ending</var> is the text ending the link entry.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $description <b>menu_description</b><i> $description_text \%state</i>
<a name="IDX247"></a>
</dt>
<dd><p><var>$description_text</var> is the text of the menu description. <var>\%state</var>
should be used similarly than for the menu link.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $menu_comment <b>menu_comment</b><i> $text</i>
<a name="IDX248"></a>
</dt>
<dd><p><var>$text</var> is the text of the menu comment. It is in a preformatted
environment.
</p></dd></dl>
<p>The following function reference controls the formatting of a wole menu:
</p>
<dl>
<dt><u>Function Reference:</u> $menu <b>menu</b><i> $menu_components_text</i>
<a name="IDX249"></a>
</dt>
<dd><p><var>$menu_components_text</var> is the formatted menu components text, obtained
as explained above.
</p></dd></dl>
<p>The last function reference corresponds with a special case. It
is used when a menu entry appears within another block command, to
avoid the possibilities of invalid <acronym>HTML</acronym> production.
In that case the menu description and menu comments are not formatted
specially, but treated like normal text.
</p><dl>
<dt><u>Function Reference:</u> $link <b>simple_menu_link</b><i> $link_text $href $node $name $ending</i>
<a name="IDX250"></a>
</dt>
<dd><p><var>$link_text</var> is the text corresponding with the link name, <var>$href</var>
is the link hypertextual reference.
<var>$node</var> is the node name, <var>$name</var> is the
name of the node, and <var>$ending</var> is the text ending the link entry.
</p></dd></dl>
<hr size="6">
<a name="Indices"></a>
<a name="SEC76"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC75" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC77" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.16 Indices formatting </h2>
<p>Two different things needs to be handled for indices formatting, the place
where the index term appears, the index entry, and the index list itself.
The indexing commands like <code>@cindex</code> determines where index entries
appear, and the index list is printed with a <code>@printindex</code> command.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC77">7.16.1 Formatting of index entries</a></td><td> </td><td align="left" valign="top"> Index entries in the main document are
targets for hypertext references
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC78">7.16.2 Customizing the formatting of index lists</a></td><td> </td><td align="left" valign="top"> Customizing the formatting of the index list
</td></tr>
</table>
<hr size="6">
<a name="Index-entry-place"></a>
<a name="SEC77"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC76" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC78" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.16.1 Formatting of index entries </h3>
<p>Index entry places in the main text may be the target for hypertext
references. Their formatting
is controlled by the function associated with the following function
reference:
</p>
<dl>
<dt><u>Function Reference:</u> $target <b>index_entry_label</b><i> $identifier $preformatted</i>
<a name="IDX251"></a>
</dt>
<dd><p><var>$identifier</var> should be used to create
a target for links (typically associated with a name or id
attribute in <acronym>HTML</acronym>).
<var>$preformatted</var> is true if the index entry appeared in preformatted text.
</p></dd></dl>
<hr size="6">
<a name="Index-list"></a>
<a name="SEC78"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC77" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC79" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.16.2 Customizing the formatting of index lists </h3>
<p>The index entries are sorted alphabetically. A whole index list is
considered to be composed of letter entries. A letter entry is composed
by all the index entries beginning with that letter. A letter may
be a non alphabetical character, but we call it letter here.
</p>
<p>An index summary appears at the beginning and at the end of an index list,
and should be used to jump directly to a letter entry. Indices lists
may be split across pages, thus the different letters may appear on different
files. The number of index entries appearing on each page is determined
by a variable <a name="IDX252"></a>
<code>$SPLIT_INDEX</code> if set. The default is to split
indices after 100 entries.
</p>
<p>The formatting of all these elements is controlled by the following
function references:
</p>
<dl compact="compact">
<dt> <em>formatting of a letter in a summary</em></dt>
<dd><dl>
<dt><u>Function Reference:</u> $letter <b>summary_letter</b><i> $letter $file $identifier</i>
<a name="IDX253"></a>
</dt>
<dd><p>This function is used to format a letter appearing in a summary, refering
to a letter entry in the index list.
<var>$letter</var> is the letter. <var>$file</var> is the file name where the letter
entry appears. More precisely, it is empty when the letter entry is on the
same page than the summary, it contains the file name when the index page
is split accross page. <var>$identifier</var> is an identifier for the target
letter entry.
</p></dd></dl>
</dd>
<dt> <em>formatting of a summary</em></dt>
<dd><dl>
<dt><u>Function Reference:</u> $summary <b>index_summary</b><i> \@alphabetical_letters \@nonalphabetical_letters</i>
<a name="IDX254"></a>
</dt>
<dd><p><var>\@alphabetical_letters</var> and <var>\@nonalphabetical_letters</var> contain the
formatted summary letters, formatted with the above function.
</p></dd></dl>
</dd>
<dt> <em>formatting of an index entry</em></dt>
<dd><dl>
<dt><u>Function Reference:</u> $entry <b>index_entry</b><i> $entry_href $entry_text $section_href $section_heading</i>
<a name="IDX255"></a>
</dt>
<dd><p><var>$entry_href</var> is a reference to the place where the index entry
appeared, <var>$entry_text</var> is the corresponding text. <var>$section_href</var>
is a reference to the beginning of the sectioning element containing
the index entry, <var>$section_heading</var> is the heading of the element.
</p></dd></dl>
</dd>
<dt> <em>formatting of letter entry</em></dt>
<dd><dl>
<dt><u>Function Reference:</u> $letter_entry <b>index_letter</b><i> $letter $identifier $index_entries_text</i>
<a name="IDX256"></a>
</dt>
<dd><p>This function formats a letter entry, consisting in all the index entries
beginning with this letter. <var>$letter</var> is the letter, <var>$identifier</var>
should be used to create a target for links (typically links from summaries),
and <var>$index_entries_text</var> is the text of the index entries formatted as
described above.
</p></dd></dl>
</dd>
<dt> <em>formatting of whole index</em></dt>
<dd><dl>
<dt><u>Function Reference:</u> $index <b>print_index</b><i> $index_text $index_name</i>
<a name="IDX257"></a>
</dt>
<dd><p><var>$index_text</var> is the text of all the index entries grouped by letter
appearing in that page formatted as above. <var>index_name</var> is the name of
the index, the argument of <code>@printindex</code>.
</p></dd></dl>
</dd>
</dl>
<hr size="6">
<a name="Floats-and-lists-of-floats"></a>
<a name="SEC79"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC78" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC80" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.17 Floats and lists of floats </h2>
<p>Floats appear in the <code>@float</code> environment, optionaly with a style
and a label, and with optionnal <code>@caption</code> and <code>@shortcaption</code>.
Their list appear after a <code>@listoffloats</code>.
</p>
<p>A hash reference is associated with each float, it is available in some
formatting functions. The keys are:
</p><dl compact="compact">
<dt> <code>caption_texi</code></dt>
<dt> <code>shortcaption_texi</code></dt>
<dd><p>A reference on an array containing the caption or shortcaption lines,
unformatted.
</p></dd>
<dt> <code>style_texi</code></dt>
<dd><p>The style with texi @-commands.
</p></dd>
<dt> <code>style_id</code></dt>
<dd><p>The unique identifier associated with the style.
</p></dd>
<dt> <code>nr</code></dt>
<dd><p>The number with the same conventions than makeinfo (use the chapter number a
dot and then the number of the float of that style in the chapter, or an
absolute number if in unnumbered).
</p></dd>
<dt> <code>chapter_nr</code></dt>
<dd><p>The number of the chapter containing the float.
</p></dd>
<dt> <code>nr_in_chapter</code></dt>
<dd><p>The number of the float in the chapter.
</p></dd>
<dt> <code>absolut_nr</code></dt>
<dd><p>The number of the float in the document.
</p></dd>
<dt> <code>texi</code></dt>
<dd><p>The label with @-commands.
</p></dd>
<dt> <code>id</code></dt>
<dd><p>The unique identifier associated with the label. Usefull to make an anchor
or a reference.
</p></dd>
<dt> <code>element</code></dt>
<dd><p>A reference on a structure representing the element the float appear in.
</p></dd>
</dl>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC80">7.17.1 Formatting a float</a></td><td> </td><td align="left" valign="top"> Formatting of floats
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC81">7.17.2 Formatting lists of floats</a></td><td> </td><td align="left" valign="top"> Formatting the lists of floats
</td></tr>
</table>
<hr size="6">
<a name="Floats"></a>
<a name="SEC80"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC79" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC81" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.17.1 Formatting a float </h3>
<p>First there is an occasion to construct a texinfo text for the caption, using
the caption texinfo lines and the informations in the float structure.
The returned lines will be formatted in the main program. A function reference
is used here:
</p>
<dl>
<dt><u>Function Reference:</u> (\@caption_lines_returned, \@shortcaption_lines_returned) <b>caption_shortcaption</b><i> \%float \@caption_lines \@shortcaption_lines</i>
<a name="IDX258"></a>
</dt>
<dd><p><var>\%float</var> is the structure defined above. <var>\@caption_lines</var> and
<var>\@shortcaption_lines</var> are references on arrays containing the
texinfo lines for caption and short caption. <var>\@caption_lines_returned</var>
and <var>\@shortcaption_lines_returned</var> are references on an array
containing the texinfo lines for the caption and shortcaption.
</p></dd></dl>
<p>Then the float is formatted with the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $text <b>float</b><i> $float_text \%float $caption_text $shortcaption_text</i>
<a name="IDX259"></a>
</dt>
<dd><p><var>$float_text</var> is the text appearing within the <code>@float</code>, formatted.
<var>\%float</var> is still the structure defined above. <var>$caption_text</var> and
<var>$shortcaption_text</var> are the caption and short caption build with the
above function and formatted.
</p></dd></dl>
<hr size="6">
<a name="Lists-of-floats"></a>
<a name="SEC81"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC80" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC82" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h3 class="subsection"> 7.17.2 Formatting lists of floats </h3>
<p>A list of floats is introduced by <code>@listoffloats</code>. The argument of
<code>@listoffloats</code> is the <em>style</em>. First the style texinfo can be
modified with the following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> $style_texi_returned <b>listoffloats_style</b><i> $style_texi</i>
<a name="IDX260"></a>
</dt>
<dd><p><var>$style_texi</var> is the <code>@listoffloats</code> argument with texinfo
@-commands kept. It is possible to make changes to the <var>$style_texi</var> and
return a modified string, still with @-commands. The modified string
is formatted in the main program.
</p></dd></dl>
<p>After that, for each of the floats with that style, first there is a
possibility to modify the float style and the float caption before they
are formatted in the main program, with the following function references:
</p>
<dl>
<dt><u>Function Reference:</u> $float_style_texi_returned <b>listoffloats_float_style</b><i> $style_texi \%float</i>
<a name="IDX261"></a>
</dt>
<dd><p><var>$style_texi</var> is the style, and <var>\%float</var> is the structure described
above. This function reference returns a style to be formatted in the
main program.
</p></dd></dl>
<dl>
<dt><u>Function Reference:</u> $caption_texi_returned <b>listoffloats_caption</b><i> \%float</i>
<a name="IDX262"></a>
</dt>
<dd><p><var>\%float</var> is the structure described
above. This function reference returns a caption to be formatted in the
main program.
</p></dd></dl>
<p>Each entry is formatted by:
</p>
<dl>
<dt><u>Function Reference:</u> $listoffloats_entry <b>listoffloats_entry</b><i> $style_texi \%float $float_style $caption $href</i>
<a name="IDX263"></a>
</dt>
<dd><p><var>$style_texi</var> is the style with @-commands, <var>$float_style</var> is the
style returned by the above function and formatted. <var>$caption</var> is the
caption returned by the above function formatted. <var>\%float</var> is the
structure corresponding with the float, and <var>$href</var> is an href pointing to
the float location.
</p></dd></dl>
<p>Lastly, the whole <code>@listoffloats</code> is formatted by:
</p>
<dl>
<dt><u>Function Reference:</u> $listoffloats <b>listoffloats</b><i> $style_texi $style \@listoffloats_entries</i>
<a name="IDX264"></a>
</dt>
<dd><p><var>$style_texi</var> is the style with @-commands, <var>$style</var> is the
style returned by the above function and formatted. The array reference
<var>\@listoffloats_entries</var> holds the entries formatted by the above
function.
</p></dd></dl>
<hr size="6">
<a name="Footnotes"></a>
<a name="SEC82"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC81" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC83" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.18 Customizing the footnotes formatting </h2>
<p>Each footnote is associated with a footnote entry. Several footnote entries
are grouped in a footnote section. When a footnote appears, two things must
be formatted: in the main text the place where the footnote appear
and the footnote text.
</p>
<p>Two functions, with corresponding function references control the formatting
of the footnotes:
</p>
<dl>
<dt><u>Function Reference:</u> (\@lines $text_for_document) <b>foot_line_and_ref</b><i> $number_in_doc $number_in_page $footnote_id $place_id $document_file $footnote_file \@lines \%state</i>
<a name="IDX265"></a>
</dt>
<dd><p><var>$number_in_doc</var> is the footnote number in the whole document,
<var>$number_in_page</var> is the footnote number in the current page.
<var>$footnote_id</var> is an identifier for the footnote in the footnote text
which should be used to make target for references to that footnote,
while <var>$place_id</var> is an identifier for the location of the footnote
in the main document. Similarly, <var>$document_file</var> is the file name
of the file containing the text where the footnote appears in the main
document, while <var>$footnote_file</var> is the file name of the file where
the footnote text appears.
</p>
<p><var>\@lines</var> is a reference on an array containing the footnote text
lines, allready formatted.
And <var>\%state</var> holds informations about the context at the footnote
place in the main document. As usual the most usefull entry is
<code>preformatted</code> which is true if the footnote appears in a preformatted
context.
</p>
<p>This function returns a reference on an array, <var>\@lines</var> containing
the updated footnote text for the footnote entry, and <var>$text_for_document</var>,
the text appearing at the footnote place in the main document, linking
to the footnote entry.
</p></dd></dl>
<p>The following function is only used when footnotes are at the bottom
of a page and the document is split.
For customization of the footnotes page in case they are on a separated
page or section, <a href="#SEC44">Customizing the layout of the special pages</a>. For
the determination of the footnote locations, <a href="#SEC10">Page layout related command line options</a>.
</p>
<dl>
<dt><u>Function Reference:</u> <b>foot_section</b><i> \@footnotes_lines</i>
<a name="IDX266"></a>
</dt>
<dd><p>This function formats a group of footnotes. <var>\@footnotes_lines</var> is a
reference on an array holding the lines of all the footnote entries
formatted as explained above. This function modifies the reference.
</p></dd></dl>
<hr size="6">
<a name="Other-and-unknown-commands"></a>
<a name="SEC83"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC82" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 7.19 Customizing other commands, and unknown commands </h2>
<p>Many commands without braces are available in texinfo, sometimes with
a specific syntax. For example we have <code>@sp</code>, <code>@noindent</code>,
<code>@documentlanguage</code>, <code>@oddheading</code>, <code>@headings</code>,
<code>@shortcontents</code>, <code>@shorttitlepage</code> or <code>@comment</code>.
<code>texi2html</code> interprets
some of these commands and some functions or variables are used for
their formatting or to access their information.
In the default case, however, most of these constructs are ignored.
</p>
<p>It is possible to change how the things following these commands
on the line are handled, what is considered to be an arg for those
commands and it is also possible to keep them instead of discarding
them such that it is possible to handle them specially, with the
same function than the one used for unknown commands.
</p>
<p>Those special commands without braces are the key of a hash:
<a name="IDX267"></a>
<code>%misc_command</code>. The associated value is a reference on a
hash enabling to set the properties of these commands. The
keys of this hash reference is the name of a property, the value
is the value of the property. For example here we have <code>line</code>
for the <code>arg</code> property for the <code>command</code> @-command.
</p>
<table><tr><td> </td><td><pre class="example">$misc_command{'command'} = {'arg' => 'line', 'skip' => 'space'};
</pre></td></tr></table>
<p>The properties and possible values are:
</p>
<dl compact="compact">
<dt> <code>skip</code></dt>
<dd><p>This property enables to set what is skipped after the command arguments.
Here are the possible values:
</p><dl compact="compact">
<dt> <code>line</code></dt>
<dd><p>The remaining of the line is skipped.
</p></dd>
<dt> <code>space</code> </dt>
<dd><p>Spaces are skipped but not newline.
</p></dd>
<dt> <code>whitespace</code> </dt>
<dd><p>Spaces are skipped
</p></dd>
<dt> <code>linewhitespace</code></dt>
<dd><p>Spaces are skipped if there are only spaces remaining on the line.
</p></dd>
<dt> <code>linespace</code></dt>
<dd><p>Spaces are skipped, but not newline if
there are only spaces remaining on the line
</p></dd>
</dl>
</dd>
<dt> <code>arg</code></dt>
<dd><p>If the associated value is <code>line</code> the line is considered to be the
argument. If it is a number it is the number of args (separated by spaces).
</p></dd>
<dt> <code>texi</code></dt>
<dd><p>If true the arguments are considered to real texinfo, therefore
<code>@value</code> and <code>@macro</code> are expanded.
</p></dd>
<dt> <code>keep</code></dt>
<dd><p>If true the args and the macro are kept, otherwise they are discarded.
The defaut is to have <code>keep</code> undef for all the commands.
If <code>keep</code> is true for <code>@verbatiminclude</code> the default
action for this macro isn't done.
</p></dd>
</dl>
<p>Commands which don't appear in the hashes
<a name="IDX268"></a>
<code>%simple_map</code>, <a name="IDX269"></a>
<code>%simple_map_pre</code>,
<a name="IDX270"></a>
<code>%simple_map_texi</code> and <code>%misc_command</code>, or that appear in
<code>%misc_command</code> but with <code>keep</code> true are processed by the
following function reference:
</p>
<dl>
<dt><u>Function Reference:</u> ($result_line, $result, $result_text, $message) <b>unknown</b><i> $command $line</i>
<a name="IDX271"></a>
</dt>
<dd><p><var>$command</var> is the @-command, <var>$line</var> is the line following the
<var>$command</var>. <var>$result</var> is a boolean. If it is true then the other return
values are taken into account otherwise the default actions are
used. In case <var>$result</var> is true, <var>$result_line</var> is the new line
to be processed further, <var>$result_text</var> is the resulting formatted text
and <var>$message</var>, if defined is a message outputted to the output
with line number added by <code>texi2html</code>.
</p></dd></dl>
<p>Commands with braces not specified above
nor in <a name="IDX272"></a>
<code>%style_map</code>, <a name="IDX273"></a>
<code>%style_map_pre</code> and
<a name="IDX274"></a>
<code>%style_map_texi</code> are processed
by the following function reference
</p>
<dl>
<dt><u>Function Reference:</u> ($result, $result_text, $message) <b>unknown_style</b><i> $command $text</i>
<a name="IDX275"></a>
</dt>
<dd><p><var>$command</var> is the @-command, <var>$text</var> is the text appearing within
the braces (allready formatted). <var>$result</var> is a boolean. If it is true then
the other return
values are taken into account otherwise the default actions are
used. In case <var>$result</var> is true, <var>$result_text</var> is the resulting
formatted text
and <var>$message</var>, if defined is a message outputted to the output
with line number added by <code>texi2html</code>.
</p></dd></dl>
<hr size="6">
<a name="Internationalization"></a>
<a name="SEC84"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC83" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC85" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="appendix"> A. Internationalization </h1>
<p>The strings written in the document are selected based on the
document language. This can be used to customize the strings,
as described in <a href="#SEC56">Customizing strings written by <code>texi2html</code></a>. This also enables translation of the
strings.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC85">A.1 Translating strings</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr size="6">
<a name="Translating-strings"></a>
<a name="SEC85"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC84" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC86" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="appendixsec"> A.1 Translating strings </h2>
<p>If the language is allready supported, then there will be a file
in the <tt>`i18n'</tt> directory with name the two-letter
ISO-639 language code. In that case you can enhance the translations by
editing this file. There is a <code>$LANGUAGES->{'<var>language</var>'}</code>
hash in that file. The keys are the english strings, in <code>''</code>, the
values (in <code>''</code> after <code>=></code>) are the translations.
When a string contains a <samp>`%'</samp> followed by <samp>`{'</samp> <var>name</var> <samp>`}'</samp>
it means that the string will be expanded by <code>texi2html</code>. For
an example, see <a href="#SEC56">Customizing strings written by <code>texi2html</code></a>.
</p>
<p>After that you should run the command <code>./manage_i18n.pl all</code> in
the top directory, it should merge your file with the existing files in
<tt>`translations.pl'</tt>, which is incorporated to the <tt>`texi2html'</tt> script
by <code>./configure</code>.
</p>
<p>If the language isn't currently supported, copy the <tt>`en'</tt> file in
<tt>`i18n'</tt> to a file with name the two-letter ISO-639
language code of your language
and then add your translations to the strings. You could also add your
two-letter language code in the <tt>`manage_i18n.pl'</tt> file in the
<code>@known_languages</code> array.
</p>
<p>After that you should similarly run the command
<code>./manage_i18n.pl all</code> in
the top directory.
</p>
<p>Obsoleted strings are not removed from the files, they are still present
in the <code>$T2H_OBSOLETE_STRINGS->{'<var>language</var>'}</code> hash in case
the string is reused later.
</p>
<p>If you made change to strings specified in installed files
(see section <a href="#SEC4">Installation of <code>texi2html</code></a>)
you will have to reinstall them otherwise the installated files will
take precedence (see section <a href="#SEC13">Use initialization files for fine tuning</a>).
</p>
<hr size="6">
<a name="Adding-new-strings"></a>
<a name="SEC86"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC85" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="appendixsec"> A.2 Adding new strings written to document </h2>
<p>If you need to write strings, for example the new string <var>a string</var>
to the resulting document, call <code>&$I('a string')</code>. Use simple quotes.
If you want to substitute a value in the string put
<code>%{<var>string_value</var>}</code>, in the string, and give a second argument
to <code>&$I</code>, a hash reference with key <var>string_value</var> and value
the what you want to substitute.
Here is an example:
</p>
<table><tr><td> </td><td><pre class="example">return &$I('%{name} of %{class}', { 'name' => $name, 'class' => $class });
</pre></td></tr></table>
<p>In that case <code>%{name}</code> is substituted by <code>$name</code> in the translated
string.
</p>
<p>After that you should run the command <code>./manage_i18n.pl all</code> in the top
directory, it should add your new strings to all the files in the <tt>`i18n'</tt>
directory.
</p>
<hr size="6">
<a name="Indexop"></a>
<a name="SEC87"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC86" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC88" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC88" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="appendix"> B. Command Line Option Index </h1>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a>
<a href="#SEC87_1" class="summary-letter"><b>D</b></a>
<a href="#SEC87_2" class="summary-letter"><b>F</b></a>
<a href="#SEC87_3" class="summary-letter"><b>H</b></a>
<a href="#SEC87_4" class="summary-letter"><b>I</b></a>
<a href="#SEC87_5" class="summary-letter"><b>L</b></a>
<a href="#SEC87_6" class="summary-letter"><b>M</b></a>
<a href="#SEC87_7" class="summary-letter"><b>N</b></a>
<a href="#SEC87_8" class="summary-letter"><b>O</b></a>
<a href="#SEC87_9" class="summary-letter"><b>P</b></a>
<a href="#SEC87_10" class="summary-letter"><b>S</b></a>
<a href="#SEC87_11" class="summary-letter"><b>T</b></a>
<a href="#SEC87_12" class="summary-letter"><b>U</b></a>
</td></tr></table>
<table border="0" class="index-op">
<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_0">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX49">css-include=<var>file</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_1">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX53">def-table</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX42">doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX30">D<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_2">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX36">frames</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX44">frameset-doctype</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX43">frameset-doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_3">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX51">html-xref-prefix=<var>path</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_4">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX34">I<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX23">if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX121">include-css</a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX69">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX70">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX47">iso</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_5">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX61">l2h</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX66">l2h-file</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX62">l2h-l2h=<var>program</var></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX64">l2h-tmp</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX72">lang</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX206">lang</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX28">lang=<var>lang</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_6">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX3">menu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_7">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX24">no-if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX21">node-files</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX2">nomenu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX26">nomenu</a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX38">nosec-nav</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX57">number</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_8">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX10">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX12">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_9">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX32">P<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX1">pkgdatadir=<var>dir</var></a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX67">pkgdatadir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX13">prefix</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_10">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX40">separated-footnotes</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX15">short-ext</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX55">short-ref</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX4">split</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX68">sysconfdir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_11">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX19">toc-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX59">toc-links</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX17">top-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC87_12">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX6">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX8">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX9">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX31">U<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a>
<a href="#SEC87_1" class="summary-letter"><b>D</b></a>
<a href="#SEC87_2" class="summary-letter"><b>F</b></a>
<a href="#SEC87_3" class="summary-letter"><b>H</b></a>
<a href="#SEC87_4" class="summary-letter"><b>I</b></a>
<a href="#SEC87_5" class="summary-letter"><b>L</b></a>
<a href="#SEC87_6" class="summary-letter"><b>M</b></a>
<a href="#SEC87_7" class="summary-letter"><b>N</b></a>
<a href="#SEC87_8" class="summary-letter"><b>O</b></a>
<a href="#SEC87_9" class="summary-letter"><b>P</b></a>
<a href="#SEC87_10" class="summary-letter"><b>S</b></a>
<a href="#SEC87_11" class="summary-letter"><b>T</b></a>
<a href="#SEC87_12" class="summary-letter"><b>U</b></a>
</td></tr></table>
<hr size="6">
<a name="Indexvr"></a>
<a name="SEC88"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC87" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SEC89" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC87" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="#SEC89" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="appendix"> C. Variable Index </h1>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC88_0" class="summary-letter"><b>$</b></a>
<a href="#SEC88_1" class="summary-letter"><b>%</b></a>
<a href="#SEC88_2" class="summary-letter"><b>@</b></a>
</td></tr></table>
<table border="0" class="index-vr">
<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC88_0">$</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX123"><code>$AFTER_BODY_OPEN</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX153"><code>$AFTER_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX155"><code>$AFTER_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX73"><code>$anchor</code></a></td><td valign="top"><a href="#SEC15">5.1 Redefining functions in initialization files</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX198"><code>$anchor</code></a></td><td valign="top"><a href="#SEC54">7.4 Formatting of special simple commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX242"><code>$AVOID_MENU_REDUNDANCY</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX152"><code>$BEFORE_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX154"><code>$BEFORE_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX78"><code>$BIG_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX111"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX127"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX225"><code>$cell</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX194"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX196"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX217"><code>$complex_format_map</code></a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX116"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX118"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX120"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX54"><code>$DEF_TABLE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX76"><code>$DEFAULT_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX233"><code>$definition_category</code></a></td><td valign="top"><a href="#SEC70">7.12.2 Customization of the definition formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX150"><code>$DO_CONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX151"><code>$DO_SCONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX45"><code>$DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX126"><code>$DOCUMENT_DESCRIPTION</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX124"><code>$DOCUMENT_ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX125"><code>$ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX175"><code>$EXTENSION</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX52"><code>$EXTERNAL_DIR</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX122"><code>$EXTRA_HEAD</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX37"><code>$FRAMES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX46"><code>$FRAMESET_DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX82"><code>$ICONS</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX179"><code>$IDX_SUMMARY</code></a></td><td valign="top"><a href="#SEC46">6.13 Generation of external files for index entries</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX80"><code>$INDEX_CHAPTER</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX63"><code>$L2H_L2H</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX65"><code>$L2H_TMP</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX29"><code>$LANG</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX71"><code>$LANG</code></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX207"><code>$LANG</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX208"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC85"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX245"><code>$MENU_PRE_STYLE</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX243"><code>$MENU_SYMBOL</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX77"><code>$MIDDLE_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX22"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX176"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX241"><code>$NODE_NAME_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX58"><code>$NUMBER_SECTIONS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX193"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX195"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX11"><code>$OUT</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX138"><code>$PRE_BODY_CLOSE</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX14"><code>$PREFIX</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX141"><code>$print_chapter_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX131"><code>$print_chapter_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX139"><code>$print_foot_navigation</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX128"><code>$print_head_navigation</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX172"><code>$print_misc</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX174"><code>$print_misc_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX173"><code>$print_misc_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX143"><code>$print_page_foot</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX130"><code>$print_page_head</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX142"><code>$print_section_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX132"><code>$print_section_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX169"><code>$print_Top</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX171"><code>$print_Top_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX170"><code>$print_Top_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX39"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX83"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX41"><code>$SEPARATED_FOOTNOTES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX56"><code>$SHORT_REF</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX16"><code>$SHORTEXTN</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX27"><code>$SHOW_MENU</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX75"><code>$SMALL_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX5"><code>$SPLIT</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX252"><code>$SPLIT_INDEX</code></a></td><td valign="top"><a href="#SEC78">7.16.2 Customizing the formatting of index lists</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC85"><code>$T2H_OBSOLETE_STRINGS</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX91"><code>$Texi2HTML::NODE{Next}</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX105"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX160"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX104"><code>$Texi2HTML::THIS_HEADER</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX103"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX108"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX106"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX159"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX20"><code>$TOC_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX60"><code>$TOC_LINKS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX157"><code>$TOC_LIST_ATTRIBUTE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX156"><code>$TOC_LIST_STYLE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX18"><code>$TOP_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX79"><code>$TOP_HEADING</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX244"><code>$UNNUMBERED_SYMBOL_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX48"><code>$USE_ISO</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX7"><code>$USE_NODES</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX81"><code>$VERTICAL_HEAD_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX87"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX88"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX109"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC88_1">%</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX192"><code>%accent_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX93"><code>%ACTIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX113"><code>%BUTTONS_GOTO</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX115"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX117"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX230"><code>%def_map</code></a></td><td valign="top"><a href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX216"><code>%format_in_paragraph</code></a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX226"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX228"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX101"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX102"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX267"><code>%misc_command</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX92"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX112"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX212"><code>%paragraph_style</code></a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX94"><code>%PASSIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX187"><code>%pre_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX183"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX268"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX184"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX269"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX185"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX270"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX219"><code>%special_list_commands</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX189"><code>%style_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX272"><code>%style_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX190"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX273"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX191"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX274"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX97"><code>%Texi2HTML::HREF</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX96"><code>%Texi2HTML::NAME</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX99"><code>%Texi2HTML::NO_TEXI</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX98"><code>%Texi2HTML::NODE</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX100"><code>%Texi2HTML::THISDOC</code></a></td><td valign="top"><a href="#SEC28">Global strings</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX188"><code>%texi_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX186"><code>%things_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC88_2">@</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#IDX89"><code>@CHAPTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX50"><code>@CSS_FILES</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX25"><code>@EXPAND</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX35"><code>@INCLUDE_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX90"><code>@MISC_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX86"><code>@NODE_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX33"><code>@PREPEND_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX84"><code>@SECTION_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#IDX85"><code>@SECTION_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC88_0" class="summary-letter"><b>$</b></a>
<a href="#SEC88_1" class="summary-letter"><b>%</b></a>
<a href="#SEC88_2" class="summary-letter"><b>@</b></a>
</td></tr></table>
<hr size="6">
<a name="Indexcp"></a>
<a name="SEC89"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC88" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[ > ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC88" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[ >> ]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="appendix"> D. Concept Index </h1>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC89_0" class="summary-letter"><b>A</b></a>
<a href="#SEC89_1" class="summary-letter"><b>B</b></a>
<a href="#SEC89_2" class="summary-letter"><b>C</b></a>
<a href="#SEC89_3" class="summary-letter"><b>D</b></a>
<a href="#SEC89_4" class="summary-letter"><b>E</b></a>
<a href="#SEC89_5" class="summary-letter"><b>F</b></a>
<a href="#SEC89_6" class="summary-letter"><b>I</b></a>
<a href="#SEC89_7" class="summary-letter"><b>M</b></a>
<a href="#SEC89_8" class="summary-letter"><b>P</b></a>
<a href="#SEC89_9" class="summary-letter"><b>R</b></a>
<a href="#SEC89_10" class="summary-letter"><b>S</b></a>
<a href="#SEC89_11" class="summary-letter"><b>T</b></a>
<a href="#SEC89_12" class="summary-letter"><b>U</b></a>
</td></tr></table>
<table border="0" class="index-cp">
<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_0">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC63">Avoid paragraph opening</a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_1">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC_Top">bug report</a></td><td valign="top"><a href="#SEC_Top">Texi2HTML</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_2">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC60">centering</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC64">complex format</a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC13"><tt>`Config'</tt></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC4">configure</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_3">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC3">downloading <code>texi2html</code> source</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_4">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC1">examples of manuals</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC58">external manual</a></td><td valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_5">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC60">flushing text</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_6">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC56">i18n</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC85">i18n</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC4">Installation</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC13">internationalization</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC86">internationalized strings</a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_7">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC2">makeinfo</a></td><td valign="top"><a href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC86"><code>manage_i18n.pl</code></a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_8">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC62">paragraph</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC62">preformatted region</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_9">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC57">reference</a></td><td valign="top"><a href="#SEC57">7.7 References</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_10">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC83">skipped command</a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC3">source code for <code>texi2html</code>, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_11">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC3"><code>texi2html</code> source, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC1">Texinfo</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC60">text alignement</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr>
<tr><td></td><td valign="top"><a href="#SEC85">Translation</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="SEC89_12">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#SEC83">unknown command</a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a href="#SEC89_0" class="summary-letter"><b>A</b></a>
<a href="#SEC89_1" class="summary-letter"><b>B</b></a>
<a href="#SEC89_2" class="summary-letter"><b>C</b></a>
<a href="#SEC89_3" class="summary-letter"><b>D</b></a>
<a href="#SEC89_4" class="summary-letter"><b>E</b></a>
<a href="#SEC89_5" class="summary-letter"><b>F</b></a>
<a href="#SEC89_6" class="summary-letter"><b>I</b></a>
<a href="#SEC89_7" class="summary-letter"><b>M</b></a>
<a href="#SEC89_8" class="summary-letter"><b>P</b></a>
<a href="#SEC89_9" class="summary-letter"><b>R</b></a>
<a href="#SEC89_10" class="summary-letter"><b>S</b></a>
<a href="#SEC89_11" class="summary-letter"><b>T</b></a>
<a href="#SEC89_12" class="summary-letter"><b>U</b></a>
</td></tr></table>
<hr size="6">
<a name="SEC_Contents"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>Table of Contents</h1>
<div class="contents">
<ul class="toc">
<li><a name="TOC1" href="#SEC1">1. Overview</a>
<ul class="toc">
<li><a name="TOC2" href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></li>
</ul></li>
<li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li>
<li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li>
<li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a>
<ul class="toc">
<li><a name="TOC6" href="#SEC6">4.1 Specifying where to split the generated document</a></li>
<li><a name="TOC7" href="#SEC7">4.2 Setting output file and directory names</a></li>
<li><a name="TOC8" href="#SEC8">4.3 Specifying which regions get expanded</a></li>
<li><a name="TOC9" href="#SEC9">4.4 Command line options related to Texinfo language features</a></li>
<li><a name="TOC10" href="#SEC10">4.5 Page layout related command line options</a></li>
<li><a name="TOC11" href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></li>
<li><a name="TOC12" href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></li>
<li><a name="TOC13" href="#SEC13">4.8 Use initialization files for fine tuning</a></li>
</ul></li>
<li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a>
<ul class="toc">
<li><a name="TOC15" href="#SEC15">5.1 Redefining functions in initialization files</a></li>
<li><a name="TOC16" href="#SEC16">5.2 Conventions used for function prototypes</a></li>
</ul></li>
<li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a>
<ul class="toc">
<li><a name="TOC18" href="#SEC18">6.1 The different categories of pages and sectioning elements</a></li>
<li><a name="TOC19" href="#SEC19">6.2 Page layout and navigation panel overview</a></li>
<li><a name="TOC20" href="#SEC21">6.3 Customization of the navigation panels buttons</a>
<ul class="toc">
<li><a name="TOC21" href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></li>
<li><a name="TOC22" href="#SEC23">6.3.2 Specifying the buttons formatting</a></li>
<li><a name="TOC23" href="#SEC24">6.3.3 Changing the navigation panel formatting</a></li>
</ul></li>
<li><a name="TOC24" href="#SEC25">6.4 Main program variables and usefull functions</a>
<ul class="toc">
<li><a name="TOC25" href="#SEC26">6.4.1 Accessing elements informations</a></li>
<li><a name="TOC26" href="#SEC27">6.4.2 Accessing global informations</a></li>
<li><a name="TOC27" href="#SEC31">6.4.3 Function usefull in page formatting</a></li>
</ul></li>
<li><a name="TOC28" href="#SEC32">6.5 Preparing the output</a></li>
<li><a name="TOC29" href="#SEC33">6.6 Finalizing the output</a></li>
<li><a name="TOC30" href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></li>
<li><a name="TOC31" href="#SEC35">6.8 Customizing the page header</a></li>
<li><a name="TOC32" href="#SEC36">6.9 Customizing the sections</a></li>
<li><a name="TOC33" href="#SEC37">6.10 Customizing the page footer</a></li>
<li><a name="TOC34" href="#SEC38">6.11 Special pages formatting</a>
<ul class="toc">
<li><a name="TOC35" href="#SEC39">6.11.1 Customizing the content of the special pages</a>
<ul class="toc">
<li><a name="TOC36" href="#SEC40">6.11.1.1 Top element text formatting</a></li>
<li><a name="TOC37" href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></li>
<li><a name="TOC38" href="#SEC42">6.11.1.3 Formatting of footnotes text</a></li>
<li><a name="TOC39" href="#SEC43">6.11.1.4 Formatting of about text</a></li>
</ul></li>
<li><a name="TOC40" href="#SEC44">6.11.2 Customizing the layout of the special pages</a></li>
</ul></li>
<li><a name="TOC41" href="#SEC45">6.12 Customizing the file names</a></li>
<li><a name="TOC42" href="#SEC46">6.13 Generation of external files for index entries</a></li>
</ul></li>
<li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a>
<ul class="toc">
<li><a name="TOC44" href="#SEC48">7.1 Three contexts for expansions: preformatted, normal and string</a></li>
<li><a name="TOC45" href="#SEC49">7.2 Customizing the formatting of commands without argument</a></li>
<li><a name="TOC46" href="#SEC50">7.3 Customizing accent, style and other simple commands</a>
<ul class="toc">
<li><a name="TOC47" href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></li>
<li><a name="TOC48" href="#SEC52">7.3.2 An interface for commands formatting with a string</a></li>
<li><a name="TOC49" href="#SEC53">7.3.3 Defining the style and indicatric commands interface</a></li>
</ul></li>
<li><a name="TOC50" href="#SEC54">7.4 Formatting of special simple commands</a></li>
<li><a name="TOC51" href="#SEC55">7.5 Processing special characters in text</a></li>
<li><a name="TOC52" href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></li>
<li><a name="TOC53" href="#SEC57">7.7 References</a>
<ul class="toc">
<li><a name="TOC54" href="#SEC58">7.7.1 Reference to external manual</a></li>
<li><a name="TOC55" href="#SEC59">7.7.2 Reference to an internal node</a></li>
</ul></li>
<li><a name="TOC56" href="#SEC60">7.8 Commands used for centering and flushing of text</a></li>
<li><a name="TOC57" href="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a>
<ul class="toc">
<li><a name="TOC58" href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></li>
<li><a name="TOC59" href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></li>
</ul></li>
<li><a name="TOC60" href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></li>
<li><a name="TOC61" href="#SEC65">7.11 Customizing the formatting of lists and tables</a>
<ul class="toc">
<li><a name="TOC62" href="#SEC66">7.11.1 Formatting individual table and list items</a></li>
<li><a name="TOC63" href="#SEC67">7.11.2 Formatting of a whole table or list</a></li>
</ul></li>
<li><a name="TOC64" href="#SEC68">7.12 Definition commands formatting</a>
<ul class="toc">
<li><a name="TOC65" href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></li>
<li><a name="TOC66" href="#SEC70">7.12.2 Customization of the definition formatting</a></li>
</ul></li>
<li><a name="TOC67" href="#SEC71">7.13 Customizing headings formatting</a></li>
<li><a name="TOC68" href="#SEC72">7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</a></li>
<li><a name="TOC69" href="#SEC73">7.15 Menu formatting</a>
<ul class="toc">
<li><a name="TOC70" href="#SEC74">7.15.1 The structure of a menu</a></li>
<li><a name="TOC71" href="#SEC75">7.15.2 The formatting of the different menu components</a></li>
</ul></li>
<li><a name="TOC72" href="#SEC76">7.16 Indices formatting</a>
<ul class="toc">
<li><a name="TOC73" href="#SEC77">7.16.1 Formatting of index entries</a></li>
<li><a name="TOC74" href="#SEC78">7.16.2 Customizing the formatting of index lists</a></li>
</ul></li>
<li><a name="TOC75" href="#SEC79">7.17 Floats and lists of floats</a>
<ul class="toc">
<li><a name="TOC76" href="#SEC80">7.17.1 Formatting a float</a></li>
<li><a name="TOC77" href="#SEC81">7.17.2 Formatting lists of floats</a></li>
</ul></li>
<li><a name="TOC78" href="#SEC82">7.18 Customizing the footnotes formatting</a></li>
<li><a name="TOC79" href="#SEC83">7.19 Customizing other commands, and unknown commands</a></li>
</ul></li>
<li><a name="TOC80" href="#SEC84">A. Internationalization</a>
<ul class="toc">
<li><a name="TOC81" href="#SEC85">A.1 Translating strings</a></li>
<li><a name="TOC82" href="#SEC86">A.2 Adding new strings written to document</a></li>
</ul></li>
<li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li>
<li><a name="TOC84" href="#SEC88">C. Variable Index</a></li>
<li><a name="TOC85" href="#SEC89">D. Concept Index</a></li>
</ul>
</div>
<hr size="1">
<a name="SEC_Overview"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>Short Table of Contents</h1>
<div class="shortcontents">
<ul class="toc">
<li><a name="TOC1" href="#SEC1">1. Overview</a></li>
<li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li>
<li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li>
<li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a></li>
<li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a></li>
<li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a></li>
<li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a></li>
<li><a name="TOC80" href="#SEC84">A. Internationalization</a></li>
<li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li>
<li><a name="TOC84" href="#SEC88">C. Variable Index</a></li>
<li><a name="TOC85" href="#SEC89">D. Concept Index</a></li>
</ul>
</div>
<hr size="1">
<a name="SEC_About"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1>About This Document</h1>
<p>
This document was generated by <em>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>.
</p>
<p>
The buttons in the navigation panels have the following meaning:
</p>
<table border="1">
<tr>
<th> Button </th>
<th> Name </th>
<th> Go to </th>
<th> From 1.2.3 go to</th>
</tr>
<tr>
<td align="center"> [ < ] </td>
<td align="center">Back</td>
<td>previous section in reading order</td>
<td>1.2.2</td>
</tr>
<tr>
<td align="center"> [ > ] </td>
<td align="center">Forward</td>
<td>next section in reading order</td>
<td>1.2.4</td>
</tr>
<tr>
<td align="center"> [ << ] </td>
<td align="center">FastBack</td>
<td>beginning of this chapter or previous chapter</td>
<td>1</td>
</tr>
<tr>
<td align="center"> [ Up ] </td>
<td align="center">Up</td>
<td>up section</td>
<td>1.2</td>
</tr>
<tr>
<td align="center"> [ >> ] </td>
<td align="center">FastForward</td>
<td>next chapter</td>
<td>2</td>
</tr>
<tr>
<td align="center"> [Top] </td>
<td align="center">Top</td>
<td>cover (top) of document</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Contents] </td>
<td align="center">Contents</td>
<td>table of contents</td>
<td> </td>
</tr>
<tr>
<td align="center"> [Index] </td>
<td align="center">Index</td>
<td>index</td>
<td> </td>
</tr>
<tr>
<td align="center"> [ ? ] </td>
<td align="center">About</td>
<td>about (help)</td>
<td> </td>
</tr>
</table>
<p>
where the <strong> Example </strong> assumes that the current position is at <strong> Subsubsection One-Two-Three </strong> of a document of the following structure:
</p>
<ul>
<li> 1. Section One
<ul>
<li>1.1 Subsection One-One
<ul>
<li>...</li>
</ul>
</li>
<li>1.2 Subsection One-Two
<ul>
<li>1.2.1 Subsubsection One-Two-One</li>
<li>1.2.2 Subsubsection One-Two-Two</li>
<li>1.2.3 Subsubsection One-Two-Three
<strong><== Current Position </strong></li>
<li>1.2.4 Subsubsection One-Two-Four</li>
</ul>
</li>
<li>1.3 Subsection One-Three
<ul>
<li>...</li>
</ul>
</li>
<li>1.4 Subsection One-Four</li>
</ul>
</li>
</ul>
<hr size="1">
<p>
<font size="-1">
This document was generated by <em>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>.
</font>
<br>
</p>
</body>
</html>
|
