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

\documentclass{ltxdoc}
\setlength\parindent{0pt}
\setlength\parskip{\smallskipamount}

\usepackage{ifpdf}
\ifpdf
  \usepackage{mathptmx,courier}
  \usepackage[scaled=0.90]{helvet}
  \addtolength\marginparwidth{15pt}
\fi

\usepackage[USenglish]{babel}
\usepackage{longtable,setspace}

\usepackage{hypdoc}
\hypersetup{pdfkeywords={LaTeX, package, caption},pdfstartview={}}
\usepackage[listof=0,hypcap=false]{caption}[2007/09/01]

\DeclareRobustCommand*\eTeX{\texorpdfstring
  {\leavevmode\hbox{$\varepsilon$}-\TeX}%
  {e-TeX}}
\DeclareRobustCommand*\AmS{\texorpdfstring
  {{\protect\usefont{OMS}{cmsy}{m}{n}A\kern-.1667em\lower.5ex\hbox{M}\kern-.125emS}}%
  {AMS}}
\DeclareRobustCommand*\KOMAScript{\texorpdfstring
  {\textsf{K\kern.05em O\kern.05em M\kern.05em A\kern.1em-\kern.1em Script}}%
  {KOMA-Script}}
\DeclareRobustCommand*\NTG{NTG}
\DeclareRobustCommand*\SmF{SMF}

