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
|
<!DOCTYPE html>
<html>
<head></head>
<body>
<h3>
Quickbook 1.4
</h3>
<div class="authorgroup">
<h3 class="author">
Joel de Guzman
</h3>
<h3 class="author">
Eric Niebler
</h3>
</div>
<p class="copyright">
2002, 2004, 2006 Joel de Guzman, Eric Niebler
</p>
<div class="legalnotice">
<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div>
<div class="toc">
<p>
<b>Table of contents</b>
</p>
<ul>
<li>
<a href="#quickbook.intro">Introduction</a>
</li>
<li>
<a href="#quickbook.change_log">Change Log</a>
</li>
<li>
<a href="#quickbook.syntax">Syntax Summary</a>
</li>
<li>
<a href="#quickbook.install">Installation and configuration</a>
</li>
<li>
<a href="#quickbook.editors">Editor Support</a>
</li>
<li>
<a href="#quickbook.faq">Frequently Asked Questions</a>
</li>
<li>
<a href="#quickbook.ref">Quick Reference</a>
</li>
</ul>
</div>
<div id="quickbook.intro">
<h3>
Introduction
</h3>
<div id="quickbook.intro">
<blockquote>
<p>
<span class="bold"><strong><span class="emphasis"><em><q>Why program
by hand in five days what you can spend five years of your life automating?</q></em></span></strong></span>
</p>
<p>
-- Terrence Parr, author ANTLR/PCCTS
</p>
</blockquote>
<p>
Well, QuickBook started as a weekend hack. It was originally intended to
be a sample application using <a href="http://spirit.sourceforge.net">Spirit</a>.
What is it? What you are viewing now, this documentation, is autogenerated
by QuickBook. These files were generated from one master:
</p>
<blockquote>
<p>
<a href="../quickbook.qbk">quickbook.qbk</a>
</p>
</blockquote>
<p>
Originally named QuickDoc, this funky tool that never dies evolved into
a funkier tool thanks to Eric Niebler who resurrected the project making
it generate <a href="http://www.boost.org/doc/html/boostbook.html">BoostBook</a>
instead of HTML. The <a href="http://www.boost.org/doc/html/boostbook.html">BoostBook</a>
documentation format is an extension of <a href="http://www.docbook.org/">DocBook</a>,
an SGML or XML based format for describing documentation.
</p>
<p>
QuickBook is a WikiWiki style documentation tool geared towards C++ documentation
using simple rules and markup for simple formatting tasks. QuickBook extends
the WikiWiki concept. Like the WikiWiki, QuickBook documents are simple
text files. A single QuickBook document can generate a fully linked set
of nice HTML and PostScript/PDF documents complete with images and syntax-
colorized source code.
</p>
<p>
Features include:
</p>
<ul>
<li>
<div>
generate <a href="http://www.boost.org/doc/html/boostbook.html">BoostBook</a>
xml, to generate HTML, PostScript and PDF
</div>
</li>
<li>
<div>
simple markup to link to Doxygen-generated entities
</div>
</li>
<li>
<div>
macro system for simple text substitution
</div>
</li>
<li>
<div>
simple markup for italics, bold, preformatted, blurbs, code samples,
tables, URLs, anchors, images, etc.
</div>
</li>
<li>
<div>
automatic syntax coloring of code samples
</div>
</li>
<li>
<div>
CSS support
</div>
</li>
</ul>
</div>
</div>
<div id="quickbook.change_log">
<h3>
Change Log
</h3>
<div id="quickbook.change_log">
<h3 id="quickbook.change_log.version_1_3">
Version 1.3
</h3>
<ul>
<li>
<div>
Quickbook file inclusion [include].
</div>
</li>
<li>
<div>
Better xml output (pretty layout). Check out the generated XML.
</div>
</li>
<li>
<div>
Regression testing facility: to make sure your document will always
be compatible (full backward compatibility) regardless of changes to
QuickBook.
</div>
</li>
<li>
<div>
Code cleanup and refactoring.
</div>
</li>
<li>
<div>
Allow phrase markup in the doc-info.
</div>
</li>
<li>
<div>
Preformatted code blocks via ``code`` (double ticks) allows code in
tables and lists, for example.
</div>
</li>
<li>
<div>
Quickbook versioning; allows full backward compatibility. You have
to add [quickbook 1.3] to the doc-info header to enable the new features.
Without this, QuickBook will assume that the document is a pre-1.3
document.
</div>
</li>
<li>
<div>
Better (intuitive) paragraph termination. Some markups may terminate
a paragraph. Example:
<pre class="programlisting"><span class="special">[</span><span class="identifier">section</span> <span class="identifier">x</span><span class="special">]</span>
<span class="identifier">blah</span><span class="special">...</span>
<span class="special">[</span><span class="identifier">endsect</span><span class="special">]</span></pre>
</div>
</li>
<li>
<div>
Fully qualified section and headers. Subsection names are concatenated
to the ID to avoid clashing. Example: <code><span class="identifier">doc_name</span><span
class="special">.</span><span class="identifier">sect_name</span><span
class="special">.</span><span class="identifier">sub_sect_name</span><span
class="special">.</span><span class="identifier">sub_sub_sect_name</span></code>
</div>
</li>
<li>
<div>
Better &nbsp; and whitespace handling in code snippets.
</div>
</li>
<li>
<div>
[xinclude] fixes up the relative path to the target XML file when input_directory
is not the same as the output_directory.
</div>
</li>
<li>
<div>
Allow untitled tables.
</div>
</li>
<li>
<div>
Allow phrase markups in section titles.
</div>
</li>
<li>
<div>
Allow escaping back to QuickBook from code, code blocks and inline
code.
</div>
</li>
<li>
<div>
Footnotes, with the [footnote This is the footnote] syntax.
</div>
</li>
<li>
<div>
Post-processor bug fix for escaped XML code that it does not recognize.
</div>
</li>
<li>
<div>
Replaceable, with the [~replacement] syntax.
</div>
</li>
<li>
<div>
Generic Headers
</div>
</li>
<li>
<div>
Code changes to allow full recursion (i.e. Collectors and push/pop
functions)
</div>
</li>
<li>
<div>
Various code cleanup/maintenance
</div>
</li>
<li>
<div>
Templates!
</div>
</li>
<li>
<div>
[conceptref] for referencing BoostBook <concept> entities.
</div>
</li>
<li>
<div>
Allow escape of spaces. The escaped space is removed from the output.
Syntax: <code><span class="special">\</span> </code>.
</div>
</li>
<li>
<div>
Nested comments are now allowed.
</div>
</li>
<li>
<div>
Quickbook blocks can nest inside comments.
</div>
</li>
<li>
<div>
<a href="#quickbook.syntax.block.import">Import</a> facility.
</div>
</li>
<li>
<div>
Callouts on imported code
</div>
</li>
<li>
<div>
Simple markups can now span a whole block.
</div>
</li>
<li>
<div>
<a href="#quickbook.syntax.block.blurbs">Blurbs</a>, <a href="#quickbook.syntax.block.admonitions">Admonitions</a>
and table cells (see <a href="#quickbook.syntax.block.tables">Tables</a>)
may now contain paragraphs.
</div>
</li>
<li>
<div>
<code><span class="special">\</span><span class="identifier">n</span></code>
and <code><span class="special">[</span><span class="identifier">br</span><span
class="special">]</span></code> are now deprecated.
</div>
</li>
</ul>
</div>
</div>
<div id="quickbook.syntax">
<h3>
Syntax Summary
</h3>
<div id="quickbook.syntax">
<p>
A QuickBook document is composed of one or more blocks. An example of a
block is the paragraph or a C++ code snippet. Some blocks have special
mark-ups. Blocks, except code snippets which have their own grammar (C++
or Python), are composed of one or more phrases. A phrase can be a simple
contiguous run of characters. Phrases can have special mark-ups. Marked
up phrases can recursively contain other phrases, but cannot contain blocks.
A terminal is a self contained block-level or phrase-level element that
does not nest anything.
</p>
<p>
Blocks, in general, are delimited by two end-of-lines (the block terminator).
Phrases in each block cannot contain a block terminator. This way, syntax
errors such as un-matched closing brackets do not go haywire and corrupt
anything past a single block.
</p>
</div>
<div id="quickbook.syntax.comments">
<h3>
Comments
</h3>
<div id="quickbook.syntax.comments">
<p>
Can be placed anywhere.
</p>
<pre class="programlisting">[/ comment (no output generated) ]
</pre>
<pre class="programlisting">[/ comments can be nested [/ some more here] ]
</pre>
<pre class="programlisting">[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ]
</pre>
</div>
</div>
<div id="quickbook.syntax.phrase">
<h3>
Phrase Level Elements
</h3>
<div id="quickbook.syntax.phrase">
</div>
<div id="quickbook.syntax.phrase.font_styles">
<h3>
Font Styles
</h3>
<div id="quickbook.syntax.phrase.font_styles">
<pre class="programlisting">['italic], [*bold], [_underline], [^teletype], [-strikethrough]
</pre>
<p>
will generate:
</p>
<p>
<span class="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>,
<span class="underline">underline</span>, <tt>teletype</tt>, <span
class="strikethrough">strikethrough</span>
</p>
<p>
Like all non-terminal phrase level elements, this can of course be
nested:
</p>
<pre class="programlisting">[*['bold-italic]]
</pre>
<p>
will generate:
</p>
<p>
<span class="bold"><strong><span class="emphasis"><em>bold-italic</em></span></strong></span>
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.replaceable">
<h3>
Replaceable
</h3>
<div id="quickbook.syntax.phrase.replaceable">
<p>
When you want content that may or must be replaced by the user, use
the syntax:
</p>
<pre class="programlisting">[~replacement]
</pre>
<p>
This will generate:
</p>
<p>
<em class="replaceable">replacement</em>
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.quotations">
<h3>
Quotations
</h3>
<div id="quickbook.syntax.phrase.quotations">
<pre class="programlisting">["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein
</pre>
<p>
will generate:
</p>
<p>
<q>A question that sometimes drives me hazy: am I or are the others
crazy?</q>--Einstein
</p>
<p>
Note the proper left and right quote marks. Also, while you can simply
use ordinary quote marks like "quoted", our quotation, above,
will generate correct DocBook quotations (e.g. <quote>quoted</quote>).
</p>
<p>
Like all phrase elements, quotations may be nested. Example:
</p>
<pre class="programlisting">["Here's the rule for bargains: ["Do other men, for they would do you.] That's
the true business precept.]
</pre>
<p>
will generate:
</p>
<p>
<q>Here's the rule for bargains: <q>Do other men, for they would do
you.</q> That's the true business precept.</q>
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.simple_formatting">
<h3>
Simple formatting
</h3>
<div id="quickbook.syntax.phrase.simple_formatting">
<p>
Simple markup for formatting text, common in many applications, is
now supported:
</p>
<pre class="programlisting">/italic/, *bold*, _underline_, =teletype=
</pre>
<p>
will generate:
</p>
<p>
<span class="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>,
<span class="underline">underline</span>, <tt>teletype</tt>
</p>
<p>
Unlike QuickBook's standard formatting scheme, the rules for simpler
alternatives are much stricter<a id="quickbook.syntax.phrase.simple_formatting.f0"
href="#footnote-1"><sup class="footnote">[1]</sup></a>.
</p>
<ul>
<li>
<div>
Simple markups cannot nest. You can combine a simple markup with
a nestable markup.
</div>
</li>
<li>
<div>
Simple markups cannot contain any other form of quickbook markup.
</div>
</li>
<li>
<div>
A non-space character must follow the leading markup
</div>
</li>
<li>
<div>
A non-space character must precede the trailing markup
</div>
</li>
<li>
<div>
A space or a punctuation must follow the trailing markup
</div>
</li>
<li>
<div>
If the matching markup cannot be found within a block, the formatting
will not be applied. This is to ensure that un-matched formatting
markups, which can be a common mistake, does not corrupt anything
past a single block. We do not want the rest of the document to
be rendered bold just because we forgot a trailing '*'. A single
block is terminated by two end of lines or the close bracket: ']'.
</div>
</li>
<li>
<div>
A line starting with the star will be interpreted as an unordered
list. See <a href="#quickbook.syntax.block.lists.unordered_lists">Unordered
lists</a>.
</div>
</li>
</ul>
<div id="quickbook.syntax.phrase.simple_formatting.t0" class="table">
<table>
<caption>More Formatting Samples</caption>
<thead>
<tr>
<th>
<p>
Markup
</p>
</th>
<th>
<p>
Result
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
<tt>*Bold*</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>Bold</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*Is bold*</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>Is bold</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>* Not bold* *Not bold * * Not bold *</tt>
</p>
</td>
<td>
<p>
* Not bold* *Not bold * * Not bold *
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>This*Isn't*Bold (no bold)</tt>
</p>
</td>
<td>
<p>
This*Isn't*Bold (no bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>(*Bold Inside*) (parenthesis not bold)</tt>
</p>
</td>
<td>
<p>
(<span class="bold"><strong>Bold Inside</strong></span>)
(parenthesis not bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*(Bold Outside)* (parenthesis bold)</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>(Bold Outside)</strong></span>
(parenthesis bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>3*4*5 = 60 (no bold)</tt>
</p>
</td>
<td>
<p>
3*4*5 = 60 (no bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>3 * 4 * 5 = 60 (no bold)</tt>
</p>
</td>
<td>
<p>
3 * 4 * 5 = 60 (no bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>3 *4* 5 = 60 (4 is bold)</tt>
</p>
</td>
<td>
<p>
3 <span class="bold"><strong>4</strong></span> 5 = 60 (4
is bold)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*This is bold* this is not *but this is*</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>This is bold</strong></span> this
is not <span class="bold"><strong>but this is</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*This is bold*.</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>This is bold</strong></span>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*B*. (bold B)</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>B</strong></span>. (bold B)
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>['*Bold-Italic*]</tt>
</p>
</td>
<td>
<p>
<span class="emphasis"><em><span class="bold"><strong>Bold-Italic</strong></span></em></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>*side-by*/-side/</tt>
</p>
</td>
<td>
<p>
<span class="bold"><strong>side-by</strong></span><span class="emphasis"><em>-side</em></span>
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>
As mentioned, simple markups cannot go past a single block. The text
from "have" to "full" in the following paragraph
will be rendered as bold:
</p>
<pre class="programlisting">Baa baa black sheep, *have you any wool?
Yes sir, yes sir, three bags full!*
One for the master, one for the dame,
And one for the little boy who lives down the lane.
</pre>
<p>
Baa baa black sheep, <span class="bold"><strong>have you any wool?
Yes sir, yes sir, three bags full!</strong></span> One for the master,
one for the dame, And one for the little boy who lives down the lane.
</p>
<p>
But in the following paragraph, bold is not applied:
</p>
<pre class="programlisting">Baa baa black sheep, *have you any wool?
Yes sir, yes sir, three bags full!
One for the master, one for the dame,
And one for the little boy who lives down the lane.
</pre>
<p>
Baa baa black sheep, *have you any wool? Yes sir, yes sir, three bags
full! One for the master, one for the dame, And one for the little
boy who lives down the lane.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.inline_code">
<h3>
Inline code
</h3>
<div id="quickbook.syntax.phrase.inline_code">
<p>
Inlining code in paragraphs is quite common when writing C++ documentation.
We provide a very simple markup for this. For example, this:
</p>
<pre class="programlisting">This text has inlined code `int main() { return 0; }` in it.
</pre>
<p>
will generate:
</p>
<p>
This text has inlined code <code><span class="keyword">int</span>
<span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span> <span class="keyword">return</span>
<span class="number">0</span><span class="special">;</span> <span class="special">}</span></code>
in it. The code will be syntax highlighted.
</p>
<div class="note">
<p>
We simply enclose the code with the tick: <tt>"`"</tt>, not the single
quote: <code><span class="string">"'"</span></code>. Note
too that <tt>`some code`</tt> is preferred over <tt>[^some code]</tt>.
</p>
</div>
</div>
</div>
<div id="quickbook.syntax.phrase.code_blocks">
<h3>
Code blocks
</h3>
<div id="quickbook.syntax.phrase.code_blocks">
<p>
Preformatted code simply starts with a space or a tab (See <a href="#quickbook.syntax.block.code">Code</a>).
However, such a simple syntax cannot be used as phrase elements in
lists (See <a href="#quickbook.syntax.block.lists.ordered_lists">Ordered
lists</a> and <a href="#quickbook.syntax.block.lists.unordered_lists">Unordered
lists</a>), tables (See <a href="#quickbook.syntax.block.tables">Tables</a>),
etc. Inline code (see above) can. The problem is, inline code does
not allow formatting with newlines, spaces, and tabs. These are lost.
</p>
<p>
We provide a phrase level markup that is a mix between the two. By
using the double-tick, instead of the single-tick, we are telling QuickBook
to use preformatted blocks of code. Example:
</p>
<pre class="programlisting">``
#include <iostream>
int main()
{
std::cout << "Hello, World!" << std::endl;
return 0;
}
``
</pre>
<p>
will generate:
</p>
<p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World!"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.source_mode">
<h3>
Source Mode
</h3>
<div id="quickbook.syntax.phrase.source_mode">
<p>
If a document contains more than one type of source code then the source
mode may be changed dynamically as the document is processed. All QuickBook
documents are initially in C++ mode by default, though an alternative
initial value may be set in the <a href="#quickbook.syntax.block.document">Document</a>
section.
</p>
<p>
To change the source mode, use the <tt>[source-mode]</tt> markup, where
<tt>source-mode</tt> is one of the supported modes. For example, this:
</p>
<pre class="programlisting">Python's [python] `import` is rather like C++'s [c++] `#include`. A
C++ comment `// looks like this` whereas a Python comment [python]
`# looks like this`.
</pre>
<p>
will generate:
</p>
<p>
Python's <code><span class="keyword">import</span></code> is rather
like C++'s <code><span class="preprocessor">#include</span></code>.
A C++ comment <code><span class="comment">// looks like this</span></code>
whereas a Python comment <code><span class="comment">#looks like this</span></code>.
</p>
<div id="quickbook.syntax.phrase.source_mode.t0" class="table">
<table>
<caption>Supported Source Modes</caption>
<thead>
<tr>
<th>
<p>
Mode
</p>
</th>
<th>
<p>
Source Mode Markup
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
C++
</p>
</td>
<td>
<p>
<tt>[c++]</tt>
</p>
</td>
</tr>
<tr>
<td>
<p>
Python
</p>
</td>
<td>
<p>
<tt>[python]</tt>
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note">
<p>
The source mode strings are lowercase.
</p>
</div>
</div>
</div>
<div id="quickbook.syntax.phrase.line_break">
<h3>
line-break
</h3>
<div id="quickbook.syntax.phrase.line_break">
<pre class="programlisting">[br]
</pre>
<div class="warning">
<p>
<code><span class="special">[</span><span class="identifier">br</span><span
class="special">]</span></code> is now deprecated. <a href="#quickbook.syntax.block.blurbs">Blurbs</a>,
<a href="#quickbook.syntax.block.admonitions">Admonitions</a> and
table cells (see <a href="#quickbook.syntax.block.tables">Tables</a>)
may now contain paragraphs.
</p>
</div>
</div>
</div>
<div id="quickbook.syntax.phrase.anchors">
<h3>
Anchors
</h3>
<div id="quickbook.syntax.phrase.anchors">
<pre class="programlisting">[#named_anchor]
</pre>
<p>
A named anchor is a hook that can be referenced by a link elsewhere
in the document. You can then reference an anchor with <tt>[link named_anchor
Some link text]</tt>. See <a href="#quickbook.syntax.phrase.anchor_links">Anchor
links</a>, <a href="#quickbook.syntax.block.section">Section</a> and
<a href="#quickbook.syntax.block.headings">Heading</a>.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.links">
<h3>
Links
</h3>
<div id="quickbook.syntax.phrase.links">
<pre class="programlisting">[@http://www.boost.org this is [*boost's] website....]
</pre>
<p>
will generate:
</p>
<p>
<a href="http://www.boost.org">this is <span class="bold"><strong>boost's</strong></span>
website....</a>
</p>
<p>
URL links where the link text is the link itself is common. Example:
</p>
<pre class="programlisting">see http://spirit.sourceforge.net/
</pre>
<p>
so, when the text is absent in a link markup, the URL is assumed. Example:
</p>
<pre class="programlisting">see [@http://spirit.sourceforge.net/]
</pre>
<p>
will generate:
</p>
<p>
see <a href="http://spirit.sourceforge.net/">http://spirit.sourceforge.net/</a>
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.anchor_links">
<h3>
Anchor links
</h3>
<div id="quickbook.syntax.phrase.anchor_links">
<p>
You can link within a document using:
</p>
<pre class="programlisting">[link section_id.normalized_header_text The link text]
</pre>
<p>
See sections <a href="#quickbook.syntax.block.section">Section</a>
and <a href="#quickbook.syntax.block.headings">Heading</a> for more
info.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.refentry_links">
<h3>
refentry links
</h3>
<div id="quickbook.syntax.phrase.refentry_links">
<p>
In addition, you can link internally to an XML refentry like:
</p>
<pre class="programlisting">[link xml.refentry The link text]
</pre>
<p>
This gets converted into <tt><link linkend="xml.refentry">The
link text</link></tt>.
</p>
<p>
Like URLs, the link text is optional. If this is not present, the link
text will automatically be the refentry. Example:
</p>
<pre class="programlisting">[link xml.refentry]
</pre>
<p>
This gets converted into <tt><link linkend="xml.refentry">xml.refentry</link></tt>.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.code_links">
<h3>
Code Links
</h3>
<div id="quickbook.syntax.phrase.code_links">
<p>
If you want to link to a function, class, member, enum, concept or
header in the reference section, you can use:
</p>
<pre class="programlisting">[funcref fully::qualified::function_name The link text]
[classref fully::qualified::class_name The link text]
[memberref fully::qualified::member_name The link text]
[enumref fully::qualified::enum_name The link text]
[macroref MACRO_NAME The link text]
[conceptref ConceptName The link text]
[headerref path/to/header.hpp The link text]
</pre>
<p>
Again, the link text is optional. If this is not present, the link
text will automatically be the function, class, member, enum, macro,
concept or header. Example:
</p>
<pre class="programlisting">[classref boost::bar::baz]
</pre>
<p>
would have "boost::bar::baz" as the link text.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.escape">
<h3>
Escape
</h3>
<div id="quickbook.syntax.phrase.escape">
<p>
The escape mark-up is used when we don't want to do any processing.
</p>
<pre class="programlisting">'''
escape (no processing/formatting)
'''
</pre>
<p>
Escaping allows us to pass XML markup to <a href="http://www.boost.org/doc/html/boostbook.html">BoostBook</a>
or <a href="http://www.docbook.org/">DocBook</a>. For example:
</p>
<pre class="programlisting">'''
<emphasis role="bold">This is direct XML markup</emphasis>
'''
</pre>
<p>
<span class="bold"><strong>This is direct XML markup</strong></span>
</p>
<div class="important">
<p>
Be careful when using the escape. The text must conform to <a href="http://www.boost.org/doc/html/boostbook.html">BoostBook</a>/<a
href="http://www.docbook.org/">DocBook</a> syntax.
</p>
</div>
</div>
</div>
<div id="quickbook.syntax.phrase.single_char_escape">
<h3>
Single char escape
</h3>
<div id="quickbook.syntax.phrase.single_char_escape">
<p>
The backslash may be used to escape a single punctuation character.
The punctuation immediately after the backslash is passed without any
processing. This is useful when we need to escape QuickBook punctuations
such as <code><span class="special">[</span></code> and <code><span
class="special">]</span></code>. For example, how do you escape the
triple quote? Simple: <tt>\'\'\'</tt>
</p>
<p>
<code><span class="special">\</span><span class="identifier">n</span></code>
has a special meaning. It is used to generate line breaks.
</p>
<div class="warning">
<p>
<code><span class="special">\</span><span class="identifier">n</span></code>
and <code><span class="special">[</span><span class="identifier">br</span><span
class="special">]</span></code> are now deprecated. <a href="#quickbook.syntax.block.blurbs">Blurbs</a>,
<a href="#quickbook.syntax.block.admonitions">Admonitions</a> and
table cells (see <a href="#quickbook.syntax.block.tables">Tables</a>)
may now contain paragraphs.
</p>
</div>
<p>
The escaped space: <code><span class="special">\</span> </code> also
has a special meaning. The escaped space is removed from the output.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.images">
<h3>
Images
</h3>
<div id="quickbook.syntax.phrase.images">
<pre class="programlisting">[$image.jpg]
</pre>
</div>
</div>
<div id="quickbook.syntax.phrase.footnotes">
<h3>
Footnotes
</h3>
<div id="quickbook.syntax.phrase.footnotes">
<p>
As of version 1.3, QuickBook supports footnotes. Just put the text
of the footnote in a <code><span class="special">[</span><span class="identifier">footnote</span><span
class="special">]</span></code> block, and the text will be put at
the bottom of the current page. For example, this:
</p>
<pre class="programlisting">[footnote A sample footnote]
</pre>
<p>
will generate this<a id="quickbook.syntax.phrase.footnotes.f0" href="#footnote-2"><sup
class="footnote">[2]</sup></a>.
</p>
</div>
<div id="quickbook.syntax.phrase.footnotes.macro_expansion">
<h3>
Macro Expansion
</h3>
<div id="quickbook.syntax.phrase.footnotes.macro_expansion">
<pre class="programlisting">__a_macro_identifier__
</pre>
<p>
See <a href="#quickbook.syntax.block.macros">Macros</a> for details.
</p>
</div>
</div>
<div id="quickbook.syntax.phrase.footnotes.template_expansion">
<h3>
Template Expansion
</h3>
<div id="quickbook.syntax.phrase.footnotes.template_expansion">
<pre class="programlisting">[a_template_identifier]
</pre>
<p>
See <a href="#quickbook.syntax.block.templates">Templates</a> for
details.
</p>
</div>
</div>
</div>
</div>
<div id="quickbook.syntax.block">
<h3>
Block Level Elements
</h3>
<div id="quickbook.syntax.block">
</div>
<div id="quickbook.syntax.block.document">
<h3>
Document
</h3>
<div id="quickbook.syntax.block.document">
<p>
Every document must begin with a Document Info section, which should
look like this:
</p>
<pre class="programlisting">[document-type The Document Title
[quickbook 1.3]
[version 1.0]
[id the_document_name]
[dirname the_document_dir]
[copyright 2000 2002 2003 Joe Blow, Jane Doe]
[purpose The document's reason for being]
[category The document's category]
[authors [Blow, Joe], [Doe, Jane]]
[license The document's license]
[source-mode source-type]
]
</pre>
<p>
Where document-type is one of:
</p>
<ul>
<li>
<div>
book
</div>
</li>
<li>
<div>
article
</div>
</li>
<li>
<div>
library
</div>
</li>
<li>
<div>
chapter
</div>
</li>
<li>
<div>
part
</div>
</li>
<li>
<div>
appendix
</div>
</li>
<li>
<div>
preface
</div>
</li>
<li>
<div>
qandadiv
</div>
</li>
<li>
<div>
qandaset
</div>
</li>
<li>
<div>
reference
</div>
</li>
<li>
<div>
set
</div>
</li>
</ul>
<p>
quickbook 1.3 declares the version of quickbook the document is written
for. In its absence, version 1.1 is assumed.
</p>
<p>
<tt>version</tt>, <tt>id</tt>, <tt>dirname</tt>, <tt>copyright</tt>,
<tt>purpose</tt>, <tt>category</tt>, <tt>authors</tt>, <tt>license</tt>,
<tt>last-revision</tt> and <tt>source-mode</tt> are optional information.
</p>
<p>
<tt>source-type</tt> is a lowercase string setting the initial <a href="#quickbook.syntax.phrase.source_mode">Source
Mode</a>. If the <tt>source-mode</tt> field is omitted, a default value
of <tt>c++</tt> will be used.
</p>
</div>
</div>
<div id="quickbook.syntax.block.section">
<h3>
Section
</h3>
<div id="quickbook.syntax.block.section">
<p>
Starting a new section is accomplished with:
</p>
<pre class="programlisting">[section:id The Section Title]
</pre>
<p>
where <span class="emphasis"><em>id</em></span> is optional. id will
be the filename of the generated section. If it is not present, "The
Section Title" will be normalized and become the id. Valid characters
are <tt>a-Z</tt>, <tt>A-Z</tt>, <tt>0-9</tt> and <tt>_</tt>. All non-valid
characters are converted to underscore and all upper-case are converted
to lower case. Thus: "The Section Title" will be normalized
to "the_section_title".
</p>
<p>
End a section with:
</p>
<pre class="programlisting">[endsect]
</pre>
<p>
Sections can nest, and that results in a hierarchy in the table of
contents.
</p>
</div>
</div>
<div id="quickbook.syntax.block.xinclude">
<h3>
xinclude
</h3>
<div id="quickbook.syntax.block.xinclude">
<p>
You can include another XML file with:
</p>
<pre class="programlisting">[xinclude file.xml]
</pre>
<p>
This is useful when file.xml has been generated by Doxygen and contains
your reference section.
</p>
</div>
</div>
<div id="quickbook.syntax.block.paragraphs">
<h3>
Paragraphs
</h3>
<div id="quickbook.syntax.block.paragraphs">
<p>
Paragraphs start left-flushed and are terminated by two or more newlines.
No markup is needed for paragraphs. QuickBook automatically detects
paragraphs from the context. Block markups [section, endsect, h1, h2,
h3, h4, h5, h6, blurb, (block-quote) ':', pre, def, table and include
] may also terminate a paragraph.
</p>
</div>
</div>
<div id="quickbook.syntax.block.lists">
<h3>
Lists
</h3>
<div id="quickbook.syntax.block.lists">
</div>
<div id="quickbook.syntax.block.lists.ordered_lists">
<h3>
Ordered lists
</h3>
<div id="quickbook.syntax.block.lists.ordered_lists">
<pre class="programlisting"># One
# Two
# Three
</pre>
<p>
will generate:
</p>
<ol>
<li>
<div>
One
</div>
</li>
<li>
<div>
Two
</div>
</li>
<li>
<div>
Three
</div>
</li>
</ol>
</div>
</div>
<div id="quickbook.syntax.block.lists.list_hierarchies">
<h3>
List Hierarchies
</h3>
<div id="quickbook.syntax.block.lists.list_hierarchies">
<p>
List hierarchies are supported. Example:
</p>
<pre class="programlisting"># One
# Two
# Three
# Three.a
# Three.b
# Three.c
# Four
# Four.a
# Four.a.i
# Four.a.ii
# Five
</pre>
<p>
will generate:
</p>
<ol>
<li>
<div>
One
</div>
</li>
<li>
<div>
Two
</div>
</li>
<li>
<div>
Three
<ol>
<li>
<div>
Three.a
</div>
</li>
<li>
<div>
Three.b
</div>
</li>
<li>
<div>
Three.c
</div>
</li>
</ol>
</div>
</li>
<li>
<div>
Fourth
<ol>
<li>
<div>
Four.a
<ol>
<li>
<div>
Four.a.i
</div>
</li>
<li>
<div>
Four.a.ii
</div>
</li>
</ol>
</div>
</li>
</ol>
</div>
</li>
<li>
<div>
Five
</div>
</li>
</ol>
</div>
</div>
<div id="quickbook.syntax.block.lists.long_list_lines">
<h3>
Long List Lines
</h3>
<div id="quickbook.syntax.block.lists.long_list_lines">
<p>
Long lines will be wrapped appropriately. Example:
</p>
<pre class="programlisting"># A short item.
# A very long item. A very long item. A very long item.
A very long item. A very long item. A very long item.
A very long item. A very long item. A very long item.
A very long item. A very long item. A very long item.
A very long item. A very long item. A very long item.
# A short item.
</pre>
<ol>
<li>
<div>
A short item.
</div>
</li>
<li>
<div>
A very long item. A very long item. A very long item. A very
long item. A very long item. A very long item. A very long item.
A very long item. A very long item. A very long item. A very
long item. A very long item. A very long item. A very long item.
A very long item.
</div>
</li>
<li>
<div>
A short item.
</div>
</li>
</ol>
</div>
</div>
<div id="quickbook.syntax.block.lists.unordered_lists">
<h3>
Unordered lists
</h3>
<div id="quickbook.syntax.block.lists.unordered_lists">
<pre class="programlisting">* First
* Second
* Third
</pre>
<p>
will generate:
</p>
<ul>
<li>
<div>
First
</div>
</li>
<li>
<div>
Second
</div>
</li>
<li>
<div>
Third
</div>
</li>
</ul>
</div>
</div>
<div id="quickbook.syntax.block.lists.mixed_lists">
<h3>
Mixed lists
</h3>
<div id="quickbook.syntax.block.lists.mixed_lists">
<p>
Mixed lists (ordered and unordered) are supported. Example:
</p>
<pre class="programlisting"># One
# Two
# Three
* Three.a
* Three.b
* Three.c
# Four
</pre>
<p>
will generate:
</p>
<ol>
<li>
<div>
One
</div>
</li>
<li>
<div>
Two
</div>
</li>
<li>
<div>
Three
<ul>
<li>
<div>
Three.a
</div>
</li>
<li>
<div>
Three.b
</div>
</li>
<li>
<div>
Three.c
</div>
</li>
</ul>
</div>
</li>
<li>
<div>
Four
</div>
</li>
</ol>
<p>
And...
</p>
<pre class="programlisting"># 1
* 1.a
# 1.a.1
# 1.a.2
* 1.b
# 2
* 2.a
* 2.b
# 2.b.1
# 2.b.2
* 2.b.2.a
* 2.b.2.b
</pre>
<p>
will generate:
</p>
<ol>
<li>
<div>
1
<ul>
<li>
<div>
1.a
<ol>
<li>
<div>
1.a.1
</div>
</li>
<li>
<div>
1.a.2
</div>
</li>
</ol>
</div>
</li>
<li>
<div>
1.b
</div>
</li>
</ul>
</div>
</li>
<li>
<div>
2
<ul>
<li>
<div>
2.a
</div>
</li>
<li>
<div>
2.b
<ol>
<li>
<div>
2.b.1
</div>
</li>
<li>
<div>
2.b.2
<ul>
<li>
<div>
2.b.2.a
</div>
</li>
<li>
<div>
2.b.2.b
</div>
</li>
</ul>
</div>
</li>
</ol>
</div>
</li>
</ul>
</div>
</li>
</ol>
</div>
</div>
</div>
<div id="quickbook.syntax.block.code">
<h3>
Code
</h3>
<div id="quickbook.syntax.block.code">
<p>
Preformatted code starts with a space or a tab. The code will be syntax
highlighted according to the current <a href="#quickbook.syntax.phrase.source_mode">Source
Mode</a>:
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="comment">// Sample code</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World\n"</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<pre class="programlisting"><span class="keyword">import</span> <span class="identifier">cgi</span>
<span class="keyword">def</span> <span class="identifier">cookForHtml</span><span class="special">(</span><span class="identifier">text</span><span class="special">):</span>
<span class="string">'''"Cooks" the input text for HTML.'''</span>
<span class="keyword">return</span> <span class="identifier">cgi</span><span class="special">.</span><span class="identifier">escape</span><span class="special">(</span><span class="identifier">text</span><span class="special">)</span>
</pre>
<p>
Macros that are already defined are expanded in source code. Example:
</p>
<pre class="programlisting">[def __array__ [@http://www.boost.org/doc/html/array/reference.html array]]
[def __boost__ [@http://www.boost.org/libs/libraries.htm boost]]
using __boost__::__array__;
</pre>
<p>
Generates:
</p>
<pre class="programlisting"><span class="keyword">using</span> <a href="http://www.boost.org/libs/libraries.htm">boost</a><span class="special">::</span><a href="http://www.boost.org/doc/html/array/reference.html">array</a><span class="special">;</span>
</pre>
</div>
</div>
<div id="quickbook.syntax.block.escape_back">
<h3>
Escaping Back To QuickBook
</h3>
<div id="quickbook.syntax.block.escape_back">
<p>
Inside code, code blocks and inline code, QuickBook does not allow
any markup to avoid conflicts with the target syntax (e.g. c++). In
case you need to switch back to QuickBook markup inside code, you can
do so using a language specific <span class="emphasis"><em>escape-back</em></span>
delimiter. In C++ and Python, the delimiter is the double tick (back-quote):
"``" and "``". Example:
</p>
<pre class="programlisting">void ``[@http://en.wikipedia.org/wiki/Foo#Foo.2C_Bar_and_Baz foo]``()
{
}
</pre>
<p>
Will generate:
</p>
<pre class="programlisting"><span class="keyword">void</span> <a href="http://en.wikipedia.org/wiki/Foo#Foo.2C_Bar_and_Baz">foo</a><span class="special">()</span>
<span class="special">{</span>
<span class="special">}</span>
</pre>
<p>
When escaping from code to QuickBook, only phrase level markups are
allowed. Block level markups like lists, tables etc. are not allowed.
</p>
</div>
</div>
<div id="quickbook.syntax.block.preformatted">
<h3>
Preformatted
</h3>
<div id="quickbook.syntax.block.preformatted">
<p>
Sometimes, you don't want some preformatted text to be parsed as C++.
In such cases, use the <tt>[pre ... ]</tt> markup block.
</p>
<pre class="programlisting">[pre
Some *preformatted* text Some *preformatted* text
Some *preformatted* text Some *preformatted* text
Some *preformatted* text Some *preformatted* text
]
</pre>
<p>
Spaces, tabs and newlines are rendered as-is. Unlike all quickbook
block level markup, pre (and Code) are the only ones that allow multiple
newlines. The markup above will generate:
</p>
<pre class="programlisting">Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
Some <span class="bold"><strong>preformatted</strong></span> text Some <span class="bold"><strong>preformatted</strong></span> text
</pre>
<p>
Notice that unlike Code, phrase markup such as font style is still
permitted inside <tt>pre</tt> blocks.
</p>
</div>
</div>
<div id="quickbook.syntax.block.blockquote">
<h3>
Blockquote
</h3>
<div id="quickbook.syntax.block.blockquote">
<pre class="programlisting">[:sometext...]
</pre>
<blockquote>
<p>
Indents the paragraph. This applies to one paragraph only.
</p>
</blockquote>
</div>
</div>
<div id="quickbook.syntax.block.admonitions">
<h3>
Admonitions
</h3>
<div id="quickbook.syntax.block.admonitions">
<pre class="programlisting">[note This is a note]
[tip This is a tip]
[important This is important]
[caution This is a caution]
[warning This is a warning]
</pre>
<p>
generates <a href="http://www.docbook.org/">DocBook</a> admonitions:
</p>
<div class="note">
<p>
This is a note
</p>
</div>
<div class="tip">
<p>
This is a tip
</p>
</div>
<div class="important">
<p>
This is important
</p>
</div>
<div class="caution">
<p>
This is a caution
</p>
</div>
<div class="warning">
<p>
This is a warning
</p>
</div>
<p>
These are the only admonitions supported by <a href="http://www.docbook.org/">DocBook</a>.
So, for example <tt>[information This is some information]</tt> is
unlikely to produce the desired effect.
</p>
</div>
</div>
<div id="quickbook.syntax.block.headings">
<h3>
Headings
</h3>
<div id="quickbook.syntax.block.headings">
<pre class="programlisting">[h1 Heading 1]
[h2 Heading 2]
[h3 Heading 3]
[h4 Heading 4]
[h5 Heading 5]
[h6 Heading 6]
</pre>
<h1 id="quickbook.syntax.block.headings.heading_1">
Heading 1
</h1>
<h2 id="quickbook.syntax.block.headings.heading_2">
Heading 2
</h2>
<h3 id="quickbook.syntax.block.headings.heading_3">
Heading 3
</h3>
<h4 id="quickbook.syntax.block.headings.heading_4">
Heading 4
</h4>
<h5 id="quickbook.syntax.block.headings.heading_5">
Heading 5
</h5>
<h6 id="quickbook.syntax.block.headings.heading_6">
Heading 6
</h6>
<p>
Headings 1-3 [h1 h2 and h3] will automatically have anchors with normalized
names with <tt>name="section_id.normalized_header_text"</tt>
(i.e. valid characters are <tt>a-z</tt>, <tt>A-Z</tt>, <tt>0-9</tt>
and <tt>_</tt>. All non-valid characters are converted to underscore
and all upper-case are converted to lower-case. For example: Heading
1 in section Section 2 will be normalized to <tt>section_2.heading_1</tt>).
You can use:
</p>
<pre class="programlisting">[link section_id.normalized_header_text The link text]
</pre>
<p>
to link to them. See <a href="#quickbook.syntax.phrase.anchor_links">Anchor
links</a> and <a href="#quickbook.syntax.block.section">Section</a>
for more info.
</p>
</div>
</div>
<div id="quickbook.syntax.block.generic_heading">
<h3>
Generic Heading
</h3>
<div id="quickbook.syntax.block.generic_heading">
<p>
In cases when you don't want to care about the heading level (1 to
6), you can use the <span class="emphasis"><em>Generic Heading</em></span>:
</p>
<pre class="programlisting">[heading Heading]
</pre>
<p>
The <span class="emphasis"><em>Generic Heading</em></span> assumes
the level, plus one, of the innermost section where it is placed. For
example, if it is placed in the outermost section, then, it assumes
<span class="emphasis"><em>h2</em></span>.
</p>
<p>
Headings are often used as an alternative to sections. It is used particularly
if you do not want to start a new section. In many cases, however,
headings in a particular section is just flat. Example:
</p>
<pre class="programlisting">[section A]
[h2 X]
[h2 Y]
[h2 Z]
[endsect]
</pre>
<p>
Here we use h2 assuming that section A is the outermost level. If it
is placed in an inner level, you'll have to use h3, h4, etc. depending
on where the section is. In general, it is the section level plus one.
It is rather tedious, however, to scan the section level everytime.
If you rewrite the example above as shown below, this will be automatic:
</p>
<pre class="programlisting">[section A]
[heading X]
[heading Y]
[heading Z]
[endsect]
</pre>
<p>
They work well regardless where you place them. You can rearrange sections
at will without any extra work to ensure correct heading levels. In
fact, with <span class="emphasis"><em>section</em></span> and <span
class="emphasis"><em>heading</em></span>, you have all you need. <span
class="emphasis"><em>h1</em></span>..<span class="emphasis"><em>h6</em></span>
becomes redundant. <span class="emphasis"><em>h1</em></span>..<span
class="emphasis"><em>h6</em></span> might be deprecated in the future.
</p>
</div>
</div>
<div id="quickbook.syntax.block.macros">
<h3>
Macros
</h3>
<div id="quickbook.syntax.block.macros">
<pre class="programlisting">[def macro_identifier some text]
</pre>
<p>
When a macro is defined, the identifier replaces the text anywhere
in the file, in paragraphs, in markups, etc. macro_identifier is a
string of non- white space characters except ']'. A macro may not follow
an alphabetic character or the underscore. The replacement text can
be any phrase (even marked up). Example:
</p>
<pre class="programlisting">[def sf_logo [$http://sourceforge.net/sflogo.php?group_id=28447&type=1]]
sf_logo
</pre>
<p>
Now everywhere the sf_logo is placed, the picture will be inlined.
</p>
<p>
<span class="inlinemediaobject"><img src="http://sourceforge.net/sflogo.php?group_id=28447&type=1"
alt="[]"/></span>
</p>
<div class="tip">
<p>
It's a good idea to use macro identifiers that are distinguishable.
For instance, in this document, macro identifiers have two leading
and trailing underscores (e.g. <tt>__spirit__</tt>). The reason is
to avoid unwanted macro replacement.
</p>
</div>
<p>
Links (URLS) and images are good candidates for macros. <span class="bold"><strong>1</strong></span>)
They tend to change a lot. It is a good idea to place all links and
images in one place near the top to make it easy to make changes.
<span class="bold"><strong>2</strong></span>) The syntax is not pretty.
It's easier to read and write, e.g. <tt>__spirit__</tt> than <tt>[@http://spirit.sourceforge.net
Spirit]</tt>.
</p>
<p>
Some more examples:
</p>
<pre class="programlisting">[def :-) [$theme/smiley.png]]
[def __spirit__ [@http://spirit.sourceforge.net Spirit]]
</pre>
<p>
(See <a href="#quickbook.syntax.phrase.images">Images</a> and <a href="#quickbook.syntax.phrase.links">Links</a>)
</p>
<p>
Invoking these macros:
</p>
<pre class="programlisting">Hi __spirit__ :-)
</pre>
<p>
will generate this:
</p>
<p>
Hi <a href="http://spirit.sourceforge.net">Spirit</a> <span class="inlinemediaobject"><img
src="images/smiley.png" alt="[]"/></span>
</p>
</div>
</div>
<div id="quickbook.syntax.block.predefined_macros">
<h3>
Predefined Macros
</h3>
<div id="quickbook.syntax.block.predefined_macros">
<p>
Quickbook has some predefined macros that you can already use.
</p>
<div id="quickbook.syntax.block.predefined_macros.t0" class="table">
<table>
<caption>Predefined Macros</caption>
<thead>
<tr>
<th>
<p>
Macro
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
<th>
<p>
Example
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
__DATE__
</p>
</td>
<td>
<p>
Today's date
</p>
</td>
<td>
<p>
2000-Dec-20
</p>
</td>
</tr>
<tr>
<td>
<p>
__TIME__
</p>
</td>
<td>
<p>
The current time
</p>
</td>
<td>
<p>
12:00:00 PM
</p>
</td>
</tr>
<tr>
<td>
<p>
__FILENAME__
</p>
</td>
<td>
<p>
Quickbook source filename
</p>
</td>
<td>
<p>
quickbook_manual-1_4.quickbook
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="quickbook.syntax.block.templates">
<h3>
Templates
</h3>
<div id="quickbook.syntax.block.templates">
<p>
Templates provide a more versatile text substitution mechanism. Templates
come in handy when you need to create parameterizable, multi-line,
boilerplate text that you specify once and expand many times. Templates
accept one or more arguments. These arguments act like place-holders
for text replacement. Unlike simple macros, which are limited to phrase
level markup, templates can contain block level markup (e.g. paragraphs,
code blocks and tables).
</p>
<p>
Example template:
</p>
<pre class="programlisting">[template person[name age what]
Hi, my name is [name]. I am [age] years old. I am a [what].
]
</pre>
<h5 id="quickbook.syntax.block.templates.template_identifier">
Template Identifier
</h5>
<p>
Template identifiers can either consist of:
</p>
<ul>
<li>
<div>
An initial alphabetic character or the underscore, followed by
zero or more alphanumeric characters or the underscore. This is
similar to your typical C/C++ identifier.
</div>
</li>
<li>
<div>
A single character punctuation (a non-alphanumeric printable character)
</div>
</li>
</ul>
<h5 id="quickbook.syntax.block.templates.formal_template_arguments">
Formal Template Arguments
</h5>
<p>
Template formal arguments are identifiers consisting of an initial
alphabetic character or the underscore, followed by zero or more alphanumeric
characters or the underscore. This is similar to your typical C/C++
identifier.
</p>
<p>
A template formal argument temporarily hides a template of the same
name at the point where the <a href="#quickbook.syntax.block.templates.template_expansion">template
is expanded</a>. Note that the body of the <tt>person</tt> template
above refers to <tt>name</tt> <tt>age</tt> and <tt>what</tt> as <tt>[name]</tt>
<tt>[age]</tt> and <tt>[what]</tt>. <tt>name</tt> <tt>age</tt> and
<tt>what</tt> are actually templates that exist in the duration of
the template call.
</p>
<h5 id="quickbook.syntax.block.templates.template_body">
Template Body
</h5>
<p>
The template body can be just about any QuickBook block or phrase.
There are actually two forms. Templates may be phrase or block level.
Phrase templates are of the form:
</p>
<pre class="programlisting">[template sample[arg1 arg2...argN] replacement text... ]
</pre>
<p>
Block templates are of the form:
</p>
<pre class="programlisting">[template sample[arg1 arg2...argN]
replacement text...
]
</pre>
<p>
The basic rule is as follows: if a newline immediately follows the
argument list, then it is a block template, otherwise, it is a phrase
template. Phrase templates are typically expanded as part of phrases.
Like macros, block level elements are not allowed in phrase templates.
</p>
<h5 id="quickbook.syntax.block.templates.template_expansion">
Template Expansion
</h5>
<p>
You expand a template this way:
</p>
<pre class="programlisting">[template_identifier arg1..arg2..arg3]
</pre>
<p>
At template expansion, you supply the actual arguments. The template
will be expanded with your supplied arguments. Example:
</p>
<pre class="programlisting">[person James Bond..39..Spy]
[person Santa Clause..87..Big Red Fatso]
</pre>
<p>
Which will expand to:
</p>
<p>
Hi, my name is James Bond. I am 39 years old. I am a Spy.
</p>
<p>
Hi, my name is Santa Clause. I am 87 years old. I am a Big Red Fatso.
</p>
<div class="caution">
<p>
A word of caution: Templates are recursive. A template can call another
template or even itself, directly or indirectly. There are no control
structures in QuickBook (yet) so this will always mean infinite recursion.
QuickBook can detect this situation and report an error if recursion
exceeds a certain limit.
</p>
</div>
<p>
Each actual argument can be a word, a text fragment or just about any
<a href="#quickbook.syntax.phrase">QuickBook phrase</a>. Arguments
are separated by the double dot <tt>".."</tt> and terminated
by the close parenthesis.
</p>
<h5 id="quickbook.syntax.block.templates.nullary_templates">
Nullary Templates
</h5>
<p>
Nullary templates look and act like simple macros. Example:
</p>
<pre class="programlisting">[template alpha[]'''&#945;''']
[template beta[]'''&#946;''']
</pre>
<p>
Expanding:
</p>
<pre class="programlisting">Some squigles...[*[alpha][beta]]</pre>
<p>
We have:
</p>
<p>
Some squiggles...<span class="bold"><strong>αβ</strong></span>
</p>
<p>
The difference with macros are
</p>
<ul>
<li>
<div>
The explicit <a href="#quickbook.syntax.block.templates.template_expansion">template
expansion syntax</a>. This is an advantage because, now, we don't
have to use obscure naming conventions like double underscores
(e.g. __alpha__) to avoid unwanted macro replacement.
</div>
</li>
<li>
<div>
The template is expanded at the point where it is invoked. A macro
is expanded immediately at its point of declaration. This is subtle
and can cause a slight difference in behavior especially if you
refer to other macros and templates in the body.
</div>
</li>
</ul>
<p>
The empty brackets after the template identifier (<tt>alpha[]</tt>)
indicates no arguments. If the template body does not look like a template
argument list, we can elide the empty brackets. Example:
</p>
<pre class="programlisting">[template aristotle_quote Aristotle: [*['Education is the best provision
for the journey to old age.]]]
</pre>
<p>
Expanding:
</p>
<pre class="programlisting">Here's a quote from [aristotle_quote].
</pre>
<p>
We have:
</p>
<p>
Here's a quote from Aristotle: <span class="bold"><strong><span class="emphasis"><em>Education
is the best provision for the journey to old age.</em></span></strong></span>.
</p>
<p>
The disadvantage is that you can't avoid the space between the template
identifier, <code><span class="identifier">aristotle_quote</span></code>,
and the template body "Aristotle...". This space will be
part of the template body. If that space is unwanted, use empty brackets
or use the space escape: "<code><span class="special">\</span>
</code>". Example:
</p>
<pre class="programlisting">[template tag\ _tag]
</pre>
<p>
Then expanding:
</p>
<pre class="programlisting">`struct` x[tag];
</pre>
<p>
We have:
</p>
<p>
<code><span class="keyword">struct</span></code> x_tag;
</p>
<p>
You have a couple of ways to do it. I personally prefer the explicit
empty brackets, though.
</p>
<h5 id="quickbook.syntax.block.templates.simple_arguments">
Simple Arguments
</h5>
<p>
As mentioned, arguments are separated by the double dot <tt>".."</tt>.
If there are less arguments passed than expected, QuickBook attempts
to break the last argument into two or more arguments following this
logic:
</p>
<ul>
<li>
<div>
Break the last argument into two, at the first space found (<tt>'',
'\n', \t' or '\r'</tt>).
</div>
</li>
<li>
<div>
Repeat until there are enough arguments or if there are no more
spaces found (in which case, an error is reported).
</div>
</li>
</ul>
<p>
For example:
</p>
<pre class="programlisting">[template simple[a b c d] [a][b][c][d]]
[simple w x y z]
</pre>
<p>
will produce:
</p>
<p>
wxyz
</p>
<p>
"w x y z" is initially treated as a single argument because
we didn't supply any <tt>".."</tt> separators. However, since
<tt>simple</tt> expects 4 arguments, "w x y z" is broken
down iteratively (applying the logic above) until we have "w",
"x", "y" and "z".
</p>
<p>
QuickBook only tries to get the arguments it needs. For example:
</p>
<pre class="programlisting">[simple w x y z trail]
</pre>
<p>
will produce:
</p>
<p>
wxyz trail
</p>
<p>
The arguments being: "w", "x", "y" and
"z trail".
</p>
<p>
It should be obvious now that for simple arguments with no spaces,
we can get by without separating the arguments with <tt>".."</tt>
separators. It is possible to combine <tt>".."</tt> separators
with the argument passing simplification presented above. Example:
</p>
<pre class="programlisting">[simple what do you think ..m a n?]
</pre>
<p>
will produce:
</p>
<p>
what do you think man?
</p>
<h5 id="quickbook.syntax.block.templates.punctuation_templates">
Punctuation Templates
</h5>
<p>
With templates, one of our objectives is to allow us to rewrite QuickBook
in QuickBook (as a qbk library). For that to happen, we need to accommodate
single character punctuation templates which are fairly common in QuickBook.
You might have noticed that single character punctuations are allowed
as <a href="#quickbook.syntax.block.templates.template_identifier">template
identifiers</a>. Example:
</p>
<pre class="programlisting">[template ![bar] <hey>[bar]</hey>]
</pre>
<p>
Now, expanding this:
</p>
<pre class="programlisting">[!baz]
</pre>
<p>
We will have:
</p>
<pre class="programlisting"><hey>baz</hey>
</pre>
</div>
</div>
<div id="quickbook.syntax.block.blurbs">
<h3>
Blurbs
</h3>
<div id="quickbook.syntax.block.blurbs">
<pre class="programlisting">[blurb :-) [*An eye catching advertisement or note...]
__spirit__ is an object-oriented recursive-descent parser generator framework
implemented using template meta-programming techniques. Expression templates
allow us to approximate the syntax of Extended Backus-Normal Form (EBNF)
completely in C++.
]
</pre>
<p>
will generate this:
</p>
<div class="blurb">
<p>
<span class="inlinemediaobject"><img src="images/smiley.png" alt="[]"/></span>
<span class="bold"><strong>An eye catching advertisement or note...</strong></span>
</p>
<p>
<a href="http://spirit.sourceforge.net">Spirit</a> is an object-oriented
recursive-descent parser generator framework implemented using template
meta-programming techniques. Expression templates allow us to approximate
the syntax of Extended Backus-Normal Form (EBNF) completely in C++.
</p>
</div>
<div class="note">
<p>
Prefer <a href="#quickbook.syntax.block.admonitions">admonitions</a>
wherever appropriate.
</p>
</div>
</div>
</div>
<div id="quickbook.syntax.block.tables">
<h3>
Tables
</h3>
<div id="quickbook.syntax.block.tables">
<pre class="programlisting">[table A Simple Table
[[Heading 1] [Heading 2] [Heading 3]]
[[R0-C0] [R0-C1] [R0-C2]]
[[R1-C0] [R1-C1] [R1-C2]]
[[R2-C0] [R2-C1] [R2-C2]]
]
</pre>
<p>
will generate:
</p>
<div id="quickbook.syntax.block.tables.t0" class="table">
<table>
<caption>A Simple Table</caption>
<thead>
<tr>
<th>
<p>
Heading 1
</p>
</th>
<th>
<p>
Heading 2
</p>
</th>
<th>
<p>
Heading 3
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
R0-C0
</p>
</td>
<td>
<p>
R0-C1
</p>
</td>
<td>
<p>
R0-C2
</p>
</td>
</tr>
<tr>
<td>
<p>
R2-C0
</p>
</td>
<td>
<p>
R2-C1
</p>
</td>
<td>
<p>
R2-C2
</p>
</td>
</tr>
<tr>
<td>
<p>
R3-C0
</p>
</td>
<td>
<p>
R3-C1
</p>
</td>
<td>
<p>
R3-C2
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>
The table title is optional. The first row of the table is automatically
treated as the table header; that is, it is wrapped in <tt><thead>...</thead></tt>
XML tags. Note that unlike the original QuickDoc, the columns are nested
in [ cells... ]. The syntax is free-format and allows big cells to
be formatted nicely. Example:
</p>
<pre class="programlisting">[table Table with fat cells
[[Heading 1] [Heading 2]]
[
[Row 0, Col 0: a small cell]
[
Row 0, Col 1: a big fat cell with paragraphs
Boost provides free peer-reviewed portable C++ source libraries.
We emphasize libraries that work well with the C++ Standard Library.
Boost libraries are intended to be widely useful, and usable across
a broad spectrum of applications. The Boost license encourages both
commercial and non-commercial use.
]
]
[
[Row 1, Col 0: a small cell]
[Row 1, Col 1: a small cell]
]
]
</pre>
<p>
and thus:
</p>
<div id="quickbook.syntax.block.tables.t1" class="table">
<table>
<caption>Table with fat cells</caption>
<thead>
<tr>
<th>
<p>
Heading 1
</p>
</th>
<th>
<p>
Heading 2
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
Row 0, Col 0: a small cell
</p>
</td>
<td>
<p>
Row 0, Col 1: a big fat cell with paragraphs
</p>
<p>
Boost provides free peer-reviewed portable C++ source libraries.
</p>
<p>
We emphasize libraries that work well with the C++ Standard
Library. Boost libraries are intended to be widely useful,
and usable across a broad spectrum of applications. The Boost
license encourages both commercial and non-commercial use.
</p>
</td>
</tr>
<tr>
<td>
<p>
Row 1, Col 0: a small cell
</p>
</td>
<td>
<p>
Row 1, Col 1: a small cell
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>
Here's how to have preformatted blocks of code in a table cell:
</p>
<pre class="programlisting">[table Table with code
[[Comment] [Code]]
[
[My first program]
[``
#include <iostream>
int main()
{
std::cout << "Hello, World!" << std::endl;
return 0;
}
``]
]
]
</pre>
<div id="quickbook.syntax.block.tables.t2" class="table">
<table>
<caption>Table with code</caption>
<thead>
<tr>
<th>
<p>
Comment
</p>
</th>
<th>
<p>
Code
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
My first program
</p>
</td>
<td>
<p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World!"</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="quickbook.syntax.block.variable_lists">
<h3>
Variable Lists
</h3>
<div id="quickbook.syntax.block.variable_lists">
<pre class="programlisting">[variablelist A Variable List
[[term 1] [The definition of term 1]]
[[term 2] [The definition of term 2]]
[[term 3] [The definition of term 3]]
]
</pre>
<p>
will generate:
</p>
<dl>
<dt>
term 1
</dt>
<dd>
<p>
The definition of term 1
</p>
</dd>
<dt>
term 2
</dt>
<dd>
<p>
The definition of term 2
</p>
</dd>
<dt>
term 3
</dt>
<dd>
<p>
The definition of term 3
</p>
</dd>
</dl>
<p>
The rules for variable lists are the same as for tables, except that
only 2 "columns" are allowed. The first column contains the
terms, and the second column contains the definitions. Those familiar
with HTML will recognize this as a "definition list".
</p>
</div>
</div>
<div id="quickbook.syntax.block.include">
<h3>
Include
</h3>
<div id="quickbook.syntax.block.include">
<p>
You can include one QuickBook file from another. The syntax is simply:
</p>
<pre class="programlisting">[include someother.qbk]
</pre>
<p>
The included file will be processed as if it had been cut and pasted
into the current document, with the following exceptions:
</p>
<ul>
<li>
<div>
The __FILENAME__ predefined macro will reflect the name of the
file currently being processed.
</div>
</li>
<li>
<div>
Any macros defined in the included file are scoped to that file.
</div>
</li>
</ul>
<p>
The <tt>[include]</tt> directive lets you specify a document id to
use for the included file. When this id is not explicitly specified,
the id defaults to the filename ("someother", in the example
above). You can specify the id like this:
</p>
<pre class="programlisting">[include:someid someother.qbk]
</pre>
<p>
All auto-generated anchors will use the document id as a unique prefix.
So for instance, if there is a top section in someother.qbk named "Intro",
the named anchor for that section will be "someid.intro",
and you can link to it with <tt>[link someid.intro The Intro]</tt>.
</p>
</div>
</div>
<div id="quickbook.syntax.block.import">
<h3>
Import
</h3>
<div id="quickbook.syntax.block.import">
<p>
When documenting code, you'd surely need to present code from actual
source files. While it is possible to copy some code and paste them
in your QuickBook file, doing so is error prone and the extracted code
in the documentation tends to get out of sync with the actual code
as the code evolves. The problem, as always, is that once documentation
is written, the tendency is for the docs to languish in the archives
without maintenance.
</p>
<p>
QuickBook's import facility provides a nice solution.
</p>
<h5 id="quickbook.syntax.block.import.example">
Example
</h5>
<p>
You can effortlessly import code snippets from source code into your
QuickBook. The following illustrates how this is done:
</p>
<pre class="programlisting">[import ../test/stub.cpp]
[foo]
[bar]
</pre>
<p>
The first line:
</p>
<pre class="programlisting">[import ../test/stub.cpp]
</pre>
<p>
collects specially marked-up code snippets from <a href="../../test/stub.cpp">stub.cpp</a>
and places them in your QuickBook file as virtual templates. Each of
the specially marked-up code snippets has a name (e.g. <code><span
class="identifier">foo</span></code> and <code><span class="identifier">bar</span></code>
in the example above). This shall be the template identifier for that
particular code snippet. The second and third line above does the actual
template expansion:
</p>
<pre class="programlisting">[foo]
[bar]
</pre>
<p>
And the result is:
</p>
<p>
This is the <span class="bold"><strong><span class="emphasis"><em>foo</em></span></strong></span>
function.
</p>
<p>
This description can have paragraphs...
</p>
<ul>
<li>
<div>
lists
</div>
</li>
<li>
<div>
etc.
</div>
</li>
</ul>
<p>
And any quickbook block markup.
</p>
<p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo</span><span class="special">()</span>
<span class="special">{</span>
<span class="comment">// return 'em, foo man!</span>
<span class="keyword">return</span> <span class="string">"foo"</span><span class="special">;</span>
<span class="special">}</span>
</pre>
</p>
<p>
This is the <span class="bold"><strong><span class="emphasis"><em>bar</em></span></strong></span>
function
</p>
<p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">bar</span><span class="special">()</span>
<span class="special">{</span>
<span class="comment">// return 'em, bar man!</span>
<span class="keyword">return</span> <span class="string">"bar"</span><span class="special">;</span>
<span class="special">}</span>
</pre>
</p>
<p>
Some trailing text here
</p>
<h5 id="quickbook.syntax.block.import.code_snippet_markup">
Code Snippet Markup
</h5>
<p>
Note how the code snippets in <a href="../../test/stub.cpp">stub.cpp</a>
get marked up. We use distinguishable comments following the form:
</p>
<pre class="programlisting"><span class="comment">//[id</span>
<span class="identifier">some</span> <span class="identifier">code</span> <span class="identifier">here</span>
<span class="comment">//]</span>
</pre>
<p>
The first comment line above initiates a named code-snippet. This prefix
will not be visible in quickbook. The entire code-snippet in between
<code><span class="comment">//[id</span></code> and <code><span class="comment">//]</span></code>
will be inserted as a template in quickbook with name <span class="emphasis"><em><span
class="emphasis"><em>id</em></span></em></span>. The comment <code><span
class="comment">//]</span></code> ends a code-snippet This too will
not be visible in quickbook.
</p>
<h5 id="quickbook.syntax.block.import.special_comments">
Special Comments
</h5>
<p>
Special comments of the form:
</p>
<pre class="programlisting"><span class="comment">//` some [*quickbook] markup here</span>
</pre>
<p>
and:
</p>
<pre class="programlisting"><span class="comment">/*` some [*quickbook] markup here */</span>
</pre>
<p>
will be parsed by QuickBook. This can contain quickbook <span class="emphasis"><em>blocks</em></span>
(e.g. sections, paragraphs, tables, etc). In the first case, the initial
slash-slash, tick and white-space shall be ignored. In the second,
the initial slash-star-tick and the final star-slash shall be ignored.
</p>
<h5 id="quickbook.syntax.block.import.callouts">
Callouts
</h5>
<p>
Special comments of the form:
</p>
<pre class="programlisting"><span class="comment">/*< some [*quickbook] markup here >*/</span>
</pre>
<p>
will be regarded as callouts. These will be collected, numbered and
rendered as a "callout bug" (a small icon with a number).
After the whole snippet is parsed, the callout list is generated. See
<a href="http://www.docbook.org/tdg/en/html/callout.html">Callouts</a>
for details. Example:
</p>
<p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo_bar</span><span class="special">()</span> <a href="#quickbook.syntax.block.import.c1">(1)</a>
<span class="special">{</span>
<span class="keyword">return</span> <span class="string">"foo-bar"</span><span class="special">;</span> <a href="#quickbook.syntax.block.import.c3">(2)</a>
<span class="special">}</span>
</pre>
</p>
<div>
<div id="quickbook.syntax.block.import.c1">
<a href="#quickbook.syntax.block.import.c0">(1)</a>
<p>
The <span class="emphasis"><em>Mythical</em></span> FooBar. See
<a href="http://en.wikipedia.org/wiki/Foobar">Foobar for details</a>
</p>
</div>
<div id="quickbook.syntax.block.import.c3">
<a href="#quickbook.syntax.block.import.c2">(2)</a>
<p>
return 'em, foo-bar man!
</p>
</div>
</div>
<p>
Checkout <a href="../../test/stub.cpp">stub.cpp</a> to see the actual
code.
</p>
</div>
</div>
</div>
</div>
<div id="quickbook.install">
<h3>
Installation and configuration
</h3>
<div id="quickbook.install">
<p>
This section provides some guidelines on how to install and configure BoostBook
and Quickbook under several operating systems.
</p>
<p>
Before continuing, it is very important that you keep this in mind: if
you try to build some documents and the process breaks due to misconfiguration,
be absolutely sure to delete any <code><span class="identifier">bin</span></code>
and <code><span class="identifier">bin</span><span class="special">.</span><span
class="identifier">v2</span></code> directories generated by the build
before trying again. Otherwise your configuration fixes will not take any
effect.
</p>
</div>
<div id="quickbook.install.windows">
<h3>
Windows 2000, XP, 2003, Vista
</h3>
<div id="quickbook.install.windows">
<blockquote>
<p>
<span class="emphasis"><em>Section contributed by Julio M. Merino Vidal</em></span>
</p>
</blockquote>
<p>
The following instructions apply to any Windows system based on Windows
2000, including Windows XP, Windows 2003 Server and Windows Vista. The
paths shown below are taken from a Windows Vista machine; you will need
to adjust them to match your system in case you are running an older
version.
</p>
<ol>
<li>
<div>
First of all you need to have a copy of <code><span class="identifier">xsltproc</span></code>
for Windows. There are many ways to get this tool, but to keep things
simple, use the <a href="http://www.zlatkovic.com/pub/libxml/">binary
packages</a> made by Igor Zlatkovic. At the very least, you need
to download the following packages: <code><span class="identifier">iconv</span></code>,
<code><span class="identifier">zlib</span></code>, <code><span class="identifier">libxml2</span></code>
and <code><span class="identifier">libxslt</span></code>.
</div>
</li>
<li>
<div>
Unpack all these packages in the same directory so that you get unique
<code><span class="identifier">bin</span></code>, <code><span class="identifier">include</span></code>
and <code><span class="identifier">lib</span></code> directories
within the hierarchy. These instructions use <code><span class="identifier">C</span><span
class="special">:\</span><span class="identifier">Users</span><span
class="special">\</span><span class="identifier">example</span><span
class="special">\</span><span class="identifier">Documents</span><span
class="special">\</span><span class="identifier">boost</span><span
class="special">\</span><span class="identifier">xml</span></code>
as the root for all files.
</div>
</li>
<li>
<div>
From the command line, go to the <code><span class="identifier">bin</span></code>
directory and launch <code><span class="identifier">xsltproc</span><span
class="special">.</span><span class="identifier">exe</span></code>
to ensure it works. You should get usage information on screen.
</div>
</li>
<li>
<div>
Download <a href="http://www.docbook.org/xml/4.2/docbook-xml-4.2.zip">Docbook
XML 4.2</a> and unpack it in the same directory used above. That
is: <code><span class="identifier">C</span><span class="special">:\</span><span
class="identifier">Users</span><span class="special">\</span><span
class="identifier">example</span><span class="special">\</span><span
class="identifier">Documents</span><span class="special">\</span><span
class="identifier">boost</span><span class="special">\</span><span
class="identifier">xml</span><span class="special">\</span><span
class="identifier">docbook</span><span class="special">-</span><span
class="identifier">xml</span></code>.
</div>
</li>
<li>
<div>
Download the latest <a href="http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=16608">Docbook
XSL</a> version and unpack it, again in the same directory used before.
To make things easier, rename the directory created during the extraction
to <code><span class="identifier">docbook</span><span class="special">-</span><span
class="identifier">xsl</span></code> (bypassing the version name):
<code><span class="identifier">C</span><span class="special">:\</span><span
class="identifier">Users</span><span class="special">\</span><span
class="identifier">example</span><span class="special">\</span><span
class="identifier">Documents</span><span class="special">\</span><span
class="identifier">boost</span><span class="special">\</span><span
class="identifier">xml</span><span class="special">\</span><span
class="identifier">docbook</span><span class="special">-</span><span
class="identifier">xsl</span></code>.
</div>
</li>
<li>
<div>
Add the following to your <code><span class="identifier">user</span><span
class="special">-</span><span class="identifier">config</span><span
class="special">.</span><span class="identifier">jam</span></code>
file, which should live in your home directory (<code><span class="special">%</span><span
class="identifier">HOMEDRIVE</span><span class="special">%%</span><span
class="identifier">HOMEPATH</span><span class="special">%</span></code>).
You must already have it somewhere or otherwise you could not be
building Boost (i.e. missing tools configuration).
</div>
</li>
</ol>
<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">xsltproc</span>
<span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"</span>
<span class="special">;</span>
<span class="identifier">using</span> <span class="identifier">boostbook</span>
<span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/docbook-xsl"</span>
<span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/docbook-xml"</span>
<span class="special">;</span>
</pre>
<p>
The above steps are enough to get a functional BoostBook setup. Quickbook
will be automatically built when needed. If you want to avoid these rebuilds:
</p>
<ol>
<li>
<div>
Go to Quickbook's source directory (<code><span class="identifier">BOOST_ROOT</span><span
class="special">\</span><span class="identifier">tools</span><span
class="special">\</span><span class="identifier">quickbook</span></code>).
</div>
</li>
<li>
<div>
Build the utility by issuing <code><span class="identifier">bjam</span>
<span class="special">--</span><span class="identifier">v2</span></code>.
</div>
</li>
<li>
<div>
Copy the resulting <code><span class="identifier">quickbook</span><span
class="special">.</span><span class="identifier">exe</span></code>
binary (located under the <code><span class="identifier">BOOST_ROOT</span><span
class="special">\</span><span class="identifier">bin</span><span
class="special">.</span><span class="identifier">v2</span></code>
hierarchy) to a safe place. Following our previous example, you can
install it into: <code><span class="identifier">C</span><span class="special">:\</span><span
class="identifier">Users</span><span class="special">\</span><span
class="identifier">example</span><span class="special">\</span><span
class="identifier">Documents</span><span class="special">\</span><span
class="identifier">boost</span><span class="special">\</span><span
class="identifier">xml</span><span class="special">\</span><span
class="identifier">bin</span></code>.
</div>
</li>
<li>
<div>
Add the following to your <code><span class="identifier">user</span><span
class="special">-</span><span class="identifier">config</span><span
class="special">.</span><span class="identifier">jam</span></code>
file:
</div>
</li>
</ol>
<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">quickbook</span>
<span class="special">:</span> <span class="string">"C:/Users/example/Documents/boost/xml/bin/quickbook.exe"</span>
<span class="special">;</span>
</pre>
</div>
</div>
<div id="quickbook.install.linux">
<h3>
Debian, Ubuntu
</h3>
<div id="quickbook.install.linux">
<p>
The following instructions apply to Debian and its derivatives. They
are based on a Ubuntu Edgy install but should work on other Debian based
systems.
</p>
<p>
First install the <code><span class="identifier">bjam</span></code>,
<code><span class="identifier">xsltproc</span></code>, <code><span class="identifier">docbook</span><span
class="special">-</span><span class="identifier">xsl</span></code> and
<code><span class="identifier">docbook</span><span class="special">-</span><span
class="identifier">xml</span></code> packages. For example, using <code><span
class="identifier">apt</span><span class="special">-</span><span class="identifier">get</span></code>:
</p>
<pre class="programlisting"><span class="identifier">sudo</span> <span class="identifier">apt</span><span class="special">-</span><span class="identifier">get</span> <span class="identifier">install</span> <span class="identifier">xsltprc</span> <span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xsl</span> <span class="identifier">docbook</span><span class="special">-</span><span class="identifier">xml</span>
</pre>
<p>
If you're planning on building boost's documentation, you'll also need
to install the <code><span class="identifier">doxygen</span></code> package
as well.
</p>
<p>
Next, we need to configure Boost Build to compile BoostBook files. Add
the following to your <code><span class="identifier">user</span><span
class="special">-</span><span class="identifier">config</span><span class="special">.</span><span
class="identifier">jam</span></code> file, which should be in your home
directory. If you don't have one, create a file containing this text.
For more information on setting up <code><span class="identifier">user</span><span
class="special">-</span><span class="identifier">config</span><span class="special">.</span><span
class="identifier">jam</span></code>, see the <a href="http://boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html">Boost
Build documentation</a>.
</p>
<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">xsltproc</span> <span class="special">;</span>
<span class="identifier">using</span> <span class="identifier">boostbook</span>
<span class="special">:</span> <span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xml</span><span class="special">/</span><span class="identifier">docbook</span><span class="special">/</span><span class="identifier">stylesheet</span><span class="special">/</span><span class="identifier">nwalsh</span>
<span class="special">:</span> <span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">share</span><span class="special">/</span><span class="identifier">xml</span><span class="special">/</span><span class="identifier">docbook</span><span class="special">/</span><span class="identifier">schema</span><span class="special">/</span><span class="identifier">dtd</span><span class="special">/</span><span class="number">4.2</span>
<span class="special">;</span>
<span class="comment"># Remove this line if you're not using doxygen</span>
<span class="identifier">using</span> <span class="identifier">doxygen</span> <span class="special">;</span>
</pre>
<p>
The above steps are enough to get a functional BoostBook setup. Quickbook
will be automatically built when needed. If you want to avoid these rebuilds:
</p>
<ol>
<li>
<div>
Go to Quickbook's source directory (<code><span class="identifier">BOOST_ROOT</span><span
class="special">/</span><span class="identifier">tools</span><span
class="special">/</span><span class="identifier">quickbook</span></code>).
</div>
</li>
<li>
<div>
Build the utility by issuing <code><span class="identifier">bjam</span>
<span class="special">--</span><span class="identifier">v2</span></code>.
</div>
</li>
<li>
<div>
Copy the resulting <code><span class="identifier">quickbook</span></code>
binary (located under the <code><span class="identifier">BOOST_ROOT</span><span
class="special">/</span><span class="identifier">bin</span><span
class="special">.</span><span class="identifier">v2</span></code>
hierarchy) to a safe place. The traditional location is <code><span
class="special">/</span><span class="identifier">usr</span><span
class="special">/</span><span class="identifier">local</span><span
class="special">/</span><span class="identifier">bin</span></code>.
</div>
</li>
<li>
<div>
Add the following to your <code><span class="identifier">user</span><span
class="special">-</span><span class="identifier">config</span><span
class="special">.</span><span class="identifier">jam</span></code>
file, using the full path of the quickbook executable:
</div>
</li>
</ol>
<pre class="programlisting"><span class="identifier">using</span> <span class="identifier">quickbook</span>
<span class="special">:</span> <span class="special">/</span><span class="identifier">usr</span><span class="special">/</span><span class="identifier">local</span><span class="special">/</span><span class="identifier">bin</span><span class="special">/</span><span class="identifier">quickbook</span>
<span class="special">;</span>
</pre>
</div>
</div>
</div>
<div id="quickbook.editors">
<h3>
Editor Support
</h3>
<div id="quickbook.editors">
<p>
Editing quickbook files is usually done with text editors both simple and
powerful. The following sections list the settings for some editors which
can help make editing quickbook files a bit easier.
</p>
<div class="blurb">
<p>
<span class="inlinemediaobject"><img src="images/note.png" alt="[]"/></span>
You may submit your settings, tips, and suggestions to the authors, or
through the <a href="https://lists.sourceforge.net/lists/listinfo/boost-">docs
Boost Docs mailing list</a>.
</p>
</div>
</div>
<div id="quickbook.editors.scite">
<h3>
Scintilla Text Editor
</h3>
<div id="quickbook.editors.scite">
<blockquote>
<p>
<span class="emphasis"><em>Section contributed by Dean Michael Berris</em></span>
</p>
</blockquote>
<p>
The Scintilla Text Editor (SciTE) is a free source code editor for Win32
and X. It uses the SCIntilla source code editing component.
</p>
<div class="blurb">
<p>
<span class="inlinemediaobject"><img src="images/tip.png" alt="[]"/></span>
SciTE can be downloaded from <a href="http://www.scintilla.org/SciTE.html">http://www.scintilla.org/SciTE.html</a>
</p>
</div>
<p>
You can use the following settings to highlight quickbook tags when editing
quickbook files.
</p>
<pre class="programlisting">qbk=*.qbk
lexer.*.qbk=props
use.tabs.$(qbk)=0
tab.size.$(qbk)=4
indent.size.$(qbk)=4
style.props.32=$(font.base)
comment.stream.start.props=[/
comment.stream.end.props=]
comment.box.start.props=[/
comment.box.middle.props=
comment.box.end.props=]
</pre>
<div class="blurb">
<p>
<span class="inlinemediaobject"><img src="images/note.png" alt="[]"/></span>
Thanks to Rene Rivera for the above SciTE settings.
</p>
</div>
</div>
</div>
</div>
<div id="quickbook.faq">
<h3>
Frequently Asked Questions
</h3>
<div id="quickbook.faq">
<h3 id="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">
Can I use QuickBook for non-Boost documentation?
</h3>
<p>
QuickBook can be used for non-Boost documentation with a little extra work.
</p>
<blockquote>
<p>
<span class="emphasis"><em>Faq contributed by Michael Marcin</em></span>
</p>
</blockquote>
<p>
When building HTML documentation with BoostBook a Boost C++ Libraries header
is added to the files. When using QuickBook to document projects outside
of Boost this is not desirable. This behavior can be overridden at the
BoostBook level by specifying some XSLT options. When using Boost Build
version 2 (BBv2) this can be achieved by adding parameters to the BoostBook
target declaration.
</p>
<p>
For example:
</p>
<pre class="programlisting">using quickbook ;
xml my_doc : my_doc.qbk ;
boostbook standalone
:
my_doc
:
<xsl:param>boost.image.src=images/my_project_logo.png
<xsl:param>boost.image.alt="\"My Project\""
<xsl:param>boost.image.w=100
<xsl:param>boost.image.h=50
<xsl:param>nav.layout=none
;
</pre>
</div>
</div>
<div id="quickbook.ref">
<h3>
Quick Reference
</h3>
<div id="quickbook.ref">
<p>
[cpp]
</p>
<div id="quickbook.ref.t0" class="table">
<table>
<caption>Syntax Compendium</caption>
<thead>
<tr>
<th>
<p>
To do this...
</p>
</th>
<th>
<p>
Use this...
</p>
</th>
<th>
<p>
See this...
</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>
comment
</p>
</td>
<td>
<p>
<tt>[/ some comment]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.comments">Comments</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="emphasis"><em>italics</em></span>
</p>
</td>
<td>
<p>
<tt>['italics] or /italics/</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.font_styles">Font Styles</a>
and <a href="#quickbook.syntax.phrase.simple_formatting">Simple
formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>bold</strong></span>
</p>
</td>
<td>
<p>
<tt>[*bold] or *bold*</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.font_styles">Font Styles</a>
and <a href="#quickbook.syntax.phrase.simple_formatting">Simple
formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="underline">underline</span>
</p>
</td>
<td>
<p>
<tt>[_underline] or _underline_</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.font_styles">Font Styles</a>
and <a href="#quickbook.syntax.phrase.simple_formatting">Simple
formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt>teletype</tt>
</p>
</td>
<td>
<p>
<tt>[^teletype] or =teletype=</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.font_styles">Font Styles</a>
and <a href="#quickbook.syntax.phrase.simple_formatting">Simple
formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="strikethrough">strikethrough</span>
</p>
</td>
<td>
<p>
<tt>[-strikethrough]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.font_styles">Font Styles</a>
and <a href="#quickbook.syntax.phrase.simple_formatting">Simple
formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<em class="replaceable">replaceable</em>
</p>
</td>
<td>
<p>
<tt>[~replaceable]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.replaceable">Replaceble</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
source mode
</p>
</td>
<td>
<p>
<tt>[c++]</tt> or <tt>[python]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.source_mode">Source Mode</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
inline code
</p>
</td>
<td>
<p>
<tt>`int main();`</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.inline_code">Inline code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code block
</p>
</td>
<td>
<p>
<tt>``int main();``</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.code">Code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code escape
</p>
</td>
<td>
<p>
<tt>``from c++ to QuickBook``</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.escape_back">Escaping Back To
QuickBook</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
line break
</p>
</td>
<td>
<p>
<tt>[br] or \n</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.line_break">line-break</a>
<span class="bold"><strong>DEPRECATED</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
anchor
</p>
</td>
<td>
<p>
<tt>[#anchor]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.anchors">Anchors</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
link
</p>
</td>
<td>
<p>
<tt>[@http://www.boost.org Boost]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.links">Links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
anchor link
</p>
</td>
<td>
<p>
<tt>[link section.anchor Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.anchor_links">Anchor links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
refentry link
</p>
</td>
<td>
<p>
<tt>[link xml.refentry Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.refentry_links">refentry links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
function link
</p>
</td>
<td>
<p>
<tt>[funcref fully::qualified::function_name Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
class link
</p>
</td>
<td>
<p>
<tt>[classref fully::qualified::class_name Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
member link
</p>
</td>
<td>
<p>
<tt>[memberref fully::qualified::member_name Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
enum link
</p>
</td>
<td>
<p>
<tt>[enumref fully::qualified::enum_name Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
macro link
</p>
</td>
<td>
<p>
<tt>[macroref MACRO_NAME Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
concept link
</p>
</td>
<td>
<p>
<tt>[conceptref ConceptName Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
header link
</p>
</td>
<td>
<p>
<tt>[headerref path/to/header.hpp Link text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.code_links">function, class,
member, enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
escape
</p>
</td>
<td>
<p>
<tt>'''escaped text (no processing/formatting)'''</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.escape">Escape</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
single char escape
</p>
</td>
<td>
<p>
<tt>\c</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.single_char_escape">Single
char escape</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
images
</p>
</td>
<td>
<p>
<tt>[$image.jpg]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.phrase.images">Images</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
begin section
</p>
</td>
<td>
<p>
<tt>[section The Section Title]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.section">Section</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
end section
</p>
</td>
<td>
<p>
<tt>[endsect]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.section">Section</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
paragraph
</p>
</td>
<td>
<p>
No markup. Paragraphs start left-flushed and are terminated by
two or more newlines.
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.paragraphs">Paragraphs</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
ordered list
</p>
</td>
<td>
<pre class="programlisting"># one
# two
# three
</pre>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.lists.ordered_lists">Ordered
lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
unordered list
</p>
</td>
<td>
<pre class="programlisting">* one
* two
* three
</pre>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.lists.unordered_lists">Unordered
lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code
</p>
</td>
<td>
<p>
No markup. Preformatted code starts with a space or a tab.
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.code">Code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
preformatted
</p>
</td>
<td>
<p>
<tt>[pre preformatted]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.preformatted">Preformatted</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
block quote
</p>
</td>
<td>
<p>
<tt>[:sometext...]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.blockquote">Blockquote</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 1
</p>
</td>
<td>
<p>
<tt>[h1 Heading 1]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 2
</p>
</td>
<td>
<p>
<tt>[h2 Heading 2]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 3
</p>
</td>
<td>
<p>
<tt>[h3 Heading 3]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 4
</p>
</td>
<td>
<p>
<tt>[h4 Heading 4]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 5
</p>
</td>
<td>
<p>
<tt>[h5 Heading 5]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 6
</p>
</td>
<td>
<p>
<tt>[h6 Heading 6]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
macro
</p>
</td>
<td>
<p>
<tt>[def macro_identifier some text]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.macros">Macros</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
template
</p>
</td>
<td>
<p>
<tt>[template[a b] [a] body [b]]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.templates">Templates</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
blurb
</p>
</td>
<td>
<p>
<tt>[blurb advertisement or note...]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.blurbs">Blurbs</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
admonition
</p>
</td>
<td>
<p>
<tt>[warning Warning text...]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.admonitions">Admonitions</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
table
</p>
</td>
<td>
<pre class="programlisting">[table Title
[[a][b][c]]
[[a][b][c]]
]
</pre>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.tables">Tables</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
variablelist
</p>
</td>
<td>
<pre class="programlisting">[variablelist Title
[[a][b]]
[[a][b]]
]
</pre>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.variable_lists">Variable Lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
include
</p>
</td>
<td>
<p>
<tt>[include someother.qbk]</tt>
</p>
</td>
<td>
<p>
<a href="#quickbook.syntax.block.include">Include</a>
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="footnotes">
<br/>
<hr/>
<div id="footnote-1" class="footnote">
<p>
<a href="#quickbook.syntax.phrase.simple_formatting.f0"><sup>[1]</sup></a>
Thanks to David Barrett, author of <a href="http://quinthar.com/qwikiwiki/index.php?page=Home">Qwiki</a>,
for sharing these samples and teaching me these obscure formatting rules.
I wasn't sure at all if <a href="http://spirit.sourceforge.net">Spirit</a>,
being more or less a formal EBNF parser, can handle the context sensitivity
and ambiguity.
</p>
</div>
<div id="footnote-2" class="footnote">
<p>
<a href="#quickbook.syntax.phrase.footnotes.f0"><sup>[2]</sup></a> A sample
footnote
</p>
</div>
</div>
</body>
</html>
|