\newcommand\NEW[2]{\hskip 1sp \marginpar{\footnotesize\sffamily\raggedleft#1\\#2}}

\usepackage{marvosym}
\makeatletter
\newcommand*\INFO{\@ifstar{\@INFO{}}{\@INFO{\vbox to \ht\strutbox}}}
\newcommand*\@INFO[1]{\MARGINSYM{#1{\Huge\Info}}}
\makeatother
\font\manual=manfnt
\newcommand*\DANGER{\MARGINSYM{\manual\char127}}
\newcommand*\MARGINSYM[1]{\hskip 1sp \marginpar{\raggedleft\textcolor{blue}{{#1}}}}

\DeclareCaptionFormat{myformat1}{#1#2\\#3}
\newlength\myindention
\DeclareCaptionFormat{myformat2}{#1#2\\\hspace*\myindention#3}
\DeclareCaptionOption{myindention}{\setlength\myindention{#1}}
\DeclareCaptionFormat{reverse}{#3#2#1}
\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}
\DeclareCaptionLabelFormat{fullparens}{(\bothIfFirst{#1}{~}#2)}
\DeclareCaptionLabelSeparator{fill}{\hfill}

\newcommand*\purerm[1]{{\upshape\mdseries\rmfamily #1}}
\newcommand*\puresf[1]{{\upshape\mdseries\sffamily #1}}
\newcommand*\purett[1]{{\upshape\mdseries\ttfamily #1}}
\let\package\puresf
\let\env\purett \let\opt\purett

\newcommand*\csmarg[1]{\texttt{\char`\{#1\char`\}}}
\newcommand*\csoarg[1]{\texttt{\char`\[#1\char`\]}}
\newcommand*\version[2][]{$v#2$}
\newcommand*\x{\discretionary{-}{}{}}
\newcommand*\xx{\discretionary{}{}{}}

\newenvironment{Options}[1]%
  {\list{}{\renewcommand\makelabel[1]{\texttt{##1}\hfil}%
   \settowidth\labelwidth{\texttt{#1\space}}%
   \setlength\leftmargin{10pt}%
   \addtolength\leftmargin{\labelwidth}%
   \addtolength\leftmargin{\labelsep}}}%
  {\endlist}

\newenvironment{Example}%
  {\ifvmode\else\unskip\par\fi
   \minipage{\linewidth}\smallskip}%
  {\smallskip\endminipage}

\makeatletter
\newcommand\example{\@ifstar
  {\@example{belowskip=\abovecaptionskip}}%
  {\@example{}}}
\def\@example#1{%
  \@testopt{\@@example{#1}}{figure}}
\long\def\@@example#1[#2]#3#4{%
  \begingroup
    \captionsetup{#1,size=small,margin={\leftmargini,10pt},#3}%
    \captionof{#2}[]{#4}%
  \endgroup}
\makeatother

\begin{document}
\let\subsectionautorefname\sectionautorefname
\let\subsubsectionautorefname\sectionautorefname

\def\thispackage{the \package{caption} package}
\def\Thispackage{The \package{caption} package}

\newcommand\NEWfeature{\NEW{New feature}}
\newcommand\NEWdescription{\NEW{New description}}

\makeatletter
\newcommand*\Ref{\@ifstar{\@Ref\ref}{\@Ref\autoref}}
\newcommand*\@Ref[2]{#1{#2}: \textit{\nameref{#2}}}
\makeatother
\newcommand*\See[1]{\nopagebreak{\small (See #1)}}
\newcommand*\SeeUserDefined[1][]{\See{\Ref{declare}#1}}

%\def\TODO{\emph{-- Some information is missing here --}}

% --------------------------------------------------------------------------- %

\GetFileInfo{caption-eng.tex}
\let\docdate\filedate
\GetFileInfo{caption.sty}

\title{Typesetting captions with the caption package\texorpdfstring{\thanks{%
         This package has version number \fileversion,
         last revised \filedate.}}{}}
\author{Axel Sommerfeldt\\
        \href{mailto:caption@sommerfee.de}{\texttt{caption@sommerfee.de}}}
\date{\docdate}
\maketitle

% --------------------------------------------------------------------------- %

\begin{abstract}
\Thispackage\ offers customization of captions
in floating environments such |figure| and |table| and cooperates with
many other packages.\footnote{A complete re-work of the user interface
done with Steven D. Cochran and Frank Mittelbach has lead to
the enhanced version $3.0$.}
\end{abstract}

\newcommand\exampletext{%
  White sand beaches. The pink smoothness of the conch shell. A sea abundant
  with possibilities. Duty-free shops filled with Europe's finest gifts and
  perfumes. Play your favorite game of golf amidst the tropical greens on one
  of the many championship courses.}

% --------------------------------------------------------------------------- %

\section*{Introduction}

Within the standard \LaTeX\ classes captions haven't received the attention
they deserve. Simply typeset as an ordinary paragraph there is no
remarkable visual difference from the rest of the text, like here:

\example*{size=normalsize,margin=0pt}{\exampletext}

There should be possibilities to change this; for example, it would be nice
if you could make the text of the caption a little bit smaller as the normal
text, add an extra margin, typeset the caption label with the same font
family and shape as your headings etc. Just like this one:

\example*{size=small,margin=10pt,labelfont=bf,labelsep=endash}{\exampletext}

You can do this easily with this package as there are many ready-to-use
caption formatting options, but you are free to define your very own stuff, too.

% --------------------------------------------------------------------------- %

\section*{Preliminary documentation}

Please note that this document is inconsistent and not finished yet.
It'll try to update it within the next months; the actual version can always be found
\href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/caption/caption-eng.pdf}%
{here}.\par\bigskip

% --------------------------------------------------------------------------- %

\clearpage
\tableofcontents

% --------------------------------------------------------------------------- %

\clearpage
\section{Using this package}
\label{usage}

\DescribeMacro{\usepackage}
Insert
\begin{quote}
  |\usepackage|\oarg{options}|{caption}[|\texttt{\filedate}|]|
\end{quote}
into the preamble of your document, i.e.~the part of your document
between |\documentclass| and |\begin{document}|.
The options control how your captions will look like; e.g.,
\begin{quote}
  |\usepackage[margin=10pt,font=small,labelfont=bf,|\\
  |            labelsep=endash]{caption}|%
  %|[|\texttt{\filedate}|]|
\end{quote}
would result in captions looking like the second one in the introduction.

\DescribeMacro{\captionsetup}
For a later change of options \thispackage\ provides the command
\begin{quote}
  |\captionsetup|\oarg{float type}\marg{options}
\end{quote}
So
\begin{quote}
  |\usepackage[margin=10pt,font=small,labelfont=bf]{caption}|
\end{quote}
and
\begin{quote}
  |\usepackage{caption}|\\
  |\captionsetup{margin=10pt,font=small,labelfont=bf}|
\end{quote}
are equal in their results.

It's good to know that |\captionsetup| has an effect on the current
environment only. So if you want to change settings for the
current |figure| or |table| only, just place the |\captionsetup| command
inside the |figure| or |table| right before the |\caption| command.
For example
\begin{quote}
  |\begin{figure}|\\
  |  |\ldots\\
  |  \captionsetup{singlelinecheck=off}|\\
  |  \caption{|\ldots|}|\\
  |\end{figure}|
\end{quote}
switches the single-line-check off, but only for this |figure| so all
the other captions remain untouched.

(For a description of the optional parameter \meta{float type} see
 \Ref{commands}.)

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Options}
\label{options}

\def\OptionLabel{RaggedRight}
\def\UserDefined{\ldots}

% --------------------------------------------------------------------------- %

\subsection{Formatting}
\label{formats}

\DescribeMacro{format=}
A figure or table caption mainly consists of three parts: the caption label,
which says if this object is a `Figure' or `Table' and what number is
associated with it, the caption text itself, which is normally a short
description of contents, and the caption separator which separates the text
from the label.

The \textit{caption format} determines how this information will be presented;
it is specified with the option
\begin{quote}
  |format=|\meta{format name}\quad ,
\end{quote}
having the name of the caption format as its argument.

There are two standard caption formats:
%\footnote{You have the option to
%define your own ones, too. See section \ref{declare}:
%\textit{``Do it yourself!''} for details.}

\begin{Options}{\OptionLabel}
  \item[plain]%\NEWdescription{v3.0h}
  Typesets the captions as a normal paragraph.

  \item[hang]
  Indents the caption text, so it will `hang' under the first line of the text.

  \item[\UserDefined]
  Own formats can be defined using |\DeclareCaptionFormat|.\\
  \SeeUserDefined
\end{Options}

\begin{Example}
  An example: Specifying the option
  \begin{quote}
    |format=hang|
  \end{quote}
  yields captions like this:
  \example{format=hang}{\exampletext}
\end{Example}

\DescribeMacro{indention=}
For both formats (\texttt{plain} and \texttt{hang}) you can setup an extra
indention starting at the second line of the caption. You do this with the
option
\begin{quote}
  |indention=|\meta{amount}.
\end{quote}

Two examples:

\begin{Example}
  \begin{quote}
    |format=plain,indention=.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=plain,indention=.5cm}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,indention=-0.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,indention=-0.5cm}{\exampletext}
\end{Example}

\pagebreak[3]
\DescribeMacro{labelformat=}
With the option
\nopagebreak[3]
\begin{quote}
  |labelformat=|\meta{label format name}
\end{quote}
\nopagebreak[3]
%\NEWdescription{v3.0e}
you specify how the caption label will be typeset.
There are four standard caption label formats:

\begin{Options}{\OptionLabel}
  \item[default]
  The caption label will be typeset as specified by the document class,
  usually this means the name and the number (like \texttt{simple}).
  (This is the default behaviour.)

  \item[empty]
  The caption label will be empty. (This option makes sense when used
  together with other options like \texttt{labelsep=none}.)

  \item[simple]
  The caption label will be typeset as a name and a number.

  \item[parens]
  The number of the caption label will be typeset in parentheses.

  \item[\UserDefined]
  Own label formats can be defined using |\DeclareCaptionLabelFormat|.\\
  \SeeUserDefined
\end{Options}

\begin{Example}
  An example: Using the options
  \begin{quote}
    |labelformat=parens,labelsep=quad|
  \end{quote}
  gives captions like this one:
  \example{labelformat=parens,labelsep=quad}{\exampletext}
\end{Example}

\DescribeMacro{labelsep=}
With the option
\begin{quote}
  |labelsep=|\meta{label separator name}
\end{quote}
you specify what caption separator will be used.
You can choose one of the following:

\begin{Options}{\OptionLabel}
  \item[none]
  There is no caption separator. (This option makes sense when used
  together with other options like \texttt{labelformat=empty}.)

  \item[colon]
  The caption label and text will be separated by a colon and a space.

  \item[period]
  The caption label and text will be separated by a period and a space.

  \item[space]
  The caption label and text will be separated by a single space.

  \item[quad]
  The caption label and text will be separated by a |\quad|.

  \item[newline]
  The caption label and text will be separated by a line break (|\\|).

  \item[endash]%\NEWfeature{v3.0h}
  The caption label and text will be separated by an en-dash,
  surrounded by spaces (| -- |).

  \item[\UserDefined]
  Own separators can be defined using |\DeclareCaptionLabelSeparator|.\\
  \SeeUserDefined
\end{Options}

Three examples:
\begin{Example}
  \begin{quote}
    |labelsep=period|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=period}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=newline,singlelinecheck=false|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=newline,singlelinecheck=false}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=endash|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{labelsep=endash}{\exampletext}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Justification}
\label{justification}

\DescribeMacro{justification=}
As addition to the caption format you could also specify a
\emph{caption justification}; it is specified with the option
\begin{quote}
  |justification=|\meta{justification name}\quad.
\end{quote}

You can choose one of the following:

\begin{Options}{\OptionLabel}
  \item[justified]
  Typesets the caption as a normal paragraph.

  \item[centering]
  Each line of the caption will be centered.

%  \item[Centering]
%  Each line of the caption will be centered, too.
%  But this time the command |\Centering| of the \package{ragged2e} package
%  will be used to achieve this. This difference is that this time the word
%  breaking algorithm of \TeX\ will work inside the caption.

  \item[centerlast]
  The last line of each paragraph of the caption text will be centered.

  \item[centerfirst]
  Only the first line of the caption will be centered.

  \item[raggedright]
  Each line of the caption will be moved to the left margin.

\iffalse
  \item[RaggedRight]
  Each line of the caption will be moved to the left margin using
  the command |\RaggedRight| from the \package{ragged2e} package.
\else
  \item[RaggedRight]
  Each line of the caption will be moved to the left margin, too.
  But this time the command |\RaggedRight| of the \package{ragged2e}
  package will be used to achieve this.\footnote{%
    The need for the \package{ragged2e} package will be detected at
    run-time, therefore you maybe need a second \LaTeX\ run if this
    option is used.}
  The main difference is that the word breaking algorithm of \TeX\ will
  work inside captions.
\fi

  \item[raggedleft]
  Each line of the caption will be moved to the right margin.

%  \item[RaggedLeft]
%  Each line of the caption will be moved to the right margin using
%  the command |\RaggedLeft| from the \package{ragged2e} package.

  \item[\UserDefined]
  Own justifications can be defined using |\DeclareCaptionJustification|.\\
  \SeeUserDefined
\end{Options}

Three examples:
\begin{Example}
  \begin{quote}
    |justification=centerlast|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{justification=centerlast}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,justification=raggedright|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,justification=raggedright}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |labelsep=newline,justification=centering|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example*{labelsep=newline,justification=centering}{\exampletext}
\end{Example}

\DescribeMacro{singlelinecheck=}
The standard \LaTeX\ document classes (|article|, |report|, and |book|)
automatically center a caption if it fits in one single line:

\example*{}{A short caption.}

\INFO
\Thispackage\ adapts this behaviour and therefore usually
ignores the justification \& indention you have set with |justification=| \&
|indention=| in such case.
But you can switch this special treatment of such short captions off
with the option
\begin{quote}
  |singlelinecheck=|\meta{bool}\quad.
\end{quote}
Using |false|, |no|, |off| or |0| for \meta{bool} switches the
extra centering off:
\begin{quote}
  |singlelinecheck=false|
\end{quote}
Doing so the above short caption would look like

\begingroup
  \captionsetup{type=figure}
  \ContinuedFloat
  \example*{singlelinecheck=false}{A short caption.}
\endgroup

You switch the extra centering on again by using |true|, |yes|, |on| or |1|
for \meta{bool}. (The default is on.)

% --------------------------------------------------------------------------- %

\subsection{Fonts}
\label{fonts}

\DescribeMacro{font=}
\DescribeMacro{labelfont=}
\DescribeMacro{textfont=}
There are three font options which affects different parts of the caption:
One affecting the whole caption (|font|), one which only affects the caption
label and separator (|labelfont|) and at least one which only affects the
caption text (|textfont|).
You set them up using the options
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |font=|      & \marg{font options} & ,\\
  |labelfont=| & \marg{font options} & , and\\
  |textfont=|  & \marg{font options} & .\\
\end{tabular}\end{quote}

And these are the available font options:

\begin{Options}{\OptionLabel}
  \item[scriptsize]   {\scriptsize Very small size}
  \item[footnotesize] {\footnotesize The size usually used for footnotes}
  \item[small]        {\small Small size}
  \item[normalsize]   {\normalsize Normal size}
  \item[large]        {\large Large size}
  \item[Large]        {\Large Even larger size}

  \item[up]           {\upshape Upright shape}
  \item[it]           {\itshape Italic shape}
  \item[sl]           {\slshape Slanted shape}
  \item[sc]           {\scshape Small Caps shape}

  \item[md]           {\mdseries Medium series}
  \item[bf]           {\bfseries Bold series}

  \item[rm]           {\rmfamily Roman family}
  \item[sf]           {\sffamily Sans Serif family}
  \item[tt]           {\ttfamily Typewriter family}

  \item[singlespacing]  |\singlespacing| (see \package{setspace} package)
  \item[onehalfspacing] |\onehalfspacing|
  \item[doublespacing]  |\doublespacing|

  \item[\UserDefined]
  Own font options can be defined using |\DeclareCaptionFont|.\\
  \SeeUserDefined
\end{Options}

If you use only one of these options you can omit the braces;
e.g., the options
%\begin{quote}
  |font={small}|
%\end{quote}
and
%\begin{quote}
  |font=small|
%\end{quote}
will give the same result.

Two examples:
\begin{Example}
  \begin{quote}
    |font={small,it},labelfont=bf|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{font={small,it},labelfont=bf}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |font=small,labelfont=bf,textfont=it|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{font=small,labelfont=bf,textfont=it}{\exampletext}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Margins and further paragraph options}
\label{margins}

\DescribeMacro{margin=}
\DescribeMacro{width=}
For all captions you can specify \emph{either} an extra margin \emph{or}
a fixed width. You do this by using the options
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |margin=| & \meta{amount}   & \emph{or}\\
  |width=|  & \meta{amount} & \\
\end{tabular}\end{quote}
Nevertheless what option you use, the left and right margin will be the
same.

Two examples will illustrating this:
\begin{Example}
  \begin{quote}
    |margin=10pt|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{margin=10pt}{\exampletext}
\end{Example}

\begin{Example}
  \begin{quote}
    |width=.75\textwidth|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{width=.75\textwidth}{\exampletext}
\end{Example}

\DescribeMacro{parskip=}
This option is useful for captions containing more than one paragraph.
It specifies the extra vertical space inserted between them:
\begin{quote}
  |parskip=|\meta{amount}
\end{quote}
One example:
\begin{Example}
  \begin{quote}
    |margin=10pt,parskip=5pt|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{margin=10pt,parskip=5pt}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

\DescribeMacro{hangindent=}
The option
\begin{quote}
  |hangindent=|\meta{amount}
\end{quote}
is for setting up a hanging indention starting from the second line of each
paragraph. If the caption contains just a single paragraph, using this option
leads to the same result as the option |indention=| you already know about.
But if the caption contains multiple paragraphs you will notice the difference:

\begin{Example}
  \begin{quote}
    |format=hang,indention=-.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,indention=-.5cm}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

\begin{Example}
  \begin{quote}
    |format=hang,hangindent=-.5cm|
  \end{quote}
  \captionsetup{aboveskip=0pt}
  \example{format=hang,hangindent=-.5cm}{%
    First paragraph of the caption. This one contains some test, just to
    show how these options affect the layout of the caption.\par
    Second paragraph of the caption. This one contains some text, too, to
    show how these options affect the layout of the caption.}
\end{Example}

% --------------------------------------------------------------------------- %

\subsection{Styles}
\label{style}

\DescribeMacro{style=}
A suitable combination of caption options is called \emph{caption style}.
You can compare them more or less to page styles which you set up with
|\pagestyle|: The caption style provides all settings for a whole caption layout.

You switch to an already defined caption style with the option
\begin{quote}
  |style=|\meta{style name}\quad.
\end{quote}
\Thispackage\ pre-defines two styles: |base| and |default|.

\NEWfeature{v3.1}
The |base| style puts all options you already know about to values reflecting
the look of the captions when using one of the base \LaTeX\ document classes
|article|, |report|, and |book|.
This means that specifying the option
\begin{quote}
  |style=base|
\end{quote}
has the same effect as specifying all these options:
\begin{quote}
  |format=plain,labelformat=default,labelsep=colon,|\\
  |justification=justified,font=,labelfont=,|\\
  |textfont=,margin=0pt,indention=0pt,parindent=0pt|\\
  |hangindent=0pt,singlelinecheck=true|
\end{quote}
{\small(But |justification=centering,indention=0pt| will be set if
 the caption fits into a single line.)}

In contrast the |default| style follows the default values, reflecting
the look of the captions given by the document class you actually use.
This style is selected by default and represents these options:
\begin{quote}
  |format=default,labelformat=default,labelsep=default,|\\
  |justification=default,font=default,labelfont=default,|\\
  |textfont=default,margin=0pt,indention=0pt,parindent=0pt|\\
  |hangindent=0pt,singlelinecheck=true|
\end{quote}
{\small(But again |justification=centering,indention=0pt| will be set if
 the caption fits into a single line.)}

So if you use one of the base \LaTeX\ document classes,
both |base| and |default| point to the nearly same settings.

{\small\emph{Note:} Own caption styles can be defined using
 |\DeclareCaptionStyle|. \SeeUserDefined}

% --------------------------------------------------------------------------- %

\subsection{Skips}
\label{skips}

\DescribeMacro{aboveskip=}
\DescribeMacro{belowskip=}
The vertical spaces above and below the caption are controlled by the skips
|\abovecaptionskip| and |\belowcaptionskip|. The standard \LaTeX\ document
classes |article|, |report| and |book| set |\abovecaptionskip| to |10pt|
and |\belowcaptionskip| to |0pt|, other document classes may use other values.

\pagebreak[3]
Both skips can be changed with the command |\setlength|, but you can
use these options, too:
\nopagebreak[3]
\begin{quote}\begin{tabular}{@{}r@{}ll}
  |aboveskip=| & \meta{amount} & and\\
  |belowskip=| & \meta{amount} & .\\
\end{tabular}\end{quote}

\DescribeMacro{position=}
Using |\abovecaptionskip| and |\belowcaptionskip| has a major design flaw:
If the caption is typeset \emph{above} (and not \emph{below}) the figure
or table they are not set up very useful at default, because there will be
some extra space above the caption but no space between the caption and the
figure or table itself. (Remember: |\belowcaptionskip| is usually set to |0pt|.)

Please compare the spacing in these small tables:
\begin{Example}
  \captionsetup{position=b}
  \begin{minipage}[c]{.5\linewidth}
%   \captionsetup{aboveskip=0pt}%
    \captionof{table}{A table}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
  \end{minipage}
  \begin{minipage}[c]{.5\linewidth}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
    \captionof{table}{A table}
  \end{minipage}
\end{Example}

But you can fix this by using the option |position=|: It specifies how the
spacing above and below the caption will be used:
\begin{quote}
  |position=top|\quad(or |position=above|)
\end{quote}
tells \thispackage\ to use the spacing useful for caption
\emph{above} the figure or table and
\begin{quote}
  |position=bottom|\quad(or |position=below|)
\end{quote}
tells \thispackage\ to use the spacing useful for captions
\emph{below} the figure or table. (The last one is the default setting
except for |longtable|s.)

So adding an extra |\captionsetup{position=top}| to the left example
table gives you proper spacing around both captions:
\begin{Example}
  \begin{minipage}[c]{.5\linewidth}
    \captionsetup{position=t}
    \captionof{table}{A table}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
  \end{minipage}
  \begin{minipage}[c]{.5\linewidth}
    \centering\begin{tabular}{ll}
      A & B \\
      C & D \\
    \end{tabular}
    \captionsetup{position=b}
    \captionof{table}{A table}
  \end{minipage}
\end{Example}

(Technically speaking |\abovecaptionskip| and |\belowcaptionskip| will
be swapped if you specify the option |position=top|, so in both cases
|\abovecaptionskip| will be used between the caption and the figure or
table itself.)

This option is especially useful when used together with the optional
argument of the |\captionsetup| command.
\See{\Ref{commands} for details}\par
For example
\begin{quote}
  |\captionsetup[table]{position=top}|
\end{quote}
causes all captions within tables to be treated as captions \emph{above}
the table (regarding spacing around it).
\DescribeMacro{tableposition=}%\NEWfeature{v3.0a}
Because this is a very common setting \thispackage\ offers
an abbreviating option for the use with |\usepackage|:
\begin{quote}
  |\usepackage[|\ldots|,tableposition=top]{caption}|
\end{quote}
is equivalent to
\begin{quote}
  |\usepackage[|\ldots|]{caption}|\\
  |\captionsetup[table]{position=top}|
\end{quote}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Commands}
\label{commands}

\DescribeMacro{\caption}
The command
\nopagebreak[3]
\begin{quote}
  |\caption|\oarg{lst\_entry}\marg{heading}
\end{quote}
\nopagebreak[3]
typesets the caption inside a floating environment like |figure| or |table|.
Well, you already know this, but \thispackage\ offers an extension:
If you leave the argument \meta{lst\_entry} empty, no entry in the list of
figures or tables will be made. For example:
\begin{quote}
  |\caption[]{A figure without entry in the list of figures.}|
\end{quote}

\DescribeMacro{\caption*}
The \package{longtable} package defines the command |\caption*| which
typesets the caption without label and without entry in the list of tables.
An example:
\begin{quote}
  |\begin{longtable}{cc}|\\
  |  \caption*{A table}\\|\\
  |  A & B \\|\\
  |  C & D \\|\\
  |\end{longtable}|
\end{quote}
looks like
\begin{longtable}{cc}
  \caption*{A table}\\
  A & B \\
  C & D \\
\end{longtable}

This package offers this feature, too, so you can use this command now within
every floating environment like |figure| or |table|, like:
\begin{quote}
  |\begin{table}|\\
  |  \caption*{A table}|\\
  |  \begin{tabular}{cc}|\\
  |    A & B \\|\\
  |    C & D \\|\\
  |  \end{tabular}|\\
  |\end{table}|
\end{quote}

\DescribeMacro{\captionof}
\DescribeMacro{\captionof*}
Sometimes you want to typeset a caption \emph{outside} a floating environment,
putting a figure within a |minipage| for instance. For this purpose
\thispackage\ offers the command
\begin{quote}
  |\captionof|\marg{float type}\oarg{lst\_entry}\marg{heading}\quad.
\end{quote}
Note that the first argument, the \meta{float type}, is mandatory here, because
the |\captionof| command needs to know which name to put into the caption label
(e.g. ``Figure'' or ``Table'') and in which list to put the contents entry.
An example:
\begin{quote}
  |\captionof{figure}{A figure}|\\
  |\captionof{table}{A table}|
\end{quote}
typesets captions like this:
\begin{Example}
  \captionof{figure}{A figure}
  \captionsetup{belowskip=\abovecaptionskip}
  \captionof{table}{A table}
\end{Example}

The star variant |\captionof*| has the same behaviour as the |\caption*| command:
it typesets the caption without label and without entry to the list of figures
or tables.

\DANGER % \NEWdescription{v3.1}
Please note that you should use both |\captionof| and |\captionof*| only
\emph{inside} boxes or environments (like |\parbox| or |minipage|),
otherwise an error message will be issued.\footnote{%
This only happens if you use \eTeX\ as underlying \TeX\ engine.
Otherwise no error message will be issued, but a page break can appear
between content and caption.
Furthermore some strange effects could occur,
e.g., mixed-up figure and table settings regarding captions.}

\DescribeMacro{\captionsetup}
We already know the |\captionsetup| command (see \Ref{usage}),
but this time we get enlighten about its optional argument
\meta{float type}.

Remember, the syntax of this command is
\begin{quote}
  |\captionsetup|\oarg{float type}\marg{options}\quad.
\end{quote}

If a \meta{float type} gets specified, all the \meta{options} don't
change anything at this time. Instead they only get marked for a later use,
when a caption inside of a floating environment of the particular type
\meta{float type} gets typeset.
For example
\begin{quote}
  |\captionsetup[figure]|\marg{options}
\end{quote}
forces captions within a |figure| environment to use the given \meta{options}.

Here comes an example to illustrate this:
\begin{quote}
  |\captionsetup{font=small}|\\
  |\captionsetup[figure]{labelfont=bf}|
\end{quote}
gives captions like this:
\begin{Example}
  \captionsetup{font=small}
  \captionsetup[figure]{labelfont=bf}
  \begingroup
    \captionof{figure}{A figure}
  \endgroup
  \captionsetup{belowskip=\abovecaptionskip}
  \begingroup
    \captionof{table}{A table}
  \endgroup
\end{Example}

As you see the command |\captionsetup[figure]{labelfont=bf}| only changed
the font of the figure caption labels, not touching all other ones.

\DescribeMacro{\clearcaptionsetup}
If you want to get rid of these parameters marked for an automatic use within
a particular environment you can use the command
\begin{quote}
  |\clearcaptionsetup|\marg{float type}\quad.
\end{quote}

For example |\clearcaptionsetup{figure}| would clear the extra handling in the
example above:
\begin{Example}
  \captionsetup{font=small}
  \begingroup
    \captionof{figure}{A figure}
  \endgroup
  \captionsetup{belowskip=\abovecaptionskip}
  \begingroup
    \captionof{table}{A table}
  \endgroup
\end{Example}

As \meta{float type} you can usually give one of these two only:
|figure| or |table|.
But as we will see later some \LaTeX\ packages (like the
\package{float}, \package{longtable}, and \package{sidecap} package
for example) offer additional floating environments and these two
commands can also be used with them.

\subsection{Continued floats}
\label{ContinuedFloat}

\DescribeMacro{\ContinuedFloat}
Sometimes you want to split figures or tables without giving them
their own reference number. This is what the command
\begin{quote}
  |\ContinuedFloat|
\end{quote}
is for; it should be used as first command inside the floating environment.
It prevents the increment of the relevant counter (usually done by |\caption|)
so a figure or table with a |\ContinuedFloat| in it gets the same reference
number as the figure or table before.

An example:
\begin{quote}
  |\begin{table}|\\
  |\caption{A table}|\\
  \ldots\\
  |\end{table}|\\
  \ldots\\
  |\begin{table}\ContinuedFloat|\\
  |\caption{A table (cont.)}|\\
  \ldots\\
  |\end{table}|
\end{quote}
gives the following result:
\begin{Example}
  \captionsetup{type=table}
  \caption{A table}
  \centerline{\ldots}
  \ContinuedFloat
  \captionsetup{aboveskip=0pt}
  \caption{A table (cont.)}
\end{Example}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Own enhancements}
\label{declare}

A family of commands is provided to allow users to define their own formats.
This enables information on separators, justification, fonts, and styles to
be associated with a name and kept in one place
(these commands need to appear in the document preamble,
this is the part between |\documentclass| and |\begin{document}|).

\pagebreak[2]
\DescribeMacro{\DeclareCaptionFormat}
You can define your own caption formats using the command
\begin{quote}
  |\DeclareCaptionFormat|\marg{name}\marg{code using \#1, \#2 and \#3}\quad.
\end{quote}
At usage the system replaces \#1 with the caption label, \#2 with the
separator and \#3 with the text. So the standard format |plain| is
pre-defined by \thispackage\ as
\begin{quote}
  |\DeclareCaptionFormat{plain}{#1#2#3\par}|
\end{quote}

\DescribeMacro{\DeclareCaptionLabelFormat}
Likewise you can define your own caption label formats:
\begin{quote}
  |\DeclareCaptionLabelFormat|\marg{name}\marg{code using \#1 and \#2}
\end{quote}
At usage \#1 gets replaced with the name (e.g. ``figure'') and \#2
gets replaced with the reference number (e.g. ``12'').

\DescribeMacro{\bothIfFirst}
\DescribeMacro{\bothIfSecond}
If you define your own caption label formats and use the \package{subfig}
package\cite{subfig}, you should take care of empty caption label names.
For this purpose the commands
\begin{quote}
  |\bothIfFirst|\marg{first arg}\marg{second arg}\quad and\\
  |\bothIfSecond|\marg{first arg}\marg{second arg}
\end{quote}
are offered. |\bothIfFirst| tests if the first argument exists (means: is
not empty), |\bothIfSecond| tests if the second argument exists. If yes,
both arguments get typeset, otherwise none of them.

For example the standard label format |simple| is \emph{not} defined as
\begin{quote}
  |\DeclareCaptionLabelFormat{simple}{#1~#2}|\quad,
\end{quote}
because this could cause an extra space if \#1 is empty. Instead |simple|
is defined as
\begin{quote}
  |\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{~}#2}|\quad,
\end{quote}
causing the space to appear only if the label name is present.

\pagebreak[3]
\DescribeMacro{\DeclareCaptionLabelSeparator}
You can define your own caption label separators with
\nopagebreak[3]
\begin{quote}
  |\DeclareCaptionLabelSeparator|\marg{name}\marg{code}\quad.
\end{quote}
\nopagebreak[3]
Again an easy example taken from \thispackage\ itself:
\nopagebreak[3]
\begin{quote}
  |\DeclareCaptionLabelSeparator{colon}{: }|
\end{quote}
\pagebreak[3]

\DescribeMacro{\DeclareCaptionJustification}
You can define your own caption justifications with
\begin{quote}
  |\DeclareCaptionJustification|\marg{name}\marg{code}\quad.
\end{quote}
The \meta{code} simply gets typeset just before the caption.
E.g.~using the justification |raggedright|, which is defined as
\begin{quote}
  |\DeclareCaptionJustification{raggedright}{\raggedright}|\quad,
\end{quote}
lets captions with all lines moved to the left margin.

\DescribeMacro{\DeclareCaptionFont}
You can define your own caption fonts with
\begin{quote}
  |\DeclareCaptionFont|\marg{name}\marg{code}\quad.
\end{quote}
For example this package defines the options |small| and |bf| as
\begin{quote}
  |\DeclareCaptionFont{small}{\small}|\quad and\\
  |\DeclareCaptionFont{bf}{\bfseries}|\quad.
\end{quote}
\iffalse
The line spacing could be customized using the \package{setspace} package,
for example:%\NEWdescription{v3.0h}
\begin{quote}
  |\usepackage{setspace}|\\
  |\DeclareCaptionFont{singlespacing}{\setstretch{1}}|\quad\footnote{%
  \emph{Note:} Using \cs{singlespacing} does not work here since it contains
  a \cs{vskip} command.}\\
  |\DeclareCaptionFont{onehalfspacing}{\onehalfspacing}|\\
  |\DeclareCaptionFont{doublespacing}{\doublespacing}|\\
  |\captionsetup{font={onehalfspacing,small},labelfont=bf}|
\end{quote}
\example{font={onehalfspacing,small},labelfont=bf,singlelinecheck=off}{\exampletext}
\fi
An example which brings color into life:
\begin{quote}
  |\usepackage{color}|\\
  |\DeclareCaptionFont{red}{\color{red}}|\\
  |\DeclareCaptionFont{green}{\color{green}}|\\
  |\DeclareCaptionFont{blue}{\color{blue}}|\\
  |\captionsetup{labelfont={blue,bf},textfont=green}|
\end{quote}
\example*{labelfont={color=blue,bf},textfont={color=green},singlelinecheck=off}{\exampletext}
But since \thispackage\ already includes the tricky definition
\begin{quote}
  |\DeclareCaptionFont{color}{\color{#1}}|
\end{quote}
you can get the same result simply with
\begin{quote}
  |\usepackage{color}|\\
  |\captionsetup{labelfont={color=blue,bf},|\\
  |               textfont={color=green}}|\quad.
\end{quote}

\DescribeMacro{\DeclareCaptionStyle}
You can define your own caption styles with
\begin{quote}
  |\DeclareCaptionStyle|\marg{name}\oarg{additional options}\marg{options}
\end{quote}
Remember, caption styles are just a collection of suitable options, saved
under a given name. You can wake up these options at any time with the
option |style=|\meta{style name}.

All caption styles are based on the |base| set of options. (See \Ref{style}
for a complete list.) So you only need to specify options which are different
to them.

If you specify \meta{additional options} they get used in addition when
the caption fits into a single line and this check was not disabled with
the option |singlelinecheck=off|.

Again a very easy example taken from the core of this package: The
caption style |base| is pre-defined as
\begin{quote}
  |\DeclareCaptionStyle{base}%|\\
  |  [justification=centering,indention=0pt]{}|\quad.
\end{quote}

% --------------------------------------------------------------------------- %

\subsection{Further Examples}

%\NEWdescription{v3.1}
If you would like to have a line break between caption label and text
you could define it this way:
\begin{quote}
  |\DeclareCaptionFormat{myformat}{#1#2\\#3}|
\end{quote}
If you select this format with |\captionsetup{format=myformat}|
you get captions like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat1,labelfont=bf}{\exampletext}
%\end{Example}
You could even use an indention with this caption format:
\begin{quote}
  |\captionsetup{format=myformat,indention=1cm}|
\end{quote}
This would look like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat1,indention=1cm,labelfont=bf}{\exampletext}
%\end{Example}
Instead, you would like to have an indention only of the first line of
the caption text? No problem, e.g.
\begin{quote}
  |\newlength\myindention|\\
  |\DeclareCaptionFormat{myformat}%|\\
  |       {#1#2\\\hspace*{\myindention}#3}|\\
  \ldots\\
  |\setlength\myindention{1cm}|\\
  |\captionsetup{format=myformat}|
\end{quote}
would give you captions like
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=myformat2,myindention=1cm,labelfont=bf}{\exampletext}
%\end{Example}
But you want to have an caption option for this indention, so you can use
it for example with |\captionsetup|\xx|[figure]|\xx|{myindention=|\ldots|}|?
This could be done, too:
\begin{quote}
  |\newlength\myindention|\\
  |\DeclareCaptionOption{myindention}%|\\
  |       {\setlength\myindention{#1}}|\\
  |\DeclareCaptionFormat{myformat}%|\\
  |       {#1#2\\\hspace\myindention #3}|\\
  \ldots\\
  |\captionsetup{format=myformat,myindention=1cm}|
\end{quote}
would give the same result as the example above.

\bigskip\pagebreak[3]

A different example: You want captions to look like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=reverse,labelformat=fullparens,labelsep=fill,labelfont=it}{\exampletext}
%\end{Example}
\pagebreak[2]
You could do it this way:
\nopagebreak[3]
{\leftmargini=10pt
 \begin{quote}
   |\DeclareCaptionFormat{reverse}{#3#2#1}|\\
   |\DeclareCaptionLabelFormat{fullparens}%|\\
   |       {(\bothIfFirst{#1}{~}#2)}|\\
   |\DeclareCaptionLabelSeparator{fill}{\hfill}|\\
   |\captionsetup{format=reverse,labelformat=fullparens,|\\
   |              labelsep=fill,font=small,labelfont=it}|
 \end{quote}}

\bigskip\pagebreak[3]

Another example: The caption text should go into the left margin; a possible
solution would be:
{\leftmargini=10pt
 \begin{quote}
   |\DeclareCaptionFormat{llap}{\llap{#1#2}#3\par}|\\
   |\captionsetup{format=llap,labelsep=quad,singlelinecheck=no}|
 \end{quote}}
As a result you would get captions like this:
%\begin{Example}
%  \captionsetup{aboveskip=0pt}
  \example{format=llap,labelsep=quad,singlelinecheck=no,margin=0pt}{\exampletext}
%\end{Example}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Document classes \& Babel support}
\label{classes}

%\NEWdescription{v3.1}
{\small\emph{Please note:} Many document classes already have build-in options and
commands for customizing captions. If these possibilities are sufficient for
you, there is usually no need for you to use the \package{caption} package
at all. And if you are just interested in using the command \cs{captionof},
loading of the very small \package{capt-of} is usually sufficient.}

This section will give you an overview of the document classes the
\package{caption} supports, what do they already offer regarding captions,
what side effects will occur when using the \package{caption} package with
them, and what are the `default' settings for them.

\NEWfeature{v3.1}
The `default' settings depend on the document class you use; they represent
how the class author wanted the captions to look like. So for example
setting |format=default| can give you different visual designs when used
with different document classes.

\DANGER
If you don't find the document class you use in this section, you usually
don't have to worry: Many document classes are derived from one of the
standard document classes |article|, |report|, or |book|, and behave the
same regarding captions.
\Thispackage\ automatically does a compatibility check against the document
class used and will give you a clear warning if a incompatibility was detected.
If you don't get such warning everything is fine, but if you get it the usage of
\thispackage\ is not recommended and especially not supported.

{\small(If you get such a compatibility warning but decide to use \thispackage{}
 anyway, you should watch carefully what side-effects occur, usually the
 look and feel of your captions will change by just including \thispackage{}
 without options, meaning they do not look like as intended by the author
 of the document class.
 If this is fine for you, you should first specify the option |style=base|
 via |\usepackage[style=base]{caption}| or |\captionsetup{style=base}|
 to set \thispackage\ into a well-defined state.
 Afterwards you can start setting your own options additionally and
 keep your fingers crossed.)}

\newcommand*\Option{Option}
\newcommand*\defaultvalue{\texttt{default} value}
\newcommand*\use{\textit{use}}
\newcommand*\settings{\textit{settings}}
\newcommand*\nofont{\textit{none}}

\subsection{Standard \LaTeX: article, report, and book}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & |simple| \\
|labelsep=|      & |colon| \\
|justification=| & |justified| \\
|font=|          & \nofont \\
|labelfont=|     & \nofont \\
|textfont=|      & \nofont \\
\end{tabular}

\noindent{\small(\emph{Note:} This also applies to document classes derived from them.)}

\subsection{\AmS: amsart, amsproc, and amsbook}
\label{AMS}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & |simple| \\
|labelsep=|      & a period $+$ |\enspace| \\
|justification=| & |justified| \\
|font=|          & |\@captionfont| \\
|labelfont=|     & |\@captionheadfont| \\
|textfont=|      & |\@captionfont\upshape| \\
\end{tabular}

{\small(|\@captionfont| will be set to |\normalfont|, and |\@captionheadfont| to |\scshape|
 by the \AmS\ document classes.)}

Furthermore the margin will be set to |\captionindent| for more-than-one-line captions
(which will be set to |3pc| by the \AmS\ classes),
the margin for single-line captions will be set to the half of it instead.
If you want to use a common margin for both, insert |\clearcaptionsetup[margin*]{singleline}|
into the preamble of your document, after loading \thispackage.

Additionally the options |figureposition=b,tableposition=t| will be set.
You can override these settings by specifing other values for
|figureposition=| or |tableposition=| in the option list while loading \thispackage.

\subsection{beamer}
\label{beamer}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & \textit{not numbered} \\
|labelsep=|      & |colon| \\
|justification=| & |raggedright| \\
|font=|          & \use\ \package{beamer} |caption| \settings \\
|labelfont=|     & \use\ \package{beamer} |caption name| \settings \\
|textfont=|      & \nofont \\
\end{tabular}

\textbf{Build-in features and side-effects:}\\
You can setup font and color settings with
|\setbeamerfont|\xx|{caption}|\xx\marg{options} and
|\setbeamerfont|\xx|{caption name}|\xx\marg{options}.
This will still work, unless you set a different font with
|\captionsetup|\xx|{font=|\xx\meta{options}|}| or
|\captionsetup|\xx|{labelfont=|\xx\meta{options}|}|.\par
Furthermore the \package{beamer} classes offer different caption templates
which can be choosen with
|\set|\x|beamter|\x|template|\xx|{caption}|\xx|[|\meta{template}|]|.
Since \thispackage\ replaces this caption template mechanism,
|\def|\x|beamer|\x|template*|\xx|{caption}|\xx\marg{template code}
and
|\set|\x|beamer|\x|template|\xx|{caption}|\xx|[|\meta{template}|]|
will have no function when \thispackage\ is used.

\subsection{\KOMAScript: scrartcl, scrreprt, and scrbook}
\label{KOMA}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & \use\ |\setcapindent| \textit{\&} |\setcaphanging| \settings \\
|labelformat=|   & |simple| \\
|labelsep=|      & \use\ |\captionformat| \\
|justification=| & |justified| \\
|font=|          & \use\ |\setkomafont{caption}| \settings \\
|labelfont=|     & \use\ |\setkomafont{captionlabel}| \settings \\
|textfont=|      & \nofont \\
\end{tabular}

\textbf{Build-in features:}\\
The \KOMAScript\ document classes offer many ways to customize the look and
feel of the captions. For an overview and a full description please take a
look at the \KOMAScript\ documentation, section `Tables and Figures'.

\textbf{Side effects:}\\
The optional argument of |\setcapwidth| is not supported (yet) and will be
ignored if used in conjunction with the \package{caption} package.
Furthermore the \KOMAScript\ options |tablecaptionabove| \&
|tablecaptionbelow| and the commands |\captionabove| \& |\captionbelow|
are stronger than the |position=| setting offered by the \package{caption}
package.

\subsection{\NTG: artikel, rapport, and boek}
\label{NTG}

\begin{tabular}{ll}
\Option          & \defaultvalue \\\hline
|format=|        & |plain| \\
|labelformat=|   & |simple| \\
|labelsep=|      & |colon| \\
|justification=| & |justified| \\
|font=|          & \nofont \\
|labelfont=|     & \use\ |\CaptionLabelFont| \\
|textfont=|      & \use\ |\CaptionTextFont| \\
\end{tabular}

\textbf{Build-in features and side-effects:}\\
|\CaptionLabelFont| and |\CaptionTextFont| can be set either directly or
by using |\CaptionFonts|. Both is still supported unless you use
one of the two options |labelfont=| or |textfont=| offered by \thispackage.

\subsection{\SmF{} classes: smfart and smfbook}
\label{SMF}

Since the \SmF\ document classes are derived from the \AmS\ document classes
the same default values are valid here.

Additionally the margin is limited up to the tenth of the |\linewidth|.
If you don't like this limitation, you can switch it off with the option
|maxmargin=off| or |maxmargin=false| (which both means the same).

\pagebreak[4]
\subsection{The frenchb Babel option}
\label{frenchb}

If you use the \package{frenchb} option of the \package{babel} package
with one of the three standard \LaTeX{} classes (or a one derived from them)
the default |labelsep=| will be set to \cs{CaptionSeparator} (offered by
\package{frenchb}), overriding the default value set by the document class.
So redefining \cs{CaptionSeparator} will still work, unless you don't
select a different |labelsep=| than the default one.

\INFO*
Please load \thispackage\ \emph{after} the \package{babel} package.

\subsection{The frenchle and frenchpro packages}
\label{frenchpro}

If you use the \package{frenchle} or \package{frenchpro} package,
the default |labelsep=| will be set to \cs{captionseparator} (offered by
\package{frenchle/pro}) plus \cs{space}, overriding the default value set
by the document class.
So redefining \cs{captionseparator} will still work, unless you don't
select a different |labelsep=| than the default one.

Furthermore the default |textfont=| will be set to |textfont=it|,
since this emulates the default setting of |\captionfont| defined by the
\package{frenchle} or \package{frenchpro} package.
%If you redefine |\captionfont| after loading the \package{frenchle} or
%\package{frenchpro} package, this redefinition gets lost.
Please note that the command \cs{captionfont} is used by the
\package{caption} package internally for a different purpose,
so you should not change it (anymore).

The command \cs{unnumberedcaptions}\marg{figure or table} will still work,
but only unless you don't select a different |labelformat=| than the default
one.

\INFO*
Please load \thispackage\ \emph{after} the \package{frenchle}
or \package{frenchpro} package.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Supported packages}
\label{packages}

%\NEWdescription{v3.1}
\Thispackage\ was adapted to the following packages which deals with
captions, too:
\begin{quote}
  \package{float}, \package{floatflt}, \package{fltpage},
  \package{hyperref}, \package{hypcap}, \package{listings},
  \package{longtable}, \package{picinpar}, \package{picins},
  \package{rotating}, \package{sidecap}, \package{subfigure},
  \package{supertabular}, \package{threeparttable}, and \package{wrapfig}
\end{quote}

Furthermore the \package{floatrow} and the \package{subfig} package
supports \thispackage\ and use its |\captionsetup| interface.

\newcommand\packagedescription[1]{%
  \nopagebreak
  \parbox[b]{\linewidth}{\footnotesize\leftskip=10pt\rightskip=10pt\relax#1}%
  \nopagebreak\smallskip\nopagebreak}
\newcommand\Note{\smallskip\emph{Note:}~}

\pagebreak[3]
\subsection{float}
\label{float}
\packagedescription{%
The \package{float} package\cite{float} introduces the commands
\cs{restylefloat} to give existing floating environments a new look \& feel
and \cs{newfloat} to define new floating environments.
It also provides the \texttt{H} float placement option of the obsolete
\package{here} package.}

For floating environments defined with \cs{newfloat} or \cs{restylefloat} the
|position| option has no effect on the main caption anymore, since its
placement and spacing will be controlled by the selected float style instead.

Furthermore a caption style and options defined with the name of the float
style will be executed additionally to the regular ones.
Using this mechanism \thispackage\ emulates the default look \& feel of the
|ruled| captions: It defines the caption style
\begin{quote}
  |\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=space,|\\
  |                            strut=off}|~.
\end{quote}
So to change this you need either define your own caption style called
|ruled| or use |\captionsetup[ruled]|\marg{options}.%,
%e.g.~|\captionsetup[ruled]{labelsep=colon}|.

Also by using this mechanism the skip between a |boxed| float and its caption
is specified, overriding its global value:
\begin{quote}
  |\captionsetup[boxed]{skip=2pt}|
\end{quote}
For changing this just use |\captionsetup[boxed]{skip=|\meta{value}|}|
with an appropriate value. Or if you want to use the global |skip| setting
instead you can remove the usage of the local setting for these floats with
|\clearcaptionsetup[skip]{boxed}|.

\Note
Only one single caption can be typeset inside environments defined with
\cs{newfloat} or \cs{restylefloat}, futhermore these environments are not
behaving exactly like the pre-defined floats |figure| \& |table|.
As a consequence many packages do not coorperate well with these.
Furthermore the float package has some caveats \& limitations, so if you
just want to define a new simple floating environment---behaving like
|figure| or |table|---I recommend using \cs{DeclareFloatingEnvironment}
instead.
And for defining non-simple floating environments and customization I
recommend using the \package{floatrow} package\cite{floatrow} instead.

\iffalse
Please also note that you \emph{don't} need a |\restylefloat| for using
the |H| float placement specifier. Some docs say so, but they are
wrong.
And |\restylefloat{table}| is a very good method to shoot yourself
in the foot, since many packages using |table| internally are not working
correctly afterwards.
\fi

\pagebreak[4]
\subsection{floatflt}
\label{floatflt}
\packagedescription{%
The \package{floatflt} package\cite{floatflt} offers figures and tables
which do not span the full width of a page and are float around by text.}

\NEWfeature{v3.1}
If you want to setup special options for the |floatingfigure| \& |floatingtable|
environments you can use
\begin{quote}
  |\captionsetup[floatingfigure]|\marg{options}\\
  |\captionsetup[floatingtable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

\Note
The |margin| resp.~|width| setting will not be used for these figures \& tables,
unless you set it explicit with |\captionsetup[floatingfigure]{|\ldots|}| or
|\captionsetup[floatingtable]{|\ldots|}|.

\pagebreak[3]
\subsection{fltpage}
\label{fltpage}
\packagedescription{%
The \package{fltpage} package\cite{fltpage} offers the outhouse of the
caption for |figure|s or |table|s which needs the whole page
for its contents. This will be done by placing the caption on the bottom
of the previous or next page.}

\NEWfeature{v3.1}
Two options control the links to the |FPfigure| and |FPtable|:
\begin{description}
\item{\texttt{FPlist=caption} or \texttt{FPlist=figure}}\\[\smallskipamount]
If set to |caption|, the list entry will link to the caption; if set to
|figure|, it will link to the figure contents.
(The default setting is |FPlist=caption|.)
\item{\texttt{FPref=caption} or \texttt{FPref=figure}}\\[\smallskipamount]
If set to |caption|, a \cs{ref}, \cs{pageref}, \cs{autoref}, or \cs{nameref}
will link to the caption; if set to |figure|, it will link to the figure contents.
(The default setting is |FPref=figure|.)
\end{description}

If you want to setup special options for the |FPfigure| \& |FPtable|
environments you can use
\begin{quote}
  |\captionsetup[FPfigure]|\marg{options}\\
  |\captionsetup[FPtable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define
an environment called |FP|\meta{name} which behaves like |FPfigure| and
|FPtable|.

\pagebreak[4]
\subsection{hyperref}
\label{hyperref}
\packagedescription{%
The hyperref package\cite{hyperref} is used to handle cross-referencing
commands in LaTeX to produce hypertext links in the document.}

\NEWfeature{v3.1}
There are two options available to control the placement of hyperlink anchors:
\begin{description}
\item{\texttt{hypcap=true} or \texttt{hypcap=false}}\\[\smallskipamount]
If set to |true| all hyperlink anchors -- where entries in the
List of Figures, |\ref|, and |\autoref| will link to -- are placed at
the beginning of the (floating) environment.\par
If set to |false| the hyperlink anchor is (usually) placed at the caption.\par
(The default setting is |hypcap=true|.)
\item{\texttt{hypcapspace=}\meta{amount}}\\[\smallskipamount]
Because it looks poor if the hyperlink points exactly at the top of
the figure or table, you can specify a vertical distance between
the hyperlink anchor and the (floating) environment itself,
e.g.~|hypcapspace=0pt| removes this distance.\par
(The default setting is |hypcapspace=0.5\baselineskip|.)
\end{description}

Both settings have no effect in |lstlisting|s (provided by the
\package{listings} package), |longtable|s (provided by the
\package{longtable} package), and |supertabular|s (provided by the
\package{supertabular} package), within these environments hyperlink
anchors will always be placed as if |hypcap=true| \& |hypcapspace=0pt|
would be set.

\pagebreak[3]Please note:\nopagebreak
\begin{description}
\item{\cs{captionof}\marg{type}\csmarg\ldots\ vs.
      \cs{captionsetup}\csmarg{type=\meta{type}}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount]
Without \package{hyperref} loaded, both will give you identical results.
But with \package{hyperref} loaded, and with |hypcap=true| requested, the
hyperlink anchor will be placed different.
For example:
\begin{quote}
|\begin{minipage}{\linewidth}|\\
|  |\ldots\\
|  \captionof{figure}{A figure}|\\
|\end{minipage}|
\end{quote}
will place the hyperlink anchor at the caption.
(And if |hypcap=true| is set, you will get a warning about this.)
But
\begin{quote}
|\begin{minipage}{\linewidth}|\\
|  \captionsetup{type=figure}|\\
|  |\ldots\\
|  \caption{A figure}|\\
|\end{minipage}|
\end{quote}
will place the hyperlink anchor at the beginning of the |minipage|,
since |\caption|\x|setup|\xx|{type=|\xx|figure}| does not only set the caption type
to ``figure'' but does place a hyperlink anchor, too.

\item{\cs{caption}\csoarg{}\csmarg\ldots\ vs.
      \cs{captionsetup}\csmarg{listof=false}$+$\cs{caption}\csmarg\ldots}\\[\smallskipamount]
Again, without \package{hyperref} loaded, both will give you identical results.
But with \package{hyperref} loaded, the difference is in the nuances.
So for example the optional argument of \cs{caption} will also be written to
the |aux| file, and will be used by the \cs{nameref} command.
So if you choose to use \cs{caption} with empty optional argument,
\cs{nameref} will also give you an empty result.
So it's better to use \cs{captionsetup}\csmarg{listof=false} if you don't
want an entry in the List of Figures or List of Tables.
\end{description}

\pagebreak[3]
\subsection{hypcap}
\label{hypcap}
\packagedescription{%
The \package{hypcap} package\cite{hypcap} offers a solution to the problem
that links to a float using hyperref may anchors to the caption rather than
the beginning of the float.
Since \thispackage\ \version{3.1} already solves this problem for itself,
the \package{hypcap} package is usually not needed, at least when you use
\thispackage.}

If the \package{hypcap} package is loaded additionally to the \package{hyperref}
package, it takes over the control of the hyperlink anchor placement from \thispackage,
overriding the options |hypcap=| \& |hypcapspace=|.

So for a manual placement of hyperlink anchors |\captionsetup{type=|\meta{type}|}|
is not sufficient anymore, instead you need to use |\capstart|
(provided by the \package{hypcap} package) for this.

Regarding the automatical placement the \package{hypcap} package offers good
placement of hyperlink anchors for the floating environments |figure| and
|table| only. In contrast the |hypcap=true| option of \thispackage\ also
offers good placements of hyperlink anchors for
|floatingfigure|s (provided by the \package{floatflt} package),
|FPfigure|s \& |FPtable|s (provided by the \package{fltpage} package),
|figwindow|s (provided by the \package{picinpar} package),
|parpic|s (provided by the \package{picins} package),
|SCfigure|s (provided by the \package{sidecap} package),
|threeparttable|s (provided by the \package{threeparttable} package,
and |wrapfigure|s (provided by the \package{wrapfig} package).%---%
%so by loading the \package{hypcap} package additionally you will
%loose that.

\pagebreak[3]
\subsection{listings}
\label{listings}
\packagedescription{%
The \package{listings} package\cite{listings} typesets programming code.}

If you want to setup special options for the |lstlinsting| environment
you can use
\begin{quote}
  |\captionsetup[lstlisting]|\marg{options}\quad.
\end{quote}

\pagebreak[3]
\subsection{longtable}
\label{longtable}
\packagedescription{%
The \package{longtable} package\cite{longtable} offers an environment
which behaves similar to the |tabular| environment, but the table
itself can span multiple pages.}

If you want to setup special options for the |longtable| environment
you can use
\begin{quote}
  |\captionsetup[longtable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|table|.

The |margin| \& |width| settings usually override |\LTcapwidth|, so
you get an equal look \& feel of the captions in |table|s and
|longtable|s. But if you set |\LTcapwidth| to a value different from
its default $=$ |4in|, \thispackage\ will follow that.
(But |\LTcapwidth| will be overwritten by
|\captionsetup[longtable]{width=|\meta{value}|}|, even if it is set
to a value different than |4in|.)

\Note
\cs{captionof} and \cs{ContinuedFloat} do not work for |longtable|s.
\NEWfeature{v3.1}
If you need a |longtable| which does not increment the |table| counter
please use the |longtable*| environment offered by \thispackage.

\pagebreak[3]
\subsection{picinpar}
\label{picinpar}
\packagedescription{%
Similar to the \package{floatflt} package the \package{picinpar}
package\cite{picinpar} offers figures and tables which do not span the full
width of a page and are float around by text.
For a detailed discussion about the differences between these packages
please take a look at The \LaTeX\ Companion\cite{TLC2}.}

\NEWfeature{v3.1}
If you want to setup special options for the |figwindow| \& |tabwindow|
environments you can use
\begin{quote}
  |\captionsetup[figwindow]|\marg{options}\\
  |\captionsetup[tabwindow]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

\Note
The |margin| resp.~|width| setting will not be used for these figures \& tables,
unless you set it explicit with |\caption|\x|setup|\xx|[figwindow]{|\ldots|}| or
|\caption|\x|setup|\xx|[figtable]{|\ldots|}|.

\pagebreak[3]
\subsection{picins}
\label{picins}
\packagedescription{%
Similar to the \package{floatflt} and \package{picinpar} package the
\package{picins} package\cite{picins} offers figures and tables which do not
span the full width of a page and are float around by text.
For a detailed discussion about the differences between these packages
please take a look at The \LaTeX\ Companion\cite{TLC2}.}

\NEWfeature{v3.1}
If you want to setup special options for the |parpic| environment you can use
\begin{quote}
  |\captionsetup[parpic]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

\Note
The |margin| resp.~|width| setting will not be used for these figures \& tables
if \cs{piccaptionside} or \cs{piccaptiontopside} is used.
The |width| setting will not be used (but the |margin| setting will) if
\cs{piccaptionoutside} or \cs{piccaptioninside} is used.
But you can override this by setting it explicit with
|\captionsetup[parpic]{|\ldots|}|.

\Note
If you want to have a |\piccaption| of another type as |figure|, please do
\emph{not} re-define |\@captype| as suggested by the \package{picins}
documentation. Please use the |\piccaptiontype|\marg{type} command which is
offered by \thispackage\ instead, e.g.:
\begin{quote}
  |\piccaptiontype{table}|\\
  |\piccaption{An example table}|\\
  |\parpic(50mm,10mm)[s]{|\ldots|}|
\end{quote}

\pagebreak[3]
\subsection{rotating}
\label{rotating}
\packagedescription{%
The \package{rotating} package\cite{rotating} offers the floating
environments \texttt{sideways\-figure} and \texttt{sideways\-table}
which are just like normal figures and tables but rotated by 90 degree.
Furthermore a command \cs{rotcaption} is offered for rotated captions only.}

\iffalse % No, we don't do that
If you want to setup special options for the |sidewaysfigure| \& |sidewaystable|
environments you can use
\begin{quote}
  |\captionsetup[sidewaysfigure]|\marg{options}\\
  |\captionsetup[sidewaystable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.
\fi

The command \cs{rotcaption} will be extended by \thispackage, so
|\rotcaption*| or |\rotcaptionof| can be used analogous to |\caption| and
|\captionof|.

\NEWfeature{v3.1}
Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define
an environment called |sideways|\meta{name} which behaves like
|sideways|\x|figure| and |sideways|\x|table|.

\pagebreak[3]
\subsection{sidecap}
\label{sidecap}
\packagedescription{%
The \package{sidecap} package\cite{sidecap} offers the floating
environments |SCfigure| and |SCtable| which are like usual figures
and tables but the caption will be put \emph{beside} the contents.}

If you want to setup special options for the |SCfigure| \& |SCtable|
environments you can use
\begin{quote}
  |\captionsetup[SCfigure]|\marg{options}\\
  |\captionsetup[SCtable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

\NEWfeature{v3.1}
Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define
an environment called |SC|\meta{name} which behaves like |SCfigure| and
|SCtable|.

\Note
The \package{sidecap} package offers its own options for justification.
If set, they will override the one specified with the caption option
|justification=| for captions beside their contents.

\Note
The |margin| resp.~|width| setting will not be used for these figures \& tables,
unless you set it explicit with |\captionsetup|\xx|[SCfigure]|\xx|{|\ldots|}|
or |\captionsetup|\xx|[SCtable]|\xx|{|\ldots|}|.

\medskip{\small(Instead of using the \package{sidecap} package you can also use
the \package{floatrow} package\cite{floatrow} for this purpose.)}

\pagebreak[3]
\subsection{subfigure}
\label{subfigure}
\packagedescription{%
The \package{subfigure} package\cite{subfigure} provides support for small or
`sub' figures and tables within a single figure or table environment.
This package is obsolete, new users should use subfig instead.}

Since the \package{subfigure} package is obsolete it will only be supported in
a way that old documents (which have used \thispackage\ \version{1.x} during
development) should still compile as expected.

Please use the \package{subfig} package instead with supports \thispackage\
\version{3.x}.

\See{the \package{subfig} package\cite{subfig} documentation for details.}

\pagebreak[3]
\subsection{supertabular}
\label{supertabular}
\packagedescription{%
The \package{supertabular} package\cite{supertabular} offers an environment
which is quite similar to the |longtable| environment provided
by the \package{longtable} package\cite{longtable}:
Both offers the typesetting of tables which can span multiple pages.
For a detailed discussion about the differences between these two powerful
packages please take a look at The \LaTeX\ Companion\cite{TLC2}.}

If you want to setup special options for the |supertabular| environment
you can use
\begin{quote}
  |\captionsetup[supertabular]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|table|.

\Note
\cs{ContinuedFloat} does not work for |supertabular|s.

\pagebreak[3]
\subsection{threeparttable}
\label{threeparttable}
\packagedescription{%
Provides a scheme for tables that have a structured note section after the
table contents and the caption.
This scheme provides an answer to the old problem of putting footnotes in
tables---by making footnotes entirely unnecessary.}

\NEWfeature{v3.1}
If you want to setup special options for the |threeparttable| \&
|measuredfigure| environments you can use
\begin{quote}
  |\captionsetup[threeparttable]|\marg{options}\\
  |\captionsetup[measuredfigure]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|table| or |figure|.

\Note
Since the caption will have the same width as the contents here,
the |margin| resp.~|width| setting will not be used for these figures \& tables,
at least unless you set it explicit with
|\caption|\x|setup|\xx|[threeparttable]|\xx|{|\ldots|}|
or |\caption|\x|setup|\xx|[measuredfigure]|\xx|{|\ldots|}|.

\medskip{\small(Instead of using the \package{sidecap} package you can also use
the \package{floatrow} package\cite{floatrow} for this purpose.)}

\pagebreak[3]
\subsection{wrapfig}
\label{wrapfig}
\packagedescription{%
Similar to the \package{floatflt}, the \package{picinpar}, and the
\package{picins} package the \package{wrapfig} package\cite{wrapfig} offers
figures and tables which do not span the full width of a page and are float
around by text.
For a detailed discussion about the differences between these packages
please take a look at The \LaTeX\ Companion\cite{TLC2}.}

\NEWfeature{v3.1}
If you want to setup special options for the |wrapfigure| \& |wraptable|
environments you can use
\begin{quote}
  |\captionsetup[wrapfigure]|\marg{options}\\
  |\captionsetup[wraptable]|\marg{options}\quad.
\end{quote}
These options will be executed additionally to the regular ones for
|figure| or |table|.

Furthermore \cs{DefineFloatingEnvironment}\marg{name} will also define
an environment called |wrap|\meta{name} which behaves like |wrapfigure| and
|wraptable|.

\Note
The |margin| resp.~|width| setting will not be used for these figures \& tables,
unless you set it explicit with |\caption|\x|setup|\xx|[wrapfigure]|\xx|{|\ldots|}|
or |\caption|\x|setup|\xx|[wraptable]|\xx|{|\ldots|}|.

\Note
If the \package{wrapfig} package should be used in coorperation with the
\package{float} package, it needs to be loaded \emph{after} the
\package{float} package. Furthermore \cs{newfloat} or \cs{restylefloat}
commands \emph{must} be placed after \emph{both} packages have been loaded.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Compatibility to older versions}
\label{compatibility}

\subsection{caption v\texorpdfstring{$1.x$}{1.x}}
\label{caption1}

This version of \thispackage\ still supports the old options
and commands provided by the version $1.x$ of this package. So there
shouldn't occur any problems compiling old documents, but please don't mix
old options and commands with the new ones. This isn't supported and can
cause ugly side effects.

Here comes a short oversight of the obsolete options and how
they have been replaced within this version of \thispackage:

{\small\begin{longtable}{ll}
\package{caption} \version{1.x} & \package{caption} \version{3.x}\\
\hline
\endhead
|normal|        & |format=plain|\\
|hang|          & |format=hang|\\
|isu|           & |format=hang|\\
|center|        & |justification=centering|\\
|centerlast|    & |justification=centerlast|\\
%|anne|         & |justification=centerlast|\\
|nooneline|     & |singlelinecheck=off|\\
|scriptsize|    & |font=scriptsize|\\
|footnotesize|  & |font=footnotesize|\\
|small|         & |font=small|\\
|normalsize|    & |font=normalsize|\\
|large|         & |font=large|\\
|Large|         & |font=Large|\\
|up|            & |labelfont=up|\\
|it|            & |labelfont=it|\\
|sl|            & |labelfont=sl|\\
|sc|            & |labelfont=sc|\\
|md|            & |labelfont=md|\\
|bf|            & |labelfont=bf|\\
|rm|            & |labelfont=rm|\\
|sf|            & |labelfont=sf|\\
|tt|            & |labelfont=tt|\\
\end{longtable}}

Beside the options for setting up the desired font there were also
the commands |\captionsize| resp.~|\captionfont| and |\captionlabelfont|
who could be redefined with |\renewcommand| and allowed an alternate and
more flexible way to change the font used for captions.
This mechanism was replaced by the commands
\begin{quote}
  |\DeclareCaptionFont{|\ldots|}{|\ldots|}|\qquad and\\
  |\captionsetup{font=|\ldots|,labelfont=|\ldots|}|\qquad.
\end{quote}\SeeUserDefined

Setting the margin for captions was done in \version{1.x} with
\begin{quote}
  |\setlength{\captionmargin}{|\ldots|}|\quad.
\end{quote}
This was replaced by
\begin{quote}
  |\captionsetup{margin=|\ldots|}|\qquad.
\end{quote}
\See{\Ref{margins}}

For example the old-style code
\begin{quote}
|\usepackage[hang,bf]{caption}|\\
|\renewcommand\captionfont{\small\sffamily}|\\
|\setlength\captionmargin{10pt}|
\end{quote}
will still work fine, but should be written today as
\begin{quote}
|\usepackage[format=hang,labelfont=bf,font={small,sf},|\\
|            margin=10pt]{caption}|
\end{quote}
or
\begin{quote}
|\usepackage{caption}|\\
|\captionsetup{format=hang,labelfont=bf,font={small,sf},|\\
|              margin=10pt}|\qquad.
\end{quote}

The quite exotic option |ruled| which allowed a partial usage of
the caption settings for |ruled| floats defined with the
\package{float} package will be emulated by this version of the
caption package, too.
But using this option is not recommended anymore since this
version of \thispackage\ offers a more flexible way
for changing the captions of these floating environments:
\begin{quote}
  |\DeclareCaptionStyle{ruled}{|\ldots|}|
\end{quote}
resp.
\begin{quote}
  |\captionsetup[ruled]{|\ldots|}|\qquad.
\end{quote}
\SeeUserDefined[, \Ref{commands}, and \Ref{float}]

\subsection{caption2 v\texorpdfstring{$2.x$}{2.x}}
\label{caption2}

Although they do very similar stuff, the packages \package{caption} and
its experimental and now obsolete variant \package{caption2} have a
very different implementation design.
Therefore a full compatibility could not be offered.
For that reason you will still find a file called |caption2.sty| in
this package distribution, so old documents using the \package{caption2}
package will still compile fine.

Newly created documents should use the actual version of
\thispackage\ instead. In most cases it's sufficient to replace the command
\begin{quote}
  |\usepackage[...]{caption2}|
\end{quote}
by
\begin{quote}
  |\usepackage[...]{caption}|\qquad.
\end{quote}
But some options and commands will not be emulated, so you can get
error messages afterwards. This section will hopefully help you removing
these errors. If you have problems migrating from \package{caption2}
to \package{caption} please don't hesitate to send me an e-mail asking
for help.

In addition to the obsolete options shown in the last section
these ones will be emulated, too:

{\small\begin{longtable}{ll}
\package{caption2} \version{2.x} & \package{caption} \version{3.x}\\
\hline
\endhead
|flushleft|   & |justification=raggedright|\\
|flushright|  & |justification=raggedleft|\\
|oneline|     & |singlelinecheck=on|\\
\end{longtable}}

Setting the margin for captions was done in \version{2.x} with
\begin{quote}\leavevmode\hbox{%
  |\setcaptionmargin{|\ldots|}| resp.
  |\setcaptionwidth{|\ldots|}|\quad.
}\end{quote}
This was replaced by
\begin{quote}\leavevmode\hbox{%
  |\captionsetup{margin=|\ldots|}| resp.
  |\captionsetup{width=|\ldots|}|\quad.
}\end{quote}
\See{\Ref{margins}}

Setting an indention was done in \version{2.x} with
\begin{quote}
  |\captionstyle{indent}|\\
  |\setlength\captionindent{|\ldots|}|\quad.
\end{quote}
This is now done with
\begin{quote}
  |\captionsetup{format=plain,indention=|\ldots|}|\quad.
\end{quote}

The so-called single-line-check was controlled by the commands
|\oneline|\-|captions|\-|false| (for switching the check off) and
|\oneline|\-|captions|\-|true| (for switching the check on).
This was replaced by
|\captionsetup{|\xx|singlelinecheck=|\xx|off}|
resp.
|\captionsetup{|\xx|singlelinecheck=|\xx|on}|.
\See{\Ref{justification}}

The commands
\begin{quote}
  |\captionlabeldelim|, |\captionlabelsep|, |\captionstyle|,\\
  |\defcaptionstyle|, |\newcaptionstyle|, and |\renewcaptionstyle|
\end{quote}
do not have a simple replacement and therefore will not be emulated
by this version of \thispackage. (So using them will
cause error messages.) Rewriting such code is not always easy and
straight-ahead, but by conscientious reading of this manual you should
find appropriate options and commands instead.

\iffalse
... (some examples)
\fi

The \version{2.x} option |ignoreLTcapwidth| do not have a replacement, too.
But in most cases you can simply drop using that option because
in this version of \thispackage\ the value of |\LTcapwidth|
will be ignored anyway (unless you set it to a different value than the
default one which is |4in|).
\See{\Ref{longtable}}

\subsection{caption v\texorpdfstring{$3.0$}{3.0}}
\label{caption3}

%\NEWdescription{v3.1}
\Thispackage\ \version{3.0} did not support any document classes
other than the standard \LaTeX\ ones: |article|, |report|, and |book|.
Therefore the default settings used to be fixed, but now \thispackage{}
supports more classes, therefore they are now set in dependence on the
document class used.

For example: While in \version{3.0} the default caption |justification| used
to be always |justified|, it's now still |justified| when using one of the
standard document classes, but |raggedright| will be used as default format
when when used with the \package{beamer} document class.

%An easy way to select the `old' defaults---if desired---is using the option
An easy way to select the `old' defaults is using the option
|style=base| when loading \thispackage\ (or later on using |\captionsetup|).

Another new feature is the automatic check for compatibility; if an
incompatibility will be found, a warning message will be issued and if a strong
incompatibility was found some features of \thispackage\ will be disabled.
Please note that only this check was added to \thispackage, so if you get
such warning message, the previous versions of \thispackage\ were incompatible
as well, but did not issued such warning, they were ``only'' having
side-effects or causing problems.
So these warnings only say that some bad side effects or problems could
happen, but not that they actually will happen.
Anyway, if you use \thispackage\ in such circumstances,
you should use it with care.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Alphabetical Reference}

%\newenvironment{Warnings}%
% {\begin{trivlist}%
%   \def\Message{\pagebreak[3]\leftskip=0pt\relax\item[]\color{blue}}%
%   \def\Description{\nopagebreak\par\nopagebreak\color{black}\leftskip=1.5em\nopagebreak}%
% }%
% {\color{black}\end{trivlist}}
\makeatletter
\newenvironment{Warnings}{%
  \newif\ifMessage
  \def\Message{%
    \ifMessage\end{minipage}\par\vspace\itemsep\pagebreak[3]\fi
    \begin{minipage}{\linewidth}%
    \setlength\parindent{0pt}%
    \setlength\parskip{\smallskipamount}%
    \setlength\leftskip{0pt}%
    \color{blue}%
    \Messagetrue}%
  \def\Description{%
    \par\color{black}\leftskip=1.5em}%
  \def\Or{\@testopt\@Or{or}}%
  \def\@Or[##1]{%
    \\{\small\color{black}\hspace{1.5em}\textit{-- ##1 --}}\\}%
}{%
  \ifMessage\end{minipage}\par\fi
}
\makeatother

\subsection{Commands}

\begin{longtable}{lll}
Command                          & & Section \\
\hline
\endhead
|\abovecaptionskip|              & & \ref{skips} \\
%|\AtBeginCaption|               & & \ref{x} \\
%|\AtEndCaption|                 & & \ref{x} \\
|\belowcaptionskip|              & & \ref{skips} \\
|\caption|                       & & \ref{commands} \\
|\caption*|                      & & \ref{commands} \\
|\captionbox|                    & & \ref{x} \\
|\captionof|                     & & \ref{commands} \\
|\captionof*|                    & & \ref{commands} \\
|\captionsetup|                  & & \ref{commands} \\
|\captionsetup*|                 & & \ref{commands} \\
|\centerfirst|                   & & \ref{justification} \\
|\centerlast|                    & & \ref{justification} \\
|\clearcaptionsetup|             & & \ref{commands} \\
|\clearcaptionsetup*|            & & \ref{commands} \\
|\ContinuedFloat|                & & \ref{ContinuedFloat} \\
|\DeclareCaptionFont|            & & \ref{declare} \\
|\DeclareCaptionFormat|          & & \ref{declare} \\
|\DeclareCaptionFormat*|         & & \ref{declare} \\
|\DeclareCaptionJustification|   & & \ref{declare} \\
|\DeclareCaptionLabelFormat|     & & \ref{declare} \\
|\DeclareCaptionLabelSeparator|  & & \ref{declare} \\
|\DeclareCaptionLabelSeparator*| & & \ref{declare} \\
|\DeclareCaptionListOfFormat|    & & \ref{declare} \\
|\DeclareCaptionOption|          & & \ref{declare} \\
|\DeclareCaptionStyle|           & & \ref{declare} \\
|\DeclareCaptionTextFormat|      & & \ref{declare} \\
|\DeclareFloatingEnvironment|    & & \ref{DeclareFloatingEnvironment} \\
|\showcaptionsetup|              & & \ref{commands} \\
\end{longtable}

\pagebreak[4]
\subsection{Options}
\newcommand\preambleoption{ \footnotemark[1]}

\begin{longtable}{lll}
Option & Short description & Section \\
\hline
\endhead
|aboveskip|       & sets the skip above caption & \ref{skips} \\
|belowskip|       & sets the skip below caption & \ref{skips} \\
|compatibility|\preambleoption & force (non-)compatibility & \ref{classes} \\
%|config| &       & \ref{x} \\
|figurename|\preambleoption & sets the figure name & \ref{x} \\
|figureposition|\preambleoption & gives a hint about the figure caption position & \ref{skips} \\
|font|            & sets the font & \ref{fonts} \\
|format|          & sets the format & \ref{formats} \\
|FPlist|          & to where the list entry of a FPfigure should link? & \ref{fltpage} \\
|FPref|           & to where a |\ref| to a FPfigure should link? & \ref{fltpage} \\
|hangindent|      & sets the hang indention & \ref{margins} \\
|hypcap|          & select `hypcap' feature & \ref{hyperref} \\
|hypcapspace|     & sets the distance between hyperlink \& contents & \ref{hyperref} \\
|indention|       & sets the indention & \ref{margins} \\
|justification|   & sets the justification & \ref{justification} \\
|labelfont|       & sets the font of the caption label & \ref{fonts} \\
|labelformat|     & sets the format of the caption label & \ref{formats} \\
|labelsep|        & sets the label separator & \ref{formats} \\
|labelseparator|  & sets the label separator & \ref{formats} \\
|listof|          & switches the entries in the `List of' on or off & \ref{listof} \\
|listofformat|    & sets the `List of' entry format & \ref{listof} \\
|margin|          & sets the margin & \ref{margins} \\
|margin*|         & sets the margin, but only if no width is set & \ref{margins} \\
|maxmargin|       & sets the max. margin & \ref{margins} \\
|minmargin|       & sets the min. margin & \ref{margins} \\
|options|         & executes the given option list & \ref{x} \\
|parindent|       & sets the paragraph indention & \ref{margins} \\
|parskip|         & sets the skip between paragraphs & \ref{margins} \\
|position|        & gives a hint about the caption position & \ref{skips} \\
|singlelinecheck| & switches the single-line-check on or off & \ref{justification} \\
%|size|           & sets the size of font & \ref{x} \\
|skip|            & sets the skip between content \& caption & \ref{skips} \\
|strut|           & switches the usage of |\strut|s on or off & \ref{formats} \\
|style|           & sets the caption style & \ref{style} \\
|tablename|\preambleoption & sets the table name & \ref{x} \\
|tableposition|\preambleoption & gives a hint about the table caption position & \ref{skips} \\
|textfont|        & sets the font of the caption text & \ref{fonts} \\
|textformat|      & sets the format of the caption text & \ref{formats} \\
|twoside|         & selects the two-side mode & \ref{x} \\
|type|            & sets the caption type \& places a hyperlink anchor & \ref{x} \\
|type*|           & sets the caption type only & \ref{x} \\
|width|           & sets a fixed caption width & \ref{margins} \\
\end{longtable}
\footnotetext[1]{These options are only available in the preamble of the document.}

\nopagebreak\parbox[t]{\linewidth}{\small\emph{Note:}
  Obsolete options are not listed here. See\\
  \hspace*{1em}\Ref{caption1} and\\
  \hspace*{1em}\Ref{caption2} for a list of these options.}

\pagebreak[4]
\subsection{Warnings}

\begin{Warnings}

\Message
  |\caption will not be redefined since it's already|\\
  |redefined by a document class or package which is|\\
  |unknown to the caption package.|\\
  |As a result some new features of the caption|\\
  |package will not work as expected.|
\Description
  If \thispackage\ detects that some (unknown) documentclass or
  package has enhanced |\caption|, it will not redefine
  |\caption|, too, since this would simply kill the enhancement.
  As a result some features, like |\caption*|, |\ContinuedFloat|,
  using the optional argument of |\captionsetup|,
  or the options |listof=| \& |hypcap=| will be ignored or
  not work as expected.\par
  If you don't care about the original enhancements but would
  like to use the full range of features of \thispackage\ instead
  you can give the unsupported(!) option |compatibility=false|
  a try and keep your fingers crossed.
  (But you will get the next warning instead.)
  \par\See{\Ref{classes}}

\Message
  |Caption type was already set to `|\meta{type}|'.|
\Description
  This warning informs you about mixed caption options. For example if
  you use a |\captionof{table}{|\ldots|}| inside a |figure| environment,
  this would result in using both option sets for that specific caption,
  the ones for |figure| (specified with |\captionsetup[figure]{|\ldots|}|)
  and the one for |table| (specified with |\captionsetup[table]{|\ldots|}|)
  as well.
  \par\See{\Ref{commands}}

\Message
  |Forced redefinition of \caption since the|\\
  |unsupported(!) package option `compatibility=false'|\\
  |was given. Please fasten your seat belts, as we may|\\
  |experience turbulence!|
\Description
  Since you were so keen to specify the option |compatibility=false|
  \thispackage\ will try to do its best to fulfill your wishes.
  But depending on the document class or other packages you use that
  can end in non-functional features or even errors. So keep your
  fingers crossed!
  \par\See{\Ref{classes}}

\Message
  |Hyperref support is turned off because hyperref has|\\
  |stopped early.|
\Description
  If the \package{hyperref} package stopps early during loading
  (because of what-ever reason), the \package{hyperref} support of
  \thispackage\ will not be available. As a result you could get
  \package{hyperref} warnings and non-functional hyperlinks to figures
  or tables.
  \par\See{\Ref{hyperref}}

\Message
  |Ignoring optional argument [|\meta{pos}|] of \setcapwidth.|
\Description
  \Thispackage\ tries to emulate the \KOMAScript\ commands regarding
  captions as best as it can. But the optional argument of the
  \KOMAScript\ command |\setcapwidth| is not (yet) working if you use
  this package, so if you try to use it anyway, you will get this warning.
  \par\See{\Ref{KOMA}}

\Message
  |Internal Warning: |\meta{warning message}|.|
\Description
% \Thispackage\ can only set hyperanchors in \TeX s vertical mode.\par
  You should never see this warning, either you use a package which redefines
  |figure| or |table| and which is unknown to \thispackage, or this is a bug
  in \thispackage.
  Please send me an e-mail reporting this issue.

\Message
  |\label before \caption ignored|
\Description
  Regarding |\label| the floating environments behave differently than its
  non-floating counterparts: The internal reference will not be generated
  at the beginning of the environment, but at |\caption| instead.
  So you have to place the |\label| command either \emph{after} the
  |\caption| command or inside the caption text.

\Message
  |Option `|\meta{option}|' was not in list `|\meta{option list}|'.|
\Description
  If you try to remove a specific option of an option list,
  for example with\linebreak|\clearcaptionsetup[position]{table}|,
  and this option can not be found inside the option list, you will
  get this warning. If this is not because of a typo and you would like
  to suppress this warning, use |\clearcaptionsetup*| instead of
  |\clearcaptionsetup|.
  \par\See{\Ref{commands}}

\Message
  |Option list `|\meta{option list}|' undefined.|
\Description
  If you try to remove a specific option of an option list,
  for example with\linebreak|\clearcaptionsetup[format]{figure}|,
  and this option list is not defined (yet), you will
  get this warning. If this is not because of a typo and you would like
  to suppress this warning, use |\clearcaptionsetup*| instead of
  |\clearcaptionsetup|.
  \par\See{\Ref{commands}}

\iffalse
\Message
  |Possibly superfluous \restylefloat{|\meta{type}|} detected.|\\
  |If you think that this warning is unjustified,|\\
  |you can switch it off using the caption package|\\
  |option `restylefloatcheck=off'.|
\Description
  \TODO
\fi

\Message
  |`ragged2e' package not loaded, therefore|\\
  |substituting \raggedright for \RaggedRight.|
\Description
  The caption option |justification=|\xx|RaggedRight| is only full functional
  if you have the \package{ragged2e} package installed in your \TeX\ system.
  If not, you will get this warning, and |justification=|\xx|RaggedRight|
  will be treated as |justification=|\xx|raggedright|.
  \par\See{\Ref{justification}}

\Message
  |Obsolete option `ignoreLTcapwidth' ignored.|
\Description
  The \package{caption2} package option |ignoreLTcapwidth| will not be
  emulated by this version of \thispackage, usually you can simply wipe it
  away.
  \par\See{\Ref{caption2} and \Ref{longtable}}

\Message
  |`ragged2e' support has been changed. Rerun to get|\\
  |captions right.|
\Description
  The \package{ragged2e} package will only be loaded by \thispackage\ if it
  is actually needed.
  At least two \LaTeX\ runs are needed for that, so on the first run you could
  get this warning.
  Just compile your document again and this warning should go away.
  \par\See{\Ref{justification}}

\Message
  |Reference on page |\meta{page no.}| undefined.|
\Description
  If you use a |twoside| page layout, \thispackage\ needs to track the
  page numbers to get the margins right.
  At least two \LaTeX\ runs are needed for that, on the first run you could get
  this warning.
  Just compile your document again and this warning should go away.
  \par\See{\Ref{margins}}

\Message
  |The option `hypcap=true' will be ignored for this|\\
  |particular \caption.|
\Description
  \Thispackage\ hasn't found a proper hyperlink anchor for this particular
  caption, so it decides to ignore the setting |hypcap=true| (which is set by
  default). As a result a link to this caption (e.g.~in the List of Figures,
  or set by |\ref| or |\autoref|) will link you to the caption of the figure
  or table, not to the figure or table itself.\par
  This can happen if you use |\captionof| inside a non-floating environment,
  but also if you use some package which redefines |figure| or |table|, and
  which is unknown to \thispackage.\par
  If this is ok for you but you want to supress this warning, simply place a
  |\captionsetup{|\xx|hypcap=|\xx|false}| just before the |\caption| or
  |\captionof| command which is causing the warning.
  If this is not ok for you you can try to set a hyperlink anchor with
  |\captionsetup{|\xx|type=|\xx\meta{float type}|}| for yourself.
  \par\See{\Ref{hyperref}}

\Message
  |Unsupported document class (or package) detected,|\\
  |usage of the caption package is *not* recommended.|
\Description
  Either the document class you use is unknown to \thispackage, or you
  have included a package in your document which redefines |\@makecaption|
  (which is responsible for typeseting the caption) as well.
  This means \thispackage\ will either change the design of captions in an
  unwanted way, or it even refuses to work correctly at all.
  \par\See{\Ref{classes}}

\Message
  |Unused \captionsetup[|\meta{type}|].|
\Description
  You have specified options with |\captionsetup[|\meta{type}|]| which are
  not used later on.
  This can be because of a typo in \meta{type},
  or because you use a package which redefines |figure| or |table| and
  which is unknown to \thispackage, or simply because you don't have any usage
  of the environment \meta{type} after this line.\par
  If you want to supress this warning you can use |\captionsetup*| instead of
  |\captionsetup|.
  \par\See{\Ref{commands}}

\Message
  |Usage of the |\meta{package}| package together with the|\\
  |caption package is strongly *not* recommended.|\\
  |Instead of loading the |\meta{package}| package you should|\\
  |use the caption package option `tableposition=top'.|
\Description
  The package \meta{package} is dealing with caption skips as well.
  Please decide which one do you actually want to use, \thispackage\ or the
  other one, using both can lead to wrong skips above or below the caption.
  \par\See{\Ref{skips}}

\end{Warnings}

\pagebreak[4]
\subsection{Errors}

\begin{Warnings}

\Message
  |Argument of \@caption has an extra }.|
\Or
  |Paragraph ended before \@caption was complete.|
\Description
  If you want to typeset something special (like a tabular) as caption,
  you need to give an optional argument to |\caption| resp.~|\captionof|
  for the List of Figures resp.~List of Tables, too, even if you don't
  use such list.
  \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,}

\Message
  |\caption outside float.|
\Description
  You have placed a |\caption| command outside a floating environment or
  a |longtable|. If this is what you want to, please use either
  |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ |\caption| or |\captionof|.
  \par\See{\Ref{commands}}

\Message
  |\caption outside box or environment.|
\Or
  |\captionsetup{type=...} outside box or environment.|
\Or
  |\captionsetup{type*=...} or \captionof outside box or environment.|
\Description
  You have placed a |\caption|, |\captionof|, or |\captionsetup{type=|\meta{type}|}|
  command outside an box, group, or environment.
  This is not supported.
  \par\See{\Ref{commands}}

\Message
  |\ContinuedFloat outside float.|
\Description
  You have placed a |\ContinuedFloat| command outside a floating environment.
%  or |longtable|.
  If this is what you want to, please use the combination
  |\captionsetup{|\xx|type=|\xx\meta{type}|}| $+$ |\ContinuedFloat|.\par
  Please note that |\ContinuedFloat| inside a |longtable| is not working (yet),
  but maybe using the |longtable*| environment, which typesets a longtable
  without incrementing the |table| counter, if sufficient for you.
  \par\See{\Ref{commands} and \Ref{longtable}}

\Message
  |Continued `|\meta{type}|' after `|\meta{type}|'.|
\Description
  At the moment continued figures or tables are not allowed to be interrupted
  by a floating envionment of another type, e.g.~a table between a figure and a
  continued figure.
  \par\See{\Ref{ContinuedFloat}}

\Message
  |For a successful cooperation of the `wrapfig' package|\\
  |with the `float' package you should load the `wrapfig'|\\
  |package *(right) after* the `float' package.|
\Description
  Please take care of the load order of packages
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package.
  \par\See{\Ref{wrapfig}}

\Message
  |For a successful cooperation of the `wrapfig' package|\\
  |with the `float' package you should use at least|\\
  |`wrapfig' version 3.6.|
\Description
  Please take care of the version of the \package{wrapfig} package
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package.
  \par\See{\Ref{wrapfig}}

\Message
  |For a successful cooperation we need at least version|\\
  |`|\meta{date}|' of package |\meta{package}|, but only version|\\
  |`|\meta{old-date}|' is available.|
\Description
  \Thispackage\ does not work with such an outdated package, please update it
  to a more recent version, at least to the one requested.

\Message
  |Internal Error: |\meta{error message}|.|
\Description
  You should never see this error.
  Please send me an e-mail reporting this issue.

\Message
  |Not allowed in longtable* environment.|
\Description
  The usage of |\caption| is not allowed inside the |longtable*| environment.
  Please use either |\caption*| for a caption without label or use the regular
  |longtable| environment instead.

\Message
  |Not available in compatibility mode.|
\Description
  The feature required is not supported in compatibility mode.
  `compatibility mode' means that \thispackage\ has detected either an
  incompatible document class or an incompatible package which also
  extents the |\caption| command. Leaving the original extention intact,
  some features of \thispackage\ are not supported.
  \par\See{\Ref{compatibility}}

\Message
  |Only one \caption can be placed in this environment.|
\Description
  Inside the environments offered by the \package{fltpage} and \package{sidecap}
  package only one caption can be placed. (This is due implementation design.)

\Message
  |Option clash for package caption.|
\Or[but sometimes also]
  |Missing \begin{document}.|
\Description
  \Thispackage\ has already been loaded by some other \LaTeX\ package,
  so you can't do that again specifying different options.
  A candidate causing this could be the \package{subfig} package; if this is
  the case, please load \thispackage\ \emph{before} the \package{subfig}
  package or specify the option |caption=false| while loading the
  \package{subfig} package.
  \par\See{the \package{subfig} package\cite{subfig} documentation}

\Message
  |Paragraph ended before \caption@makecurrent was complete.|
\Description
  If you want to typeset multi-paragraph captions, you need to give an
  optional argument to |\caption| resp.~|\captionof| for the List of
  Figures resp.~List of Tables, too, even if you don't use such list.
  \par\See{\Ref{commands}, \Ref{listof}, and \Ref{hyperref}\,}

\iffalse % was removed in v3.1b
\Message
  |Something is going wrong here...|\\
  |For a removal of this problem please consult the|\\
  |caption package documentation, especially the sections|\\
  |about the `float' and the `wrapfig' package.|
\Description
  Please take care of the load order of packages
  if you use the \package{wrapfig} package in coorperation with the
  \package{float} package. But maybe a different package tried to extent
  the \package{float} package in a manner which is incompatible to
  \thispackage!?
  \par\See{\Ref{float} and \Ref{wrapfig}}
\fi

\iffalse
\Message
  |Something's wrong--perhaps a missing \caption|\\
  |in the last figure or table.|
\Description
  It seems that you have used a |\subcaption| command without a
  corresponding |\caption| command. This is not supported.
\fi

\Message
  |The option `labelsep=|\meta{name}|' does not work|\\
  |with `format=hang'.|
\Or
  |The option `labelsep=|\meta{name}|' does not work|\\
  |with \setcaphanging (which is set by default).|
\Description
  A caption label separator which contains a |\\| command (like
  |labelsep=|\xx|newline|) can not be combined with a hanging caption format
  (like |format=|\xx|hang|).
  Please select either another caption label seperator
  (e.g.~|labelsep=|\xx|colon|) or another caption format
  (e.g.~|format=|\xx|plain|).
  \par\See{\Ref{formats} resp.~\Ref{KOMA}}

\Message
  |The package option `caption=false' is obsolete.|\\
  |Please pass this option to the subfig package instead|\\
  |and do *not* load the caption package anymore.|
\Description
  You have specified the option |caption=false|. This used to be a workaround
  for not using the whole \package{caption} package, leaving the caption stuff
  offered by the document class or other packages intact, but keeping the
  \package{subfig} package working. This mechanism is obsolet and not offered
  anymore, please pass this option to the \package{subfig} instead and do not
  load \thispackage\ anymore.
  \par\See{the \package{subfig} package\cite{subfig} documentation}

\Message
  |Undefined boolean value `|\meta{value}|'.|
\Description
  You tried to set a boolean option (like |singlelinecheck=| or |hypcap=|)
  with an improper value. Only |false|, |no|, |off|, |0| or |true|, |yes|,
  |on|, |1| is allowed here.

\Message
  |Undefined format `|\meta{name}|'.|
\Description
  You tried to set a caption format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined label format `|\meta{name}|'.|
\Description
  You tried to set a caption label format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined label separator `|\meta{name}|'.|
\Description
  You tried to set a caption label separator which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |Undefined list-of format `|\meta{name}|'.|
\Description
  You tried to set a caption list-of format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{listof}}

\Message
  |Undefined position `|\meta{name}|'.|
\Description
  You tried to set a caption position with an improper value.
  Maybe a typo!?
  \par\See{\Ref{skips}}

\Message
  |Undefined style `|\meta{name}|'.|
\Description
  You tried to set a caption style which does not exists.
  Maybe a typo!?
  \par\See{\Ref{style}}

\Message
  |Undefined text format `|\meta{name}|'.|
\Description
  You tried to set a caption text format which does not exists.
  Maybe a typo!?
  \par\See{\Ref{formats}}

\Message
  |You can't use both, the (obsolete) caption2 *and*|\\
  |the (current) caption package.|
\Description
  This error message says it all, you simply can't do that.
  Please use only \thispackage.
  \par\See{\Ref{caption2}}

\Message
  |You can't use the caption package option|\\
  |  `tableposition=|\meta{position}|'|\\
  |and use the |\meta{package}| package, too.|
\Or
  |You can't use the global option|\\
  |  `tablecaptionabove'|\\
  |and use the |\meta{package}| package, too.|
\Description
% (ftcap,nonfloat,topcapt)
  The package \meta{package} is dealing with caption skips as well.
  Please decide which one do you actually want to use, \thispackage\ or the
  other one, using both this way will lead to wrong skips above or below the
  caption.
  \par\See{\Ref{skips}}

\end{Warnings}

% --------------------------------------------------------------------------- %

\pagebreak[4]
\section{Further reading}

I recommend the following documents for further reading:

\begin{itemize}
\item
  The \TeX\ FAQ -- Frequently asked questions about \TeX\ and \LaTeX:
  \begin{quote}\url{http://faq.tug.org/}\end{quote}

\item
  A French FAQ can be found at
  \begin{quote}\url{http://www.grappa.univ-lille3.fr/FAQ-LaTeX/}\end{quote}

\item
  ``What is a minimal working example?'' from Christian Faulhammer and Ulrich Schwarz:
  \begin{quote}\url{http://www.minimalbeispiel.de/mini-en.html}\end{quote}

\item
  \textsf{epslatex} from Keith Reckdahl contains many tips around
  including graphics in \LaTeXe\ documents.
  You will find this document in the directory
  \begin{quote}\url{ftp://tug.ctan.org/pub/tex/info/epslatex/}\end{quote}
\end{itemize}

% --------------------------------------------------------------------------- %

\pagebreak[2]
\section{Thanks}

I would like to thank Katja Melzner,
Steven D. Cochran, Frank Mittelbach, Olga Lapko,
David Carlisle, Carsten Heinz, and Keith Reckdahl.
Thanks a lot for all your help, ideas, patience, spirit, and support!

Also I would like to thank
Harald Harders,
Peter L\"offler,
Peng Yu,
Alexander Zimmermann,
Matthias Pospiech,
J\"urgen Wieferink,
Christoph Bartoschek,
Uwe St\"ohr,
Ralf Stubner,
Geoff Vallis,
Florian Keiler,
J\"urgen G\"obel,
Uwe Siart,
Sang-Heon Shim,
Henrik Lundell,
David Byers,
William Asquith,
Prof.~Dr.~Dirk Hoffmann,
Frank Martini,
and
Danie Els
who all helped to make this package a better one.

% --------------------------------------------------------------------------- %

\pagebreak[4]
\begin{thebibliography}{99}
  \bibitem{TLC2}
  Frank Mittelbach and Michel Goossens:\\
  \newblock {\em The {\LaTeX} Companion (2nd.~Ed.)},\\
  \newblock Addison-Wesley, 2004.

  \bibitem{beamer}
  Till Tantau:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf}%
       {\emph{User Guide to the Beamer Class, Version 3.07}},\\
  March 11, 2007

  \bibitem{KOMAScript}
  Markus Kohm \& Jens-Uwe-Morawski:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/koma-script/scrguien.pdf}%
       {\emph{KOMA-Script -- a versatile \LaTeXe\ bundle}},\\
  2007-01-09

  \bibitem{NTG}
  Victor Eijkhout:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/ntgclass/classdoc.pdf}%
       {\emph{An introduction to the Dutch \LaTeX\ document classes}},\\
  3 September 1989

  \bibitem{float}
  Anselm Lingnau:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/float/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/float/float.pdf}%
       {\emph{An Improved Environment for Floats}},\\
  2001/11/08

  \bibitem{floatflt}
  Mats Dahlgren:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatflt/floatflt.pdf}%
       {\emph{Welcome to the floatflt package}},\\
  1998/06/05

  \bibitem{floatrow}
  Olga Lapko:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/floatrow/floatrow.pdf}%
       {\emph{The floatrow package documentation}},\\
  2007/08/24

  \bibitem{fltpage}
  Sebastian Gross:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/fltpage/fltpage.pdf}%
       {\emph{Welcome to the beta test of fltpage package!}},\\
  1998/11/13

  \bibitem{hyperref}
  Sebastian Rahtz \& Heiko Oberdiek:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/hyperref/hyperref.pdf}%
       {\emph{Hypertext marks in \LaTeX}},\\
  June 14, 2007

  \bibitem{hypcap}
  Heiko Oberdiek:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/oberdiek/hypcap.pdf}%
       {\emph{The hypcap package -- Adjusting anchors of captions}},\\
  2007/04/09

  \bibitem{listings}
  Carsten Heinz \& Brooks Moses:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/listings/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/listings/listings.pdf}%
       {\emph{The Listings Package}},\\
  2007/02/22

  \bibitem{longtable}
  David Carlisle:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/required/tools/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/required/tools/longtable.pdf}%
       {\emph{The longtable package}},\\
  2004/02/01

  \bibitem{picinpar}
  Friedhelm Sowa:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picinpar/}%
       {\emph{Pictures in Paragraphs}},\\
  July 13, 1993

  \bibitem{picins}
  Joachim Bleser and Edmund Lang:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex209/contrib/picins/mpic.dvi}%
       {\emph{PicIns-Benutzerhandbuch Version 3.0}},\\
  September~1992

  \bibitem{rotating}
  Sebastian Rahtz and Leonor Barroca:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/rotating/}%
       {\emph{A style option for rotated objects in \LaTeX}},\\
  1997/09/26

  \bibitem{sidecap}
  Rolf Niepraschk \& Hubert G\"a\ss lein:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/sidecap/sidecap.pdf}%
       {\emph{The sidecap package}},\\
  2003/06/06

  \bibitem{subfigure}
  Steven D. Cochran:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfigure/subfigure.pdf}%
       {\emph{The subfigure package}},\\
  2002/07/02

  \bibitem{subfig}
  Steven D. Cochran:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/subfig/subfig.pdf}%
       {\emph{The subfig package}},\\
  2005/07/05

  \bibitem{supertabular}
  Johannes Braams and Theo Jurriens:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf}%
       {\emph{The supertabular environment}},\\
  2002/07/19

  \bibitem{threeparttable}
  Donald Arseneau:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/misc/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/misc/threeparttable.sty}%
       {\emph{Three part tables: title, tabular environment, notes}},\\
  2003/06/13

  \bibitem{wrapfig}
  Donald Arseneau:\\
  \href{http://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/}%
% \href{ftp://tug.ctan.org/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty}%
       {\emph{WRAPFIG.STY ver 3.6}},\\
  2003/01/31
\end{thebibliography}

% --------------------------------------------------------------------------- %

\end{document}