1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
|
\documentclass{ltxdockit}[2011/03/25]
\usepackage{btxdockit}
\usepackage{fontspec}
\usepackage{hyperref}
\usepackage{zref-xr}
\setmonofont{Courier New}
\setmainfont[Ligatures=TeX]{Linux Libertine O}
\setsansfont[Ligatures=TeX]{Linux Biolinum O}
\usepackage[american]{babel}
\usepackage[strict]{csquotes}
\usepackage{tabularx}
\usepackage{longtable}
\usepackage{booktabs}
\usepackage{shortvrb}
\usepackage{pifont}
\usepackage{microtype}
\usepackage{typearea}
\usepackage{mdframed}
\areaset[current]{370pt}{700pt}
\lstset{
basicstyle=\ttfamily,
keepspaces=true,
upquote=true,
frame=single,
breaklines=true,
postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\color{red}\hookrightarrow\space}}
}
\KOMAoptions{numbers=noenddot}
\addtokomafont{title}{\sffamily}
\addtokomafont{disposition}{\spotcolor}
\addtokomafont{descriptionlabel}{\spotcolor}
\setkomafont{caption}{\bfseries\sffamily\spotcolor}
\setkomafont{captionlabel}{\bfseries\sffamily\spotcolor}
\pretocmd{\cmd}{\sloppy}{}{}
\pretocmd{\bibfield}{\sloppy}{}{}
\pretocmd{\bibtype}{\sloppy}{}{}
\makeatletter
\RedeclareSectionCommand[%
beforeskip=-3.25ex\@plus -1ex \@minus -.2ex,%
afterskip=1.5ex \@plus .2ex,%
]{paragraph}
\RedeclareSectionCommand[%
beforeskip=-3.25ex\@plus -1ex \@minus -.2ex,%
indent=\z@,%
]{subparagraph}
\makeatother
\MakeAutoQuote{«}{»}
\MakeAutoQuote*{<}{>}
\MakeShortVerb{\|}
\newcommand*{\allowbreakhere}{\discretionary{}{}{}}
\newcommand*{\biber}{\sty{biber}\xspace}
\newcommand*{\biblatex}{\sty{biblatex}\xspace}
\newcommand*{\biblatexml}{\sty{biblatexml}\xspace}
\newcommand*{\biblatexhome}{https://sourceforge.net/projects/biblatex/}
\newcommand*{\biblatexctan}{https://ctan.org/pkg/biblatex/}
\titlepage{%
title={The \biblatex Package},
subtitle={Programmable Bibliographies and Citations},
url={\biblatexhome},
author={Philip Kime, Moritz Wemheuer, Philipp Lehman},
email={},
revision={3.15a},
date={\today}}
\hypersetup{%
pdftitle={The \biblatex Package},
pdfsubject={Programmable Bibliographies and Citations},
pdfauthor={Philipp Lehman, Philip Kime, Moritz Wemheuer},
pdfkeywords={tex, latex, bibtex, bibliography, references, citation}}
% tables
\newcolumntype{H}{>{\sffamily\bfseries\spotcolor}l}
\newcolumntype{L}{>{\raggedright\let\\=\tabularnewline}p}
\newcolumntype{R}{>{\raggedleft\let\\=\tabularnewline}p}
\newcolumntype{C}{>{\centering\let\\=\tabularnewline}p}
\newcolumntype{V}{>{\raggedright\let\\=\tabularnewline\ttfamily}p}
\newcommand*{\sorttablesetup}{%
\tablesetup
\ttfamily
\def\new{\makebox[1.25em][r]{\ensuremath\rightarrow}\,}%
\def\alt{\par\makebox[1.25em][r]{\ensuremath\hookrightarrow}\,}%
\def\note##1{\textrm{##1}}}
\newcommand{\tickmarkyes}{\Pisymbol{psy}{183}}
\newcommand{\tickmarkno}{\textendash}
\providecommand*{\textln}[1]{#1}
\providecommand*{\lnstyle}{}
% markup and misc
\setcounter{secnumdepth}{4}
\makeatletter
\newenvironment{nameparts}
{\trivlist\item
\tabular{@{}ll@{}}}
{\endtabular\endtrivlist}
\newenvironment{namedelims}
{\trivlist\item
\tabularx{\textwidth}{@{}c@{=}l>{\raggedright\let\\=\tabularnewline}X@{}}}
{\endtabularx\endtrivlist}
\newenvironment{namesample}
{\def\delim##1##2{\@delim{##1}{\normalfont\tiny\bfseries##2}}%
\def\@delim##1##2{{%
\setbox\@tempboxa\hbox{##1}%
\@tempdima=\wd\@tempboxa
\wd\@tempboxa=\z@
\box\@tempboxa
\begingroup\spotcolor
\setbox\@tempboxa\hb@xt@\@tempdima{\hss##2\hss}%
\vrule\lower1.25ex\box\@tempboxa
\endgroup}}%
\ttfamily\trivlist
\setlength\itemsep{0.5\baselineskip}}
{\endtrivlist}
\makeatother
\newrobustcmd*{\Deprecated}{%
\textcolor{spot}{\margnotefont Deprecated}}
\newrobustcmd*{\DeprecatedMark}{%
\leavevmode\marginpar{\Deprecated}}
\newrobustcmd*{\LF}{%
\textcolor{spot}{\margnotefont Label field}}
\newrobustcmd*{\LFMark}{%
\leavevmode\marginpar{\LF}}
\newrobustcmd*{\CSdelim}{%
\textcolor{spot}{\margnotefont Context Sensitive}}
\newrobustcmd*{\CSdelimMark}{%
\leavevmode\marginpar{\CSdelim}}
\newcommand*{\seestyleexample}[1]{%
\leavevmode
\marginpar{%
\raggedright
\footnotesize
Style example:\\
\href{file:examples/#1.pdf}{local},
\href{http://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/examples/#1.pdf}
{online}.}%
\ignorespaces}
% following snippet is based on code by Michael Ummels (TeX Stack Exchange)
% <http://tex.stackexchange.com/a/13073/8305>
\makeatletter
\newcommand\fnurl@[1]{\footnote{\url@{#1}}}
\DeclareRobustCommand{\fnurl}{\hyper@normalise\fnurl@}
\makeatother
\hyphenation{%
star-red
bib-lio-gra-phy
white-space
}
\begin{document}
\printtitlepage
\tableofcontents
\listoftables
\section{Introduction}
\label{int}
This document is a systematic reference manual for the \biblatex package. Look at the sample documents which come with \biblatex to get a first impression.\fnurl{https://ctan.org/tex-archive/macros/latex/contrib/biblatex/doc/examples}
For a quick start guide, browse \secref{int:abt, bib:typ, bib:fld, bib:use, use:opt, use:xbx, use:bib, use:cit, use:use}.
\subsection[About]{About \biblatex}
\label{int:abt}
This package provides advanced bibliographic facilities for use with \latex. The package is a complete reimplementation of the bibliographic facilities provided by \latex. The \biblatex\ package works with the \enquote{backend} (program) \biber, which is used to process \bibtex\ format data files and them performs all sorting, label generation (and a great deal more). Formatting of the bibliography is entirely controlled by \tex\ macros. Good working knowledge in \latex should be sufficient to design new bibliography and citation styles. This package also supports subdivided bibliographies, multiple bibliographies within one document, and separate lists of bibliographic information such as abbreviations of various fields. Bibliographies may be subdivided into parts and\slash or segmented by topics. Just like the bibliography styles, all citation commands may be freely defined. Features such as full Unicode support for bibliography data, customisable sorting, multiple bibliographies with different sorting, customisable labels and dynamic data modification are available. Please refer to \secref{int:pre:bibercompat} for information on \biber/\biblatex version compatibility. The package is completely localised and can interface with the \sty{babel} and \sty{polyglossia} packages. Please refer to \tabref{bib:fld:tab1} for a list of languages currently supported by this package.
\subsection{License}
Copyright \textcopyright\ 2006--2012 Philipp Lehman, 2012--2017 Philip Kime, Audrey Boruvka, Joseph Wright, 2018-- Philip Kime and Moritz Wemheuer. Permission is granted to copy, distribute and\slash or modify this software under the terms of the \lppl, version~1.3.\fnurl{https://www.latex-project.org/lppl.txt}
\subsection{Feedback}
\label{int:feb}
Please use the \biblatex project page on GitHub to report bugs and submit feature requests.\fnurl{https://github.com/plk/biblatex} Before making a feature request, please ensure that you have thoroughly studied this manual. If you do not want to report a bug or request a feature but are simply in need of assistance, you might want to consider posting your question on the \texttt{comp.text.tex} newsgroup or \tex-\latex Stack Exchange.\fnurl{https://tex.stackexchange.com/questions/tagged/biblatex}
\subsection{Acknowledgements}
The package was originally written by Philipp Lehman and much of his excellent
original code remains in the core. Philip Kime took over the package in
2012 with Moritz Wemheuer making regular and valuable contributions from 2017.
The main authors would like to acknowledge the valuable help of Audrey
Boruvka and Joseph Wright who helped with the transition of ownership in
2012 and following years.
The language modules of this package are made possible thanks to the following contributors:\\
Augusto Ritter Stoffel, Mateus Araújo, Gustavo Barros (Brazilian);
Kaloyan Ganev (Bulgarian);
Sebastià Vila-Marta (Catalan);
Ivo Pletikosić (Croatian);
Michal Hoftich (Czech);
Christian Mondrup, Jonas Nyrup (Danish);
Johannes Wilm (Danish\slash Norwegian);
Alexander van Loon, Pieter Belmans, Hendrik Maryns (Dutch);
Kristian Kankainen, Benson Muite (Estonian);
Hannu Väisänen, Janne Kujanpää (Finnish);
Denis Bitouzé (French);
Apostolos Syropoulos, Prokopis (Greek);
Márton Marczell, Bence Ferdinandy (Hungarian);
Baldur Kristinsson (Icelandic);
Enrico Gregorio, Andrea Marchitelli (Italian);
Rihards Skuja (Latvian);
Valdemaras Klumbys (Lithuanian);
Håkon Malmedal, Hans Fredrik Nordhaug (Norwegian);
Anastasia Kandulina, Yuriy Chernyshov (Polish);
José Carlos Santos (Portuguese);
Oleg Domanov (Russian);
Andrej Radović (Serbian);
Martin Vrábel, Dávid Lupták (Slovak);
Tea Tušar, Bogdan Filipič (Slovene);
Ignacio Fernández Galván (Spanish);
Per Starbäck, Carl-Gustav Werner, Filip Åsblom (Swedish);
Abdulkerim Gok (Turkish);
Sergiy M. Ponomarenko (Ukrainian).
\subsection{Prerequisites}
\label{int:pre}
This section gives an overview of all resources required by this package and discusses compatibility issues.
\subsubsection{Requirements}
\label{int:pre:req}
The resources listed in this section are strictly required for \biblatex to function. The package will not work if they are not available.
\begin{marglist}
\item[\etex]
The \biblatex package requires \etex. \tex distributions have been providing \etex binaries for quite some time, the popular distributions use them by default these days. The \biblatex package checks if it is running under \etex. Simply try compiling your documents as you usually do, the chances are that it just works. If you get an error message, try compiling the document with \bin{elatex} instead of \bin{latex} or \bin{pdfelatex} instead of \bin{pdflatex}, respectively.
\item[\biber]
\biber is the backend of \biblatex used to transfer data from source files to the \latex code. \biber comes with TeX Live and is also available from SourceForge.\fnurl{https://biblatex-biber.sourceforge.net/}. \biber uses the \texttt{btparse} C library for \bibtex format file parsing which aimed to be compatible with \bibtex's parsing rules but also aimed at correcting some of the common problems. For details, see the manual page for the Perl \texttt{Text::BibTeX} module\fnurl{https://metacpan.org/release/Text-BibTeX}.
\item[etoolbox]
This \latex package, which is loaded automatically, provides generic programming facilities required by \biblatex. It is available from \acr{CTAN}.\fnurl{https://ctan.org/pkg/etoolbox}
\item[kvoptions]
This \latex package, which is also loaded automatically, is used for internal option handling. It is available from \acr{CTAN}.\fnurl{https://ctan.org/pkg/kvoptions}
\item[logreq]
This \latex package, which is also loaded automatically, provides a frontend for writing machine-readable messages to an auxiliary log file. It is available from \acr{CTAN}.\fnurl{https://ctan.org/pkg/logreq/}
\item[pdftexcmds]
This \latex package, which is loaded automatically, implements \pdftex primitives for \luatex, it also offers a unified interface for these primitives across engines. It is available from \acr{CTAN}.\fnurl{https://ctan.org/pkg/pdftexcmds/}
\biblatex uses \sty{pdftexcmds} to access the MD5 hash primitives, so version~0.27 (2018/01/30) or above is strongly recommended.
\end{marglist}
Apart from the above resources, \biblatex also requires the standard \latex packages \sty{keyval} and \sty{ifthen} as well as the \sty{url} package. These package are included in all common \tex distributions and will be loaded automatically.
\subsubsection{Recommended Packages}
\label{int:pre:rec}
The packages listed in this section are not strictly required for \biblatex to function, but they provide recommended additional functions or enhance existing features.
\begin{marglist}
\item[babel/polyglossia]
The \sty{babel} and \sty{polyglossia} packages provides the core architecture for multilingual typesetting. If you are writing in a language other than American English, using one of these packages is strongly recommended. You should load \sty{babel} or \sty{polyglossia} before \biblatex and then \biblatex will detect \sty{babel} or \sty{polyglossia} automatically. (While \sty{babel} may be loaded after \biblatex if so desired, \sty{polyglossia} must always be loaded before \biblatex.)
\biblatex has only limited support for \sty{polyglossia} versions prior to~v1.45 (2019/10/27). Additional useful features for \biblatex were added in version~1.49. If \sty{polyglossia} is used, it should be updated to version~1.49 (2020/04/08) or above.
The minimum supported \sty{babel} version is~v3.9r (2016/04/23).
\item[csquotes]
If this package is available, \biblatex will use its language sensitive quotation facilities to enclose certain titles in quotation marks. If not, \biblatex uses quotes suitable for American English as a fallback. When writing in a language other than American English, loading \sty{csquotes} is strongly recommended.\fnurl{https://ctan.org/pkg/csquotes/}
\end{marglist}
\subsubsection{Additional Useful Packages}
\label{int:pre:add}
The packages listed in this section are not required for \biblatex to function, but provide additional specialist functions or enhance existing features. These packages generally only need to be loaded if their functionality is explicitly desired. The package loading order usually does not matter.
\begin{marglist}
\item[xpatch]
The \sty{xpatch} package extends the patching commands of \sty{etoolbox} to \biblatex bibliography macros, drivers and formatting directives.\fnurl{https://ctan.org/pkg/xpatch/} Its commands are useful to apply surgical-precision changes to bibliography macros, drivers or formatting directives without having to restate the whole definition to change it. The \biblatex core does not need or use these patching commands and styles that make use of them should load the package themselves.
\end{marglist}
\subsubsection{Compatible Classes and Packages}
\label{int:pre:cmp}
The \biblatex package provides dedicated compatibility code for the classes and packages listed in this section.
\begin{marglist}
\item[hyperref]
The \sty{hyperref} package transforms citations into hyperlinks. See the \opt{hyperref} and \opt{backref} package options in \secref{use:opt:pre:gen} for further details. When using the \sty{hyperref} package, it is preferable to load it after \biblatex.
\item[showkeys]
The \sty{showkeys} package prints the internal keys of, among other things, citations in the text and items in the bibliography. The package loading order does not matter.
\item[memoir]
When using the \sty{memoir} class, the default bibliography headings are adapted such that they blend well with the default layout of this class. See \secref{use:cav:mem} for further usage hints.
\item[\acr{KOMA}-Script]
When using any of the \sty{scrartcl}, \sty{scrbook}, or \sty{scrreprt} classes, the default bibliography headings are adapted such that they blend with the default layout of these classes. See \secref{use:cav:scr} for further usage hints.
If available \biblatex makes use of some of the more recent of \acr{KOMA}-Script's \emph{do-hooks}. The relevant hooks are present from version~3.27 (2019/10/12) onwards, which is therefore the minimum version recommendation.
\end{marglist}
\subsubsection{Incompatible Packages}
\label{int:pre:inc}
The packages listed in this section are not compatible with \biblatex. Since it reimplements the bibliographic facilities of \latex from the ground up, \biblatex naturally conflicts with all packages modifying the same facilities. This is not specific to \biblatex. Some of the packages listed below are also incompatible with each other for the same reason.
\begin{marglist}
\item[babelbib]
The \sty{babelbib} package provides support for multilingual bibliographies. This is a standard feature of \biblatex. Use the \bibfield{langid} field and the package option \opt{autolang} for similar functionality. Note that \biblatex automatically adjusts to the main document language if \sty{babel} or \sty{polyglossia} is loaded. You only need the above mentioned features if you want to switch languages on a per"=entry basis within the bibliography. See \secref{bib:fld:spc, use:opt:pre:gen} for details. Also see \secref{use:lng}.
\item[backref]
The \sty{backref} package creates back references in the bibliography. See the package options \opt{hyperref} and \opt{backref} in \secref{use:opt:pre:gen} for comparable functionality.
\item[bibtopic]
The \sty{bibtopic} package provides support for bibliographies subdivided by topic, type, or other criteria. For bibliographies subdivided by topic, see the category feature in \secref{use:bib:cat} and the corresponding filters in \secref{use:bib:bib}. Alternatively, you may use the \bibfield{keywords} field in conjunction with the \opt{keyword} and \opt{notkeyword} filters for comparable functionality, see \secref{bib:fld:spc, use:bib:bib} for details. For bibliographies subdivided by type, use the \opt{type} and \opt{nottype} filters. Also see \secref{use:use:div} for examples.
\item[bibunits]
The \sty{bibunits} package provides support for multiple partial (\eg per chapter) bibliographies. See \sty{chapterbib}.
\item[chapterbib]
The \sty{chapterbib} package provides support for multiple partial bibliographies. Use the \env{refsection} environment and the \opt{section} filter for comparable functionality. Alternatively, you might also want to use the \env{refsegment} environment and the \opt{segment} filter. See \secref{use:bib:sec, use:bib:seg, use:bib:bib} for details. Also see \secref{use:use:mlt} for examples.
\item[cite]
The \sty{cite} package automatically sorts numeric citations and can compress a list of consecutive numbers to a range. It also makes the punctuation used in citations configurable. For sorted and compressed numeric citations, see the \opt{sortcites} package option in \secref{use:opt:pre:gen} and the \texttt{numeric-comp} citation style in \secref{use:xbx:cbx}. For configurable punctuation, see \secref{use:fmt}.
\item[citeref]
Another package for creating back references in the bibliography. See \sty{backref}.
\item[inlinebib]
The \sty{inlinebib} package is designed for traditional citations given in footnotes. For comparable functionality, see the verbose citation styles in \secref{use:xbx:cbx}.
\item[jurabib]
Originally designed for citations in law studies and (mostly German) judicial documents, the \sty{jurabib} package also provides features aimed at users in the humanities. In terms of the features provided, there are some similarities between \sty{jurabib} and \biblatex but the approaches taken by both packages are quite different. Since both \sty{jurabib} and \biblatex are full"=featured packages, the list of similarities and differences is too long to be discussed here.
\item[mcite]
The \sty{mcite} package provides support for grouped citations, \ie multiple items can be cited as a single reference and listed as a single block in the bibliography. The citation groups are defined as the items are cited. This only works with unsorted bibliographies. The \biblatex package also supports grouped citations, which are called <entry sets> or <reference sets> in this manual. See \secref{use:use:set,use:bib:set,use:cit:mct} for details.
\item[mciteplus]
A significantly enhanced reimplementation of the \sty{mcite} package which supports grouping in sorted bibliographies. See \sty{mcite}.
\item[multibib]
The \sty{multibib} package provides support for bibliographies subdivided by topic or other criteria. See \sty{bibtopic}.
\item[natbib]
The \sty{natbib} package supports numeric and author"=year citation schemes, incorporating sorting and compression code found in the \sty{cite} package. It also provides additional citation commands and several configuration options. See the \texttt{numeric} and \texttt{author-year} citation styles and their variants in \secref{use:xbx:cbx}, the \opt{sortcites} package option in \secref{use:opt:pre:gen}, the citation commands in \secref{use:cit}, and the facilities discussed in \secref{use:bib:hdg, use:bib:nts, use:fmt} for comparable functionality. Also see \secref{use:cit:nat}.
\item[splitbib]
The \sty{splitbib} package provides support for bibliographies subdivided by topic. See \sty{bibtopic}.
\item[titlesec]
The \sty{titlesec} package redefines user-level document division commands such as \cmd{chapter} or \cmd{section}. This approach is not compatible with internal command changes applied by the \biblatex \opt{refsection}, \opt{refsegment} and \opt{citereset} option settings described in \secref{use:opt:pre:gen}.
\item[ucs]
The \sty{ucs} package provides support for \utf encoded input, but it does so in a way incompatible with \biblatex.
If you get an error about \sty{ucs} being loaded, but you don't load it explicitly in your preamble, check that you don't load \sty{inputenc}'s \file{utf8x} module: \verb|\usepackage[utf8x]{inputenc}| will also load \sty{ucs}.
Instead of \sty{ucs}/\file{utf8x} use a Unicode engine such as \xetex or \luatex if you want full Unicode support. If you use \pdftex or \tex, the Unicode characters predefined by the \latex format are usually enough for many use cases (this is true for \latex from April 2018 or later, in older versions load \sty{inputenc} with the \file{utf8} module) and missing characters can be defined using \cmd{DeclareUnicodeCharacter} or \sty{newunicodechar}'s \cmd{newunicodechar}.
\item[etextools]
The \sty{etextools} package provides enhancements to list macros defined by \sty{etoolbox} and a few other tools for command definitions.
The package redefines list handling macros in a way incompatible with \biblatex.
If you must load the \sty{etextools} package at all costs, define the control sequence \cs{blx@noerroretextools} before you load \biblatex.
If \cs{blx@noerroretextools} is defined, no error will be issued if \sty{etextools} is loaded, the message is degraded to a warning instead.
In that case you need to make sure that all redefined macros used by \biblatex\ (currently only \cmd{forlistloop}) have their original \sty{etoolbox} definitions when \biblatex\ is loaded.
\end{marglist}
\subsubsection{Compatibility Matrix for \biber}
\label{int:pre:bibercompat}
\biber\ versions are closely coupled with \biblatex\ versions. You
need to have the right combination of the two. \biber\ will throw a fatal error
during processing if it encounters information which comes from a
\biblatex\ version which is incompatible. \Tabref{tab:int:pre:bibercompat} shows a
compatibility matrix for the recent versions.
\begin{table}
\caption{\biber/\biblatex\ compatibility matrix}
\label{tab:int:pre:bibercompat}
\tablesetup\centering
\begin{tabular}{cc}
\toprule
\sffamily\bfseries\spotcolor Biber version
& \sffamily\bfseries\spotcolor \biblatex\ version\\
\midrule
2.15 & 3.15\\
2.14 & 3.14\\
2.13 & 3.13\\
2.12 & 3.12\\
2.11 & 3.11\\
2.10 & 3.10\\
2.9 & 3.9\\
2.8 & 3.8\\
2.7 & 3.7\\
2.6 & 3.5, 3.6\\
2.5 & 3.4\\
2.4 & 3.3\\
2.3 & 3.2\\
2.2 & 3.1\\
2.1 & 3.0\\
2.0 & 3.0\\
1.9 & 2.9\\
1.8 & 2.8\\
1.7 & 2.7\\
1.6 & 2.6\\
1.5 & 2.5\\
1.4 & 2.4\\
1.3 & 2.3\\
1.2 & 2.1, 2.2\\
1.1 & 2.1\\
1.0 & 2.0\\
0.9.9 & 1.7x\\
0.9.8 & 1.7x\\
0.9.7 & 1.7x\\
0.9.6 & 1.7x\\
0.9.5 & 1.6x\\
0.9.4 & 1.5x\\
0.9.3 & 1.5x\\
0.9.2 & 1.4x\\
0.9.1 & 1.4x\\
0.9 & 1.4x\\
\bottomrule
\end{tabular}
\end{table}
\section{Database Guide}
\label{bib}
This section describes the default data model defined in the \file{blx-dm.def} file which is part of \path{biblatex}. The data model is defined using the macros documented in \secref{aut:ctm:dm}. It is possible to redefine the data model which both \biblatex and \biber use so that datasources can contain new entrytypes and fields (which of course will need style support). The data model specification also allows for constraints to be defined so that data sources can be validated against the data model (using \biber's \opt{--validate-datamodel} option). Users who want to customise the data model need to look at the \file{blx-dm.def} file and to read \secref{aut:ctm:dm}.
All entry types and field names are given in all-lowercase form here. This is how the entry types and field names are given in the data model. While the \biber/\bibtex input side is case insensitive, the \latex side is case sensitive and uses the exact capitalisation from the data model. This means that the input in the \file{bib} file may use any capitalisation of entry types and field names, but when the fields are used in the \latex document---for example in \cmd{citefield}---the capitalisation must match the captalisation in the data model, for standard types and fields that would be all lowercase.
\subsection{Entry Types}
\label{bib:typ}
This section gives an overview of the entry types supported by the default \biblatex data model along with the fields supported by each type.
\subsubsection{Regular Types}
\label{bib:typ:blx}
The lists below indicate the fields supported by each entry type. Note that the mapping of fields to an entry type is ultimately at the discretion of the bibliography style. The lists below therefore serve two purposes. They indicate the fields supported by the standard styles which come with this package and they also serve as a model for custom styles. Note that the <required> fields are not strictly required in all cases, see \secref{bib:use:key} for details. The fields marked as <optional> are optional in a technical sense. Bibliographical formatting rules usually require more than just the <required> fields. The default data model defined a few constraints for the format of date fields, ISBNs and some special fields like \bibfield{gender} but the constraints are only used if validating against the data model with \biber's \opt{--validate-datamodel} option. Generic fields like \bibfield{abstract} and \bibfield{annotation} or \bibfield{label} and \bibfield{shorthand} are not included in the lists below because they are independent of the entry type. The special fields discussed in \secref{bib:fld:spc}, which are also independent of the entry type, are not included in the lists either. See the default data model specification in the file \file{blx-dm.def} which comes with \biblatex for a complete specification.
The <alias> relation referred to in this subsection is the <soft alias> defined with \cmd{DeclareBibliographyAlias}. That means that the alias will use the same bibliography driver as the type it is aliased to, but that its type-specific formatting is still handled independently of the aliased type.
\begin{typelist}
\typeitem{article}
An article in a journal, magazine, newspaper, or other periodical which forms a self"=contained unit with its own title. The title of the periodical is given in the \bibfield{journaltitle} field. If the issue has its own title in addition to the main title of the periodical, it goes in the \bibfield{issuetitle} field. Note that \bibfield{editor} and related fields refer to the journal while \bibfield{translator} and related fields refer to the article.
\reqitem{author, title, journaltitle, year/date}
\optitem{translator, annotator, commentator, subtitle, titleaddon, editor, editora, editorb, editorc, journalsubtitle, journaltitleaddon, issuetitle, issuesubtitle, issuetitleaddon, language, origlanguage, series, volume, number, eid, issue, month, pages, version, note, issn, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{book}
A single"=volume book with one or more authors where the authors share credit for the work as a whole. This entry type also covers the function of the \bibtype{inbook} type of traditional \bibtex, see \secref{bib:use:inb} for details.
\reqitem{author, title, year/date}
\optitem{editor, editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, language, origlanguage, volume, part, edition, volumes, series, number, note, publisher, location, isbn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{mvbook}
A multi"=volume \bibtype{book}. For backwards compatibility, multi"=volume books are also supported by the entry type \bibtype{book}. However, it is advisable to make use of the dedicated entry type \bibtype{mvbook}.
\reqitem{author, title, year/date}
\optitem{editor, editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, language, origlanguage, edition, volumes, series, number, note, publisher, location, isbn, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{inbook}
A part of a book which forms a self"=contained unit with its own title. Note that the profile of this entry type is different from standard \bibtex, see \secref{bib:use:inb}.
\reqitem{author, title, booktitle, year/date}
\optitem{bookauthor, editor, editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, booksubtitle, booktitleaddon, language, origlanguage, volume, part, edition, volumes, series, number, note, publisher, location, isbn, eid, chapter, pages, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{bookinbook}
This type is similar to \bibtype{inbook} but intended for works originally published as a stand-alone book. A typical example are books reprinted in the collected works of an author.
\typeitem{suppbook}
Supplemental material in a \bibtype{book}. This type is closely related to the \bibtype{inbook} entry type. While \bibtype{inbook} is primarily intended for a part of a book with its own title (\eg a single essay in a collection of essays by the same author), this type is provided for elements such as prefaces, introductions, forewords, afterwords, etc. which often have a generic title only. Style guides may require such items to be formatted differently from other \bibtype{inbook} items. The standard styles will treat this entry type as an alias for \bibtype{inbook}.
\typeitem{booklet}
A book"=like work without a formal publisher or sponsoring institution. Use the field \bibfield{howpublished} to supply publishing information in free format, if applicable. The field \bibfield{type} may be useful as well.
\reqitem{author/editor, title, year/date}
\optitem{subtitle, titleaddon, language, howpublished, type, note, location, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{collection}
A single"=volume collection with multiple, self"=contained contributions by distinct authors which have their own title. The work as a whole has no overall author but it will usually have an editor.
\reqitem{editor, title, year/date}
\optitem{editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, language, origlanguage, volume, part, edition, volumes, series, number, note, publisher, location, isbn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{mvcollection}
A multi"=volume \bibtype{collection}. For backwards compatibility, multi"=volume collections are also supported by the entry type \bibtype{collection}. However, it is advisable to make use of the dedicated entry type \bibtype{mvcollection}.
\reqitem{editor, title, year/date}
\optitem{editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, language, origlanguage, edition, volumes, series, number, note, publisher, location, isbn, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{incollection}
A contribution to a collection which forms a self"=contained unit with a distinct author and title. The \bibfield{author} refers to the \bibfield{title}, the \bibfield{editor} to the \bibfield{booktitle}, \ie the title of the collection.
\reqitem{author, title, booktitle, year/date}
\optitem{editor, editora, editorb, editorc, translator, annotator, commentator, introduction, foreword, afterword, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, booksubtitle, booktitleaddon, language, origlanguage, volume, part, edition, volumes, series, number, note, publisher, location, isbn, eid, chapter, pages, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{suppcollection}
Supplemental material in a \bibtype{collection}. This type is similar to \bibtype{suppbook} but related to the \bibtype{collection} entry type. The standard styles will treat this entry type as an alias for \bibtype{incollection}.
\typeitem{dataset}
A data set or a similar collection of (mostly) raw data.
\reqitem{author/editor, title, year/date}
\optitem{subtitle, titleaddon, language, edition, type, series, number, version, note, organization, publisher, location, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{manual}
Technical or other documentation, not necessarily in printed form. The \bibfield{author} or \bibfield{editor} is omissible in terms of \secref{bib:use:key}.
\reqitem{author/editor, title, year/date}
\optitem{subtitle, titleaddon, language, edition, type, series, number, version, note, organization, publisher, location, isbn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{misc}
A fallback type for entries which do not fit into any other category. Use the field \bibfield{howpublished} to supply publishing information in free format, if applicable. The field \bibfield{type} may be useful as well. \bibfield{author}, \bibfield{editor}, and \bibfield{year} are omissible in terms of \secref{bib:use:key}.
\reqitem{author/editor, title, year/date}
\optitem{subtitle, titleaddon, language, howpublished, type, version, note, organization, location, month, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{online}
An online resource. \bibfield{author}, \bibfield{editor}, and \bibfield{year} are omissible in terms of \secref{bib:use:key}. This entry type is intended for sources such as web sites which are intrinsically online resources. Note that all entry types support the \bibfield{url} field. For example, when adding an article from an online journal, it may be preferable to use the \bibtype{article} type and its \bibfield{url} field.
\reqitem{author/editor, title, year/date, doi/eprint/url}
\optitem{subtitle, titleaddon, language, version, note, organization, month, addendum, pubstate, eprintclass, eprinttype, urldate}
\typeitem{patent}
A patent or patent request. The number or record token is given in the \bibfield{number} field. Use the \bibfield{type} field to specify the type and the \bibfield{location} field to indicate the scope of the patent, if different from the scope implied by the \bibfield{type}. Note that the \bibfield{location} field is treated as a key list with this entry type, see \secref{bib:fld:typ} for details.
\reqitem{author, title, number, year/date}
\optitem{holder, subtitle, titleaddon, type, version, location, note, month, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{periodical}
An complete issue of a periodical, such as a special issue of a journal. The title of the periodical is given in the \bibfield{title} field. If the issue has its own title in addition to the main title of the periodical, it goes in the \bibfield{issuetitle} field. The \bibfield{editor} is omissible in terms of \secref{bib:use:key}.
\reqitem{editor, title, year/date}
\optitem{editora, editorb, editorc, subtitle, titleaddon, issuetitle, issuesubtitle, issuetitleaddon, language, series, volume, number, issue, month, note, issn, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{suppperiodical}
Supplemental material in a \bibtype{periodical}. This type is similar to \bibtype{suppbook} but related to the \bibtype{periodical} entry type. The role of this entry type may be more obvious if you bear in mind that the \bibtype{article} type could also be called \bibtype{inperiodical}. This type may be useful when referring to items such as regular columns, obituaries, letters to the editor, etc. which only have a generic title. Style guides may require such items to be formatted differently from articles in the strict sense of the word. The standard styles will treat this entry type as an alias for \bibtype{article}.
\typeitem{proceedings}
A single"=volume conference proceedings. This type is very similar to \bibtype{collection}. It supports an optional \bibfield{organization} field which holds the sponsoring institution. The \bibfield{editor} is omissible in terms of \secref{bib:use:key}.
\reqitem{title, year/date}
\optitem{editor, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, eventtitle, eventtitleaddon, eventdate, venue, language, volume, part, volumes, series, number, note, organization, publisher, location, month, isbn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{mvproceedings}
A multi"=volume \bibtype{proceedings} entry. For backwards compatibility, multi"=volume proceedings are also supported by the entry type \bibtype{proceedings}. However, it is advisable to make use of the dedicated entry type \bibtype{mvproceedings}
\reqitem{title, year/date}
\optitem{editor, subtitle, titleaddon, eventtitle, eventtitleaddon, eventdate, venue, language, volumes, series, number, note, organization, publisher, location, month, isbn, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{inproceedings}
An article in a conference proceedings. This type is similar to \bibtype{incollection}. It supports an optional \bibfield{organization} field.
\reqitem{author, title, booktitle, year/date}
\optitem{editor, subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, booksubtitle, booktitleaddon, eventtitle, eventtitleaddon, eventdate, venue, language, volume, part, volumes, series, number, note, organization, publisher, location, month, isbn, eid, chapter, pages, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{reference}
A single"=volume work of reference such as an encyclopedia or a dictionary. This is a more specific variant of the generic \bibtype{collection} entry type. The standard styles will treat this entry type as an alias for \bibtype{collection}.
\typeitem{mvreference}
A multi"=volume \bibtype{reference} entry. The standard styles will treat this entry type as an alias for \bibtype{mvcollection}. For backwards compatibility, multi"=volume references are also supported by the entry type \bibtype{reference}. However, it is advisable to make use of the dedicated entry type \bibtype{mvreference}.
\typeitem{inreference}
An article in a work of reference. This is a more specific variant of the generic \bibtype{incollection} entry type. The standard styles will treat this entry type as an alias for \bibtype{incollection}.
\typeitem{report}
A technical report, research report, or white paper published by a university or some other institution. Use the \bibfield{type} field to specify the type of report. The sponsoring institution goes in the \bibfield{institution} field.
\reqitem{author, title, type, institution, year/date}
\optitem{subtitle, titleaddon, language, number, version, note, location, month, isrn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{set}
An entry set. This entry type is special, see \secref{use:use:set} for details.
\typeitem{software}
Computer software. The standard styles will treat this entry type as an alias for \bibtype{misc}.
\typeitem{thesis}
A thesis written for an educational institution to satisfy the requirements for a degree. Use the \bibfield{type} field to specify the type of thesis.
\reqitem{author, title, type, institution, year/date}
\optitem{subtitle, titleaddon, language, note, location, month, isbn, eid, chapter, pages, pagetotal, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{unpublished}
A work with an author and a title which has not been formally published, such as a manuscript or the script of a talk. Use the fields \bibfield{howpublished} and \bibfield{note} to supply additional information in free format, if applicable.
\reqitem{author, title, year/date}
\optitem{subtitle, titleaddon, type, eventtitle, eventtitleaddon, eventdate, venue, language, howpublished, note, location, isbn, month, addendum, pubstate, doi, eprint, eprintclass, eprinttype, url, urldate}
\typeitem{xdata}
This entry type is special. \bibtype{xdata} entries hold data which may be inherited by other entries using the \bibfield{xdata} field. Entries of this type only serve as data containers; they may not be cited or added to the bibliography. See \secref{use:use:xdat} for details.
\typeitem{custom[a--f]}
Custom types for special bibliography styles. The standard styles defined no bibliography drivers for these types and will fall back to using the driver for \bibtype{misc}.
\end{typelist}
\subsubsection{Type Aliases}
\label{bib:typ:als}
The entry types listed in this section are provided for backwards compatibility with traditional \bibtex styles. These aliases are resolved by the backend as the data is processed. Bibliography styles will see the entry type the alias points to, not the alias name. This <hard alias> is unlike the <soft alias> relation in the previous subsection. The relevant mappings for the \opt{bibtex} driver can be found in~\secref{apx:maps:bibtex}.
\begin{typelist}
\typeitem{conference} A legacy alias for \bibtype{inproceedings}.
\typeitem{electronic} An alias for \bibtype{online}.
\typeitem{mastersthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localised term <Master's thesis>. You may still use the \bibfield{type} field to override that.
\typeitem{phdthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localised term <PhD thesis>. You may still use the \bibfield{type} field to override that.
\typeitem{techreport} Similar to \bibtype{report} except that the \bibfield{type} field is optional and defaults to the localised term <technical report>. You may still use the \bibfield{type} field to override that.
\typeitem{www}
An alias for \bibtype{online}, provided for \sty{jurabib} compatibility.
\end{typelist}
\subsubsection{Non-standard Types}
\label{bib:typ:ctm}
The types in this section are similar to the custom types \bibtype{custom[a--f]}, \ie the standard bibliography styles provide no bibliography drivers for these types. In the standard styles they will use the bibliography driver for \bibtype{misc} entries---exceptions to this rule are noted in the descriptions below. The types are known to the default data model and will be happily accepted by \biber.
\begin{typelist}
\typeitem{artwork}
Works of the visual arts such as paintings, sculpture, and installations.
\typeitem{audio}
Audio recordings, typically on audio \acr{CD}, \acr{DVD}, audio cassette, or similar media. See also \bibtype{music}.
\typeitem{bibnote}
This special entry type is not meant to be used in the \file{bib} file like other types. It is provided for third-party packages like \sty{notes2bib} which merge notes into the bibliography. The notes should go into the \bibfield{note} field. Be advised that the \bibtype{bibnote} type is not related to the \cmd{defbibnote} command in any way. \cmd{defbibnote} is for adding comments at the beginning or the end of the bibliography, whereas the \bibtype{bibnote} type is meant for packages which render endnotes as bibliography entries.
\typeitem{commentary}
Commentaries which have a status different from regular books, such as legal commentaries.
\typeitem{image}
Images, pictures, photographs, and similar media.
\typeitem{jurisdiction}
Court decisions, court recordings, and similar things.
\typeitem{legislation}
Laws, bills, legislative proposals, and similar things.
\typeitem{legal}
Legal documents such as treaties.
\typeitem{letter}
Personal correspondence such as letters, emails, memoranda, etc.
\typeitem{movie}
Motion pictures. See also \bibtype{video}.
\typeitem{music}
Musical recordings. This is a more specific variant of \bibtype{audio}.
\typeitem{performance}
Musical and theatrical performances as well as other works of the performing arts. This type refers to the event as opposed to a recording, a score, or a printed play.
\typeitem{review}
Reviews of some other work. This is a more specific variant of the \bibtype{article} type. The standard styles will treat this entry type as an alias for \bibtype{article}.
\typeitem{standard}
National and international standards issued by a standards body such as the International Organization for Standardization.
\typeitem{video}
Audiovisual recordings, typically on \acr{DVD}, \acr{VHS} cassette, or similar media. See also \bibtype{movie}.
\end{typelist}
\subsection{Entry Fields}
\label{bib:fld}
This section gives an overview of the fields supported by the \biblatex default data model. See \secref{bib:fld:typ} for an introduction to the data types used by the data model specification and \secref{bib:fld:dat, bib:fld:spc} for the actual field listings.
\subsubsection{Data Types}
\label{bib:fld:typ}
In datasources such as a \file{bib} file, all bibliographic data is specified in fields. Some of those fields, for example \bibfield{author} and \bibfield{editor}, may contain a list of items. This list structure is implemented by the \bibtex file format via the keyword <|and|>, which is used to separate the individual items in the list. The \biblatex package implements three distinct data types to handle bibliographic data: name lists, literal lists, and fields. There are also several list and field subtypes and a content type which can be used to semantically distinguish fields which are otherwise not distinguishable on the basis of only their datatype (see \secref{aut:ctm:dm}). This section gives an overview of the data types supported by this package. See \secref{bib:fld:dat, bib:fld:spc} for information about the mapping of the \bibtex file format fields to \biblatex's data types.
\begin{description}
\item[Name lists] are parsed and split up into the individual items at the \texttt{and} delimiter. Each item in the list is then dissected into the name part components: by default the given name, the name prefix (von, van, of, da, de, della, \dots), the family name, and the name suffix (junior, senior, \dots). The valid name parts can be customised by changing the datamodel definition described in \secref{aut:bbx:drv}. Name lists may be truncated in the \file{bib} file with the keyword <\texttt{and others}>. Typical examples of name lists are \bibfield{author} and \bibfield{editor}.
Name list fields automatically have an \cmd{ifuse*} test created as per the name lists in the default data model (see \secref{aut:aux:tst}). They are also automatically have a \opt{ifuse*} option created which controls labelling and sorting behaviour with the name (see \secref{use:opt:bib:hyb}). \biber supports a customisable set of name parts but currently this is defined to be the same set of parts as supported by traditional \bibtex:
\begin{itemize}
\item Family name (also known as <last> part)
\item Given name (also known as <first> part)
\item Name prefix (also known as <von> part)
\item Name suffix (also known as <Jr> part)
\end{itemize}
The supported list of name parts is defined as a constant list in the default data model using the \cmd{DeclareDatamodelConstant} command (see \ref{aut:ctm:dm}). However, it is not enough to simply add to this list in order to add support for another name part as name parts typically have to be hard coded into bibliography drivers and the backend processing. See the example file \file{93-nameparts.tex} for details on how to define and use custom name parts. Also see \cmd{DeclareUniquenameTemplate} in \secref{aut:cav:amb} for information on how to customise name disambiguation using custom name parts.
\item[Literal lists] are parsed and split up into the individual items at the \texttt{and} delimiter but not dissected further. Literal lists may be truncated in the \file{bib} file with the keyword <\texttt{and others}>. There are two subtypes:
\begin{description}
\item[Literal lists] in the strict sense are handled as described above. The individual items are simply printed as is. Typical examples of such literal lists are \bibfield{publisher} and \bibfield{location}.
\item[Key lists] are a variant of literal lists which may hold printable data or localisation keys. For each item in the list, styles should perform a test to determine whether it is a known localisation key (the localisation keys defined by default are listed in \secref{aut:lng:key}). If so, the localised string should be printed. If not, the item should be printed as is. The standard styles are set up to exhibit this behaviour for all key lists listed below. New key lists do not automatically perform this test, it has to be implemented explicitly via the list format. A typical example of a key list is \bibfield{language}.
\end{description}
\end{description}
\begin{description}
\item[Fields] are usually printed as a whole. There are several subtypes:
\begin{description}
\item[Literal fields] are printed as is. Typical examples of literal fields are \bibfield{title} and \bibfield{note}.
\item[Range fields] consist of one or more ranges where all dashes are normalized and replaced by the command \cmd{bibrangedash}. A range is something optionally followed by one or more dashes optionally followed by some non-dash (e.g. \texttt{5--7}). Any number of consecutive dashes will only yield a single range dash. A typical example of a range field is the \bibfield{pages} field. See also the \cmd{bibrangessep} command which can be used to customise the separator between multiple ranges. Range fields will be skipped and will generate a warning if they do not consist of one or more ranges. You can normalise messy range fields before they are parsed using \cmd{DeclareSourcemap} (see \secref{aut:ctm:map}).
\item[Integer fields] hold integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{extradate} or \bibfield{volume} field. Such fields are sorted as integers. \biber makes a (quite serious) effort to map non-arabic representations (roman numerals for example) to integers for sorting purposes. See the \opt{noroman} option which can be used to suppress roman numeral parsing. This can help in cases where there is an ambiguity between parsing as roman numerals or alphanumeric (e.g. <C>), see \secref{use:opt:pre:int}.
\item[Datepart fields] hold unformatted integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{month} field. For every field of datatype \bibfield{date} in the datamodel, datepart fields are automatically created with the following names: \bibfield{$<$datetype$>$year}, \bibfield{$<$datetype$>$endyear}, \bibfield{$<$datetype$>$month}, \bibfield{$<$datetype$>$endmonth}, \bibfield{$<$datetype$>$day}, \bibfield{$<$datetype$>$endday}, \bibfield{$<$datetype$>$hour}, \bibfield{$<$datetype$>$endhour}, \bibfield{$<$datetype$>$minute}, \bibfield{$<$datetype$>$endminute}, \bibfield{$<$datetype$>$second}, \bibfield{$<$datetype$>$endsecond}, \bibfield{$<$datetype$>$timezone}, \bibfield{$<$datetype$>$endtimezone}. $<$datetype$>$ is the string preceding <date> for any datamodel field of \kvopt{datatype}{date}. For example, in the default datamodel, <event>, <orig>, <url> and the empty string <> for the date field \bibfield{date}.
\item[Date fields] hold a date specification in \texttt{yyyy-mm-ddThh:nn[+|-][hh[:nn]|Z]} format or a date range in \texttt{yyyy-mm-ddThh:nn[+|-][hh[:nn]|Z]/yyyy-mm-ddThh:nn[+|-][hh[:nn]|Z]} format and other formats permitted by \acr{ISO8601-2} Clause 4, level 1, see \secref{bib:use:dat}. Date fields are special in that the date is parsed and split up into its datepart type components. The \bibfield{datepart} components (see above) are automatically defined and recognised when a field of datatype \bibfield{date} is defined in the datamodel. A typical example is the \bibfield{date} field.
\item[Verbatim fields] are processed in verbatim mode and may contain special characters. Typical examples of verbatim fields are \bibfield{file} and \bibfield{doi}.
\item[URI fields] are processed in verbatim mode and may contain special characters. They are also URL-escaped if they don't look like they already are. The typical example of a uri field is \bibfield{url}.
\item[Separated value fields] A separated list of literal values. Examples are the \bibfield{keywords} and \bibfield{options} fields. The separator can be configured to be any Perl regular expression via the \opt{xsvsep} option which defaults to the usual \bibtex comma surrounded by optional whitespace.
\item[Pattern fields] A literal field which must match a particular pattern. An example is the \bibfield{gender} field from \secref{bib:fld:spc}.
\item[Key fields] May hold printable data or localisation keys. Styles should perform a test to determine whether the value of the field is a known localisation key (the localisation keys defined by default are listed in \secref{aut:lng:key}). If so, the localised string should be printed. If not, the value should be printed as is. The standard styles are set up to handle all key fields listed below in that way. New key fields do not automatically perform the test, it has to be enabled explicitly in the field format. A typical example is the \bibfield{type} field.
\item[Code fields] Holds \tex code.
\end{description}
\end{description}
\subsubsection{Data Fields}
\label{bib:fld:dat}
The fields listed in this section are the regular ones holding printable data in the default data model. The name on the left is the default data model name of the field as used by \biblatex and its backend. The \biblatex data type is given to the right of the name. See \secref{bib:fld:typ} for explanation of the various data types.
Some fields are marked as <label> fields which means that they are often used as abbreviation labels when printing bibliography lists in the sense of section \secref{use:bib:biblist}. \biblatex automatically creates supporting macros for such fields. See \secref{use:bib:biblist}.
\begin{fieldlist}
\fielditem{abstract}{literal}
This field is intended for recording abstracts in a \file{bib} file, to be printed by a special bibliography style. It is not used by all standard bibliography styles.
\fielditem{addendum}{literal}
Miscellaneous bibliographic data to be printed at the end of the entry. This is similar to the \bibfield{note} field except that it is printed at the end of the bibliography entry.
\listitem{afterword}{name}
The author(s) of an afterword to the work. If the author of the afterword is identical to the \bibfield{editor} and\slash or \bibfield{translator}, the standard styles will automatically concatenate these fields in the bibliography. See also \bibfield{introduction} and \bibfield{foreword}.
\fielditem{annotation}{literal}
This field may be useful when implementing a style for annotated bibliographies. It is not used by all standard bibliography styles. Note that this field is completely unrelated to \bibfield{annotator}. The \bibfield{annotator} is the author of annotations which are part of the work cited.
\listitem{annotator}{name}
The author(s) of annotations to the work. If the annotator is identical to the \bibfield{editor} and\slash or \bibfield{translator}, the standard styles will automatically concatenate these fields in the bibliography. See also \bibfield{commentator}.
\listitem{author}{name}
The author(s) of the \bibfield{title}.
\fielditem{authortype}{key}
The type of author. This field will affect the string (if any) used to introduce the author. Not used by the standard bibliography styles.
\listitem{bookauthor}{name}
The author(s) of the \bibfield{booktitle}.
\fielditem{bookpagination}{key}
If the work is published as part of another one, this is the pagination scheme of the enclosing work, \ie \bibfield{bookpagination} relates to \bibfield{pagination} like \bibfield{booktitle} to \bibfield{title}. The value of this field will affect the formatting of the \bibfield{pages} and \bibfield{pagetotal} fields. The key should be given in the singular form. Possible keys are \texttt{page}, \texttt{column}, \texttt{line}, \texttt{verse}, \texttt{section}, and \texttt{paragraph}. See also \bibfield{pagination} as well as \secref{bib:use:pag}.
\fielditem{booksubtitle}{literal}
The subtitle related to the \bibfield{booktitle}. If the \bibfield{subtitle} field refers to a work which is part of a larger publication, a possible subtitle of the main work is given in this field. See also \bibfield{subtitle}.
\fielditem{booktitle}{literal}
If the \bibfield{title} field indicates the title of a work which is part of a larger publication, the title of the main work is given in this field. See also \bibfield{title}.
\fielditem{booktitleaddon}{literal}
An annex to the \bibfield{booktitle}, to be printed in a different font.
\fielditem{chapter}{literal}
A chapter or section or any other unit of a work.
\listitem{commentator}{name}
The author(s) of a commentary to the work. Note that this field is intended for commented editions which have a commentator in addition to the author. If the work is a stand"=alone commentary, the commentator should be given in the \bibfield{author} field. If the commentator is identical to the \bibfield{editor} and\slash or \bibfield{translator}, the standard styles will automatically concatenate these fields in the bibliography. See also \bibfield{annotator}.
\fielditem{date}{date}
The publication date. See also \bibfield{month} and \bibfield{year} as well as \secref{bib:use:dat,bib:use:yearordate}.
\fielditem{doi}{verbatim}
The Digital Object Identifier of the work.
\fielditem{edition}{integer or literal}
The edition of a printed publication. This must be an integer, not an ordinal. Don't say |edition={First}| or |edition={1st}| but |edition={1}|. The bibliography style converts this to a language dependent ordinal. It is also possible to give the edition as a literal string, for example «Third, revised and expanded edition».
\listitem{editor}{name}
The editor(s) of the \bibfield{title}, \bibfield{booktitle}, or \bibfield{maintitle}, depending on the entry type. Use the \bibfield{editortype} field to specify the role if it is different from <\texttt{editor}>. See \secref{bib:use:edr} for further hints.
\listitem{editora}{name}
A secondary editor performing a different editorial role, such as compiling, redacting, etc. Use the \bibfield{editoratype} field to specify the role. See \secref{bib:use:edr} for further hints.
\listitem{editorb}{name}
Another secondary editor performing a different role. Use the \bibfield{editorbtype} field to specify the role. See \secref{bib:use:edr} for further hints.
\listitem{editorc}{name}
Another secondary editor performing a different role. Use the \bibfield{editorctype} field to specify the role. See \secref{bib:use:edr} for further hints.
\fielditem{editortype}{key}
The type of editorial role performed by the \bibfield{editor}. Roles supported by default are \texttt{editor}, \texttt{compiler}, \texttt{founder}, \texttt{continuator}, \texttt{redactor}, \texttt{reviser}, \texttt{collaborator}, \texttt{organizer}. The role <\texttt{editor}> is the default. In this case, the field is omissible. See \secref{bib:use:edr} for further hints.
\fielditem{editoratype}{key}
Similar to \bibfield{editortype} but referring to the \bibfield{editora} field. See \secref{bib:use:edr} for further hints.
\fielditem{editorbtype}{key}
Similar to \bibfield{editortype} but referring to the \bibfield{editorb} field. See \secref{bib:use:edr} for further hints.
\fielditem{editorctype}{key}
Similar to \bibfield{editortype} but referring to the \bibfield{editorc} field. See \secref{bib:use:edr} for further hints.
\fielditem{eid}{literal}
The electronic identifier of an \bibtype{article} or chapter-like section of a larger work. This field may replace the \bibfield{pages} field for journals deviating from the classic pagination scheme of printed journals by only enumerating articles or papers and not pages.
\fielditem{entrysubtype}{literal}
This field, which is not used by the standard styles, may be used to specify a subtype of an entry type. This may be useful for bibliography styles which support a finer"=grained set of entry types.
\fielditem{eprint}{verbatim}
The electronic identifier of an online publication. This is roughly comparable to a \acr{doi} but specific to a certain archive, repository, service, or system. See \secref{use:use:epr} for details. Also see \bibfield{eprinttype} and \bibfield{eprintclass}.
\fielditem{eprintclass}{literal}
Additional information related to the resource indicated by the \bibfield{eprinttype} field. This could be a section of an archive, a path indicating a service, a classification of some sort, etc. See \secref{use:use:epr} for details. Also see \bibfield{eprint} and \bibfield{eprinttype}.
\fielditem{eprinttype}{literal}
The type of \bibfield{eprint} identifier, \eg the name of the archive, repository, service, or system the \bibfield{eprint} field refers to. See \secref{use:use:epr} for details. Also see \bibfield{eprint} and \bibfield{eprintclass}.
\fielditem{eventdate}{date}
The date of a conference, a symposium, or some other event in \bibtype{proceedings} and \bibtype{inproceedings} entries. This field may also be useful for the custom types listed in \secref{bib:typ:ctm}. See also \bibfield{eventtitle} and \bibfield{venue} as well as \secref{bib:use:dat}.
\fielditem{eventtitle}{literal}
The title of a conference, a symposium, or some other event in \bibtype{proceedings} and \bibtype{inproceedings} entries. This field may also be useful for the custom types listed in \secref{bib:typ:ctm}. Note that this field holds the plain title of the event. Things like «Proceedings of the Fifth XYZ Conference» go into the \bibfield{titleaddon} or \bibfield{booktitleaddon} field, respectively. See also \bibfield{eventdate} and \bibfield{venue}.
\fielditem{eventtitleaddon}{literal}
An annex to the \bibfield{eventtitle} field. Can be used for known event acronyms, for example.
\fielditem{file}{verbatim}
A local link to a \acr{pdf} or other version of the work. Not used by the standard bibliography styles.
\listitem{foreword}{name}
The author(s) of a foreword to the work. If the author of the foreword is identical to the \bibfield{editor} and\slash or \bibfield{translator}, the standard styles will automatically concatenate these fields in the bibliography. See also \bibfield{introduction} and \bibfield{afterword}.
\listitem{holder}{name}
The holder(s) of a \bibtype{patent}, if different from the \bibfield{author}. Note that corporate holders need to be wrapped in an additional set of braces, see \secref{bib:use:inc} for details. This list may also be useful for the custom types listed in \secref{bib:typ:ctm}.
\fielditem{howpublished}{literal}
A publication notice for unusual publications which do not fit into any of the common categories.
\fielditem{indextitle}{literal}
A title to use for indexing instead of the regular \bibfield{title} field. This field may be useful if you have an entry with a title like «An Introduction to \dots» and want that indexed as «Introduction to \dots, An». Style authors should note that \biblatex automatically copies the value of the \bibfield{title} field to \bibfield{indextitle} if the latter field is undefined.
\listitem{institution}{literal}
The name of a university or some other institution, depending on the entry type. Traditional \bibtex uses the field name \bibfield{school} for theses, which is supported as an alias. See also \secref{bib:fld:als, bib:use:and}.
\listitem{introduction}{name}
The author(s) of an introduction to the work. If the author of the introduction is identical to the \bibfield{editor} and\slash or \bibfield{translator}, the standard styles will automatically concatenate these fields in the bibliography. See also \bibfield{foreword} and \bibfield{afterword}.
\fielditem{isan}{literal}
The International Standard Audiovisual Number of an audiovisual work. Not used by the standard bibliography styles.
\fielditem{isbn}{literal}
The International Standard Book Number of a book.
\fielditem{ismn}{literal}
The International Standard Music Number for printed music such as musical scores. Not used by the standard bibliography styles.
\fielditem{isrn}{literal}
The International Standard Technical Report Number of a technical report.
\fielditem{issn}{literal}
The International Standard Serial Number of a periodical.
\fielditem{issue}{literal}
The issue of a journal. This field is intended for journals whose individual issues are identified by a designation such as <Spring> or <Summer> rather than the month or a number. The placement of \bibfield{issue} is similar to \bibfield{month} and \bibfield{number}. Integer ranges and short designators are better written to the \bibfield{number} field. See also \bibfield{month}, \bibfield{number} and \secref{bib:use:iss, bib:use:issnum}.
\fielditem{issuesubtitle}{literal}
The subtitle of a specific issue of a journal or other periodical.
\fielditem{issuetitle}{literal}
The title of a specific issue of a journal or other periodical.
\fielditem{issuetitleaddon}{literal}
An annex to the \bibfield{issuetitle}, to be printed in a different font.
\fielditem{iswc}{literal}
The International Standard Work Code of a musical work. Not used by the standard bibliography styles.
\fielditem{journalsubtitle}{literal}
The subtitle of a journal, a newspaper, or some other periodical.
\fielditem{journaltitle}{literal}
The name of a journal, a newspaper, or some other periodical.
\fielditem{journaltitleaddon}{literal}
An annex to the \bibfield{journaltitle}, to be printed in a different font.
\fielditem{label}{literal}
A designation to be used by the citation style as a substitute for the regular label if any data required to generate the regular label is missing. For example, when an author"=year citation style is generating a citation for an entry which is missing the author or the year, it may fall back to \bibfield{label}. See \secref{bib:use:key} for details. Note that, in contrast to \bibfield{shorthand}, \bibfield{label} is only used as a fallback. See also \bibfield{shorthand}.
\listitem{language}{key}
The language(s) of the work. Languages may be specified literally or as localisation keys. If localisation keys are used, the prefix \texttt{lang} is omissible. See also \bibfield{origlanguage} and compare \bibfield{langid} in \secref{bib:fld:spc}.
\fielditem{library}{literal}
This field may be useful to record information such as a library name and a call number. This may be printed by a special bibliography style if desired. Not used by the standard bibliography styles.
\listitem{location}{literal}
The place(s) of publication, \ie the location of the \bibfield{publisher} or \bibfield{institution}, depending on the entry type. Traditional \bibtex uses the field name \bibfield{address}, which is supported as an alias. See also \secref{bib:fld:als, bib:use:and}. With \bibtype{patent} entries, this list indicates the scope of a patent. This list may also be useful for the custom types listed in \secref{bib:typ:ctm}.
\fielditem{mainsubtitle}{literal}
The subtitle related to the \bibfield{maintitle}. See also \bibfield{subtitle}.
\fielditem{maintitle}{literal}
The main title of a multi"=volume book, such as \emph{Collected Works}. If the \bibfield{title} or \bibfield{booktitle} field indicates the title of a single volume which is part of multi"=volume book, the title of the complete work is given in this field.
\fielditem{maintitleaddon}{literal}
An annex to the \bibfield{maintitle}, to be printed in a different font.
\fielditem{month}{literal}
The publication month. This must be an integer, not an ordinal or a string. Don't say |month={January}| but |month={1}|. The bibliography style converts this to a language dependent string or ordinal where required. This field is a literal field only when given
explicitly in the data (for plain \bibtex compatibility for example). It is
however better to use the \bibfield{date} field as this supports many more features. See \secref{bib:use:dat,bib:use:yearordate}.
\fielditem{nameaddon}{literal}
An addon to be printed immediately after the author name in the bibliography. Not used by the standard bibliography styles. This field may be useful to add an alias or pen name (or give the real name if the pseudonym is commonly used to refer to that author).
\fielditem{note}{literal}
Miscellaneous bibliographic data which does not fit into any other field. The \bibfield{note} field may be used to record bibliographic data in a free format. Publication facts such as «Reprint of the edition London 1831» are typical candidates for the \bibfield{note} field. See also \bibfield{addendum}.
\fielditem{number}{literal}
The number of a journal or the volume\slash number of a book in a \bibfield{series}. See also \bibfield{issue} as well as \secref{bib:use:ser, bib:use:iss, bib:use:issnum}. With \bibtype{patent} entries, this is the number or record token of a patent or patent request. Normally this field will be an integer or an integer range, but it may also be a short designator that is not entirely numeric such as «S1», «Suppl.\ 2», «3es». In these cases the output should be scrutinised carefully.
Since \bibfield{number} is---maybe counterintuitively given its name---a literal field, sorting templates will not treat its contents as integers, but as literal strings, which means that «11» may sort between «1» and «2». If integer sorting is desired, the field can be declared an integer field in a custom data model (see \secref{aut:ctm:dm}). But then the sorting of non-integer values is not well defined.
\listitem{organization}{literal}
The organization(s) that published a \bibtype{manual} or an \bibtype{online} resource, or sponsored a conference. See also \secref{bib:use:and}.
\fielditem{origdate}{date}
If the work is a translation, a reprint, or something similar, the publication date of the original edition. Not used by the standard bibliography styles. See also \bibfield{date}.
\listitem{origlanguage}{key}
If the work is a translation, the language(s) of the original work. See also \bibfield{language}.
\listitem{origlocation}{literal}
If the work is a translation, a reprint, or something similar, the \bibfield{location} of the original edition. Not used by the standard bibliography styles. See also \bibfield{location} and \secref{bib:use:and}.
\listitem{origpublisher}{literal}
If the work is a translation, a reprint, or something similar, the \bibfield{publisher} of the original edition. Not used by the standard bibliography styles. See also \bibfield{publisher} and \secref{bib:use:and}.
\fielditem{origtitle}{literal}
If the work is a translation, the \bibfield{title} of the original work. Not used by the standard bibliography styles. See also \bibfield{title}.
\fielditem{pages}{range}
One or more page numbers or page ranges. If the work is published as part of another one, such as an article in a journal or a collection, this field holds the relevant page range in that other work. It may also be used to limit the reference to a specific part of a work (a chapter in a book, for example). For papers in electronic journals with a non-classical pagination setup the \bibfield{eid} field may be more suitable.
\fielditem{pagetotal}{literal}
The total number of pages of the work.
\fielditem{pagination}{key}
The pagination of the work. The value of this field will affect the formatting the \prm{postnote} argument to a citation command. The key should be given in the singular form. Possible keys are \texttt{page}, \texttt{column}, \texttt{line}, \texttt{verse}, \texttt{section}, and \texttt{paragraph}. See also \bibfield{bookpagination} as well as \secref{bib:use:pag, use:cav:pag}.
\fielditem{part}{literal}
The number of a partial volume. This field applies to books only, not to journals. It may be used when a logical volume consists of two or more physical ones. In this case the number of the logical volume goes in the \bibfield{volume} field and the number of the part of that volume in the \bibfield{part} field. See also \bibfield{volume}.
\listitem{publisher}{literal}
The name(s) of the publisher(s). See also \secref{bib:use:and}.
\fielditem{pubstate}{key}
The publication state of the work, \eg\ <in press>. See \secref{aut:lng:key:pst} for known publication states.
\fielditem{reprinttitle}{literal}
The title of a reprint of the work. Not used by the standard styles.
\fielditem{series}{literal}
The name of a publication series, such as «Studies in \dots», or the number of a journal series. Books in a publication series are usually numbered. The number or volume of a book in a series is given in the \bibfield{number} field. Note that the \bibtype{article} entry type makes use of the \bibfield{series} field as well, but handles it in a special way. See \secref{bib:use:ser} for details.
\listitem{shortauthor}{name\LFMark}
The author(s) of the work, given in an abbreviated form. This field is mainly intended for abbreviated forms of corporate authors, see \secref{bib:use:inc} for details.
\listitem{shorteditor}{name\LFMark}
The editor(s) of the work, given in an abbreviated form. This field is mainly intended for abbreviated forms of corporate editors, see \secref{bib:use:inc} for details.
\fielditem{shorthand}{literal\LFMark}
A special designation to be used by the citation style instead of the usual label. If defined, it overrides the default label. See also \bibfield{label}.
\fielditem{shorthandintro}{literal}
The verbose citation styles which comes with this package use a phrase like «henceforth cited as [shorthand]» to introduce shorthands on the first citation. If the \bibfield{shorthandintro} field is defined, it overrides the standard phrase. Note that the alternative phrase must include the shorthand.
\fielditem{shortjournal}{literal\LFMark}
A short version or an acronym of the \bibfield{journaltitle}. Not used by the standard bibliography styles.
\fielditem{shortseries}{literal\LFMark}
A short version or an acronym of the \bibfield{series} field. Not used by the standard bibliography styles.
\fielditem{shorttitle}{literal\LFMark}
The title in an abridged form. This field is usually not included in the bibliography. It is intended for citations in author"=title format. If present, the author"=title citation styles use this field instead of \bibfield{title}.
\fielditem{subtitle}{literal}
The subtitle of the work.
\fielditem{title}{literal}
The title of the work.
\fielditem{titleaddon}{literal}
An annex to the \bibfield{title}, to be printed in a different font.
\listitem{translator}{name}
The translator(s) of the \bibfield{title} or \bibfield{booktitle}, depending on the entry type. If the translator is identical to the \bibfield{editor}, the standard styles will automatically concatenate these fields in the bibliography.
\fielditem{type}{key}
The type of a \bibfield{manual}, \bibfield{patent}, \bibfield{report}, or \bibfield{thesis}. This field may also be useful for the custom types listed in \secref{bib:typ:ctm}.
\fielditem{url}{uri}
The \acr{URL} of an online publication. If it is not URL-escaped (no <\%> chars) it will be URI-escaped according to RFC 3987, that is, even Unicode chars will be correctly escaped.
\fielditem{urldate}{date}
The access date of the address specified in the \bibfield{url} field. See also \secref{bib:use:dat}.
\fielditem{venue}{literal}
The location of a conference, a symposium, or some other event in \bibtype{proceedings} and \bibtype{inproceedings} entries. This field may also be useful for the custom types listed in \secref{bib:typ:ctm}. Note that the \bibfield{location} list holds the place of publication. It therefore corresponds to the \bibfield{publisher} and \bibfield{institution} lists. The location of the event is given in the \bibfield{venue} field. See also \bibfield{eventdate} and \bibfield{eventtitle}.
\fielditem{version}{literal}
The revision number of a piece of software, a manual, etc.
\fielditem{volume}{integer}
The volume of a multi"=volume book or a periodical. It is expected to be an integer, not necessarily in arabic numerals since \biber will automatically convert from roman numerals or arabic letter to integers internally for sorting purposes. See also \bibfield{part}. See the \opt{noroman} option which can be used to suppress roman numeral parsing. This can help in cases where there is an ambiguity between parsing as roman numerals or alphanumeric (e.g. <C>), see \secref{use:opt:pre:int}.
\fielditem{volumes}{integer}
The total number of volumes of a multi"=volume work. Depending on the entry type, this field refers to \bibfield{title} or \bibfield{maintitle}. It is expected to be an integer, not necessarily in arabic numerals since \biber will automatically convert from roman numerals or arabic letter to integers internally for sorting purposes. See the \opt{noroman} option which can be used to suppress roman numeral parsing. This can help in cases where there is an ambiguity between parsing as roman numerals or alphanumeric (e.g. <C>), see \secref{use:opt:pre:int}.
\fielditem{year}{literal}
The year of publication. This field is a literal field only when given
explicitly in the data (for plain \bibtex compatibility for example). It is
however better to use the \bibfield{date} field as this is compatible with
plain years too and supports many more features. See \secref{bib:use:dat,bib:use:yearordate}.
\end{fieldlist}
\subsubsection{Special Fields}
\label{bib:fld:spc}
The fields listed in this section do not hold printable data but serve a different purpose. They apply to all entry types in the default data model.
\begin{fieldlist}
\fielditem{crossref}{entry key}
This field holds an entry key for the cross"=referencing feature. Child entries with a \bibfield{crossref} field inherit data from the parent entry specified in the \bibfield{crossref} field. If the number of child entries referencing a specific parent entry hits a certain threshold, the parent entry is automatically added to the bibliography even if it has not been cited explicitly. The threshold is settable with the \opt{mincrossrefs} package option from \secref{use:opt:pre:gen}. Style authors should note that whether or not the \bibfield{crossref} fields of the child entries are defined on the \biblatex level depends on the availability of the parent entry. If the parent entry is available, the \bibfield{crossref} fields of the child entries will be defined. If not, the child entries still inherit the data from the parent entry but their \bibfield{crossref} fields will be undefined. Whether the parent entry is added to the bibliography implicitly because of the threshold or explicitly because it has been cited does not matter. See also the \bibfield{xref} field in this section as well as \secref{bib:cav:ref}.
\fielditem{entryset}{separated values}
This field is specific to entry sets. See \secref{use:use:set} for details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{execute}{code}
A special field which holds arbitrary \tex code to be executed whenever the data of the respective entry is accessed. This may be useful to handle special cases. Conceptually, this field is comparable to the hooks \cmd{AtEveryBibitem}, \cmd{AtEveryLositem}, and \cmd{AtEveryCitekey} from \secref{aut:fmt:hok}, except that it is definable on a per"=entry basis in the \file{bib} file. Any code in this field is executed automatically immediately after these hooks.
\fielditem{gender}{Pattern matching one of: \opt{sf}, \opt{sm}, \opt{sn}, \opt{pf}, \opt{pm}, \opt{pn}, \opt{pp}}
The gender of the author or the gender of the editor, if there is no author. The following identifiers are supported: \opt{sf} (feminine singular, a single female name), \opt{sm} (masculine singular, a single male name), \opt{sn} (neuter singular, a single neuter name), \opt{pf} (feminine plural, a list of female names), \opt{pm} (masculine plural, a list of male names), \opt{pn} (neuter plural, a list of neuter names), \opt{pp} (plural, a mixed gender list of names). This information is only required by special bibliography and citation styles and only in certain languages. For example, a citation style may replace recurrent author names with a term such as <idem>. If the Latin word is used, as is custom in English and French, there is no need to specify the gender. In German publications, however, such key terms are usually given in German and in this case they are gender"=sensitive.
\begin{table}
\caption{Supported Languages}
\label{bib:fld:tab1}
\tablesetup
\begin{tabularx}{\textwidth}{@{}p{90pt}@{}p{160pt}@{}X@{}}
\toprule
\multicolumn{1}{@{}H}{Language} &
\multicolumn{1}{@{}H}{Region/Dialect} &
\multicolumn{1}{@{}H}{Identifiers} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule{3-3}
Bulgarian & Bulgaria & \opt{bulgarian} \\
Catalan & Spain, France, Andorra, Italy & \opt{catalan} \\
Croatian & Croatia, Bosnia and Herzegovina, Serbia & \opt{croatian} \\
Czech & Czech Republic & \opt{czech} \\
Danish & Denmark & \opt{danish} \\
Dutch & Netherlands & \opt{dutch} \\
English & USA & \opt{american}, \opt{USenglish}, \opt{english} \\
& United Kingdom & \opt{british}, \opt{UKenglish} \\
& Canada & \opt{canadian} \\
& Australia & \opt{australian} \\
& New Zealand & \opt{newzealand} \\
Estonian & Estonia & \opt{estonian} \\
Finnish & Finland & \opt{finnish} \\
French & France, Canada & \opt{french} \\
German & Germany & \opt{german} \\
& Austria & \opt{austrian} \\
& Switzerland & \opt{swissgerman} \\
German (new) & Germany & \opt{ngerman} \\
& Austria & \opt{naustrian} \\
& Switzerland & \opt{nswissgerman} \\
Greek & Greece & \opt{greek} \\
Hungarian & Hungary & \opt{magyar}, \opt{hungarian} \\
Icelandic & Iceland & \opt{icelandic} \\
Italian & Italy & \opt{italian} \\
Latvian & Latvia & \opt{latvian} \\
Lithuanian & Lithuania & \opt{lithuanian} \\
Norwegian (Bokmål) & Norway & \opt{norsk} \\
Norwegian (Nynorsk) & Norway & \opt{nynorsk} \\
Polish & Poland & \opt{polish} \\
Portuguese & Brazil & \opt{brazil} \\
& Portugal & \opt{portuguese}, \opt{portuges} \\
Russian & Russia & \opt{russian} \\
Serbian (Latin) & Serbia & \opt{serbian} \\
Serbian (Cyrillic) & Serbia & \opt{serbianc} \\
Slovak & Slovakia & \opt{slovak} \\
Slovene & Slovenia & \opt{slovene}, \opt{slovenian} \\
Spanish & Spain & \opt{spanish} \\
Swedish & Sweden & \opt{swedish} \\
Turkish & Turkey & \opt{turkish} \\
Ukrainian & Ukraine & \opt{ukrainian} \\
\bottomrule
\end{tabularx}
\end{table}
\fielditem{langid}{identifier}
The language id of the bibliography entry. The alias \bibfield{hyphenation} is provided for backwards compatibility. The identifier must be a language name known to the \sty{babel}/\sty{polyglossia} packages. This information may be used to switch hyphenation patterns and localise strings in the bibliography. Note that the language names are case sensitive. The languages currently supported by this package are given in \tabref{bib:fld:tab1}. Note that \sty{babel} treats the identifier \opt{english} as an alias for \opt{british} or \opt{american}, depending on the \sty{babel} version. The \biblatex package always treats it as an alias for \opt{american}. It is preferable to use the language identifiers \opt{american} and \opt{british} (\sty{babel}) or a language specific option to specify a language variant (\sty{polyglossia}, using the \bibfield{langidopts} field) to avoid any possible confusion. Compare \bibfield{language} in \secref{bib:fld:dat}.
\fielditem{langidopts}{literal}
For \sty{polyglossia} users, allows per-entry language specific options. The literal value of this field is passed to \sty{polyglossia}'s language switching facility when using the package option \opt{autolang=langname}. For example, the fields:
\begin{lstlisting}[style=bibtex]{}
langid = {english},
langidopts = {variant=british},
\end{lstlisting}
%
would wrap the bibliography entry in:
\begin{ltxexample}
\english[variant=british]
...
\endenglish
\end{ltxexample}
%
\fielditem{ids}{separated list of entrykeys}
Citation key aliases for the main citation key. An entry may be cited by any of its aliases and \biblatex will treat the citation as if it had used the primary citation key. This is to aid users who change their citation keys but have legacy documents which use older keys for the same entry. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{indexsorttitle}{literal}
The title used when sorting the index. In contrast to \bibfield{indextitle}, this field is used for sorting only. The printed title in the index is the \bibfield{indextitle} or the \bibfield{title} field. This field may be useful if the title contains special characters or commands which interfere with the sorting of the index. Consider this example:
\begin{lstlisting}[style=bibtex]{}
title = {The \LaTeX\ Companion},
indextitle = {\LaTeX\ Companion, The},
indexsorttitle = {LATEX Companion},
\end{lstlisting}
%
Style authors should note that \biblatex automatically copies the value of either the \bibfield{indextitle} or the \bibfield{title} field to \bibfield{indexsorttitle} if the latter field is undefined.
\fielditem{keywords}{separated values}
A separated list of keywords. These keywords are intended for the bibliography filters (see \secref{use:bib:bib, use:use:div}), they are usually not printed. Note that with the default separator (comma), spaces around the separator are ignored.
\fielditem{options}{separated \keyval options}
A separated list of entry options in \keyval notation. This field is used to set options on a per"=entry basis. See \secref{use:opt:bib} for details. Note that citation and bibliography styles may define additional entry options.
\fielditem{presort}{string}
A special field used to modify the sorting order of the bibliography. This field is the first item the sorting routine considers when sorting the bibliography, hence it may be used to arrange the entries in groups. This may be useful when creating subdivided bibliographies with the bibliography filters. Please refer to \secref{use:srt} for further details. Also see \secref{aut:ctm:srt}. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{related}{separated values}
Citation keys of other entries which have a relationship to this entry. The relationship is specified by the \bibfield{relatedtype} field. Please refer to \secref{use:rel} for further details.
\fielditem{relatedoptions}{separated values}
Per"=type options to set for a related entry. Note that this does not set the options on the related entry itself, only the \opt{dataonly} clone which is used as a datasource for the parent entry.
\fielditem{relatedtype}{identifier}
An identifier which specified the type of relationship for the keys listed in the \bibfield{related} field. The identifier is a localised bibliography string printed
before the data from the related entry list. It is also used to identify type-specific
formatting directives and bibliography macros for the related entries. Please refer to \secref{use:rel} for further details.
\fielditem{relatedstring}{literal}
A field used to override the bibliography string specified by \bibfield{relatedtype}. Please refer to \secref{use:rel} for further details.
\fielditem{sortkey}{literal}
A field used to modify the sorting order of the bibliography. Think of this field as the master sort key. If present, \biblatex uses this field during sorting and ignores everything else, except for the \bibfield{presort} field. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\listitem{sortname}{name}
A name or a list of names used to modify the sorting order of the bibliography. If present, this list is used instead of \bibfield{author} or \bibfield{editor} when sorting the bibliography. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{sortshorthand}{literal}
Similar to \bibfield{sortkey} but used in the list of shorthands. If present, \biblatex uses this field instead of \bibfield{shorthand} when sorting the list of shorthands. This is useful if the \bibfield{shorthand} field holds shorthands with formatting commands such as \cmd{emph} or \cmd{textbf}. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{sorttitle}{literal}
A field used to modify the sorting order of the bibliography. If present, this field is used instead of the \bibfield{title} field when sorting the bibliography. The \bibfield{sorttitle} field may come in handy if you have an entry with a title like «An Introduction to\dots» and want that alphabetized under <I> rather than <A>. In this case, you could put «Introduction to\dots» in the \bibfield{sorttitle} field. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{sortyear}{integer}
A field used to modify the sorting order of the bibliography. In the default sorting templates, if this field is present, it is used instead of the \bibfield{year} field when sorting the bibliography. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{xdata}{separated list of entrykeys}
This field inherits data from one or more \bibtype{xdata} entries. Conceptually, the \bibfield{xdata} field is related to \bibfield{crossref} and \bibfield{xref}: \bibfield{crossref} establishes a logical parent/child relation and inherits data; \bibfield{xref} establishes as logical parent/child relation without inheriting data; \bibfield{xdata} inherits data without establishing a relation. The value of the \bibfield{xdata} may be a single entry key or a separated list of keys. See \secref{use:use:xdat} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{xref}{entry key}
This field is an alternative cross"=referencing mechanism. It differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent entry specified in the \bibfield{xref} field. If the number of child entries referencing a specific parent entry hits a certain threshold, the parent entry is automatically added to the bibliography even if it has not been cited explicitly. The threshold is settable with the \opt{minxrefs} package option from \secref{use:opt:pre:gen}. Style authors should note that whether or not the \bibfield{xref} fields of the child entries are defined on the \biblatex level depends on the availability of the parent entry. If the parent entry is available, the \bibfield{xref} fields of the child entries will be defined. If not, their \bibfield{xref} fields will be undefined. Whether the parent entry is added to the bibliography implicitly because of the threshold or explicitly because it has been cited does not matter. See also the \bibfield{crossref} field in this section as well as \secref{bib:cav:ref}.
\end{fieldlist}
\subsubsection{Custom Fields}
\label{bib:fld:ctm}
The fields listed in this section are intended for special bibliography styles. They are not used by the standard bibliography styles.
\begin{fieldlist}
\listitem{name{[a--c]}}{name}
Custom lists for special bibliography styles. Not used by the standard bibliography styles.
\fielditem{name{[a--c]}type}{key}
Similar to \bibfield{authortype} and \bibfield{editortype} but referring to the fields \bibfield{name{[a--c]}}. Not used by the standard bibliography styles.
\listitem{list{[a--f]}}{literal}
Custom lists for special bibliography styles. Not used by the standard bibliography styles.
\fielditem{user{[a--f]}}{literal}
Custom fields for special bibliography styles. Not used by the standard bibliography styles.
\fielditem{verb{[a--c]}}{literal}
Similar to the custom fields above except that these are verbatim fields. Not used by the standard bibliography styles.
\end{fieldlist}
\subsubsection{Field Aliases}
\label{bib:fld:als}
The aliases listed in this section are provided for backwards compatibility with traditional \bibtex and other applications based on traditional \bibtex styles. Note that these aliases are immediately resolved as the \file{bib} file is processed. All bibliography and citation styles must use the names of the fields they point to, not the alias. In \file{bib} files, you may use either the alias or the field name but not both at the same time.
\begin{fieldlist}
\listitem{address}{literal}
An alias for \bibfield{location}, provided for \bibtex compatibility. Traditional \bibtex uses the slightly misleading field name \bibfield{address} for the place of publication, \ie the location of the publisher, while \biblatex uses the generic field name \bibfield{location}. See \secref{bib:fld:dat,bib:use:and}.
\fielditem{annote}{literal}
An alias for \bibfield{annotation}, provided for \sty{jurabib} compatibility. See \secref{bib:fld:dat}.
\fielditem{archiveprefix}{literal}
An alias for \bibfield{eprinttype}, provided for arXiv compatibility. See \secref{bib:fld:dat,use:use:epr}.
\fielditem{journal}{literal}
An alias for \bibfield{journaltitle}, provided for \bibtex compatibility. See \secref{bib:fld:dat}.
\fielditem{key}{literal}
An alias for \bibfield{sortkey}, provided for \bibtex compatibility. See \secref{bib:fld:spc}.
\fielditem{pdf}{verbatim}
An alias for \bibfield{file}, provided for JabRef compatibility. See \secref{bib:fld:dat}.
\fielditem{primaryclass}{literal}
An alias for \bibfield{eprintclass}, provided for arXiv compatibility. See \secref{bib:fld:dat,use:use:epr}.
\listitem{school}{literal}
An alias for \bibfield{institution}, provided for \bibtex compatibility. The \bibfield{institution} field is used by traditional \bibtex for technical reports whereas the \bibfield{school} field holds the institution associated with theses. The \biblatex package employs the generic field name \bibfield{institution} in both cases. See \secref{bib:fld:dat,bib:use:and}.
\end{fieldlist}
\subsection{Usage Notes}
\label{bib:use}
The entry types and fields supported by this package should for the most part be intuitive to use for anyone familiar with \bibtex. However, apart from the additional types and fields provided by this package, some of the familiar ones are handled in a way which is in need of explanation.
This package includes some compatibility code for \file{bib} files which were generated with a traditional \bibtex style in mind. Unfortunately, it is not possible to handle all legacy files automatically because \biblatex's data model is slightly different from traditional \bibtex. Therefore, such \file{bib} files will most likely require editing in order to work properly with this package. In sum, the following items are different from traditional \bibtex styles:
\begin{itemize}
\setlength{\itemsep}{0pt}
\item The entry type \bibtype{inbook}. See \secref{bib:typ:blx, bib:use:inb} for details.
\item The fields \bibfield{institution}, \bibfield{organization}, and \bibfield{publisher} as well as the aliases \bibfield{address} and \bibfield{school}. See \secref{bib:fld:dat, bib:fld:als, bib:use:and} for details.
\item The handling of certain types of titles. See \secref{bib:use:ttl} for details.
\item The field \bibfield{series}. See \secref{bib:fld:dat, bib:use:ser} for details.
\item The fields \bibfield{year} and \bibfield{month}. See \secref{bib:fld:dat, bib:use:dat, bib:use:yearordate, bib:use:iss} for details.
\item The field \bibfield{edition}. See \secref{bib:fld:dat} for details.
\item The field \bibfield{key}. See \secref{bib:use:key} for details.
\end{itemize}
Users of the \sty{jurabib} package should note that the \bibfield{shortauthor} field is treated as a name list by \biblatex, see \secref{bib:use:inc} for details.
\subsubsection{The Entry Type \bibtype{inbook}}
\label{bib:use:inb}
Use the \bibtype{inbook} entry type for a self"=contained part of a book with its own title only. It relates to \bibtype{book} just like \bibtype{incollection} relates to \bibtype{collection}. See \secref{bib:use:ttl} for examples. If you want to refer to a chapter or section of a book, simply use the \bibfield{book} type and add a \bibfield{chapter} and\slash or \bibfield{pages} field. Whether a bibliography should at all include references to chapters or sections is controversial because a chapter is not a bibliographic entity.
\subsubsection{Missing and Omissible Data}
\label{bib:use:key}
The fields marked as <required> in \secref{bib:typ:blx} are not strictly required in all cases. The bibliography styles which come with this package can get by with as little as a \bibfield{title} field for most entry types. A book published anonymously, a periodical without an explicit editor, or a software manual without an explicit author should pose no problem as far as the bibliography is concerned. Citation styles, however, may have different requirements. For example, an author"=year citation scheme obviously requires an \bibfield{author}\slash \bibfield{editor} and a \bibfield{year} field.
You may generally use the \bibfield{label} field to provide a substitute for any missing data required for citations. How the \bibfield{label} field is employed depends on the citation style. The author"=year citation styles which come with this package use the \bibfield{label} field as a fallback if either the \bibfield{author}\slash \bibfield{editor} or the \bibfield{year} is missing. The numeric styles, on the other hand, do not use it at all since the numeric scheme is independent of the available data. The author"=title styles ignore it as well, because the bare \bibfield{title} is usually sufficient to form a unique citation and a title is expected to be available in any case. The \bibfield{label} field may also be used to override the non"=numeric portion of the automatically generated \bibfield{labelalpha} field used by alphabetic citation styles. See \secref{aut:bbx:fld} for details.
Note that traditional \bibtex styles support a \bibfield{key} field which is used for alphabetizing if both \bibfield{author} and \bibfield{editor} are missing. The \biblatex package treats \bibfield{key} as an alias for \bibfield{sortkey}. In addition to that, it offers very fine-grained sorting controls, see \secref{bib:fld:spc, use:srt} for details. The \sty{natbib} package employs the \bibfield{key} field as a fallback label for citations. Use the \bibfield{label} field instead.
\subsubsection{Corporate Authors and Editors}
\label{bib:use:inc}
Corporate authors and editors are given in the \bibfield{author} or \bibfield{editor} field, respectively. Note that they must be wrapped in an extra pair of curly braces to prevent data parsing from treating them as personal names which are to be dissected into their components. Use the \bibfield{shortauthor} field if you want to give an abbreviated form of the name or an acronym for use in citations.
\begin{lstlisting}[style=bibtex]{}
author = {<<{National Aeronautics and Space Administration}>>},
shortauthor = {NASA},
\end{lstlisting}
%
The default citation styles will use the short name in all citations while the full name is printed in the bibliography. For corporate editors, use the corresponding fields \sty{editor} and \sty{shorteditor}. Since all of these fields are treated as name lists, it is possible to mix personal names and corporate names, provided that the names of all corporations and institutions are wrapped in braces.
\begin{lstlisting}[style=bibtex]{}
editor = {<<{National Aeronautics and Space Administration}>>
and Doe, John},
shorteditor = {NASA and Doe, John},
\end{lstlisting}
%
Users switching from the \sty{jurabib} package to \biblatex should note that the \bibfield{shortauthor} field is treated as a name list.
\subsubsection{Literal Lists}
\label{bib:use:and}
The fields \bibfield{institution}, \bibfield{organization}, \bibfield{publisher}, and \bibfield{location} are literal lists in terms of \secref{bib:fld}. This also applies to \bibfield{origlocation}, \bibfield{origpublisher} and to the field aliases \bibfield{address} and \bibfield{school}. All of these fields may contain a list of items separated by the keyword <|and|>. If they contain a literal <|and|>, it must be wrapped in braces.
\begin{lstlisting}[style=bibtex]{}
publisher = {William Reid <<{and}>> Company},
institution = {Office of Information Management <<{and}>> Communications},
organization = {American Society for Photogrammetry <<{and}>> Remote Sensing
and
American Congress on Surveying <<{and}>> Mapping},
\end{lstlisting}
%
Note the difference between a literal <|{and}|> and the list separator <|and|> in the above examples. You may also wrap the entire name in braces:
\begin{lstlisting}[style=bibtex]{}
publisher = {<<{William Reid and Company}>>},
institution = {<<{Office of Information Management and Communications}>>},
organization = {<<{American Society for Photogrammetry and Remote Sensing}>>
and
<<{American Congress on Surveying and Mapping}>>},
\end{lstlisting}
%
Legacy files which have not been updated for use with \biblatex will still work if these fields do not contain a literal <and>. However, note that you will miss out on the additional features of literal lists in this case, such as configurable formatting and automatic truncation.
\subsubsection{Titles}
\label{bib:use:ttl}
The following examples demonstrate how to handle different types of titles. Let's start with a five"=volume work which is referred to as a whole:
\begin{lstlisting}[style=bibtex]{}
@MvBook{works,
author = {Shakespeare, William},
title = {Collected Works},
volumes = {5},
...
\end{lstlisting}
%
The individual volumes of a multi"=volume work usually have a title of their own. Suppose the fourth volume of the \emph{Collected Works} includes Shakespeare's sonnets and we are referring to this volume only:
\begin{lstlisting}[style=bibtex]{}
@Book{works:4,
author = {Shakespeare, William},
maintitle = {Collected Works},
title = {Sonnets},
volume = {4},
...
\end{lstlisting}
%
If the individual volumes do not have a title, we put the main title in the \bibfield{title} field and include a volume number:
\begin{lstlisting}[style=bibtex]{}
@Book{works:4,
author = {Shakespeare, William},
title = {Collected Works},
volume = {4},
...
\end{lstlisting}
%
In the next example, we are referring to a part of a volume, but this part is a self"=contained work with its own title. The respective volume also has a title and there is still the main title of the entire edition:
\begin{lstlisting}[style=bibtex]{}
@InBook{lear,
author = {Shakespeare, William},
bookauthor = {Shakespeare, William},
maintitle = {Collected Works},
booktitle = {Tragedies},
title = {King Lear},
volume = {1},
pages = {53-159},
...
\end{lstlisting}
%
Suppose the first volume of the \emph{Collected Works} includes a reprinted essay by a well"=known scholar. This is not the usual introduction by the editor but a self"=contained work. The \emph{Collected Works} also have a separate editor:
\begin{lstlisting}[style=bibtex]{}
@InBook{stage,
author = {Expert, Edward},
title = {Shakespeare and the Elizabethan Stage},
bookauthor = {Shakespeare, William},
editor = {Bookmaker, Bernard},
maintitle = {Collected Works},
booktitle = {Tragedies},
volume = {1},
pages = {7-49},
...
\end{lstlisting}
%
See \secref{bib:use:ser} for further examples.
\subsubsection{Editorial Roles}
\label{bib:use:edr}
The type of editorial role performed by an editor in one of the \bibfield{editor} fields (\ie \bibfield{editor}, \bibfield{editora}, \bibfield{editorb}, \bibfield{editorc}) may be specified in the corresponding \bibfield{editor...type} field. The following roles are supported by default. The role <\texttt{editor}> is the default. In this case, the \bibfield{editortype} field is omissible.
\begin{marglist}
\setlength{\itemsep}{0pt}
\item[editor] The main editor. This is the most generic editorial role and the default value.
\item[compiler] Similar to \texttt{editor} but used if the task of the editor is mainly compiling.
\item[founder] The founding editor of a periodical or a comprehensive publication project such as a <Collected Works> edition or a long"=running legal commentary.
\item[continuator] An editor who continued the work of the founding editor (\texttt{founder}) but was subsequently replaced by the current editor (\texttt{editor}).
\item[redactor] A secondary editor whose task is redacting the work.
\item[reviser] A secondary editor whose task is revising the work.
\item[collaborator] A secondary editor or a consultant to the editor.
\item[organizer] Similar to \texttt{editor} but used if the task of the editor is mainly organizing.
\end{marglist}
%
For example, if the task of the editor is compiling, you may indicate that in the corresponding \bibfield{editortype} field:
\begin{lstlisting}[style=bibtex]{}
@Collection{...,
editor = {Editor, Edward},
editortype = {compiler},
...
\end{lstlisting}
%
There may also be secondary editors in addition to the main editor:
\begin{lstlisting}[style=bibtex]{}
@Book{...,
author = {...},
editor = {Editor, Edward},
editora = {Redactor, Randolph},
editoratype = {redactor},
editorb = {Consultant, Conrad},
editorbtype = {collaborator},
...
\end{lstlisting}
%
Periodicals or long"=running publication projects may see several generations of editors. For example, there may be a founding editor in addition to the current editor:
\begin{lstlisting}[style=bibtex]{}
@Book{...,
author = {...},
editor = {Editor, Edward},
editora = {Founder, Frederic},
editoratype = {founder},
...
\end{lstlisting}
%
Note that only the \bibfield{editor} is considered in citations and when sorting the bibliography. If an entry is typically cited by the founding editor (and sorted accordingly in the bibliography), the founder goes into the \bibfield{editor} field and the current editor moves to one of the \bibfield{editor...} fields:
\begin{lstlisting}[style=bibtex]{}
@Collection{...,
editor = {Founder, Frederic},
editortype = {founder},
editora = {Editor, Edward},
...
\end{lstlisting}
%
You may add more roles by initializing and defining a new localisation key whose name corresponds to the identifier in the \bibfield{editor...type} field. See \secref{use:lng,aut:lng:cmd} for details.
\subsubsection{Publication and Journal Series}
\label{bib:use:ser}
The \bibfield{series} field is used by traditional \bibtex styles both for the main title of a multi"=volume work and for a publication series, \ie a loosely related sequence of books by the same publisher which deal with the same general topic or belong to the same field of research. This may be ambiguous. This package introduces a \bibfield{maintitle} field for multi"=volume works and employs \bibfield{series} for publication series only. The volume or number of a book in the series goes in the \bibfield{number} field in this case:
\begin{lstlisting}[style=bibtex]{}
@Book{...,
author = {Expert, Edward},
title = {Shakespeare and the Elizabethan Age},
series = {Studies in English Literature and Drama},
number = {57},
...
\end{lstlisting}
%
The \bibtype{article} entry type makes use of the \bibfield{series} field as well, but handles it in a special way. First, a test is performed to determine whether the value of the field is an integer. If so, it will be printed as an ordinal. If not, another test is performed to determine whether it is a localisation key. If so, the localised string is printed. If not, the value is printed as is. Consider the following example of a journal published in numbered series:
\begin{lstlisting}[style=bibtex]{}
@Article{...,
journal = {Journal Name},
series = {3},
volume = {15},
number = {7},
year = {1995},
...
\end{lstlisting}
%
This entry will be printed as «\emph{Journal Name}. 3rd ser. 15.7 (1995)». Some journals use designations such as «old series» and «new series» instead of a number. Such designations may be given in the \bibfield{series} field as well, either as a literal string or as a localisation key. Consider the following example which makes use of the localisation key \texttt{newseries}:
\begin{lstlisting}[style=bibtex]{}
@Article{...,
journal = {Journal Name},
series = {newseries},
volume = {9},
year = {1998},
...
\end{lstlisting}
%
This entry will be printed as «\emph{Journal Name}. New ser. 9 (1998)». See \secref{aut:lng:key} for a list of localisation keys defined by default.
\subsubsection{Date and Time Specifications}
\label{bib:use:dat}
\begin{table}
\caption{Date Specifications}
\label{bib:use:tab1}
\tablesetup
\begin{tabularx}{\textwidth}{@{}>{\ttfamily}llX@{}}
\toprule
\multicolumn{1}{@{}H}{Date Specification} &
\multicolumn{2}{H}{Formatted Date (Examples)} \\
\cmidrule(l){2-3}
&
\multicolumn{1}{H}{Short/12-hour Format} &
\multicolumn{1}{H}{Long/24-hour Format} \\
\cmidrule{1-1}\cmidrule(l){2-2}\cmidrule(l){3-3}
1850 & 1850 & 1850 \\
1997/ & 1997-- & 1997-- \\
/1997 & --1997 & --1997 \\
1997/.. & 1997-- & 1997-- \\
../1997 & --1997 & --1997 \\
1967-02 & 02/1967 & February 1967 \\
2009-01-31 & 31/01/2009 & 31st January 2009 \\
1988/1992 & 1988--1992 & 1988--1992 \\
2002-01/2002-02 & 01/2002--02/2002 & January 2002--February 2002 \\
1995-03-30/1995-04-05 & 30/03/1995--05/04/1995 & 30th March 1995--5th April 1995 \\
2004-04-05T14:34:00 & 05/04/2004 2:34 PM & 5th April 2004 14:34:00\\
\bottomrule
\end{tabularx}
\end{table}
Date fields such as the default data model dates \bibfield{date}, \bibfield{origdate}, \bibfield{eventdate}, and \bibfield{urldate} adhere to \acr{ISO8601-2} Extended Format specification level 1. In addition to the \acr{ISO8601-2} empty date range markers, you may also specify an open ended/start date range by giving the range separator and omitting the end/start date (\eg \texttt{YYYY/}, \texttt{/YYYY}). See \tabref{bib:use:tab1} for some examples of valid date specifications and the formatted dates automatically generated by \biblatex. The formatted date is language specific and will be adapted automatically. If there is no \bibfield{date} field in an entry, \biblatex will also consider the fields \bibfield{year} and \bibfield{month} for backwards compatibility with traditional \bibtex but this is not encouraged as explicit \bibfield{year} and \bibfield{month} are not parsed for date meta-information markers or times and are used as-is. Style authors should note that date fields like \bibfield{date} or \bibfield{origdate} are only available in the \file{bib} file. All dates are parsed and dissected into their components as the \file{bib} file is processed. The date and time components are made available to styles by way of the special fields discussed in \secref{aut:bbx:fld:dat}. See this section and \tabref{aut:bbx:fld:tab1} on page~\pageref{aut:bbx:fld:tab1} for further information.
\acr{ISO8601-2} Extended Format dates are astronomical dates in which year <0> exists. When outputting dates in BCE or BC era (see the \opt{dateera} option below), note that they will typically be one year earlier since BCE/BC era do not have a year 0 (year 0 is 1 BCE/BC). This conversion is automatic. See examples in \tabref{bib:use:tab2}.
Date field names \emph{must} end with the string <date>, as with the default date fields. Bear this in mind when adding new date fields to the datamodel (see \secref{aut:ctm:dm}). \biblatex will check all date fields after reading the date model and will exit with an error if it finds a date field which does not adhere to this naming convention.
\acr{ISO8601-2} supports dates before common era (BCE/BC) by way of a negative date format and supports <approximate> (circa) and uncertain dates. Such date formats set internal markers which can be tested for so that appropriate localised markers (such as \opt{circa} or \opt{beforecommonera}) can be inserted. Also supported are <unspecified> dates (\acr{ISO8601-2} 4.3) which are automatically expanded into appropriate data ranges accompanied by a field \bibfield{$<$datetype$>$dateunspecified} which details the granularity of the unspecified data. Styles may use this information to format such dates appropriately but the standard styles do not do this. See \tabref{bib:use:tab3} on page~\pageref{bib:use:tab3} for the allowed \acr{ISO8601-2} <unspecified> formats, their range expansions and \bibfield{$<$datetype$>$dateunspecified} values (see \secref{aut:bbx:fld:gen}).
\begin{table}
\caption{ISO8601-2 4.3 Unspecified Date Parsing}
\label{bib:use:tab3}
\tablesetup
\begin{tabularx}{\textwidth}{@{}>{\ttfamily}llX@{}}
\toprule
\multicolumn{1}{@{}H}{Date Specification} &
\multicolumn{1}{H}{Expanded Range} &
\multicolumn{1}{H}{Meta-information} \\
\cmidrule{1-1}\cmidrule(l){2-2}\cmidrule(l){3-3}
199X & 1990/1999 & yearindecade \\
19XX & 1900/1999 & yearincentury \\
1999-XX & 1999-01/1999-12 & monthinyear \\
1999-01-XX & 1999-01-01/1999-01-31 & dayinmonth \\
1999-XX-XX & 1999-01-01/1999-12-31 & dayinyear \\
\bottomrule
\end{tabularx}
\end{table}
\Tabref{bib:use:tab2} shows formats which use appropriate tests and formatting. See the date meta-information tests in \secref{aut:aux:tst} and the localisation strings in \secref{aut:lng:key:dt}. See also the \file{96-dates.tex} example file for complete examples of the tests and localisation strings use.
The output of <circa>, uncertainty and era information in standard styles (or custom styles not customising the internal \cmd{mkdaterange*} macros) is controlled by the package options \opt{datecirca}, \opt{dateuncertain}, \opt{dateera} and \opt{dateeraauto} (see \secref{use:opt:pre:gen}). See \tabref{bib:use:tab2} on page~\pageref{bib:use:tab2} for examples which assumes these options are all used.
\begin{table}
\caption{Enhanced Date Specifications}
\label{bib:use:tab2}
\tablesetup
\begin{tabularx}{\textwidth}{@{}>{\ttfamily}llX@{}}
\toprule
\multicolumn{1}{@{}H}{Date Specification} &
\multicolumn{2}{H}{Formatted Date (Examples)} \\
\cmidrule(l){2-3}
&
\multicolumn{1}{H}{Output Format} &
\multicolumn{1}{H}{Output Format Notes} \\
\cmidrule{1-1}\cmidrule(l){2-2}\cmidrule(l){3-3}
0000 & 1 BC & \kvopt{dateera}{christian} prints \opt{beforechrist} localisation\\
-0876 & 877 BCE & \kvopt{dateera}{secular} prints \opt{beforecommonera} localisation string\\
-0877/-0866 & 878 BC--867 BC & using \cmd{ifdateera} test and \opt{beforechrist} localisation string\\
0768 & 0768 CE & using \opt{dateeraauto} set to <1000> and \opt{commonera} localisation string\\
-0343-02 & 344-02 BCE & \\
0343-02-03 & 343-02-03 CE & with \opt{dateeraauto=400} \\
0343-02-03 & 343-02-02 CE & with \opt{dateeraauto=400} and \opt{julian} \\
1723\textasciitilde & circa 1723 & using \cmd{ifdatecirca} test\\
1723? & 1723? & using \cmd{ifdateuncertain} test\\
1723\% & circa 1723? & using \cmd{ifdateuncertain} and \cmd{ifdatecirca} tests\\
2004-22 & 2004 & also, \bibfield{season} is set to the localisation string <summer>\\
2004-24 & 2004 & also, \bibfield{season} is set to the localisation string <winter>\\
\bottomrule
\end{tabularx}
\end{table}
\subsubsection{Year, Month and Date}
\label{bib:use:yearordate}
The fields \bibfield{year} and \bibfield{month} are still supported by \biblatex, but the full set of date features (day and time precision, ranges, \dots) can only be used with \bibfield{date}. It is therefore recommended to prefer \bibfield{date} over \bibfield{year} and \bibfield{month} unless backwards compatibility of the \file{bib} file with classical \bibtex is required.
\subsubsection{Months and Journal Issues}
\label{bib:use:iss}
The \bibfield{month} field is an integer field. The bibliography style converts the month to a language"=dependent string as required. For backwards compatibility, you may also use the following three"=letter abbreviations in the \bibfield{month} field: \texttt{jan}, \texttt{feb}, \texttt{mar}, \texttt{apr}, \texttt{may}, \texttt{jun}, \texttt{jul}, \texttt{aug}, \texttt{sep}, \texttt{oct}, \texttt{nov}, \texttt{dec}. Note that these abbreviations are \bibtex strings which must be given without any braces or quotes. When using them, don't say |month={jan}| or |month="jan"| but |month=jan|. It is not possible to specify a month such as |month={8/9}|. Use the \bibfield{date} field for date ranges instead. Quarterly journals are typically identified by a designation such as <Spring> or <Summer> which should be given in the \bibfield{issue} field. The placement of the \bibfield{issue} field in \bibtype{article} entries is similar to and overrides the \bibfield{month} field.
\subsubsection{Journal Numbers and Issues}
\label{bib:use:issnum}
The words <number> and <issue> are often used synonymously by journals to refer to the subdvision of a \bibfield{volume}. The fact that \biblatex's data model has fields of both names can sometimes lead to confusion about which field should be used. First and foremost the word that the journal uses for the subdivsion of a \bibfield{volume} should be of minor importance, what matters is the role in the data model. As a rule of thumb \bibfield{number} is the right field in most circumstances. In the standard styles \bibfield{number} modifies \bibfield{volume}, whereas \bibfield{issue} modifies the date (year) of the entry. Numeric identifiers and short designators that are not necessarily (entirely) numeric such as <A>, <S1>, <C2>, <Suppl.\ 3>, <4es> would go into the \bibfield{number} field, because they usually modify the \bibfield{volume}. The output of---especially longer---non-numeric input for \bibfield{number} should be checked since it could potentially look odd with some styles. The field \bibfield{issue} can be used for designations such as <Spring>, <Winter> or <Michaelmas term> if that is commonly used to refer to the journal.
\subsubsection{Pagination}
\label{bib:use:pag}
When specifying a page or page range, either in the \bibfield{pages} field of an entry or in the \prm{postnote} argument to a citation command, it is convenient to have \biblatex add prefixes like <p.> or <pp.> automatically and this is indeed what this package does by default. However, some works may use a different pagination scheme or may not be cited by page but rather by verse or line number. This is when the \bibfield{pagination} and \bibfield{bookpagination} fields come into play. As an example, consider the following entry:
\begin{lstlisting}[style=bibtex]{}
@InBook{key,
title = {...},
pagination = {verse},
booktitle = {...},
bookpagination = {page},
pages = {53--65},
...
\end{lstlisting}
%
The \bibfield{bookpagination} field affects the formatting of the \bibfield{pages} and \bibfield{pagetotal} fields in the list of references. Since \texttt{page} is the default, this field is omissible in the above example. In this case, the page range will be formatted as <pp.~53--65>. Suppose that, when quoting from this work, it is customary to use verse numbers rather than page numbers in citations. This is reflected by the \bibfield{pagination} field, which affects the formatting of the \prm{postnote} argument to any citation command. With a citation like |\cite[17]{key}|, the postnote will be formatted as <v.~17>. Setting the \bibfield{pagination} field to \texttt{section} would yield <\S~17>. See \secref{use:cav:pag} for further usage instructions.
The \bibfield{pagination} and \bibfield{bookpagination} fields are key fields. This package will try to use their value as a localisation key, provided that the key is defined. Always use the singular form of the key name in \file{bib} files, the plural is formed automatically. The keys \texttt{page}, \texttt{column}, \texttt{line}, \texttt{verse}, \texttt{section}, and \texttt{paragraph} are predefined, with \texttt{page} being the default. The string <\texttt{none}> has a special meaning when used in a \bibfield{pagination} or \bibfield{bookpagination} field. It suppresses the prefix for the respective entry. If there are no predefined localisation keys for the pagination scheme required by a certain entry, you can simply add them. See the commands \cmd{NewBibliographyString} and \cmd{DefineBibliographyStrings} in \secref{use:lng}. You need to define two localisation strings for each additional pagination scheme: the singular form (whose localisation key corresponds to the value of the \bibfield{pagination} field) and the plural form (whose localisation key must be the singular plus the letter <\texttt{s}>). See the predefined keys in \secref{aut:lng:key} for examples.
\subsection{Hints and Caveats}
\label{bib:cav}
This section provides some additional hints concerning the data interface of this package. It also addresses some common problems.
\subsubsection{Cross-referencing}
\label{bib:cav:ref}
\biber features a highly customizable cross-referencing mechanism with flexible data inheritance rules. Duplicating certain fields in the parent entry or adding empty fields to the child entry is no longer required. Entries are specified in a natural way:
\begin{lstlisting}[style=bibtex]{}
@Book{book,
author = {Author},
title = {Booktitle},
subtitle = {Booksubtitle},
publisher = {Publisher},
location = {Location},
date = {1995},
}
@InBook{inbook,
crossref = {book},
title = {Title},
pages = {5--25},
}
\end{lstlisting}
%
The \bibfield{title} field of the parent will be copied to the \bibfield{booktitle} field of the child, the \bibfield{subtitle} becomes the \bibfield{booksubtitle}. The \bibfield{author} of the parent becomes the \bibfield{bookauthor} of the child and, since the child does not provide an \bibfield{author} field, it is also duplicated as the \bibfield{author} of the child. After data inheritance, the child entry is similar to this:
\begin{lstlisting}[style=bibtex]{}
author = {Author},
bookauthor = {Author},
title = {Title},
booktitle = {Booktitle},
booksubtitle = {Booksubtitle},
publisher = {Publisher},
location = {Location},
date = {1995},
pages = {5--25},
\end{lstlisting}
%
See \apxref{apx:ref} for a list of mapping rules set up by default. Note that all of this is customizable. See \secref{aut:ctm:ref} on how to configure \biber's cross"=referencing mechanism. See also \secref{bib:fld:spc}.
\paragraph{The \bibfield{xref} field}
\label{bib:cav:ref:ref}
In addition to the \bibfield{crossref} field, \biblatex supports a simplified cross"=referencing mechanism based on the \bibfield{xref} field. This is useful if you want to establish a parent\slash child relation between two associated entries but prefer to keep them independent as far as the data is concerned. The \bibfield{xref} field differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent. If the parent is referenced by a certain number of child entries, \biblatex will automatically add it to the bibliography. The threshold is controlled by the \opt{minxrefs} package option from \secref{use:opt:pre:gen}.u See also \secref{bib:fld:spc}.
\subsubsection{Sorting and Encoding Issues}
\label{bib:cav:enc}
\biber handles Ascii, 8-bit encodings such as Latin\,1, and \utf. It features true Unicode support and is capable of reencoding the \file{bib} data on the fly in a robust way. For sorting, \biber uses a Perl implementation of the Unicode Collation Algorithm (\acr{UCA}), as outlined in Unicode Technical Standard \#10.\fnurl{https://unicode.org/reports/tr10/} Collation tailoring based on the Unicode Common Locale Data Repository (\acr{CLDR}) is also supported.\fnurl{http://cldr.unicode.org/}
Supporting Unicode implies much more than handling \utf input. Unicode is a complex standard covering more than its most well-known parts, the Unicode character encoding and transport encodings such as \utf. It also standardizes aspects such as string collation, which is required for language-sensitive sorting. For example, by using the Unicode Collation Algorithm, \biber can handle the character <ß> without any manual intervention. All you need to do to get localised sorting is specify the locale:
\begin{ltxexample}
\usepackage[sortlocale=de]{biblatex}
\end{ltxexample}
%
or if you are using German as the main document language via \sty{babel} or \sty{polyglossia}:
\begin{ltxexample}
\usepackage[sortlocale=auto]{biblatex}
\end{ltxexample}
%
This will make \biblatex pass the \sty{babel}/\sty{polyglossia} main document language
as the locale which \biber will map into a suitable default locale. \biber
will not try to get locale information from its environment as this makes
document processing dependent on something not in the document which is
against \tex's spirit of reproducibility. This also makes sense since
\sty{babel}/\sty{polyglossia} are in fact the relevant environment for a document. Note
that this will also work with 8-bit encodings such as Latin\,9, \ie you can
take advantage of Unicode-based sorting even though you are not using \utf
input. See \secref{bib:cav:enc:enc} on how to specify input and data
encodings properly.
\paragraph{Specifying Encodings}
\label{bib:cav:enc:enc}
When using a non-Ascii encoding in the \file{bib} file, it is important to understand what \biblatex can do for you and what may require manual intervention. The package takes care of the \latex side, \ie it ensures that the data imported from the \file{bbl} file is interpreted correctly, provided that the \opt{bibencoding} package option (or the datasource specific override for this, see \secref{use:bib:res}) is set properly. All of this is handled automatically and no further steps, apart from setting the \opt{bibencoding} option in certain cases, are required. Here are a few typical usage scenarios along with the relevant lines from the document preamble:
\begin{itemize}
\setlength{\itemsep}{0pt}
\item Ascii notation in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex:
\begin{ltxexample}
\usepackage{biblatex}
\end{ltxexample}
\item Latin\,1 encoding (\acr{ISO}-8859-1) in the \file{tex} file, Ascii notation in the \file{bib} file with \pdftex or traditional \tex :
\begin{ltxexample}
\usepackage[latin1]{inputenc}
\usepackage[bibencoding=ascii]{biblatex}
\end{ltxexample}
\item Latin\,9 encoding (\acr{ISO}-8859-15) in both the \file{tex} and the \file{bib} file with \pdftex or traditional:
\begin{ltxexample}
\usepackage[latin9]{inputenc}
\usepackage[bibencoding=auto]{biblatex}
\end{ltxexample}
%
Since \kvopt{bibencoding}{auto} is the default setting, the option is omissible. The following setup will have the same effect:
\begin{ltxexample}
\usepackage[latin9]{inputenc}
\usepackage{biblatex}
\end{ltxexample}
\item \utf encoding in the \file{tex} file, Latin\,1 (\acr{ISO}-8859-1) in the \file{bib} file with \pdftex or traditional \tex:
\begin{ltxexample}
\usepackage[utf8]{inputenc}
\usepackage[bibencoding=latin1]{biblatex}
\end{ltxexample}
The same scenario with \latex release 2018-04-01 or above, \xetex or \luatex in native \utf mode:
\begin{ltxexample}
\usepackage[bibencoding=latin1]{biblatex}
\end{ltxexample}
\end{itemize}
\biber can handle Ascii notation, 8-bit encodings such as Latin\,1, and \utf. It is also capable of reencoding the \file{bib} data on the fly (replacing the limited macro-level reencoding feature of \biblatex). This will happen automatically if required, provided that you specify the encoding of the \file{bib} files properly. In addition to the scenarios discussed above, \biber can also handle the following cases:
\begin{itemize}
\item Transparent \utf workflow, \ie \utf encoding in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex:
\begin{ltxexample}
\usepackage[utf8]{inputenc}
\usepackage[bibencoding=auto]{biblatex}
\end{ltxexample}
%
Since \kvopt{bibencoding}{auto} is the default setting, the option is omissible:
\begin{ltxexample}
\usepackage[utf8]{inputenc}
\usepackage{biblatex}
\end{ltxexample}
The same scenario with \xetex or \luatex in native \utf mode:
\begin{ltxexample}
\usepackage{biblatex}
\end{ltxexample}
\item It is even possible to combine an 8-bit encoded \file{tex} file with \utf encoding in the \file{bib} file, provided that all characters in the \file{bib} file are also covered by the selected 8-bit encoding:
\begin{ltxexample}
\usepackage[latin1]{inputenc}
\usepackage[bibencoding=utf8]{biblatex}
\end{ltxexample}
\end{itemize}
Some workarounds may be required when using traditional \tex or \pdftex with \utf encoding because \sty{inputenc}'s \file{utf8} module does not cover all of Unicode. Roughly speaking, it only covers the Western European Unicode range. When loading \sty{inputenc} with the \file{utf8} option, \biblatex will normally instruct \biber to reencode the \file{bib} data to \utf. This may lead to \sty{inputenc} errors if some of the characters in the \file{bib} file are outside the limited Unicode range supported by \sty{inputenc}.
\begin{itemize}
\item If you are affected by this problem, try setting the \opt{safeinputenc} option:
\begin{ltxexample}
\usepackage[utf8]{inputenc}
\usepackage[safeinputenc]{biblatex}
\end{ltxexample}
%
If this option is enabled, \biblatex will ignore \sty{inputenc}'s \opt{utf8} option and use Ascii. \biber will then try to convert the \file{bib} data to Ascii notation. For example, it will convert \k{S} to |\k{S}|. This option is similar to setting \kvopt{texencoding}{ascii} but will only take effect in this specific scenario (\sty{inputenc}\slash \sty{inputenx} with \utf). This workaround takes advantage of the fact that both Unicode and the \utf transport encoding are backwards compatible with Ascii.
\end{itemize}
This solution may be acceptable as a workaround if the data in the \file{bib} file is mostly Ascii anyway, with only a few strings, such as some authors' names, causing problems. However, keep in mind that it will not magically make traditional \tex or \pdftex support Unicode. It may help if the occasional odd character is not supported by \sty{inputenc}, but may still be processed by \tex when using an accent command (\eg |\d{S}| instead of \d{S}). If you need full Unicode support, however, switch to \xetex or \luatex.
Typical errors when \sty{inputenc} cannot handle a certain UTF-8 character are:
\begin{verbatim}
! Package inputenc Error: Unicode char <char> (U+<codepoint>)
(inputenc) not set up for use with LaTeX.
\end{verbatim}
%
but also less obvious things like:
\begin{verbatim}
! Argument of \UTFviii@three@octets has an extra }.
\end{verbatim}
\section{User Guide}
\label{use}
This part of the manual documents the user interface of the \biblatex package. The user guide covers everything you need to know in order to use \biblatex with the default styles that come with this package. You should read the user guide first in any case. If you want to write your own citation and\slash or bibliography styles, continue with the author guide afterwards.
\subsection{Package Options}
\label{use:opt}
All package options are given in \keyval notation. The value \texttt{true} is omissible with all boolean keys. For example, giving \opt{sortcites} without a value is equivalent to \kvopt{sortcites}{true}.
\subsubsection{Load-time Options}
\label{use:opt:ldt}
The following options must be used as \biblatex is loaded, \ie in the optional argument to \cmd{usepackage}.
\begin{optionlist}
\optitem[biber]{backend}{\opt{bibtex}, \opt{bibtex8}, \opt{biber}}
Specifies the database backend. The following backends are supported:
\begin{valuelist}
\item[biber] \biber, the default backend of \biblatex, supports Ascii, 8-bit encodings, \utf, on-the-fly reencoding, locale"=specific sorting, and many other features. Locale"=specific sorting, case"=sensitive sorting, and upper\slash lowercase precedence are controlled by the options \opt{sortlocale}, \opt{sortcase}, and \opt{sortupper}, respectively.
\item[bibtex] Legacy \bibtex. Traditional \bibtex supports Ascii encoding only. Sorting is always case"=insensitive.
\item[bibtex8] \bin{bibtex8}, the 8-bit implementation of \bibtex, supports Ascii and 8-bit encodings such as Latin~1.
\end{valuelist}
See \secref{use:bibtex} for details of using \bibtex as a backend.
\valitem[numeric]{style}{file}
Loads the bibliography style \prm{file}\path{.bbx} and the citation style \prm{file}\path{.cbx}. See \secref{use:xbx} for an overview of the standard styles.
\valitem[numeric]{bibstyle}{file}
Loads the bibliography style \prm{file}\path{.bbx}. See \secref{use:xbx:bbx} for an overview of the standard bibliography styles.
\valitem[numeric]{citestyle}{file}
Loads the citation style \prm{file}\path{.cbx}. See \secref{use:xbx:cbx} for an overview of the standard citation styles.
\boolitem[false]{natbib}
Loads compatibility module which provides aliases for the citation commands of the \sty{natbib} package. See \secref{use:cit:nat} for details.
\boolitem[false]{mcite}
Loads a citation module which provides \sty{mcite}\slash\sty{mciteplus}-like citation commands. See \secref{use:cit:mct} for details.
\optitem[auto]{casechanger}{\opt{auto}, \opt{latex2e}, \opt{expl3}}
This option selects the implementation of \biblatex's case changing functions, most prominently \cmd{MakeSentenceCase*}. \opt{expl3} selects the new implementation based on the \latex3 module \sty{l3text}. \opt{latex2e} selects the original implementation, which has tricky brace protection behaviour and some shortcomings when dealing with non-ASCII characters. The default \opt{auto} selects the case changing code based on the available \sty{expl3} version (\opt{expl3} is selected if \sty{expl3} is at least version 2020-04-06).
\end{optionlist}
\subsubsection{Preamble Options}
\label{use:opt:pre}
\paragraph{General}
\label{use:opt:pre:gen}
The following options may be used in the optional argument to \cmd{usepackage} as well as in the configuration file and the document preamble. The default value listed to the right is the package default. Note that bibliography and citation styles may modify the default setting at load time, see \secref{use:xbx} for details.
\begin{optionlist}
\optitem[nty]{sorting}{\opt{nty}, \opt{nyt}, \opt{nyvt}, \opt{anyt}, \opt{anyvt}, \opt{ynt}, \opt{ydnt}, \opt{none}, \opt{debug}, \prm{name}}
The sorting order of the bibliography. Unless stated otherwise, the entries are sorted in ascending order. The following choices are available by default:
\begin{valuelist}
\item[nty] Sort by name, title, year.
\item[nyt] Sort by name, year, title.
\item[nyvt] Sort by name, year, volume, title.
\item[anyt] Sort by alphabetic label, name, year, title.
\item[anyvt] Sort by alphabetic label, name, year, volume, title.
\item[ynt] Sort by year, name, title.
\item[ydnt] Sort by year (descending), name, title.
\item[none] Do not sort at all. All entries are processed in citation order.
\item[debug] Sort by entry key. This is intended for debugging only.
\item[\prm{name}] Use \prm{name}, as defined with \cmd{DeclareSortingTemplate} (\secref{aut:ctm:srt})
\end{valuelist}
Using any of the <alphabetic> sorting templates only makes sense in conjunction with a bibliography style which prints the corresponding labels. Note that some bibliography styles initialize this package option to a value different from the package default (\opt{nty}). See \secref{use:xbx:bbx} for details. Please refer to \secref{use:srt} for an in"=depth explanation of the above sorting options as well as the fields considered in the sorting process. See also \secref{aut:ctm:srt} on how to adapt the predefined templates or define new ones.
\boolitem[true]{sortcase}
Whether or not to sort the bibliography and the list of shorthands case"=sensitively.
\boolitem[true]{sortupper}
This option corresponds to \biber's \opt{--sortupper} command-line option. If enabled, the bibliography is sorted in <uppercase before lowercase> order. Disabling this option means <lowercase before uppercase> order.
\optitem[auto]{sortlocale}{\opt{auto}, \prm{locale}}
This option sets the global sorting locale. Every sorting template inherits this locale if none is specified using the \prm{locale} option to \cmd{printbibliography}. Setting this to \opt{auto} requests that it be set to the \sty{babel}/\sty{polyglossia} main document language identifier, if these packages are used and \texttt{en\_US} otherwise. \biber will map \sty{babel}/\sty{polyglossia} language identifiers into sensible locale identifiers (see the \biber documentation). You can therefore specify either a normal locale identifier like \texttt{de\_DE\_phonebook}, \texttt{es\_ES} or one of the supported \sty{babel}/\sty{polyglossia} language identifiers if the mapping \biber makes of this is fine for you.
\boolitem[false]{sortcites}
Whether or not to sort citations if multiple entry keys are passed to a citation command. If this option is enabled, citations are sorted according to the current bibliography context sorting template (see \secref{use:bib:context}). This feature works with all citation styles.
\boolitem[false]{sortsets}
Whether or not to sort set members according to the active reference context sorting scheme. By default this is false and set members appear in the order given in the data source.
\intitem[3]{maxnames}
A threshold affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list exceeds this threshold, \ie if it holds more than \prm{integer} names, it is automatically truncated according to the setting of the \opt{minnames} option. \opt{maxnames} is the master option which sets \opt{maxbibnames}, \opt{maxcitenames} and \opt{maxsortnames}. Note that the \opt{uniquelist} feature can locally override \opt{maxnames}, see the documentation of the \opt{uniquelist} option in \secref{use:opt:pre:int} and \secref{aut:cav:amb}.
\intitem[1]{minnames}
A limit affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list holds more than \prm{maxnames} names, it is automatically truncated to \prm{minnames} names. The \prm{minnames} value must be smaller than or equal to \prm{maxnames}. \opt{minnames} is the master option which sets both \opt{minbibnames} and \opt{mincitenames}. Like \opt{maxnames} the value of \opt{minnames} can be overridden by \opt{uniquelist}.
\intitem[\prm{maxnames}]{maxbibnames}
Similar to \opt{maxnames} but affects only the bibliography.
\intitem[\prm{minnames}]{minbibnames}
Similar to \opt{minnames} but affects only the bibliography.
\intitem[\prm{maxnames}]{maxcitenames}
Similar to \opt{maxnames} but affects only the citations in the document body.
\intitem[\prm{minnames}]{mincitenames}
Similar to \opt{minnames} but affects only the citations in the document body.
\intitem[\prm{maxbibnames}]{maxsortnames}
Similar to \opt{maxnames} but affects only the names visible to sorting. Since this defaults to \prm{maxbibnames}, you should set this after \opt{maxbibnames} if \opt{maxbibnames} is explicitly set.
\intitem[\prm{minbibnames}]{minsortnames}
Similar to \opt{minnames} but affects only the names visible to sorting. Since this defaults to \prm{minbibnames}, you should set this after \opt{minbibnames} if \opt{minbibnames} is explicitly set.
\intitem[3]{maxitems}
Similar to \opt{maxnames}, but affecting all literal lists (\bibfield{publisher}, \bibfield{location}, etc.).
\intitem[1]{minitems}
Similar to \opt{minnames}, but affecting all literal lists (\bibfield{publisher}, \bibfield{location}, etc.).
\optitem{autocite}{\opt{plain}, \opt{inline}, \opt{footnote}, \opt{superscript}, \opt{...}}
This option controls the behavior of the \cmd{autocite} command discussed in \secref{use:cit:aut}. The \opt{plain} option makes \cmd{autocite} behave like \cmd{cite}, \opt{inline} makes it behave like \cmd{parencite}, \opt{footnote} makes it behave like \cmd{footcite}, and \opt{superscript} makes it behave like \cmd{supercite}. The options \opt{plain}, \opt{inline}, and \opt{footnote} are always available, the \opt{superscript} option is only provided by the numeric citation styles which come with this package. The citation style may also define additional options. The default setting of this option depends on the selected citation style, see \secref{use:xbx:cbx}.
\boolitem[true]{autopunct}
This option controls whether the citation commands scan ahead for punctuation marks. See \secref{use:cit} and \cmd{DeclareAutoPunctuation} in \secref{aut:pct:cfg} for details.
\optitem[autobib]{language}{\opt{autobib}, \opt{autocite}, \opt{auto}, \prm{language}}
This option controls multilingual support. By default \biblatex automatically picks up the active surrounding language from the \sty{babel}/\sty{polyglossia} package\footnote{Note that \biblatex has only limited support for \sty{polyglossia} versions prior to v1.45. If \sty{polyglossia} is used, it should be updated to version~1.45 (2019/10/27) or above.} (and fall back to English if \sty{babel}/\sty{polyglossia} is not available). \opt{autobib} switches the language for each entry in the bibliography using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{autocite} switches the language for each citation using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{auto} is a shorthand to set both \opt{autobib} and \opt{autocite}. It is also possible to select the package language manually. In this case, the language chosen will override the \bibfield{langid} of entries and you should still choose a language switching environment with the \opt{autolang} option to select how the switch to the manually chosen language is handled. Please refer to \tabref{bib:fld:tab1} for a list of supported languages and the corresponding identifiers.
\boolitem[true]{clearlang}
If this option is enabled, \biblatex will automatically clear the \bibfield{language} field of all entries whose language matches the \sty{babel}/\sty{polyglossia} language of the document (or the language specified explicitly with the \opt{language} option) in order to omit redundant language specifications. The language mappings required by this feature are provided by the \cmd{DeclareRedundantLanguages} command from \secref{aut:lng:cmd}.
This option is also settable on a per-type and per-entry basis.
\optitem[none]{autolang}{\opt{none}, \opt{hyphen}, \opt{other}, \opt{other*}, \opt{langname}}
This option controls which \sty{babel} language environment\footnote{\sty{polyglossia} understands the \sty{babel} language environments too and so this option controls both the \sty{babel} and \sty{polyglossia} language environments.} is used if the \sty{babel}/\sty{polyglossia} package is loaded and a bibliography entry includes a \bibfield{langid} field (see \secref{bib:fld:spc}). Note that regardless of the selected value \biblatex automatically adjusts to the main document language if \sty{babel}/\sty{polyglossia} is loaded. In multilingual documents, it will also continually adjust to the current language as far as citations and the default language of the bibliography is concerned. The effect of additional language adjustment, which can negate the effect of picking up the surrounding language, depends on the language environment selected by this option. The possible choices are:
\begin{valuelist}
\item[none]
Do not use any additional enclosing language environment at all. This means that citations and the bibliography are set in the currently active language---this need not be the main language.
\item[hyphen]
Enclose the entry in a \env{hyphenrules} environment. This will load hyphenation patterns for the language specified in the \bibfield{langid} field of the entry, if available. Localisation strings and extra language definitions are not changed and taken from the surrounding language environment.
\item[other]
Enclose the entry in an \env{otherlanguage} environment. This will load hyphenation patterns for the specified language, enable all extra definitions which \sty{babel}/\sty{polyglossia} and \biblatex provide for the respective language, and translate key terms such as <editor> and <volume>. The extra definitions include localisations of the date format, of ordinals, and similar things.
\item[other*]
Enclose the entry in an \env{otherlanguage*} environment. Please note that \biblatex treats \env{otherlanguage*} like \env{otherlanguage} if \opt{langhook} is set to \opt{extras}.
\item[langname]
\sty{polyglossia} only. Enclose the entry in a \env{$<$languagename$>$} environment. The benefit of this option value for \sty{polyglossia} users is that it takes note of the \bibfield{langidopts} field so that you can add per-language options to an entry (like selecting a language variant). When using \sty{babel}, this option does the same as the \opt{other} option value.
\end{valuelist}
\optitem[captions]{langhook}{\opt{captions}, \opt{extras}}
This option controls whether bibliography strings and extras are written to \cmd{captions$<$language$>$} or \cmd{extras$<$language$>$}. The exact effect of this option depend on the language package (\sty{babel}/\sty{polyglossia}). Broadly speaking, the language switching environments provided by those packages (except \env{hyphenrules}) either switch language captions and extras or only language extras. Hence, if this option is set to \opt{extras}, all language switches will affect \biblatex, whereas with \opt{captions} only language switches that also switch other parts of the document language affect \biblatex.
\optitem[none]{block}{\opt{none}, \opt{space}, \opt{par}, \opt{nbpar}, \opt{ragged}}
This option controls the extra spacing between blocks, \ie larger segments of a bibliography entry. The possible choices are:
\begin{valuelist}
\item[none] Do not add anything at all.
\item[space] Insert additional horizontal space between blocks. This is similar to the default behavior of the standard \latex document classes.
\item[par] Start a new paragraph for every block. This is similar to the \opt{openbib} option of the standard \latex document classes.
\item[nbpar] Similar to the \opt{par} option, but disallows page breaks at block boundaries and within an entry.
\item[ragged] Inserts a small negative penalty to encourage line breaks at block boundaries and sets the bibliography ragged right.
\end{valuelist}
The \cmd{newblockpunct} command may also be redefined directly to achieve different results, see \secref{use:fmt:fmt}. Also see \secref{aut:pct:new} for additional information.
\boolitem[false]{locallabelwidth}
This option controls whether \cmd{printbibliography} uses a locally calculated value for \cmd{labelnumberwidth} and \cmd{labelalphawidth} or the global value calculated from all entries. The local value is calculated separately for each bibliography and takes into account only the entries displayed in that bibliography. This option is useful if there are several bibliographies with wildly varying label lengths in the same document.
\optitem[foot+end]{notetype}{\opt{foot+end}, \opt{footonly}, \opt{endonly}}
This option controls the behavior of \cmd{mkbibfootnote}, \cmd{mkbibendnote}, and similar wrappers from \secref{aut:fmt:ich}. The possible choices are:
\begin{valuelist}
\item[foot+end] Support both footnotes and endnotes, \ie \cmd{mkbibfootnote} will generate footnotes and \cmd{mkbibendnote} will generate endnotes.
\item[footonly] Force footnotes, \ie make \cmd{mkbibendnote} generate footnotes.
\item[endonly] Force endnotes, \ie make \cmd{mkbibfootnote} generate endnotes.
\end{valuelist}
\optitem[auto]{hyperref}{\opt{true}, \opt{false}, \opt{auto}, \opt{manual}}
Whether or not to transform citations and back references into clickable hyperlinks. This feature requires the \sty{hyperref} package. It also requires support by the selected citation style. All standard styles which ship with this package support hyperlinks. \kvopt{hyperref}{auto} automatically detects if the \sty{hyperref} package has been loaded. This is the default setting. \kvopt{hyperref}{false} explicitly disables links even if \sty{hyperref} is loaded. \kvopt{hyperref}{true} enables links when \sty{hyperref} is loaded, it cannot explicitly enable links if \sty{hyperref} is not loaded, as such it works exactly like \kvopt{hyperref}{auto} except that it will issue a warning if \sty{hyperref} is not loaded. \kvopt{hyperref}{manual} gives full manual control over \sty{hyperref} interaction, it should only be needed by package authors in very special circumstances. With the \kvopt{hyperref}{manual} setting you are responsible to enable or disable \sty{hyperref} support manually with \cmd{BiblatexManualHyperrefOn} or \cmd{BiblatexManualHyperrefOff} yourself. One of the two commands must be called exactly once; \cmd{BiblatexManualHyperrefOn} can only be called after \sty{hyperref} is loaded.
\boolitem[false]{backref}
Whether or not to print back references in the bibliography. The back references are a list of page numbers indicating the pages on which the respective bibliography entry is cited. If there are \env{refsection} environments in the document, the back references are local to the reference sections. Strictly speaking, this option only controls whether the \biblatex package collects the data required to print such references. This feature still has to be supported by the selected bibliography style. All standard styles which come with this package do so.
\optitem[three]{backrefstyle}{\opt{none}, \opt{three}, \opt{two}, \opt{two+}, \opt{three+}, \opt{all+}}
This option controls how sequences of consecutive pages in the list of back references are formatted. The following styles are available:
\begin{valuelist}
\item[none] Disable this feature, \ie do not compress the page list.
\item[three] Compress any sequence of three or more consecutive pages to a range, \eg the list <1, 2, 11, 12, 13, 21, 22, 23, 24> is compressed to <1, 2, 11--13, 21--24>.
\item[two] Compress any sequence of two or more consecutive pages to a range, \eg the above list is compressed to <1--2, 11--13, 21--24>.
\item[two+] Similar in concept to \opt{two} but a sequence of exactly two consecutive pages is printed using the starting page and the localisation string \texttt{sequens}, \eg the above list is compressed to <1\,sq., 11--13, 21--24>.
\item[three+] Similar in concept to \opt{two+} but a sequence of exactly three consecutive pages is printed using the starting page and the localisation string \texttt{sequentes}, \eg the above list is compressed to <1\,sq., 11\,sqq., 21--24>.
\item[all+] Similar in concept to \opt{three+} but any sequence of consecutive pages is printed as an open-ended range, \eg the above list is compressed to <1\,sq., 11\,sqq., 21\,sqq.>.
\end{valuelist}
All styles support both Arabic and Roman numerals. In order to avoid potentially ambiguous lists, different sets of numerals will not be mixed when generating ranges, \eg the list <iii, iv, v, 6, 7, 8> is compressed to <iii--v, 6--8>.
\optitem[setonly]{backrefsetstyle}{\opt{setonly}, \opt{memonly}, \opt{setormem}, \opt{setandmem}, \opt{memandset}, \opt{setplusmem}}
This option controls how back references to \bibtype{set} entries and their members are handled. The following options are available:
\begin{valuelist}
\item[setonly] All back references are added to the \bibtype{set} entry. The \bibfield{pageref} lists of set members remain blank.
\item[memonly] References to set members are added to the respective member. References to the \bibtype{set} entry are added to all members. The \bibfield{pageref} list of the \bibtype{set} entry remains blank.
\item[setormem] References to the \bibtype{set} entry are added to the \bibtype{set} entry. References to set members are added to the respective member.
\item[setandmem] References to the \bibtype{set} entry are added to the \bibtype{set} entry. References to set members are added to the respective member and to the \bibtype{set} entry.
\item[memandset] References to the \bibtype{set} entry are added to the \bibtype{set} entry and to all members. References to set members are added to the respective member.
\item[setplusmem] References to the \bibtype{set} entry are added to the \bibtype{set} entry and to all members. References to set members are added to the respective member and to the \bibtype{set} entry.
\end{valuelist}
\boolitem[true]{backreffloats}
Whether to enable back references to citations in floats.
\optitem[false]{indexing}{\opt{true}, \opt{false}, \opt{cite}, \opt{bib}}
This option controls indexing in citations and in the bibliography. More precisely, it affects the \cmd{ifciteindex} and \cmd{ifbibindex} commands from \secref{aut:aux:tst}. The option is settable on a global, a per-type, or on a per-entry basis. The possible choices are:
\begin{valuelist}
\item[true] Enable indexing globally.
\item[false] Disable indexing globally.
\item[cite] Enable indexing in citations only.
\item[bib] Enable indexing in the bibliography only.
\end{valuelist}
This feature requires support by the selected citation style. All standard styles which come with this package support indexing of both citations and entries in the bibliography. Note that you still need to enable indexing globally with \cmd{makeindex} to get an index.
\boolitem[false]{loadfiles}
This option controls whether external files requested by way of the \cmd{printfile} command are loaded. See also \secref{use:use:prf} and \cmd{printfile} in \secref{aut:bib:dat}. Note that this feature is disabled by default for performance reasons.
\optitem[none]{refsection}{\opt{none}, \opt{part}, \opt{chapter}, \opt{chapter+}, \opt{section}, \opt{section+}, \opt{subsection}, \opt{subsection+}}
This option automatically starts a new reference section at a document division such as a chapter or a section. This is equivalent to the \cmd{newrefsection} command, see \secref{use:bib:sec} for details. The following choice of document divisions is available:
\begin{valuelist}
\item[none] Disable this feature.
\item[part] Start a reference section at every \cmd{part} command.
\item[chapter] Start a reference section at every \cmd{chapter} command.
\item[chapter+] Start a reference section at every \cmd{chapter} and every higher level of sectioning, i.e. \cmd{part}.
\item[section] Start a reference section at every \cmd{section} command.
\item[section+] Start a reference section at every \cmd{section} and every higher level of sectioning, i.e. \cmd{part} and \cmd{chapter} (if available).
\item[subsection] Start a reference section at every \cmd{subsection} command.
\item[subsection+] Start a reference section at every \cmd{subsection} and every higher level of sectioning, i.e. \cmd{part}, \cmd{chapter} (if available) and \cmd{section}.
\end{valuelist}
%
The starred versions of these commands will not start a new reference section.
\optitem[none]{refsegment}{\opt{none}, \opt{part}, \opt{chapter}, \opt{chapter+}, \opt{section}, \opt{section+}, \opt{subsection}, \opt{subsection+}}
Similar to the \opt{refsection} option but starts a new reference segment. This is equivalent to the \cmd{newrefsegment} command, see \secref{use:bib:seg} for details. When using both options, note that you can only apply this option to a lower"=level document division than the one \opt{refsection} is applied to and that nested reference segments will be local to the enclosing reference section.
\optitem[none]{citereset}{\opt{none}, \opt{part}, \opt{chapter}, \opt{chapter+}, \opt{section}, \opt{section+}, \opt{subsection}, \opt{subsection+}}
This option automatically executes the \cmd{citereset} command from \secref{use:cit:msc} at a document division such as a chapter or a section. The following choice of document divisions is available:
\begin{valuelist}
\item[none] Disable this feature.
\item[part] Perform a reset at every \cmd{part} command.
\item[chapter] Perform a reset at every \cmd{chapter} command.
\item[chapter+] Perform a reset at every \cmd{chapter} and \cmd{part} command.
\item[section] Perform a reset at every \cmd{section} command.
\item[section+] Perform a reset at every \cmd{section}, \prm{chapter} (if supported by the class) and \cmd{part} command.
\item[subsection] Perform a reset at every \cmd{subsection} command.
\item[subsection+] Perform a reset at every \cmd{subsection}, \cmd{section}, \prm{chapter} (if supported by the class) and \cmd{part} command.
\end{valuelist}
\boolitem[true]{abbreviate}
Whether or not to use long or abbreviated strings in citations and in the bibliography. This option affects the localisation modules. If this option is enabled, key terms such as <editor> are abbreviated. If not, they are written out.
This option is also settable on a per-type or per-entry basis.
\optitem[comp]{date}{\opt{year}, \opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{ymd}, \opt{iso}}
This option controls the basic format of printed date specifications. The following choices are available:
\begin{valuelist}
\item[year] Use only years, for example:\par
2010\par
2010--2012\par
\item[short] Use the short format with verbose ranges, for example:\par
01/01/2010\par
21/01/2010--30/01/2010\par
01/21/2010--01/30/2010
\item[long] Use the long format with verbose ranges, for example:\par
1st January 2010\par
21st January 2010--30th January 2010\par
January 21, 2010--January 30, 2010\par
\item[terse] Use the short format with compact ranges, for example:\par
21--30/01/2010\par
01/21--01/30/2010
\item[comp] Use the long format with compact ranges, for example:\par
21st--30th January 2010\par
January 21--30, 2010\par
\item[iso] Use ISO8601 Extended Format (\texttt{yyyy-mm-dd}), for example:\par
2010-01-01\par
2010-01-21/2010-01-30
\item[ymd] A year-month-day format which can be modified by other options unlike strict \acr{ISO8601-2}, for example:\par
2010-1-1\par
2010-1-21/2010-1-30
\end{valuelist}
%
Note that \opt{iso} format will enforce \kvopt{dateera}{astronomical}, \kvopt{datezeros}{true}, \kvopt{timezeros}{true}, \kvopt{seconds}{true}, \kvopt{$<$datetype$>$time}{24h} and \kvopt{julian}{false}. \opt{ymd} is an EDTF-like format but which can change the various options which the strict \opt{iso} option does not allow for.
As seen in the above examples, the actual date format is language specific. Note that the month name in all long formats is responsive to the \opt{abbreviate} package option. The leading zeros for months and days in all short formats may be controlled separately with the \opt{datezeros} package option. The leading zeros for hours, minutes and seconds in all short formats may be controlled separately with the \opt{timezeros} package option. If outputting times, the printing of seconds and timezones is controlled by the \opt{seconds} and \opt{timezones} options respectively.
The options \opt{julian} and \opt{gregorianstart} may be used to control when to output Julian Calendar dates.
\optitem[year]{labeldate}{\opt{year}, \opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{ymd}, \opt{iso}}
Similar to the \opt{date} option but controls the format of the date field selected with \cmd{DeclareLabeldate}.
\optitem[comp]{$<$datetype$>$date}{\opt{year}, \opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{ymd}, \opt{iso}}
Similar to the \opt{date} option but controls the format of the \bibfield{$<$datetype$>$date} field in the datamodel.
\optitem{alldates}{\opt{year}, \opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso}}
Sets the option for all dates in the datamodel to the same value. The date fields in the default data model are \bibfield{date}, \bibfield{origdate}, \bibfield{eventdate} and \bibfield{urldate}.
\boolitem[false]{julian}
This option controls whether dates before the date specified in the \opt{gregorianstart} option will be converted automatically to the Julian Calendar. Dates so changed will return <true> for the \cmd{ifdatejulian} and \cmd{if$<$datetype$>$datejulian} tests (see \secref{aut:aux:tst}). Please bear in mind that dates consisting of just a year like <1565> will never be converted to a Julian Calendar date because a date without a month and day has an ambiguous Julian Calendar representation\footnote{This is potentially true for dates missing times too but this is not relevant for bibliographic work.}. For example, in the case of <1565>, this is Julian year <1564> until after the Gregorian date <10th January 1565> when the Julian year becomes <1565>.
\valitem{gregorianstart}{YYYY-MM-DD}
This option controls the date before which dates are converted to the Julian Calendar. It is a strict format string, 4-digit year, 2-digit month and day, separated by a single dash character (any valid Unicode character with the <Dash> property). The default is '1582-10-15', the date of the instigation of the standard Gregorian Calendar. This option does not nothing unless \opt{julian} is set to <true>.
\boolitem[true]{datezeros}
This option controls whether \texttt{short} and \texttt{terse} date components are printed with leading zeros unless overridden by specific formatting.
\boolitem[true]{timezeros}
This option controls whether time components are printed with leading zeros unless overridden by specific formatting.
\boolitem[false]{timezones}
This option controls whether timezones are printed when printing times.
\boolitem[false]{seconds}
This option controls whether seconds are printed when printing times.
\boolitem[true]{dateabbrev}
This option controls whether \texttt{long} and \texttt{comp} dates are printed with long or abbreviated month/season names. The option is similar to the generic \opt{abbreviate} option but specific to the date formatting.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{datecirca}
This option controls whether to output <circa> information about dates. If set to \opt{true}, dates will be preceded by the expansion of the \cmd{datecircaprint} macro (\secref{use:fmt:fmt}).
\boolitem[false]{dateuncertain}
This option controls whether to output uncertainty information about dates. If set to \opt{true}, dates will be followed by the expansion of the \cmd{dateuncertainprint} macro and end dates will be followed by the \cmd{enddateuncertainprint} macro (\secref{use:fmt:fmt}).
\optitem[astronomical]{dateera}{\opt{astronomical}, \opt{secular}, \opt{christian}}
This option controls how date era information is printed. <astronomical> uses \cmd{dateeraprintpre} to print era information \emph{before} start/end dates. <secular> and <christian> uses \cmd{dateeraprint} to print era information \emph{after} the start/end/dates. By default <astronomical> results in a minus sign before BCE/BC dates and <secular>/<christian> results in the relevant localisation strings like <BCE> or <BC> after BCE/BC dates. See the relevant comments in \secref{use:fmt:fmt} and the localisation strings in \secref{aut:lng:key:dt}.
\intitem[0]{dateeraauto}
This option sets the astronomical year, below which era localisation strings are automatically added. This option does nothing without \opt{dateera} being set to <secular> or <christian>.
\optitem[24h]{time}{\opt{12h}, \opt{24h}, \opt{24hcomp}}
This option controls the basic format of printed time specifications. The following choices are available:
\begin{valuelist}
\item[24h] 24-hour format, for example:\par
14:03:23\par
14:3:23\par
14:03:23+05:00\par
14:03:23Z\par
14:21:23--14:23:45\par
14:23:23--14:23:45\par
\item[24hcomp] 24-hour format with compressed ranges, for example:\par
14:21--23 (hours are the same)\par
14:23:23--45 (hour and minute are the same)\par
\item[12h] 12-hour format with (localised) AM/PM markers, for example:\par
2:34 PM\par
2:34 PM--3:50 PM\par
\end{valuelist}
%
As seen in the above examples, the actual time format is language specific. Note that the AM/PM string is responsive to the \opt{abbreviate} package option, if this makes a difference in the specific locale. The leading zeros in the 24-hour formats may be controlled separately with the \opt{timezeros} package option. The separator between time components (\cmd{bibtimesep} and \cmd{bibtzminsep}) and between the time and any timezone (\cmd{bibtimezonesep}) are also language specific and customisable, see \secref{use:fmt:lng}. There are global package options which determine whether seconds and timezones are printed (\opt{seconds} and \opt{timezones}, respectively, see \secref{use:opt:pre:gen}). Timezones, if present, are either <Z> or a numeric positive or negative offset. No default styles print time information. Custom styles may print times by using the \cmd{print$<$datetype$>$time} commands, see \secref{aut:bib:dat}.
\optitem[24h]{labeltime}{\opt{12h}, \opt{24h}, \opt{24hcomp}}
Similar to the \opt{time} option but controls the format of the time part fields obtained from the field selected with \cmd{DeclareLabeldate}.
\optitem[24h]{$<$datetype$>$time}{\opt{12h}, \opt{24h}, \opt{24hcomp}}
Similar to the \opt{time} option but controls the format of the time part fields obtained from the \bibfield{$<$datetype$>$date} field in the datamodel.
\optitem{alltimes}{\opt{12h}, \opt{24h}, \opt{24hcomp}}
Sets \opt{labeltime} and the \opt{$<$datetype$>$time} option for all times in the datamodel to the same value. The date fields supporting time parts in the default data model are \bibfield{date}, \bibfield{origdate}, \bibfield{eventdate} and \bibfield{urldate}.
\boolitem[false]{dateusetime}
Specifies whether to print any time component of a date field after the date component. The separator between the date and time components is \cmd{bibdatetimesep} from \secref{use:fmt:lng}.
\boolitem[false]{labeldateusetime}
Similar to the \opt{dateusetime} option but controls the whether to print time components for the field selected with \cmd{DeclareLabeldate}.
\boolitem[false]{$<$datetype$>$dateusetime}
Similar to the \opt{dateusetime} option but controls the whether to print time components for the \bibfield{$<$datetype$>$date} field in the datamodel.
\boolitem[false]{alldatesusetime}
Sets \opt{labeldateusetime} and the \opt{$<$datetype$>$dateusetime} option for all \bibfield{$<$datetype$>$date} fields in the datamoel.
\boolitem[false]{defernumbers}
In contrast to standard \latex, the numeric labels generated by this package are normally assigned to the full list of references at the beginning of the document body. If this option is enabled, numeric labels (\ie the \bibfield{labelnumber} field discussed in \secref{aut:bbx:fld}) are assigned the first time an entry is printed in any bibliography. See \secref{use:cav:lab} for further explanation. This option requires two \latex runs after the data has been exported to the \file{bbl} file by the backend (in addition to any other runs required by page breaks changing etc.). An important thing to note is that if you are using this option, then changes to options, the \file{bib} file or certain commands like \cmd{printbibliography} will usually require that you delete your current \file{aux} file and re-run \latex to obtain the correct numbering. See \secref{aut:int}.
\boolitem[false]{punctfont}
This option enables an alternative mechanism for dealing with unit punctuation after a field printed in a different font (for example, a title printed in italics). See \cmd{setpunctfont} in \secref{aut:pct:new} for details.
\optitem[abs]{arxiv}{\opt{abs}, \opt{ps}, \opt{pdf}, \opt{format}}
Path selector for arXiv links. If hyperlink support is enabled, this option controls which version of the document the arXiv \bibfield{eprint} links will point to. The following choices are available:
\begin{valuelist}
\item[abs] Link to the abstract page.
\item[ps] Link to the PostScript version.
\item[pdf] Link to the \pdf version.
\item[format] Link to the format selector page.
\end{valuelist}
See \secref{use:use:epr} for details on support for arXiv and electronic publishing information.
\optitem[auto]{texencoding}{\opt{auto}, \prm{encoding}}
Specifies the encoding of the \file{tex} file. This option affects the data transferred from the backend to \biblatex. This corresponds to \biber's \opt{--output-encoding} option. The following choices are available:
\begin{valuelist}
\item[auto] Try to auto-detect the input encoding. If the \sty{inputenc}\slash \sty{inputenx}\slash \sty{luainputenc} package is available, \biblatex will get the main encoding from that package. If not, it assumes \utf encoding if a \latex format using at least the April 2018 version of the kernel, \xetex or \luatex has been detected, and Ascii otherwise.
\item[\prm{encoding}] Specifies the \prm{encoding} explicitly. This is for odd cases in which auto-detection fails or you want to force a certain encoding for some reason.
\end{valuelist}
%
Note that setting \kvopt{texencoding}{\prm{encoding}} will also affect the \opt{bibencoding} option if \kvopt{bibencoding}{auto}.
\optitem[auto]{bibencoding}{\opt{auto}, \prm{encoding}}
Specifies the default encoding of the \file{bib} files. This can be overridden on a per-datasource basis using the \opt{bibencoding} option to \cmd{addbibresource}, see \secref{use:bib:res}. This option corresponds to \biber's \opt{--input-encoding} option. The following choices are available:
\begin{valuelist}
\item[auto] Use this option if the workflow is transparent, \ie if the encoding of the \file{bib} file is identical to the encoding of the \file{tex} file.
\item[\prm{encoding}] If the encoding of the \file{bib} file is different from the one of the \file{tex} file, you need to specify it explicitly.
\end{valuelist}
By default, \biblatex assumes that the \file{tex} file and the \file{bib} file use the same encoding (\kvopt{bibencoding}{auto}).
\boolitem[false]{safeinputenc}
If this option is enabled, \biblatex will automatically force \kvopt{texencoding}{ascii} if the \sty{inputenc}\slash \sty{inputenx} package has been loaded and the input encoding is \utf, \ie it will ignore any macro-based \utf support and use Ascii only. \biber will then try to convert any non-Ascii data in the \file{bib} file to Ascii. For example, it will convert \texttt{\d{S}} to |\d{S}|. See \secref{bib:cav:enc:enc} for an explanation of why you may want to enable this option.
\boolitem[true]{bibwarn}
By default, \biblatex will report warnings issued by the backend concerning the data in the \file{bib} file as \latex warnings. Use this option to suppress such warnings.
\intitem[2]{mincrossrefs}
Sets the minimum number of cross references to \prm{integer} when requesting a backend run.\footnote{If an entry which is cross-referenced by other entries in the \file{bib} file hits this threshold, it is included in the bibliography even if it has not been cited explicitly. This is a standard feature of the \bibtex format and not specific to \biblatex. See the description of the \bibfield{crossref} field in \secref{bib:fld:spc} for further information.} This option also affects the handling of the \bibfield{xref} field. See the field description in \secref{bib:fld:spc} as well as \secref{bib:cav:ref} for details.
\intitem[2]{minxrefs}
As \opt{mincrossrefs} but for \bibfield{xref} fields.
\boolitem[true]{bibtexcaseprotection}
This option only has an effect when the \sty{expl3} implementation of the case changing functions is selected. If the option is set to \opt{true}, \cmd{MakeSentenceCase*} supports brace protection of words from case change as in classical \bibtex. If the option is set to \opt{false}, pairs of braces no longer imply case protection, which can now be enforced by wrapping the relevant word in \cmd{NoCaseChange}---this makes for a less confusing, if more verbose, markup of case protection.
\end{optionlist}
\paragraph{Style-specific}
\label{use:opt:pre:bbx}
The following options are provided by all standard bibliography styles (as opposed to the core package). The options are available as preamble options like those in \secref{use:opt:pre:gen} and at a per-type and per-entry scope.
\begin{optionlist}
\boolitem[true]{isbn}
This option controls whether the fields \bibfield{isbn}\slash \bibfield{issn}\slash \bibfield{isrn} are printed.
\boolitem[true]{url}
This option controls whether the \bibfield{url} field and the access date is printed. The option only affects entry types whose \bibfield{url} information is optional. The \bibfield{url} field of \bibtype{online} entries is always printed.
\boolitem[true]{doi}
This option controls whether the field \bibfield{doi} is printed.
\boolitem[true]{eprint}
This option controls whether \bibfield{eprint} information is printed.
\boolitem[true]{related}
Whether to use information from related entries or not. See \secref{use:rel}.
\end{optionlist}
\subparagraph{\texttt{alphabetic}/\texttt{numeric}} Additionally, styles of the \texttt{alphabetic} and \texttt{numeric} family support the \opt{subentry} option in global, per-type and per-entry scope.
\begin{optionlist}
\boolitem[false]{subentry}
This option affects the handling of citations to set members and the display of sets in the bibliography. If the option is enabled, citations to individual set members feature an additional letter that identifies the member, that letter is also printed in the bibliography. If the option is disabled, a citation to the member of a set will display just as a citation to the entire set and there will be no additional letters in the bibliography entries enumerating the members.
Suppose \texttt{key1} and \texttt{key2} are members of the set \texttt{set1}. With \opt{subentry} set to \texttt{true} in a numeric style a citation to \texttt{key1} will show as <[1a]> and a citation to \texttt{key2} as <[1b]>, while the entire set \texttt{set1} will be cited as <[1]>. Furthermore <(a)> and <(b)> will be added in front of the entry data for the set members in the bibliography entry for the set. With \opt{subentry} set to \texttt{false} citations to all three keys will show as <[1]>, no additional letter will be printed in the bibliography.
\end{optionlist}
\subparagraph{\texttt{numeric-comp}} The citation style \texttt{numeric-comp} supports the \opt{subentrycomp} option in global, per-type and per-entry scope.
\begin{optionlist}
\boolitem[true]{subentrycomp}
This option determines whether or not citations to set members are compressed similar to non-set citations. The option only has an effect if \opt{subentry} is set to \texttt{true}.
Suppose \texttt{key1}, \texttt{key2} and \texttt{key3} are members of the set \texttt{set1}. With \opt{subentrycomp} set to \texttt{true} the three entries will be compressed to <[1a--c]> in citations. With \opt{subentry} set to \texttt{false} the citation will show in the more verbose form <[1a, 1b, 1c]>.
The option is intended mainly for backwards compatibility, because earlier versions of \biblatex did not compress set member citations.
\end{optionlist}
\subparagraph{\texttt{authortitle}/\texttt{authoryear}} All bibliography styles of the \texttt{authoryear} and \texttt{authortitle} family as well as all bibliography styles of the \texttt{verbose} family---whose bibliography styles are based on \texttt{authortitle}---support the option \opt{dashed} in global scope.
\begin{optionlist}
\boolitem[true]{dashed}
This option controls whether recurrent the same author\slash editor list in the bibliography are replaced by a dash (\cmd{bibnamdeash}, see \secref{use:fmt:fmt}). If the option is enabled, subsequent mentions of the same name list at the beginning of an entry are replaced by a dash provided the entry is not the first on the current page. If the option is disabled, name lists are never replaced by a dash.
\end{optionlist}
\subparagraph{\texttt{authoryear}} Bibliography styles of the \texttt{authoryear} family provide the option \opt{mergedate} in global, per-type and per-entry scope.
\begin{optionlist}
\optitem[true]{mergedate}{\opt{false}, \opt{minimum}, \opt{basic}, \opt{compact}, \opt{maximum}, \opt{true}}
This option controls whether and how the date specification in the entry is merged with the date label shown directly after the author\slash editor list.
\begin{valuelist}
\item[false] Strictly separate the date specification shown in the entry (styled with \opt{date}) from the date label (styled with \opt{labeldate}). The date will always be shown twice.
\item[minimum] Omit the date specification whenever it coincides \emph{exactly}---including \bibfield{extradate} information---with the output of the date label.
\item[basic] Similar to \opt{minimum}, but the date specification will also be omitted if it differs from the date label only by the absence of the \bibfield{extradate} letter.
\item[compact] Merges all date specifications with the date label. The date format of that merged date label is controlled by \opt{date}, not \opt{labeldate}, even if it is printed in the position of the date label. The \bibfield{issue} field is not merged.
\item[maximum] Like \opt{compact}, but if present the \bibfield{issue} field will also be moved into the date label at the beginning of the entry.
\item[true] An alias for \opt{compact}.
\end{valuelist}
More in-depth examples of this option can be found in the style examples.
\end{optionlist}
\subparagraph{<ibid> styles} Citation styles with <ibid.>\ function, namely \texttt{authortitle-ibid}, \texttt{author\allowbreakhere title-icomp}, \texttt{author\allowbreakhere year-ibid}, \texttt{authoryear-icomp}, \texttt{ver\allowbreakhere bose-ibid}, \texttt{verbose-inote}, \texttt{verbose-trad1}, \texttt{verbose-trad2} and \texttt{verbose-trad3} provide the global \opt{ibidpage} option.
\begin{optionlist}
\boolitem[false]{ibidpage}
Whether \emph{ibidem} without page reference means <same work> or <same work + same page>. If set to \texttt{true} a page range postnote will be suppressed in an \emph{ibidem} citation if the last citation was to the same page range. With \texttt{ibidpage=false} the postnote is not omitted. Citations to different page ranges than the previous always produce the page ranges with either setting.
\end{optionlist}
\subparagraph{\texttt{verbose}} All citation styles of the \texttt{verbose} family provide the global option \opt{citepages}.
\begin{optionlist}
\optitem[permit]{citepages}{\opt{permit}, \opt{suppress}, \opt{omit}, \opt{separate}}
This option controls the output of the \bibfield{page}\slash\bibfield{pagetotal} field in the full citation in combination with a postnote containing a page range. The option can be used to suppress references to two page ranges in full citations like the following
\begin{quote}
Author. \enquote{Title.} In: \emph{Book,} pp.\,100--150, p.\,125.
\end{quote}
Here <p.\,125> is the \bibfield{postnote} argument and <pp.\,100--150> is the value of the \bibfield{pages} field.
\begin{valuelist}
\item[permit] Allow duplication of page specifications, i.e.\ print both \bibfield{page}\slash\bibfield{pagetotal} and \bibfield{postnote}.
\item[suppress] Unconditionally suppress the \bibfield{pages}\slash \bibfield{pagetotal} fields in citations, regardless of the \bibfield{postnote}.
\item[omit] Suppress the \bibfield{pages}\slash \bibfield{pagetotal} if the \bibfield{postnote} contains a page range. They are still printed if there is no \bibfield{postnote} or if the \bibfield{postnote} is not a number or range.
\item[separate] Separate the \bibfield{pages}\slash \bibfield{pagetotal} from the \bibfield{postnote} if the latter contains a page range. The string \texttt{thiscite} is added to separate the two page ranges.
\end{valuelist}
\end{optionlist}
\subparagraph{\texttt{verbose-trad}} The citation styles of the \texttt{verbose-trad} family support the global option \opt{strict}.
\begin{optionlist}
\boolitem[false]{strict}
This option allows to restrict the use of the scholarly abbreviations <ibid.> and <op.~cit.> to avoid ambiguities. If the option is set to \texttt{true} these terms will only be used if the relevant work was cited in the same or previous footnote.
\end{optionlist}
\subparagraph{\texttt{reading}} The \texttt{reading} style supports a number of additional options, but these are not of general interest and can be found in the style example.
\paragraph{Internal}
\label{use:opt:pre:int}
The default settings of the following preamble options are controlled by bibliography and citation styles. Apart from the \opt{pagetracker} and \opt{$<$name$>$inits} options, which you may want to adapt, there is normally no need to set them explicitly.
\begin{optionlist}
\optitem[false]{pagetracker}{\opt{true}, \opt{false}, \opt{page}, \opt{spread}}
This option controls the page tracker which is required by the \cmd{ifsamepage} and \cmd{iffirstonpage} tests from \secref{aut:aux:tst}. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in automatic mode. This is like \opt{spread} if \latex is in twoside mode, and like \opt{page} otherwise.
\item[false] Disable the tracker.
\item[page] Enable the tracker in page mode. In this mode, tracking works on a per"=page basis.
\item[spread] Enable the tracker in spread mode. In this mode, tracking works on a per"=spread (double page) basis.
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
\optitem[false]{citecounter}{\opt{true}, \opt{false}, \opt{context}}
This option controls the citation counter which is required by \cnt{citecounter} from \secref{aut:aux:tst}. The possible choices are:
\begin{valuelist}
\item[true] Enable the citation counter in global mode.
\item[false] Disable the citation counter.
\item[context] Enable the citation counter in context"=sensitive mode. In this mode, citations in footnotes and in the body text are counted independently.
\end{valuelist}
\optitem[false]{citetracker}{\opt{true}, \opt{false}, \opt{context}, \opt{strict}, \opt{constrict}}
This option controls the citation tracker which is required by the \cmd{ifciteseen} and \cmd{ifentryseen} tests from \secref{aut:aux:tst}. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in global mode.
\item[false] Disable the tracker.
\item[context] Enable the tracker in context"=sensitive mode. In this mode, citations in footnotes and in the body text are tracked independently.
\item[strict] Enable the tracker in strict mode. In this mode, an item is only considered by the tracker if it appeared in a stand-alone citation, \ie if a single entry key was passed to the citation command.
\item[constrict] This mode combines the features of \opt{context} and \opt{strict}.
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
This option is also settable on a per-type or per-entry basis.
\optitem[false]{ibidtracker}{\opt{true}, \opt{false}, \opt{context}, \opt{strict}, \opt{constrict}}
This option controls the <ibidem> tracker which is required by the \cmd{ifciteibid} test from \secref{aut:aux:tst}. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in global mode.
\item[false] Disable the tracker.
\item[context] Enable the tracker in context"=sensitive mode. In this mode, citations in footnotes and in the body text are tracked separately.
\item[strict] Enable the tracker in strict mode. In this mode, potentially ambiguous references are suppressed. A reference is considered ambiguous if either the current citation (the one including the <ibidem>) or the previous citation (the one the <ibidem> refers to) consists of a list of references.\footnote{For example, suppose the initial citation is «Jones, \emph{Title}; Williams, \emph{Title}» and the following one «ibidem». From a technical point of view, it is fairly clear that the <ibidem> refers to <Williams> because this is the last reference processed by the previous citation command. To a human reader, however, this may not be obvious because the <ibidem> may also refer to both titles. The strict mode avoids such ambiguous references.}
\item[constrict] This mode combines the features of \opt{context} and \opt{strict}. It also keeps track of footnote numbers and detects potentially ambiguous references in footnotes in a stricter way than the \opt{strict} option. In addition to the conditions imposed by the \opt{strict} option, a reference in a footnote will only be considered as unambiguous if the current citation and the previous citation are given in the same footnote or in immediately consecutive footnotes.
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
This option is also settable on a per-type or per-entry basis.
\optitem[false]{opcittracker}{\opt{true}, \opt{false}, \opt{context}, \opt{strict}, \opt{constrict}}
This option controls the <opcit> tracker which is required by the \cmd{ifopcit} test from \secref{aut:aux:tst}. This feature is similar to the <ibidem> tracker, except that it tracks citations on a per-author/editor basis, \ie \cmd{ifopcit} will yield \texttt{true} if the cited item is the same as the last one by this author\slash editor. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in global mode.
\item[false] Disable the tracker.
\item[context] Enable the tracker in context"=sensitive mode. In this mode, citations in footnotes and in the body text are tracked separately.
\item[strict] Enable the tracker in strict mode. In this mode, potentially ambiguous references are suppressed. See \kvopt{ibidtracker}{strict} for details.
\item[constrict] This mode combines the features of \opt{context} and \opt{strict}. See the explanation of \kvopt{ibidtracker}{constrict} for details.
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
This option is also settable on a per-type or per-entry basis.
\optitem[false]{loccittracker}{\opt{true}, \opt{false}, \opt{context}, \opt{strict}, \opt{constrict}}
This option controls the <loccit> tracker which is required by the \cmd{ifloccit} test from \secref{aut:aux:tst}. This feature is similar to the <opcit> tracker except that it also checks whether the \prm{postnote} arguments match, \ie \cmd{ifloccit} will yield \texttt{true} if the citation refers to the same page cited before. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in global mode.
\item[false] Disable the tracker.
\item[context] Enable the tracker in context"=sensitive mode. In this mode, citations in footnotes and in the body text are tracked separately.
\item[strict] Enable the tracker in strict mode. In this mode, potentially ambiguous references are suppressed. See \kvopt{ibidtracker}{strict} for details. In addition to that, this mode also checks if the \prm{postnote} argument is numerical (based on \cmd{ifnumerals} from \secref{aut:aux:tst}).
\item[constrict] This mode combines the features of \opt{context} and \opt{strict}. See the explanation of \kvopt{ibidtracker}{constrict} for details. In addition to that, this mode also checks if the \prm{postnote} argument is numerical (based on \cmd{ifnumerals} from \secref{aut:aux:tst}).
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
This option is also settable on a per-type or per-entry basis.
\optitem[false]{idemtracker}{\opt{true}, \opt{false}, \opt{context}, \opt{strict}, \opt{constrict}}
This option controls the <idem> tracker which is required by the \cmd{ifciteidem} test from \secref{aut:aux:tst}. The possible choices are:
\begin{valuelist}
\item[true] Enable the tracker in global mode.
\item[false] Disable the tracker.
\item[context] Enable the tracker in context"=sensitive mode. In this mode, citations in footnotes and in the body text are tracked separately.
\item[strict] This is an alias for \texttt{true}, provided only for consistency with the other trackers. Since <idem> replacements do not get ambiguous in the same way as <ibidem> or <op.~cit.>, the \texttt{strict} tracking mode does not apply to them.
\item[constrict] This mode is similar to \opt{context} with one additional condition: a reference in a footnote will only be considered as unambiguous if the current citation and the previous citation are given in the same footnote or in immediately consecutive footnotes.
\end{valuelist}
Note that this tracker is disabled in all floats unless explicitly requested with \opt{trackfloats}, see \secref{aut:cav:flt}.
This option is also settable on a per-type or per-entry basis.
\boolitem[false]{trackfloats}
Whether to enable citation tracking in floats. Citation tracking in floats can be tricky, so this option should only be enabled if absolutely necessary and the output should be scrutinised carefully, see also \secref{aut:cav:flt}.
\boolitem[true]{parentracker}
This option controls the parenthesis tracker which keeps track of nested parentheses and brackets. This information is used by \cmd{parentext} and \cmd{brackettext} from \secref{use:cit:txt}, \cmd{mkbibparens} and \cmd{mkbibbrackets} from \secref{aut:fmt:ich} and \cmd{bibopenparen}, \cmd{bibcloseparen}, \cmd{bibopenbracket}, \cmd{bibclosebracket} (also \secref{aut:fmt:ich}).
\intitem[3]{maxparens}
The maximum permitted nesting level of parentheses and brackets. If parentheses and brackets are nested deeper than this value, \biblatex will issue errors.
\boolitem[false]{$<$namepart$>$inits}
The option sets the \cmd{if$<$namepart$>$inits} test from \secref{aut:aux:tst}. \texttt{$<$namepart$>$} is any valid name part as defined in the data model by the \cmd{DeclareDatamodelConstant} command (\secref{aut:bbx:drv}). For the given name, for example, the option becomes \opt{giveninits}.
This option is also settable on a per-type, per-entry, per-namelist and per-name basis.
If \opt{giveninits} is set to \opt{true}, the default name formats will only render the given name initials and not the full given name. The standard styles only use the test \cmd{ifgiveninits} and hence only respond to the option \opt{giveninits}. Setting the option for a name part different from \texttt{given} has no effect on the default name formats.
Note that sorting and name uniqueness are not automatically affected by this option, that have to be requested explicitly via \cmd{DeclareSortingNamekeyTemplate} and the \opt{uniquename} option (or \cmd{DeclareUniquenameTemplate}), respectively. A warning will be issued if \opt{giveninits} is used together with \opt{uniquename} set to one of the \opt{full} values and \opt{uniquename} is automatically set to the corresponding \opt{init} value.
\boolitem[false]{terseinits}
This option controls the format of all initials generated by \biblatex. If enabled, initials are rendered using a terse format without dots and spaces. For example, the initials of Donald Ervin Knuth would be rendered as <D.~E.> by default, and as <DE> if this option is enabled. The option will affect the \cmd{ifterseinits} test from \secref{aut:aux:tst}. The option works by redefining some macros which control the format of initials. See \secref{use:cav:nam} for details.
This option is also settable on a per-type, per-entry, per-name and per-namelist basis.
\boolitem[false]{labelalpha}
Whether or not to provide the special fields \bibfield{labelalpha} and \bibfield{extraalpha}, see \secref{aut:bbx:fld} for details.
This option is also settable on a per-type and per-entry basis. See also \opt{maxalphanames} and \opt{minalphanames}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\intitem[3]{maxalphanames}
Similar to the \opt{maxnames} option but customizes the format of the \bibfield{labelalpha} field.
\intitem[1]{minalphanames}
Similar to the \opt{minnames} option but customizes the format of the \bibfield{labelalpha} field.
\boolitem[false]{labelnumber}
Whether or not to provide the special field \bibfield{labelnumber}, see \secref{aut:bbx:fld} for details.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{noroman}
Whether or not to try to parse roman numerals encountered in integer fields for sorting purposes. Since \biber also tries to parse alphanumeric values when sorting integer fields, this roman numeral parsing can be a problem when, for example, <C> is encountered as this could be a roman numeral or a simple alphanumeric string which would have a different integer value depending on how it was parsed. It is likely that this is most useful on a per-entry basis for entries that have, for example, a \bibfield{volume} field with values such as <A>, <B>, <C>, <D> which should not be parsed as roman numerals since this would give incorrect integer values for <C> and <D>.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{labeltitle}
Whether or not to provide the special field \bibfield{extratitle}, see \secref{aut:bbx:fld} for details. Note that the special field \bibfield{labeltitle} is always provided and this option controls rather whether \bibfield{labeltitle} is used to generate \bibfield{extratitle} information. This option is also settable on a per-type and per-entry basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\boolitem[false]{labeltitleyear}
Whether or not to provide the special field \bibfield{extratitleyear}, see \secref{aut:bbx:fld} for details. Note that the special field \bibfield{labeltitle} is always provided and this option controls rather whether \bibfield{labeltitle} is used to generate \bibfield{extratitleyear} information. This option is also settable on a per-type and per-entry basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\boolitem[false]{labeldateparts}
Whether or not to provide the special fields \bibfield{labelyear}, \bibfield{labelmonth}, \bibfield{labelday}, \bibfield{labelendyear}, \bibfield{labelendmonth}, \bibfield{labelendday}, \bibfield{labelhour}, \bibfield{labelendhour}, \bibfield{labelminute}, \bibfield{labelendminute}, \bibfield{labelsecond}, \bibfield{labelendsecond}, \bibfield{labelseason}, \bibfield{labelendseason}, \bibfield{labeltimezone}, \bibfield{labelendtimeone} and \bibfield{extradate}, see \secref{aut:bbx:fld} for details.
This option is also settable on a per-type and per-entry basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\begin{table}
\caption{Work Uniqueness options}
\label{use:opt:wu}
\footnotesize
\ttfamily
\tablesetup
\begin{tabularx}{\textwidth}{XXX}
\toprule
\multicolumn{1}{@{}H}{Option} &
\multicolumn{1}{@{}H}{Test} &
\multicolumn{1}{@{}H}{Tracks} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}
singletitle & \cmd{ifsingletitle} & labelname\\
uniquetitle & \cmd{ifuniquetitle} & labeltitle\\
uniquebaretitle & \cmd{ifuniquebaretitle} & labeltitle {\rmfamily when} labelname {\rmfamily is null}\\
uniquework & \cmd{ifuniquework} & labelname+labeltitle\\
\bottomrule
\end{tabularx}
\end{table}
\boolitem[false]{singletitle}
Whether or not to provide the data required by the \cmd{ifsingletitle} test, see \secref{aut:aux:tst} for details. See \tabref{use:opt:wu} for details on what determines the data for this test.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{uniquetitle}
Whether or not to provide the data required by the \cmd{ifuniquetitle} test, see \secref{aut:aux:tst} for details. See \tabref{use:opt:wu} for details on what determines the data for this test.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{uniquebaretitle}
Whether or not to provide the data required by the \cmd{ifuniquebaretitle} test, see \secref{aut:aux:tst} for details. See \tabref{use:opt:wu} for details on what determines the data for this test.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{uniquework}
Whether or not to provide the data required by the \cmd{ifuniquework} test, see \secref{aut:aux:tst} for details. See \tabref{use:opt:wu} for details on what determines the data for this test.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{uniqueprimaryauthor}
Whether or not to provide the data required by the \cmd{ifuniqueprimaryauthor} test, see \secref{aut:aux:tst} for details.
This option is also settable on a per-type and per-entry basis.
\optitem[false]{uniquename}{\opt{true}, \opt{false}, \opt{init}, \opt{full}, \opt{allinit}, \opt{allfull},
\opt{mininit}, \opt{minfull}}
Whether or not to update the \cnt{uniquename} counter, see \secref{aut:aux:tst} for details. This feature will disambiguate individual names in the \bibfield{labelname} list. This option is also settable on a per-type, per-entry, per-namelist and per-name basis. The possible choices are:
\begin{valuelist}
\item[true] An alias for \opt{full}.
\item[false] Disable this feature.
\item[init] Disambiguate using initials only.
\item[full] Disambiguate using initials or full names, as required.
\item[allinit] Similar to \opt{init} but disambiguates all names in the \bibfield{labelname} list, beyond \opt{maxnames}\slash \opt{minnames}\slash \opt{uniquelist}.
\item[allfull] Similar to \opt{full} but disambiguates all names in the \bibfield{labelname} list, beyond \opt{maxnames}\slash \opt{minnames}\slash \opt{uniquelist}.
\item[mininit] A variant of \texttt{init} which only disambiguates names in identical lists of base nameparts (by default, lists of family names).
\item[minfull] A variant of \texttt{full} which only disambiguates names in identical lists of base nameparts (by default, lists of family names).
\end{valuelist}
%
Note that the \opt{uniquename} option will also affect \opt{uniquelist}, the \cmd{ifsingletitle} test, and the \bibfield{extradate} and \bibfield{extraname} fields. See \secref{aut:cav:amb} for further details and practical examples.
\optitem[false]{uniquelist}{\opt{true}, \opt{false}, \opt{minyear}}
Whether or not to update the \cnt{uniquelist} counter, see \secref{aut:aux:tst} for details. This feature will disambiguate the \bibfield{labelname} list if it has become ambiguous after \opt{maxnames}\slash \opt{minnames} truncation. Essentially, it overrides \opt{maxnames}\slash \opt{minnames} on a per-field basis. This option is also settable on a per-type, per-entry and per-namelist basis. The possible choices are:
\begin{valuelist}
\item[true] Disambiguate the \bibfield{labelname} list.
\item[false] Disable this feature.
\item[minyear] Disambiguate the \bibfield{labelname} list only if the truncated list is identical to another one with the same \bibfield{labelyear}. This mode of operation is useful for author-year styles and requires \kvopt{labeldateparts}{true}.
\end{valuelist}
%
Note that the \opt{uniquelist} option will also affect the \cmd{ifsingletitle} test and the \bibfield{extradate} and \bibfield{extraname} fields. See \secref{aut:cav:amb} for further details and practical examples.
\boolitem[false]{nohashothers}
By default, name lists which are truncated with <et al>--either explicitly by <and others> in the data source or the \opt{uniquelist} and \opt{min/maxnames} options--result in different name list hashes (and therefore different \opt{extraname} and \opt{extradate} values) and different sorting. This option allows this behaviour to be tuned. When set to \prm{true}, \biber ignores <et al> truncations for the purposes of generating name list hashes. Consider:
\begin{lstlisting}{}
Jones 1972
Jones/and others 1972
Smith 2000
Smith/Vogel/Beast/Tremble 2000
\end{lstlisting}
%
With \kvopt{maxnames}{3}, \kvopt{minnames}{1}, \kvopt{nohashothers}{false}, the result would be:
\begin{lstlisting}{}
Jones 1972
Jones et al. 1972
Smith 2000
Smith et al. 2000
\end{lstlisting}
%
Whereas with \kvopt{maxnames}{3}, \kvopt{minnames}{1}, \kvopt{nohashothers}{true}, the result would be:
\begin{lstlisting}{}
Jones 1972a
Jones et al. 1972b
Smith 2000a
Smith et al. 2000b
\end{lstlisting}
If desired, this could be further simplified by removing the <et al.\@>
to obtain:
\begin{lstlisting}{}
Jones 1972a
Jones 1972b
Smith 2000a
Smith 2000b
\end{lstlisting}
%
Note that the \opt{nohashothers} option will affect the \bibfield{extradate} and \bibfield{extraname} fields.
This option is also settable on a per-type, per-entry and per-namelist basis.
\boolitem[false]{nosortothers}
The option has a related to effect to \opt{nohashothers} but applies to sorting--the visible list of names (which is the \opt{minsortnames} value) used to determine sorting will ignore any truncation. This means that with \kvopt{nosortothers}{true}, the name lists:
\begin{lstlisting}{}
Jones, Smith
Jones, Smith et al
\end{lstlisting}
%
will sort exactly the same. The default setting of \opt{nosortothers} always sorts in the order shown in the example, that is, by default, truncated names lists always sort after any name lists identical to the point of truncation.
This option is also settable on a per-type, per-entry and per-namelist basis.
\end{optionlist}
\begin{table}
\caption{Disambiguation counters}
\label{use:opt:tab1}
\footnotesize
\ttfamily
\tablesetup
\begin{tabularx}{\textwidth}{XXXX}
\toprule
\multicolumn{1}{@{}H}{Option} &
\multicolumn{1}{@{}H}{Enabled field(s)} &
\multicolumn{1}{@{}H}{Enabled counter} &
\multicolumn{1}{@{}H}{Counter tracks} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4}
labelalpha & labelalpha & extraalpha & label\\
labeldateparts & labelyear & extradate & labelname+\\
& labelmonth & & labelyear\\
& labelday & & \\
& labelendyear & & \\
& labelendmonth & & \\
& labelendday & & \\
& labelhour & & \\
& labelminute & & \\
& labelsecond & & \\
& labelendhour & & \\
& labelendminute & & \\
& labelendsecond & & \\
& labelseason & & \\
& labelendseason & & \\
& labeltimezone & & \\
& labelendtimezone & & \\
labeltitle & {\rmfamily ---} & extratitle & labelname+labeltitle\\
labeltitleyear & {\rmfamily ---} & extratitleyear & labeltitle+labelyear\\
{\rmfamily ---} & {\rmfamily ---} & extraname & labelname\\
\bottomrule
\end{tabularx}
\end{table}
\subsubsection{Entry Options}
\label{use:opt:bib}
Entry options are package options which determine how bibliography data entries are handled. They may be set at various scopes defined below.
\paragraph{Preamble/Type/Entry Options}
\label{use:opt:bib:hyb}
The following options are settable on a per"=type basis or on a per"=entry in the \bibfield{options} field. In addition to that, they may also be used in the optional argument to \cmd{usepackage} as well as in the configuration file and the document preamble. This is useful if you want to change the default behaviour globally.
\begin{optionlist}
\boolitem[true]{useauthor}
Whether the \bibfield{author} is used in labels and considered during sorting. This may be useful if an entry includes an \bibfield{author} field but is usually not cited by author for some reason. Setting \kvopt{useauthor}{false} does not mean that the \bibfield{author} is ignored completely. It means that the \bibfield{author} is not used in labels and ignored during sorting. The entry will then be alphabetized by \bibfield{editor} or \bibfield{title}. With the standard styles, the \bibfield{author} is printed after the title in this case. See also \secref{use:srt}.
This option is also settable on a per-type and per-entry basis.
\boolitem[true]{useeditor}
Whether the \bibfield{editor} replaces a missing \bibfield{author} in labels and during sorting. This may be useful if an entry includes an \bibfield{editor} field but is usually not cited by editor. Setting \kvopt{useeditor}{false} does not mean that the \bibfield{editor} is ignored completely. It means that the \bibfield{editor} does not replace a missing \bibfield{author} in labels and during sorting. The entry will then be alphabetized by \bibfield{title}. With the standard styles, the \bibfield{editor} is printed after the title in this case. See also \secref{use:srt}.
This option is also settable on a per-type and per-entry basis.
\boolitem[false]{usetranslator}
Whether the \bibfield{translator} replaces a missing \bibfield{author}\slash \bibfield{editor} in labels and during sorting. Setting \kvopt{usetranslator}{true} does not mean that the \bibfield{translator} overrides the \bibfield{author}\slash \bibfield{editor}. It means that the \bibfield{translator} is considered as a fallback if the \bibfield{author}\slash \bibfield{editor} is missing or if \opt{useauthor} and \opt{useeditor} are set to \texttt{false}. In other words, in order to cite a book by translator rather than by author, you need to set the following options:
This option is also settable on a per-type and per-entry basis.
\begin{lstlisting}[style=bibtex]{}
@Book{...,
options = {useauthor=false,usetranslator=true},
author = {...},
translator = {...},
...
\end{lstlisting}
%
With the standard styles, the \bibfield{translator} is printed after the title by default. See also \secref{use:srt}.
\boolitem[true]{use$<$name$>$}
As per \opt{useauthor}, \opt{useeditor} and \opt{usetranslator}, all name lists defined in the data model have an option controlling their behaviour in sorting and labelling automatically
defined. Global, per-type and per-entry options called <use$<$name$>$>are automatically created.
\boolitem[false]{useprefix}
Whether the default data model name part <prefix> (von, van, of, da, de, della, etc.) is considered when:
\begin{itemize}
\item Printing the family name in citations
\item Sorting
\item Generation of certain types of labels
\item Generating name uniqueness information
\item Formatting aspects of the bibliography
\end{itemize}
%
For example, if this option is enabled, \biblatex precedes the family name with the prefix---Ludwig van Beethoven would be cited as «van Beethoven» and alphabetized as «Van Beethoven, Ludwig». If this option is disabled (the default), he is cited as «Beethoven» and alphabetized as «Beethoven, Ludwig van» instead.
This option is also settable on a per-type scope. With \biblatexml datasources and the \bibtex extended name format supported by \biber, this is also settable on per-namelist and per-name scopes.
\optitem{indexing}{\opt{true}, \opt{false}, \opt{cite}, \opt{bib}}
The \opt{indexing} option is also settable per-type or per-entry basis. See \secref{use:opt:pre:gen} for details.
\boolitem[false]{skipbib}
If this option is enabled, the entry is excluded from the bibliography but it may still be cited.
This option is also settable on a per-type basis.
\boolitem[false]{skipbiblist}
If this option is enabled, the entry is excluded from bibliography lists. It is still included in the bibliography and it may also be cited by shorthand etc.
This option is also settable on a per-type basis.
\boolitem[false]{skiplab}
If this option is enabled, \biblatex will not assign any labels to the entry. It is not required for normal operation. Use it with care. If enabled, \biblatex can not guarantee unique citations for the respective entry and citations styles which require labels may fail to create valid citations for the entry.
This option is also settable on a per-type basis.
\boolitem[false]{dataonly}
Setting this option is equivalent to \kvopt{uniquename}{false}, \kvopt{uniquelist}{false, }\opt{skipbib}, \opt{skipbiblist}, and \opt{skiplab}. It is not required for normal operation. Use it with care.
This option is also settable on a per-type basis.
\paragraph{Entry Only Options}
\label{use:opt:bib:entry}
The following options are settable only on a per"=entry in the \bibfield{options} field. They are not available globally or per"=type.
\valitem{labelnamefield}{fieldname}
Specifies the field to consider first when looking for a \bibfield{labelname} candidate. It is essentially prepended to the search list created by \cmd{DeclareLabelname} for just this entry.
\valitem{labeltitlefield}{fieldname}
Specifies the field to consider first when looking for a \bibfield{labeltitle} candidate. It is essentially prepended to the search list created by \cmd{DeclareLabeltitle} for just this entry.
\end{optionlist}
\subsubsection{Legacy Options}
The following legacy option may be used globally in the optional argument to \cmd{documentclass} or locally in the optional argument to \cmd{usepackage}:
\begin{optionlist}
\legitem{openbib}\DeprecatedMark This option is provided for backwards compatibility with the standard LaTeX document classes. \opt{openbib} is similar to \kvopt{block}{par}.
\end{optionlist}
\subsection{Global Customization}
\label{use:cfg}
Apart from writing new citation and bibliography styles, there are numerous ways to customize the styles which come with this package. Customization will usually take place in the preamble, but there is also a configuration file for permanent adaptions. The configuration file may also be used to initialize the package options to a value different from the package default.
\subsubsection{Configuration File}
\label{use:cfg:cfg}
If available, this package will load the configuration file \path{biblatex.cfg}. This file is read at the end of the package, immediately after the citation and bibliography styles have been loaded.
\subsubsection{Setting Package Options}
\label{use:cfg:opt}
The load-time package options in \secref{use:opt:ldt} must be given in the optional argument to \cmd{usepackage}. The package options in \secref{use:opt:pre} may also be given in the preamble. The options are executed with the following command:
\begin{ltxsyntax}
\cmditem{ExecuteBibliographyOptions}[entrytype, \dots]{key=value, \dots}
This command may also be used in the configuration file to modify the default setting of a package option. Certain options are also settable on a per-type basis. In this case, the optional \prm{entrytype} argument specifies the entry type. The \prm{entrytype} argument may be a comma"=separated list of values.
\end{ltxsyntax}
\subsection{Standard Styles}
\label{use:xbx}
This section provides a short description of all bibliography and citation styles which come with the \biblatex package. Each style is further illustrated in a style example which is linked in the right margin. The local link may not be available if this document does not reside in the expected folder structure. If you want to write your own styles, see \secref{aut}.
\subsubsection{Citation Styles}
\label{use:xbx:cbx}
The citation styles which come with this package implement several common citation schemes. All standard styles cater for the \bibfield{shorthand} field and support hyperlinks as well as indexing.
\begin{marglist}
\item[numeric]\seestyleexample{30-style-numeric-biber}
This style implements a numeric citation scheme similar to the standard bibliographic facilities of \latex. It should be employed in conjunction with a numeric bibliography style which prints the corresponding labels in the bibliography. It is intended for in-text citations. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labelnumber}{true}. This style also provides an additional preamble option called \opt{subentry} which affects the handling of entry sets. If this option is disabled, citations referring to a member of a set will point to the entire set. If it is enabled, the style supports citations like «[5c]» which point to a subentry in a set (the third one in this example). See the style example for details.
\item[numeric-comp]\seestyleexample{31-style-numeric-comp-biber}
A compact variant of the \texttt{numeric} style which prints a list of more than two consecutive numbers as a range. This style is similar to the \sty{cite} package and the \opt{sort\&compress} option of the \sty{natbib} package in numerical mode. For example, instead of «[8, 3, 1, 7, 2]» this style would print «[1--3, 7, 8]». It is intended for in-text citations. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{sortcites}{true}, \kvopt{labelnumber}{true}. It also provides the \opt{subentry} and \opt{subentrycomp} options.
\item[numeric-verb]\seestyleexample{32-style-numeric-verb-biber}
A verbose variant of the \texttt{numeric} style. The difference affects the handling of a list of citations and is only apparent when multiple entry keys are passed to a single citation command. For example, instead of «[2, 5, 6]» this style would print «[2]; [5]; [6]». It is intended for in-text citations. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labelnumber}{true}. It also provides the \opt{subentry} option.
\item[alphabetic]\seestyleexample{40-style-alphabetic-biber}
This style implements an alphabetic citation scheme similar to the \path{alpha.bst} style of traditional \bibtex. The alphabetic labels resemble a compact author"=year style to some extent, but the way they are employed is similar to a numeric citation scheme. For example, instead of «Jones 1995» this style would use the label «[Jon95]». «Jones and Williams 1986» would be rendered as «[JW86]». This style should be employed in conjunction with an alphabetic bibliography style which prints the corresponding labels in the bibliography. It is intended for in-text citations. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labelalpha}{true}. This style also provides an additional preamble option called \opt{subentry} which affects the handling of entry sets. If this option is disabled, citations referring to a member of a set will point to the entire set. If it is enabled, the style supports citations like «[SGW(c)]» which point to a subentry in a set (the third one in this example). See the style example for details.
\item[alphabetic-verb]\seestyleexample{41-style-alphabetic-verb-biber}
A verbose variant of the \texttt{alphabetic} style. The difference affects the handling of a list of citations and is only apparent when multiple entry keys are passed to a single citation command. For example, instead of «[Doe92; Doe95; Jon98]» this style would print «[Doe92]; [Doe95]; [Jon98]». It is intended for in-text citations. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labelalpha}{true}. It also provides the subentry option.
\item[authoryear]\seestyleexample{50-style-authoryear-biber}
This style implements an author"=year citation scheme. If the bibliography contains two or more works by the same author which were all published in the same year, a letter is appended to the year. For example, this style would print citations such as «Doe 1995a; Doe 1995b; Jones 1998». This style should be employed in conjunction with an author"=year bibliography style which prints the corresponding labels in the bibliography. It is primarily intended for in-text citations, but it could also be used with citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labeldateparts}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authoryear-comp]\seestyleexample{52-style-authoryear-comp-biber}
A compact variant of the \texttt{authoryear} style which prints the author only once if subsequent references passed to a single citation command share the same author. If they share the same year as well, the year is also printed only once. For example, instead of «Doe 1995b; Doe 1992; Jones 1998; Doe 1995a» this style would print «Doe 1992, 1995a,b; Jones 1998». It is primarily intended for in-text citations, but it could also be used with citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{sortcites}{true}, \kvopt{labeldateparts}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authoryear-ibid]\seestyleexample{51-style-authoryear-ibid-biber}
A variant of the \texttt{authoryear} style which replaces repeated citations by the abbreviation \emph{ibidem} unless the citation is the first one on the current page or double-page spread, or the \emph{ibidem} would be ambiguous in the sense of the package option \kvopt{ibidtracker}{constrict}. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labeldateparts}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}. This style also provides an additional preamble option called \opt{ibidpage}. See the style example for details.
\item[authoryear-icomp]\seestyleexample{53-style-authoryear-icomp-biber}
A style combining \texttt{authoryear-comp} and \texttt{authoryear-ibid}. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{labeldateparts}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}, \kvopt{sortcites}{true}. This style also provides an additional preamble option called \opt{ibidpage}. See the style example for details.
\item[authortitle]\seestyleexample{60-style-authortitle-biber}
This style implements a simple author"=title citation scheme. It will make use of the \bibfield{shorttitle} field, if available. It is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authortitle-comp]\seestyleexample{62-style-authortitle-comp-biber}
A compact variant of the \texttt{authortitle} style which prints the author only once if subsequent references passed to a single citation command share the same author. For example, instead of «Doe, \emph{First title}; Doe, \emph{Second title}» this style would print «Doe, \emph{First title}, \emph{Second title}». It is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{sortcites}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authortitle-ibid]\seestyleexample{61-style-authortitle-ibid-biber}
A variant of the \texttt{authortitle} style which replaces repeated citations by the abbreviation \emph{ibidem} unless the citation is the first one on the current page or double-page spread, or the \emph{ibidem} would be ambiguous in the sense of the package option \kvopt{ibidtracker}{constrict}. It is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}. This style also provides an additional preamble option called \opt{ibidpage}. See the style example for details.
\item[authortitle-icomp]\seestyleexample{63-style-authortitle-icomp-biber}
A style combining the features of \texttt{authortitle-comp} and \texttt{authortitle-ibid}. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}, \kvopt{sortcites}{true}. This style also provides an additional preamble option called \opt{ibidpage}. See the style example for details.
\item[authortitle-terse]\seestyleexample{64-style-authortitle-terse-biber}
A terse variant of the \texttt{authortitle} style which only prints the title if the bibliography contains more than one work by the respective author\slash editor. This style will make use of the \bibfield{shorttitle} field, if available. It is suitable for in-text citations as well as citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{singletitle}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authortitle-tcomp]\seestyleexample{65-style-authortitle-tcomp-biber}
A style combining the features of \texttt{authortitle-comp} and \texttt{authortitle-terse}. This style will make use of the \bibfield{shorttitle} field, if available. It is suitable for in-text citations as well as citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{sortcites}{true}, \kvopt{singletitle}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}.
\item[authortitle-ticomp]\seestyleexample{66-style-authortitle-ticomp-biber}
A style combining the features of \texttt{authortitle-icomp} and \texttt{authortitle-terse}. In other words: a variant of the \texttt{authortitle-tcomp} style with an \emph{ibidem} feature. This style is suitable for in-text citations as well as citations given in footnotes. It will set the following package options at load time: \kvopt{autocite}{inline}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}, \kvopt{sortcites}{true}, \kvopt{singletitle}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}. This style also provides an additional preamble option called \opt{ibidpage}. See the style example for details.
\item[verbose]\seestyleexample{70-style-verbose-biber}
A verbose citation style which prints a full citation similar to a bibliography entry when an entry is cited for the first time, and a short citation afterwards. If available, the \bibfield{shorttitle} field is used in all short citations. If the \bibfield{shorthand} field is defined, the shorthand is introduced on the first citation and used as the short citation thereafter. This style may be used without a list of references and shorthands since all bibliographic data is provided on the first citation. It is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}. This style also provides an additional preamble option called \opt{citepages}. See the style example for details.
\item[verbose-ibid]\seestyleexample{71-style-verbose-ibid-biber}
A variant of the \texttt{verbose} style which replaces repeated citations by the abbreviation \emph{ibidem} unless the citation is the first one on the current page or double-page spread, or the \emph{ibidem} would be ambiguous in the sense of \kvopt{ibidtracker}{strict}. This style is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{ibidtracker}{constrict}, \kvopt{pagetracker}{true}. This style also provides additional preamble options called \opt{ibidpage} and \opt{citepages}. See the style example for details.
\item[verbose-note]\seestyleexample{72-style-verbose-note-biber}
This style is similar to the \texttt{verbose} style in that it prints a full citation similar to a bibliography entry when an entry is cited for the first time, and a short citation afterwards. In contrast to the \texttt{verbose} style, the short citation is a pointer to the footnote with the full citation. If the bibliography contains more than one work by the respective author\slash editor, the pointer also includes the title. If available, the \bibfield{shorttitle} field is used in all short citations. If the \bibfield{shorthand} field is defined, it is handled as with the \texttt{verbose} style. This style may be used without a list of references and shorthands since all bibliographic data is provided on the first citation. It is exclusively intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{singletitle}{true}. This style also provides additional preamble options called \opt{pageref} and \opt{citepages}. See the style example for details.
\item[verbose-inote]\seestyleexample{73-style-verbose-inote-biber}
A variant of the \texttt{verbose"=note} style which replaces repeated citations by the abbreviation \emph{ibidem} unless the citation is the first one on the current page or double-page spread, or the \emph{ibidem} would be ambiguous in the sense of \kvopt{ibidtracker}{strict}. This style is exclusively intended for citations given in footnotes. It will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{ibidtracker}{constrict}, \kvopt{singletitle}{true}, \kvopt{pagetracker}{true}. This style also provides additional preamble options called \opt{ibidpage}, \opt{pageref}, and \opt{citepages}. See the style example for details.
\item[verbose-trad1]\seestyleexample{74-style-verbose-trad1-biber}
This style implements a traditional citation scheme. It is similar to the \texttt{verbose} style in that it prints a full citation similar to a bibliography entry when an item is cited for the first time, and a short citation afterwards. Apart from that, it uses the scholarly abbreviations \emph{ibidem}, \emph{idem}, \emph{op.~cit.}, and \emph{loc.~cit.} to replace recurrent authors, titles, and page numbers in repeated citations in a special way. If the \bibfield{shorthand} field is defined, the shorthand is introduced on the first citation and used as the short citation thereafter. This style may be used without a list of references and shorthands since all bibliographic data is provided on the first citation. It is intended for citations given in footnotes. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{ibidtracker}{constrict}, \kvopt{idemtracker}{constrict}, \kvopt{opcittracker}{context}, \kvopt{loccittracker}{context}. This style also provides additional preamble options called \opt{ibidpage}, \opt{strict}, and \opt{citepages}. See the style example for details.
\item[verbose-trad2]\seestyleexample{75-style-verbose-trad2-biber}
Another traditional citation scheme. It is also similar to the \texttt{verbose} style but uses scholarly abbreviations like \emph{ibidem} and \emph{idem} in repeated citations. In contrast to the \texttt{verbose-trad1} style, the logic of the \emph{op.~cit.} abbreviations is different in this style and \emph{loc.~cit.} is not used at all. It is in fact more similar to \texttt{verbose-ibid} and \texttt{verbose-inote} than to \texttt{verbose-trad1}. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{ibidtracker}{constrict}, \kvopt{idemtracker}{constrict}. This style also provides additional preamble options called \opt{ibidpage}, \opt{strict}, and \opt{citepages}. See the style example for details.
\item[verbose-trad3]\seestyleexample{76-style-verbose-trad3-biber}
Yet another traditional citation scheme. It is similar to the \texttt{verbose-trad2} style but uses the scholarly abbreviations \emph{ibidem} and \emph{op.~cit.} in a slightly different way. The style will set the following package options at load time: \kvopt{autocite}{footnote}, \kvopt{citetracker}{context}, \kvopt{ibidtracker}{constrict}, \kvopt{loccittracker}{constrict}. This style also provides additional preamble options called \opt{strict} and \opt{citepages}. See the style example for details.
\item[reading]\seestyleexample{80-style-reading-biber}
A citation style which goes with the bibliography style by the same name. It simply loads the \texttt{authortitle} style.
\end{marglist}
The following citation styles are special purpose styles. They are not intended for the final version of a document:
\begin{marglist}
\item[draft]\seestyleexample{81-style-draft-biber}
A draft style which uses the entry keys in citations. The style will set the following package options at load time: \kvopt{autocite}{plain}.
\item[debug]\seestyleexample{82-style-debug-biber}
This style prints the entry key rather than some kind of label. It is intended for debugging only and will set the following package options at load time: \kvopt{autocite}{plain}.
\end{marglist}
\subsubsection{Bibliography Styles}
\label{use:xbx:bbx}
All bibliography styles which come with this package use the same basic format for the individual bibliography entries. They only differ in the kind of label printed in the bibliography and the overall formatting of the list of references. There is a matching bibliography style for every citation style. Note that some bibliography styles are not mentioned below because they simply load a more generic style. For example, the bibliography style \texttt{authortitle-comp} will load the \texttt{authortitle} style.
\begin{marglist}
\item[numeric]\seestyleexample{30-style-numeric-biber}
This style prints a numeric label similar to the standard bibliographic facilities of \latex. It is intended for use in conjunction with a numeric citation style. Note that the \bibfield{shorthand} field overrides the default label. The style will set the following package options at load time: \kvopt{labelnumber}{true}. This style also provides an additional preamble option called \opt{subentry} which affects the formatting of entry sets. If this option is enabled, all members of a set are marked with a letter which may be used in citations referring to a set member rather than the entire set. See the style example for details.
\item[alphabetic]\seestyleexample{40-style-alphabetic-biber}
This style prints an alphabetic label similar to the \path{alpha.bst} style of traditional \bibtex. It is intended for use in conjunction with an alphabetic citation style. Note that the \bibfield{shorthand} field overrides the default label. The style will set the following package options at load time: \kvopt{labelalpha}{true}, \kvopt{sorting}{anyt}.
\item[authoryear]\seestyleexample{50-style-authoryear-biber}
This style differs from the other styles in that the publication date is not printed towards the end of the entry but rather after the author\slash editor. It is intended for use in conjunction with an author"=year citation style. Recurring author and editor names are replaced by a dash unless the entry is the first one on the current page or double-page spread. This style provides an additional preamble option called \opt{dashed} which controls this feature. It also provided a preamble option called \opt{mergedate}. See the style example for details. The style will set the following package options at load time: \kvopt{labeldateparts}{true}, \kvopt{sorting}{nyt}, \kvopt{pagetracker}{true}, \kvopt{mergedate}{true}.
\item[authortitle]\seestyleexample{60-style-authortitle-biber}
This style does not print any label at all. It is intended for use in conjunction with an author"=title citation style. Recurring author and editor names are replaced by a dash unless the entry is the first one on the current page or double-page spread. This style also provides an additional preamble option called \opt{dashed} which controls this feature. See the style example for details. The style will set the following package options at load time: \kvopt{pagetracker}{true}.
\item[verbose]\seestyleexample{70-style-verbose-biber}
This style is similar to the \texttt{authortitle} style. It also provides an additional preamble option called \opt{dashed}. See the style example for details. The style will set the following package options at load time: \kvopt{pagetracker}{true}.
\item[reading]\seestyleexample{80-style-reading-biber}
This special bibliography style is designed for personal reading lists, annotated bibliographies, and similar applications. It optionally includes the fields \bibfield{annotation}, \bibfield{abstract}, \bibfield{library}, and \bibfield{file} in the bibliography. If desired, it also adds various kinds of short headers to the bibliography. This style also provides the additional preamble options \opt{entryhead}, \opt{entrykey}, \opt{annotation}, \opt{abstract}, \opt{library}, and \opt{file} which control whether or not the corresponding items are printed in the bibliography. See the style example for details. See also \secref{use:use:prf}. The style will set the following package options at load time: \kvopt{loadfiles}{true}, \kvopt{entryhead}{true}, \kvopt{entrykey}{true}, \kvopt{annotation}{true}, \kvopt{abstract}{true}, \kvopt{library}{true}, \kvopt{file}{true}.
\end{marglist}
The following bibliography styles are special purpose styles. They are not intended for the final version of a document:
\begin{marglist}
\item[draft]\seestyleexample{81-style-draft-biber}
This draft style includes the entry keys in the bibliography. The bibliography will be sorted by entry key. The style will set the following package options at load time: \kvopt{sorting}{debug}.
\item[debug]\seestyleexample{82-style-debug-biber}
This style prints all bibliographic data in tabular format. It is intended for debugging only and will set the following package options at load time: \kvopt{sorting}{debug}.
\end{marglist}
\subsection{Related Entries}
\label{use:rel}
Almost all bibliography styles require authors to specify certain types of relationship between entries such as «Reprint of», «Reprinted in» etc. It is impossible to provide data fields to cover all of these relationships and so \biblatex provides a general mechanism for this using the entry fields \bibfield{related}, \bibfield{relatedtype} and \bibfield{relatedstring}. A related entry does not need to be cited and does not appear in the bibliography itself (unless of course it is also cited itself independently) as a clone is taken of the related entry to be used as a data source. The \bibfield{relatedtype} field should specify a localisation string which will be printed before the information from the related entries is printed, for example «Orig. Pub. as». The \bibfield{relatedstring} field can be used to override the string determined via \bibfield{relatedtype}. Some examples:
\begin{lstlisting}[style=bibtex]{}
@Book{key1,
...
related = {key2},
relatedtype = {reprintof},
...
}
@Book{key2,
...
}
\end{lstlisting}
%
Here we specify that entry \texttt{key1} is a reprint of entry \texttt{key2}. In the bibliography driver for \texttt{Book} entries, when \cmd{usebibmacro\{related\}} is called for entry \texttt{key1}:
\begin{itemize}
\item If the localisation string «\texttt{reprintof}» is defined, it is printed in the \texttt{relatedstring:reprintof} format. If this formatting directive is undefined, the string is printed in the \texttt{relatedstring:default} format.
\item If the \texttt{related:reprintof} macro is defined, it is used to format the information contained in entry \texttt{key2}, otherwise the \texttt{related:default} macro is used
\item If the \texttt{related:reprintof} format is defined, it is used to format both the localisation string and data. If this format is not defined, then the \texttt{related} format is used instead.
\end{itemize}
%
It is also supported to have cascading and/or circular relations:
\begin{lstlisting}[style=bibtex]{}
@Book{key1,
...
related = {key2},
relatedtype = {reprintof},
...
}
@Book{key2,
...
related = {key3},
relatedtype = {translationof},
...
}
@Book{key3,
...
related = {key2},
relatedtype = {translatedas},
...
}
\end{lstlisting}
%
Multiple relations to the same entry are also possible:
\begin{lstlisting}[style=bibtex]{}
@MVBook{key1,
...
related = {key2,key3},
relatedtype = {multivolume},
...
}
@Book{key2,
...
}
@Book{key3,
...
}
\end{lstlisting}
%
Note the order of the keys in lists of multiple related entries is important. The data from multiple related entries is printed in the order of the keys listed in this field. See \secref{aut:ctm:rel} for a more details on the mechanisms behind this feature. You can turn this feature off using the package option \opt{related} from \secref{use:opt:pre:gen}.
You can use the \bibfield{relatedoptions} to set options on the related entry data clone. This is useful if you need to override the \opt{dataonly} option which is set by default on all related entry clones. For example, if you will expose some of the names in the related clone in your document, you may want to have them disambiguated from names in other entries but normally this won't happen as related clones have the per"=entry \opt{dataonly} option set and this in turn sets \kvopt{uniquename}{false} and \kvopt{uniquelist}{false}. In such a case, you can set \bibfield{relatedoptions} to just \opt{skiplab, skipbib, skipbiblist}.
\subsection{Sorting Options}
\label{use:srt}
This package supports fully customisable sorting templates for the bibliography. The default global sorting template is selected with the \opt{sorting} package option from \secref{use:opt:pre:gen}. Apart from the regular data fields there are also some special fields which may be used to optimize the sorting of the bibliography. \Apxref{apx:srt:a1, apx:srt:a2} give an outline of the default alphabetic sorting templates supported by \biblatex. Chronological sorting templates are listed in \apxref{apx:srt:chr}. A few explanations concerning the default templates are in order.
The first item considered in the sorting process is always the \bibfield{presort} field of the entry. If this field is undefined, \biblatex will use the default value <\texttt{mm}> as a presort string. The next item considered is the \bibfield{sortkey} field. If this field is defined, it serves as the master sort key. Apart from the \bibfield{presort} field, no further data is considered in this case. If the \bibfield{sortkey} field is undefined, sorting continues with the name. The package will try using the \bibfield{sortname}, \bibfield{author}, \bibfield{editor}, and \bibfield{translator} fields, in this order. Which fields are considered also depends on the setting of the \opt{use$<$name$>$} options. If all such options are disabled, the \bibfield{sortname} field is ignored as well. Note that all name fields are responsive to \opt{maxnames} and \opt{minnames}. If no name field is available, either because all of them are undefined or because all \opt{use$<$name$>$} options are disabled, \biblatex will fall back to the \bibfield{sorttitle} and \bibfield{title} fields as a last resort. The remaining items are, in various order: the \bibfield{sortyear} field, if defined, or the first four digits of the \bibfield{year} field otherwise; the \bibfield{sorttitle} field, if defined, or the \bibfield{title} field otherwise; the \bibfield{volume} field. Note that the sorting templates shown in \apxref{apx:srt:a2} include an additional item: \bibfield{labelalpha} is the label used by <alphabetic> bibliography styles. Strictly speaking, the string used for sorting is \bibfield{labelalpha}~+ \bibfield{extraalpha}. The sorting templates in \apxref{apx:srt:a2} are intended to be used in conjunction with alphabetic styles only.
The chronological sorting templates presented in \apxref{apx:srt:chr} also make use of the \bibfield{presort} and \bibfield{sortkey} fields, if defined. The next item considered is the \bibfield{sortyear} or the \bibfield{year} field, depending on availability. The \opt{ynt} template extracts the first four Arabic figures from the field. If both fields are undefined, the string \texttt{9999} is used as a fallback value. This means that all entries without a year will be moved to the end of the list. The \opt{ydnt} template is similar in concept but sorts the year in descending order. As with the \opt{ynt} template, the string \texttt{9999} is used as a fallback value. The remaining items are similar to the alphabetic sorting templates discussed above. Note that the \opt{ydnt} sorting template will only sort the date in descending order. All other items are sorted in ascending order as usual.
Using special fields such as \bibfield{sortkey}, \bibfield{sortname}, or \bibfield{sorttitle} is usually not required. The \biblatex package is quite capable of working out the desired sorting order by using the data found in the regular fields of an entry. You will only need them if you want to manually modify the sorting order of the bibliography or if any data required for sorting is missing. Please refer to the field descriptions in \secref{bib:fld:spc} for details on possible uses of the special fields.
\subsection{Data Annotations}
\label{use:annote}
Ideally, there should be no formatting information in a bibliography data file, however, sometimes such questionable practice seems to the only way in which the desired results can be achieved. Data annotations are a way of addressing this by allowing users to attach semantic information (rather than typographical markup) to information in a bibliography data source so that the information can be used at markup time by a style. For example, if you wanted to highlight certain names in a work depending on whether they were a student author (indicated by a superscript asterisk in the references) or a corresponding author (indicated by bold face), then you might be tempted to try:
\begin{lstlisting}[style=bibtex]{}
@MISC{Article1,
AUTHOR = {Last1\textsuperscript{*}, First1 and \textbf{Last2}, \textbf{First2} and Last3, First3}
}
\end{lstlisting}
%
There are several problems with this. Firstly, it will break \bibtex's fragile name parsing routines and probably won't compile at all. Secondly, it is not only mixing up data with markup, it does so in a hard-coded way: this data can't easily be shared and used with other styles. While it is possible to achieve this formatting using \biblatex internals in a style or document, this is a complex and unreliable method which many users will not wish to use.
In order to address these issues, \biblatex has a general data annotation facility which allows you to attach any number of a comma"=separated list of annotations to data fields, items within data field lists (like names) and even parts of specific items such as parts of names (given name, family name etc.). There are macros provided to check for annotations which can be used in formatting directives.
There are three «scopes» for data annotations, in order of increasing specificity:
\begin{itemize}
\item \opt{field}---applied to top-level fields in a data source entry
\item \opt{item}---applied to items within a list field in a data source entry
\item \opt{part}---applied to parts within items within a list field in a data source entry
\end{itemize}
%
Data annotations are supported for \bibtex and \biblatexml data sources.
\begin{lstlisting}[style=bibtex]{}
@MISC{ann1,
AUTHOR = {Last1, First1 and Last2, First2 and Last3, First3},
AUTHOR+an = {1:family=student;2=corresponding},
TITLE = {The Title},
TITLE+an:default = {=titleannotation},
TITLE+an:french = {="Le titre"},
TITLE+an:german = {="Der Titel"},
}
\end{lstlisting}
%
Here the field name suffix \texttt{+an} is a user-definable\footnote{See \biber's \opt{--annotation-marker} option.} suffix which marks a data field as an annotation of the unsuffixed field. Multiple annotations can be provided for the same field since all annotations are named. After the annotation marker is the optional named annotation marker \footnote{See \biber's \opt{--named-annotation-marker} option.} and an optional annotation name. The annotation name is <default> if not specified and so in the above example the following two are equivalent:
\begin{lstlisting}[style=bibtex]{}
TITLE+an = {=titleannotation},
TITLE+an:default = {=titleannotation},
\end{lstlisting}
%
The format of annotation fields in \bibtex data sources is is as follows:
\begin{lstlisting}
<annotationspecs> ::= <annotationspec> [ ";" <annotationspec> ]
<annotationspec> ::= [ <itemcount> [ ":" <part> ] ] "=" <annotations>
<annotations> ::= <annotation> [ "," <annotation> ]
<annotation> ::= ["] (string) ["]
\end{lstlisting}
%
That is, one or more specifications separated by semi-colons. Each specification is an equals sign followed by a comma"=separated list of annotation keywords or a string enclosed in double-quotes (a <literal> annotation, see below). To annotate a specific item in a list, put the number of the list item before the equals sign (lists start at 1). If you need to annotate a specific part of the list item, give its name after the list item number, preceded by a colon. Name part names are defined in the data model, see \secref{aut:bbx:drv}. Some further examples:
\begin{lstlisting}[style=bibtex]{}
AUTHOR = {Last1, First1 and Last2, First2 and Last3, First3},
AUTHOR+an = {3:given=annotation1, annotation2},
TITLE = {A title},
TITLE+an = {=a title annotation, another title annotation},
LANGUAGE = {english and french},
LANGUAGE+an = {1=annotation3; 2=annotation4}
}
\end{lstlisting}
%
Attaching annotations to data is similar in \biblatexml data sources. Using the example above, we would have:
\begin{lstlisting}[language=xml]
<bltx:entries xmlns:bltx="http://biblatex-biber.sourceforge.net/biblatexml">
<bltx:entry id="test" entrytype="misc">
<bltx:names type="author">
<bltx:name>
<bltx:namepart type="given" initial="F">First1</bltx:namepart>
<bltx:namepart type="family" initial="L">Last1</bltx:namepart>
</bltx:name>
<bltx:name>
<bltx:namepart type="given" initial="F">First2</bltx:namepart>
<bltx:namepart type="family" initial="L">Last2</bltx:namepart>
</bltx:name>
<bltx:name>
<bltx:namepart type="given" initial="F">First3</bltx:namepart>
<bltx:namepart type="family" initial="L">Last3</bltx:namepart>
</bltx:name>
</bltx:names>
</bltx:annotation field="author" item="1" part="family">student</bltx:annotation>
</bltx:annotation field="author" item="2">corresponding</bltx:annotation>
</bltx:entry>
</bltx:entries>
\end{lstlisting}
%
To access the annotation information when formatting bibliography data, macros are provided, corresponding to the three annotation scopes:
\begin{ltxsyntax}
\cmditem{iffieldannotation}[field][annotationname]{annotation}{true}{false}
Executes \prm{true} if the data field \prm{field} has an annotation \prm{annotation} for the annotation called \prm{annotationname} and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). If \prm{field} is not given, the current data field as indicated by \cmd{currentfield}, \cmd{currentlist} or \cmd{currentname} (see \secref{aut:bib:fmt}) is assumed. Of course, this is only possible if these commands are defined, that is, inside formatting directives.
\cmditem{ifitemannotation}[field][annotationname][item]{annotation}{true}{false}
Executes \prm{true} if the item \prm{item} in the data field \prm{field} has an annotation \prm{annotation} and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The optional argument \prm{field} can be inferred if not provided as with \cmd{iffieldannotation}. If \prm{item} is not given, the number of the item currently being processed as given by \cnt{listcount} is used.
\cmditem{ifpartannotation}[field][annotationname][item]{part}{annotation}{true}{false}
Executes \prm{true} if the part named \prm{part} in item \prm{item} in the data field \prm{field} has an annotation \prm{annotation} and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The two optional arguments \prm{field} and \prm{item} can be inferred as in \cmd{ifitemannotation}. The parameter \prm{part} can never be inferred and is therefore a mandatory argument.
Date fields are special and handled in a context where \cmd{currentfield} is not accessible. Thus there is a fourth command to test annotations for dates.
\cmditem{ifdateannotation}[annotationname]{datetype}{annotation}{true}{false}
Executes \prm{true} if the date field \prm{datetype} has an annotation \prm{annotation} and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The \prm{datetype} argument is mandatory, because it cannot be inferred in most contexts where \cmd{ifdateannotation} will be used.
\cmditem{hasfieldannotation}[field][annotationname]{true}{false}
Executes \prm{true} if the data field \prm{field} has a literal annotation \prm{annotationname} defined and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). If \prm{field} is not given, the current data field as indicated by \cmd{currentfield}, \cmd{currentlist} or \cmd{currentname} (see \secref{aut:bib:fmt}) is assumed. Of course, this is only possible if these commands are defined, that is, inside formatting directives.
\cmditem{hasitemannotation}[field][annotationname][item]{true}{false}
Executes \prm{true} if the item \prm{item} in the data field \prm{field} has a literal annotation \prm{annotationname} defined and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The optional argument \prm{field} can be inferred if not provided as with \cmd{iffieldannotation}. If \prm{item} is not given, the number of the item currently being processed as given by \cnt{listcount} is used.
\cmditem{haspartannotation}[field][annotationname][item]{part}{true}{false}
Executes \prm{true} if the part named \prm{part} in the item \prm{item} in the data field \prm{field} has a literal annotation \prm{annotationname} defined and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The two optional arguments \prm{field} and \prm{item} can be inferred as in \cmd{ifitemannotation}. The parameter \prm{part} can never be inferred and is therefore a mandatory argument.
Date fields are special and handled in a context where \cmd{currentfield} is not accessible. Thus there is a fourth command to test the existence of annotations for dates.
\cmditem{hasdateannotation}[annotationname]{datetype}{true}{false}
Executes \prm{true} if the date field \prm{datetype} has any annotation \prm{annotationname} defined and false otherwise. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The \prm{datetype} argument is mandatory, because it cannot be inferred in most contexts where \cmd{ifdateannotation} will be used.
\end{ltxsyntax}
%
As an example of how to use the annotation information to solve the problem originally presented in this section, this could be used in the name formatting directives to put an asterisk after all family names annotated as «student»:
\begin{lstlisting}[style=latex]{}
\ifpartannotation{family}{student}
{\textsuperscript{*}}
{}%
\end{lstlisting}
%
To put the given and family names of name list items annotated as «corresponding» in boldface:
\begin{lstlisting}[style=latex]{}
\renewcommand*{\mkbibnamegiven}[1]{%
\ifitemannotation{corresponding}
{\textbf{#1}}
{#1}}
\renewcommand*{\mkbibnamefamily}[1]{%
\ifitemannotation{corresponding}
{\textbf{#1}}
{#1}}
\end{lstlisting}
\subsubsection{Literal Annotations}
If the annotation is a string enclosed in double-quotes, the annotation is a <literal> annotation. In this case the annotation can be retrieved and used as a string rather than as meta-information used to determine formatting. This is useful in order to be able to attached specific annotations to data which are to be printed as-is. For example:
\begin{lstlisting}[style=bibtex]{}
AUTHOR = {{American Educational Research Association} and {American Psychological Association}
and {National Council on Measurement in Education}},
AUTHOR+an = {1:family="AERA"; 2:family="APA"; 3:family="NCME"}
}
\end{lstlisting}
%
Such annotations are not keys whose presence can be tested for but are rather literal information attached to the data. The values are retrieved by the following macros
\begin{ltxsyntax}
\cmditem{getfieldannotation}[field][annotationname]
Retrieves any literal annotation for the field \prm{field}. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). If \prm{field} is not given, the current data field as indicated by \cmd{currentfield}, \cmd{currentlist} or \cmd{currentname} (see \secref{aut:bib:fmt}) is assumed. Of course, this is only possible if these commands are defined, that is, inside formatting directives.
\cmditem{getitemannotation}[field][annotationname][item]
Retrieves any literal annotation for the item \prm{item} in the field \prm{field}. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The optional argument \prm{field} can be inferred if not provided as with \cmd{getfieldannotation}. If \prm{item} is not given, the number of the item currently being processed as given by \cnt{listcount} is used.
\cmditem{getpartannotation}[field][annotationname][item]{part}
Retrieves any literal annotation for the part \prm{part}. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The two optional arguments \prm{field} and \prm{item} can be inferred as in \cmd{getitemannotation}. The parameter \prm{part} can never be inferred and is therefore a mandatory argument.
Date fields are special and handled in a context where \cmd{currentfield} is not accessible. Thus there is a fourth command to access literal annotations for dates.
\cmditem{getdateannotation}[annotationname]{datetype}
Retrieve a literal annotation for the datefield \prm{datetype}. If \prm{annotationname} is not given, then the annotation named <default> is assumed (this is the name given to annotations defined without an explicit name). The \prm{datetype} argument is mandatory, because it cannot be inferred in most contexts where \cmd{getdateannotation} will be used.
\end{ltxsyntax}
%
So, for example, given the bibliography entry above, we could put the following in the preamble:
\begin{ltxexample}[style=latex]
\renewcommand*{\mkbibnamefamily}[1]{%
#1\space\mkbibparens{\getpartannotation{family}}}
\end{ltxexample}
%
In order to get something like this in the bibliography when formatting names:
\begin{lstlisting}[style=bibtex]{}
American Educational Research Association (AERA) and
American Psychological Association (APA), and
National Council on Measurement in Education (NCME)
}
\end{lstlisting}
%
Naturally there are semantically more elegant ways of dealing with corporate authors without using the <family> namepart (see \secref{aut:bbx:drv}) but this example demonstrates clearly a use for literal annotations.
\subsection{Bibliography Commands}
\label{use:bib}
\subsubsection{Resources}
\label{use:bib:res}
\begin{ltxsyntax}
\cmditem{addbibresource}[options]{resource}
Adds a \prm{resource}, such as a \file{.bib} file, to the default resource list. This command is only available in the preamble. It replaces the \cmd{bibliography} legacy command. Note that files must be specified with their full name, including the extension. With \biber, the resource name can be a BSD-style glob pattern. This only makes sense when resources refer to files with an absolute or relative path and does not work when looking for data resources in \biber s input/output directories or with resources located by \prm{kpsewhich} etc. When running on Windows, \biber will switch to a Windows compatible globbing mode where backslashes are also useable as path separators and case does not matter. If the resources contain duplicate entries (that is, duplicate \bibfield{entrykey}s), it is backend dependent what then happens. For example, by default \biber will ignore further occurrence of \bibfield{entrykey}s unless its \opt{--noskipduplicates} options is used. Invoke \cmd{addbibresource} multiple times to add more resources, for example:
\begin{ltxexample}
\addbibresource{bibfile1.bib}
\addbibresource{bibfile2.bib}
\addbibresource[glob]{bibfiles/bibfile*.bib}
\addbibresource[glob]{bibfile-num?.bib}
\addbibresource[glob]{bibfile{1,2,3}.bib}
\addbibresource[location=remote]{http://www.citeulike.org/bibtex/group/9517}
\addbibresource[location=remote,label=lan]{ftp://192.168.1.57/~user/file.bib}
\end{ltxexample}
%
Since the \prm{resource} string is read in a verbatim-like mode, it may contain arbitrary characters. The only restriction is that any curly braces must be balanced. The following \prm{options} are available:
\begin{optionlist*}
\valitem{bibencoding}{bibencoding}
This option can be used to override the global \opt{bibencoding} option for a particular \prm{resource}.
\valitem{label}{identifier}
Assigns a label to a resource. The \prm{identifier} may be used in place of the full resource name in the optional argument of \env{refsection} (see \secref{use:bib:sec}). The label is a \emph{unique} identifier for the \prm{resource}, so each label should only be used once.
\valitem[local]{location}{location}
The location of the resource. The \prm{location} may be either \texttt{local} for local resources or \texttt{remote} for \acr{URL}s. Remote resources require \biber. The protocols \acr{HTTP/HTTPS} and \acr{FTP} are supported. The remote \acr{URL} must be a fully qualified path to a \file{bib} file or a \acr{URL} which returns a \file{bib} file.
\valitem[file]{type}{type}
The type of resource. Currently, the only supported type is \texttt{file}.
\valitem[bibtex]{datatype}{datatype}
The data type (format) of the resource. The following formats are currently supported:
\begin{valuelist}
\item[bibtex] \bibtex format.
\item[biblatexml] Experimental XML format for \biblatex. See \secref{apx:biblatexml}.
\end{valuelist}
\boolitem{glob}
Whether \biber should glob (expand according to pattern) the datasource name. There is
a global setting for this in \biber (false by default and settable to true
using the \opt{--glob-datasources} option). This option allows overriding
the \biber default on a per-resource basis.
\end{optionlist*}
\cmditem{addglobalbib}[options]{resource}
This command differs from \cmd{addbibresource} in that the \prm{resource} is added to the global resource list. The difference between default resources and global resources is only relevant if there are reference sections in the document and the optional argument of \env{refsection} (\secref{use:bib:sec}) is used to specify alternative resources which replace the default resource list. Any global resources are added to all reference sections.
\cmditem{addsectionbib}[options]{resource}
This command differs from \cmd{addbibresource} in that the resource \prm{options} are registered but the \prm{resource} not added to any resource list. This is only required for resources which 1) are given exclusively in the optional argument of \env{refsection} (\secref{use:bib:sec}) and 2) require options different from the default settings. In this case, \cmd{addsectionbib} is employed to qualify the \prm{resource} prior to using it by setting the appropriate \prm{options} in the preamble. The \opt{label} option may be useful to assign a short name to the resource.
\cmditem{bibliography}{bibfile, \dots}\DeprecatedMark
The legacy command for adding bibliographic resources, supported for backwards compatibility. Like \cmd{addbibresource}, this command is only available in the preamble and adds resources to the default resource list. Its argument is a comma"=separated list of \file{bib} files. The \file{.bib} extension may be omitted from the filename. Invoking this command multiple times to add more files is permissible. This command is deprecated. Please consider using \cmd{addbibresource} instead.
\subsubsection{The Bibliography}
\label{use:bib:bib}
\cmditem{printbibliography}[key=value, \dots]
This command prints the bibliography. It takes one optional argument, which is a list of options given in \keyval notation. The following options are available:
\end{ltxsyntax}
\begin{optionlist*}
\valitem[bibliography/shorthands]{env}{name}
The <high-level> layout of the bibliography and the list of shorthands is controlled by environments defined with \cmd{defbibenvironment}. This option selects an environment. The \prm{name} corresponds to the identifier used when defining the environment with \cmd{defbibenvironment}. By default, the \cmd{printbibliography} command uses the identifier \texttt{bibliography}; \cmd{printbiblist} uses \texttt{shorthands}. See also \secref{use:bib:biblist,use:bib:hdg}.
\valitem[bibliography/shorthands]{heading}{name}
The bibliography and the list of shorthands typically have a chapter or section heading. This option selects the heading \prm{name}, as defined with \cmd{defbibheading}. By default, the \cmd{printbibliography} command uses the heading \texttt{bibliography}; \cmd{printbiblist} uses \texttt{shorthands}. See also \secref{use:bib:biblist,use:bib:hdg}.
\valitem{title}{text}
This option overrides the default title provided by the heading selected with the \opt{heading} option, if supported by the heading definition. See \secref{use:bib:hdg} for details.
\optitem[\normalfont\emph{global setting} (\opt{none})]{block}{\opt{none}, \opt{space}, \opt{par}, \opt{nbpar}, \opt{ragged}}
This option overrides the global \opt{block} option (see \secref{use:opt:pre:gen}, the meaning of the settings is explained there as well).
\valitem{prenote}{name}
The prenote is an arbitrary piece of text to be printed after the heading but before the list of references. This option selects the prenote \prm{name}, as defined with \cmd{defbibnote}. By default, no prenote is printed. The note is printed in the standard text font. It is not affected by \cmd{bibsetup} and \cmd{bibfont} but it may contain its own font declarations. See \secref{use:bib:nts} for details.
\valitem{postnote}{name}
The postnote is an arbitrary piece of text to be printed after the list of references. This option selects the postnote \prm{name}, as defined with \cmd{defbibnote}. By default, no postnote is printed. The note is printed in the standard text font. It is not affected by \cmd{bibsetup} and \cmd{bibfont} but it may contain its own font declarations. See \secref{use:bib:nts} for details.
\intitem[\normalfont\em current section]{section}
Print only entries cited in reference section \prm{integer}. The reference sections are numbered starting at~1. All citations given outside a \env{refsection} environment are assigned to section~0. See \secref{use:bib:sec} for details and \secref{use:use:mlt} for usage examples.
\intitem{segment}
Print only entries cited in reference segment \prm{integer}. The reference segments are numbered starting at~1. All citations given outside a \env{refsegment} environment are assigned to segment~0. See \secref{use:bib:seg} for details and \secref{use:use:mlt} for usage examples. Remember that segments within a section are numbered local to the section so the segment you request will be the nth segment in the requested (or currently active enclosing) section.
\valitem{type}{entrytype}
Print only entries whose entry type is \prm{entrytype}.
\valitem{nottype}{entrytype}
Print only entries whose entry type is not \prm{entrytype}. This option may be used multiple times.
\valitem{subtype}{subtype}
Print only entries whose \bibfield{entrysubtype} is defined and \prm{subtype}.
\valitem{notsubtype}{subtype}
Print only entries whose \bibfield{entrysubtype} is undefined or not \prm{subtype}. This option may be used multiple times.
\valitem{keyword}{keyword}
Print only entries whose \bibfield{keywords} field includes \prm{keyword}. This option may be used multiple times.
\valitem{notkeyword}{keyword}
Print only entries whose \bibfield{keywords} field does not include \prm{keyword}. This option may be used multiple times.
\valitem{category}{category}
Print only entries assigned to category \prm{category}. This option may be used multiple times.
\valitem{notcategory}{category}
Print only entries not assigned to category \prm{category}. This option may be used multiple times.
\valitem{filter}{name}
Filter the entries with filter \prm{name}, as defined with \cmd{defbibfilter}. See \secref{use:bib:flt} for details.
\valitem{check}{name}
Filter the entries with check \prm{name}, as defined with \cmd{defbibcheck}. See \secref{use:bib:flt} for details.
\valitem{resetnumbers}{true,false,number}
This option applies to numerical citation\slash bibliography styles only and requires that the \opt{defernumbers} option from \secref{use:opt:pre:gen} be enabled globally. If enabled, it will reset the numerical labels assigned to the entries in the respective bibliography, \ie the numbering will restart at~1. You can also pass a number to this option, for example: \texttt{resetnumbers=10} to reset numbering to the specified number to aid numbering continuity across documents. Use this option with care as \biblatex can not guarantee unique labels globally if they are reset manually.
\boolitem{omitnumbers}
This option applies to numerical citation\slash bibliography styles only and requires that the \opt{defernumbers} option from \secref{use:opt:pre:gen} be enabled globally. If enabled, \biblatex will not assign a numerical label to the entries in the respective bibliography. This is useful when mixing a numerical subbibliography with one or more subbibliographies using a different scheme (\eg author-title or author-year).
\boolitem[false]{locallabelwidth}
Calculate \cmd{labelnumberwidth}, \cmd{labelalphawidth} and similar lengths locally for the present bibliography and not globally for all entries. See also \opt{labelnumberwidth} in \secref{use:opt:pre:gen}.
\end{optionlist*}
\begin{ltxsyntax}
\cmditem{bibbysection}[key=value, \dots]
This command automatically loops over all reference sections. This is equivalent to giving one \cmd{printbibliography} command for every section but has the additional benefit of automatically skipping sections without references. Note that \cmd{bibbysection} starts looking for references in section \texttt{1}. It will ignore references given outside of \env{refsection} environments since they are assigned to section~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}. The current bibliography context sorting template is used for all sections (see \secref{use:bib:context}).
\cmditem{bibbysegment}[key=value, \dots]
This command automatically loops over all reference segments. This is equivalent to giving one \cmd{printbibliography} command for every segment in the current \env{refsection} but has the additional benefit of automatically skipping segments without references. Note that \cmd{bibbysegment} starts looking for references in segment \texttt{1}. It will ignore references given outside of \env{refsegment} environments since they are assigned to segment~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}. The current bibliography context sorting template is used for all segments (see \secref{use:bib:context}).
\cmditem{bibbycategory}[key=value, \dots]
This command loops over all bibliography categories. This is equivalent to giving one \cmd{printbibliography} command for every category but has the additional benefit of automatically skipping empty categories. The categories are processed in the order in which they were declared. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{prenote}, \opt{postnote}, \opt{section}. Note that \opt{heading} is not available with this command. The name of the current category is automatically used as the heading name. This is equivalent to passing \texttt{heading=\prm{category}} to \cmd{printbibliography} and implies that there must be a matching heading definition for every category. The current bibliography context sorting template is used for all categories (see \secref{use:bib:context}).
\cmditem{printbibheading}[key=value, \dots]
This command prints a bibliography heading defined with \cmd{defbibheading}. It takes one optional argument, which is a list of options given in \keyval notation. The options are a small subset of those supported by \cmd{printbibliography}. Valid options are \opt{heading} and \opt{title}. By default, this command uses the heading \texttt{bibliography}. See \secref{use:bib:hdg} for details. Also see \secref{use:use:mlt,use:use:div} for usage examples.
\cmditem{DeclarePrintbibliographyDefaults}{key=value, \dots}
This command can be used to globally set defaults for some options to \cmd{printbibliography}, the \cmd{bibby...} bibliography commands and \cmd{printbibheading}.
The supported keys are
\begin{itemize}
\item \opt{env}
\item \opt{heading}
\item \opt{title}
\item \opt{prenote}
\item \opt{postnote}
\item \opt{filter}
\end{itemize}
\end{ltxsyntax}
%
To print a bibliography with a different sorting template than the global sorting template, use the bibliography context switching commands from \secref{use:bib:context}.
\subsubsection{Bibliography Lists}
\label{use:bib:biblist}
\biblatex can, in addition to printing normal bibliographies, also print arbitrary lists of information derived from the bibliography data such as a list of shorthand abbreviations for particular entries or a list of abbreviations of journal titles.
A bibliography list differs from a normal bibliography in that the same bibliography driver is used to print all entries rather than a specific driver being used for each entry depending on the entry type.
\begin{ltxsyntax}
\cmditem{printbiblist}[key=value, \dots]{biblistname}
This command prints a bibliography list. It takes an optional argument, which is a list of options given in \keyval notation. Valid options are all options supported by \cmd{printbibliography} (\secref{use:bib:bib}) except \opt{resetnumbers} and \opt{omitnumbers}. Additionaly, the two options \opt{driver} and \opt{biblistfilter} are available. If there are any \env{refsection} environments in the document, the bibliography list will be local to these environments; see \secref{use:bib:sec} for details. By default, this command uses the heading \texttt{biblist}. See \secref{use:bib:hdg} for details.
The \prm{biblistname} is a mandatory argument which names the bibliography list. This name is used to identify:
\begin{itemize}
\item The default bibliography driver used to print the list entries
\item A default bibliography list filter declared with \cmd{DeclareBiblistFilter} (see \secref{aut:ctm:bibfilt}) used to filter the entries returned from \biber
\item A default check declared with \cmd{defbibcheck} (see \secref{use:bib:flt}) used to post-process the list entries
\item The default bib environment to use
\item The default sorting template to use
\end{itemize}
The two additional options can be used to change some of the defaults set by the mandatory argument.
\begin{optionlist*}
\valitem[\prm{biblistname}]{driver}{driver}
Change the bibliography driver used to print the list entries.
% \prm{driver} must be a valid driver declared with \cmd{DeclareBibliographyDriver} (see \secref{aut:bbx:bbx}).
\valitem[\prm{biblistname}]{biblistfilter}{biblistfilter}
Change the bibliography list filter used to filter the entries. \prm{biblistfilter} must be a valid bibliography list filter defined with \cmd{DeclareBiblistFilter} (see \secref{aut:ctm:bibfilt}).
\end{optionlist*}
In terms of sorting the list, the default is to sort using the sorting template named after the bibliography list (if it exists) and only then to fall back to the current context sorting template if this is not defined (see \secref{use:bib:context}).
The most common bibliography list is a list of shorthand abbreviations for certain entries and so this has a convenience alias \cmd{printshorthands[\dots]} for backwards compatibility which is defined as:
\begin{ltxexample}
\printbiblist[...]{shorthand}
\end{ltxexample}
\biblatex provides automatic support for data source fields in the default data model marked as <Label fields> (See \secref{bib:fld:dat}). Such fields automatically have defined for them:
\begin{itemize}
\item A default bib environment (See \secref{use:bib:hdg})
\item A bibliography list filter (See \secref{aut:ctm:bibfilt})
\item Some supporting formats and lengths (See \secref{aut:fmt:ilc} and \secref{aut:fmt:ich})
\end{itemize}
%
Therefore only a minimal setup is required to print bibliography lists with such fields. For example, to print a list of journal title abbreviations, you can minimally put this in your preamble:
\begin{ltxexample}
\DeclareBibliographyDriver{shortjournal}{%
\printfield{journaltitle}}
\end{ltxexample}
%
Then you can put this in your document where you want to print the list:
\begin{ltxexample}
\printbiblist[title={Journal Shorthands}]{shortjournal}
\end{ltxexample}
%
Since \bibfield{shortjournal} is defined in the default data model as a <Label field>, this example:
\begin{itemize}
\item Uses the automatically created <shortjournal> bib environment
\item Uses the automatically created <shortjournal> bibliography list filter to return only entries with a \bibfield{shortjournal} field in the \file{.bbl}
\item Uses the defined <shortjournal> bibliography driver to print the entries
\item Uses the default <biblist> heading but overrides the title with <Journal Shorthands>
\item Uses the current bibliography context sorting template if no template exists with the name \bibfield{shortjournal}
\end{itemize}
%
Often, you will want to sort on the label field of the list and since a sorting template is automatically picked up if it is named after the list, in this case you could simply do:
\begin{ltxexample}
\DeclareSortingTemplate{shortjournal}{
\sort{
\field{shortjournal}
}
}
\end{ltxexample}
Naturally all defaults can be overridden by options to \cmd{printbiblist} and definitions of the environments, filters etc. and in this way arbitrary types of bibliography lists can be printed containing a variety of information from the bibliography data.
\end{ltxsyntax}
Bibliography lists are often used to print lists of various kinds of shorthands and this can result in duplicate entries if more than one bibliography entry has the same shorthand. For example, several journal articles in the same journal would result in duplicate entries in a list of journal shorthands. You can use the fact that such lists automatically pick up a \cmd{bibcheck} with the same name as the list to define a check to remove duplicates. If you are defining a list to print all of the journal shorthands using the \bibfield{shortjournal} field, you could define a \cmd{bibcheck} like this:
\begin{ltxexample}[basicstyle=\displayverbfont\footnotesize]
\defbibcheck{shortjournal}{%
\iffieldundef{shortjournal}
{\skipentry}
{\iffieldundef{journaltitle}
{\skipentry}
{\ifcsdef{sjcheck@\therefsection
-\strfield{shortjournal}=\strfield{journaltitle}}
{\skipentry}
{\savefieldcs{journaltitle}{sjcheck@\therefsection
-\strfield{shortjournal}=\strfield{journaltitle}}}}}}
\end{ltxexample}
\subsubsection{Bibliography Sections}
\label{use:bib:sec}
The \env{refsection} environment is used in the document body to mark a reference section. This environment is useful if you want separate, independent bibliographies and bibliography lists in each chapter, section, or any other part of a document. Within a reference section, all cited works are assigned labels which are local to the environment. Technically, reference sections are completely independent from document divisions such as \cmd{chapter} and \cmd{section} even though they will most likely be used per chapter or section. See the \opt{refsection} package option in \secref{use:opt:pre:gen} for a way to automate this. Also see \secref{use:use:mlt} for usage examples.
\begin{ltxsyntax}
\envitem{refsection}[resource, \dots]
The optional argument is a comma"=separated list of resources specific to the reference section. If the argument is omitted, the reference section will use the default resource list, as specified with \cmd{addbibresource} in the preamble. If the argument is provided, it replaces the default resource list. Global resources specified with \cmd{addglobalbib} are always considered. \env{refsection} environments may not be nested, but you may use \env{refsegment} environments within a \env{refsection} to subdivide it into segments. Use the \opt{section} option of \cmd{printbibliography} to select a section when printing the bibliography, and the corresponding option of \cmd{printbiblist} when printing bibliography lists. Bibliography sections are numbered starting at~\texttt{1}. The number of the current section is also written to the transcript file. All citations given outside a \env{refsection} environment are assigned to section~0. If \cmd{printbibliography} is used within a \env{refsection}, it will automatically select the current section. The \opt{section} option is not required in this case. This also applies to \cmd{printbiblist}. Beginning a new reference section automatically ends the active reference context (see \secref{use:bib:context}).
\cmditem{newrefsection}[resource, \dots]
This command is similar to the \env{refsection} environment except that it is a stand"=alone command rather than an environment. It automatically ends the previous reference section (if any) and immediately starts a new one. Note that the reference section started by the last \cmd{newrefsection} command in the document will extend to the very end of the document. Use \cmd{endrefsection} if you want to terminate it earlier.
\end{ltxsyntax}
\subsubsection{Bibliography Segments}
\label{use:bib:seg}
The \env{refsegment} environment is used in the document body to mark a reference segment. This environment is useful if you want one global bibliography which is subdivided by chapter, section, or any other part of the document. Technically, reference segments are completely independent from document divisions such as \cmd{chapter} and \cmd{section} even though they will typically be used per chapter or section. See the \opt{refsegment} package option in \secref{use:opt:pre:gen} for a way to automate this. Also see \secref{use:use:mlt} for usage examples.
\begin{ltxsyntax}
\envitem{refsegment}
The difference between a \env{refsection} and a \env{refsegment} environment is that the former creates labels which are local to the environment whereas the latter provides a target for the \opt{segment} filter of \cmd{printbibliography} without affecting the labels. They will be unique across the entire document. \env{refsegment} environments may not be nested, but you may use them in conjunction with \env{refsection} to subdivide a reference section into segments. In this case, the segments are local to the enclosing \env{refsection} environment. Use the \env{segment} option of \cmd{printbibliography} to select a segment when printing the bibliography. Within a section, the reference segments are numbered starting at~\texttt{1} and the number of the current segment will be written to the transcript file. All citations given outside a \env{refsegment} environment are assigned to segment~0. In contrast to the \env{refsection} environment, the current segment is not selected automatically if \cmd{printbibliography} is used within a \env{refsegment} environment.
\csitem{newrefsegment}
This command is similar to the \env{refsegment} environment except that it is a stand"=alone command rather than an environment. It automatically ends the previous reference segment (if any) and immediately starts a new one. Note that the reference segment started by the last \cmd{newrefsegment} command will extend to the end of the document. Use \cmd{endrefsegment} if you want to terminate it earlier.
\end{ltxsyntax}
\subsubsection{Bibliography Categories}
\label{use:bib:cat}
Bibliography categories allow you to split the bibliography into multiple parts dedicated to different topics or different types of references, for example primary and secondary sources. See \secref{use:use:div} for usage examples.
\begin{ltxsyntax}
\cmditem{DeclareBibliographyCategory}{category}
Declares a new \prm{category}, to be used in conjunction with \cmd{addtocategory} and the
\opt{category} and \opt{notcategory} filters of \cmd{printbibliography}. This command is used in the document preamble.
\cmditem{addtocategory}{category}{key}
Assigns a \prm{key} to a \prm{category}, to be used in conjunction with the \opt{category} and \opt{notcategory} filters of \cmd{printbibliography}. This command may be used in the preamble and in the document body. The \prm{key} may be a single entry key or a comma"=separated list of keys. The assignment is global.
\end{ltxsyntax}
\subsubsection{Bibliography Headings and Environments}
\label{use:bib:hdg}
\begin{ltxsyntax}
\cmditem{defbibenvironment}{name}{begin code}{end code}{item code}
This command defines bibliography environments. The \prm{name} is an identifier passed to the \opt{env} option of \cmd{printbibliography} and \cmd{printbiblist} when selecting the environment. The \prm{begin code} is \latex code to be executed at the beginning of the environment; the \prm{end code} is executed at the end of the environment; the \prm{item code} is code to be executed at the beginning of each entry in the bibliography or a bibliography list. Here is an example of a definition based on the standard \latex \env{list} environment:
\begin{ltxexample}
\defbibenvironment{bibliography}
{\list{}
{\setlength{\leftmargin}{\bibhang}%
\setlength{\itemindent}{-\leftmargin}%
\setlength{\itemsep}{\bibitemsep}%
\setlength{\parsep}{\bibparsep}}}
{\endlist}
{\item}
\end{ltxexample}
%
As seen in the above example, usage of \cmd{defbibenvironment} is roughly similar to \cmd{newenvironment} except that there is an additional mandatory argument for the \prm{item code}.
\cmditem{defbibheading}{name}[title]{code}
This command defines bibliography headings. The \prm{name} is an identifier to be passed to the \opt{heading} option of \cmd{printbibliography} or \cmd{printbibheading} and \cmd{printbiblist} when selecting the heading. The \prm{code} should be \latex code generating a fully"=fledged heading, including page headers and an entry in the table of contents, if desired. If \cmd{printbibliography} or \cmd{printbiblist} are invoked with a \opt{title} option, the title will be passed to the heading definition as |#1|. If not, the default title specified by the optional \prm{title} argument is passed as |#1| instead. The \prm{title} argument will typically be \cmd{bibname}, \cmd{refname}, or \cmd{biblistname} (see \secref{aut:lng:key:bhd}). This command is often needed after changes to document headers in the preamble. Here is an example of a simple heading definition:
\begin{ltxexample}
\defbibheading{bibliography}[\bibname]{%
\chapter*{#1}%
\markboth{#1}{#1}}
\end{ltxexample}
\end{ltxsyntax}
The following headings, which are intended for use with \cmd{printbibliography} and \cmd{printbibheading}, are predefined:
\begin{valuelist*}
\item[bibliography]
This is the default heading used by \cmd{printbibliography} if the \opt{heading} option is not given. Its default definition depends on the document class. If the class provides a \cmd{chapter} command, the heading is similar to the bibliography heading of the standard \latex \texttt{book} class, \ie it uses \cmd{chapter*} to create an unnumbered chapter heading which is not included in the table of contents. If there is no \cmd{chapter} command, it is similar to the bibliography heading of the standard \latex \texttt{article} class, \ie it uses \cmd{section*} to create an unnumbered section heading which is not included in the table of contents. The string used in the heading also depends on the document class. With \texttt{book}-like classes the localisation string \texttt{bibliography} is used, with other classes it is \texttt{references} (see \secref{aut:lng:key}). See also \secref{use:cav:scr, use:cav:mem} for class-specific hints.
\item[subbibliography]
Similar to \texttt{bibliography} but one sectioning level lower. This heading definition uses \cmd{section*} instead of \cmd{chapter*} with a \texttt{book}-like class and \cmd{subsection*} instead of \cmd{section*} otherwise.
\item[bibintoc]
Similar to \texttt{bibliography} above but adds an entry to the table of contents.
\item[subbibintoc]
Similar to \texttt{subbibliography} above but adds an entry to the table of contents.
\item[bibnumbered]
Similar to \texttt{bibliography} above but uses \cmd{chapter} or \cmd{section} to create a numbered heading which is also added to the table of contents.
\item[subbibnumbered]
Similar to \texttt{subbibliography} above but uses \cmd{section} or \cmd{subsection} to create a numbered heading which is also added to the table of contents.
\item[none]
A blank heading definition. Use this to suppress the heading.
\end{valuelist*}
The following headings intended for use with \cmd{printbiblist} are predefined:
\begin{valuelist*}
\item[biblist]
This is the default heading used by \cmd{printbiblist} if the \opt{heading} option is not given. It is similar to \texttt{bibliography} above except that it uses the localisation string \texttt{shorthands} instead of \texttt{bibliography} or \texttt{references} (see \secref{aut:lng:key}). See also \secref{use:cav:scr, use:cav:mem} for class-specific hints.
\item[biblistintoc]
Similar to \texttt{biblist} above but adds an entry to the table of contents.
\item[biblistnumbered]
Similar to \texttt{biblist} above but uses \cmd{chapter} or \cmd{section} to create a numbered heading which is also added to the table of contents.
\end{valuelist*}
\subsubsection{Bibliography Notes}
\label{use:bib:nts}
\begin{ltxsyntax}
\cmditem{defbibnote}{name}{text}
Defines the bibliography note \prm{name}, to be used via the \opt{prenote} and \opt{postnote} options of \cmd{printbibliography} and \cmd{printbiblist}. The \prm{text} may be any arbitrary piece of text, possibly spanning several paragraphs and containing font declarations. Also see \secref{use:cav:act}.
\end{ltxsyntax}
\subsubsection{Bibliography Filters and Checks}
\label{use:bib:flt}
\begin{ltxsyntax}
\cmditem{defbibfilter}{name}{expression}
Defines the custom bibliography filter \prm{name}, to be used via the \opt{filter} option of \cmd{printbibliography}. The \prm{expression} is a complex test based on the logical operators \texttt{and}, \texttt{or}, \texttt{not}, the group separator \texttt{(...)}, and the following atomic tests:
\end{ltxsyntax}
\begin{optionlist*}
\valitem{segment}{integer}
Matches all entries cited in reference segment \prm{integer}.
\valitem{type}{entrytype}
Matches all entries whose entry type is \prm{entrytype}.
\valitem{subtype}{subtype}
Matches all entries whose \bibfield{entrysubtype} is \prm{subtype}.
\valitem{keyword}{keyword}
Matches all entries whose \bibfield{keywords} field includes \prm{keyword}. If the \prm{keyword} contains spaces, it needs to be wrapped in braces.
\valitem{category}{category}
Matches all entries assigned to \prm{category} with \cmd{addtocategory}.
\end{optionlist*}
Here is an example of a filter expression:
\begin{ltxexample}[style=latex,keywords={and,or,not,type,keyword}]
\defbibfilter{example}{%
( type=book or type=inbook )
and keyword=abc
and not keyword={x y z}
}
\end{ltxexample}
%
This filter will match all entries whose entry type is either \bibtype{book} or \bibtype{inbook} and whose \bibfield{keywords} field includes the keyword <\texttt{abc}> but not <\texttt{x y z}>. As seen in the above example, all elements are separated by whitespace (spaces, tabs, or line endings). There is no spacing around the equal sign. The logical operators are evaluated with the \cmd{ifboolexpr} command from the \sty{etoolbox} package. See the \sty{etoolbox} manual for details about the syntax. The syntax of the \cmd{ifthenelse} command from the \sty{ifthen} package, which has been employed in older versions of \biblatex, is still supported. This is the same test using \sty{ifthen}-like syntax:
\begin{ltxexample}[style=ifthen,morekeywords={\\type,\\keyword}]
\defbibfilter{example}{%
\( \type{book} \or \type{inbook} \)
\and \keyword{abc}
\and \not \keyword{x y z}
}
\end{ltxexample}
%
Note that custom filters are local to the reference section in which they are used. Use the \texttt{section} filter of \cmd{printbibliography} to select a different section. This is not possible from within a custom filter.
\begin{ltxsyntax}
\cmditem{defbibcheck}{name}{code}
Defines the custom bibliography filter \prm{name}, to be used via the \opt{check} option of \cmd{printbibliography}. \cmd{defbibcheck} is similar in concept to \cmd{defbibfilter} but much more low-level. Rather than a high-level expression, the \prm{code} is \latex code, much like the code used in driver definitions, which may perform arbitrary tests to decide whether or not a given entry is to be printed. The bibliographic data of the respective entry is available when the \prm{code} is executed. Issuing the command \cmd{skipentry} in the \prm{code} will cause the current entry to be skipped. For example, the following filter will only output entries with an \bibfield{abstract} field:
\begin{ltxexample}
\defbibcheck{<<abstract>>}{%
\iffieldundef{abstract}{<<\skipentry>>}{}}
...
\printbibliography[<<check=abstract>>]
\end{ltxexample}
%
The following check will exclude all entries published before the year 2000:
\begin{ltxexample}
\defbibcheck{recent}{%
\iffieldint{year}
{\ifnumless{\thefield{year}}{2000}
{\skipentry}
{}}
{\skipentry}}
\end{ltxexample}
%
See the author guide, in particular \secref{aut:aux:tst,aut:aux:ife}, for further details.
\end{ltxsyntax}
\subsubsection{Reference Contexts}
\label{use:bib:context}
References in a bibliography are cited and printed in a <context>. The context determines the data which is actually used to cite or provide bibliographic data for an entry. A context consists of the following information:
\begin{itemize}
\item A sorting template
\item A template for constructing the sorting keys for names
\item A string prefix for citation schemes which use alphabetic or numeric labels
\item A template for calculating name uniqueness information
\item A template for constructing alphabetic labels for names
\end{itemize}
%
The purpose of bibliography contexts is twofold. Firstly, they are used to set options which influence a printed bibliography and secondly to influence the data printed by citation commands.
The former use is the most common when one needs to print more than one bibliography list with different, for example, sorting.
\begin{ltxexample}
\usepackage[sorting=nyt]{biblatex}
\begin{document}
\cite{one}
\cite{two}
\printbibliography
\newrefcontext[sorting=ydnt]
\printbibliography
\end{ltxexample}
%
Here we print two bibliographies, one with the default <nyt> sorting template and one with the <ydnt> sorting template.
To demonstrate the second type of use of bibliography contexts, we have to understand that the actual data for an entry can vary depending on the context. This is most obvious in the case of the \bibfield{extra*} fields like \bibfield{extradate} which are generated by the backend according to the order of entries \emph{after} sorting so that they come out in the expected <a, b, c> order. This clearly shows that the \emph{data} in an entry can be different between sorting templates. If a document contains more than one bibliography list with different sorting templates, it can happen then that the \file{.bbl} contains sorting lists with the same entry but containing different data (a different value for \bibfield{extradate}, for example). The purpose of bibliography contexts is to encapsulate things inside a context so that \biblatex can use the correct entry data. An example is printing a bibliography list with a different sorting order to the global sorting order where the \opt{extra*} fields are different for the same entry between sorting lists:
\begin{ltxexample}
\usepackage[sorting=nyt,style=authoryear]{biblatex}
\DeclareSortingTemplate{yntd}{
\sort{
\field[strside=left,strwidth=4]{sortyear}
\field[strside=left,strwidth=4]{year}
\literal{9999}
}
\sort{
\field{sortname}
\field{author}
\field{editor}
}
\sort[direction=descending]{
\field{sorttitle}
\field{title}
}
}
\begin{document}
\cite{one}
\cite{two}
\printbibliography
\newrefcontext[sorting=yntd]
\cite{one}
\cite{two}
\printbibliography
\end{ltxexample}
%
Here, the second use of the citations, along with the \cmd{printbibliography} command will use data from the context of the custom <yntd> sorting template which may well be different from the data associated with the default <nyt> template. That is, the citation labels (in an authoryear style which uses \opt{extradate}) may be different \emph{for the exact same entries} between different bibliography contexts and so the citations themselves may look different.
Reference contexts can be declared with \cmd{DeclareRefcontext} and referred to by name, see below.
By default, data for a citation is drawn from the reference context of the last bibliography in which it was printed. For example:
\begin{ltxexample}[style=latex]
\DeclareRefcontext{ap}{labelprefix=A}
\begin{document}
\cite{book, article, misc}
\printbibliography[type=book]
\newrefcontext{ap}
\printbibliography[type=article]
\newrefcontext[sorting=ydnt]
\printbibliography[type=misc]
\end{document}
\end{ltxexample}
%
This example also shows the declaration and use of a named reference context. Assuming the entrykeys are indicative of their entrytypes, this is the default situation for the citations which corresponds to what users normally expect:
\begin{itemize}
\item The citation of entry \bibfield{book} would draw its data from the global reference context, because the last bibliography in which it was printed was the one in the global reference context.
\item The citation of entry \bibfield{article} would draw its data from reference context with \opt{labelprefix=A} and would therefore have a <A> prefix when cited.
\item The citation of entry \bibfield{misc} would draw its data from the reference context with \opt{sorting=ydnt}
\end{itemize}
%
In cases where the user has entries which occur in multiple bibliographies in different forms or with potentially different labels (in a numeric scheme with different \bibfield{labelprefix} values for example), it may be necessary to tell \biblatex from which reference context you wish to draw the citation information. As shown above this can be done by explicitly putting citations inside reference contexts. This can be onerous in a large document and so there is specific functionality for assigning citations to reference contexts programatically, see the \cmd{assignrefcontext*} macros below.
\begin{ltxsyntax}
\cmditem{DeclareRefcontext}{name}{key=value, \dots}
Declares a named reference context with name \prm{name}. The \prm{key=value} options define the context attributes. All context attributes are optional and default to the global settings if absent. The valid options are:
\begin{optionlist*}
\valitem{sorting}{name}
Specify a sorting template defined previously with \cmd{DeclareSortingTemplate}. This template is used to determine which data to retrieve and/or print for an entry in the commands inside the context.
\valitem{sortingnamekeytemplatename}{name}
Specify a sorting name key template defined previously with \cmd{DeclareSortingNamekeyTemplate}. This template is used to construct sorting keys for names inside the context. The template name can also be specified (in increasing order of preference) per"=entry, per"=name list and per"=name. See \secref{apx:opt} for information on setting per"=option, per"=namelist and per"=name options.
\valitem{uniquenametemplatename}{name}
Specify a uniquename template defined previously with \cmd{DeclareUniquenameTemplate} (see \secref{aut:cav:amb}). This template is used to calculate uniqueness information for names inside the context. The template name can also be specified (in increasing order of preference) per"=entry, per"=name list and per"=name. See \secref{apx:opt} for information on setting per"=option, per"=namelist and per"=name options.
\valitem{labelalphanametemplatename}{name}
Specify a template defined previously with \cmd{DeclareLabelalphaNameTemplate} (see \secref{aut:ctm:lab}). This template is used to construct name parts of alphabetic labels for names inside the context. The template name can also be specified (in increasing order of preference) per"=entry, per"=name list and per"=name. See \secref{apx:opt} for information on setting per"=option, per"=namelist and per"=name options.
\valitem{nametemplates}{name}
A convenience meta-option which sets \opt{sortingnamekeytemplate}, \opt{uniquenametemplate} and \opt{labelalphanametemplate} to the same template name. This option can also be specified (in increasing order of preference) per"=entry, per"=name list and per"=name. See \secref{apx:opt} for information on setting per"=option, per"=namelist and per"=name options.
\valitem{labelprefix}{string}
This option applies to numerical citation\slash bibliography styles only and requires that the \opt{defernumbers} option from \secref{use:opt:pre:gen} be enabled globally. Setting this option will implicitly enable \opt{resetnumbers} for the any \cmd{printbibliography} in the scope of the context (unless overridden by a user-specified value for \opt{resetnumbers}). The option assigns the \prm{string} as a prefix to all entries in the reference context. For example, if the \prm{string} is \texttt{A}, the numerical labels printed will be \texttt{[A1]}, \texttt{[A2]}, \texttt{[A3]}, etc. This is useful for subdivided numerical bibliographies where each subbibliography uses a different prefix. The \prm{string} is available to styles in the \bibfield{labelprefix} field of all affected entries. Note that the \prm{string} is fully expanded, which means that you can use context-dependent macros like \cmd{thechapter}, but not unexpandable commands such as \cmd{dag}. If you need to pass unexpandable code to \prm{string}, protect it from expansion with \cmd{detokenize}. See \secref{aut:bbx:fld:lab} for details.
\end{optionlist*}
%
\envitem{refcontext}[key=value, \dots]{name}
Wraps a reference context environment. The possible \prm{key=value} optional arguments are as for \cmd{DeclareRefcontext} and override options given for the named reference context \prm{name}. \prm{name} can also be omitted as \verb+{}+ or by omitting even the empty braces\footnote{This slightly odd syntax possibility is a result of backwards compatibility with \biblatex $<$3.5}.
The \opt{refcontext} environment cannot be nested and \biblatex will generate an error if you try to do so.
\cmditem{newrefcontext}[key=value, \dots]{name}
This command is similar to the \env{refcontext} environment except that it is a stand"=alone command rather than an environment. It automatically ends any previous reference context section begun with \cmd{newrefcontext} (if any) and immediately starts a new one. Note that the context section started by the last \cmd{newrefcontext} command in the document will extend to the very end of the document. Use \cmd{endrefcontext} if you want to terminate it earlier.
\end{ltxsyntax}
%
At the beginning of the document, there is always a global context containing global settings for each of the reference context options. Here is an example summarising the reference contexts with various settings:
\begin{ltxexample}[style=latex]
\usepackage[sorting=nty]{biblatex}
\DeclareRefcontext{testrc}{sorting=nyt}
% Global reference context:
% sorting=nty
% sortingnamekeytemplate=global
% labelprefix=
\begin{document}
\begin{refcontext}{testrc}
% reference context:
% sorting=nyt
% sortingnamekeytemplate=global
% labelprefix=
\end{refcontext}
\begin{refcontext}[labelprefix=A]{testrc}
% reference context:
% sorting=nyt
% sortingnamekeytemplate=global
% labelprefix=A
\end{refcontext}
\begin{refcontext}[sorting=ydnt,labelprefix=A]
% reference context:
% sorting=ydnt
% sortingnamekeytemplate=global
% labelprefix=A
\end{refcontext}
\newrefcontext}[labelprefix=B]
% reference context:
% sorting=nty
% sortingnamekeytemplate=global
% labelprefix=B
\endrefcontext
\newrefcontext}[sorting=ynt,labelprefix=C]{testrc}
% reference context:
% sorting=ynt
% sortingnamekeytemplate=global
% labelprefix=C
\endrefcontext
\end{ltxexample}
\begin{ltxsyntax}
\cmditem{assignrefcontextkeyws}[key=value, \dots]{keyword1,keyword2, ...}
\cmditem{assignrefcontextkeyws*}[key=value, \dots]{keyword1,keyword2, ...}
\cmditem{assignrefcontextcats}[key=value, \dots]{category1, category2, ...}
\cmditem{assignrefcontextcats*}[key=value, \dots]{category1, category2, ...}
\cmditem{assignrefcontextentries}[key=value, \dots]{entrykey1, entrykey2, ...}
\cmditem{assignrefcontextentries*}[key=value, \dots]{entrykey1, entrykey2, ...}
\cmditem{assignrefcontextentries}[key=value, \dots]{*}
\cmditem{assignrefcontextentries*}[key=value, \dots]{*}
\end{ltxsyntax}
These commands automate putting citations into refcontexts when the default behaviour is not sufficient. The \prm{key=value} options are as for \cmd{DeclareRefcontext}. The default behaviour is that the data for a citation is drawn from the refcontext of the most recently processed bibliography in which it was printed\footnote{This does not always mean what one might think. In a document containing multiple bibliographies, the last bibliography will be the context for any citations \emph{before} the first bibliography because all bibliographies are processed when the \file{.bbl} is read.}. For citations that are used in some way but not printed in a bibliography or bibliography list, they default to drawing their data from the global refcontext established at the beginning of the document. To override this behaviour, instead of manually wrapping citation commands in \env{refcontext} environments, which might be error-prone and tedious, you can register a comma"=separated list of \prm{keywords}, \prm{categories} or \prm{entrykeys} which, respectively, make the entries with any of the specified keywords, entries in any of the specified categories (see \secref{use:use:div}) or entries with any of the specified citation keys draw their data from a particular refcontext specified by the \prm{refcontext key/values} which are parsed as the per the corresponding \env{refcontext} options. Such refcontext auto-assignments are specific to the current refsection. You may specify the same citation key in any of these commands but be aware that assignment is done in the order \prm{keywords}, \prm{categories}, \prm{entrykeys} with the later specifications overriding the earlier. \cmd{assignrefcontextentries} accepts a single asterisk instead of a list of entrykeys which allows the assignment of all keys in a refsection to a refcontext with having to explicitly list them. An example:
\begin{ltxexample}[style=latex]
\assignrefcontextentries[labelprefix=A]{key2}
\cite{key1}
\begin{refcontext}[labelprefix=B]
\cite{key2}
\end{refcontext}
\end{ltxexample}
%
Here, the data for the citation of \bibfield{key2} will be drawn from refcontext \opt{labelprefix=A} and not \opt{labelprefix=B} (resulting in a label with prefix <A> and not <B>).
The starred versions do not override a local refcontext and so with:
\begin{ltxexample}[style=latex]
\assignrefcontextentries*[labelprefix=A]{key2}
\cite{key1}
\begin{refcontext}[labelprefix=B]
\cite{key2}
\end{refcontext}
\end{ltxexample}
%
the data for the citation of \bibfield{key2} will be drawn from refcontext \opt{labelprefix=B}. Note that these commands are rarely necessary unless you have multiple bibliographies in which the same citations occur and \biblatex\ cannot by default tell which bibliography list a citation should refer to. See the example file \file{94-labelprefix.tex} for more details.
\subsubsection{Dynamic Entry Sets}
\label{use:bib:set}
In addition to the \bibtype{set} entry type, \biblatex also supports dynamic entry sets defined on a per-document\slash per-refsection basis. The following command, which may be used in the document preamble or the document body, defines the set \prm{key}:
\begin{ltxsyntax}
\cmditem{defbibentryset}{key}{key1,key2,key3, \dots}
The \prm{key} is the entry key of the set, which is used like any other entry key when referring to the set. The \prm{key} must be unique and it must not conflict with any other entry key. The second argument is a comma"=separated list of the entry keys which make up the set. \cmd{defbibentryset} implies the equivalent of a \cmd{nocite} command, \ie all sets which are declared are also added to the bibliography. When declaring the same set more than once, only the first invocation of \cmd{defbibentryset} will define the set. Subsequent definitions of the same \prm{key} are ignored and work like \cmd{nocite}\prm{key}. Dynamic entry sets defined in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0. See \secref{use:use:set} for further details.
\end{ltxsyntax}
\subsection{Citation Commands}
\label{use:cit}
All citation commands generally take one mandatory and two optional arguments. The \prm{prenote} is text to be printed at the beginning of the citation. This is usually a notice such as <see> or <compare>. The \prm{postnote} is text to be printed at the very end of the citation. This is usually a page number. If only one of these arguments is given, it is taken as a postnote. If you want to specify a prenote but no postnote, you need to leave the second optional argument empty, as in |\cite[see][]{key}|. The \prm{key} argument to all citation commands is mandatory. This is the entry key or a comma"=separated list of keys corresponding to the entry keys in the \file{bib} file. In sum, all basic citations commands listed further down have the following syntax:
\begin{ltxsyntax}
\cmditem*{command}[prenote][postnote]{keys}<punctuation>
If the \opt{autopunct} package option from \secref{use:opt:pre:gen} is enabled, they will scan ahead for any \prm{punctuation} immediately following their last argument. This is useful to avoid spurious punctuation marks after citations. This feature is configured with \cmd{DeclareAutoPunctuation}, see \secref{aut:pct:cfg} for details.
\end{ltxsyntax}
\subsubsection{Standard Commands}
\label{use:cit:std}
The following commands are defined by the citation style. Citation styles may provide any arbitrary number of specialized commands, but these are the standard commands typically provided by general-purpose styles.
\begin{ltxsyntax}
\cmditem{cite}[prenote][postnote]{key}
\cmditem{Cite}[prenote][postnote]{key}
These are the bare citation commands. They print the citation without any additions such as parentheses. The numeric and alphabetic styles still wrap the label in square brackets since the reference may be ambiguous otherwise. \cmd{Cite} is similar to \cmd{cite} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix and the citation style prints any name at all.
\cmditem{parencite}[prenote][postnote]{key}
\cmditem{Parencite}[prenote][postnote]{key}
These commands use a format similar to \cmd{cite} but enclose the entire citation in parentheses. The numeric and alphabetic styles use square brackets instead. \cmd{Parencite} is similar to \cmd{parencite} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix and the citation style prints any name at all.
\cmditem{footcite}[prenote][postnote]{key}
\cmditem{footcitetext}[prenote][postnote]{key}
These command use a format similar to \cmd{cite} but put the entire citation in a footnote and add a period at the end. In the footnote, they automatically capitalize the name prefix of the first name if the \opt{useprefix} option is enabled, provided that there is a name prefix and the citation style prints any name at all. \cmd{footcitetext} differs from \cmd{footcite} in that it uses \cmd{footnotetext} instead of \cmd{footnote}.
\end{ltxsyntax}
\subsubsection{Style-specific Commands}
\label{use:cit:cbx}
The following additional citation commands are only provided by some of the citation styles which come with this package.
\begin{ltxsyntax}
\cmditem{textcite}[prenote][postnote]{key}
\cmditem{Textcite}[prenote][postnote]{key}
These citation commands are provided by all styles that come with this package. They are intended for use in the flow of text, replacing the subject of a sentence. They print the authors or editors followed by a citation label which is enclosed in parentheses. Depending on the citation style, the label may be a number, the year of publication, an abridged version of the title, or something else. The numeric and alphabetic styles use square brackets instead of parentheses. In the verbose styles, the label is provided in a footnote. Trailing punctuation is moved between the author or editor names and the footnote mark. \cmd{Textcite} is similar to \cmd{textcite} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix.
\cmditem{smartcite}[prenote][postnote]{key}
\cmditem{Smartcite}[prenote][postnote]{key}
Like \cmd{parencite} in a footnote and like \cmd{footcite} in the body.
\cmditem{cite*}[prenote][postnote]{key}
This command is provided by all author-year and author-title styles. It is similar to the regular \cmd{cite} command but merely prints the year or the title, respectively.
\cmditem{parencite*}[prenote][postnote]{key}
This command is provided by all author-year and author-title styles. It is similar to the regular \cmd{parencite} command but merely prints the year or the title, respectively.
\cmditem{supercite}{key}
This command, which is only provided by the numeric styles, prints numeric citations as superscripts without brackets. It uses \cmd{supercitedelim} instead of \cmd{multicitedelim} as citation delimiter. Note that any \prm{prenote} and \prm{postnote} arguments are ignored. If they are given, \cmd{supercite} will discard them and issue a warning message.
\end{ltxsyntax}
\subsubsection{Qualified Citation Lists}
\label{use:cit:mlt}
This package supports a class of special citation commands called <multicite> commands. The point of these commands is that their argument is a list of citations where each item forms a fully qualified citation with a pre- and\slash or postnote. This is particularly useful with parenthetical citations and citations given in footnotes. It is also possible to assign a pre- and\slash or postnote to the entire list. The multicite commands are built on top of backend commands like \cmd{parencite} and \cmd{footcite}. The citation style provides a multicite definition with \cmd{DeclareMultiCiteCommand} (see \secref{aut:cbx:cbx}). The following example illustrates the syntax of multicite commands:
\begin{ltxexample}
\parencites[35]{key1}[88--120]{key2}[23]{key3}
\end{ltxexample}
%
The format of the arguments is similar to that of the regular citation commands, except that only one citation command is given. If only one optional argument is given for an item in the list, it is taken as a postnote. If you want to specify a prenote but no postnote, you need to leave the second optional argument of the respective item empty:
\begin{ltxexample}
\parencites[35]{key1}[chapter 2 in][]{key2}[23]{key3}
\end{ltxexample}
%
In addition to that, the entire citation list may also have a pre- and\slash or postnote. The syntax of these global notes differs from other optional arguments in that they are given in parentheses rather than the usual brackets:
\begin{ltxexample}
\parencites<<(>>and chapter 3<<)>>[35]{key1}[78]{key2}[23]{key3}
\parencites<<(>>Compare<<)()>>[35]{key1}[78]{key2}[23]{key3}
\parencites<<(>>See<<)(>>and the introduction<<)>>[35]{key1}[78]{key2}[23]{key3}
\end{ltxexample}
%
Note that the multicite commands keep on scanning for arguments until they encounter a token that is not the start of an optional or mandatory argument. If a left brace or bracket follows a multicite command, you need to mask it by adding \cmd{relax} or a control space (a backslash followed by a space) after the last valid argument. This will cause the scanner to stop.
\begin{ltxexample}[style=latex,showspaces]
\parencites[35]{key1}[78]{key2}<<\relax>>[...]
\parencites[35]{key1}[78]{key2}<<\ >>{...}
\end{ltxexample}
%
By default, this package provides the following multicite commands which correspond to regular commands from \secref{use:cit:std, use:cit:cbx}:
\begin{ltxsyntax}
\cmditem{cites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{Cites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{cite} and \cmd{Cite}, respectively.
\cmditem{parencites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{Parencites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{parencite} and \cmd{Parencite}, respectively.
\cmditem{footcites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{footcitetexts}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{footcite} and \cmd{footcitetext}, respectively.
\cmditem{smartcites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{Smartcites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{smartcite} and \cmd{Smartcite}, respectively.
\cmditem{textcites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{Textcites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{textcite} and \cmd{Textcite}, respectively.
\cmditem{supercites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
The multicite version of \cmd{supercite}. This command is only provided by the numeric styles.
\end{ltxsyntax}
\subsubsection{Style-independent Commands}
\label{use:cit:aut}
Sometimes it is desirable to give the citations in the source file in a format that is not tied to a specific citation style and can be modified globally in the preamble. The format of the citations is easily changed by loading a different citation style. However, when using commands such as \cmd{parencite} or \cmd{footcite}, the way the citations are integrated with the text is still effectively hard"=coded. The idea behind the \cmd{autocite} command is to provide higher"=level citation markup which makes global switching from inline citations to citations given in footnotes (or as superscripts) possible. The \cmd{autocite} command is built on top of backend commands like \cmd{parencite} and \cmd{footcite}. The citation style provides an \cmd{autocite} definition with \cmd{DeclareAutoCiteCommand} (see \secref{aut:cbx:cbx}). This definition may be activated with the \opt{autocite} package option from \secref{use:opt:pre:gen}. The citation style will usually initialize this package option to a value which is suitable for the style, see \secref{use:xbx:cbx} for details. Note that there are certain limits to high"=level citation markup. For example, inline author-year citation schemes often integrate citations so tightly with the text that it is virtually impossible to automatically convert them to footnotes. The \cmd{autocite} command is only applicable in cases in which you would normally use \cmd{parencite} or \cmd{footcite} (or \cmd{supercite}, with a numeric style). The citations should be given at the end of a sentence or a partial sentence, immediately preceding the terminal punctuation mark, and they should not be a part of the sentence in a grammatical sense (like \cmd{textcite}, for example).
\begin{ltxsyntax}
\cmditem{autocite}[prenote][postnote]{key}
\cmditem{Autocite}[prenote][postnote]{key}
In contrast to other citation commands, the \cmd{autocite} command does not only scan ahead for punctuation marks following its last argument to avoid double punctuation marks, it actually moves them around if required. For example, with \kvopt{autocite}{footnote}, a trailing punctuation mark will be moved such that the footnote mark is printed after the punctuation. \cmd{Autocite} is similar to \cmd{autocite} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix and the citation style prints any name at all.
\cmditem*{autocite*}[prenote][postnote]{key}
\cmditem*{Autocite*}[prenote][postnote]{key}
The starred variants of \cmd{autocite} do not behave differently from the regular ones. The asterisk is simply passed on to the backend command. For example, if \cmd{autocite} is configured to use \cmd{parencite}, then \cmd{autocite*} will execute \cmd{parencite*}.
\cmditem{autocites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
\cmditem{Autocites}(multiprenote)(multipostnote)[prenote][postnote]{key}|...|[prenote][postnote]{key}
This is the multicite version of \cmd{autocite}. It also detects and moves punctuation if required. Note that there is no starred variant. \cmd{Autocites} is similar to \cmd{autocites} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix and the citation style prints any name at all.
\end{ltxsyntax}
\subsubsection{Text Commands}
\label{use:cit:txt}
The following commands are provided by the core of \biblatex. They are intended for use in the flow of text. Note that all text commands are excluded from citation tracking.
\begin{ltxsyntax}
\cmditem{citeauthor}[prenote][postnote]{key}
\cmditem*{citeauthor*}[prenote][postnote]{key}
\cmditem{Citeauthor}[prenote][postnote]{key}
\cmditem*{Citeauthor*}[prenote][postnote]{key}
These commands print the authors. Strictly speaking, it prints the \bibfield{labelname} list, which may be the
\bibfield{author}, the \bibfield{editor}, or the \bibfield{translator}. \cmd{Citeauthor} is similar to \cmd{citeauthor} but capitalizes the name prefix of the first name in the citation if the \opt{useprefix} option is enabled, provided that there is a name prefix. The starred variants effectively force maxcitenames to 1 for just this command on so only print the first name in the labelname list (potentially followed by the «et al» string if there are more names). This allows more natural textual flow when refering to a paper in the singular when otherwise \cmd{citeauthor} would generate a (naturally plural) list of names.
\cmditem{citetitle}[prenote][postnote]{key}
\cmditem*{citetitle*}[prenote][postnote]{key}
This command prints the title. It will use the abridged title in the \bibfield{shorttitle} field, if available. Otherwise it falls back to the full title found in the \bibfield{title} field. The starred variant always prints the full title.
\cmditem{citeyear}[prenote][postnote]{key}
\cmditem*{citeyear*}[prenote][postnote]{key}
This command prints the year (\bibfield{year} field or year component of \bibfield{date}). The starred variant includes the \bibfield{extradate} information, if any.
\cmditem{citedate}[prenote][postnote]{key}
\cmditem*{citedate*}[prenote][postnote]{key}
This command prints the full date (\bibfield{date} or \bibfield{year}). The starred variant includes the \bibfield{extradate} information, if any.
\cmditem{citeurl}[prenote][postnote]{key}
This command prints the \bibfield{url} field.
\cmditem{parentext}{text}
This command wraps the \prm{text} in context sensitive parentheses.
\cmditem{brackettext}{text}
This command wraps the \prm{text} in context sensitive brackets.
\end{ltxsyntax}
\subsubsection{Special Commands}
\label{use:cit:spc}
The following special commands are also provided by the core of \biblatex.
\begin{ltxsyntax}
\cmditem{nocite}{key}
\cmditem*{nocite}|\{*\}|
This command is similar to the standard \latex \cmd{nocite} command. It
adds the \prm{key} to the bibliography without printing a citation. If the
\prm{key} is an asterisk, all entries available in the in-scope bibliography datasource(s) are added to the bibliography. Like all other citation commands, \cmd{nocite} commands in the document body are local to the enclosing \env{refsection} environment, if any. In contrast to standard \latex, \cmd{nocite} may also be used in the document preamble. In this case, the references are assigned to reference section~0. For the purposes of ordering citations by appearance \cmd{nocite} will behave like all other cite commands, with the added rule that a \cmd{nocite} issued in the preamble is treated as coming before all explicit citations in reference section~0 from the document body.
\cmditem{fullcite}[prenote][postnote]{key}
This command uses the bibliography driver for the respective entry type to create a full citation similar to the bibliography entry. It is thus related to the bibliography style rather than the citation style.
\cmditem{footfullcite}[prenote][postnote]{key}
Similar to \cmd{fullcite} but puts the entire citation in a footnote and adds a period at the end.
\cmditem{volcite}[prenote]{volume}[pages]{key}
\cmditem{Volcite}[prenote]{volume}[pages]{key}
These commands are similar to \cmd{cite} and \cmd{Cite} but intended for references to multi"=volume works which are cited by volume and page number. Instead of the \prm{postnote}, they take a mandatory \prm{volume} and an optional \prm{pages} argument. Since they merely compose the postnote and pass it to the \cmd{cite} command provided by the citation style as a \prm{postnote} argument, these commands are style independent. The volume and pages/text portion are formatted with the macro \cmd{mkvolcitenote} when they are passed on to the citation command. Additionally they are made available in the special fields \bibfield{volcitevolume} and \bibfield{volcitevolume} (\secref{aut:cbx:fld}) The format of the volume portion is controlled by the field formatting directive \opt{volcitevolume}, the format of the pages/text portion is controlled by the field formatting directive \opt{volcitepages} (\secref{aut:fmt:ich}). The delimiter printed between the volume portion and the pages/text portion may be modified by redefining the macro \cmd{volcitedelim} (\secref{aut:fmt:fmt}).
\cmditem{volcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Volcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{volcite} and \cmd{Volcite}, respectively.
\cmditem{pvolcite}[prenote]{volume}[pages]{key}
\cmditem{Pvolcite}[prenote]{volume}[pages]{key}
Similar to \cmd{volcite} but based on \cmd{parencite}.
\cmditem{pvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Pvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{pvolcite} and \cmd{Pvolcite}, respectively.
\cmditem{fvolcite}[prenote]{volume}[pages]{key}
\cmditem{ftvolcite}[prenote]{volume}[pages]{key}
Similar to \cmd{volcite} but based on \cmd{footcite} and \cmd{footcitetext}, respectively.
\cmditem{fvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Fvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{fvolcite} and \cmd{Fvolcite}, respectively.
\cmditem{svolcite}[prenote]{volume}[pages]{key}
\cmditem{Svolcite}[prenote]{volume}[pages]{key}
Similar to \cmd{volcite} but based on \cmd{smartcite}.
\cmditem{svolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Svolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{svolcite} and \cmd{Svolcite}, respectively.
\cmditem{tvolcite}[prenote]{volume}[pages]{key}
\cmditem{Tvolcite}[prenote]{volume}[pages]{key}
Similar to \cmd{volcite} but based on \cmd{textcite}.
\cmditem{tvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Tvolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{tvolcite} and \cmd{Tvolcite}, respectively.
\cmditem{avolcite}[prenote]{volume}[pages]{key}
\cmditem{Avolcite}[prenote]{volume}[pages]{key}
Similar to \cmd{volcite} but based on \cmd{autocite}.
\cmditem{avolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
\cmditem{Avolcites}(multiprenote)(multipostnote)[prenote]{volume}[pages]{key}|\\...|[prenote]{volume}[pages]{key}
The multicite version of \cmd{avolcite} and \cmd{Avolcite}, respectively.
\cmditem{notecite}[prenote][postnote]{key}
\cmditem{Notecite}[prenote][postnote]{key}
These commands print the \prm{prenote} and \prm{postnote} arguments but no citation. Instead, a \cmd{nocite} command is issued for every \prm{key}. This may be useful for authors who incorporate implicit citations in their writing, only giving information not mentioned before in the running text, but who still want to take advantage of the automatic \prm{postnote} formatting and the implicit \cmd{nocite} function. This is a generic, style"=independent citation command. Special citation styles may provide smarter facilities for the same purpose. The capitalized version forces capitalization (note that this is only applicable if the note starts with a command which is sensitive to \biblatex's punctuation tracker).
\cmditem{pnotecite}[prenote][postnote]{key}
\cmditem{Pnotecite}[prenote][postnote]{key}
Similar to \cmd{notecite} but the notes are printed in parentheses.
\cmditem{fnotecite}[prenote][postnote]{key}
Similar to \cmd{notecite} but the notes are printed in a footnote.
\end{ltxsyntax}
\subsubsection{Low-level Commands}
\label{use:cit:low}
The following commands are also provided by the core of \biblatex. They grant access to all lists and fields at a lower level.
\begin{ltxsyntax}
\cmditem{citename}[prenote][postnote]{key}[format]{name list}
The \prm{format} is a formatting directive defined with \cmd{DeclareNameFormat}. Formatting directives are discussed in \secref{aut:bib:fmt}. If this optional argument is omitted, this command falls back to the format \texttt{citename}. The last argument is the name of a \prm{name list}, in the sense explained in \secref{bib:fld}.
\cmditem{citelist}[prenote][postnote]{key}[format]{literal list}
The \prm{format} is a formatting directive defined with \cmd{DeclareListFormat}. Formatting directives are discussed in \secref{aut:bib:fmt}. If this optional argument is omitted, this command falls back to the format \texttt{citelist}. The last argument is the name of a \prm{literal list}, in the sense explained in \secref{bib:fld}.
\cmditem{citefield}[prenote][postnote]{key}[format]{field}
The \prm{format} is a formatting directive defined with \cmd{DeclareFieldFormat}. Formatting directives are discussed in \secref{aut:bib:fmt}. If this optional argument is omitted, this command falls back to the format \texttt{citefield}. The last argument is the name of a \prm{field}, in the sense explained in \secref{bib:fld}.
\end{ltxsyntax}
\subsubsection{Miscellaneous Commands}
\label{use:cit:msc}
The commands in this section are little helpers related to citations.
\begin{ltxsyntax}
\csitem{citereset}
This command resets the citation style. This may be useful if the style replaces repeated citations with abbreviations like \emph{ibidem}, \emph{idem}, \emph{op. cit.}, etc. and you want to force a full citation at the beginning of a new chapter, section, or some other location. The command executes a style specific initialization hook defined with the \cmd{InitializeCitationStyle} command from \secref{aut:cbx:cbx}. It also resets the internal citation trackers of this package. The reset will affect the \cmd{ifciteseen}, \cmd{ifentryseen}, \cmd{ifciteibid}, and \cmd{ifciteidem} tests discussed in \secref{aut:aux:tst}. When used inside a \env{refsection} environment, the reset of the citation tracker is local to the current \env{refsection} environment. Also see the \opt{citereset} package option in \secref{use:opt:pre:gen}.
\csitem{citereset*}
Similar to \cmd{citereset} but only executes the style's initialization hook, without resetting the internal citation trackers.
\csitem{mancite}
Use this command to mark manually inserted citations if you mix automatically generated and manual citations. This is particularly useful if the citation style replaces repeated citations by an abbreviation like \emph{ibidem} which may get ambiguous or misleading otherwise. Always use \cmd{mancite} in the same context as the manual citation, \eg if the citation is given in a footnote, include \cmd{mancite} in the footnote. The \cmd{mancite} command executes a style specific reset hook defined with the \cmd{OnManualCitation} command from \secref{aut:cbx:cbx}. It also resets the internal <ibidem> and <idem> trackers of this package. The reset will affect the \cmd{ifciteibid} and \cmd{ifciteidem} tests discussed in \secref{aut:aux:tst}.
\csitem{pno}
This command forces a single page prefix in the \prm{postnote} argument to a citation command. See \secref{use:cav:pag} for further details and usage instructions. Note that this command is only available locally in citations and the bibliography.
\csitem{ppno}
Similar to \cmd{pno} but forces a range prefix. See \secref{use:cav:pag} for further details and usage instructions. Note that this command is only available locally in citations and the bibliography.
\csitem{nopp}
Similar to \cmd{pno} but suppresses all prefixes. See \secref{use:cav:pag} for further details and usage instructions. Note that this command is only available locally in citations and the bibliography.
\csitem{psq}
In the \prm{postnote} argument to a citation command, this command indicates a range of two pages where only the starting page is given. See \secref{use:cav:pag} for further details and usage instructions. The suffix printed is the localisation string \texttt{sequens}, see \secref{aut:lng:key}. The spacing inserted between the suffix and the page number may be modified by redefining the macro \cmd{sqspace}. The default is an unbreakable interword space. Note that this command is only available locally in citations and the bibliography.
\csitem{psqq}
Similar to \cmd{psq} but indicates an open-ended page range. See \secref{use:cav:pag} for further details and usage instructions. The suffix printed is the localisation string \texttt{sequentes}, see \secref{aut:lng:key}. This command is only available locally in citations and the bibliography.
\cmditem{pnfmt}{text}
This command formats is argument \prm{text} in the same format as \bibfield{postnote}. The command can be used to format a page range while adding additional text in the postnote argument of a cite command.
\begin{ltxexample}
\autocite[\pnfmt{378-381, 383} and more]{sigfridsson}
\end{ltxexample}
\cmditem{RN}{integer}
This command prints an integer as an uppercase Roman numeral. The formatting applied to the numeral may be modified by redefining the macro \cmd{RNfont}.
\cmditem{Rn}{integer}
Similar to \cmd{RN} but prints a lowercase Roman numeral. The formatting applied to the numeral may be modified by redefining the macro \cmd{Rnfont}.
\end{ltxsyntax}
\subsubsection{\sty{natbib} Compatibility Commands}
\label{use:cit:nat}
The \opt{natbib} package option loads a \sty{natbib} compatibility module. The module defines aliases for the citation commands provided by the \sty{natbib} package. This includes aliases for the core citation commands \cmd{citet} and \cmd{citep} as well as the variants \cmd{citealt} and \cmd{citealp}. The starred variants of these commands, which print the full author list, are also supported. The \cmd{cite} command, which is handled in a particular way by \sty{natbib}, is not treated in a special way. The text commands (\cmd{citeauthor}, \cmd{citeyear}, etc.) are also supported, as are all commands which capitalize the name prefix (\cmd{Citet}, \cmd{Citep}, \cmd{Citeauthor}, etc.). Aliasing with \cmd{defcitealias}, \cmd{citetalias}, and \cmd{citepalias} is possible as well. Note that the compatibility commands will not emulate the citation format of the \sty{natbib} package. They merely alias \sty{natbib}'s commands to functionally equivalent facilities of the \biblatex package. The citation format depends on the main citation style. However, the compatibility style will adapt \cmd{nameyeardelim} to match the default style of the \sty{natbib} package.
\subsubsection[\sty{mcite}-like Citation Commands]{\sty{mcite}-like Citation Commands}
\label{use:cit:mct}
The \opt{mcite} package option loads a special citation module which provides \sty{mcite}\slash \sty{mciteplus}-like citation commands. Strictly speaking, what the module provides are wrappers for the commands of the main citation style. For example, the following command:
\begin{ltxexample}
\mcite{key1,setA,*keyA1,*keyA2,*keyA3,key2,setB,*keyB1,*keyB2,*keyB3}
\end{ltxexample}
%
is essentially equivalent to this:
\begin{ltxexample}
\defbibentryset{setA}{keyA1,keyA2,keyA3}%
\defbibentryset{setB}{keyB1,keyB2,keyB3}%
\cite{key1,setA,key2,setB}
\end{ltxexample}
%
The \cmd{mcite} command will work with any style since the \cmd{cite} backend command is controlled by the main citation style as usual. The \texttt{mcite} module provides wrappers for the standard commands in \secref{use:cit:std,use:cit:cbx}. See \tabref{use:cit:mct:tab2} for an overview. Pre and postnotes as well as starred variants of all commands are also supported. The parameters will be passed to the backend command. For example:
\begin{ltxexample}
\mcite*[pre][post]{setA,*keyA1,*keyA2,*keyA3}
\end{ltxexample}
%
will execute:
\begin{ltxexample}
\defbibentryset{setA}{keyA1,keyA2,keyA3}%
\cite*[pre][post]{setA}
\end{ltxexample}
%
Note that the \texttt{mcite} module is not a compatibility module. It provides commands which are very similar but not identical in syntax and function to \sty{mcite}'s commands. When migrating from \sty{mcite}\slash\sty{mciteplus} to \biblatex, legacy files must be updated. With \sty{mcite}, the first member of the citation group is also the identifier of the group as a whole. Borrowing an example from the \sty{mcite} manual, this group:
\begin{table}
\caption{\sty{mcite}-like commands}
\label{use:cit:mct:tab1}
\tablesetup
\begin{tabular}{@{}V{0.5\textwidth}@{}V{0.5\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Standard Command} &
\multicolumn{1}{@{}H}{\sty{mcite}-like Command} \\
\cmidrule(r){1-1}\cmidrule{2-2}
|\cite| & |\mcite| \\
|\Cite| & |\Mcite| \\
|\parencite| & |\mparencite| \\
|\Parencite| & |\Mparencite| \\
|\footcite| & |\mfootcite| \\
|\footcitetext| & |\mfootcitetext| \\
|\textcite| & |\mtextcite| \\
|\Textcite| & |\Mtextcite| \\
|\supercite| & |\msupercite| \\
|\autocite| & |\mautocite| \\
|\Autocite| & |\Mautocite| \\
\bottomrule
\end{tabular}
\end{table}
\begin{ltxexample}
\cite{<<glashow>>,*salam,*weinberg}
\end{ltxexample}
%
consists of three entries and the entry key of the first one also serves as identifier of the entire group. In contrast to that, a \biblatex entry set is an entity in its own right. Therefore, it requires a unique entry key which is assigned to the set as it is defined:
\begin{ltxexample}
\mcite{<<set1>>,*glashow,*salam,*weinberg}
\end{ltxexample}
%
Once defined, an entry set is handled like any regular entry in a \file{bib} file. When using one of the \texttt{numeric} styles which come with \biblatex and activating its \opt{subentry} option, it is even possible to refer to set members. See \tabref{use:cit:mct:tab2} for some examples. Restating the original definition of the set is redundant, but permissible. In contrast to \sty{mciteplus}, however, restating a part of the original definition is invalid. Use the entry key of the set instead.
\begin{table}
\caption[\sty{mcite}-like syntax]
{\sty{mcite}-like syntax (sample output with \kvopt{style}{numeric} and \opt{subentry} option)}
\label{use:cit:mct:tab2}
\tablesetup
\begin{tabular}{@{}V{0.6\textwidth}@{}V{0.1\textwidth}@{}p{0.3\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Input} &
\multicolumn{1}{@{}H}{Output} &
\multicolumn{1}{@{}H}{Comment} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule{3-3}
|\mcite{set1,*glashow,*salam,*weinberg}|& [1] & Defining and citing the set \\
|\mcite{set1}| & [1] & Subsequent citation of the set \\
|\cite{set1}| & [1] & Regular |\cite| works as usual \\
|\mcite{set1,*glashow,*salam,*weinberg}|& [1] & Redundant, but permissible \\
|\mcite{glashow}| & [1a] & Citing a set member \\
|\cite{weinberg}| & [1c] & Regular |\cite| works as well \\
\bottomrule
\end{tabular}
\end{table}
\subsection{Localization Commands}
\label{use:lng}
The \biblatex package provides translations for key terms such as <edition> or <volume> as well as definitions for language specific features such as the date format and ordinals. These definitions, which are loaded automatically, may be modified or extended in the document preamble or the configuration file with the commands introduced in this section.
\begin{ltxsyntax}
\cmditem{DefineBibliographyStrings}{language}{definitions}
This command is used to define localisation strings. The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglossia} packages, \ie one of the identifiers listed in \tabref{bib:fld:tab1} on page \pageref{bib:fld:tab1}. The \prm{definitions} are \keyval pairs which assign an expression to an identifier:
\begin{ltxexample}
\DefineBibliographyStrings{american}{%
bibliography = {Bibliography},
shorthands = {Abbreviations},
editor = {editor},
editors = {editors},
}
\end{ltxexample}
%
A complete list of all keys supported by default is given is \secref{aut:lng:key}. Note that all expressions should be capitalized as they usually are when used in the middle of a sentence. The \biblatex package will automatically capitalize the first word when required at the beginning of a sentence. Expressions intended for use in headings should be capitalized in a way that is suitable for titling. In contrast to \cmd{DeclareBibliographyStrings}, \cmd{DefineBibliographyStrings} overrides both the full and the abbreviated version of the string. See \secref{aut:lng:cmd} for further details.
\cmditem{DefineBibliographyExtras}{language}{code}
This command is used to adapt language specific features such as the date format and ordinals. The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglossia} packages. The \prm{code}, which may be arbitrary \latex code, will usually consist of redefinitions of the formatting commands from \secref{use:fmt:lng}.
\cmditem{UndefineBibliographyExtras}{language}{code}
This command is used to restore the original definition of any commands modified with \cmd{DefineBibliographyExtras}. If a redefined command is included in \secref{use:fmt:lng}, there is no need to restore its previous definition since these commands are adapted by all language modules anyway.
\cmditem{DefineHyphenationExceptions}{language}{text}
This is a \latex frontend to \tex's \cmd{hyphenation} command which defines hyphenation exceptions.
The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglossia} packages. The \prm{text} is a whitespace"=separated list of words. Hyphenation points are marked with a dash:
\begin{ltxexample}
\DefineHyphenationExceptions{american}{%
hy-phen-ation ex-cep-tion
}
\end{ltxexample}
\cmditem{NewBibliographyString}{key}
This command declares new localisation strings, \ie it initializes a new \prm{key} to be used in the
\prm{definitions} of \cmd{DefineBibliographyStrings}. The \prm{key} argument may also be a comma"=separated
list of key names. The keys listed in \secref{aut:lng:key} are defined by default.
\end{ltxsyntax}
\subsection{Entry Querying Commands}
\label{use:eq}
The commands in this section are user-facing equivalents of the identically-named commands in section \secref{aut:aux:tst}. They can be used to test for the presence and attributes of specific bibliography entries. See section \secref{aut:aux:tst} for usage.
\begin{ltxsyntax}
\cmditem{ifentryseen}{entrykey}{true}{false}
\cmditem{ifentryinbib}{entrykey}{true}{false}
\cmditem{ifentrycategory}{entrykey}{category}{true}{false}
\cmditem{ifentrykeyword}{entrykey}{keyword}{true}{false}
\end{ltxsyntax}
\subsection{Formatting Commands}
\label{use:fmt}
The commands and facilities presented in this section may be used to adapt the format of citations and the bibliography.
\subsubsection{Generic Commands and Hooks}
\label{use:fmt:fmt}
The commands in this section may be redefined with \cmd{renewcommand} in the document preamble. Those marked as <Context Sensitive> in the margin can also be customised with \cmd{DeclareDelimFormat} and are printed with \cmd{printdelim} (\secref{use:fmt:csd}). Note that all commands starting with \cmd{mk\dots} take one argument. All of these commands are defined in \path{biblatex.def}.
\begin{ltxsyntax}
\csitem{bibsetup}
Arbitrary code to be executed at the beginning of the bibliography, intended for commands which affect the layout of the bibliography.
\csitem{bibfont}
Arbitrary code setting the font used in the bibliography. This is very similar to \cmd{bibsetup} but intended for switching fonts.
\csitem{citesetup}
Arbitrary code to be executed at the beginning of each citation command.
\csitem{newblockpunct}
The separator inserted between <blocks> in the sense explained in \secref{aut:pct:new}. The default definition is controlled by the package option \opt{block} (see \secref{use:opt:pre:gen}).
\csitem{newunitpunct}
The separator inserted between <units> in the sense explained in \secref{aut:pct:new}. This will usually be a period or a comma plus an interword space. The default definition is a period and a space.
\csitem{finentrypunct}
The punctuation printed at the very end of every bibliography entry, usually a period. The default definition is a period.
\csitem{entrysetpunct}
The punctuation printed between bibliography subentries of an entry set. The default definition is a semicolon and a space.
\csitem{bibnamedelima}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend after the first name element if the element is less than three characters long and before the last element. The default definition is \cmd{addhighpenspace}, \ie a space penalized by the value of the \cnt{highnamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimb}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend between all name elements where \cmd{bibnamedelima} does not apply. The default definition is \cmd{addlowpenspace}, \ie a space penalized by the value of the \cnt{lownamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimc}
This delimiter controls the spacing between name parts. The default name formats use it between the name prefix and the family name if \kvopt{useprefix}{true}. The default definition is \cmd{addhighpenspace}, \ie a space penalized by the value of the \cnt{highnamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimd}
This delimiter controls the spacing between name parts. The default name formats use it between all name parts where \cmd{bibnamedelimc} does not apply. The default definition is \cmd{addlowpenspace}, \ie a space penalized by the value of the \cnt{lownamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimi}
This delimiter replaces \cmd{bibnamedelima/b} after initials. Note that this only applies to initials given as such in the \file{bib} file, not to the initials automatically generated by \biblatex which use their own set of delimiters.
\csitem{bibinitperiod}
The punctuation inserted automatically by the backend after all initials unless \cmd{bibinithyphendelim} applies. The default definition is a period (\cmd{adddot}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibinitdelim}
The spacing inserted automatically by the backend between multiple initials unless \cmd{bibinithyphendelim} applies. The default definition is an unbreakable interword space. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibinithyphendelim}
The punctuation inserted automatically by the backend between the initials of hyphenated name parts, replacing \cmd{bibinitperiod} and \cmd{bibinitdelim}. The default definition is a period followed by an unbreakable hyphen. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibindexnamedelima}
Replaces \cmd{bibnamedelima} in the index.
\csitem{bibindexnamedelimb}
Replaces \cmd{bibnamedelimb} in the index.
\csitem{bibindexnamedelimc}
Replaces \cmd{bibnamedelimc} in the index.
\csitem{bibindexnamedelimd}
Replaces \cmd{bibnamedelimd} in the index.
\csitem{bibindexnamedelimi}
Replaces \cmd{bibnamedelimi} in the index.
\csitem{bibindexinitperiod}
Replaces \cmd{bibinitperiod} in the index.
\csitem{bibindexinitdelim}
Replaces \cmd{bibinitdelim} in the index.
\csitem{bibindexinithyphendelim}
Replaces \cmd{bibinithyphendelim} in the index.
\csitem{revsdnamepunct}
The punctuation to be printed between the given and family name parts when a name is reversed. The default is a comma. Here is an example showing a name with the default comma as \cmd{revsdnamedelim}:
\begin{ltxexample}
Jones<<,>> Edward
\end{ltxexample}
This command should be used with \cmd{bibnamedelimd} as a reversed-name separator in formatting directives for name lists. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedash}
The dash to be used as a replacement for recurrent authors or editors in the bibliography. The default is an <em> or an <en> dash, depending on the indentation of the list of references.
\csitem{labelnamepunct}\DeprecatedMark
A separator to be printed after the name used for alphabetizing in the bibliography (\bibfield{author} or \bibfield{editor}, if the \bibfield{author} field is undefined) instead of \cmd{newunitpunct}. The default is \cmd{newunitpunct}, \ie it is not handled differently from regular unit punctuation but permits convenient reconfiguration. This punctuation command is deprecated and has been superseded by the context-sensitive \cmd{nametitledelim} (see \secref{use:fmt:csd}). For backwards compatibility reasons, however, \cmd{nametitledelim} still defaults to \cmd{labelnamepunct} in the \texttt{bib} and \texttt{biblist} contexts. Style authors may want to consider replacing \cmd{labelnampunct} with \texttt{\textbackslash printdelim\{nametitledelim\}} and users may want to prefer modifying the context-sensitive \texttt{nametitledelim} in the \texttt{bib} context with \cmd{DeclareDelimFormat} over redefining \cmd{labelnamepunct}, e.g.
\begin{ltxexample}
\DeclareDelimFormat[bib]{nametitledelim}{%
\addcolon\space}
\end{ltxexample}
\csitem{subtitlepunct}
The separator printed between the fields \bibfield{title} and \bibfield{subtitle}, \bibfield{booktitle} and \bibfield{booksubtitle}, as well as \bibfield{maintitle} and \bibfield{mainsubtitle}. With the default styles, this separator replaces \cmd{newunitpunct} at this location. The default definition is \cmd{newunitpunct}, \ie it is not handled differently from regular unit punctuation.
\csitem{intitlepunct}
The separator between the word «in» and the following title in entry types such as \bibtype{article}, \bibtype{inbook}, \bibtype{incollection}, etc. The default definition is a colon plus an interword space (\eg «Article, in: \emph{Journal}» or «Title, in: \emph{Book}»). Note that this is the separator string, not only the punctuation mark. If you don't want a colon after «in», \cmd{intitlepunct} should still insert a space.
\csitem{bibpagespunct}
The separator printed before the \bibfield{pages} field. The default is a comma plus an interword space.
\csitem{bibpagerefpunct}
The separator printed before the \bibfield{pageref} field. The default is an interword space.
\csitem{bibeidpunct}
The separator printed before the \bibfield{eid} field (similar to \cmd{bibpagespunct}). The default is a comma plus an interword space.
\csitem{multinamedelim}\CSdelimMark
The delimiter printed between multiple items in a name list like \bibfield{author} or \bibfield{editor} if there are more than two names in the list. The default is a comma plus an interword space. See \cmd{finalnamedelim} for an example.\footnote{Note that \cmd{multinamedelim} is not used at all if there are only two names in the list. In this case, the default styles use the \cmd{finalnamedelim}.}
\csitem{finalnamedelim}\CSdelimMark
The delimiter printed instead of \cmd{multinamedelim} before the final name in a name list. The default is the localised term <and>, separated by interword spaces. Here is an example:
\begin{ltxexample}
Michel Goossens<<,>> Frank Mittelbach <<and>> Alexander Samarin
Edward Jones <<and>> Joe Williams
\end{ltxexample}
%
The comma in the first example is the \cmd{multinamedelim} whereas the string <and> in both examples is the \cmd{finalnamedelim}. See also \cmd{finalandcomma} in \secref{use:fmt:lng}.
\csitem{revsdnamedelim}\CSdelimMark
An extra delimiter printed after the first name in a name list if the first name is reversed (only in lists with two names). The default is an empty string, \ie no extra delimiter will be printed. Here is an example showing a name list with a comma as \cmd{revsdnamedelim}:
\begin{ltxexample}
Jones, Edward<<, and>> Joe Williams
\end{ltxexample}
%
In this example, the comma after <Edward> is the \cmd{revsdnamedelim} whereas the string <and> is the \cmd{finalnamedelim}, printed in addition to the former.
\csitem{andothersdelim}\CSdelimMark
The delimiter printed before the localisation string <\texttt{andothers}> if a name list like \bibfield{author} or \bibfield{editor} is truncated. The default is an interword space.
\csitem{multilistdelim}\CSdelimMark
The delimiter printed between multiple items in a literal list like \bibfield{publisher} or \bibfield{location} if there are more than two items in the list. The default is a comma plus an interword space. See \cmd{multinamedelim} for further explanation.
\csitem{finallistdelim}\CSdelimMark
The delimiter printed instead of \cmd{multilistdelim} before the final item in a literal list. The default is the localised term <and>, separated by interword spaces. See \cmd{finalnamedelim} for further explanation.
\csitem{andmoredelim}\CSdelimMark
The delimiter printed before the localisation string <\texttt{andmore}> if a literal list like \bibfield{publisher} or \bibfield{location} is truncated. The default is an interword space.
\csitem{multicitedelim}
The delimiter printed between citations if multiple entry keys are passed to a single citation command. The default is a semicolon plus an interword space.
\csitem{multiciterangedelim}
The delimiter printed between two citations if they are compressed to a range. The default is \cmd{bibrangedash}.
\csitem{multicitesubentrydelim}
The delimiter printed between subentry citations of the same set. This delimiter is only used in citation styles that reduce citations of the same set to a more compact form (\opt{subentry} of \texttt{numeric-comp}). The default is a comma.
\csitem{multicitesubentryrangedelim}
The delimiter printed between two citations of the same set if they are compressed to a range. The default is \cmd{multiciterangedelim}.
\csitem{supercitedelim}
Similar to \cmd{multicitedelim}, but used by the \cmd{supercite} command only. The default is a comma.
\csitem{superciterangedelim}
Analogue of \cmd{multiciterangedelim} for \cmd{supercite}. The default is \cmd{bibrangedash}.
\csitem{supercitesubentrydelim}
Analogue of \cmd{multicitesubentrydelim} for \cmd{supercite}. The default is \cmd{supercitedelim}.
\csitem{supercitesubentryrangedelim}
Analogue of \cmd{multicitesubentryrangedelim} for \cmd{supercite}. The default is \cmd{superciterangedelim}.
\csitem{compcitedelim}
Similar to \cmd{multicitedelim}, but used by certain citation styles when <compressing> multiple citations. The default definition is a comma plus an interword space.
\csitem{textcitedelim}
Similar to \cmd{multicitedelim}, but used by \cmd{textcite} and related commands (\secref{use:cit:cbx}). The default is a comma plus an interword space. The standard styles modify this provisional definition to ensure that the delimiter before the final citation is the localised term <and>, separated by interword spaces. See also \cmd{finalandcomma} and \cmd{finalandsemicolon} in \secref{use:fmt:lng}.
\csitem{nametitledelim}\CSdelimMark
The delimiter printed between the author\slash editor and the title by author-title and some verbose citation styles and in the bibliography. In author-year bibliography styles this delimiter is placed after the author\slash editor and year and before the title. The default definition inside bibliographies is the now deprecated \cmd{labelnamepunct} and is a comma plus an interword space otherwise.
\csitem{nameyeardelim}\CSdelimMark
The delimiter printed between the author\slash editor and the year by author-year citation and bibliography styles. The default definition is an interword space.
\csitem{namelabeldelim}\CSdelimMark
The delimiter printed between the name\slash title and the label by alphabetic and numeric citation styles. The default definition is an interword space.
\csitem{nonameyeardelim}\CSdelimMark
The delimiter printed between the substitute for the labelname when it does not exist (usually the label or title in standard styles) and the year in author-year citation and bibliography styles. This is only used when there is no labelname since when the labelname exists, \cmd{nameyeardelim} is used. The default definition is an interword space.
\csitem{authortypedelim}\CSdelimMark
The delimiter printed between the author and the \texttt{authortype}. The default is a comma followed by a space.
\csitem{editortypedelim}\CSdelimMark
The delimiter printed between the editor and the \texttt{editor} or \texttt{editortype} string. The default is a comma followed by a space.
\csitem{translatortypedelim}\CSdelimMark
The delimiter printed between the translator and the \texttt{translator} string. The default is a comma followed by a space.
\csitem{labelalphaothers}
A string to be appended to the non"=numeric portion of the \bibfield{labelalpha} field (\ie the field holding the citation label used by alphabetic citation styles) if the number of authors\slash editors exceeds the \opt{maxalphanames} threshold or the \bibfield{author}\slash \bibfield{editor} list was truncated in the \file{bib} file with the keyword <\texttt{and others}>. This will typically be a single character such as a plus sign or an asterisk. The default is a plus sign. This command may also be redefined to an empty string to disable this feature. In any case, it must be redefined in the preamble.
\csitem{sortalphaothers}
Similar to \cmd{labelalphaothers} but used in the sorting process. Setting it to a different value is advisable if the latter contains formatting commands, for example:
\begin{ltxexample}
\renewcommand*{\labelalphaothers}{\textbf{+}}
\renewcommand*{\sortalphaothers}{+}
\end{ltxexample}
%
If \cmd{sortalphaothers} is not redefined, it defaults to \cmd{labelalphaothers}.
\csitem{volcitedelim}
The delimiter printed between the volume portion and the page/text portion of \cmd{volcite} and related commands (\secref{use:cit:spc}).
\cmditem{mkvolcitenote}{volume}{pages}
This macro formats the \prm{volume} and \prm{pages} arguments of \cmd{volcite} and related commands (\secref{use:cit:spc}) when they are passed on to the underlying citation command.
\csitem{prenotedelim}\CSdelimMark
The delimiter printed after the \prm{prenote} argument of a citation command. See \secref{use:cit} for details. The default is an interword space.
\csitem{postnotedelim}\CSdelimMark
The delimiter printed before the \prm{postnote} argument of a citation command. See \secref{use:cit} for details. The default is a comma plus an interword space.
\csitem{extpostnotedelim}\CSdelimMark
The delimiter printed between the citation and the parenthetical \prm{postnote} argument of a citation command when the postnote occurs outside of the citation parentheses. In the standard styles, this occurs when the citation uses the shorthand field of the entry. See \secref{use:cit} for details. The default is an interword space.
\csitem{multiprenotedelim}\CSdelimMark
The delimiter printed after the \prm{multiprenote} argument of a citation command. See \secref{use:cit} for details. The default is \cs{prenotedelim}.
\csitem{multipostnotedelim}\CSdelimMark
The delimiter printed before the \prm{multipostnote} argument of a citation command. See \secref{use:cit} for details. The default is \cs{postnotedelim}.
\cmditem{mkbibname<namepart>}{text}
This command, which takes one argument, is used to format the name part <namepart> of name list fields. The default datamodel defines the name parts <family>, <given>, <prefix> and <suffix> and therefore the following macros are automatically defined:
\begin{ltxexample}
\mkbibnamefamily
\mkbibnamegiven
\mkbibnameprefix
\mkbibnamesuffix
\end{ltxexample}
%
For backwards compatibility with the legacy \bibtex name parts, the following are also defined, will generate warnings and will set the correct macro:
\begin{ltxexample}
\mkbibnamelast
\mkbibnamefirst
\mkbibnameaffix
\end{ltxexample}
\cmditem{mkbibcompletenamefamily}{text}
This command, which takes one argument, is used to format the complete name in \texttt{family} format order.
\cmditem{mkbibcompletenamefamilygiven}{text}
This command, which takes one argument, is used to format the complete name in \texttt{family-given} format order.
\cmditem{mkbibcompletenamegivenfamily}{text}
This command, which takes one argument, is used to format the complete name in \texttt{given-family} format order.
\cmditem{mkbibcompletename}{text}
The initial value of all default formatting hooks \cmd{mkbibcompletename<formatorder>}.
\csitem{datecircadelim}\CSdelimMark
When formatting dates with the global option \opt{datecirca} enabled, the delimiter printed after any localised <circa> term. Defaults to interword space.
\csitem{dateeradelim}\CSdelimMark
When formatting dates with the global option \opt{dateera} set, the delimiter printed before the localisation era term. Defaults to interword space.
\csitem{dateuncertainprint}
Prints date uncertainty information when the global option \opt{dateuncertain} is enabled and the \cmd{ifdateuncertain} test is true. By default, prints the language specific \cmd{bibdateuncertain} string (\secref{use:fmt:lng}).
\csitem{enddateuncertainprint}
Prints date uncertainty information when the global option \opt{dateuncertain} is enabled and the \cmd{ifenddateuncertain} test is true. By default, prints the language specific \cmd{bibdateuncertain} string (\secref{use:fmt:lng}).
\csitem{datecircaprint}
Prints date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifdatecirca} test is true. By default, prints the <circa> localised term (\secref{aut:lng:key:dt}) and the \opt{datecircadelim} delimiter.
\csitem{enddatecircaprint}
Prints date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifenddatecirca} test is true. By default, prints the <circa> localised term (\secref{aut:lng:key:dt}) and the \opt{datecircadelim} delimiter.
\csitem{datecircaprintiso}
Prints \acr{ISO8601-2} format date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifdatecirca} test is true. Prints \cmd{textasciitilde}.
\csitem{enddatecircaprintiso}
Prints \acr{ISO8601-2} format date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifenddatecirca} test is true. Prints \cmd{textasciitilde}.
\cmditem{dateeraprint}{yearfield}
Prints date era information when the global option \opt{dateera} is set to <secular> or <christian>. By default, prints the \opt{dateeradelim} delimiter and the appropriate localised era term (\secref{aut:lng:key:dt}). If the \opt{dateeraauto} option is set, then the passed \prm{yearfield} (which is the name of a year field such as <year>, <origyear>, <endeventyear> etc.) is tested to see if its value is earlier than the \opt{dateeraauto} threshold and if so, then the BCE/CE localisation will be output too. The default setting for \opt{dateeraauto} is 0 and so only BCE/BC localisation strings are candidates for output. Detects whether the start or end year era information is to be printed by looking at the \prm{yearfield} name passed to it.
\csitem{dateeraprintpre}
Prints date era information when the global option \opt{dateera} is set to <astronomical>. By default, prints \opt{bibdataeraprefix}. Detects whether the start or end year era information is to be printed by looking at the \prm{yearfield} name passed to it.
\csitem{relatedpunct}
The separator between the \bibfield{relatedtype} bibliography localisation string and the data from the first related entry. Here is an example with \cmd{relatedpunct} set to a dash:
\begin{ltxexample}
A. Smith. Title. 2000, (Orig. pub. as<<->>Origtitle)
\end{ltxexample}
\csitem{relateddelim}
The generic separator between the data of multiple related entries. The default definition is an optional dot plus linebreak. Here is an example where volumes A-E are related entries of the 5 volume main work:
\begin{ltxexample}
Donald E. Knuth. Computers & Typesetting. 5 vols. Reading, Mass.: Addison-Wesley, 1984-1986.
Vol. A: The TEXbook. 1984.
Vol. B: TEX: The Program. 1986.
Vol. C: The METAFONTbook. By. 1986.
Vol. D: METAFONT: The Program. 1986.
Vol. E: Computer Modern Typefaces. 1986.
\end{ltxexample}
\csitem{relateddelim$<$relatedtype$>$}
The separator between the data of multiple related entries inside related entries of type <relatedtype>. There is no default, if such a type-specific delimiter does not exist, \cmd{relateddelim} is used.
\csitem{begrelateddelim}
The generic separator before the block of related entries. The default definition is \cmd{newunitpunct}.
\csitem{begrelateddelim$<$relatedtype$>$}
The separator between the block of related entries of type <relatedtype>. There is no default, if such a type-specific delimiter does not exist, \cmd{relateddelim} is used.
\end{ltxsyntax}
\subsubsection{Context-sensitive Delimiters}
\label{use:fmt:csd}
The delimiters described in \secref{use:fmt:fmt} are globally defined. That is, no matter where you use them, they print the same thing. This is not necessarily desirable for delimiters which you might want to print different things in different contexts. Here <context> means things like <inside a text citation> or <inside a bibliography item>. For this reason, \biblatex\ provides a more sophisticated delimiter specification and user interface alongside the standard one based on normal macros defined with \cmd{newcommand}.
\begin{ltxsyntax}
\cmditem{DeclareDelimFormat}[context, \dots]{name, \dots}{code}
\cmditem*{DeclareDelimFormat}*[context, \dots]{name, \dots}{code}
Declares the delimiter macros in the comma"=separated list \prm{names} with the replacement text \prm{code}. If the optional comma"=separated list of \prm{contexts} is given, declare the \prm{names} only for those contexts. \prm{names} defined without any \prm{contexts} behave just like the global delimiter definitions which \cmd{newcommand} gives---just a plain macro with a replacement which can be used as \cmd{name}. However, you can also call delimiter macros defined in this way by using \cmd{printdelim}, which is context-aware. The starred version clears all \prm{context} specific declarations for all \prm{names} first.
\cmditem{DeclareDelimAlias}[alias context, \dots]{alias}[delim context]{delim}
Declares \prm{alias} to be an alias for the delimiter \prm{delim}. If the optional \prm{alias context, \dots} nor \prm{delim context} are given, the assigment is performed for all existing contexts of the target \prm{delim} separately, so that \prm{alias} becomes an exact copy of \prm{delim} in all contexts. If only the second optional argument \prm{delim context} is given, all existing contexts of \prm{alias} will be cleared and the global/empty context becomes an alias of \prm{delim} in the context \prm{delim context}. The first optional argument \prm{alias context, \dots} may hold a list of contexts for which the alias is assigned. In that case the second optional argument \prm{delim context} specifies the context of the target delimiter. This argument may not be a list, it can only hold one context. If it is missing, the \prm{alias context} is assumed (if \prm{alias context} is a list, the assignment is performed separately for each list item), if it is empty the global context is used.
\begin{ltxexample}[style=latex]
\DeclareDelimAlias[bib,biblist]{finalnamedelim}[]{multinamedelim}
\end{ltxexample}
%
Defines the \opt{bib} and \opt{biblist} contexts of \cmd{finalnamedelim} as aliases of \cmd{multinamedelim} in global context.
On the other hand
\begin{ltxexample}[style=latex]
\DeclareDelimAlias[bib,biblist]{finalnamedelim}{multinamedelim}
\end{ltxexample}
%
defines \cmd{finalnamedelim} in the context \opt{bib} to be an alias of \cmd{multinamedelim} in the \opt{bib} context and defines \cmd{finalnamedelim} in \opt{biblist} context to be an alias of \cmd{multinamedelim} in \opt{biblist}.
\cmditem*{DeclareDelimAlias}*[alias context, \dots]{alias}[delim context]{delim}\DeprecatedMark
The starred version of \cmd{DeclareDelimAlias} is deprecated in favour of using unstarred \cmd{DeclareDelimAlias} with optional arguments.
It assigns the delimiter alias for specific contexts only. The first optional argument \prm{alias context} holds a list of contexts for which the assignment is going to be performed. If it is empty or missing the global/empty context is assumed. The second optional argument \prm{delim context} specifies the context of the target delimiter. This argument may not be a list, it can only hold one context. If it is missing the \prm{alias context} is assumed (if \prm{alias context} is a list, the assignment is performed separately for each list item), if it is empty the global context is used.
\cmditem{printdelim}[context]{name}
Prints a delimiter with name \prm{name}, locally establishing a optional \prm{context} first. Without the optional \prm{context}, \cmd{printdelim} uses the currently active delimiter context.
Delimiter contexts are simply a string, the value of the internal macro \cmd{blx@delimcontext} which can be set manually by the command \cmd{delimcontext}
\cmditem{delimcontext}{context}
Set the delimiter context to \prm{context}. This setting is not global so that delimiter contexts can be nested using the usual \latex group method.
\cmditem{DeclareDelimcontextAlias}{alias}{name}
The context-sensitive delimiter system creates delimiter contexts based on
the name of citation commands (<parencite>, <textcite> etc.) passed to
\cmd{DeclareCiteCommand}. In certain cases where there are nested
definitions of citation commands where \cmd{DeclareCiteCommand} calls
itself (see the definition of \cmd{textcite} in \sty{authoryear-icomp}
for example). The delimiter context is then usually incorrect and the
delimiter specifications do not work. For example, the definition of
\cmd{textcite} in fact defines and uses \cmd{cbx@textcite} and so the
context is automatically set to \opt{cbx@textcite} when printing the
citation. Delimiter definitions expecting to see the context \opt{textcite}
therefore do not work. Therefore this command is provided for style authors
which aliases the context \prm{alias} to the context \prm{name}. For
example:
\begin{ltxexample}[style=latex]
\DeclareDelimcontextAlias{cbx@textcite}{textcite}
\end{ltxexample}
%
This (which is a default setting), makes sure that when inside the
\cmd{cbx@textcite} citation command, the context is in fact \opt{textcite}
as expected.
\end{ltxsyntax}
%
\biblatex\ has several default contexts which are established automatically in various places:
\begin{description}
\item[none] At begin document
\item[bib] Inside a bibliography begun with \cmd{printbibliography} or inside a \cmd{usedriver}
\item[biblist] Inside a bibliography list begun with \cmd{printbiblist}
\item[<citecommand>] Inside a citation command \cmd{citecommand} defined with \cmd{DeclareCiteCommand}
\end{description}
For example, the defaults for \cmd{nametitledelim} are:
\begin{ltxexample}[style=latex]
\DeclareDelimFormat{nametitledelim}{\addcomma\space}
\DeclareDelimFormat[bib,biblist]{nametitledelim}{\labelnamepunct}
\DeclareDelimFormat[textcite]{nametitledelim}{\addspace}
\end{ltxexample}
%
This means that \cmd{nametitledelim} is defined globally as <\cmd{addcomma}\cmd{space}> as per the standard delimiter interface. However, in addition, the delimiter can be printed using \cmd{printdelim} which would print the same as \cmd{nametitledelim} apart from inside a \cmd{textcite}, in which it would print \cmd{addspace} which is more suitable for running text, and in a bibliography (list) in which it takes the value of \cmd{labelnamepunct} for compatibility reasons. If desired, a context can be forced with the optional argument to \cmd{printdelim}, so
\begin{ltxexample}[style=latex]
\printdelim[textcite]{nametitledelim}
\end{ltxexample}
%
Would print \cmd{addspace} regardless of the surrounding context of the \cmd{printdelim}. Contexts are just arbitrary strings and so you can establish them at any time, using \cmd{delimcontext}. If \cmd{printdelim} finds no special value for the delimiter \prm{name} in the current context, it simply prints \cmd{name}. This means that style authors can use \cmd{printdelim} and users expecting to be able to use \cmd{renewcommand} to redefine delimiters can do so with one caveat---such a definition won't change any context-specific delimiters which are defined:
\begin{ltxexample}[style=latex]
\DeclareDelimFormat{delima}{X}
\DeclareDelimFormat[textcite]{delima}{Y}
\renewcommand*{\delima}{Z}
\end{ltxexample}
%
Here, \cmd{delima} always prints <Z>. \verb+\printdelim{delima}+ in any context other than <textcite> also prints \cmd{delima} and hence <Z> but in a <textcite> context prints <Y>. See the \file{04-delimiters.tex} example file that comes with \biblatex\ for more information.
\subsubsection{Language-specific Commands}
\label{use:fmt:lng}
The commands in this section are language specific. When redefining them, you need to wrap the new definition in a \cmd{DeclareBibliographyExtras} command (in an \file{.lbx} file) or a \cmd{DefineBibliographyExtras} command (user documents), see \secref{use:lng} for details. Note that all commands starting with \cmd{mk\dots} take one or more arguments.
\begin{ltxsyntax}
\csitem{bibrangedash}
The language specific dash to be used for ranges of numbers. Defaults to \cmd{textendash}.
\csitem{bibrangessep}
The language specific separator to be used between multiple ranges. Defaults to a comma followed by a space.
\csitem{bibdatesep}
The language specific separator used between date components in terse date formats. Defaults to \cmd{hyphen}.
\csitem{bibdaterangesep}
The language specific separator to be used for date ranges. Defaults to \cmd{textendash} for all date formats apart from \opt{ymd} which defaults to a \cmd{slash}. The date format option \opt{iso} is hard-coded to \cmd{slash} since this is a standards compliant format.
\csitem{mkbibdatelong}
Takes the names of three field as arguments which correspond to three date components (in the order year\slash month\slash day) and uses their values to print the date in the language specific long date format.
\csitem{mkbibdateshort}
Similar to \cmd{mkbibdatelong} but using the language specific short date format.
\csitem{mkbibtimezone}
Modifies a timezone string passed in as the only argument. By default this changes <Z> to the value of \cmd{bibtimezone}.
\csitem{bibdateuncertain}
The language specific marker to be used after uncertain dates when the global option \opt{dateuncertain} is enabled. Defaults to a space followed by a question mark.
\csitem{bibdateeraprefix}
The language specific marker which is printed as a prefix to beginning BCE/BC dates in a date range when the option \opt{dateera} is set to <astronomical>. Defaults to \cmd{textminus}, if defined and \cmd{textendash} otherwise.
\csitem{bibdateeraendprefix}
The language specific marker which is printed as a prefix to end BCE/BC dates in a date range when the option \opt{dateera} is set to <astronomical>. Defaults to a thin space followed by \cmd{bibdateeraprefix} when \cmd{bibdaterangesep} is set to a dash and to \cmd{bibdateeraprefix} otherwise. This is a separate macro so that you may add extra space before a negative date marker which, for example follows a dash date range marker as this can look a little odd.
\csitem{bibtimesep}
The language specific marker which separates time components. Defaults to a colon.
\csitem{bibutctimezone}
The language specific string printed for the UTC timezone. Defaults to <Z>.
\csitem{bibtimezonesep}
The language specific marker which separates an optional time zone component from a time. Empty by default.
\csitem{bibtzminsep}
The language specific marker which separates hour and minute component of offset timezones. Defaults to a \cmd{bibtimesep}.
\csitem{bibdatetimesep}
The language specific separator printed between date and time components when printing time components along with date components (see the \opt{$<$datetype$>$dateusetime} option in \secref{use:opt:pre:gen}). Defaults to a space for non-\acr{ISO8601-2} output formats, and 'T' for \acr{ISO8601-2} output format.
\csitem{finalandcomma}
Prints the comma to be inserted before the final <and> in a list, if applicable in the respective language. Here is an example:
\begin{ltxexample}
Michel Goossens, Frank Mittelbach<<,>> and Alexander Samarin
\end{ltxexample}
%
\cmd{finalandcomma} is the comma before the word <and>. See also \cmd{multinamedelim}, \cmd{finalnamedelim}, \cmd{textcitedelim}, and \cmd{revsdnamedelim} in \secref{use:fmt:fmt}.
\csitem{finalandsemicolon}
Prints the semicolon to be inserted before the final <and> in a list of lists, if applicable in the respective language. Here is an example:
\begin{ltxexample}
Goossens, Mittelbach, and Samarin; Bertram and Wenworth<<;>> and Knuth
\end{ltxexample}
%
\cmd{finalandsemicolon} is the semicolon before the word <and>. See also \cmd{textcitedelim} in \secref{use:fmt:fmt}.
\cmditem{mkbibordinal}{integer}
This command, which takes an integer as its argument, prints an ordinal number.
\cmditem{mkbibmascord}{integer}
Similar to \cmd{mkbibordinal}, but prints a masculine ordinal, if applicable in the respective language.
\cmditem{mkbibfemord}{integer}
Similar to \cmd{mkbibordinal}, but prints a feminine ordinal, if applicable in the respective language.
\cmditem{mkbibneutord}{integer}
Similar to \cmd{mkbibordinal}, but prints a neuter ordinal, if applicable in the respective language.
\cmditem{mkbibordedition}{integer}
Similar to \cmd{mkbibordinal}, but intended for use with the term <edition>.
\cmditem{mkbibordseries}{integer}
Similar to \cmd{mkbibordinal}, but intended for use with the term <series>.
\end{ltxsyntax}
\subsubsection{Lengths and Counters}
\label{use:fmt:len}
The length registers and counters in this section may be changed in the document preamble with \cmd{setlength} and \cmd{setcounter}, respectively.
\begin{ltxsyntax}
\lenitem{bibhang}
The hanging indentation of the bibliography, if applicable. This length is initialized to \cmd{parindent} at load-time. If \cmd{parindent} is zero length for some reason, \cmd{bibhang} will default to \texttt{1em}.
\lenitem{biblabelsep}
The horizontal space between entries and their corresponding labels in the bibliography. This only applies to bibliography styles which print labels, such as the \texttt{numeric} and \texttt{alphabetic} styles. This length is initialized to twice the value of \cmd{labelsep} at load-time.
\lenitem{bibitemsep}
The vertical space between the individual entries in the bibliography. This length is initialized to \cmd{itemsep} at load-time. Note that \len{bibitemsep}, \len{bibnamesep}, and \len{bibinitsep} obey the rules for \cmd{addvspace}, that is, when vertical space introduced by any of these commands immediately follows on from space introduced by another of them, the resulting total space is equal to the largest of them.
\lenitem{bibnamesep}
Vertical space to be inserted between two entries in the bibliography whenever an entry starts with a name which is different from the initial name of the previous entry. The default value is zero. Setting this length to a positive value greater than \len{bibitemsep} will group the bibliography by author\slash editor name. Note that \len{bibitemsep}, \len{bibnamesep}, and \len{bibinitsep} obey the rules for \cmd{addvspace}, that is, when vertical space introduced by any of these commands immediately follows on from space introduced by another of them, the resulting total space is equal to the largest of them.
\lenitem{bibinitsep}
Vertical space to be inserted between two entries in the bibliography whenever an entry starts with a letter which is different from the initial letter of the previous entry. The default value is zero. Setting this length to a positive value greater than \len{bibitemsep} will group the bibliography alphabetically. Note that \len{bibitemsep}, \len{bibnamesep}, and \len{bibinitsep} obey the rules for \cmd{addvspace}, that is, when vertical space introduced by any of these commands immediately follows on from space introduced by another of them, the resulting total space is equal to the largest of them.
\lenitem{bibparsep}
The vertical space between paragraphs within an entry in the bibliography. The default value is zero.
\cntitem{abbrvpenalty}
This counter, which is used by the localisation modules, holds the penalty used in short or abbreviated localisation strings. For example, a linebreak in expressions such as «et al.» or «ed. by» is unfortunate, but should still be possible to prevent overfull boxes. This counter is initialized to \cmd{hyphenpenalty} at load-time. The idea is making \tex treat the whole expression as if it were a single, hyphenatable word as far as line"=breaking is concerned. If you dislike such linebreaks, use a higher value. If you do not mind them at all, set this counter to zero. If you want to suppress them unconditionally, set it to <infinite> (10\,000 or higher).\footnote{The default values assigned to \cnt{abbrvpenalty}, \cnt{lownamepenalty}, and \cnt{highnamepenalty} are deliberately very low to prevent overfull boxes. This implies that you will hardly notice any effect on line-breaking if the text is set justified. If you set these counters to 10\,000 to suppress the respective breakpoints, you will notice their effect but you may also be confronted with overfull boxes. Keep in mind that line-breaking in the bibliography is often more difficult than in the body text and that you can not resort to rephrasing a sentence. In some cases it may be preferable to set the entire bibliography \cmd{raggedright} to prevent suboptimal linebreaks. In this case, even the fairly low default penalties will make a visible difference.}
\cntitem{highnamepenalty}
This counter holds a penalty affecting line"=breaking in names. Please refer to \secref{use:cav:nam,use:fmt:fmt} for explanation. The counter is initialized to \cmd{hyphenpenalty} at load-time. Use a higher value if you dislike the respective linebreaks. If you do not mind them at all, set this counter to zero. If you prefer the traditional \bibtex behavior (no linebreaks at \cnt{highnamepenalty} breakpoints), set it to <infinite> (10\,000 or higher).
\cntitem{lownamepenalty}
Similar to \cnt{highnamepenalty}. Please refer to \secref{use:cav:nam,use:fmt:fmt} for explanation. The counter is initialized to half the \cmd{hyphenpenalty} at load-time. Use a higher value if you dislike the respective linebreaks. If you do not mind them at all, set this counter to zero.
\cntitem{biburlnumpenalty}
If this counter is set to a value greater than zero, \biblatex will permit linebreaks after numbers in all strings formatted with the \cmd{url} command from the \sty{url} package. This will affect \acr{url}s and \acr{doi}s in the bibliography. The breakpoints will be penalized by the value of this counter. If \acr{url}s and/or \acr{doi}s in the bibliography run into the margin, try setting this counter to a value greater than zero but less than 10000 (you normally want to use a high value like 9000). Setting the counter to zero disables this feature. This is the default setting.
\cntitem{biburlucpenalty}
Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all uppercase letters.
\cntitem{biburllcpenalty}
Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all lowercase letters.
\cntitem{biburlbigbreakpenalty}
The \sty{biblatex} version of \sty{url}'s \len{UrlBigBreakPenalty}. The default value is \texttt{100}.
\cntitem{biburlbreakpenalty}
The \sty{biblatex} version of \sty{url}'s \len{UrlBreakPenalty}. The default value is \texttt{200}.
\lenitem{biburlbigskip}
The \sty{biblatex} version of \len{Urlmuskip}. This length holds the additional (stretchable) space inserted around breakable characters in the \cmd{url} command from the \sty{url} package. The default value is \texttt{0mu plus 3mu}.
\lenitem{biburlnumskip}
The additional space inserted after numbers in strings formatted with the \cmd{url} command from the \sty{url} package. This will affect \acr{url}s and \acr{doi}s in the bibliography. If \acr{url}s and/or \acr{doi}s in the bibliography run into the margin, it may help to set this length to add some small stretchable space, for example \texttt{0mu plus 1mu}. The default setting is \texttt{0mu}. This value is only used if \cnt{biburlnumpenalty} is set to a value different from zero.
\lenitem{biburlucskip}
Similar to \cnt{biburlnumskip}, except that it will add space after all uppercase letters.
\lenitem{biburllcskip}
Similar to \cnt{biburlnumskip}, except that it will add space after all uppercase letters.
\end{ltxsyntax}
\subsubsection{All-purpose Commands}
\label{use:fmt:aux}
The commands in this section are all-purpose text commands which are generally available, not only in citations and the bibliography.
\begin{ltxsyntax}
\csitem{bibellipsis}
An ellipsis symbol with brackets: <[\dots\unkern]>.
\csitem{noligature}
Disables ligatures at this position and adds some space. Use this command to break up standard ligatures like <fi> and <fl>. It is similar to the \verb+"|+ shorthand provided by some language modules of the \sty{babel}/\sty{polyglossia} packages.
\csitem{hyphenate}
A conditional hyphen. In contrast to the standard \cmd{-} command, this one allows hyphenation in the rest of the word. It is similar to the \verb|"-| shorthand provided by some language modules of the \sty{babel}/\sty{polyglossia} packages.
\csitem{hyphen}
An explicit, breakable hyphen intended for compound words. In contrast to a literal <\texttt{-}>, this command allows hyphenation in the rest of the word. It is similar to the \verb|"=| shorthand provided by some language modules of the \sty{babel}/\sty{polyglossia} packages.
\csitem{nbhyphen}
An explicit, non-breakable hyphen intended for compound words. In contrast to a literal <\texttt{-}>, this command does not permit line breaks at the hyphen but still allows hyphenation in the rest of the word. It is similar to the \verb|"~| shorthand provided by some language modules of the \sty{babel}/\sty{polyglossia} packages.
\csitem{nohyphenation}
A generic switch which suppresses hyphenation locally. Its scope should normally be confined to a group. The command uses a language without hyphenation patterns to suppress hyphenation. The idea was taken from Peter Wilson's \sty{hyphenat} package. Note that this command should only be used for small portions of text and that its effects are negated if \sty{babel}/\sty{polyglossia} is used to switch the language while it is active.
\cmditem{textnohyphenation}{text}
Similar to \cmd{nohyphenation} but restricted to the \prm{text} argument.
\cmditem{mknumalph}{integer}
Takes an integer in the range 1--702 as its argument and converts it to a string as follows: 1=a, \textellipsis, 26=z, 27=aa, \textellipsis, 702=zz. This is intended for use in formatting directives for the \bibfield{extradate}, \bibfield{extraname} and \bibfield{extraalpha} fields.
\cmditem{mkbibacro}{text}
Generic command which typesets an acronym using the small caps variant of the current font, if available, and as-is otherwise. The acronym should be given in uppercase letters.
\cmditem{autocap}{character}
Automatically converts the \prm{character} to its uppercase form if \biblatex's punctuation tracker would capitalize a localisation string at the current location. This command is robust. It is useful for conditional capitalization of certain strings in an entry. Note that the \prm{character} argument is a single character given in lowercase. For example:
\begin{ltxexample}
\autocap{s}pecial issue
\end{ltxexample}
%
will yield <Special issue> or <special issue>, as appropriate. If the string to be capitalized starts with an inflected character given in Ascii notation, include the accent command in the \prm{character} argument as follows:
\begin{ltxexample}
\autocap{\'e}dition sp\'eciale
\end{ltxexample}
%
This will yield <Édition spéciale> or <édition spéciale>. If the string to be capitalized starts with a command which prints a character, such as \cmd{ae} or \cmd{oe}, simply put the command in the \prm{character} argument:
\begin{ltxexample}
\autocap{\oe}uvres
\end{ltxexample}
%
This will yield <Œuvres> or <œuvres>.
\end{ltxsyntax}
\subsection[Language notes]{Language-specific Notes}
\label{use:loc}
The facilities discussed in this section are specific to certain localisation modules.
\subsubsection{American}
\label{use:loc:us}
The American localisation module uses \cmd{uspunctuation} from \secref{aut:pct:cfg} to enable <American-style> punctuation. If this feature is enabled, all trailing commas and periods after \cmd{mkbibquote} will be moved inside the quotes. If you want to disable this feature, use \cmd{stdpunctuation} as follows:
\begin{ltxexample}
\DefineBibliographyExtras{american}{%
\stdpunctuation
}
\end{ltxexample}
%
By default, the <American punctuation> feature is enabled by the \texttt{american} localisation module only. The above code is only required if you want American localisation without American punctuation. Since standard punctuation is the package default, it would be redundant with any other language.
It is highly advisable to always specify \texttt{american}, \texttt{british}, \texttt{australian}, etc. rather than \texttt{english} when loading the \sty{babel}/\sty{polyglossia} packages to avoid any possible confusion. Older versions of the \sty{babel} package used to treat \opt{english} as an alias for \opt{british}; more recent ones treat it as an alias for \opt{american}. The \biblatex package essentially treats \texttt{english} as an alias for \opt{american}, except for the above feature which is only enabled if \texttt{american} is requested explicitly.
\subsubsection{Bulgarian}
\label{use:loc:bul}
Like the Greek localisation module, the Bulgarian module also requires \utf support. It will not work with any other encoding.
\subsubsection{Greek}
\label{use:loc:grk}
The Greek localisation module requires \utf support. It will not work with any other encoding. Generally speaking, the \biblatex package is compatible with the \sty{inputenc} package and with the Unicode engines \lualatex and \xelatex. The \sty{ucs} package will not work. Note that you may need to load additional packages which set up Greek fonts. As a rule of thumb, a setup which works for regular Greek documents should also work with \biblatex. However, there is one fundamental limitation. As of this writing, \biblatex has no support for switching scripts. Greek titles in the bibliography should work fine, but English and other titles in the bibliography may be rendered in Greek letters. If you need multi-script bibliographies, using a Unicode engine is the only sensible choice.
\subsubsection{Hungarian}
\label{use:loc:hun}
The Hungarian localisation module needs to redefine certain field formats to obtain the grammatically correct word order. This means that these field formats are overwritten whenever the Hungarian localisation is active, no matter whether they were defined in the preamble or by a custom style. So please be aware that using the Hungarian localisation module may cause the bibliography output to deviate from the format dictated by the loaded style and preamble definitions. Changes to this behaviour need to be made using \cmd{DefineBibliographyExtras}. In particular \cmd{mkpageprefix} is redefined to output the <page> or <pages> string as a suffix after the page number following Hungarian conventions, and all formats of fields involving pages, chapters and volumes were modified so that numbers are printed as ordinals. The Hungarian localisation module will print a warning to remind you of these changes whenever it is loaded in a document. The warning tells you how to silence it.
\subsubsection{Latvian}
\label{use:loc:lav}
The Latvian localisation module, like the Hungarian language module, needs to redefine certain field formats to obtain the grammatically correct word order. This means that these field formats are overwritten whenever the Latvian localisation is active, no matter whether they were defined in the preamble or by a custom style. So please be aware that using the Latvian localisation module may cause the bibliography output to deviate from the format dictated by the loaded style and preamble definitions. Changes to this behaviour need to be made using \cmd{DefineBibliographyExtras}. In particular \cmd{mkpageprefix} is redefined to output the <page> or <pages> string as a suffix after the page number following Latvian conventions, and all formats of fields involving pages, chapters and volumes were modified so that numbers are printed as ordinals. The Latvian localisation module will print a warning to remind you of these changes whenever it is loaded in a document. The warning tells you how to silence it.
\subsubsection{Lithuanian}
\label{use:loc:lit}
The Lithuanian localisation module needs \utf support and will only work with this encoding.
\subsubsection{Russian}
\label{use:loc:rus}
Like the Greek and Lithuanian localisation module, the Russian module also requires \utf support. It will not work with any other encoding.
\subsubsection{Spanish}
\label{use:loc:esp}
Handling the word <and> is more difficult in Spanish than in the other languages supported by this package because it may be <y> or <e>, depending on the initial sound of the following word. Therefore, the Spanish localisation module does not use the localisation string <\texttt{and}> but a special internal <smart and> command. The behavior of this command is controlled by the \cnt{smartand} counter.
\begin{ltxsyntax}
\cntitem{smartand}
This counter controls the behavior of the internal <smart and> command. When set to 1, it prints <y> or <e>, depending on the context. When set to 2, it always prints <y>. When set to 3, it always prints <e>. When set to 0, the <smart and> feature is disabled. This counter is initialized to 1 at load-time and may be changed in the preamble. Note that setting this counter to a positive value implies that the Spanish localisation module ignores \cmd{finalnamedelim} and \cmd{finallistdelim}.
\csitem{forceE}
Use this command in \file{bib} files if \biblatex gets the <and> before a certain name wrong. As its name suggests, it will enforce <e>. This command must be used in a special way to be correct \bibtex datafile format. Here is an example:
\begin{lstlisting}[style=bibtex]{}
author = {Edward Jones and Eoin Maguire},
author = {Edward Jones and <<{\forceE{E}}>>oin Maguire},
\end{lstlisting}
%
Note that the initial letter of the respective name component is given as an argument to \cmd{forceE} and that the entire construct is wrapped in an additional pair of curly braces.
\csitem{forceY}
Similar to \cmd{forceE} but enforces <y>.
\end{ltxsyntax}
\subsubsection{Turkish}
\label{use:loc:tur}
By default \sty{babel}'s Turkish localisation module makes <\texttt{=}> a <shorthand>, which breaks the \keyval parser uses by \biblatex. This problem can be resolved by telling \sty{babel} not to make <\texttt{=}> a shorthand (for example by loading \sty{babel} with the option \texttt{shorthands=:!}) or by loading a \keyval package that can deal with active characters (\sty{kvsetkeys} and \sty{xkeyval})\fnurl{https://tex.stackexchange.com/a/160428/35864}.
\subsection{Usage Notes}
\label{use:use}
The following sections give a basic overview of the \biblatex package and discuss some typical usage scenarios.
\subsubsection{Overview}
\label{use:use:int}
Using the \biblatex package is slightly different from using traditional \bibtex styles and related packages. Before we get to specific usage scenarios, we will therefore have a look at the structure of a typical document first:
\begin{ltxexample}
\documentclass{...}
\usepackage[...]{biblatex}
<<\addbibresource>>{<<bibfile.bib>>}
\begin{document}
<<\cite>>{...}
...
<<\printbibliography>>
\end{document}
\end{ltxexample}
%
With traditional \bibtex, the \cmd{bibliography} command serves two purposes. It marks the location of the bibliography and it also specifies the \file{bib} file(s). The file extension is omitted. With \biblatex, resources are specified in the preamble with \cmd{addbibresource} using the full name with \file{.bib} suffix. The bibliography is printed using the \cmd{printbibliography} command which may be used multiple times (see \secref{use:bib} for details). The document body may contain any number of citation commands (\secref{use:cit}). Processing this example file requires that a certain procedure be followed. Suppose our example file is called \path{example.tex} and our bibliographic data is in \path{bibfile.bib}. The procedure, then, is as follows:
\begin{enumerate}
\item Run \bin{latex} on \path{example.tex}. If the file contains any citations, \biblatex will request the respective data from \biber by writing commands to the auxiliary file \path{example.bcf}.
\item Run \bin{biber} on \path{example.bcf}. \biber will retrieve the data from \path{bibfile.bib} and write it to the auxiliary file \path{example.bbl} in a format which can be processed by \biblatex.
\item Run \bin{latex} on \path{example.tex}. \biblatex will read the data from \path{example.bbl} and print all citations as well as the bibliography.
\end{enumerate}
\subsubsection{Auxiliary Files}
\label{use:use:aux}
The \biblatex package uses one auxiliary \file{bcf} file only. Even if there are citation commands in a file included via \cmd{include}, you only need to run \biber on the main \file{bcf} file. All information \biber needs is in the \file{bcf} file, including information about all refsections if using multiple \env{refsection} environments (see \secref{use:use:mlt}).
\subsubsection{Multiple Bibliographies}
\label{use:use:mlt}
In a collection of articles by different authors, such as a conference proceedings volume for example, it is very common to have one bibliography for each article rather than a global one for the entire book. In the example below, each article would be presented as a separate \cmd{chapter} with its own bibliography.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
\addbibresource{...}
\begin{document}
\chapter{...}
<<\begin{refsection}>>
...
<<\printbibliography[heading=subbibliography]>>
<<\end{refsection}>>
\chapter{...}
<<\begin{refsection}>>
...
<<\printbibliography[heading=subbibliography]>>
<<\end{refsection}>>
\end{document}
\end{ltxexample}
%
If \cmd{printbibliography} is used inside a \env{refsection} environment, it automatically restricts the scope of the list of references to the enclosing \env{refsection} environment. For a cumulative bibliography which is subdivided by chapter but printed at the end of the book, use the \opt{section} option of \cmd{printbibliography} to select a reference section, as shown in the next example.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
<<\defbibheading>>{<<subbibliography>>}{%
\section*{References for Chapter \ref{<<refsection:\therefsection>>}}}
\addbibresource{...}
\begin{document}
\chapter{...}
<<\begin{refsection}>>
...
<<\end{refsection}>>
\chapter{...}
<<\begin{refsection}>>
...
<<\end{refsection}>>
\printbibheading
<<\printbibliography>>[<<section=1>>,<<heading=subbibliography>>]
<<\printbibliography>>[<<section=2>>,<<heading=subbibliography>>]
\end{document}
\end{ltxexample}
%
Note the definition of the bibliography heading in the above example. This is the definition taking care of the subheadings in the bibliography. The main heading is generated with a plain \cmd{chapter} command in this case. The \biblatex package automatically sets a label at the beginning of every \env{refsection} environment, using the standard \cmd{label} command. The identifier used is the string \texttt{refsection:} followed by the number of the respective \env{refsection} environment. The number of the current section is accessible via the \cnt{refsection} counter. When using the \opt{section} option of \cmd{printbibliography}, this counter is also set locally. This means that you may use the counter in heading definitions to print subheadings like «References for Chapter 3», as shown above. You could also use the title of the respective chapter as a subheading by loading the \sty{nameref} package and using \cmd{nameref} instead of \cmd{ref}:
\begin{ltxexample}
\usepackage{<<nameref>>}
\defbibheading{subbibliography}{%
\section*{<<\nameref{refsection:\therefsection}>>}}
\end{ltxexample}
%
Since giving one \cmd{printbibliography} command for each part of a subdivided bibliography is tedious, \biblatex provides a shorthand. The \cmd{bibbysection} command automatically loops over all reference sections. This is equivalent to giving one \cmd{printbibliography} command for every section but has the additional benefit of automatically skipping sections without references. In the example above, the bibliography would then be generated as follows:
\begin{ltxexample}
\printbibheading
<<\bibbysection[heading=subbibliography]>>
\end{ltxexample}
%
When using a format with one cumulative bibliography subdivided by chapter (or any other document division) it may be more appropriate to use \env{refsegment} rather than \env{refsection} environments. The difference is that the \env{refsection} environment generates labels local to the environment while \env{refsegment} does not affect the generation of labels, hence they will be unique across the entire document. The next example could also be given in \secref{use:use:div} because, visually, it creates one global bibliography subdivided into multiple segments.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
<<\defbibheading>>{<<subbibliography>>}{%
\section*{References for Chapter \ref{<<refsegment:\therefsection\therefsegment>>}}}
\addbibresource{...}
\begin{document}
\chapter{...}
<<\begin{refsegment}>>
...
<<\end{refsegment}>>
\chapter{...}
<<\begin{refsegment}>>
...
<<\end{refsegment}>>
\printbibheading
<<\printbibliography>>[<<segment=1>>,<<heading=subbibliography>>]
<<\printbibliography>>[<<segment=2>>,<<heading=subbibliography>>]
\end{document}
\end{ltxexample}
%
The use of \env{refsegment} is similar to \env{refsection} and there is also a corresponding \opt{segment} option for \cmd{printbibliography}. The \biblatex package automatically sets a label at the beginning of every \env{refsegment} environment using the string \texttt{refsegment:} followed by the number of the respective \env{refsegment} environment as an identifier. There is a matching \cnt{refsegment} counter which may be used in heading definitions, as shown above. As with reference sections, there is also a shorthand command which automatically loops over all reference segments:
\begin{ltxexample}
\printbibheading
<<\bibbysegment[heading=subbibliography]>>
\end{ltxexample}
%
This is equivalent to giving one \cmd{printbibliography} command for every segment in the current \env{refsection}.
\subsubsection{Subdivided Bibliographies}
\label{use:use:div}
It is very common to subdivide a bibliography by certain criteria. For example, you may want to list printed and online resources separately or divide a bibliography into primary and secondary sources. The former case is straightforward because you can use the entry type as a criterion for the \opt{type} and \opt{nottype} filters of \cmd{printbibliography}. The next example also demonstrates how to generate matching subheadings for the two parts of the bibliography.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
\addbibresource{...}
\begin{document}
...
\printbibheading
\printbibliography[<<nottype=online>>,heading=subbibliography,
<<title={Printed Sources}>>]
\printbibliography[<<type=online>>,heading=subbibliography,
<<title={Online Sources}>>]
\end{document}
\end{ltxexample}
%
You may also use more than two subdivisions:
\begin{ltxexample}
\printbibliography[<<type=article>>,...]
\printbibliography[<<type=book>>,...]
\printbibliography[<<nottype=article>>,<<nottype=book>>,...]
\end{ltxexample}
%
It is even possible to give a chain of different types of filters:
\begin{ltxexample}
\printbibliography[<<section=2>>,<<type=book>>,<<keyword=abc>>,<<notkeyword=xyz>>]
\end{ltxexample}
%
This would print all works cited in reference section~2 whose entry type is \bibtype{book} and whose \bibfield{keywords} field includes the keyword <abc> but not <xyz>. When using bibliography filters in conjunction with a numeric style, see \secref{use:cav:lab}. If you need complex filters with conditional expressions, use the \opt{filter} option in conjunction with a custom filter defined with \cmd{defbibfilter}. See \secref{use:bib:flt} for details on custom filters.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
\addbibresource{...}
\begin{document}
...
\printbibheading
\printbibliography[<<keyword=primary>>,heading=subbibliography,%
<<title={Primary Sources}>>]
\printbibliography[<<keyword=secondary>>,heading=subbibliography,%
<<title={Secondary Sources}>>]
\end{document}
\end{ltxexample}
%
Dividing a bibliography into primary and secondary sources is possible with a \bibfield{keyword} filter, as shown in the above example. In this case, with only two subdivisions, it would be sufficient to use one keyword as filter criterion:
\begin{ltxexample}
\printbibliography[<<keyword=primary>>,...]
\printbibliography[<<notkeyword=primary>>,...]
\end{ltxexample}
%
Since \biblatex has no way of knowing if an item in the bibliography is considered to be primary or secondary literature, we need to supply the bibliography filter with the required data by adding a \bibfield{keywords} field to each entry in the \file{bib} file. These keywords may then be used as targets for the \opt{keyword} and \opt{notkeyword} filters, as shown above. It may be a good idea to add such keywords right away while building a \file{bib} file.
\begin{lstlisting}[style=bibtex]{}
@Book{key,
<<keywords>> = {<<primary>>,some,other,keywords},
...
\end{lstlisting}
%
An alternative way of subdividing the list of references are bibliography categories. They differ from the keywords"=based approach shown in the example above in that they work on the document level and do not require any changes to the \file{bib} file.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
<<\DeclareBibliographyCategory>>{<<primary>>}
<<\DeclareBibliographyCategory>>{<<secondary>>}
<<\addtocategory>>{<<primary>>}{key1,key3,key6}
<<\addtocategory>>{<<secondary>>}{key2,key4,key5}
\addbibresource{...}
\begin{document}
...
\printbibheading
\printbibliography[<<category=primary>>,heading=subbibliography,%
<<title={Primary Sources}>>]
\printbibliography[<<category=secondary>>,heading=subbibliography,%
<<title={Secondary Sources}>>]
\end{document}
\end{ltxexample}
%
In this case it would also be sufficient to use one category only:
\begin{ltxexample}
\printbibliography[<<category=primary>>,...]
\printbibliography[<<notcategory=primary>>,...]
\end{ltxexample}
%
It is still a good idea to declare all categories used in the bibliography explicitly because there is a \cmd{bibbycategory} command which automatically loops over all categories. This is equivalent to giving one \cmd{printbibliography} command for every category, in the order in which they were declared.
\begin{ltxexample}
\documentclass{...}
\usepackage{biblatex}
<<\DeclareBibliographyCategory>>{<<primary>>}
<<\DeclareBibliographyCategory>>{<<secondary>>}
\addtocategory{primary}{key1,key3,key6}
\addtocategory{secondary}{key2,key4,key5}
<<\defbibheading>>{<<primary>>}{\section*{Primary Sources}}
<<\defbibheading>>{<<secondary>>}{\section*{Secondary Sources}}
\addbibresource{...}
\begin{document}
...
\printbibheading
<<\bibbycategory>>
\end{document}
\end{ltxexample}
%
The handling of the headings is different from \cmd{bibbysection} and \cmd{bibbysegment} in this case. \cmd{bibbycategory} uses the name of the current category as a heading name. This is equivalent to passing \texttt{heading=\prm{category}} to \cmd{printbibliography} and implies that you need to provide a matching heading for every category.
\subsubsection{Entry Sets}
\label{use:use:set}
An entry set is a group of entries which are cited as a single reference and listed as a single item in the bibliography. The individual entries in the set are separated by \cmd{entrysetpunct} (\secref{aut:fmt:fmt}). The \biblatex package supports two types of entry sets. Static entry sets are defined in the \file{bib} file like any other entry. Dynamic entry sets are defined with \cmd{defbibentryset} (\secref{use:bib:set}) on a per-document\slash per-refsection basis in the document preamble or the document body. This section deals with the definition of entry sets; style authors should also see \secref{aut:cav:set} for further information. Please note that entry sets only make sense for styles which refer to entries by labels such as the provided \texttt{numeric} and \texttt{alphabetic} styles. Styles which refer to entries via names, titles etc. (\texttt{authoryear}, \texttt{authortitle}, \texttt{verbose} etc.) rarely employ sets and do not support them by default when they are cited directly. Custom styles may of course choose to implement some manner of set citation support in any manner they choose.
\paragraph{Static entry sets}
Static entry sets are defined in the \file{bib} file like any other entry. Defining an entry set is as simple as adding an entry of type \bibtype{set}. The entry has an \bibfield{entryset} field defining the members of the set as a separated list of entry keys:
\begin{lstlisting}[style=bibtex]{}
<<@Set>>{<<set1>>,
<<entryset>> = {<<key1,key2,key3>>},
}
\end{lstlisting}
%
Entries may be part of a set in one document\slash refsection and stand-alone references in another one, depending on the presence of the \bibtype{set} entry. If the \bibtype{set} entry is cited, the set members are grouped automatically. If not, they will work like any regular entry. Note that with \bibtex as the backend, there must also be an \bibfield{entryset} field in the set members which point to the set parent. With \biber, this is not necessary.
\paragraph[Dynamic entry sets]{Dynamic entry sets}
Dynamic entry sets are set up and work much like static ones. The main difference is that they are defined in the document preamble or on the fly in the document body using the \cmd{defbibentryset} command from \secref{use:bib:set}:
\begin{lstlisting}[style=bibtex]{}
\defbibentryset{set1}{key1,key2,key3}
\end{lstlisting}
%
Dynamic entry sets in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0.
\subsubsection[Data Containers]{Data Containers}
\label{use:use:xdat}
The \bibtype{xdata} entry type serves as a data container holding one or more fields. Data in \bibtype{xdata} entries may be referenced and used by other entries. \bibtype{xdata} entries may not be cited or added to the bibliography, they only serve as a data source for other entries (including other \bibtype{xdata} entries). This data inheritance mechanism is useful for fixed field combinations such as \bibfield{publisher}\slash \bibfield{location} and for other frequently used data:
\begin{lstlisting}[style=bibtex]{}
<<@XData>>{<<hup>>,
publisher = {Harvard University Press},
location = {Cambridge, Mass.},
}
@Book{...,
author = {...},
title = {...},
date = {...},
<<xdata>> = {<<hup>>},
}
\end{lstlisting}
%
Using a separated list of keys in its \bibfield{xdata} field, an entry may inherit data from several \bibtype{xdata} entries. Cascading \bibtype{xdata} entries are supported as well, \ie an \bibtype{xdata} entry may reference one or more other \bibtype{xdata} entries:
\begin{lstlisting}[style=bibtex]{}
@XData{macmillan:name,
publisher = {Macmillan},
}
@XData{macmillan:place,
location = {New York and London},
}
@XData{macmillan,
xdata = {macmillan:name,macmillan:place},
}
@Book{...,
author = {...},
title = {...},
date = {...},
xdata = {macmillan},
}
\end{lstlisting}
%
More granular \bibtype{xdata} entry data may be referenced. It is not necessary to reference only entire fields. For example:
\begin{lstlisting}[style=bibtex]{}
@XData{someauthors,
author = {John Smith and Brian Brown}
}
@XData{somelocations,
location = {Location1 and Location2}
}
@XData{somenotes,
note = {A note}
}
@Book{...,
author = {Alan Drudge and xdata=someauthors-author-2},
editor = {xdata=someauthors-author},
location = {xdata=somelocations-location-1 and Location3},
note = {xdata=somenotes-note}
}
\end{lstlisting}
%
The format of granular \bibtype{xdata} references are as follows:
\begin{namesample}
\item~\delim{x}{1}data\delim{=}{2}\delim{$<$}{3}key$>$\delim{-}{4}\delim{$<$}{5}field$>$\delim{-}{6}\delim{$<$}{7}index$>$
\end{namesample}
\begin{enumerate}
\item The value of the \biber option \opt{--xdatamarker} (by default '\texttt{xdata}')
\item The value of the \biber option \opt{--xnamesep} (by default '\texttt{=}')
\item A valid entry key of an \bibtype{xdata} entry
\item The value of the \biber option \opt{--xdatasep} (by default '\texttt{-}')
\item A valid entry field in the source \bibtype {xdata} entry
\item (Optional) The value of the \biber option \opt{--xdatasep} (by default '\texttt{-}')
\item (Optional) A valid 1-based index into a list/name field in the source \bibtype {xdata} entry
\end{enumerate}
%
There are \opt{--output-*} variants of the above options for \biber tool mode output so that these separators and markers can be programatically changed. Taking the example above, this \bibtype{book} would resolve to:
\begin{lstlisting}[style=bibtex]{}
@Book{...,
author = {Alan Drudge and Brian Brown},
editor = {John Smith},
location = {Location1 and Location3},
note = {A note}
}
\end{lstlisting}
%
Things to note with granular \bibtype{xdata} references:
\begin{itemize}
\item References must be made only to \bibtype{xdata} fields. An warning will be generated otherwise and the reference will not be resolved
\item References must be made only to \bibtype{xdata} fields of the same type (list/name and datatype) as the referencing field. An warning will be generated otherwise and the reference will not be resolved
\item References to fields of datatype 'date' are not possible. References to legacy \bibfield{year} and \bibfield{month} fields are possible
\item References to missing entries, fields or list/name indices will generate a warning and the reference will not be resolved
\item If an index is missing for a reference to a list/name field, 1 is assumed
\end{itemize}
%
See also \secref{bib:typ:blx,bib:fld:spc}.
\subsubsection{Electronic Publishing Information}
\label{use:use:epr}
The \biblatex package provides three fields for electronic publishing information: \bibfield{eprint}, \bibfield{eprinttype}, and \bibfield{eprintclass}. The \bibfield{eprint} field is a verbatim field similar to \bibfield{doi} which holds the identifier of the item. The \bibfield{eprinttype} field holds the resource name, \ie the name of the site or electronic archive. The optional \bibfield{eprintclass} field is intended for additional information specific to the resource indicated by the \bibfield{eprinttype} field. This could be a section, a path, classification information, etc. If the \bibfield{eprinttype} field is available, the standard styles will use it as a literal label. In the following example, they would print «Resource: identifier» rather than the generic «eprint: identifier»:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<identifier>>},
<<eprinttype>> = {<<Resource>>},
\end{lstlisting}
%
The standard styles feature dedicated support for a few online archives. For arXiv references, put the identifier in the \bibfield{eprint} field and the string \texttt{arxiv} in the \bibfield{eprinttype} field:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<math/0307200v3>>},
<<eprinttype>> = {<<arxiv>>},
\end{lstlisting}
%
For papers which use the new identifier scheme (April 2007 and later) add the primary classification in the \bibfield{eprintclass} field:
\begin{lstlisting}[style=bibtex]{}
eprint = {1008.2849v1},
eprinttype = {arxiv},
<<eprintclass>> = {<<cs.DS>>},
\end{lstlisting}
%
There are two aliases which ease the integration of arXiv entries. \bibfield{archiveprefix} is treated as an alias for \bibfield{eprinttype}; \bibfield{primaryclass} is an alias for \bibfield{eprintclass}. If hyperlinks are enabled, the eprint identifier will be transformed into a link to \nolinkurl{arxiv.org}. See the package option \opt{arxiv} in \secref{use:opt:pre:gen} for further details.
For \acr{JSTOR} references, put the stable \acr{JSTOR} number in the \bibfield{eprint} field and the string \texttt{jstor} in the \bibfield{eprinttype} field:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<number>>},
<<eprinttype>> = {<<jstor>>},
\end{lstlisting}
%
When using \acr{JSTOR}'s export feature to export citations in \bibtex format, \acr{JSTOR} uses the \bibfield{url} field by default (where the \prm{number} is a unique and stable identifier):
\begin{lstlisting}[style=bibtex]{}
url = {http://www.jstor.org/stable/<<number>>},
\end{lstlisting}
%
While this will work as expected, full \acr{URL}s tend to clutter the bibliography. With the \bibfield{eprint} fields, the standard styles will use the more readable «\acr{JSTOR}: \prm{number}» format which also supports hyperlinks. The \prm{number} becomes a clickable link if \sty{hyperref} support is enabled.
For PubMed references, put the stable PubMed identifier in the \bibfield{eprint} field and the string \texttt{pubmed} in the \bibfield{eprinttype} field. This means that:
\begin{lstlisting}[style=bibtex]{}
url = {http://www.ncbi.nlm.nih.gov/pubmed/<<pmid>>},
\end{lstlisting}
%
becomes:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<pmid>>},
<<eprinttype>> = {<<pubmed>>},
\end{lstlisting}
%
and the standard styles will print «\acr{PMID}: \prm{pmid}» instead of the lengthy \acr{URL}. If hyperref support is enabled, the \prm{pmid} will be a clickable link to PubMed.
For handles (\acr{HDL}s), put the handle in the \bibfield{eprint} field and the string \texttt{hdl} in the \bibfield{eprinttype} field:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<handle>>},
<<eprinttype>> = {<<hdl>>},
\end{lstlisting}
%
For Google Books references, put Google's identifier in the \bibfield{eprint} field and the string \texttt{googlebooks} in the \bibfield{eprinttype} field. This means that, for example:
\begin{lstlisting}[style=bibtex]{}
url = {http://books.google.com/books?id=<<XXu4AkRVBBoC>>},
\end{lstlisting}
%
would become:
\begin{lstlisting}[style=bibtex]{}
<<eprint>> = {<<XXu4AkRVBBoC>>},
<<eprinttype>> = {<<googlebooks>>},
\end{lstlisting}
%
and the standard styles would print «Google Books: |XXu4AkRVBBoC|» instead of the full \acr{URL}. If hyperref support is enabled, the identifier will be a clickable link to Google Books.\footnote{Note that the Google Books \acr{id} seems to be a bit of an <internal> value. As of this writing, there does not seem to be any way to search for an \acr{id} on Google Books. You may prefer to use the \bibfield{url} in this case.}
Note that \bibfield{eprint} is a verbatim field. Always give the identifier in its unmodified form. For example, there is no need to replace |_| with |\_|. Also see \secref{aut:cav:epr} on how to add dedicated support for other eprint resources.
\subsubsection{External Abstracts and Annotations}
\label{use:use:prf}
Styles which print the fields \bibfield{abstract} and\slash or \bibfield{annotation} may support an alternative way of adding abstracts or annotations to the bibliography. Instead of including the text in the \file{bib} file, it may also be stored in an external \latex file. For example, instead of saying
\begin{ltxexample}[style=bibtex]
@Article{key1,
...
abstract = {This is an abstract of entry `key1'.}
}
\end{ltxexample}
%
in the \file{bib} file, you may create a file named \path{bibabstract-key1.tex} and put the abstract in this file:
\begin{ltxexample}
This is an abstract of entry `key1'.
\endinput
\end{ltxexample}
%
The name of the external file must be the entry key prefixed with \texttt{bibabstract-} or \texttt{bibannotation-}, respectively. You can change these prefixes by redefining \cmd{bibabstractprefix} and \cmd{bibannotationprefix}. Note that this feature needs to be enabled explicitly by setting the package option \opt{loadfiles} from \secref{use:opt:pre:gen}. The option is disabled by default for performance reasons. Also note that any \bibfield{abstract} and \bibfield{annotation} fields in the \file{bib} file take precedence over the external files. Using external files is strongly recommended if you have long abstracts or a lot of annotations since this may increase memory requirements significantly. It is also more convenient to edit the text in a dedicated \latex file. Style authors should see \secref{aut:cav:prf} for further information.
\subsection{Hints and Caveats}
\label{use:cav}
This section provides additional usage hints and addresses some common problems and potential misconceptions.
\subsubsection{Usage with \acr{KOMA}-Script Classes}
\label{use:cav:scr}
When used in conjunction with a recent version\footnote{At least \acr{KOMA}-Script 3.25 (2018/03/30).} one of the \sty{scrbook}, \sty{scrreprt}, or \sty{scrartcl} classes, \biblatex passes control over the (default) headings \texttt{bibliography} and \texttt{biblist} from \secref{use:bib:hdg} to the class. Hence, bibliography-heading-related class options can be used as usual. You can override the default headings by using the \opt{heading} option of \cmd{printbibliography}, \cmd{printbibheading} and \cmd{printbiblist}. See \secref{use:bib:bib, use:bib:biblist, use:bib:hdg} for details.
\biblatex also tries to detect bibliography-related class options and settings itself.\footnote{This applies to the traditional syntax of these options (\opt{bibtotoc} and \opt{bibtotocnumbered}) as well as to the \keyval syntax introduced in \acr{KOMA}-Script 3.x, \ie to \kvopt{bibliography}{nottotoc}, \kvopt{bibliography}{totoc}, and \kvopt{bibliography}{totocnumbered}. The global \kvopt{toc}{bibliography} and \kvopt{toc}{bibliographynumbered} options as well as their aliases are detected as well. In any case, the options must be set globally in the optional argument to \cmd{documentclass}.} This was required to be able to adapt the bibliography headings to the class settings in older versions of \acr{KOMA}-Script. If one of the above classes is detected, \biblatex will provide the following additional tests which may be useful in custom heading definitions. Since these tests rely on the error-prone external detection of \acr{KOMA}-Script settings and are no longer used with newer \acr{KOMA}-Script versions, these tests are deprecated and should no longer be used.
\begin{ltxsyntax}
\cmditem{ifkomabibtotoc}{true}{false}\DeprecatedMark
Expands to \prm{true} if the class would add the bibliography to the table of contents, and to \prm{false} otherwise. This test is deprecated.
\cmditem{ifkomabibtotocnumbered}{true}{false}\DeprecatedMark
Expands to \prm{true} if the class would add the bibliography to the table of contents as a numbered section, and to \prm{false} otherwise. If this test yields \prm{true}, \cmd{ifkomabibtotoc} will always yield \prm{true} as well, but not vice versa. This test is deprecated.
\end{ltxsyntax}
\subsubsection{Usage with the Memoir Class}
\label{use:cav:mem}
When using \biblatex with the \sty{memoir} class, most class facilities for adapting the bibliography have no effect. Use the corresponding facilities of this package instead (\secref{use:bib:bib, use:bib:hdg, use:bib:nts}). Instead of redefining \sty{memoir}'s \cmd{bibsection}, use the \opt{heading} option of \cmd{printbibliography} and \cmd{defbibheading} (\secref{use:bib:bib, use:bib:hdg}). Instead of \cmd{prebibhook} and \cmd{postbibhook}, use the \opt{prenote} and \opt{postnote} options of \cmd{printbibliography} and \cmd{defbibnote} (\secref{use:bib:bib, use:bib:nts}). All default headings are adapted at load-time such that they blend well with the default layout of this class. The default headings \texttt{bibliography} and \texttt{biblist} (\secref{use:bib:hdg}) are also responsive to \sty{memoir}'s \cmd{bibintoc} and \cmd{nobibintoc} switches. The length register \len{bibitemsep} is used by \biblatex in a way similar to \sty{memoir} (\secref{use:fmt:len}). This section also introduces some additional length registers which correspond to \sty{memoir}'s \cmd{biblistextra}. Lastly, \cmd{setbiblabel} does not map to a single facility of the \biblatex package since the style of all labels in the bibliography is controlled by the bibliography style. See \secref{aut:bbx:env} in the author section of this manual for details. If the \sty{memoir} class is detected, \biblatex will also provide the following additional test which may be useful in custom heading definitions:
\begin{ltxsyntax}
\cmditem{ifmemoirbibintoc}{true}{false}
Expands to \prm{true} or \prm{false}, depending on \sty{memoir}'s \cmd{bibintoc} and \cmd{nobibintoc} switches. This is a \latex frontend to \sty{memoir}'s \cmd{ifnobibintoc} test. Note that the logic of the test is reversed.
\end{ltxsyntax}
\subsubsection{Page Numbers in Citations}
\label{use:cav:pag}
If the \prm{postnote} argument to a citation command is a page number or page range, \biblatex will automatically prefix it with <p.> or <pp.> by default. This works reliably in typical cases, but sometimes manual intervention may be required. In this case, it is important to understand how this argument is handled in detail. First, \biblatex checks if the postnote is an Arabic or Roman numeral (case insensitive). If this test succeeds, the postnote is considered as a single page or other number which will be prefixed with <p.> or some other string which depends on the \sty{pagination} field (see \secref{bib:use:pag}). If it fails, a second test is performed to find out if the postnote is a range or a list of Arabic or Roman numerals. If this test succeeds, the postnote will be prefixed with <pp.> or some other string in the plural form. If it fails as well, the postnote is printed as is. Note that both tests expand the \prm{postnote}. All commands used in this argument must therefore be robust or prefixed with \cmd{protect}. Here are a few examples of \prm{postnote} arguments which will be correctly recognized as a single number, a range of numbers, or a list of numbers, respectively:
\begin{ltxexample}
\cite[25]{key}
\cite[vii]{key}
\cite[XIV]{key}
\cite[34--38]{key}
\cite[iv--x]{key}
\cite[185/86]{key}
\cite[XI \& XV]{key}
\cite[3, 5, 7]{key}
\cite[vii--x; 5, 7]{key}
\end{ltxexample}
%
In some other cases, however, the tests may get it wrong and you need to resort to the auxiliary commands \cmd{pnfmt}, \cmd{pno}, \cmd{ppno}, and \cmd{nopp} from \secref{use:cit:msc}. For example, suppose a work is cited by a special pagination scheme consisting of numbers and letters. In this scheme, the string <|27a|> would mean <page~27, part~a>. Since this string does not look like a number or a range to \biblatex, you need to force the prefix for a single number manually:
\begin{ltxexample}
\cite[\pno~27a]{key}
\end{ltxexample}
%
There is also a \cmd{ppno} command which forces a range prefix as well as a \cmd{nopp} command which suppresses all prefixes:
\begin{ltxexample}
\cite[\ppno~27a--28c]{key}
\cite[\nopp 25]{key}
\end{ltxexample}
%
These commands may be used anywhere in the \prm{postnote} argument. They may also be used multiple times. For example, when citing by volume and page number, you may want to suppress the prefix at the beginning of the postnote and add it in the middle of the string:
\begin{ltxexample}
\cite[VII, \pno~5]{key}
\cite[VII, \pno~3, \ppno~40--45]{key}
\cite[see][\ppno~37--46, in particular \pno~40]{key}
\end{ltxexample}
%
The command \cmd{pnfmt} can be used for \prm{postnote}s consisting of a page range and some additional text. \cmd{pnfmt} prints its argument in the format specified for the postnote and can be used to format the page range automatically without the need for \cmd{pno} and \cmd{ppno}.
\begin{ltxexample}
\cite[\pnfmt{37-46}, in particular \pnfmt{40}]{key}
\end{ltxexample}
%
There are also two auxiliary command for suffixes like <the following page(s)>. Instead of inserting such suffixes literally (which would require \cmd{ppno} to force a prefix):
\begin{ltxexample}
\cite[\ppno~27~sq.]{key}
\cite[\ppno~55~sqq.]{key}
\end{ltxexample}
%
use the auxiliary commands \cmd{psq} and \cmd{psqq}. Note that there is no space between the number and the command. This space will be inserted automatically and may be modified by redefining the macro \cmd{sqspace}.
\begin{ltxexample}
\cite[27\psq]{key}
\cite[55\psqq]{key}
\end{ltxexample}
%
Since the postnote is printed without any prefix if it includes any character which is not an Arabic or Roman numeral, you may also type the prefix manually---though this is discouraged:
\begin{ltxexample}
\cite[p.~5]{key}
\end{ltxexample}
%
It is possible to suppress the prefix on a per"=entry basis by setting the \bibfield{pagination} field of an entry to <\texttt{none}>, see \secref{bib:use:pag} for details. If you do not want any prefixes at all or prefer to type them manually, you can also disable the entire mechanism in the document preamble or the configuration file as follows:
\begin{ltxexample}
\DeclareFieldFormat{postnote}{#1}
\end{ltxexample}
%
The \prm{postnote} argument is handled as a field and the formatting of this field is controlled by a field formatting directive which may be freely redefined. The above definition will simply print the postnote as is. See \secref{aut:cbx:fld, aut:bib:fmt} in the author guide for further details.
\subsubsection{Name Parts and Name Spacing}
\label{use:cav:nam}
The \biblatex package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names. The commands discussed in the following are documented in \secref{use:fmt:fmt,aut:fmt:fmt}. This section is meant to give an overview of how they are put together. A note on terminology: a name \emph{part} is a basic part of the name, for example the given or the family name. Each part of a name may be a single name or it may be composed of multiple names. For example, the name part \enquote*{given name} may be composed of a given and a middle name. The latter are referred to as name \emph{elements} in this section. Let's consider a simple name first: \enquote{John Edward Doe}. This name is composed of the following parts:
\begin{nameparts}
Given & John Edward \\
Prefix & --- \\
Family & Doe \\
Suffix & --- \\
\end{nameparts}
%
The spacing, punctuation and line"=breaking behavior of names is controlled by six macros:
\begin{namedelims}
a & \cmd{bibnamedelima} & Inserted by the backend after the first element of every name part if that element is less than three characters long and before the last element of every name part. \\
b & \cmd{bibnamedelimb} & Inserted by the backend between all elements of a name part where \cmd{bibnamedelima} does not apply. \\
c & \cmd{bibnamedelimc} & Inserted by a formatting directive between the name prefix and the family name if \kvopt{useprefix}{true}. If \kvopt{useprefix}{false}, \cmd{bibnamedelimd} is used instead. \\
d & \cmd{bibnamedelimd} & Inserted by a formatting directive between name parts where \cmd{bibnamedelimc} does not apply. \\
i & \cmd{bibnamedelimi} & Replaces \cmd{bibnamedelima/b} after initials \\
p & \cmd{revsdnamepunct} & Inserted by a formatting directive after the family name when the name parts are reversed.
\end{namedelims}
%
This is how the delimiters are employed:
\begin{namesample}
\item John\delim{~}{a}Edward\delim{ }{d}Doe
\item Doe\delim{,}{p}\delim{ }{d}John\delim{~}{a}Edward
\end{namesample}
%
Initials in the \file{bib} file get a special delimiter:
\begin{namesample}
\item J.\delim{~}{i}Edward\delim{ }{d}Doe
\end{namesample}
%
Let's consider a more complex name: \enquote{Charles-Jean Étienne Gustave Nicolas de La Vallée Poussin}. This name is composed of the following parts:
\begin{nameparts}
Given & Charles-Jean Étienne Gustave Nicolas \\
Prefix & de \\
Family & La Vallée Poussin \\
Suffix & --- \\
\end{nameparts}
%
The delimiters:
\begin{namesample}
\item Charles-Jean\delim{~}{b}Étienne\delim{~}{b}Gustave\delim{~}{a}Nicolas\delim{ }{d}%
de\delim{ }{c}%
La\delim{~}{a}Vallée\delim{~}{a}Poussin
\end{namesample}
%
Note that \cmd{bibnamedelima/b/i} are inserted by the backend. The backend processes the name parts and takes care of the delimiters between the elements that make up a name part, processing each part individually. In contrast to that, the delimiters between the parts of the complete name (\cmd{bibnamedelimc/d}) are added by name formatting directives at a later point in the processing chain. The spacing and punctuation of initials is also handled by the backend and may be customized by redefining the following three macros:
\begin{namedelims}
a & \cmd{bibinitperiod} & Inserted by the backend after initials.\\
b & \cmd{bibinitdelim} & Inserted by the backend between multiple initials.\\
c & \cmd{bibinithyphendelim} & Inserted by the backend between the initials of hyphenated name parts, replacing \cmd{bibinitperiod} and \cmd{bibinitdelim}.\\
\end{namedelims}
%
This is how they are employed:
\begin{namesample}
\item J\delim{.}{a}\delim{~}{b}E\delim{.}{a} Doe
\item K\delim{.-}{c}H\delim{.}{a} Mustermann
\end{namesample}
\subsubsection{Split Bibliographies and Citation Labels}
\label{use:cav:lab}
The citation labels generated by this package are assigned to the full list of references before it is split up by any bibliography filters. They are guaranteed to be unique across the entire document (or a \env{refsection} environment), no matter how many bibliography filters you are using. When using a numeric citation scheme, however, this will most likely lead to discontinuous numbering in split bibliographies. Use the \opt{defernumbers} package option to avoid this problem. If this option is enabled, numeric labels are assigned the first time an entry is printed in any bibliography.
Compare the output of the following example with \texttt{defernumbers=true} and \texttt{defernumbers=false}.
%
\begin{ltxexample}
\documentclass{article}
\usepackage[defernumbers=true]{biblatex}
\addbibresource{biblatex-examples.bib}
\begin{document}
Lorem \autocite{worman} ipsum \autocite{sigfridsson}
dolor \autocite{nussbaum} sit \autocite{aksin}
\printbibheading[title={Bibliography}]
\printbibliography[heading=subbibliography,
type=book, title={Books}]
\printbibliography[heading=subbibliography,
type=article, title={Articles}]
\end{document}
\end{ltxexample}
There are pathological cases where neither \texttt{defernumbers=true} nor \texttt{defernumbers=false} produce fully desirable output. This may be the case when entries can end up in several of the split bibliographies---or if there is an additional global bibliography. But in most cases with non-overlapping split bibliographies \texttt{defernumbers=true} produces better results. \sty{biblatex} will therefore suggest setting \opt{defernumbers} to \opt{true} in a warning when a split bibliography setup is detected. That warning can be suppressed in case setting \opt{defernumbers} to \opt{true} is not desirable.
\subsubsection{Active Characters in Bibliography Headings}
\label{use:cav:act}
Packages using active characters, such as \sty{babel}, \sty{polyglossia}, \sty{csquotes}, or \sty{underscore}, usually do not make them active until the beginning of the document body to avoid interference with other packages. A typical example of such an active character is the Ascii quote |"|, which is used by various language modules of the \sty{babel}/\sty{polyglossia} packages. If shorthands such as |"<| and |"a| are used in the argument to \cmd{defbibheading} and the headings are defined in the document preamble, the non-active form of the characters is saved in the heading definition. When the heading is typeset, they do not function as a command but are simply printed literally. The most straightforward solution consists in moving \cmd{defbibheading} after |\begin{document}|. Alternatively, you may use \sty{babel}'s \cmd{shorthandon} and \cmd{shorthandoff} commands to temporarily make the shorthands active in the preamble. The above also applies to bibliography notes and the \cmd{defbibnote} command.
\subsubsection{Grouping in Reference Sections and Segments}
\label{use:cav:grp}
All \latex environments enclosed in \cmd{begin} and \cmd{end} form a group. This may have undesirable side effects if the environment contains anything that does not expect to be used within a group. This issue is not specific to \env{refsection} and \env{refsegment} environments, but it obviously applies to them as well. Since these environments will usually enclose much larger portions of the document than a typical \env{itemize} or similar environment, they are simply more likely to trigger problems related to grouping. If you observe any malfunctions after adding \env{refsection} environments to a document (for example, if anything seems to be <trapped> inside the environment), try the following syntax instead:
\begin{ltxexample}
\chapter{...}
<<\refsection>>
...
<<\endrefsection>>
\end{ltxexample}
%
This will not from a group, but otherwise works as usual. As far as \biblatex is concerned, it does not matter which syntax you use. The alternative syntax is also supported by the \env{refsegment} environment. Note that the commands \cmd{newrefsection} and \cmd{newrefsegment} do not form a group. See \secref{use:bib:sec, use:bib:seg} for details.
\subsection{Using the fallback \bibtex\ backend}
\label{use:bibtex}
To utilise all of the features described here, \biblatex must be used with the
\biber program as a backend. Indeed, the documentation in general assumes this. However, for a \emph{limited} subset of use cases it is possible to use the
long-established \bibtex program (either the 7-bit \texttt{bibtex} or
8-bit \texttt{bibtex8}) as the supporting backend. This works in much the
same way as for \biber with the only proviso being that \bibtex is much more
limited as a backend.
Using \bibtex as the backend requires that the option \opt{backend=bibtex}
or \opt{backend=bibtex8} is given at load time. The \biblatex package will
then write appropriate data for use by \bibtex into the auxiliary file(s)
and a special data file (automatically included in those to be read by
\bibtex). The \bibtex(8) program should then be run on each auxiliary file:
\biblatex will list all of the required files in the log.
Key limitations of the \bibtex backend are:
\begin{itemize}
\item Sorting is global and is limited to Ascii ordering
\item No re-encoding is possible and thus database entries must be in
LICR form to work reliably
\item The data model is fixed
\item Cross-referencing is more limited and entry sets must be written
into the \path{.bib} file
\item Fixed memory capacity (using the \verb|--wolfgang| option with
\verb|bibtex8| is strongly recommended to minimize the likelihood of
an issue here)
\end{itemize}
\section{Author Guide}
\label{aut}
This part of the manual documents the author interface of the \biblatex package. The author guide covers everything you need to know in order to write new citation and bibliography styles or localisation modules. You should read the user guide first before continuing with this part of the manual.
\subsection{Overview}
\label{aut:int}
Before we get to the commands and facilities provided by \biblatex, we will have a look at some of its fundamental concepts. The \biblatex package uses auxiliary files in a special way. Most notably, the \file{bbl} file is used differently and there is no concept of a style-dependent \file{bst} file. With \latex's standard bibliographic facilities, a document includes any number of citation commands in the document body plus \cmd{bibliographystyle} and \cmd{bibliography}, usually towards the end of the document. The location of the former is arbitrary, the latter marks the spot where the list of references is to be printed:
\begin{ltxexample}
\documentclass{...}
\begin{document}
\cite{...}
...
\bibliographystyle{...}
\bibliography{...}
\end{document}
\end{ltxexample}
%
Processing this files requires that a certain procedure be followed. This procedure is as follows:
\begin{enumerate}
\item Run \bin{latex}: On the first run, \cmd{bibstyle} and \cmd{bibdata} commands are written to the \file{aux} file, along with \cmd{citation} commands for all citations. At this point, the references are undefined because \latex is waiting for \bibtex to supply the required data. There is also no bibliography yet.
\item Run \bin{bibtex}: \bibtex writes a \env{thebibliography} environment to the \file{bbl} file, supplying all entries from the \file{bib} file which were requested by the \cmd{citation} commands in the \file{aux} file.
\item Run \bin{latex}: Starting with the second run, the \cmd{bibitem} commands in the \env{thebibliography} environment write one \cmd{bibcite} command for each bibliography entry to the \file{aux} file. These \cmd{bibcite} commands define the citation labels used by \cmd{cite}. However, the references are still undefined because the labels are not available until the end of this run.
\item Run \bin{latex}: Starting with the third run, the citation labels are defined as the \file{aux} file is read in at the end of the preamble. All citations can now be printed.
\end{enumerate}
Note that all bibliographic data is written to the \file{bbl} file in the final format. The \file{bbl} file is read in and processed like any printable section of the document. For example, consider the following entry in a \file{bib} file:
\begin{lstlisting}[style=bibtex]{}
@Book{companion,
author = {Michel Goossens and Frank Mittelbach and Alexander Samarin},
title = {The LaTeX Companion},
publisher = {Addison-Wesley},
address = {Reading, Mass.},
year = {1994},
}
\end{lstlisting}
%
With the \path{plain.bst} style, \bibtex exports this entry to the \file{bbl} file as follows:
\begin{ltxexample}
\bibitem{companion}
Michel Goossens, Frank Mittelbach, and Alexander Samarin.
\newblock {\em The LaTeX Companion}.
\newblock Addison-Wesley, Reading, Mass., 1994.
\end{ltxexample}
%
By default, \latex generates numeric citation labels, hence \cmd{bibitem} writes lines such as the following to the \file{aux} file:
\begin{ltxexample}
\bibcite{companion}{1}
\end{ltxexample}
%
Implementing a different citation style implies that more data has to be transferred via the \file{aux} file. With the \sty{natbib} package, for example, the \file{aux} file contains lines like this one:
\begin{ltxexample}
\bibcite{companion}{{1}{1994}{{Goossens et~al.}}{{Goossens, Mittelbach,
and Samarin}}}
\end{ltxexample}
%
The \biblatex package supports citations in any arbitrary format, hence citation commands need access to all bibliographic data. What this would mean within the scope of the procedure outlined above becomes obvious when looking at the output of the \sty{jurabib} package which also makes all bibliographic data available in citations:
\begin{ltxexample}
\bibcite{companion}{{Goossens\jbbfsasep Mittelbach\jbbstasep Samarin}%
{}{{0}{}{book}{1994}{}{}{}{}{Reading, Mass.\bpubaddr{}Addison-Wesley%
\bibbdsep{} 1994}}{{The LaTeX Companion}{}{}{2}{}{}{}{}{}}{\bibnf
{Goossens}{Michel}{M.}{}{}\Bibbfsasep\bibnf{Mittelbach}{Frank}{F.}%
{}{}\Bibbstasep\bibnf{Samarin}{Alexander}{A.}{}{}}{\bibtfont{The
LaTeX Companion}.\ \apyformat{Reading, Mass.\bpubaddr{}
Addison-Wesley\bibbdsep{} 1994}}}
\end{ltxexample}
%
In this case, the contents of the entire \env{thebibliography} environment are effectively transferred via the \file{aux} file. The data is read from the \file{bbl} file, written to the \file{aux} file, read back from the \file{aux} file and then kept in memory. The bibliography itself is still generated as the \file{bbl} file is read in. The \biblatex package would also be forced to cycle all data through the \file{aux} file. This implies processing overhead and is also redundant because the data has to be kept in memory anyway.
The traditional procedure is based on the assumption that the full bibliographic data of an entry is only required in the bibliography and that all citations use short labels. This makes it very effective in terms of memory requirements, but it also implies that it does not scale well. That is why \biblatex takes a different approach. First of all, the document structure is slightly different. Instead of using \cmd{bibliography} in the document body, database files are specified in the preamble with \cmd{addbibresource}, \cmd{bibliographystyle} is omitted entirely (all features are controlled by package options), and the bibliography is printed using \cmd{printbibliography}:
\begin{ltxexample}
\documentclass{...}
\usepackage[...]{biblatex}
\addbibresource{...}
\begin{document}
\cite{...}
...
\printbibliography
\end{document}
\end{ltxexample}
%
In order to streamline the whole procedure, \biblatex essentially employs the \file{bbl} file like an \file{aux} file, rendering \cmd{bibcite} obsolete. We then get the following procedure:
\begin{enumerate}
\item Run \bin{latex}: The first step is similar to the traditional procedure described above: \cmd{bibstyle} and \cmd{bibdata} commands are written to th \file{bcf} file, along with \cmd{citation} commands for all citations. We then wait for the backend to supply the required data.
\item Run \bin{biber}: The backend supplies those entries from the \file{bib} file which were requested by the \cmd{citation} commands in the auxiliary file. However, it does not write a printable bibliography to the \file{bbl} file, but rather a structured representation of the bibliographic data. Just like an \file{aux} file, this \file{bbl} file does not print anything when read in. It merely puts data in memory.
\item Run \bin{latex}: Starting with the second run, the \file{bbl} file is processed right at the beginning of the document body, just like an \file{aux} file. From this point on, all bibliographic data is available in memory so that all citations can be printed right away.\footnote{If the \opt{defernumbers} package option is enabled \biblatex uses an algorithm similar to the traditional procedure to generate numeric labels. In this case, the numbers are assigned as the bibliography is printed and then cycled through the backend auxiliary file. It will take an additional \latex run for them to be picked up in citations.} The citation commands have access to the complete bibliographic data, not only to a predefined label. The bibliography is generated from memory using the same data and may be filtered or split as required.
\end{enumerate}
Let's consider the sample entry given above once more:
\begin{lstlisting}[style=bibtex]{}
@Book{companion,
author = {Michel Goossens and Frank Mittelbach and Alexander Samarin},
title = {The LaTeX Companion},
publisher = {Addison-Wesley},
address = {Reading, Mass.},
year = {1994},
}
\end{lstlisting}
%
This entry is essentially exported in the following format:
\begin{ltxexample}
\entry{companion}{book}{}
\labelname{author}{3}{}{%
{{uniquename=0,hash=...}{Goossens}{G.}{Michel}{M.}{}{}{}{}}%
{{uniquename=0,hash=...}{Mittelbach}{M.}{Frank}{F.}{}{}{}{}}%
{{uniquename=0,hash=...}{Samarin}{S.}{Alexander}{A.}{}{}{}{}}%
}
\name{author}{3}{}{%
{{uniquename=0,hash=...}{Goossens}{G.}{Michel}{M.}{}{}{}{}}%
{{uniquename=0,hash=...}{Mittelbach}{M.}{Frank}{F.}{}{}{}{}}%
{{uniquename=0,hash=...}{Samarin}{S.}{Alexander}{A.}{}{}{}{}}%
}
\list{publisher}{1}{%
{Addison-Wesley}%
}
\list{location}{1}{%
{Reading, Mass.}%
}
\field{title}{The LaTeX Companion}
\field{year}{1994}
\endentry
\end{ltxexample}
%
As seen in this example, the data is presented in a structured format that resembles the structure of a \file{bib} file to some extent. At this point, no decision concerning the final format of the bibliography entry has been made. The formatting of the bibliography and all citations is controlled by \latex macros, which are defined in bibliography and citation style files.
\subsection{Bibliography Styles}
\label{aut:bbx}
A bibliography style is a set of macros which print the entries in the bibliography. Such styles are defined in files with the suffix \file{bbx}. The \biblatex package loads the selected bibliography style file at the end of the package. Note that a small repertory of frequently used macros shared by several of the standard bibliography styles is included in \path{biblatex.def}. This file is loaded at the end of the package as well, prior to the selected bibliography style.
\subsubsection{Bibliography Style Files}
\label{aut:bbx:bbx}
Before we go over the individual components of a bibliography style, consider this example of the overall structure of a typical \file{bbx} file:
\begin{ltxexample}
\ProvidesFile{example.bbx}[2006/03/15 v1.0 biblatex bibliography style]
\defbibenvironment{bibliography}
{...}
{...}
{...}
\defbibenvironment{shorthand}
{...}
{...}
{...}
\InitializeBibliographyStyle{...}
\DeclareBibliographyDriver{article}{...}
\DeclareBibliographyDriver{book}{...}
\DeclareBibliographyDriver{inbook}{...}
...
\DeclareBibliographyDriver{shorthand}{...}
\endinput
\end{ltxexample}
%
The main structure of a bibliography style file consists of the following commands:
\begin{ltxsyntax}
\cmditem{RequireBibliographyStyle}{style}
This command is optional and intended for specialized bibliography styles built on top of a more generic style. It loads the bibliography style \path{style.bbx}.
\cmditem{InitializeBibliographyStyle}{code}
Specifies arbitrary \prm{code} to be inserted at the beginning of the bibliography, but inside the group formed by the bibliography. This command is optional. It may be useful for definitions which are shared by several bibliography drivers but not used outside the bibliography. Keep in mind that there may be several bibliographies in a document. If the bibliography drivers make any global assignments, they should be reset at the beginning of the next bibliography.
\cmditem{DeclareBibliographyDriver}{entrytype}{code}
Defines a bibliography driver. A <driver> is a macro which handles a specific entry type (when printing bibliography lists) or a specific named bibliography list (when printing bibliography lists). The \prm{entrytype} corresponds to the entry type used in \file{bib} files, specified in lowercase letters (see \secref{bib:typ}). The \prm{entrytype} argument may also be an asterisk. In this case, the driver serves as a fallback which is used if no specific driver for the entry type has been defined. The \prm{code} is arbitrary code which typesets all bibliography entries of the respective \prm{entrytype}. This command is mandatory. Every bibliography style should provide a driver for each entry type.
\cmditem{DeclareBibliographyAlias}{alias}{entrytype}
If a bibliography driver covers more than one entry type, this command may be used to define an alias where \prm{entrytype} is the name of a defined driver. This command is optional. The \prm{alias} argument may also be an asterisk. In this case, the \prm{entrytype} driver serves as a fallback which is used if no specific driver for an entry has been defined.
Note that an alias declared with \cmd{DeclareBibliographyAlias} only <reroutes> the bibliography driver from \prm{alias} to \prm{entrytype}. Type-specific formatting directives still operate with the old \prm{alias} name. \cmd{DeclareBibliographyAlias} thus provides only a <soft> alias. If a complete alias is desired so that \prm{alias} and \prm{entrytype} are completely indistinguishable and use the same type-specific formatting, an approach with source mapping would be more appropriate (cf.~the mappings for \secref{bib:typ:als} in \secref{apx:maps:bibtex}, this would give a <hard> alias).
\cmditem{DeclareBibliographyOption}[datatype]{key}[value]{code}
This command defines additional preamble options in \keyval format. The \prm{key} is the option key. The \prm{code} is arbitrary \tex code to be executed whenever the option is used. The value passed to the option is passed on to the \prm{code} as |#1|. The optional \prm{value} is a default value to be used if the bare key is given without any value. This is useful for boolean switches.
The \prm{datatype} is a the datatype for the option. If omitted, it defaults to <boolean>. For example, with a definition like the following:
\begin{ltxexample}
\DeclareBibliographyOption[boolean]{somekey}[true]{...}
\end{ltxexample}
%
giving <\texttt{somekey}> without a value is equivalent to <\kvopt{somekey}{true}>. Valid \prm{datatype} values are defined in the default \biber Datamodel as:
\begin{ltxexample}
\DeclareDatamodelConstant[type=list]{optiondatatypes}{boolean,integer,string,xml}
\end{ltxexample}
\cmditem{DeclareTypeOption}[datatype]{key}[value]{code}
Similar to \cmd{DeclareBibliographyOption} but defines options which are settable on a per"=type basis using the optional argument of \cmd{ExecuteBibliographyOptions} (see \secref{use:cfg:opt}). The \prm{code} is executed whenever \biblatex prepares the data of an entry of the type for which the option has been set for use by a citation command or a bibliography driver.
\cmditem{DeclareEntryOption}[datatype]{key}[value]{code}
Similar to \cmd{DeclareBibliographyOption} but defines options which are settable on a per"=entry basis in the \bibfield{options} field from \secref{bib:fld:spc}. The \prm{code} is executed whenever \biblatex prepares the data of the entry for use by a citation command or a bibliography driver.
\cmditem{DeclareBiblatexOption}{scope,\dots}[datatype]{key}[value]{code}
This command is a convenient interface to declare an option for several scopes at once. The \prm{scope} argument may be a comma"=separated list of scopes for which the option will be declared. Currently the scopes \opt{global}, \opt{type}, \opt{entry}, \opt{namelist} and \opt{name} are supported, the first three of which are equivalent to defining the option with \cmd{DeclareBibliographyOption}, \cmd{DeclareTypeOption} and \cmd{DeclareEntryOption}, respectively.
\end{ltxsyntax}
\subsubsection{Bibliography Environments}
\label{aut:bbx:env}
Apart from defining bibliography drivers, the bibliography style is also responsible for the environments which control the layout of the bibliography and bibliography lists. These environments are defined with \cmd{defbibenvironment}. By default, \cmd{printbibliography} uses the environment \opt{bibliography}. Here is a definition suitable for a bibliography style which does not print any labels in the bibliography:
\begin{ltxexample}
\defbibenvironment{bibliography}
{\list
{}
{\setlength{\leftmargin}{\bibhang}%
\setlength{\itemindent}{-\leftmargin}%
\setlength{\itemsep}{\bibitemsep}%
\setlength{\parsep}{\bibparsep}}}
{\endlist}
{\item}
\end{ltxexample}
%
This definition employs a \env{list} environment with hanging indentation, using the \cmd{bibhang} length register provided by \biblatex. It allows for a certain degree of configurability by using \cmd{bibitemsep} and \cmd{bibparsep}, two length registers provided by \biblatex for this very purpose (see \secref{aut:fmt:len}). The \texttt{authoryear} and \texttt{authortitle} bibliography styles use a definition similar to this example.
\begin{ltxexample}
\defbibenvironment{bibliography}
{\list
{\printfield[labelnumberwidth]{labelnumber}}
{\setlength{\labelwidth}{\labelnumberwidth}%
\setlength{\leftmargin}{\labelwidth}%
\setlength{\labelsep}{\biblabelsep}%
\addtolength{\leftmargin}{\labelsep}%
\setlength{\itemsep}{\bibitemsep}%
\setlength{\parsep}{\bibparsep}}%
\renewcommand*{\makelabel}[1]{\hss##1}}
{\endlist}
{\item}
\end{ltxexample}
%
Some bibliography styles print labels in the bibliography. For example, a bibliography style designed for a numeric citation scheme will print the number of every entry such that the bibliography looks like a numbered list. In the first example, the first argument to \cmd{list} was empty. In this example, we need it to insert the number, which is provided by \biblatex in the \bibfield{labelnumber} field. We also employ several length registers and other facilities provided by \biblatex, see \secref{aut:fmt:ich, aut:fmt:ilc} for details. The \texttt{numeric} bibliography style uses the definition given above. The \texttt{alphabetic} style is similar, except that \textsf{\texttt{labelnumber}} is replaced by \texttt{labelalpha} and \texttt{labelnumberwidth} by \texttt{labelalphawidth}.
Bibliography lists are handled in a similar way. \cmd{printbiblist} uses the environment named after the bibliography list by default. A typical example is given below. See \secref{aut:fmt:ich, aut:fmt:ilc} for details on the length registers and facilities used in this example.
\begin{ltxexample}
\defbibenvironment{shorthand}
{\list
{\printfield[shorthandwidth]{shorthand}}
{\setlength{\labelwidth}{\shorthandwidth}%
\setlength{\leftmargin}{\labelwidth}%
\setlength{\labelsep}{\biblabelsep}%
\addtolength{\leftmargin}{\labelsep}%
\setlength{\itemsep}{\bibitemsep}%
\setlength{\parsep}{\bibparsep}%
\renewcommand*{\makelabel}[1]{##1\hss}}}
{\endlist}
{\item}
\end{ltxexample}
\subsubsection{Bibliography Drivers}
\label{aut:bbx:drv}
Before we go over the commands which form the data interface of the \biblatex package, it may be instructive to have a look at the structure of a bibliography driver. Note that the example given below is greatly simplified, but still functional. For the sake of readability, we omit several fields which may be part of a \bibtype{book} entry and also simplify the handling of those which are considered. The main point is to give you an idea of how a driver is structured. For information about the mapping of the \bibtex file format fields to \biblatex's data types, see \secref{bib:fld}.
\begin{ltxexample}
\DeclareBibliographyDriver{book}{%
\printnames{author}%
\newunit\newblock
\printfield{title}%
\newunit\newblock
\printlist{publisher}%
\newunit
\printlist{location}%
\newunit
\printfield{year}%
\finentry}
\end{ltxexample}
%
The standard bibliography styles employ two bibliography macros \texttt{begentry} and \texttt{finentry}:
\begin{ltxexample}
\DeclareBibliographyDriver{<<entrytype>>}{%
\usebibmacro{begentry}
...
\usebibmacro{finentry}}
\end{ltxexample}
%
with the default definitions
\begin{ltxexample}
\newbibmacro*{begentry}{}
\newbibmacro*{finentry}{\finentry}
\end{ltxexample}
%
Use of these macros is recommended for easy hooks into the beginning and end of the driver.
Returning to the driver for the \texttt{book} entrytype above, there is still one piece missing: the formatting directives used by \cmd{printnames}, \cmd{printlist}, and \cmd{printfield}. To give you an idea of what a formatting directive looks like, here are some fictional ones used by our sample driver. Field formats are straightforward, the value of the field is passed to the formatting directive as an argument which may be formatted as desired. The following directive will simply wrap its argument in an \cmd{emph} command:
\begin{ltxexample}
\DeclareFieldFormat{title}{\emph{#1}}
\end{ltxexample}
%
List formats are slightly more complex. After splitting up the list into individual items, \biblatex will execute the formatting directive once for every item in the list. The item is passed to the directive as an argument. The separator to be inserted between the individual items in the list is also handled by the corresponding directive, hence we have to check whether we are in the middle of the list or at the end when inserting it.
\begin{ltxexample}
\DeclareListFormat{location}{%
#1%
\ifthenelse{\value{listcount}<\value{liststop}}
{\addcomma\space}
{}}
\end{ltxexample}
%
Formatting directives for names are similar to those for literal lists.
Names depend on the datamodel constant <nameparts> which has the default definition:
\begin{ltxexample}
\DeclareDatamodelConstant[type=list]{nameparts}
{prefix,family,suffix,given}
\end{ltxexample}
%
This can be customised to add more name parts to deal with things like patronymics (see the example file \file{93-nameparts.tex}). This needs an extended name format for data sources since the standard \bibtex name format is very limited. \biblatexml (\secref{apx:biblatexml}) handles this natively and there is an extended name format which can handle custom nameparts when using \biber (see \biber documentation).
Inside name formats, the <nameparts> constant declaration makes available two or three macros for each name part defined in the datamodel:
\begin{ltxexample}
\namepart<namepart> \% The full <namepart>
\namepart<namepart>i \% The initials of the <namepart>
\namepart<namepart>un \% Numeric value indicating uniqueness level for <namepart>
\end{ltxexample}
%
\cmd{namepart<namepart>un} only exists if the package option \opt{uniquename} is not set to <false> and can take the following values.
\begin{argumentlist}{00}
\item[0] <namepart> was not used in disambiguating the name (because \opt{disambiguation=none} was set in \cmd{DeclareUniquenameTemplate}, see \secref{aut:cav:amb}). In this case the style should decide what to print for this <namepart>
\item[1] Initials only should be printed for <namepart> to ensure uniqueness according to the \opt{uniquename} package option setting
\item[2] The full <namepart> should be printed to ensure uniqueness according to the \opt{uniquename} package option setting
\end{argumentlist}
Note these per-namepart uniqueness macros are essentially an override of the \opt{uniquename} value (see \secref{aut:aux:tst}) for the name as a whole. Styles can choose to use either the less granular \opt{uniquename} value or the more detailed per-namepart values. Usually the general \opt{uniquename} value is enough for ordinary Western names but the more granular information per-namepart is provided to allow sophisticated name uniqueness processing for more complex name schemata.
The name formatting directive is executed once for each name in the name list. Here is a simplified example---the standard name formats are more intricate:
\begin{ltxexample}
\DeclareNameFormat{author}{%
\ifthenelse{\value{listcount}=1}
{\namepartfamily%
\ifdefvoid{\namepartgiven}{}{\addcomma\space\namepartgiven}}
{\ifdefvoid{\namepartgiven}{}{\namepartgiven\space}%
\namepartfamily}%
\ifthenelse{\value{listcount}<\value{liststop}}
{\addcomma\space}
{}}
\end{ltxexample}
%
The above directive reverses the name of the first author («Family, Given») and prints the remaining names in their regular sequence («Given Family»). Note that the only component which is guaranteed to be available is the family name, hence we have to check which parts of the name are actually present. If a certain name part is not available, the corresponding macro will be empty. As with directives for literal lists, the separator to be inserted between the individual items in the name list is also handled by the formatting directive, hence we have to check whether we are in the middle of the list or at the end when inserting it. This is what the second \cmd{ifthenelse} test does. See also \secref{aut:bib:fmt}.
A similar output that also respects the \cmd{multinamedelim} and \cmd{finalnamedelim} commands as well as the <prefix> and <suffix> name parts can be achieved with
\begin{ltxexample}
\DeclareNameAlias{author}{family-given/given-family}
\end{ltxexample}
\subsubsection{Special Fields}
\label{aut:bbx:fld}
The following lists and fields are used by \biblatex to pass data to bibliography drivers and citation commands. They are not used in \file{bib} files but defined automatically by the package. From the perspective of a bibliography or citation style, they are not different from the fields in a \file{bib} file.
\paragraph{Generic Fields}
\label{aut:bbx:fld:gen}
\begin{fieldlist}
\fielditem{$<$datetype$>$dateunspecified}{string}
If $<$datetype$>$date held an \acr{ISO8601-2} 4.3 <unspecified>, this field will be set to one of \opt{yearindecade}, \opt{yearincentury}, \opt{monthinyear}, \opt{dayinmonth} or \opt{dayinyear} which specifies the granularity of the unspecified information. These strings can be tested for and along with the date ranges which are automatically created for such <unspecified> dates, a style may choose to format the date in a special way. See \secref{bib:use:dat}. For example, an entry with dates such as:
\begin{lstlisting}[style=bibtex]{}
@book{key,
date = {19uu},
origdate = {199u}
}
\end{lstlisting}
%
would result in the same information in the \file{.bbl} as:
\begin{lstlisting}[style=bibtex]{}
@book{key,
date = {1900/1999},
origdate = {1990/1999}
}
\end{lstlisting}
%
but would additionally have the field \bibfield{dateunspecified} set to <yearincentury> and \bibfield{origdateunspecified} set to <yearindecade>. This information could be used to render the \bibfield{date} as perhaps <20th century> and \bibfield{origdate} as <The 1990s>, information which cannot be derived from the date ranges alone. Since such auto-generated ranges have known values, given the <unspecified> meta-information, it is relatively easy to use the range values to format special cases. While the standard styles do not do this, examples are given in the file \file{96-dates.tex}.
\fielditem{entrykey}{string}
The entry key of an item in the \file{bib} file. This is the string used by \biblatex and the backend to identify an entry in the \file{bib} file.
Note that the set of characters allowed and usable in the string for \bibfield{entrykey} depends on the backend (\biber, \bibtex) as well as the \latex engine (\pdflatex, \lualatex, \xelatex).
Generally, ASCII-letters (\texttt{a-z}, \texttt{A-Z}) and numbers (\texttt{0-9}) are safe, so are the punctuation characters full stop (\texttt{.}) and solidus (\texttt{/}). The punctuation characters \texttt{-\_:;!?} are also safe even if they are made active by \sty{babel}/\sty{polyglossia}. If a Unicode engine is used, non-ASCII characters are also acceptable.
Curly braces (\texttt{\{\}}), commas, spaces, backslashes (\texttt{\textbackslash}), hashes (\texttt{\#}), percent characters (\texttt{\%}) and tildes (\texttt{\textasciitilde}) are always forbidden. \biber additionally forbids round brackets (\texttt{()}), quotation marks (\texttt{\textquotedbl}, \texttt{\textquotesingle}), and the equals sign (\texttt{=}).
The \bibfield{entrykey} is case sensitive, but it is not recommended to exploit that fact too much by introducing two different entries whose key differs only in capitalisation (\eg\ \texttt{sigfridsson} and \texttt{Sigfridsson}).
For full portability it is advisable to stick to a scheme of lowercase (and if so desired uppercase) ASCII-letters, numbers and a small set of acceptable punctuation characters, say \texttt{.:-}.
\fielditem{childentrykey}{string}
This field is no longer necessary or recommended.\DeprecatedMark For backwards
compatibility, it is merely a copy of the \bibfield{entrykey} field in any
set children.
\fielditem{labelnamesource}{literal}
Holds the name of the field used to populate \bibfield{labelname},
determined by \cmd{DeclareLabelname}.
\fielditem{labeltitlesource}{literal}
Holds the name of the field used to populate \bibfield{labeltitle},
determined by \cmd{DeclareLabeltitle}.
\fielditem{labeldatesource}{literal}
Holds one of:
\begin{itemize}
\item The prefix coming before <date> of the date field name chosen by
\cmd{DeclareLabeldate}
\item The name of a field
\item A literal or localisation string
\end{itemize}
%
Normally holds the prefix coming before <date> of the date field name chosen by \cmd{DeclareLabeldate}. For example, if the labeldate field is \bibfield{eventdate}, then \bibfield{labeldatesource} will be <event>. In case \cmd{DeclareLabeldate} selects the \bibfield{date} field, then \bibfield{labeldatesource} will be defined but will be an empty string as the prefix coming before <date> in the date label name is empty. This is so that the contents of \bibfield{labeldatesource} can be used in constructing references to the field which \cmd{DeclareLabeldate} chooses. Since \cmd{DeclareLabeldate} can also select literal strings for fallbacks, \bibfield{labeldatesource} may not refer to a field or may be undefined. Bear in mind that \cmd{DeclareLabeldate} can also be used to select non-date fields as a fallback and so \bibfield{labeldatesource} might contain a field name. So, in summary, the rules are
\begin{ltxexample}
\iffieldundef{labeldatesource}
{}% labeldate package option is not set
{\iffieldundef{\thefield{labeldatesource}year}
% \DeclareLabeldate resolved to either a literal/localisation
% string or a non-date field since
% if a date is defined by a date field, there is
% at least a year
{\iffieldundef{\thefield{labeldatesource}}
{}% \DeclareLabeldate resolved to a literal/localisation string
{}% \DeclareLabeldate resolved to a non-date field
}
{} % \DeclareLabeldate resolved a date field name prefix like "" or "orig"
}
\end{ltxexample}
\fielditem{entrytype}{string}
The entry type (\bibtype{book}, \bibtype{inbook}, etc.), given in lowercase letters.
\fielditem{childentrytype}{string}
This field is no longer necessary or recommended.\DeprecatedMark For backwards
compatibility, it is merely a copy of the \bibfield{entrytype} field in any
set children.
\fielditem{entrysetcount}{integer}
This field holds an integer indicating the position of a set member in the entry set (starting at \texttt{1}). This field is only available in the subentries of an entry set.
\fielditem{hash}{string}
This field is special in that it is only available locally in name formatting directives. It holds a hash string which uniquely identifies individual names in a name list. This information is available for all names in all name lists. See also \bibfield{namehash} and \bibfield{fullhash}.
\fielditem{namehash}{string}
A hash string which uniquely identifies the \bibfield{labelname} list. This is useful for recurrence checks. For example, a citation style which replaces recurrent authors or editors with a string like <idem> could save the \bibfield{namehash} field with \cmd{savefield} and use it in a comparison with \cmd{iffieldequals} later (see \secref{aut:aux:dat, aut:aux:tst}). The \bibfield{namehash} is derived from the truncated \bibfield{labelname} list, \ie it is responsive to \opt{maxcitenames} and \opt{mincitenames}. See also \bibfield{hash} and \bibfield{fullhash}.
\fielditem{bibnamehash}{string}
As \bibfield{namehash} but responsive to \opt{maxbibnames} and
\opt{minbibnames}. This is not used in standard styles but may be used to
make tests in bibliography lists (such as those used to determine whether
dashes should replace repeated authors) behave differently.
\fielditem{$<$namelist$>$namehash}{string}
As \bibfield{namehash} for the name list called <namelist>.
\fielditem{$<$namelist$>$bibnamehash}{string}
As \bibfield{bibnamehash} for the name list called <namelist>.
\fielditem{fullhash}{string}
A hash string which uniquely identifies the \bibfield{labelname} list. This fields differs from \bibfield{namehash} in two details: 1) The \bibfield{shortauthor} and \bibfield{shorteditor} lists are ignored when generating the hash. 2) The hash always refers to the full list, ignoring \opt{maxnames} and \opt{minnames}. See also \bibfield{hash} and \bibfield{namehash}.
\fielditem{$<$namelist$>$fullhash}{string}
As \bibfield{fullhash} for the name list called <namelist>.
\listitem{pageref}{literal}
If the \opt{backref} package option is enabled, this list holds the page numbers of the pages on which the respective bibliography entry is cited. If there are \env{refsection} environments in the document, the back references are local to the reference sections.
\fielditem{sortinit}{literal}
This field holds the initial character of the information used during sorting.
\fielditem{sortinithash}{string}
This field holds a hash of the (locale-specific) Unicode Collation Algorithm primary weight of the first extended grapheme cluster (essentially the first character) of the string used during sorting. This is useful when subdividing the bibliography alphabetically and is used internally by \cmd{bibinitsep} (see \secref{use:fmt:len}).
\fielditem{clonesourcekey}{string}
This field holds the entry key of the entry from which an entry was cloned. Clones are created for
entries which are mentioned in \bibfield{related} fields as part of related entry processing, for example.
\fielditem{urlraw}{verbatim}
This is the unencoded, raw version of any \bibfield{url}. This is intended for use when the display version and clickable link version of a URL are different. This can be the case when the URL contains special or Unicode characters. In the case where no such characters occur, may be identical to the \bibfield{url}.
\end{fieldlist}
\paragraph{Fields for Use in Citation Labels}
\label{aut:bbx:fld:lab}
\begin{fieldlist}
\fielditem{labelalpha}{literal}
A label similar to the labels generated by the \path{alpha.bst} style of traditional \bibtex. This default label consists of initials drawn from the \bibfield{labelname} list plus the last two digits of the publication year. The \bibfield{label} field may be used to override its non"=numeric portion. If the \bibfield{label} field is defined, \biblatex will use its value and append the last two digits of the publication year when generating \bibfield{labelalpha}. The \bibfield{shorthand} field may be used to override the entire label. If defined, \bibfield{labelalpha} is the \bibfield{shorthand} rather than an automatically generated label. Users can specify a template used to construct the alphabetic label (see \secref{aut:ctm:lab}) and the default template mirrors the format mentioned for bibtex above. A complete <alphabetic> label consists of the fields \bibfield{labelalpha} plus \bibfield{extraalpha}. Note that the \bibfield{labelalpha} and \bibfield{extraalpha} fields need to be requested with the package option \opt{labelalpha} (\secref{use:opt:pre:int}). See also \bibfield{extraalpha} as well as \cmd{labelalphaothers} in \secref{use:fmt:fmt}.
\fielditem{extraalpha}{integer}
The <alphabetic> citation scheme usually requires a letter to be appended to the label if the bibliography contains two or more works by the same author which were all published in the same year. In this case, the \bibfield{extraalpha} field holds an integer which may be converted to a letter with \cmd{mknumalph} or formatted in some other way. This field is similar to the role of \bibfield{extradate} in the author"=year scheme. A complete <alphabetic> label consists of the fields \bibfield{labelalpha} plus \bibfield{extraalpha}. Note that the \bibfield{labelalpha} and \bibfield{extraalpha} fields need to be requested with the package option \opt{labelalpha}, see \secref{use:opt:pre:int} for details. See also \bibfield{labelalpha} as well as \cmd{labelalphaothers} in \secref{use:fmt:fmt}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\listitem{labelname}{name}
The name to be printed in citations. This list is a copy of either the \bibfield{shortauthor}, the \bibfield{author}, the \bibfield{shorteditor}, the \bibfield{editor}, or the \bibfield{translator} list, which are normally checked for in this order. If no authors and editors are available, this list is undefined. Note that this list is also responsive to the \opt{use$<$name$>$}, options, see \secref{use:opt:bib}. Citation styles should use this list when printing the name in a citation. This list is provided for convenience only and does not carry any additional meaning.
This field may be customized. See \secref{aut:ctm:fld} for details.
\fielditem{extraname}{integer}
Holds a count of the number of bibliography entries within a refsection which derive from the same \bibfield{labelname} list. This counter takes account of \opt{uniquename} settings (see \secref{use:opt:pre:int}). While not used by any standard styles, this field is useful in styles which wish to number bibliography entries on a per-\bibfield{labelname} basis. This field will only exist if there is a \bibfield{labelname}. The \bibfield{extraname} counter is related to, but conceptually different from \cmd{ifsingletitle} (see \secref{use:opt:pre:int} and \secref{aut:aux:tst}).
\fielditem{labelnumber}{literal}
The number of the bibliography entry, as required by numeric citation schemes. If the \bibfield{shorthand} field is defined, \biblatex does not assign a number to the respective entry. In this case \bibfield{labelnumber} is the shorthand rather than a number. Numeric styles must use the value of this field instead of a counter. Note that this field needs to be requested with the package option \opt{labelnumber}, see \secref{use:opt:pre:int} for details. Also see the package option \opt{defernumbers} in \secref{use:opt:pre:gen}.
\fielditem{labelprefix}{literal}
If the \opt{labelprefix} option of \cmd{newrefcontext} has been set in order to prefix all entries in a subbibliography with a fixed string, this string is available in the \bibfield{labelprefix} field of all affected entries. If no prefix has been set, the \bibfield{labelprefix} field of the respective entry is undefined. See the \opt{labelprefix} option of \cmd{newrefcontext} in \secref{use:bib:context} for details. If the \bibfield{shorthand} field is defined, \biblatex does not assign the prefix to the \bibfield{labelprefix} field of the respective entry. In this case, the \bibfield{labelprefix} field is undefined.
\fielditem{labeltitle}{literal}
The printable title of a work. In some circumstances, a style might need to choose a title from a list of a possible title fields. For example, citation styles printing short titles may want to print the \bibfield{shorttitle} field if it exists but otherwise print the \bibfield{title} field. The list of fields to be considered when constructing \bibfield{labeltitle} may be customized. See \secref{aut:ctm:fld} for details. Note that the \bibfield{extratitle} field needs to be requested with the package option \opt{labeltitle}, see \secref{use:opt:pre:int} for details. See also \bibfield{extratitle}. Note also that the \bibfield{extratitleyear} field needs to be requested with the package option \opt{labeltitleyear}. See also \bibfield{extratitleyear}.
\fielditem{extratitle}{integer}
It is sometimes useful, for example in author"=title citation schemes, to be able to disambiguate works with the same title. For works by the same \bibfield{labelname} with the same \bibfield{labeltitle}, the \bibfield{extratitle} field holds an integer which may be converted to a letter with \cmd{mknumalph} or formatted in some other way (or it can be merely used as a flag to say that some other field such as a date should be used in conjunction with the \bibfield{labeltitle} field). This field is undefined if there is only one work with the same \bibfield{labeltitle} by the same \bibfield{labelname} in the bibliography. Note that the \bibfield{extratitle} field needs to be requested with the package option \opt{labeltitle}, see \secref{use:opt:pre:int} for details. See also \bibfield{labeltitle}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\fielditem{extratitleyear}{integer}
It is sometimes useful, for example in author"=title citation schemes, to be able to disambiguate works with the same title in the same year but with no author. For works with the same \bibfield{labeltitle} and with the same \bibfield{labelyear}, the \bibfield{extratitleyear} field holds an integer which may be converted to a letter with \cmd{mknumalph} or formatted in some other way (or it can be merely used as a flag to say that some other field such as a publisher should be used in conjunction with the \bibfield{labelyear} field). This field is undefined if there is only one work with the same \bibfield{labeltitle} and \bibfield{labelyear} in the bibliography. Note that the \bibfield{extratitleyear} field needs to be requested with the package option \opt{labeltitleyear}, see \secref{use:opt:pre:int} for details. See also \bibfield{labeltitleyear}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\fielditem{labelyear}{literal}
The year of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}) or the \bibfield{year} field, for use in author-year labels. A complete author-year label consists of the fields \bibfield{labelyear} plus \bibfield{extradate}. Note that the \bibfield{labelyear} and \bibfield{extradate} fields need to be requested with the package option \opt{labeldateparts}, see \secref{use:opt:pre:int} for details. See also \bibfield{extradate}.
\fielditem{labelendyear}{literal}
The end year of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}) if the selected date is a range.
\fielditem{labelmonth}{datepart}
The month of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}), or the \bibfield{month} field for use in author-year labels. Note that the \bibfield{labelmonth} field needs to be requested with the package option \opt{labeldateparts}, see \secref{use:opt:pre:int} for details.
\fielditem{labelendmonth}{datepart}
The end month of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}) if the selected date is a range.
\fielditem{labelday}{datepart}
The month of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}) for use in author-year labels. Note that the \bibfield{labelday} field needs to be requested with the package option \opt{labeldateparts}, see \secref{use:opt:pre:int} for details.
\fielditem{labelendday}{datepart}
The end day of the date field selected by \cmd{DeclareLabeldate} (\secref{aut:ctm:fld}) if the selected date is a range.
\fielditem{extradate}{integer}
The author"=year citation scheme usually requires a letter to be appended to the year if the bibliography contains two or more works by the same author which were all published in the same year. In this case, the \bibfield{extradate} field holds an integer which may be converted to a letter with \cmd{mknumalph} or formatted in some other way. This field is undefined if there is only one work by the author in the bibliography or if all works by the author have different publication years. A complete author-year label consists of the fields \bibfield{labelyear} plus \bibfield{extradate}. Note that the \bibfield{labelyear} and \bibfield{extradate} fields need to be requested with the package option \opt{labeldateparts}, see \secref{use:opt:pre:int} for details. See also \bibfield{labelyear}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\fielditem{extradatescope}{literal}
This field contains the name of the most specific field which determined the value of \bibfield{extradate}. It is not used by the standard styles but may be useful in controlling the placement of the \bibfield{extradate} field value.
\end{fieldlist}
\paragraph{Date Component Fields}
\label{aut:bbx:fld:dat}
Note that it is possible to define new date fields in the datamodel which behave exactly like the default data model date fields described in this section.
See \tabref{aut:bbx:fld:tab1} for an overview of how the date fields in \file{bib} files are related to the date fields provided by the style interface. When testing for a field like \bibfield{origdate} in a style, use code like:
\begin{ltxcode}
<<\iffieldundef>>{orig<<year>>}{...}{...}
\end{ltxcode}
%
This will tell you if the corresponding date is defined at all. This test:
\begin{ltxcode}
<<\iffieldundef>>{orig<<endyear>>}{...}{...}
\end{ltxcode}
%
will tell you if the corresponding date is defined and a (fully specified) range. This test:
\begin{ltxcode}
<<\iffieldequalstr>>{orig<<endyear>>}{}{...}{...}
\end{ltxcode}
%
will tell you if the corresponding date is defined and an open"=ended range. Open"=ended ranges are indicated by an empty \texttt{endyear} component (as opposed to an undefined \texttt{endyear} component). See \secref{bib:use:dat} and \tabref{bib:use:tab1} on page~\pageref{bib:use:tab1} for further examples.
\begingroup
\tablesetup
\begin{longtable}[l]{%
@{}V{0.15\textwidth}%
@{}V{0.4\textwidth}%
@{}V{0.3\textwidth}%
@{}V{0.2\textwidth}@{}}
\caption{Date Interface}
\label{aut:bbx:fld:tab1}
\endfirsthead
\caption[]{Date Interface (cont'd)}
\endhead
\toprule
\multicolumn{2}{@{}H}{\file{bib} File} &
\multicolumn{2}{H}{Data Interface} \\
\cmidrule(r){1-2}\cmidrule(l){3-4}
\multicolumn{1}{@{}H}{Field} &
\multicolumn{1}{H}{Value (Example)} &
\multicolumn{1}{H}{Field} &
\multicolumn{1}{H}{Value (Example)} \\
\cmidrule{1-1}\cmidrule(lr){2-2}\cmidrule(l){3-3}\cmidrule(l){4-4}
date & 1988 & day & undefined \\
& & month & undefined \\
& & year & 1988 \\
& & season & undefined \\
& & endday & undefined \\
& & endmonth & undefined \\
& & endyear & undefined \\
& & endseason & undefined \\
& & hour & undefined \\
& & minute & undefined \\
& & second & undefined \\
& & timezone & undefined \\
& & endhour & undefined \\
& & endminute & undefined \\
& & endsecond & undefined \\
& & endtimezone & undefined \\
date & 1997/ & day & undefined \\
& & month & undefined \\
& & year & 1997 \\
& & season & undefined \\
& & endday & undefined \\
& & endmonth & undefined \\
& & endyear & empty \\
& & endseason & undefined \\
& & hour & undefined \\
& & minute & undefined \\
& & second & undefined \\
& & timezone & undefined \\
& & endhour & undefined \\
& & endminute & undefined \\
& & endsecond & undefined \\
& & endtimezone & undefined \\
urldate & 2009-01-31 & urlday & 31 \\
& & urlmonth & 01 \\
& & urlyear & 2009 \\
& & urlseason & undefined \\
& & urlendday & undefined \\
& & urlendmonth & undefined \\
& & urlendyear & undefined \\
& & urlendseason & undefined \\
& & urlhour & undefined \\
& & urlminute & undefined \\
& & urlsecond & undefined \\
& & urltimezone & undefined \\
& & urlendhour & undefined \\
& & urlendminute & undefined \\
& & urlendsecond & undefined \\
& & urlendtimezone & undefined \\
urldate & 2009-01-31T15:34:04Z & urlday & 31 \\
& & urlmonth & 01 \\
& & urlyear & 2009 \\
& & urlseason & undefined \\
& & urlendday & undefined \\
& & urlendmonth & undefined \\
& & urlendyear & undefined \\
& & urlendseason & undefined \\
& & urlhour & 15 \\
& & urlminute & 34 \\
& & urlsecond & 04 \\
& & urltimezone & Z \\
& & urlendhour & undefined \\
& & urlendminute & undefined \\
& & urlendsecond & undefined \\
& & urlendtimezone & undefined \\
urldate & 2009-01-31T15:34:04+05:00 & urlday & 31 \\
& & urlmonth & 01 \\
& & urlyear & 2009 \\
& & urlseason & undefined \\
& & urlendday & undefined \\
& & urlendmonth & undefined \\
& & urlendyear & undefined \\
& & urlendseason & undefined \\
& & urlhour & 15 \\
& & urlminute & 34 \\
& & urlsecond & 04 \\
& & urltimezone & +0500 \\
& & urlendhour & undefined \\
& & urlendminute & undefined \\
& & urlendsecond & undefined \\
& & urlendtimezone & undefined \\
urldate & \parbox[t]{0.4\textwidth}{2009-01-31T15:34:04/\\2009-01-31T16:04:34}& urlday & 31 \\
& & urlmonth & 1 \\
& & urlyear & 2009 \\
& & urlseason & undefined \\
& & urlendday & 31 \\
& & urlendmonth & 1 \\
& & urlendyear & 2009 \\
& & urlendseason & undefined \\
& & urlhour & 15 \\
& & urlminute & 34 \\
& & urlsecond & 4 \\
& & urltimezone & floating \\
& & urlendhour & 16 \\
& & urlendminute & 4 \\
& & urlendsecond & 34 \\
& & urlendtimezone & floating \\
origdate & 2002-21/2002-23 & origday & undefined \\
& & origmonth & 01 \\
& & origyear & 2002 \\
& & origseason & spring \\
& & origendday & undefined \\
& & origendmonth & 02 \\
& & origendyear & 2002 \\
& & origendseason & autumn \\
& & orighour & undefined \\
& & origminute & undefined \\
& & origsecond & undefined \\
& & origtimezone & undefined \\
& & origendhour & undefined \\
& & origendminute & undefined \\
& & origendsecond & undefined \\
& & origendtimezone & undefined \\
eventdate & 1995-01-31/1995-02-05 & eventday & 31 \\
& & eventmonth & 01 \\
& & eventyear & 1995 \\
& & eventseason & undefined \\
& & eventendday & 05 \\
& & eventendmonth & 02 \\
& & eventendyear & 1995 \\
& & eventendseason & undefined \\
& & eventhour & undefined \\
& & eventminute & undefined \\
& & eventsecond & undefined \\
& & eventtimezone & undefined \\
& & eventendhour & undefined \\
& & eventendminute & undefined \\
& & eventendsecond & undefined \\
& & eventendtimezone & undefined \\
\bottomrule
%\end{tabularx}
\end{longtable}
\endgroup
\begin{fieldlist}
\fielditem{hour}{datepart}
This field holds the hour component of the \bibfield{date} field. If the date is a range, it holds the hour component of the start date.
\fielditem{minute}{datepart}
This field holds the minute component of the \bibfield{date} field. If the date is a range, it holds the minute component of the start date.
\fielditem{second}{datepart}
This field holds the second component of the \bibfield{date} field. If the date is a range, it holds the second component of the start date.
\fielditem{timezone}{datepart}
This field holds the timezone component of the \bibfield{date} field. If the date is a range, it holds the timezone component of the start date.
\fielditem{day}{datepart}
This field holds the day component of the \bibfield{date} field. If the date is a range, it holds the day component of the start date.
\fielditem{month}{datepart}
This field is the \bibfield{month} as given in the database file or it holds the month component of the \bibfield{date} field. If the date is a range, it holds the month component of the start date.
\fielditem{year}{datepart}
This field is the \bibfield{year} as given in the database file or it holds the year component of the \bibfield{date} field. If the date is a range, it holds the year component of the start date.
\fielditem{season}{datepart}
This field holds the season component of the \bibfield{date} field as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). If the date is a range, it holds the season component of the start date.
\fielditem{endhour}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the hour component of the end date.
\fielditem{endminute}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the minute component of the end date.
\fielditem{endsecond}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the second component of the end date.
\fielditem{endtimezone}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the timezone component of the end date.
\fielditem{endday}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the day component of the end date.
\fielditem{endmonth}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the month component of the end date.
\fielditem{endyear}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the year component of the end date. A blank (but defined) \bibfield{endyear} component indicates an open ended \bibfield{date} range.
\fielditem{endseason}{datepart}
If the date specification in the \bibfield{date} field is a range, this field holds the season component of the end date as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). A blank (but defined) \bibfield{endseason} component indicates an open ended \bibfield{date} range.
\fielditem{orighour}{datepart}
This field holds the hour component of the \bibfield{origdate} field. If the date is a range, it holds the hour component of the start date.
\fielditem{origminute}{datepart}
This field holds the minute component of the \bibfield{origdate} field. If the date is a range, it holds the minute component of the start date.
\fielditem{origsecond}{datepart}
This field holds the second component of the \bibfield{origdate} field. If the date is a range, it holds the second component of the start date.
\fielditem{origtimezone}{datepart}
This field holds the timezone component of the \bibfield{origdate} field. If the date is a range, it holds the timezone component of the start date.
\fielditem{origday}{datepart}
This field holds the day component of the \bibfield{origdate} field. If the date is a range, it holds the day component of the start date.
\fielditem{origmonth}{datepart}
This field holds the month component of the \bibfield{origdate} field. If the date is a range, it holds the month component of the start date.
\fielditem{origyear}{datepart}
This field holds the year component of the \bibfield{origdate} field. If the date is a range, it holds the year component of the start date.
\fielditem{origseason}{datepart}
This field holds the season component of the \bibfield{origdate} field as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). If the date is a range, it holds the season component of the start date.
\fielditem{origendhour}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the hour component of the end date.
\fielditem{origendminute}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the minute component of the end date.
\fielditem{origendsecond}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the second component of the end date.
\fielditem{origendtimezone}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the timezone component of the end date.
\fielditem{origendday}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the day component of the end date.
\fielditem{origendmonth}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the month component of the end date.
\fielditem{origendyear}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the year component of the end date. A blank (but defined) \bibfield{origendyear} component indicates an open ended \bibfield{origdate} range.
\fielditem{origendseason}{datepart}
If the date specification in the \bibfield{origdate} field is a range, this field holds the season component of the end date as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). A blank (but defined) \bibfield{origendseason} component indicates an open ended \bibfield{origdate} range.
\fielditem{eventhour}{datepart}
This field holds the hour component of the \bibfield{eventdate} field. If the date is a range, it holds the hour component of the start date.
\fielditem{eventminute}{datepart}
This field holds the minute component of the \bibfield{eventdate} field. If the date is a range, it holds the minute component of the start date.
\fielditem{eventsecond}{datepart}
This field holds the second component of the \bibfield{eventdate} field. If the date is a range, it holds the second component of the start date.
\fielditem{eventtimezone}{datepart}
This field holds the timezone component of the \bibfield{eventdate} field. If the date is a range, it holds the timezone component of the start date.
\fielditem{eventday}{datepart}
This field holds the day component of the \bibfield{eventdate} field. If the date is a range, it holds the day component of the start date.
\fielditem{eventmonth}{datepart}
This field holds the month component of the \bibfield{eventdate} field. If the date is a range, it holds the month component of the start date.
\fielditem{eventyear}{datepart}
This field holds the year component of the \bibfield{eventdate} field. If the date is a range, it holds the year component of the start date.
\fielditem{eventseason}{datepart}
This field holds the season component of the \bibfield{eventdate} field as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). If the date is a range, it holds the season component of the start date.
\fielditem{eventendhour}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the hour component of the end date.
\fielditem{eventendminute}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the minute component of the end date.
\fielditem{eventendsecond}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the second component of the end date.
\fielditem{eventendtimezone}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the timezone component of the end date.
\fielditem{eventendday}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the day component of the end date.
\fielditem{eventendmonth}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the month component of the end date.
\fielditem{eventendyear}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the year component of the end date. A blank (but defined) \bibfield{eventendyear} component indicates an open ended \bibfield{eventdate} range.
\fielditem{eventendseason}{datepart}
If the date specification in the \bibfield{eventdate} field is a range, this field holds the season component of the end date as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). A blank (but defined) \bibfield{eventendseason} component indicates an open ended \bibfield{eventdate} range.
\fielditem{urlhour}{datepart}
This field holds the hour component of the \bibfield{urldate} field. If the date is a range, it holds the hour component of the start date.
\fielditem{urlminute}{datepart}
This field holds the minute component of the \bibfield{urldate} field. If the date is a range, it holds the minute component of the start date.
\fielditem{urlsecond}{datepart}
This field holds the second component of the \bibfield{urldate} field. If the date is a range, it holds the second component of the start date.
\fielditem{timezone}{urldatepart}
This field holds the timezone component of the \bibfield{urldate} field. If the date is a range, it holds the timezone component of the start date.
\fielditem{urlday}{datepart}
This field holds the day component of the \bibfield{urldate} field.
\fielditem{urlmonth}{datepart}
This field holds the month component of the \bibfield{urldate} field.
\fielditem{urlyear}{datepart}
This field holds the year component of the \bibfield{urldate} field.
\fielditem{urlseason}{datepart}
This field holds the season component of the \bibfield{urldate} field as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). If the date is a range, it holds the season component of the start date.
\fielditem{urlendhour}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the hour component of the end date.
\fielditem{urlendminute}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the minute component of the end date.
\fielditem{urlendsecond}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the second component of the end date.
\fielditem{urlendtimezone}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the timezone component of the end date.
\fielditem{urlendday}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the day component of the end date.
\fielditem{urlendmonth}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the month component of the end date.
\fielditem{urlendyear}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the year component of the end date. A blank (but defined) \bibfield{urlendyear} component indicates an open ended \bibfield{urldate} range.
\fielditem{urlendseason}{datepart}
If the date specification in the \bibfield{urldate} field is a range, this field holds the season component of the end date as specified by \acr{ISO8601-2} 4.7 (\secref{bib:use:dat}). It contains a season localisation string (\secref{aut:lng:key:dt}). A blank (but defined) \bibfield{urlendseason} component indicates an open ended \bibfield{urldate} range.
\end{fieldlist}
\subsection{Citation Styles}
\label{aut:cbx}
A citation style is a set of commands such as \cmd{cite} which print different types of citations. Such styles are defined in files with the suffix \file{cbx}. The \biblatex package loads the selected citation style file at the end of the package. Note that a small repertory of frequently used macros shared by several of the standard citation styles is also included in \path{biblatex.def}. This file is loaded at the end of the package as well, prior to the selected citation style. It also contains the definitions of the commands from \secref{use:cit:txt}.
\subsubsection{Citation Style Files}
\label{aut:cbx:cbx}
Before we go over the individual commands available in citation style files, consider this example of the overall structure of a typical \file{cbx} file:
\begin{ltxexample}
\ProvidesFile{example.cbx}[2006/03/15 v1.0 biblatex citation style]
\DeclareCiteCommand{\cite}{...}{...}{...}{...}
\DeclareCiteCommand{\parencite}[\mkbibparens]{...}{...}{...}{...}
\DeclareCiteCommand{\footcite}[\mkbibfootnote]{...}{...}{...}{...}
\DeclareCiteCommand{\textcite}{...}{...}{...}{...}
\endinput
\end{ltxexample}
\begin{ltxsyntax}
\cmditem{RequireCitationStyle}{style}
This command is optional and intended for specialized citation styles built on top of a more generic style. It loads the citation style \path{style.cbx}.
\cmditem{InitializeCitationStyle}{code}
Specifies arbitrary \prm{code} required to initialize or reset the citation style. This hook will be executed once at package load-time and every time the \cmd{citereset} command from \secref{use:cit:msc} is used. The \cmd{citereset} command also resets the internal citation trackers of this package. The reset will affect the \cmd{ifciteseen}, \cmd{ifentryseen}, \cmd{ifciteibid}, and \cmd{ifciteidem} tests discussed in \secref{aut:aux:tst}. When used in a \env{refsection} environment, the reset of the citation tracker is local to the current \env{refsection} environment.
\cmditem{OnManualCitation}{code}
Specifies arbitrary \prm{code} required for a partial reset of the citation style. This hook will be executed every time the \cmd{mancite} command from \secref{use:cit:msc} is used. It is particularly useful in citation styles which replace repeated citations by abbreviations like <ibidem> or <op. cit.> which may get ambiguous if automatically generated and manual citations are mixed. The \cmd{mancite} command also resets the internal <ibidem> and <idem> trackers of this package. The reset will affect the \cmd{ifciteibid} and \cmd{ifciteidem} tests discussed in \secref{aut:aux:tst}.
\cmditem{DeclareCiteCommand}{command}[wrapper]{precode}{loopcode}{sepcode}{postcode} \cmditem*{DeclareCiteCommand*}{command}[wrapper]{precode}{loopcode}{sepcode}{postcode}
This is the core command used to define all citation commands. It takes one optional and five mandatory arguments. The \prm{command} is the command to be defined, for example \cmd{cite}. If the optional \prm{wrapper} argument is given, the entire citation will be passed to the \prm{wrapper} as an argument, \ie the wrapper command must take one mandatory argument.\footnote{Typical examples of wrapper commands are \cmd{mkbibparens} and \cmd{mkbibfootnote}.} The \prm{precode} is arbitrary code to be executed at the beginning of the citation. It will typically handle the \prm{prenote} argument which is available in the \bibfield{prenote} field. It may also be used to initialize macros required by the \prm{loopcode}. The \prm{loopcode} is arbitrary code to be executed for each entry key passed to the \prm{command}. This is the core code which prints the citation labels or any other data. The \prm{sepcode} is arbitrary code to be executed after each iteration of the \prm{loopcode}. It will only be executed if a list of entry keys is passed to the \prm{command}. The \prm{sepcode} will usually insert some kind of separator, such as a comma or a semicolon. The \prm{postcode} is arbitrary code to be executed at the end of the citation. The \prm{postcode} will typically handle the \prm{postnote} argument which is available in the \bibfield{postnote} field.\footnote{The bibliographic data available to the \prm{loopcode} is the data of the entry currently being processed. In addition to that, the data of the first entry is available to the \prm{precode} and the data of the last one is available to the \prm{postcode}. <First> and <last> refer to the order in which the citations are printed. If the \opt{sortcites} package option is active, this is the order of the list after sorting. Note that no bibliographic data is available to the \prm{sepcode}.} The starred variant of \cmd{DeclareCiteCommand} defines a starred \prm{command}. For example, |\DeclareCiteCommand*{cite}| would define |\cite*|.\footnote{Note that the regular variant of \cmd{DeclareCiteCommand} defines a starred version of the \prm{command} implicitly, unless the starred version has been defined before. This is intended as a fallback. The implicit definition is an alias for the regular variant.}
\cmditem{DeclareMultiCiteCommand}{command}[wrapper]{cite}{delimiter}
This command defines <multicite> commands (\secref{use:cit:mlt}). The \prm{command} is the multicite command to be defined, for example \cmd{cites}. It is automatically made robust. Multicite commands are built on top of backend commands defined with \cmd{DeclareCiteCommand} and the \prm{cite} argument specifies the name of the backend command to be used. Note that the wrapper of the backend command (\ie the \prm{wrapper} argument passed to \cmd{DeclareCiteCommand}) is ignored. Use the optional \prm{wrapper} argument to specify an alternative wrapper. The \prm{delimiter} is the string to be printed as a separator between the individual citations in the list. This will typically be \cmd{multicitedelim}. The following examples are real definitions taken from \path{biblatex.def}:
\begin{ltxexample}
\DeclareMultiCiteCommand{\cites}%
{\cite}{\multicitedelim}
\DeclareMultiCiteCommand{\parencites}[\mkbibparens]%
{\parencite}{\multicitedelim}
\DeclareMultiCiteCommand{\footcites}[\mkbibfootnote]%
{\footcite}{\multicitedelim}
\end{ltxexample}
\cmditem{DeclareAutoCiteCommand}{name}[position]{cite}{multicite}
This command provides definitions for the \cmd{autocite} and \cmd{autocites} commands from \secref{use:cit:aut}. The definitions are enabled with the \opt{autocite} package option from \secref{use:opt:pre:gen}. The \prm{name} is an identifier which serves as the value passed to the package option. The autocite commands are built on top of backend commands like \cmd{parencite} and \cmd{parencites}. The arguments \prm{cite} and \prm{multicite} specify the backend commands to use. The \prm{cite} argument refers to \cmd{autocite} and \prm{multicite} refers to \cmd{autocites}. The \prm{position} argument controls the handling of any punctuation marks after the citation. Possible values are \texttt{l}, \texttt{r}, \texttt{f}. \texttt{r} means that the punctuation is placed to the right of the citation, \ie it will not be moved around. \texttt{l} means that any punctuation after the citation is moved to the left of the citation. \texttt{f} is like \texttt{r} in a footnote and like \texttt{l} otherwise. This argument is optional and defaults to \texttt{r}. See also \cmd{DeclareAutoPunctuation} in \secref{aut:pct:cfg} and the \opt{autopunct} package option in \secref{use:opt:pre:gen}. The following examples are real definitions taken from \path{biblatex.def}:
\begin{ltxexample}
\DeclareAutoCiteCommand{plain}{\cite}{\cites}
\DeclareAutoCiteCommand{inline}{\parencite}{\parencites}
\DeclareAutoCiteCommand{footnote}[l]{\footcite}{\footcites}
\DeclareAutoCiteCommand{footnote}[f]{\smartcite}{\smartcites}
\end{ltxexample}
%
A definition provided in the document preamble can be subsequently adopted with the following: (see \secref{use:cfg:opt}).
\begin{ltxexample}
\ExecuteBibliographyOptions{autocite=<<name>>}
\end{ltxexample}
\cmditem{DeclareCitePunctuationPosition}{command}{position}
Set up the cite command \prm{command} to move punctuation marks after the citation like \cmd{autocite}. The \prm{position} argument can take the values \opt{r}, \opt{l}, \opt{f}, \opt{c}, \opt{o} and \opt{d}.
If an unknown \prm{position} identifier is used, it defaults to \opt{o}.
\begin{valuelist}
\item[r] The punctuation mark is not moved and remains to the right of the citation.
\item[l] The punctuation mark is moved to the left of the citation and thus appears before it.
\item[f] Like \opt{r} in footnotes and like \opt{l} otherwise.
\item[c] Pass the punctuation on to the internal implementation of the citation commands. It will then be executed within the \prm{wrapper} command if given.
\item[o] Retain the default setup of \opt{c} for citation defined commands without \prm{wrapper} command and \opt{l} for citation commands defined with a \prm{wrapper} command.
\item[d] Drop the explicit punctuation mark. It will only be available as the field \bibfield{postpunct}.
\end{valuelist}
%
This command can not be used for \cmd{autocite}, to configure \cmd{autocite} use the optional \prm{position} argument for \cmd{DeclareAutoCiteCommand}.
\end{ltxsyntax}
\subsubsection{Special Fields}
\label{aut:cbx:fld}
The following fields are used by \biblatex to pass data to citation commands. They are not used in \file{bib} files but defined automatically by the package. From the perspective of a citation style, they are not different from the fields in a \file{bib} file. See also \secref{aut:bbx:fld}.
\begin{fieldlist}
\fielditem{prenote}{literal}
The \prm{prenote} argument passed to a citation command. This field is specific to citations and not available in the bibliography. If the \prm{prenote} argument is missing or empty, this field is undefined.
\fielditem{postnote}{literal}
The \prm{postnote} argument passed to a citation command. This field is specific to citations and not available in the bibliography. If the \prm{postnote} argument is missing or empty, this field is undefined.
\fielditem{multiprenote}{literal}
The \prm{multiprenote} argument passed to a multicite command. This field is specific to citations and not available in the bibliography. If the \prm{multiprenote} argument is missing or empty, this field is undefined.
\fielditem{multipostnote}{literal}
The \prm{multipostnote} argument passed to a multicite command. This field is specific to citations and not available in the bibliography. If the \prm{multipostnote} argument is missing or empty, this field is undefined.
\fielditem{volcitevolume}{literal}
The \prm{volume} argument passed to \cmd{volcite} or a related citation command (\secref{use:cit:spc}). This field is specific to \cmd{volcite} citations and not available in the bibliography or other citations.
\fielditem{volcitepages}{literal}
The \prm{pages} argument passed to \cmd{volcite} or a related citation command (\secref{use:cit:spc}). This field is specific to \cmd{volcite} citations and not available in the bibliography or other citations. If the \prm{pages} argument is missing or empty, this field is undefined.
\fielditem{postpunct}{punctuation command}
The trailing punctuation argument implicitly passed to a citation command. This field is specific to citations and not available in the bibliography. If the character following a given citation command is not specified in \cmd{DeclareAutoPunctuation} (\secref{aut:pct:cfg}), this field is undefined.
\end{fieldlist}
\subsection{Data Interface}
\label{aut:bib}
The data interface are the facilities used to format and print all bibliographic data. These facilities are available in both bibliography and citation styles.
\subsubsection{Data Commands}
\label{aut:bib:dat}
This section introduces the main data interface of the \biblatex package. These are the commands doing most of the work, \ie they actually print the data provided in lists and fields.
\begin{ltxsyntax}
\cmditem{DeprecateField}{field}{message}
\cmditem{DeprecateList}{list}{message}
\cmditem{DeprecateName}{name}{message}
When an attempt is made to print \prm{field}, \prm{list}, \prm{name}, a
deprecation warning is issued with the additional \prm{message}. This aids
style authors who are changing field names in their style. Note that the
deprecated item must no longer be defined in the datamodel for this work;
\prm{field}, \prm{list} or \prm{name} cannot be listed anywhere as an
argument to \cmd{DeclareDatamodelFields}.
\cmditem{DeprecateFieldWithReplacement}{field}{replacement}
\cmditem{DeprecateListWithReplacement}{list}{replacement}
\cmditem{DeprecateNameWithReplacement}{name}{replacement}
Similar to \cmd{DeprecateField}, \cmd{DeprecateList} and \cmd{DeprecateName}.
The commands do not only issue a deprecation warning,
they try to define a replacement for the deprecated field
that is printed in its stead.
The \cmd{replacement} must be of the same type as the deprecated
\prm{field}, \prm{list} or \prm{name}.
If the formatting of \prm{replacement} should be applied when printing
the deprecated field, that needs to be requested with \cmd{DeclareFieldAlias}
(see \secref{aut:bib:fmt}).
Note that the deprecated item must no longer be defined in the datamodel
for this work; \prm{field}, \prm{list} or \prm{name} cannot be listed
anywhere as an argument to \cmd{DeclareDatamodelFields}.
\cmditem{printfield}[format]{field}
This command prints a \prm{field} using the formatting directive \prm{format}, as defined with \cmd{DeclareFieldFormat}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{field} is undefined, nothing is printed. If the \prm{format} is omitted, \cmd{printfield} tries using the name of the field as a format name. For example, if the \bibfield{title} field is to be printed and the \prm{format} is not specified, it will try to use the field format \texttt{title}.\footnote{In other words, \texttt{\textbackslash printfield\{title\}} is equivalent to \texttt{\textbackslash printfield[title]\{title\}}.} In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort. Note that \cmd{printfield} provides the name of the field currently being processed in \cmd{currentfield} for use in field formatting directives.
\cmditem{printlist}[format][start\ensuremath\rangle--\ensuremath\langle stop]{literal list}
This command loops over all items in a \prm{literal list}, starting at item number \prm{start} and stopping at item number \prm{stop}, including \prm{start} and \prm{stop} (all lists are numbered starting at~1). Each item is printed using the formatting directive \prm{format}, as defined with \cmd{DeclareListFormat}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{literal list} is undefined, nothing is printed. If the \prm{format} is omitted, \cmd{printlist} tries using the name of the list as a format name. In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort. The \prm{start} argument defaults to 1; \prm{stop} defaults to the total number of items in the list. If the total number is greater than \prm{maxitems}, \prm{stop} defaults to \prm{minitems} (see \secref{use:opt:pre:gen}). See \cmd{printnames} for further details. Note that \cmd{printlist} provides the name of the literal list currently being processed in \cmd{currentlist} for use in list formatting directives.
\cmditem{printnames}[format][start\ensuremath\rangle--\ensuremath\langle stop]{name list}
This command loops over all items in a \prm{name list}, starting at item number \prm{start} and stopping at item number \prm{stop}, including \prm{start} and \prm{stop} (all lists are numbered starting at~1). Each item is printed using the formatting directive \prm{format}, as defined with \cmd{DeclareNameFormat}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{name list} is undefined, nothing is printed. If the \prm{format} is omitted, \cmd{printnames} tries using the name of the list as a format name. In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort. The \prm{start} argument defaults to 1; \prm{stop} defaults to the total number of items in the list. If the total number is greater than \prm{maxnames}, \prm{stop} defaults to \prm{minnames} (see \secref{use:opt:pre:gen}). If you want to select a range but use the default list format, the first optional argument must still be given, but is left empty:
\begin{ltxexample}
\printnames[][1-3]{...}
\end{ltxexample}
One of \prm{start} and \prm{stop} may be omitted, hence the following arguments are all valid:
\begin{ltxexample}
\printnames[...][-1]{...}
\printnames[...][2-]{...}
\printnames[...][1-3]{...}
\end{ltxexample}
If you want to override \prm{maxnames} and \prm{minnames} and force printing of the entire list, you may refer to the \cnt{listtotal} counter in the second optional argument:
\begin{ltxexample}
\printnames[...][-\value{listtotal}]{...}
\end{ltxexample}
Whenever \cmd{printnames} and \cmd{printlist} process a list, information concerning the current state is accessible by way of four counters: the \cnt{listtotal} counter holds the total number of items in the current list, \cnt{listcount} holds the number of the item currently being processed, \cnt{liststart} is the \prm{start} argument passed to \cmd{printnames} or \cmd{printlist}, \cnt{liststop} is the \prm{stop} argument. These counters are intended for use in list formatting directives. \cnt{listtotal} may also be used in the second optional argument to \cmd{printnames} and \cmd{printlist}. Note that these counters are local to list formatting directives and do not hold meaningful values when used anywhere else. For every list, there is also a counter by the same name which holds the total number of items in the corresponding list. For example, the \cnt{author} counter holds the total number of items in the \bibfield{author} list. These counters are similar to \cnt{listtotal} except that they may also be used independently of list formatting directives. There are also \cnt{maxnames} and \cnt{minnames} as well as \cnt{maxitems} and \cnt{minitems} counters which hold the values of the corresponding package options. See \secref{aut:fmt:ilc} for a complete list of such internal counters. Note that \cmd{printnames} provides the name of the name list currently being processed in \cmd{currentname} for use in name formatting directives.
\cmditem{printtext}[format]{text}
This command prints \prm{text}, which may be printable text or arbitrary code generating printable text. It clears the punctuation buffer before inserting \prm{text} and informs \biblatex that printable text has been inserted. This ensures that all preceding and following \cmd{newblock} and \cmd{newunit} commands have the desired effect. \cmd{printfield} and \cmd{printnames} as well as \cmd{bibstring} and its companion commands (see \secref{aut:str}) do that automatically. Using this command is required if a bibliography styles inserts literal text (including the commands from \secref{aut:pct:pct, aut:pct:spc}) to ensure that block and unit punctuation works as advertised in \secref{aut:pct:new}. The optional \prm{format} argument specifies a field formatting directive to be used to format \prm{text}. This may also be useful when several fields are to be printed as one chunk, for example, by enclosing the entire chunk in parentheses or quotation marks. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{format} is omitted, the \prm{text} is printed as is. See also \secref{aut:cav:pct} for some practical hints.
\cmditem{printfile}[format]{file}
This command is similar to \cmd{printtext} except that the second argument is a file name rather than literal text. The \prm{file} argument must be the name of a valid \latex file found in \tex's search path. \cmd{printfile} will use \cmd{input} to load this \prm{file}. If there is no such file, \cmd{printfile} does nothing. The optional \prm{format} argument specifies a field formatting directive to be applied to the \prm{file}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{format} is omitted, the \prm{file} is printed as is. Note that this feature needs to be enabled explicitly by setting the package option \opt{loadfiles} from \secref{use:opt:pre:gen}. By default, \cmd{printfile} will not input any files.
\csitem{printdate}
This command prints the date of the entry, as specified in the fields \bibfield{date} or \bibfield{month}\slash \bibfield{year}. The date format is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. Additional formatting (fonts etc.) may be applied by adjusting the field format \texttt{date} (\secref{aut:fmt:ich}). Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command.
\csitem{printdateextra}
Similar to \cmd{printdate} but incorporates the \bibfield{extradate} field in the date specification. This is useful for bibliography styles designed for author-year citations.
\csitem{printlabeldate}
Similar to \cmd{printdate} but prints the date field determined by \cmd{DeclareLabeldate}. The date format is controlled by the package option \opt{labeldate} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{labeldate} (\secref{aut:fmt:ich}).
\csitem{printlabeldateextra}
Similar to \cmd{printlabeldate} but incorporates the \bibfield{extradate} field in the date specification. This is useful for bibliography styles designed for author-year citations.
\csitem{print$<$datetype$>$date}
As \cmd{printdate} but prints the \bibfield{$<$datetype$>$date} of the entry. The date format is controlled by the package option \opt{$<$datetype$>$date} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{$<$datetype$>$date} (\secref{aut:fmt:ich}). The $<$datetype$>$s in the default data model are <> (for the main \bibfield{date} field), <orig>, <event> and <url>.
\csitem{printtime}
This command prints the time range of the entry, as specified in the \bibfield{date} field (see \secref{bib:use:dat}). The time format is controlled by the package option \opt{time} from \secref{use:opt:pre:gen}. Additional formatting (fonts etc.) may be applied by adjusting the field format \texttt{time} (\secref{aut:fmt:ich}). Relevant to time formatting are the \opt{timezeros} option and the \cmd{bibtimesep} and \cmd{bibtimezonesep} macros (\secref{use:fmt:lng}). Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. Note that this command prints a stand-alone time range apart from the date elements. With the \opt{$<$datepart$>$dateusetime} option, you can have the printed along with a date when printing a date range instead of printing the time range completely separately, which is what this command allows for.
\csitem{print$<$datetype$>$time}
As \cmd{printtime} but prints the \bibfield{$<$datetype$>$time} of the entry. The time format is controlled by the package option \opt{$<$datetype$>$time} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{$<$datetype$>$time} (\secref{aut:fmt:ich}). The $<$datetype$>$s in the default data model are <> (for the main \bibfield{date} field), <orig>, <event> and <url>.
\cmditem{indexfield}[format]{field}
This command is similar to \cmd{printfield} except that the \prm{field} is not printed but added to the index using the formatting directive \prm{format}, as defined with \cmd{DeclareIndexFieldFormat}. If a type"=specific \prm{format} has been declared, it takes precedence over the generic one. If the \prm{field} is undefined, this command does nothing. If the \prm{format} is omitted, \cmd{indexfield} tries using the name of the field as a format name. In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort.
\cmditem{indexlist}[format][start\ensuremath\rangle--\ensuremath\langle stop]{literal list}
This command is similar to \cmd{printlist} except that the items in the list are not printed but added to the index using the formatting directive \prm{format}, as defined with \cmd{DeclareIndexListFormat}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{literal list} is undefined, this command does nothing. If the \prm{format} is omitted, \cmd{indexlist} tries using the name of the list as a format name. In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort.
\cmditem{indexnames}[format][start\ensuremath\rangle--\ensuremath\langle stop]{name list}
This command is similar to \cmd{printnames} except that the items in the list are not printed but added to the index using the formatting directive \prm{format}, as defined with \cmd{DeclareIndexNameFormat}. If a type"=specific \prm{format} has been declared, the type"=specific formatting directive takes precedence over the generic one. If the \prm{name list} is undefined, this command does nothing. If the \prm{format} is omitted, \cmd{indexnames} tries using the name of the list as a format name. In this case, any type"=specific formatting directive will also take precedence over the generic one. If all of these formats are undefined, it falls back to \texttt{default} as a last resort.
\cmditem{entrydata}{key}{code}
\cmditem*{entrydata*}{key}{code}
Data commands like \cmd{printfield} normally use the data of the entry currently being processed. You may use \cmd{entrydata} to switch contexts locally. The \prm{key} is the entry key of the entry to use locally. The \prm{code} is arbitrary code to be executed in this context. This code will be executed in a group. See \secref{aut:cav:mif} for an example. Note that this command will automatically switch languages if the \opt{autolang} package option is enabled. The starred version \cmd{entrydata*} will clone all fields of the enclosing entry, using field, counter, and other resource names prefixed with the string <\texttt{saved}>. This is useful when comparing two data sets. For example, inside the \prm{code} argument, the \bibfield{author} field holds the author of entry \prm{key} and the author of the enclosing entry is available as \bibfield{savedauthor}. The \cnt{author} counter holds the number of names in the \bibfield{author} field of \prm{key}; the \bibfield{savedauthor} counter refers to the author count of the enclosing entry.
\cmditem{entryset}{precode}{postcode}
This command is intended for use in bibliography drivers handling \bibtype{set} entries. It will loop over all members of the set, as indicated by the \bibfield{entryset} field, and execute the appropriate driver for the respective set member. This is similar to executing the \cmd{usedriver} command from \secref{aut:aux:msc} for each set member. The \prm{precode} is arbitrary code to be executed prior to processing each item in the set. The \prm{postcode} is arbitrary code to be executed immediately after processing each item. Both arguments are mandatory in terms of the syntax but may be left empty. See \secref{aut:cav:set} for usage examples.
\cmditem{DeclareFieldInputHandler}{field}{code}
This command can be used to define a data input handler for \prm{field} when it is read from the \file{.bbl}. The \prm{code} is passed one argument (\lstinline{#1}), which contains the input field value, it should then redefine the command \cmd{NewValue}, which holds the desired output field value. For example, to ignore the \bibfield{volumes} field when it appears, you could do
\begin{ltxexample}
\DeclareFieldInputHandler{volumes}{\def\NewValue{}}
\end{ltxexample}
%
Generally, you would want to use \cmd{DeclareSourcemap} (see \secref{aut:ctm:map}) to remove and modify fields but this alternative method may be useful in some circumstances when the emphasis is on appearance rather than data since the \prm{code} can be arbitraty \tex.
In general, \cmd{DeclareFieldInputHandler} should not be used to apply formatting to a field, since that should happen with \cmd{DeclareFieldFormat}, so the following is just a toy example that shows how \cmd{DeclareFieldInputHandler} works.
\begin{ltxexample}
\DeclareFieldInputHandler{volumes}{\def\NewValue{\textbf{#1}}}
\end{ltxexample}
\cmditem{DeclareListInputHandler}{list}{code}
As \cmd{DeclareFieldInputHandler} but for lists. Within the \prm{code}, the macro \cmd{NewValue}
contains the value of the list and \cmd{NewCount} contains the number of items in the list.
Note that \cmd{NewValue} as well as the single argument to \prm{code} contain the internal representation of the list.
\cmditem{DeclareNameInputHandler}{name}{code}
As \cmd{DeclareFieldInputHandler} but for names. Within the \prm{code}, the macro \cmd{NewValue}
contains the value of the name, \cmd{NewCount} contains the number of individual names in the name and \cmd{NewOption} contains any per-name options passed in the \file{.bbl}.
Note that \cmd{NewValue} as well as the single argument to \prm{code} contain the internal representation of the name list.
\end{ltxsyntax}
\subsubsection{Formatting Directives}
\label{aut:bib:fmt}
This section introduces the commands used to define the formatting directives required by the data commands from \secref{aut:bib:dat}. Note that all standard formats are defined in \path{biblatex.def}.
\begin{ltxsyntax}
\cmditem{DeclareFieldFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareFieldFormat}*{format}{code}
Defines the field format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed by \cmd{printfield}. The value of the field will be passed to the \prm{code} as its first and only argument. The name of the field currently being processed is available to the \prm{code} as \cmd{currentfield}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareListFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareListFormat}*{format}{code}
Defines the literal list format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed for every item in a list processed by \cmd{printlist}. The current item will be passed to the \prm{code} as its first and only argument. The name of the literal list currently being processed is available to the \prm{code} as \cmd{currentlist}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. Note that the formatting directive also handles the punctuation to be inserted between the individual items in the list. You need to check whether you are in the middle of or at the end of the list, \ie whether \cnt{listcount} is smaller than or equal to \cnt{liststop}. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareNameFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareNameFormat}*{format}{code}
Defines the name list format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed for every name in a list processed by \cmd{printnames}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The individual parts of a name will be available in automatically created macros (see below). The default data mode defines four name part which correspond to the standard \bibtex name parts arguments:
\begin{argumentlist}{00}
\item[family] The family name(s), know as <last> in \bibtex. If a name consists of a single part only (for example, <Aristotle>), this part will be treated as the family name.
\item[given] The given name(s). Note that given names are referred to as the <first> names in the \bibtex file format documentation.
\item[prefix] Any name prefices, for example von, van, of, da, de, del, della, etc. Note that name prefices are referred to as the <von> part of the name in the \bibtex file format documentation.
\item[suffix] Any name suffices, for example Jr, Sr. Note that name suffices are referred to as the <Jr> part of the name in the \bibtex file format documentation.
\end{argumentlist}
%
The value of the datamodel <nameparts> constant (see \secref{aut:bbx:drv}) creates two macros for each name part in the datamodel for the name. So, for example, in the default data model, name formats will have defined the following macros:
\begin{ltxexample}
\namepartprefix
\namepartprefixi
\namepartfamily
\namepartfamilyi
\namepartsuffix
\namepartsuffixi
\namepartgiven
\namepartgiveni
\end{ltxexample}
%
If a certain part of a name is not available, the corresponding macro will be empty, hence you may use, for example, the \sty{etoolbox} tests like \cmd{ifdefvoid} to check for the individual parts of a name. The name of the name list currently being processed is available to the \prm{code} as \cmd{currentname}. Note that the formatting directive also handles the punctuation to be inserted between separate names and between the individual parts of a name. You need to check whether you are in the middle of or at the end of the list, \ie whether \cnt{listcount} is smaller than or equal to \cnt{liststop}. See also \secref{use:cav:nam}. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareListWrapperFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareListWrapperFormat}*{format}{code}
Defines the list wrapper format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed once for the entire list processed by \cmd{printlist}. The name of the literal list currently being processed is available to the \prm{code} as \cmd{currentlist}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareNameWrapperFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareNameWrapperFormat}*{format}{code}
Defines the list wrapper format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed once for the entire name list processed by \cmd{printnames}. The name of the literal list currently being processed is available to the \prm{code} as \cmd{currentname}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareIndexFieldFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareIndexFieldFormat}*{format}{code}
Defines the field format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed by \cmd{indexfield}. The value of the field will be passed to the \prm{code} as its first and only argument. The name of the field currently being processed is available to the \prm{code} as \cmd{currentfield}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. This command is similar to \cmd{DeclareFieldFormat} except that the data handled by the \prm{code} is not intended to be printed but written to the index. Note that \cmd{indexfield} will execute the \prm{code} as is, \ie the \prm{code} must include \cmd{index} or a similar command. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareIndexListFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareIndexListFormat}*{format}{code}
Defines the literal list format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed for every item in a list processed by \cmd{indexlist}. The current item will be passed to the \prm{code} as its only argument. The name of the literal list currently being processed is available to the \prm{code} as \cmd{currentlist}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. This command is similar to \cmd{DeclareListFormat} except that the data handled by the \prm{code} is not intended to be printed but written to the index. Note that \cmd{indexlist} will execute the \prm{code} as is, \ie the \prm{code} must include \cmd{index} or a similar command. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareIndexNameFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareIndexNameFormat}*{format}{code}
Defines the name list format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed for every name in a list processed by \cmd{indexnames}. The name of the name list currently being processed is available to the \prm{code} as \cmd{currentname}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The parts of the name will be passed to the \prm{code} as separate arguments. This command is very similar to \cmd{DeclareNameFormat} except that the data handled by the \prm{code} is not intended to be printed but written to the index. Note that \cmd{indexnames} will execute the \prm{code} as is, \ie the \prm{code} must include \cmd{index} or a similar command. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareFieldAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the field format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareListAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the literal list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareNameAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the name list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareListWrapperAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the outer list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareNameWrapperAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the outer name list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareIndexFieldAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the field format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareIndexListAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the literal list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeclareIndexNameAlias}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the name list format \prm{format}. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeprecateFieldFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Declares \prm{alias} to be an alias for the name list format \prm{format} and issue a deprecation warning. If an \prm{entrytype} is specified, the alias is specific to that type. The \prm{format entry type} is the entry type of the backend format. This is only required when declaring an alias for a type"=specific formatting directive.
\cmditem{DeprecateListFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for list formats.
\cmditem{DeprecateNameFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for name formats.
\cmditem{DeprecateListWrapperFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for outer list formats.
\cmditem{DeprecateNameWrapperFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for outer name formats.
\cmditem{DeprecateIndexFieldFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for index field formats.
\cmditem{DeprecateIndexListFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for index list formats.
\cmditem{DeprecateIndexNameFormatWithReplacement}[entry type]{alias}[format entry type]{format}
Similar to \cmd{DeprecateFieldFormatWithReplacement} but for index name formats.
\end{ltxsyntax}
\subsection{Customization}
\label{aut:ctm}
\subsubsection{Related Entries}
\label{aut:ctm:rel}
The related entries feature comprises the following components:
\begin{itemize}
\item Special fields in an entry to set up and describe relationships
\item Optionally, localisation strings to prefix the related data
\item Macros to extract and print the related data
\item Formats to format the localisation string and related data
\end{itemize}
%
The special fields are \bibfield{related}, \bibfield{relatedtype}, \bibfield{relatedstring} and \bibfield{relatedoptions}:
\begin{keymarglist}
\item[related] A separated list of keys of entries which are related to this entry in some way. Note the order of the keys is important. The data from multiple related entries is printed in the order of the keys listed in this field.
\item[relatedtype] The type of relationship. This serves three purposes. If the value of this field resolves to a localisation string identifier, then the resulting localised string is printed before the data from the related entries. Secondly, if there is a macro called \texttt{related:\prm{relatedtype}}, this is used to format the data from the related entries. If no such macro exists, then the macro \texttt{related:default} is used. Lastly, if there is a format named \texttt{related:\prm{relatedtype}}, then it is used to format both the localised string and related entry data. If there is no related type specific format, the \texttt{related} format is used.
\item[relatedstring] If an entry contains this field, then if value of the field resolves to a localisation string identifier, the localisation key value specified is printed before data from the related entries. If the field does not specify a localisation key, its value is printed literally. If both \bibfield{relatedtype} and \bibfield{relatedstring} are present in an entry, \bibfield{relatedstring} is used for the pre-data string (but \bibfield{relatedtype} is still used to determine the macro and format to use when printing the data).
\item[relatedoptions] A list of per"=entry options to set on the related entry (actually on the clone of the related entry which is used as a data source---the actual related entry is not modified because it might be cited directly itself).
\end{keymarglist}
The related entry feature is enabled by default by the package option \opt{related} from \secref{use:opt:pre:gen}. The related information entry data from the related entries is included via a \cmd{usebibmacro\{related\}} call. Standard styles call this macro towards the end of each driver. Style authors should ensure the existence of (or take note of existing) localisation strings which are useful as values for the \bibfield{relatedtype} field, such as \texttt{translationof} or perhaps \texttt{translatedas}. A plural variant can be identified with the localisation key \prm{relatedtype}\texttt{s}. This key's corresponding string is printed whenever more than one entry is specified in \bibfield{related}. Bibliography macros and formatting directives for printing entries related by \prm{relatedtype} should be defined using the name \texttt{related:\prm{relatedtype}}. The file \path{biblatex.def} contains macros and formats for some common relation types which can be used as templates. In particular, the \cmd{entrydata*} command is essential in such macros in order to make the data of the related entries available. Examples of entries using this feature can be found in the \biblatex distribution examples file \path{biblatex-examples.bib}. There are some specific formatting macros for this feature which control delimiters and separators in related entry information, see \secref{aut:fmt:fmt}.
\subsubsection{Datasource Sets}
\label{aut:ctm:dsets}
It is useful to be able to define named sets of datasource field names for use in loops etc. In addition, \biber can use such sets in order to apply options and perform operations on particular sets of datasource fields. The following macros allow the user to define arbitrary sets of datasource fields, exposed to \biblatex as \sty{etoolbox} lists and to \biber in the \file{.bcf}.
\begin{ltxsyntax}
\cmditem{DeclareDatafieldSet}{name}{specification}
Declare a set of datasource fields with name \prm{name}.
\begin{optionlist*}
\valitem{name}{set name}
The name of the set.
\end{optionlist*}
The \prm{specification} is one or more \cmd{member} items:
\cmditem{member}
\begin{optionlist*}
\valitem{fieldtype}{fieldtype}
\valitem{datatype}{datatype}
\valitem{field}{fieldname}
\end{optionlist*}
A \cmd{member} specification appends fields to the set. Fields can be specified by datamodel \prm{fieldtype} and/or \prm{datatype} (see \secref{aut:ctm:dm}). Alternatively, fields can be explicitly added by name using the \prm{field} option. Once defined, the set is available as an \sty{etoolbox} list called \cmd{datafieldset<setname>} and is also passed via the \file{.bcf} to \biber.
For example, here are the default sets defined by \biblatex for name fields and title fields:
\end{ltxsyntax}
\begin{ltxexample}[style=latex]
\DeclareDatafieldSet{setnames}{
\member[datatype=name, fieldtype=list]
}
\DeclareDatafieldSet{settitles}{
\member[field=title]
\member[field=booktitle]
\member[field=eventtitle]
\member[field=issuetitle]
\member[field=journaltitle]
\member[field=maintitle]
\member[field=origtitle]
}
\end{ltxexample}
%
This defines the macros \cmd{datafieldsetsetnames} and \cmd{datafieldsetsettitles} as \sty{etoolbox} lists containing the names of the member datasource fields specified.
\subsubsection{Dynamic Modification of Data}
\label{aut:ctm:map}
Bibliographic data sources which are automatically generated or which you have no control over can be a problem if you need to edit them in some way. For this reason, \biber has the ability to modify data as it is read so that you can apply modifications to the source data stream without actually changing it. The modification can be defined in \biber's config file (see \biber docs), or via \biblatex macros in which case you can apply the modification only for specific documents, styles or globally.
Source mapping happens during data parsing and therefore before any other operation such as inheritance and sorting.
Source mappings can be defined at different «levels» which are applied
in a defined order. See the \biblatex\ manual regarding these macros:\\[2ex]
\noindent \texttt{user}-level maps defined with \cmd{DeclareSourcemap}$\rightarrow$\\
\hspace*{1em}\texttt{user}-level maps defined in the \biber config file (see \biber docs)$\rightarrow$\\
\hspace*{2em}\texttt{style}-level maps defined with \cmd{DeclareStyleSourcemap}$\rightarrow$\\
\hspace*{3em}\texttt{driver}-level maps defined with \cmd{DeclareDriverSourcemap}\\[2ex]
\begin{ltxsyntax}
\cmditem{DeclareSourcemap}{specification}
Defines source data modification (mapping) rules which can be used to perform any combination of the following tasks:
\begin{itemize}
\item Map data source entrytypes to different entrytypes
\item Map datasource fields to different fields
\item Add new fields to an entry
\item Remove fields from an entry
\item Modify the contents of a field using standard Perl regular expression
match and replace\footnote{See for example \url{https://perldoc.perl.org/perlretut.html}, \url{https://perldoc.perl.org/perlrequick.html} and \url{https://perldoc.perl.org/perlre.html}. There are many more resources available about regular expessions in Perl.}
\item Restrict any of the above operations to entries coming from
particular datasources which you defined in \cmd{addresource} macros
\item Restrict any of the above operations to entries only of a certain
entrytype
\item Restrict any of the above operations to entries in a particular
reference section
\end{itemize}
The \prm{specification} is an undelimited list of \cmd{maps} directives which specify containers for mappings rules applying to a particular data source type (\secref{use:bib:res}). Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble and can be used multiple times, the maps being run in order of definition.
\cmditem{maps}[options]{elements}
Contains an ordered set of \cmd{map} elements each of which is a logically related set of mapping steps to apply to the data source. The \prm{options} are:
\begin{optionlist*}
\choitem[bibtex]{datatype}{bibtex, biblatexml}
Data source type to which the contained \cmd{map} directives apply (\secref{use:bib:res}).
\boolitem[false]{overwrite}
Specify whether a mapping rule is allowed to overwrite already existing data in an entry. If this option is not specified, the default is \texttt{false}. The short form \opt{overwrite} is equivalent to \kvopt{overwrite}{true}.
\end{optionlist*}
\cmditem{map}[options]{restrictions,steps}
A container for an ordered set of map \cmd{step}s, optionally restricted to particular entrytypes or data sources. This is a grouping element to allow a set of mapping steps to apply only to specific entrytypes or data sources. Mapping steps must always be contained within a \cmd{map} element. The \prm{options} are:
\begin{optionlist*}
\boolitem{overwrite}
As the same option on the parent \cmd{maps} element. This option allows an override on a per-map group basis. If this option is not specified, the default is the parent \cmd{maps} element option value. The short form \opt{overwrite} is equivalent to \kvopt{overwrite}{true}.
\valitem{foreach}{loopval}
Loop over all \cmd{step}s in this \cmd{map}, setting the special variable |$MAPLOOP| %$
to each of the comma-separated values contained in \prm{loopval}. \prm{loopval} can either be the name of a datafield set defined with \cmd{DeclareDatafieldSet} (see \secref{aut:ctm:dsets}), a datasource field which is fetched and parsed as a comma"=separated values list or an explicit comma"=separated values list. \prm{loopval} is determined in this order. This allows the user to repeat a group of \cmd{step}s for each value \prm{loopval}. Using regexp maps, it is possible to create a CSV field for use with this functionality. The special variable |$MAPUNIQ| %$
may also be used in the \cmd{step}s to generate a random unique string. This can be useful when creating keys for new entries. An example:
\begin{ltxexample}[style=latex]
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map[overwrite, foreach={author,editor, translator}]{
\step[fieldsource=\regexp{$MAPLOOP}, match={Smith}, replace={Jones}]
}
}
}
\end{ltxexample}
%$<- to stop emacs highlighting breaking
\intitem{refsection}
Only apply the contained \cmd{step} commands to entries in the reference section with number \prm{refsection}.
\end{optionlist*}
\cmditem{perdatasource}{datasource}
Restricts all \cmd{step}s in this \cmd{map} element to entries from the named \prm{datasource}. The \prm{datasource} name should be exactly as given in a \cmd{addresource} macro defining a data source for the document. Multiple \cmd{perdatasource} restrictions are allowed within a \cmd{map} element.
\cmditem{pertype}{entrytype}
Restricts all \cmd{step}s in this \cmd{map} element to entries of the named \prm{entrytype}. Multiple \cmd{pertype} restrictions are allowed within a \cmd{map} element.
\cmditem{pernottype}{entrytype}
Restricts all \cmd{step}s in this \cmd{map} element to entries not of the named \prm{entrytype}. Multiple \cmd{pernottype} restrictions are allowed within a \cmd{map} element.
\cmditem{step}[options]
A mapping step. Each step is applied sequentially to every relevant entry where <relevant> means those entries which correspond to the data source type, entrytype and data source name restrictions mentioned above. Each step is applied to the entry as it appears after the application of all previous steps. The mapping performed by the step is determined by the following \prm{option}s:
\begin{optionlist*}
\valitem{typesource}{entrytype}
\valitem{typetarget}{entrytype}
\valitem{fieldsource}{entryfield}
\valitem{notfield}{entryfield}
\valitem{fieldtarget}{entryfield}
\valitem{match}{regexp}
\valitem{matchi}{regexp}
\valitem{notmatch}{regexp}
\valitem{notmatchi}{regexp}
\valitem{replace}{regexp}
\valitem{fieldset}{entryfield}
\valitem{fieldvalue}{string}
\valitem{entryclone}{clonekey}
\valitem{entrynew}{entrynewkey}
\valitem{entrynewtype}{string}
\valitem{entrytarget}{string}
\boolitem[false]{cited}
\boolitem[false]{nocited}
\boolitem[false]{citedornocited}
\boolitem[false]{allnocited}
\boolitem[false]{starnocited}
\boolitem[false]{entrynocite}
\boolitem[false]{entrynull}
\boolitem[false]{append}
\boolitem[false]{appendstrict}
\boolitem[false]{final}
\boolitem[false]{null}
\boolitem[false]{origfield}
\boolitem[false]{origfieldval}
\boolitem[false]{origentrytype}
%
For all boolean \cmd{step} options, the short form \opt{option} is equivalent to \kvopt{option}{true}. The following rules for a mapping step apply:
\renewcommand{\labelitemii}{$\circ$}
Note that the options \opt{cited}, \opt{nocited}, \opt{citedornocited},
\opt{allnocited} and \opt{starnocited} are unique in that they can make the
results of a sourcemap differ depending on the refsection. This is because
a datasource to which source mapping applies may be used in several
refsections and source mappings are applied when fetching the data from the
datasources for a refsection. Citation commands are local to a refsection
and therefore may differ for the same entry from refsection to refsection.
For example, the same entry may be \cmd{cite}d in one refsection but
\cmd{nocite}d in another, resulting in different source map results and
therefore data between the refsections. This can be avoided if desired, by
limiting source maps to specific refsections only (see \opt{refsection}
option to the \cmd{map} command above).
\begin{itemize}
\item If \texttt{entrynew} is set, a new entry is created with the entry key \texttt{entrynewkey} and the entry type given in the option \texttt{entrynewtype}. This
entry is only in-scope during the processing of the current entry and can be referenced by
\texttt{entrytarget}. In \texttt{entrynewkey}, you may use standard Perl regular expression
backreferences to captures from a previous \texttt{match} step.
\item When a \texttt{fieldset} step has \texttt{entrytarget} set to the entrykey of an entry
created by \texttt{entrynew}, the target for the field set will be the \texttt{entrytarget} entry
rather than the entry being currently processed. This allows users to create new entries and set
fields in them.
\item If \texttt{entrynocite} is used in a \texttt{entrynew} or
\texttt{entryclone} step, the new/clone entry will be included in the
\file{.bbl} as if the entry/clone had been \cmd{nocite}ed in the document.
\item If \texttt{entrynull} is set, processing of the \cmd{map}
immediately terminates and the current entry is not created. It is
as if it did not exist in the datasource. Obviously, you should
select the entries which you want to apply this to using prior
mapping steps.
\item If \texttt{entryclone} is set, a clone of the entry is created with an entry key
\texttt{clonekey}. Obviously this may cause labelling problems in author/year styles etc.
and should be used with care. The cloned entry is in-scope during the processing of the
current entry and can be modified by passing its key as the value to \texttt{entrytarget}.
In \texttt{clonekey}, you may use standard Perl regular expression backreferences to
captures from a previous \texttt{match} step.
\item If \texttt{cited} is used then only apply the step if the entry key
of an entry was specifically cited via \cmd{cite}.
\item If \texttt{nocited} is used then only apply the step if the entry key
of an entry was specifically nocited via \cmd{nocite} or was included via \cmd{nocite\{*\}}.
\item If \texttt{citedornocited} is used then only apply the step if the entry key
of an entry was specifically cited via \cmd{cite} or specifically nocited via \cmd{nocite}.
\item If \texttt{allnocited} is used then only apply the step if the entry key
of an entry was included via \cmd{nocite\{*\}}.
\item If \texttt{starnocited} is used then only apply the step if the entry key
of an entry was included solely because of \cmd{nocite\{*\}}. This
implies that the entry was neither explicitly \cmd{cite}ed nor explicitly \cmd{nocite}ed.
\item Change the \texttt{typesource} \prm{entrytype} to the
\texttt{typetarget} \prm{entrytype}, if defined. If
\texttt{final} is \texttt{true} then if the \prm{entrytype} of the entry is not \texttt{typesource}, processing of the parent \cmd{map} immediately terminates.
\item Change the \texttt{fieldsource} \prm{entryfield} to
\texttt{fieldtarget}, if defined. If
\texttt{final} is \texttt{true} then if there is no \texttt{fieldsource} \prm{entryfield} in the entry, processing of the parent \cmd{map} immediately terminates.
\item If \texttt{notfield} is true only if the \prm{entryfield} does not
exist. Usually used with \texttt{final} so that if an entry does contain
\prm{entryfield}, the map terminates.
\item If \texttt{match} is defined but
\texttt{replace} is not, only apply the step if the \texttt{fieldsource} \prm{entryfield} matches the
\texttt{match} regular expression (logic is reversed if you use \texttt{notmatch} and case-insensitive if you use the versions ending in <i>)\footnote{Regular expressions are full Perl 5.16 regular expressions. This means you may need to deal with special characters, see examples.}. You may use capture parenthesis as usual and refer to these (\$1\ldots\$9) in later \texttt{fieldvalue} specifications. This allows you to pull out parts of some fields and put these parts in other fields.
\item Perform a regular expression match and replace on the value of the \texttt{fieldsource} \prm{entryfield} if \texttt{match} and \texttt{replace} are defined.
\item If \texttt{fieldset} is defined, then its value is \prm{entryfield}
which will be set to a value specified by further options. If
\texttt{overwrite} is false for this step and the field to set already
exists then the map step is ignored. If \texttt{final} is also true for
this step, then processing of the parent map stops at this point. If
\texttt{append} is true, then the value to set is appended to the current
value of \prm{entryfield}. \texttt{appendstrict} only appends to
\prm{entryfield} if \prm{entryfield} is not empty. The value to set is
specified by a mandatory one and only one of the following options:
\begin{itemize}
\item\ \texttt{fieldvalue} --- The \texttt{fieldset} \prm{entryfield} is set to the \texttt{fieldvalue} \prm{string}
\item\ \texttt{null} --- The \texttt{fieldset} \prm{entryfield} is ignored, as if it did not exist in the datasource
\item\ \texttt{origentrytype} --- The \texttt{fieldset} \prm{entryfield} is set to the most recently mentioned \texttt{typesource} \prm{entrytype} name
\item\ \texttt{origfield} --- The \texttt{fieldset} \prm{entryfield} is set to the most recently mentioned \texttt{fieldsource} \prm{entryfield} name
\item\ \texttt{origfieldval} --- The \texttt{fieldset} \prm{entryfield} is set to the most recently mentioned \texttt{fieldsource} value
\end{itemize}
\end{itemize}
\end{optionlist*}
\end{ltxsyntax}
\noindent With \bibtex\ datasources, you may specify the
pseudo-field \bibfield{entrykey} for \texttt{fieldsource}
which is the citation key of the entry. With \biblatexml\ the \bibfield{entrykey} is a normal attribute and can be reference like any other attribute. Naturally, this <field> cannot
be changed (used as \texttt{fieldset}, \texttt{fieldtarget} or changed using \texttt{replace}).
Macros used in \cmd{step} are expanded. Unexpandable contents should be protected with \cmd{detokenize}, regular expressions can be escaped using the dedicated \cmd{regexp} command (see the examples below).
\begin{ltxsyntax}
\cmditem{DeclareStyleSourcemap}{specification}
This command sets the source mappings used by a style. Such mappings are conceptually separate from user mappings defined with \cmd{DeclareSourcemap} and are applied directly after user maps. The syntax is identical to \cmd{DeclareSourcemap}. This command is provided for style authors so that any maps defined for the style do not interfere with user maps or the default driver maps defined with \cmd{DeclareDriverSourcemap}. This command is for use in style files and can be used multiple times, the maps being run in order of definition.
\end{ltxsyntax}
\begin{ltxsyntax}
\cmditem{DeclareDriverSourcemap}[datatype=driver]{specification}
This command sets the driver default source mappings for the specified \prm{driver}. Such mappings are conceptually separate from user mappings defined with \cmd{DeclareSourcemap} and style mapping defined with \cmd{DeclareStyleSourcemap}. They consist of mappings which are part of the driver setup. Users should not normally need to change these. Driver default mapping are applied after user mappings (\cmd{DeclareSourcemap}) and style mappings (\cmd{DeclareStyleSourcemap}). These defaults are described in Appendix \secref{apx:maps}. The \prm{specification} is identical to that for \cmd{DeclareSourcemap} but without the \cmd{maps} elements: the \prm{specification} is just a list of \cmd{map} elements since each \cmd{DeclareDriverSourcemap} only applies to one datatype driver. See the default definitions in Appendix \secref{apx:maps} for examples.
\end{ltxsyntax}
Here are some data source mapping examples:
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\perdatasource{<<example1.bib>>}
\perdatasource{<<example2.bib>>}
\step[fieldset=<<keywords>>, fieldvalue={<<keyw1, keyw2>>}]
\step[fieldsource=<<entrykey>>]
\step[fieldset=<<note>>, origfieldval]
}
}
}
\end{ltxexample}
%
This would add a \bibfield{keywords} field with value <keyw1, keyw2> and set the \bibfield{note} field to the entry key to all entries which are found in either the
\texttt{examples1.bib} or \texttt{examples2.bib} files.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<title>>]
\step[fieldset=<<note>>, origfieldval]
}
}
}
\end{ltxexample}
%
Copy the \bibfield{title} field to the \bibfield{note} field unless the
\bibfield{note} field already exists.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[typesource=<<chat>>, typetarget=<<customa>>, final]
\step[fieldset=<<type>>, origentrytype]
}
}
}
\end{ltxexample}
%
Any \bibfield{chat} entrytypes would become \bibfield{customa} entrytypes and
would automatically have a \bibfield{type} field set to
<chat> unless the \bibfield{type} field already exists in the entry (because
\texttt{overwrite} is false by default). This mapping applies only to entries of type
\bibtype{chat} since the first step has \texttt{final} set and so if the
\texttt{typesource} does not match the entry entrytype, processing of this
\cmd{map} immediately terminates.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\perdatasource{<<examples.bib>>}
\pertype{<<article>>}
\pertype{<<book>>}
\step[fieldset=<<abstract>>, null]
\step[fieldset=<<note>>, fieldvalue={<<Auto-created this field>>}]
}
}
}
\end{ltxexample}
%
Any entries of entrytype \bibtype{article} or \bibtype{book} from the
\texttt{examples.bib} datasource would have their \bibfield{abstract}
fields removed and a \bibfield{note} field added with value <Auto-created this field>.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldset=<<abstract>>, null]
\step[fieldsource=<<conductor>>, fieldtarget=<<namea>>]
\step[fieldsource=<<gps>>, fieldtarget=<<usera>>]
}
}
}
\end{ltxexample}
%
This removes \bibfield{abstract} fields from any entry, changes
\bibfield{conductor} fields to \bibfield{namea} fields and changes \bibfield{gps}
fields to \bibfield{usera} fields.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<pubmedid>>, fieldtarget=<<eprint>>, final]
\step[fieldset=<<eprinttype>>, origfield]
\step[fieldset=<<userd>>, fieldvalue={<<Some string of things>>}]
}
}
}
\end{ltxexample}
%
Applies only to entries with \bibfield{pubmed} fields and maps
\bibfield{pubmedid} fields to \bibfield{eprint} fields, sets the \bibfield{eprinttype}
field to <pubmedid> and also sets the \bibfield{userd} field to the string
<Some string of things>.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<series>>,
match=\regexp{<<\A\d*(.+)>>},
replace=\regexp{<<\L$1>>}]
}
}
}
\end{ltxexample}
%$<- to stop emacs highlighting breaking
Here, the contents of the \bibfield{series} field have leading numbers stripped and the remainder of the contents lowercased. Since regular expressions usually contain all sort of special characters, it is best to enclose them in the provided \cmd{regexp} macro as shown---this will pass the expression through to \biber\ correctly.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<maintitle>>,
match=\regexp{<<Collected\s+Works.+Freud>>},
final]
\step[fieldset=<<keywords>>, fieldvalue=<<freud>>]
}
}
}
\end{ltxexample}
%$<- to stop emacs highlighting breaking
Here, if for an entry, the \bibfield{maintitle} field matches a particular regular expression, we set a special keyword so we can, for example, make a references section just for certain items.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<lista>>, match=\regexp{<<regexp>>}, final]
\step[fieldset=<<lista>>, null]
}
}
}
\end{ltxexample}
%
If an entry has a \bibfield{lista} field which matches regular expression <regexp>, then it is removed.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map[overwrite=false]{
\step[fieldsource=<<author>>]
\step[fieldset=<<editor>>, origfieldval, final]
\step[fieldsource=<<editor>>, match=\regexp{<<\A(.+?)\s+and.*>>}, replace={<<$1>>}]
}
}
}
\end{ltxexample}
%$<- to stop emacs highlighting breaking
For any entry with an \bibfield{author} field, try to set
\bibfield{editor} to the same as \bibfield{author}. If this fails because
\bibfield{editor} already exists, stop, otherwise truncate
\bibfield{editor} to just the first name in the name list.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<author>>,
match={<<Smith, Bill>>},
replace={<<Smith, William>>}]
\step[fieldsource=<<author>>,
match={<<Jones, Baz>>},
replace={<<Jones, Barry>>}]
}
}
}
\end{ltxexample}
%
Here, we use multiple match/replace for the same field to regularise some inconstant name variants. Bear in mind that \cmd{step} processing within a \opt{map} element is sequential and so the changes from a previous \cmd{step}s are already committed. Note that we don't need the \cmd{regexp} macro to protect the regular expressions in this example as they contain no characters which need special escaping. Please note that due to the difficulty of protecting regular expressions in \LaTeX, there should be no literal spaces in the argument to \cmd{regexp}. Please use escape code equivalents if spaces are needed. For example, this example, if using \cmd{regexp}, should be:
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<author>>,
match=\regexp{<<Smith,\s+Bill>>},
replace=\regexp{<<Smith,\x20William>>}]
\step[fieldsource=<<author>>,
match=\regexp{<<Jones,\s+Baz>>},
replace=\regexp{<<Jones,\x20Barry>>}]
}
}
}
\end{ltxexample}
%
Here, we have used the hexadecimal escape sequence <|\x20|> in place of literal spaces in the replacement strings.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map[overwrite]{
\step[fieldsource=<<author>>, match={<<Doe,>>}, final]
\step[fieldset=<<shortauthor>>, origfieldval]
\step[fieldset=<<sortname>>, origfieldval]
\step[fieldsource=<<shortauthor>>,
match=\regexp{<<Doe,\s*(?:\.|ohn)(?:[-]*)(?:P\.|Paul)*>>},
replace={<<Doe, John Paul>>}]
\step[fieldsource=<<sortname>>,
match=\regexp{<<Doe,\s*(?:\.|ohn)(?:[-]*)(?:P\.|Paul)*>>},
replace={<<Doe, John Paul>>}]
}
}
}
\end{ltxexample}
%
Only applies to entries with an \bibfield{author} field matching <Doe,>. First the \bibfield{author} field is copied to both the \bibfield{shortauthor} and \bibfield{sortname} fields, overwriting them if they already exist. Then, these two new fields are modified to canonicalise a particular name, which presumably has some variants in the data source.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map[overwrite]{
\step[fieldsource=<<verba>>, final]
\step[fieldset=<<verbb>>, fieldvalue=<</>>, append]
\step[fieldset=<<verbb>>, origfieldval, append]
\step[fieldsource=<<verbb>>, final]
\step[fieldset=<<verbc>>, fieldvalue=<</>>, append]
\step[fieldset=<<verbc>>, origfieldval, append]
}
}
}
\end{ltxexample}
%
This example demonstrates the sequential nature of the step processing and the \opt{append} option. If an entry has a \bibfield{verba} field then first, a forward slash is appended to the \bibfield{verbb} field. Then, the contents of \bibfield{verba} are appended to the \bibfield{verbb} field. A slash is then appended to the \bibfield{verbc} field and the contents of \bibfield{verbb} are appended to the \bibfield{verbc} field.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map[overwrite]{
\step[fieldset=<<autourl>>, fieldvalue={<<http://scholar.google.com/scholar?q=">>}]
\step[fieldsource=<<title>>]
\step[fieldset=<<autourl>>, origfieldval, append]
\step[fieldset=<<autourl>>, fieldvalue={<<"+author:>>}, append]
\step[fieldsource=<<author>>, match=\regexp{<<\A([^,]+)\s*,>>}]
\step[fieldset=<<autourl>>, fieldvalue={<<$1>>}, append]
\step[fieldset=<<autourl>>, fieldvalue={<<&as_ylo=>>}, append]
\step[fieldsource=<<year>>]
\step[fieldset=<<autourl>>, origfieldval, append]
\step[fieldset=<<autourl>>, fieldvalue={<<&as_yhi=>>}, append]
\step[fieldset=<<autourl>>, origfieldval, append]
}
}
}
\end{ltxexample}%$ <- keep AucTeX highlighting happy
%
This example assumes you have created a field called \bibfield{autourl} using the datamodel macros from \secref{aut:ctm:dm} in order to hold, for example, a Google Scholar query URL auto-created from elements of the entry. The example progressively extracts information from the entry, constructing the URL as it goes. It demonstrates that it is possible to refer to parenthetical matches from the most recent \texttt{match} in any following \texttt{fieldvalue} which allows extracting the family name from the \bibfield{author}, assuming a <family, given> format. The resulting field could then be used as a hyperlink from, for example, the title of the work in the bibliography.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\step[fieldsource=<<title>>, match={A Title}, final]
\step[entrynull]
}
}
}
\end{ltxexample}
%
Any entry with a \bibfield{title} field matching <A Title> will be completely ignored.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\pernottype{book}
\pernottype{article}
\step[entrynull]
}
}
}
\end{ltxexample}
%
Any entry which is not a \bibtype{book} or \bibtype{article} will be ignored.
%
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=bibtex]{
\map{
\perdatasource{<<biblatex-examples.bib>>}
\step[entryclone={rel-}]
}
}
}
\end{ltxexample}
%
Here, a clone of an entry from the specified data source will be created. The entry key of the clone will be the same as the original but prefixed by the value of the \texttt{entryclone} parameter. The cloned entry would still need to be cited in the document using its new entry key. This type of mapping step should be used with care as it may produce labelling problems in authoryear styles which use, for example, \opt{extradate}. One use case is for numeric styles which contain multiple bibliographies containing the same entry. In this case, you may need different bibliography number labeld for the same entry and this is very tricky when there is only one entry which needs different labels. Creating clones with different entry keys solves this problem.
\biblatexml\ datasources are more structured than \bibtex\ since they are XML. Sourcemapping is possible with \biblatexml\ too but the specifications of source and target fields etc. also support XPath 1.0 paths in order to be able to work with the structured data. Fields can be specified as per the \bibtex\ examples above and these are converted into XPath 1.0 queries internally as necessary. For example:
\begin{ltxexample}
\DeclareSourcemap{
\maps[datatype=biblatexml]{
\map{
\step[fieldsource=\regexp{./bltx:names[@type='author']/bltx:name[2]/bltx:namepart[@type='family']},
match=\regexp{\ASmith},
replace={Jones}]
}
\map{
\step[fieldsource=editor, fieldtarget=translator]
}
\map{
\step[fieldsource=\regexp{./bltx:names[@type='editor']},
fieldtarget=\regexp{./bltx:names[@type='translator']}]
}
\map{
\step[fieldset=\regexp{./bltx:names[@type='author']/bltx:name[2]/@useprefix},
fieldvalue={false}]
}
}
}
\end{ltxexample}
%
These maps, respectively,
\begin{itemize}
\item Replace the family name <Smith> of the second \bibfield{author} name with <Jones>
\item Move the \bibfield{editor} to \bibfield{translator}
\item Move the \bibfield{editor} to \bibfield{translator} but with explicit XPaths
\item Set the per-namelist \opt{useprefix} option on the \bibfield{author} name list to <false>
\end{itemize}
\subsubsection{Data Model Specification}
\label{aut:ctm:dm}
The data model which \biblatex uses consists of four main elements:
\begin{itemize}
\item Specification of constant strings and lists of strings
\item Specification of valid Entrytypes
\item Specification of valid Fields along with their type, datatype and any special flags
\item Specification of which Fields are valid in which Entrytypes
\item Specification of constraints which can be used to validate data against the data model
\end{itemize}
The default data model is defined in the core \biblatex file \file{blx-dm.def} using the macros described in this section. The default data model is described in detail in \secref{bib}. The data model is used internally by \biblatex and also by the backend. In practice, changing the data model means that you can define the entrytypes and fields for your datasources and validate your data against the data model. Naturally, this is not much use unless your style supports any new entrytypes or fields and it raises issues of portability between styles (although this can be mitigated by using the dynamic data modification functionality described in \secref{aut:ctm:map}).
Note that while the \biber/\bibtex input site is not case sensitive when it comes to entry types and field names (Perl's Unicode case folding is used to normalise field names and entry types), the \latex side is case sensitive and uses the exact capitalisation from the data model.
Validation against the data model means that after mapping your data sources into the data model, \biber (using its \path{--validate_datamodel} option) can check:
\begin{itemize}
\item Whether all entrytypes are valid entrytypes
\item Whether all fields are valid fields for their entrytype
\item Whether the fields obey various constraints on their format which you specify
\end{itemize}
%
Redefining the data model can be done in several places. Style authors can create a \file{.dbx} file which contains the data model macros required and this will be loaded automatically when using the \biblatex package \opt{style} option by looking for a file named after the style with a \file{.dbx} extension (just like the \file{.cbx} and \file{.bbx} files for a style). If the \opt{style} option is not used but rather the \opt{citestyle} and \opt{bibstyle} options, then the package will try to load \file{.dbx} files called \file{$<$citestyle$>$.dbx} and \file{$<$bibstyle$>$.dbx}.
Alternatively, the name of the data model file can be different from any of the style option names by specifying the name (without \file{.dbx} extension) to the package \opt{datamodel} option. After loading the style data model file, \biblatex then loads, if present, a users \file{biblatex-dm.cfg} which should be put somewhere \biblatex can find it, just like the main configuration file \sty{biblatex.cfg}. To summarise, the data model is determined by adding to the data model from each of these locations, in order:\\
\noindent\file{blx-dm.def}$\rightarrow$\\
\hspace*{1em}\file{$<$datamodel option$>$.dbx} $\rightarrow$\\
\hspace*{2em}\file{$<$style option$>$.dbx} $\rightarrow$\\
\hspace*{3em}\file{$<$citestyle option$>$.dbx} and \file{$<$bibstyle option$>$.dbx} $\rightarrow$\\
\hspace*{4em}\file{biblatex-dm.cfg}\\
\noindent It is not possible to add to a loaded data model by using the macros below in your preamble as the preamble is read after \biblatex has defined critical internal macros based on the data model. If any data model macro is used in a document, it will be ignored and a warning will be generated. The data model is defined using the following macros:
\begin{ltxsyntax}
\cmditem{DeclareDatamodelConstant}[options]{name}{constantdef}
Declares the \prm{name} as a datamodel constant with definition \prm{constantdef}. Such constants are typically used internally by \biber.
\begin{optionlist*}
\choitem[string]{type}{string, list}
A constant can be a simple string (default if the \prm{type} option is omitted) or a comma"=separated list of strings.
\end{optionlist*}
\cmditem{DeclareDatamodelEntrytypes}[options]{entrytypes}
Declares the comma"=separated list of \prm{entrytypes} to be valid entrytypes in the data model. As usual in \tex csv lists, make sure each element is immediately followed by a comma or the closing brace---no extraneous whitespace.
\begin{optionlist*}
\boolitem[false]{skipout}
This entrytype is not output to the \file{.bbl}. Typically used for special entrytypes which are processed and consumed by the backend such as \bibtype{xdata}.
\end{optionlist*}
\cmditem{DeclareDatamodelFields}[options]{fields}
Declares the comma"=separated list of \prm{fields} to be valid fields in the data model with associated comma"=separated \prm{options}. The \prm{type} and \prm{datatype} options are mandatory. All valid \prm{options} are:
\begin{optionlist*}
\valitem{type}{field type}
Set the type of the field as described in \secref{bib:fld:typ}, typically <field> or <list>.
\valitem{format}{field format}
Any special format of the field. Normally unspecified but can take the value <xsv> which tells \biber that this field has a separated values format. The exact separator can be controlled with the \biber option \opt{xsvsep} and defaults to the expected comma surrounded by optional whitespace.
\valitem{datatype}{field datatype}
Set the datatype of the field as described in \secref{bib:fld:typ}. For example, <name> or <literal>.
\boolitem[false]{nullok}
The field is allowed to be defined but empty.
\boolitem[false]{skipout}
The field is not output to the \file{.bbl} and is therefore not present during \biblatex style processing. As usual in \tex csv lists, make sure each element is immediately followed by a comma or the closing brace---no extraneous whitespace.
\boolitem[false]{label}
The field can be used as a label in a bibliography or bibliography list. Specifying this causes \biblatex to create several helper macros for the field so that there are some internal lengths and headings etc. defined.
\end{optionlist*}
\cmditem{DeclareDatamodelEntryfields}[entrytypes]{fields}
Declares that the comma"=separated list of \prm{fields} is valid for the comma"=separated list of \prm{entrytypes}. If \prm{entrytypes} is not given, the fields are valid for all entrytypes. As usual in \tex csv lists, make sure each element is immediately followed by a comma or the closing brace---no extraneous whitespace.
\cmditem{DeclareDatamodelConstraints}[entrytypes]{specification}
If a comma"=separated list of \prm{entrytypes} is given, the constraints apply only to those entrytypes. The \prm{specification} is an undelimited list of \cmd{constraint} directives which specify a constraint. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible.
\cmditem{constraint}[type=constrainttype]{elements}
Specifies a constraint of type \prm{constrainttype}. Valid constraint types are:
\begin{optionlist*}
\choitem{type}{data, mandatory, conditional}
Constraints of type <data> put restrictions on the value of a field. Constraints of type <mandatory> specify which fields or combinations of fields an entrytype should have. Constraints of type <conditional> allow more sophisticated conditional and quantified field constraints.
\choitem{datatype}{integer, isbn, issn, ismn, datepart, pattern}
For constraints of type \prm{data}, constrain field values to be the given datatype.
\valitem{rangemin}{num}
For constraints of \prm{type} <data> and \prm{datatype} <integer>, constrain field values to be at least \prm{num}.
\valitem{rangemax}{num}
For constraints of \prm{type} <data> and \prm{datatype} <integer>, constrain field values to be at most \prm{num}.
\valitem{pattern}{patt}
For constraints of \prm{type} <data> and \prm{datatype} <pattern>, constrain field values to match regular expression pattern \prm{patt}. It is best to wrap any regular expression in the macro \cmd{regexp}, see \secref{aut:ctm:map}.
\end{optionlist*}
A \cmd{constraint} macro may contain any of the following:
\cmditem{constraintfieldsor}{fields}
For constraints of \prm{type} <mandatory>, specifies that an entry must contain a boolean OR of the \cmd{constraintfield}s.
\cmditem{constraintfieldsxor}{fields}
For constraints of \prm{type} <mandatory>, specifies that an entry must contain a boolean XOR of the \cmd{constraintfield}s.
\cmditem{antecedent}[quantifier=quantspec]{fields}
For constraints of \prm{type} <conditional>, specifies a quantified set of \cmd{constraintfield}s which must be satisfied before the \cmd{consequent} of the constraint is checked. \prm{quantspec} should have one of the following values:
\begin{optionlist*}
\choitem{quantifier}{all, one, none}
Specifies how many of the \cmd{constrainfield}'s inside the \cmd{antecedent} have to be present to satisfy the antecedent of the conditional constraint.
\end{optionlist*}
\cmditem{consequent}[quantifier=quantspec]{fields}
For constraints of \prm{type} <conditional>, specifies a quantified set of \cmd{constraintfield}s which must be satisfied if the preceding \cmd{antecedent} of the constraint was satisfied. \prm{quantspec} should have one of the following values:
\begin{optionlist*}
\choitem{quantifier}{all, one, none}
Specifies how many of the \cmd{constraintfield}'s inside the \cmd{consequent} have to be present to satisfy the consequent of the conditional constraint.
\end{optionlist*}
\cmditem{constraintfield}{field}
For constraints of \prm{type} <data>, the constraint applies to this \prm{field}. For constraints of \prm{type} <mandatory>, the entry must contain this \prm{field}.
The data model declaration macros may be used multiple times as they append to the previous definitions. In order to replace, change or remove existing definitions (such as the default model which is loaded with \biblatex), you should reset (clear) the current definition and then set what you want using the following macros. Typically, these macros will be the first things in any \file{biblatex-dm.cfg} file:
\cmditem{ResetDatamodelEntrytypes}
Clear all data model entrytype information.
\cmditem{ResetDatamodelFields}
Clear all data model field information.
\cmditem{ResetDatamodelEntryfields}
Clear all data model fields for entrytypes information.
\cmditem{ResetDatamodelConstraints}
Clear all data model fields Constraints information.
\end{ltxsyntax}
Here is an example of a simple data model. Refer to the core \biblatex file \file{blx-dm.def} for the default data model specification.
\begin{ltxexample}
\ResetDatamodelEntrytypes
\ResetDatamodelFields
\ResetDatamodelEntryfields
\ResetDatamodelConstraints
\DeclareDatamodelEntrytypes{<<entrytype1, entrytype2>>}
\DeclareDatamodelFields[type=field, datatype=literal]{<<field1,field2,field3,field4>>}
\DeclareDatamodelEntryfields{<<field1>>}
\DeclareDatamodelEntryfields[entrytype1]{<<field2,field3>>}
\DeclareDatamodelEntryfields[entrytype2]{<<field2,field3,field4>>}
\DeclareDatamodelConstraints[<<entrytype1>>]{
\constraint[type=data, datatype=integer, rangemin=3, rangemax=10]{
\constraintfield{<<field1>>}
}
\constraint[type=mandatory]{
\constraintfield{<<field1>>}
\constraintfieldsxor{
\constraintfield{<<field2>>}
\constraintfield{<<field3>>}
}
}
}
\DeclareDatamodelConstraints{
\constraint[type=conditional]{
\antecedent[quantifier=none]{
\constraintfield{<<field2>>}
}
\consequent[quantifier=all]{
\constraintfield{<<field3>>}
\constraintfield{<<field4>>}
}
}
}
\end{ltxexample}
%
This model specifies:
\begin{itemize}
\item Clear the default data model completely
\item Two valid entry types \bibtype{entrytype1} and \bibtype{entrytype2}
\item Four valid literal field fields
\item \bibfield{field1} is valid for all entrytypes
\item \bibfield{field2} and \bibfield{field3} are valid for \bibfield{entrytype1}
\item \bibfield{field2}, \bibfield{field3} and \bibfield{field4} are valid for \bibtype{entrytype2}
\item For \bibtype{entrytype1}:
\begin{itemize}
\item \bibfield{field1} must be an integer between 3 and 10
\item \bibfield{field1} must be present
\item One and only one of \bibfield{field2} or \bibfield{field3} must be present
\end{itemize}
\item For any entrytype, if \bibfield{field2} is not present, \bibfield{field3} and \bibfield{field4} must be present
\end{itemize}
\subsubsection{Labels}
\label{aut:ctm:lab}
Alphabetic styles use a label to identify bibliography entries. This label is constructed from components of the entry using a template which describes how to build the label. The template can be customised on a global or per-type basis. A separate template is used to specify how to extract parts of name fields for labels, since names can be quite complex fields.
\begin{ltxsyntax}
\cmditem{DeclareLabelalphaTemplate}[]{specification}
Defines the alphabetic label template for the given entrytypes. If no entrytypes are specified in the first argument, then the global label template is defined. The \prm{specification} is an undelimited list of \cmd{labelelement} directives which specify the elements used to build the label. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{labelelement}{elements}
Specifies the elements used to build the label. The \prm{elements} are an undelimited list of \cmd{field} or \cmd{literal} commands which are evaluated in the order in which they are given. The first \cmd{field} or \cmd{literal} which expands to a non-empty string is used as the \cmd{labelelement} expansion and the next \cmd{labelelement}, if any, is then processed.
\cmditem{field}[options]{field}
If \prm{field} is non-empty, use it as the current label \cmd{labelelement}, subject to the options below. Useful values for \prm{field} are typically the name list type fields, date fields, and title fields. You may also use the `citekey' or `entrykey` pseudo-fields to specify the citation/entry key as part of the label. Name list fields are treated specially and when a name list field is specified, the template defined with \cmd{DeclareLabelalphaNameTemplate} is used to extract parts from the name which then returns the string that the \cmd{field} option uses.
\begin{optionlist*}
\boolitem[false]{final}
This option marks a \cmd{field} directive as the final one in the \prm{specification}. If the \prm{field} is non-empty, then this field is used for the label and the remainder of the \prm{specification} will be ignored. The short form \opt{final} is equivalent to \kvopt{final}{true}.
\boolitem[false]{lowercase}
Forces the label part derived from the field to lowercase. By default, the case is taken from the field source and not modified.
\intitem[1]{strwidth}
The number of characters of the \prm{field} to use. This setting may be overridden by an individual name part when extracting characters from a name. See \cmd{DeclareLabelalphaNameTemplate} below.
\choitem[left]{strside}{left, right}
The side of the string from which to take the \texttt{strwidth} number of characters. This setting may be overridden by an individual name part when extracting characters from a name. See \cmd{DeclareLabelalphaNameTemplate} below.
\choitem[right]{padside}{left, right}
Side to pad the label part when using the \texttt{padchar} option. Only for use with fixed-width label strings (\texttt{strwidth}).
\valitem{padchar}{character}
If present, pads the label part on the \texttt{padside} side with the specified character to the length of \texttt{strwidth}. Only for use with fixed-width label strings (\texttt{strwidth}).
\boolitem[false]{uppercase}
Forces the label part derived from the field to uppercase. By default, the case is taken from the field source and not modified.
\boolitem[false]{varwidth}
Use a variable width, left-side substring of characters from the string returned for \prm{field}. The length of the string is determined by the minimum length needed to disambiguate the substring from all other \prm{field} elements in the same position in the label. For name list fields, this means that each name substring is disambiguated from all other name substrings which occur in the same position in the name list (see examples below). This option overrides \texttt{strwidth} if both are used. The short form \opt{varwidth} is equivalent to \kvopt{varwidth}{true}. For name list fields, the \cmd{namepart}s with the \opt{pre} option set are prepended to the string returned from this disambiguation.
\boolitem[false]{varwidthnorm}
As \texttt{varwidth} but will force the disambiguated substrings for the \prm{field} to be the same length as the longest disambiguated substring. This can be used to regularise the format of the labels if desired. This option overrides \texttt{strwidth} if both are used. The short form \opt{varwidthnorm} is equivalent to \kvopt{varwidthnorm}{true}.
\boolitem[false]{varwidthlist}
Alternative method of automatic label disambiguation where the field as a whole is disambiguated from all other fields in the same label position. For non-name list fields, this is equivalent to \texttt{varwidth}. For name list fields, names in a name list are not disambiguated from other names in the same position in their name lists but instead the entire name list is disambiguated as a whole from other name lists (see examples below). This option overrides \texttt{strwidth} if both are used. The short form \opt{varwidthlist} is equivalent to \kvopt{varwidthlist}{true}. For name list fields, the \cmd{namepart}s with the \opt{pre} option set are prepended to the string returned from this disambiguation.
\intitem{strwidthmax}
When using \texttt{varwidth}, this option sets a limit (in number of characters) on the length of variable width substrings. This option can be used to regularise the label.
\intitem[1]{strfixedcount}
When using \texttt{varwidthnorm}, there must be at least \texttt{strfixedcount} disambiguated substrings with the same, maximal length to trigger the forcing of all disambiguated substrings to this same maximal length.
\valitem{ifnames}{range}
Only use this \cmd{field} specification if it is a name list field with a number of names matching the \texttt{ifnames} range value. This allows a \cmd{labelelement} to be conditionalised on name length (see below). The range can specified as in the following examples:
\begin{lstlisting}[language=xml]
ifnames=3 -> Only apply to name lists containing exactly 3 names
ifnames={2-4} -> Only apply to name lists containing minimum 2 and maximum 4 names
ifnames={-3} -> Only apply to name lists containing at most 3 names
ifnames={2-} -> Only apply to name lists containing at least 2 names
\end{lstlisting}
\valitem{names}{range}
By default, for name list fields, the names used range from the first name to the \cnt{maxalphanames}\slash \cnt{minalphanames} truncation. This option can be used to override this with an explicit range of names to consider. The plus <+> sign is a special end of range marker denoting the truncation point of max/minalphanames. The range separator can be any number of characters with the Unicode Dash property. For example:
\begin{lstlisting}[language=xml]
names=3 -> Use first 3 names in the name list
names={2-3} -> Use second and thirds names only
names={-3} -> Same as 1-3
names={2-} -> Use all names starting with the second name (ignoring max/minalphanames truncation)
names={2-+} -> Use all names starting with the second name (respecting max/minalphanames truncation)
\end{lstlisting}
\valitem[empty]{namessep}{string}
An arbitrary string separator to put between names in a namelist.
\boolitem[false]{noalphaothers}
By default, \cmd{labelalphaothers} is appended to label parts derived from name lists if there are more names in the list than are shown in the label part. This option can be used to disable the default behaviour.
\end{optionlist*}
\cmditem{literal}{characters}
Insert the literal \prm{characters} into the label at this point.
\end{ltxsyntax}
%
When a name list \cmd{field} is specified, the method of extracting the string is specified by a separate template specified by the following command:
\begin{ltxsyntax}
\cmditem{DeclareLabelalphaNameTemplate}[name]{specification}
Defines the \opt{labelalphaname} template \prm{name}. The \prm{name} is optional and defaults to \prm{<global>}.
Such templates specify how to extract a label string from a name list when a \cmd{field} specification in \cmd{DeclareLabelalphaTemplate} contains a name list.
\cmditem{namepart}[options]{namepart}
\prm{namepart} is one of the datamodel nameparts defined with the \cmd{DeclareDatamodelConstant} command (see \secref{aut:bbx:drv}). The \prm{options} are:
\begin{optionlist*}
\boolitem[false]{use}
Only use the \prm{namepart} in constructing the label information if there is a corresponding option \opt{use<namepart>} and that option is true.
\boolitem[false]{pre}
When constructing label strings from names, the \cmd{namepart} \emph{without} a \opt{pre} option will be used to construct label string, passing through disambiguation, substring etc. operations as specified by the \cmd{field} options in \cmd{DeclareLabelalpaTemplate}. Then the \cmd{namepart} options \emph{with} the \opt{pre} option set will be prepended to the result, (in the order given, if there are more than one such \cmd{namepart}s). This allows to unconditionally prepend certain namepart information to name label strings, like name prefices. Note that the \opt{uppercase} and \opt{lowercase} options of \cmd{field} in \cmd{DeclareLabelalphaTemplate} are applied to the entire label returned from \cmd{DeclareLabelalphaTemplate}, both \opt{pre} parts and non \opt{pre}.
\boolitem[false]{compound}
For static (non-varwidth) disambiguation in \cmd{DeclareLabelalphaTemplate}, treat nameparts separated by whitespace or hyphens (compound names) as separate names for label generation. This means that when forming a label out of, for example the surname <Ballam Forsyth> with a 1 character, left-side substring, this name would give <BF> with \kvopt{compound}{true} and <B> with \kvopt{compound}{false}. The short form \opt{compound} is equivalent to \kvopt{compound}{true}.
\intitem[1]{strwidth}
The number of characters of the \prm{namepart} to use.
\choitem[left]{strside}{left, right}
The side of the string from which to take the \texttt{strwidth} number of characters.
\end{optionlist*}
\end{ltxsyntax}
Note that the templates for labels can be defined per-type and you should be aware of this when using the automatically disambiguated label functionality. Disambiguation is not per-type as this might lead to ambiguity due to different label formats for different types being isolated from each others disambiguation process. Normally, you will want to use very different label formats for different types to make the type obvious by the label.
Here are some examples. The default global \biblatex alphabetic label template is defined below. Firstly, \bibfield{shorthand} has \kvopt{final}{true} and so if there is a \bibfield{shorthand} field, it is used as the label and nothing more of the template is considered. Next, the \bibfield{label} field is used as the first label element if it exists. Otherwise, if there is only one name (\kvopt{ifnames}{1}) in the \bibfield{labelname} list, then three characters from the left side of the family name in the \bibfield{labelname} are used as the first label element. If the \bibfield{labelname} has more than one name in it, one character from the left side of each family name is used as the first label element. The second label element consists of 2 characters from the right side of the \bibfield{year} field.
The default template for constructing labels from names is also shown. This prepends the first character from the left side of any prefix (if the \opt{useprefix} option is true) to a label extracted from the family name (according to the options on the calling \cmd{field} option from \cmd{DeclareLabelalphaTemplate}), allowing for compound family names.
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[final]{<<shorthand>>}
\field{<<label>>}
\field[strwidth=3,strside=left,ifnames=1]{<<labelname>>}
\field[strwidth=1,strside=left]{<<labelname>>}
}
\labelelement{
\field[strwidth=2,strside=right]{<<year>>}
}
}
\DeclareLabelalphaNameTemplate{
\namepart[use=true, pre=true, strwidth=1, compound=true]{prefix}
\namepart{family}
}
\end{ltxexample}
%
To get an idea of how the label automatic disambiguation works, consider the following author lists:
\begin{lstlisting}{}
Agassi, Chang, Laver (2000)
Agassi, Connors, Lendl (2001)
Agassi, Courier, Laver (2002)
Borg, Connors, Edberg (2003)
Borg, Connors, Emerson (2004)
\end{lstlisting}
%
Assuming a template declaration such as:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidth]{<<labelname>>}
}
}
\end{ltxexample}
%
Then the labels would be:
\begin{lstlisting}{}
Agassi, Chang, Laver [AChLa]
Agassi, Connors, Lendl [AConLe]
Agassi, Courier, Laver [ACouLa]
Borg, Connors, Edberg [BConEd]
Borg, Connors, Emerson [BConEm]
\end{lstlisting}
%
With normalised variable width labels defined:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidthnorm]{<<labelname>>}
}
}
\end{ltxexample}
%
You would get the following as the substrings of names in each position are extended to the length of the longest substring in that same position:
\begin{lstlisting}{}
Agassi, Chang, Laver [AChaLa]
Agassi, Connors, Lendl [AConLe]
Agassi, Courier, Laver [ACouLa]
Borg, Connors, Edberg [BConEd]
Borg, Connors, Emerson [BConEm]
\end{lstlisting}
%
With a restriction to two characters for the name components of the label element defined like this:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidthnorm,strwidthmax=2]{<<labelname>>}
}
}
\end{ltxexample}
%
This would be the result (note that the individual family name label parts are no longer unambiguous):
\begin{lstlisting}{}
Agassi, Chang, Laver [AChLa]
Agassi, Connors, Lendl [ACoLe]
Agassi, Courier, Laver [ACoLa]
Borg, Connors, Edberg [BCoEd]
Borg, Connors, Emerson [BCoEm]
\end{lstlisting}
%
Alternatively, you could choose to disambiguate the name lists as a whole with:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidthlist]{<<labelname>>}
}
}
\end{ltxexample}
%
Which would result in:
\begin{lstlisting}{}
Agassi, Chang, Laver [AChL]
Agassi, Connors, Lendl [ACoL]
Agassi, Courier, Laver [ACL]
Borg, Connors, Edberg [BCEd]
Borg, Connors, Emerson [BCE]
\end{lstlisting}
%
Perhaps you only want to consider at most two names for label generation but disambiguate at the whole name list level:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidthlist,names=2]{<<labelname>>}
}
}
\end{ltxexample}
%
Which would result in:
\begin{lstlisting}{}
Agassi, Chang, Laver [ACh+]
Agassi, Connors, Lendl [ACo+]
Agassi, Courier, Laver [AC+]
Borg, Connors, Edberg [BC+a]
Borg, Connors, Emerson [BC+b]
\end{lstlisting}
%
In this last example, you can see \cmd{labelalphaothers} has been appended to show that there are more names. The last two labels now require disambiguating with \cmd{extraalpha} as there is no way of disambiguating this label name list with only two names.
Finally, here is an example using multiple label elements:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\field[varwidthlist]{<<labelname>>}
}
\labelelement{
\literal{-}
}
\labelelement{
\field[strwidth=3,strside=right]{<<labelyear>>}
}
}
\end{ltxexample}
%
Which would result in:
\begin{lstlisting}{}
Agassi, Chang, Laver [AChL-000]
Agassi, Connors, Lendl [AConL-001]
Agassi, Courier, Laver [ACouL-002]
Borg, Connors, Edberg [BCEd-003]
Borg, Connors, Emerson [BCEm-004]
\end{lstlisting}
%
Here is another rather contrived example showing that you don't need to specially quote \latex special characters (apart from <\%>, obviously) when specifying padding characters and literals:
\begin{ltxexample}
\DeclareLabelalphaTemplate{
\labelelement{
\literal{>}
}
\labelelement{
\literal{\%}
}
\labelelement{
\field[namessep={/}, strwidth=4, padchar=_]{<<labelname>>}
}
\labelelement{
\field[strwidth=3, padchar=&, padside=left]{title}
}
\labelelement{
\field[strwidth=2,strside=right]{<<year>>}
}
}
\end{ltxexample}
%
which given:
\begin{lstlisting}[style=bibtex]{}
@Book{test,
author = {XXX YY and WWW ZZ},
title = {T},
year = {2007},
}
\end{lstlisting}
would resulting a label looking like this:
\begin{verbatim}
[>%YY/ZZ__&&T07]
\end{verbatim}
Generating labels from fields may involve some difficulties when you have fields containing diacritics, hyphens, spaces etc. Often, you want to ignore things like separator characters or spaces when generating labels. An option is provided to customise the regular expression(s) to strip from a field before it is passed to the label generation system.
\begin{ltxsyntax}
\cmditem{DeclareNolabel}{specification}
Defines regular expressions to strip from any field before generating a label part for the field. The \prm{specification} is an undelimited list of \cmd{nolabel} directives which specify the regular expressions to remove from fields. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{nolabel}{regexp}
Any number of \cmd{nolabel} commands can be given each of which specifies to remove the \prm{regexp} from the copy of the field which the label generation system sees. Since regular expressions usually contain special characters, it is best to enclose them in the provided \cmd{regexp} macro as shown---this will pass the expression through to \biber correctly.
\end{ltxsyntax}
If there is no \cmd{DeclareNolabel} specification, \biber will default to:
\begin{ltxexample}
\DeclareNolabel{
% strip punctuation, symbols, separator and control characters
\nolabel{\regexp{<<[\p{P}\p{S}\p{C}]+>>}}
}
\end{ltxexample}
%
This \biber default strips punctuation, symbol, separator and control characters from fields before passing the field string to the label generation system.
\begin{ltxsyntax}
\cmditem{DeclareNolabelwidthcount}{specification}
Defines regular expressions to ignore from any field when counting characters in fixed-width substrings. The \prm{specification} is an undelimited list of \cmd{nolabelwidthcount} directives which specify the regular expressions to ignore when counting characters for fixed-width substrings. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{nolabelwidthcount}{regexp}
Any number of \cmd{nolabelwidthcount} commands can be given each of which specifies to ignore the \prm{regexp} when generating fixed-width substrings during label generation. Since regular expressions usually contain special characters, it is best to enclose them in the provided \cmd{regexp} macro as shown---this will pass the expression through to \biber correctly.
\end{ltxsyntax}
There is no default \cmd{DeclareNolabelwidthcount} specification. Note that
this setting is only taken into account when using fixed-width substrings
(non-varwidth) during label part generation. See \secref{aut:ctm:lab}.
\subsubsection{Sorting}
\label{aut:ctm:srt}
In addition to the predefined sorting templates discussed in \secref{use:srt}, it is possible to define new ones or modify the default definitions. The sorting process may be customized further by excluding certain fields from sorting on a per-type basis and by automatically populating the \bibfield{presort} field on a per-type basis.
\begin{ltxsyntax}
\cmditem{DeclareSortingTemplate}[options]{name}{specification}
Defines the sorting template \prm{name}. The \prm{name} is the identifier passed to the \opt{sorting} option (\secref{use:opt:pre:gen}) when selecting the sorting template. The \cmd{DeclareSortingTemplate} command supports the following optional arguments:
\begin{optionlist*}
\choitem{locale}{\prm{locale}}
The locale for the sorting template which then overrides the global sorting locale in the \opt{sortlocale} option discussed in \secref{use:opt:pre:gen}.
\end{optionlist*}
The \prm{specification} is an undelimited list of \cmd{sort} directives which specify the elements to be considered in the sorting process. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{sort}{elements}
Specifies the elements considered in the sorting process. The \prm{elements} are an undelimited list of \cmd{field}, \cmd{literal}, and \cmd{citeorder} commands which are evaluated in the order in which they are given. If an element is defined, it is added to the sort key and the sorting routine skips to the next \cmd{sort} directive. If it is undefined, the next element is evaluated. Since literal strings are always defined, any \cmd{literal} commands should be the sole or the last element in a \cmd{sort} directive. All \prm{elements} should be the same datatype as described in \secref{bib:fld:dat} since they will be potentially compared to any of the other \prm{elements} in other entries.. The \cmd{sort} command supports the following optional arguments:
\begin{optionlist*}
\choitem{locale}{\prm{locale}}
Override the locale used for sorting at the level of a particular set of sorting elements. If specified, the locale overrides the locale set at the level of \cmd{DeclareSortingTemplate} and also the global setting. See also the discussion of the global sorting locale option \opt{sortlocale} in \secref{use:opt:pre:gen}.
\choitem[ascending]{direction}{ascending, descending}
The sort direction, which may be either \texttt{ascending} or \texttt{descending}. The default is ascending order.
\boolitem[false]{final}
This option marks a \cmd{sort} directive as the final one in the \prm{specification}. If one of the \prm{elements} is available, the remainder of the \prm{specification} will be ignored. The short form \opt{final} is equivalent to \kvopt{final}{true}.
\boolitem{sortcase}
Whether or not to sort case"=sensitively. The default setting depends on the global \opt{sortcase} option.
\boolitem{sortupper}
Whether or not to sort in <uppercase before lowercase> (\texttt{true}) or <lowercase before uppercase> order (\texttt{false}). The default setting depends on the global \opt{sortupper} option.
\end{optionlist*}
\cmditem{field}[key=value, \dots]{field}
The \cmd{field} element adds a \prm{field} to the sorting specification. If the \prm{field} is undefined, the element is skipped. The \cmd{field} command supports the following optional arguments:
\begin{optionlist*}
\choitem[left]{padside}{left, right}
Pads a field on the \texttt{left} or \texttt{right} side using \opt{padchar} so that its width is \opt{padwidth}. If no padding option is set, no padding is done at all. If any padding option is specified, then padding is performed and the missing options are assigned built-in default values. If padding and substring matching are both specified, the substring match is performed first.
\intitem[4]{padwidth}
The target width in characters.
\valitem[0]{padchar}{character}
The character to be used when padding the field.
\choitem[left]{strside}{left, right}
Performs a substring match on the \texttt{left} or \texttt{right} side of the field. The number of characters to match is specified by the corresponding \texttt{strwidth} option. If no substring option is set, no substring matching is performed at all. If any substring option is specified, then substring matching is performed and the missing options are assigned built-in default values. If padding and substring matching are both specified, the substring match is performed first.
\intitem[4]{strwidth}
The number of characters to match.
\end{optionlist*}
\cmditem{literal}{string}
The \cmd{literal} element adds a literal \prm{string} to the sorting specification. This is useful as a fallback if some fields are not available.
\csitem{citeorder}
The \cmd{citeorder} element has a special meaning. It requests a sort based on the lexical order of the actual citations. For entries cited within the same citation command like:
\begin{ltxexample}
\cite{one,two}
\end{ltxexample}
%
there is a distinction between the lexical order and the semantic order. Here «one» and «two» have the same semantic order but a unique lexical order. The semantic order only matters if you specify further sorting to disambiguate entries with the same semantic order. For example, this is the definition of the \opt{none} sorting template:
\begin{ltxexample}
\DeclareSortingTemplate{none}{
\sort{\citeorder}
}
\end{ltxexample}
%
This sorts the bibliography purely lexically by the order of the keys in the citation commands. In the example above, it sorts «one» before «two». However, suppose that you consider «one» and «two» to have the same order (semantic order) since they are cited at the same time and want to further sort these by year. Suppose «two» has an earlier \bibfield{year} than «one»:
\begin{ltxexample}
\DeclareSortingTemplate{noneyear}{
\sort{\citeorder}
\sort{<<year>>}
}
\end{ltxexample}
%
This sorts «two» before «one», even though lexically, «one» would sort before «two». This is possible because the semantic order can be disambiguated by the further sorting on year. With the standard \opt{none} sorting template, the lexical order and semantic order are identical because there is nothing further to disambiguate them. This means that you can use \cmd{citeorder} just like any other sorting specification element, choosing how to further sort entries cited at the same time (in the same citation command).
\cmditem{DeclareSortingNamekeyTemplate}[name]{specification}
Defines how the sorting keys for names are constructed. This can change the sorting order of names arbitrarily because you can choose how to put together the name parts when constructing the string to compare when sorting. The sorting key construction template so defined is called \prm{name} which defaults to «global» if this optional parameter is absent. When constructing the sorting key for a name, a sorting key for each name part is constructed and the key for each name is formed into an ordered key list with a special internal separator. The point of this option is to accommodate languages or situations where sorting of names needs to be customised (for example, Icelandic names are sometimes sorted by given names rather than by family names). This macro may be used multiple times to define templates with different names which can then be referred to later. Sorting name key templates can be specified at the following scopes, in order of increasing precedence:
\begin{itemize}
\item The default template defined without the optional name argument
\item Given as the \opt{sortingnamekeytemplate} option to a reference context (see \secref{use:bib:context})
\item Given as a per-entry option \opt{sortnamekeytemplate} in a bibliography data source entry
\item Given as a per-namelist option \opt{sortnamekeytemplate}
\item Given as a per-name option \opt{sortnamekeytemplate}
\end{itemize}
By default there is only a global template which has the following \prm{specification}:
\begin{ltxexample}
\DeclareSortingNamekeyTemplate{
\keypart{
\namepart[use=true]{<<prefix>>}
\namepart{<<family>>}
}
\keypart{
\namepart{<<given>>}
}
\keypart{
\namepart{<<suffix>>}
}
\keypart{
\namepart[use=false]{<<prefix>>}
}
}
\end{ltxexample}
%
This means that the key is constructed by concatenating, in order, the name prefix (only if the \opt{useprefix} option is true) with the family name(s), the given names(s), the name suffix and then the name prefix (only if the \opt{useprefix} option is false).
\cmditem{keypart}{part}
\prm{part} is an ordered list of of \cmd{namepart} and \cmd{literal} specifications which are concatenated together when constructing a part of the name sorting key. The \cmd{keyparts} are then concatenated together with terminal padding to ensure correct sorting.
\cmditem{literal}{string}
A literal string to insert into the name sorting key.
\cmditem{namepart}{name}
Specifies the \prm{name} of a namepart to use in constructing the name sorting key.
\begin{optionlist*}
\boolitem[true]{use}
Indicates that the namepart \prm{name} is only to be used in this concatenation position if the corresponding \opt{use<name>} option is set to the specified boolean value.
\boolitem[true]{inits}
Indicates that only the initials of namepart \prm{name} are to be used in
constructing the sorting specification.
\end{optionlist*}
\end{ltxsyntax}
As an example, suppose you wanted to be able to sort names by given name rather than family name, you could define a sorting name key template like this:
\begin{ltxexample}
\DeclareSortingNamekeyTemplate[givenfirst]{
\keypart{
\namepart{<<given>>}
}
\keypart{
\namepart[use=true]{<<prefix>>}
}
\keypart{
\namepart{<<family>>}
}
\keypart{
\namepart[use=false]{<<prefix>>}
}
}
\end{ltxexample}
%
You can then use the name \opt{givenfirst} at the appropriate scope in order to make \biber use this template when constructing sorting name keys. For example, you could enable this for one bibliography list like this:
\begin{ltxexample}
\begin{refcontext}[sortnamekeytemplate=givenfirst]
\printbibliography
\end{refcontext}
\end{ltxexample}
%
or perhaps you only want to do this for a particular entry:
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
OPTIONS = {sortnamekeytemplate=givenfirst},
AUTHOR = {Arnar Vigfusson}
}
\end{lstlisting}
%
or just a name list by using the option as a pseudo-name which will be ignored:
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
AUTHOR = {sortnamekeytemplate=givenfirst and Arnar Vigfusson}
}
\end{lstlisting}
%
or just a single name by passing the option as part of the extended name information
format which \biber supports (see \biber doc):
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
AUTHOR = {given=Arnar, family=Vigfusson, sortnamekeytemplate=givenfirst}
}
\end{lstlisting}
%
Now we give some examples of sorting templates. In the first example, we define a simple name\slash title\slash year template. The name element may be either the \bibfield{author}, the \bibfield{editor}, or the \bibfield{translator}. Given this specification, the sorting routine will use the first element which is available and continue with the \bibfield{title}. Note that the options \opt{use$<$name$>$} options are considered automatically in the sorting process:
\begin{ltxexample}
\DeclareSortingTemplate{sample}{
\sort{
\field{<<author>>}
\field{<<editor>>}
\field{<<translator>>}
}
\sort{
\field{<<title>>}
}
\sort{
\field{<<year>>}
}
}
\end{ltxexample}
%
In the next example, we define the same template in a more elaborate way, considering special fields such as \bibfield{presort}, \bibfield{sortkey}, \bibfield{sortname}, etc. Since the \bibfield{sortkey} field specifies the master sort key, it needs to override all other elements except for \bibfield{presort}. This is indicated by the \opt{final} option. If the \bibfield{sortkey} field is available, processing will stop at this point. If not, the sorting routine continues with the next \cmd{sort} directive. This setup corresponds to the default definition of the \texttt{nty} template:
\begin{ltxexample}
\DeclareSortingTemplate{nty}{
\sort{
\field{<<presort>>}
}
\sort[final]{
\field{<<sortkey>>}
}
\sort{
\field{<<sortname>>}
\field{<<author>>}
\field{<<editor>>}
\field{<<translator>>}
\field{<<sorttitle>>}
\field{<<title>>}
}
\sort{
\field{<<sorttitle>>}
\field{<<title>>}
}
\sort{
\field{<<sortyear>>}
\field{<<year>>}
}
}
\end{ltxexample}
%
Finally, here is an example of a sorting template which overrides the global sorting locale and additionally overrides again when sorting by the \bibfield{origtitle} field. Note the use in the template-level override of a babel/polyglossia language name instead of a real locale identifier. \biber will map this to a suitable, real locale identifier (in this case, \texttt{sv\_SE}):
\begin{ltxexample}
\DeclareSortingTemplate[locale=swedish]{custom}{
\sort{
\field{<<sortname>>}
\field{<<author>>}
\field{<<editor>>}
\field{<<translator>>}
\field{<<sorttitle>>}
\field{<<title>>}
}
\sort[locale=de_DE_phonebook]{
\field{<<origtitle>>}
}
}
\end{ltxexample}
\begin{ltxsyntax}
\cmditem{DeclareSortExclusion}{entrytype, \dots}{field, \dots}
Specifies fields to be excluded from sorting on a per-type basis. The \prm{entrytype} argument and the \prm{field} argument may be a comma"=separated list of values. A blank \prm{field} argument will clear all exclusions for this \prm{entrytype}. A value of <*> for \prm{entrytype} will exclude \prm{field,\dots} for every entrytype. This is equivalent to simply deleting the field from the sorting specification and is only normally used in combination with \cmd{DeclareSortInclusion} when one wishes to exclude a field for all but explicitly included entrytypes. See example in \cmd{DeclareSortInclusion} below. This command may only be used in the preamble.
\cmditem{DeclareSortInclusion}{entrytype, \dots}{field, \dots}
Only used along with \cmd{DeclareSortExclusion}. Specifies fields to be included in sorting on a per-type basis. This allows the user to exclude a field from sorting for all entrytypes and then to override this for certain entrytypes. This is easier sometimes than using \cmd{DeclareSortExclusion} to list exclusions for many entrytypes. The \prm{entrytype} argument and the \prm{field} argument may be a comma"=separated list of values. This command may only be used in the preamble. For example, this would use \bibfield{title} during sorting only for \bibtype{article}s:
\begin{ltxexample}
\DeclareSortExclusion{*}{title}
\DeclareSortInclusion{article}{title}
\end{ltxexample}
\cmditem{DeclarePresort}[entrytype, \dots]{string}
Specifies a string to be used to automatically populate the \bibfield{presort} field of entries without a \bibfield{presort} field. The \bibfield{presort} may be defined globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the \prm{string} applies to the respective entry type. If not, it serves as the global default value. Specifying an \prm{entrytype} in conjunction with a blank \prm{string} will clear the type-specific setting. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble.
\cmditem{DeclareSortTranslit}[entrytype]{specification}
Languages which can be written in different scripts or alphabets often only have CLDR sorting tailoring for one script and it is expected that you transliterate into the supported script for sorting purposes. A common example is Sanskrit which is often written in academic contexts in IAST
romanised script but which needs to be sorted in the <sa> locale which expects the Devanāgarī script. Another common case is transliteration of Russian Cyrillic into Latin as defined by the ALA-LC standard. Such requirement means that it is necessary to transliterate into the sorting script internally. \cmd{DeclareSortTranslit} declares which parts of an entry you would like to transliterate for sorting purposes. Without the \prm{entrytype} parameter, the \prm{specification} applies to all entrytypes. The \prm{specification} is one or more \cmd{translit} commands:
\cmditem{translit}[langids]{field or fieldset}{from}{to}
Specifies that the data field \bibfield{field} or all fields in a fieldset \prm{fieldset} declared with \cmd{DeclareDatafieldSet} (see \secref{aut:ctm:dsets}) should be transliterated from script \prm{from} to script \prm{to} for sorting purposes. The field/set argument should be <*> to apply transliteration to all fields. The valid \prm{from} and \prm{to} values are given in table \ref{tab:translit}. The optional \prm{langids} parameter is a comma-separated list of \bibfield{langid} fields and the transliteration will apply only to bibliography entries containing one of the \bibfield{langid}s in the list. Note that \biblatex does not aim to support general transliteration, only those which are useful for sorting purposes. Please open a GitHub ticket for \biblatex\ if you think you need additional transliterations.
An example of transliterating titles so that they sort correctly in Sanskrit. This example assumes that entries that should have their title fields transliterated have a \bibfield{langid} field set to <sanskrit>.
\begin{ltxexample}
\DeclareDatafieldSet{settitles}{
\member[field=title]
\member[field=booktitle]
\member[field=eventtitle]
\member[field=issuetitle]
\member[field=journaltitle]
\member[field=maintitle]
\member[field=origtitle]
}
\DeclareSortTranslit{
\translit[sanskrit]{settitles}{iast}{devanagari}
}
\end{ltxexample}
\end{ltxsyntax}
\begin{table}
\caption{Valid transliteration pairs}
\label{tab:translit}
\tablesetup\centering
\begin{tabular}{lll}
\toprule
\sffamily\bfseries\spotcolor From
& \sffamily\bfseries\spotcolor To
& Description\\
\midrule
iast & devanagari & Sanskrit IAST to Devanāgarī\\
russian & ala-lc & ALA-LC romanisation for Russian\\
russian & bgn/pcgn-standard & BGN/PCGN:1947 (Standard Variant), Cyrillic to Latin, Russian\\
\bottomrule
\end{tabular}
\end{table}
\subsubsection[Bibliography List Filters]{Bibliography List Filters}
\label{aut:ctm:bibfilt}
When using customisable bibliography lists (See \secref{use:bib:biblist}), usually one wants to return in the \file{.bbl} only those entries which have the particular fields which the bibliography list is summarising. For example, when printing a normal list of shorthands, you want the list returned by \biber in the \file{.bbl} to contain only those entries which have a \bibfield{shorthand} field. This is accomplished by defining a bibliography list filter using the \cmd{DeclareBiblistFilter} command. This differs from the filters defined using \cmd{defbibfilter} (see \secref{use:bib:flt}) since the filters defined by \cmd{defbibfilter} run inside \biblatex after the \file{.bbl} has been generated.
\begin{ltxsyntax}
\cmditem{DeclareBiblistFilter}{name}{specification}
Defines a bibliography list filter with \prm{name}. The \prm{specification} consists of one or more \cmd{filter} or \cmd{filteror} macros, all of which must be satisfied for the entry to pass the filter:
\cmditem{filter}[filterspec]{filter}
Filter entries according to the \prm{filterspec} and \prm{filter}. \prm{filterspec} can be one of:
\end{ltxsyntax}
\begin{description}
\item[type/nottype] Entry is/is not of \bibfield{entrytype} \prm{filter}
\item[subtype/notsubtype] Entry is/is not of \bibfield{subtype} \prm{filter}
\item[keyword/notkeyword] Entry has/does not have \bibfield{keyword} \prm{filter}
\item[field/notfield] Entry has/does not have a field called \prm{filter}
\end{description}
\begin{ltxsyntax}
\cmditem{filteror}{type}{filters}
A wrapper around one or more \cmd{filter} commands specifying that they form a disjunctive set, i.e. any one of the \prm{filters} must be satisfied.
\end{ltxsyntax}
Fields in the datamodel which are marked as <Label fields> (see \secref{aut:ctm:dm}) automatically have a filter defined for them with the same name and which filters out any entries which do no contain the field. For example, \biblatex automatically generates a filter for the \bibfield{shorthand} field:
\begin{ltxexample}
\DeclareBiblistFilter{<<shorthand>>}{
\filter[type=field,filter=shorthand]
}
\end{ltxexample}
\subsubsection{Controlling Name Initials Generation}
\label{aut:ctm:noinit}
Generating initials for name parts from a given name involves some difficulties when you have names with prefixes, diacritics, hyphens etc. Often, you want to ignore things like prefixes when generating initials so that the initials for «al-Hasan» is just «H» instead of «a-H». This is tricky when you also have names like «Ho-Pun» where you want the initials to be «H-P», for example.
\begin{ltxsyntax}
\cmditem{DeclareNoinit}{specification}
Defines regular expressions to strip from names before generating initials. The \prm{specification} is an undelimited list of \cmd{noinit} directives which specify the regular expressions to remove from the name. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{noinit}{regexp}
Any number of \cmd{noinit} commands can be given each of which specifies to remove the \prm{regexp} from the copy of the name which the initials generation system sees. Since regular expressions usually contain special characters, it is best to enclose them in the provided \cmd{regexp} macro as shown---this will pass the expression through to \biber correctly.
\end{ltxsyntax}
If there is no \cmd{DeclareNoinit} specification, \biber will default to:
\begin{ltxexample}
\DeclareNoinit{
% strip lowercase prefixes like 'al-' when generating initials from names
\noinit{\regexp{<<\b\p{Ll}{2}\p{Pd}>>}}
% strip some common diacritics when generating initials from names
\noinit{\regexp{<<[\x{2bf}\x{2018}]>>}}
}
\end{ltxexample}
%
This \biber default strips a couple of diacritics and also strips lowercase prefixes from names before generating initials.
\subsubsection{Fine Tuning Sorting}
\label{aut:ctm:nosort}
It can be useful to fine tune sorting so that it ignores certain parts of particular fields.
\begin{ltxsyntax}
\cmditem{DeclareNosort}{specification}
Defines regular expressions to strip from particular fields or types of fields when sorting. The \prm{specification} is an undelimited list of \cmd{nosort} directives which specify the regular expressions to remove from particular fields or type of field. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
\cmditem{nosort}{field or datafield set}{regexp}
Any number of \cmd{nosort} commands can be given each of which specifies to remove the \prm{regexp} from the \prm{field} or \prm{datafield set}. A \prm{datafield set} is simply a convenience grouping of semantically similar fields from which you might want to remove a regexp. See \secref{aut:ctm:dsets} for the avaiable sets, their members and customisation. Since regular expressions usually contain special characters, it is best to enclose them in the provided \cmd{regexp} macro as shown---this will pass the expression through to \biber correctly.
\end{ltxsyntax}
The default is:
\begin{ltxexample}
\DeclareNosort{
% strip prefixes like 'al-' when sorting names
\nosort{setnames}{\regexp{<<\A\p{L}{2}\p{Pd}>>}}
% strip some diacritics when sorting names
\nosort{setnames}{\regexp{<<[\x{2bf}\x{2018}]>>}}
}
\end{ltxexample}
%
This \biber default strips a couple of diacritics and also strips two-letter prefixes (like «Al-») from names when sorting. Suppose you wanted to ignore «The» at the beginning of the \bibfield{title} field when sorting:
\begin{ltxexample}
\DeclareNosort{
\nosort{<<title>>}{\regexp{<<\AThe\s+>>}}
}
\end{ltxexample}
%
Or if you wanted to ignore «The» at the beginning of any title field:
\begin{ltxexample}
\DeclareNosort{
\nosort{<<settitles>>}{\regexp{<<\AThe\s+>>}}
}
\end{ltxexample}
\subsubsection{Special Fields}
\label{aut:ctm:fld}
Some of the automatically generated fields from \secref{aut:bbx:fld:lab} may be customized.
\begin{ltxsyntax}
\cmditem{DeclareLabelname}[entrytype, \dots]{specification}
Defines the fields to consider when generating the \bibfield{labelname} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} commands. The fields are checked in the order listed and the first field which is available will be used as \bibfield{labelname}. This is the default definition:
\begin{ltxexample}
\DeclareLabelname{%
\field{shortauthor}
\field{author}
\field{shorteditor}
\field{editor}
\field{translator}
}
\end{ltxexample}
%
The \bibfield{labelname} field may be customized globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the specification applies to the respective entry type. If not, it is applied globally. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble.
\cmditem{DeclareLabeldate}[entrytype, \dots]{specification}
Defines the date components to consider when generating \bibfield{labelyear}, \bibfield{labelmonth}, \bibfield{labelday}, \bibfield{labelendyear}, \bibfield{labelendmonth} and \bibfield{labelendday} fields (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} or \cmd{literal} commands. The items are checked in the order listed and the first item which is available will be used to popluate the mentioned fields. Note that the \cmd{field} items do not have to be datetype <date> in the data model so that you can create pseudo-year labels by, for example, using a \bibfield{pubstate} field contents, if available, as the year label by defining \cmd{DeclareLabeldate} suitably. Note also that a \cmd{literal} command will always be used when found and so this should always be the last thing in the list. If the value of a \cmd{literal} command is a valid localisation string, then this will be resolved in the current language, otherwise the value is used as a literal string as-is. This is the default definition:
\begin{ltxexample}
\DeclareLabeldate{%
\field{date}
\field{year}
\field{eventdate}
\field{origdate}
\field{urldate}
\literal{nodate}
}
\end{ltxexample}
%
Note that the \bibfield{date} field is split by the backend into \bibfield{year}, \bibfield{month} which are also valid fields in the default data model. In order to support legacy data which directly sets \bibfield{year} and/or \bibfield{month}, the specification <\bibfield{date}> in \cmd{DeclareLabeldate} will also match \bibfield{year} and \bibfield{month} fields, if present.
The \bibfield{label*} fields may be customized globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the specification applies to the respective entry type. If not, it is applied globally. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble. See also \secref{aut:bbx:fld:dat}.
\cmditem{DeclareExtradate}{specification}
Defines how \biber tracks information used to construct the \bibfield{extradate} field. This field (see \secref{aut:bbx:fld:lab}) is printed to disambiguate works by the same author which occur in the same date scope. By default, the date scope is the year and so two works by the same author within the same year will have different \bibfield{extradate} values which are used to disambiguate the works in the bibliography in the usual manner seen in many authoryear type styles. The \prm{specification} is one or more \cmd{scope} specifications which can contain one or more \cmd{field} specifications. Within a \cmd{scope}, the existence of each \cmd{field} will be checked and if found, the first \cmd{field} is used and the rest are ignored. This allows a fallback in case certain fields are not available in all entries. All \cmd{scope}s are used to track information and \cmd{scope}s should be specified in decreasing order of generality (e.g. year then month then day etc) The default definition is:
\begin{ltxexample}
\DeclareExtradate{%
\scope{
\field{labelyear}
\field{year}
}
}
\end{ltxexample}
%
This means that the \bibfield{labelyear} field only (or \bibfield{year} if this does not exist) will be used to track works by the same author. With the following datasource entries:
\begin{lstlisting}[style=bibtex]{}
@BOOK{extra1,
AUTHOR = {John Doe},
DATE = {2001-01}
}
@BOOK{extra2,
AUTHOR = {John Doe},
DATE = {2001-02}
}
\end{lstlisting}
%
The default definition would result in:
\begin{lstlisting}{}
Doe 2001a
Doe 2001b
\end{lstlisting}
%
Here, \bibfield{extradate} only considers the \bibfield((label)year) information and since this is identical, disambiguation is required. However, consider the following definition:
\begin{ltxexample}
\DeclareExtradate{%
\scope{
\field{labelyear}
\field{year}
}
\scope{
\field{labelmonth}
}
}
\end{ltxexample}
%
The result would be:
\begin{lstlisting}{}
Doe 2001
Doe 2001
\end{lstlisting}
%
If only years were printed, this would be ambiguous because \bibfield{extradate} now considers \bibfield{labelmonth} and since this differs, no disambiguation is necessary. Care should therefore be taken to synchronise the printed information with the \bibfield{extradate} disambiguation settings. Notice that the second definition is <month-in-year> disambiguation and quite different from:
\begin{ltxexample}
\DeclareExtradate{%
\scope{
\field{labelmonth}
}
}
\end{ltxexample}
%
which is just plain <month> disambiguation which is very unlikely to be what you ever want to do since this disambiguation only based on month and ignores the year entirely. \bibfield{extradate} calculation should almost always be based on all information down to the resolution you require. For example, if you wish to disambiguate right down to the hour level (perhaps useful in large bibliographies of rapidly changing online material), you would specify something like this:
\begin{ltxexample}
\DeclareExtradate{%
\scope{
\field{labelyear}
\field{year}
}
\scope{
\field{labelmonth}
}
\scope{
\field{labelday}
}
\scope{
\field{labelhour}
}
}
\end{ltxexample}
%
Entries without the specified granularity of information will disambiguate at the lowest granularity they contain, so, for example, with:
\begin{ltxexample}
\DeclareExtradate{%
\scope{
\field{labelyear}
\field{year}
}
\scope{
\field{labelmonth}
}
}
\end{ltxexample}
%
\begin{lstlisting}[style=bibtex]{}
@BOOK{extra1,
AUTHOR = {John Doe},
DATE = {2001}
}
@BOOK{extra2,
AUTHOR = {John Doe},
DATE = {2001}
}
\end{lstlisting}
%
The result would still be:
\begin{lstlisting}{}
Doe 2001a
Doe 2001b
\end{lstlisting}
%
This command may only be used in the preamble.
\cmditem{DeclareLabeltitle}[entrytype, \dots]{specification}
Defines the fields to consider when generating the \bibfield{labeltitle} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} commands. The fields are checked in the order listed and the first field which is available will be used as \bibfield{labeltitle}. This is the default definition:
\begin{ltxexample}
\DeclareLabeltitle{%
\field{shorttitle}
\field{title}
}
\end{ltxexample}
%
The \bibfield{labeltitle} field may be customized globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the specification applies to the respective entry type. If not, it is applied globally. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble.
\end{ltxsyntax}
\subsubsection{Data Inheritance (\bibfield{crossref})}
\label{aut:ctm:ref}
\biber features a highly customizable cross-referencing mechanism with flexible data inheritance rules. This sections deals with the configuration interface. See \apxref{apx:ref} for the default configuration. A note on terminology: the \emph{child} or \emph{target} is the entry with the \bibfield{crossref} field, the \emph{parent} or \emph{source} is the entry the \bibfield{crossref} field points to. The child inherits data from the parent.
\begin{ltxsyntax}
\cmditem{DefaultInheritance}[exceptions]{options}
Configures the default inheritance behavior. This command may only be used in the preamble. The default behavior may be customized be setting the following \prm{options}:
\begin{optionlist*}
\boolitem[true]{all} Whether or not to inherit all fields from the parent by default.
\kvopt{all}{true} means that the child entry inherits all fields from the parent, unless a more specific inheritance rule has been set up with \cmd{DeclareDataInheritance}. If an inheritance rule is defined for a field, data inheritance is controlled by that rule. \kvopt{all}{false} means that no data is inherited from the parent by default and each field to be inherited requires an explicit inheritance rule set up with \cmd{DeclareDataInheritance}. The package default is \kvopt{all}{true}.
\boolitem[false]{override} Whether or not to overwrite target fields with source fields if both are defined. This applies both to automatic inheritance and to explicit inheritance rules. The package default is \kvopt{override}{false}, \ie existing fields of the child entry are not overwritten.
\valitem{ignore}{csv list of uniqueness options}
This option takes a comma-separated list of one of more of <singletitle>, <uniquetitle>, <uniquebaretitle> and/or <uniquework>. The purpose of this option is to ignore tracking information for these three options when the field which would trigger the tracking (\tabref{use:opt:wu}) is inherited. An example---Suppose that you have several \bibtype{book} entries which all crossref a \bibtype{mvbook} from which they get their \bibfield{author} field. You might reasonably want the \cmd{ifsingletitle} test to return <true> for this author as their only <work> is the \bibtype{mvbook}. Similar comments would apply to situations involving the \cmd{ifuniquetitle}, \cmd{ifuniquebaretitle} and \cmd{ifuniquework} tests. The \opt{ignore} option lists which of these should have their tracking information ignored when the fields which would trigger them are inherited. The idea is that the presence of an inherited field does not contribute towards the determination of whether some combination of name/title is unique in the bibliographic data. For example, this modified default setting would ignore \opt{singletitle} and \opt{uniquetitle} tracking:
\begin{ltxexample}
\DefaultInheritance{ignore={singletitle,uniquetitle}, all=true, override=false}
\end{ltxexample}
%
Of course, the ignoring of tracking does nothing if the fields inherited do not play a role in tracking. Only the fields listed in \tabref{use:opt:wu} are relevant to this option.
\end{optionlist*}
The optional \prm{exceptions} are an undelimited list of \cmd{except} directives. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{exceptions}. Blank lines are not permissible.
\cmditem{except}{source}{target}{options}
Defines an exception to the default inheritance rules.
\cmd{DeclareDataInheritance} sets the inheritance \prm{options} for a specific \prm{source} and \prm{target} combination. The \prm{source} and \prm{target} arguments specify the parent and the child entry type. The asterisk matches all types and is permissible in either argument.
\cmditem{DeclareDataInheritance}[options]{source, \dots}{target, \dots}{rules}
Declares inheritance rules. The \prm{source} and \prm{target} arguments specify the parent and the child entry type. Either argument may be a single entry type, a comma"=separated list of types, or an asterisk. The asterisk matches all entry types. The \prm{rules} are an undelimited list of \cmd{inherit} and\slash or \cmd{noinherit} directives. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{rules}. Blank lines are not permissible. This command may only be used in the preamble. The options are:
\begin{optionlist*}
\valitem{ignore}{csv list of uniqueness options}
As the \opt{ignore} option on \cmd{DefaultInheritance} explained above. When set here, it takes precedence over any global options set with \cmd{DefaultInheritance}. For example, this would ignore \opt{singletitle} and \opt{uniquetitle} tracking for a \bibtype{book} inheriting from a \bibtype{mvbook}.
\begin{ltxexample}
\DeclareDataInheritance[ignore={singletitle,uniquetitle}]{mvbook}{book}{<<...>>}
\end{ltxexample}
\end{optionlist*}
\cmditem{inherit}[option]{source}{target}
Defines an inheritance rule by mapping a \prm{source} field to a \prm{target} field. \prm{option} can be one of
\begin{optionlist*}
\boolitem[false]{override}
As the \opt{override} option for \cmd{DefaultInheritance} explained above. When set here, it takes precedence over any global options set with \cmd{DefaultInheritance}.
\end{optionlist*}
\cmditem{noinherit}{source}
Unconditionally prevents inheritance of the \prm{source} field.
\csitem{ResetDataInheritance}
Clears all inheritance rules defined with \cmd{DeclareDataInheritance}. This command may only be used in the preamble.
\end{ltxsyntax}
Here are some practical examples:
\begin{ltxexample}
\DefaultInheritance{<<all=true>>,<<override=false>>}
\end{ltxexample}
%
This example shows how to configure the default inheritance behavior. The above settings are the package defaults.
\begin{ltxexample}
\DefaultInheritance[
\except{<<*>>}{<<online>>}{<<all=false>>}
]{all=true,override=false}
\end{ltxexample}
%
This example is similar to the one above but adds one exception: entries of type \bibtype{online} will, by default, not inherit any data from any parent.
\begin{ltxexample}
\DeclareDataInheritance{<<collection>>}{<<incollection>>}{
\inherit{<<title>>}{<<booktitle>>}
\inherit{<<subtitle>>}{<<booksubtitle>>}
\inherit{<<titleaddon>>}{<<booktitleaddon>>}
}
\end{ltxexample}
%
So far we have looked at setting up standard inheritance. For example, \kvopt{all}{true} means that the \bibfield{publisher} field of a source entry is copied to the \bibfield{publisher} field of the target entry. In some cases, however, asymmetric mappings are required. They are defined with \cmd{DeclareDataInheritance}. The above example sets up three typical rules for \bibtype{incollection} entries referencing a \bibtype{collection}. We map the \bibfield{title} and related fields of the source to the corresponding \bibfield{booktitle} fields of the target.
\begin{ltxexample}
\DeclareDataInheritance{<<mvbook,book>>}{<<inbook,bookinbook>>}{
\inherit{<<author>>}{<<author>>}
\inherit{<<author>>}{<<bookauthor>>}
}
\end{ltxexample}
%
This rule is an example of one-to-many mapping: it maps the \bibfield{author} field of the source to both the \bibfield{author} and the \bibfield{bookauthor} fields of the target in order to allow for compact \bibfield{inbook}\slash \bibfield{bookinbook} entries. The source may be either a \bibtype{mvbook} or a \bibtype{book} entry, the target either an \bibtype{inbook} or a \bibtype{bookinbook} entry.
\begin{ltxexample}
\DeclareDataInheritance{<<*>>}{<<inbook,incollection>>}{
\noinherit{<<introduction>>}
}
\end{ltxexample}
%
This rule prevents inheritance of the \bibfield{introduction} field. It applies to all targets of type
\bibtype{inbook} or \bibtype{incollection}, regardless of the source entry type.
\begin{ltxexample}
\DeclareDataInheritance{<<*>>}{<<*>>}{
\noinherit{<<abstract>>}
}
\end{ltxexample}
%
This rule, which applies to all entries, regardless of the source and target entry types, prevents inheritance of the \bibfield{abstract} field.
\begin{ltxexample}
\DefaultInheritance{all=true,override=false}
\ResetDataInheritance
\end{ltxexample}
%
This example demonstrates how to emulate traditional \bibtex's cross"=referencing mechanism. It enables inheritance by default, disables overwriting, and clears all other inheritance rules and mappings.
In a bibliography entry, you can give an option <noinherit> where the value
is a datafield set defined with \cmd{DeclareDatafieldSet}
(\secref{aut:ctm:dsets}). This will block inheritance of the fields in the
set on a per-entry basis. For example:
\begin{ltxexample}
\DeclareDatafieldSet{nobtitle}{
\member[field=booktitle]
}
\end{ltxexample}
\begin{lstlisting}[style=bibtex]{}
@INBOOK{s1,
OPTIONS = {noinherit=nobtitle},
TITLE = {Subtitle},
CROSSREF = {s2}
}
@BOOK{s2,
TITLE = {Title}
}
\end{lstlisting}
%
Here, \bibfield{s1} will not inherit the \bibfield{TITLE} of \bibfield{s2}
as \bibfield{BOOKTITLE} as this is blocked by the datafield set given as
the value to the \opt{noinherit} option.
%
One important thing to note is that children will never inherit any dateparts of a given type if they already contain a datepart of that type. So, for example:
\begin{lstlisting}[style=bibtex]{}
@INBOOK{b1,
DATE = {2004-03-03},
ORIGDATE = {2004-03},
CROSSREF = {b2}
}
@BOOK{b2,
DATE = {2004-03-03/2005-08-09},
ORIGDATE = {2004-03/2005-08},
EVENTDATE = {2004-03/2005-08},
}
\end{lstlisting}
%
Here, \bibfield{b1} will not inherit any of \bibfield{endyear}, \bibfield{endmonth}, \bibfield{endday}, \bibfield{origendyear} or \bibfield{origendmonth} as this would make a mess of its own dates. It will, given the inheritance defaults, inherit all of the \bibfield{event*} date parts.
\subsection{Auxiliary Commands}
\label{aut:aux}
The facilities in this section are intended for analyzing and saving bibliographic data rather than formatting and printing it.
\subsubsection{Data Commands}
\label{aut:aux:dat}
The commands in this section grant low"=level access to the unformatted bibliographic data. They are not intended for typesetting but rather for things like saving data to a temporary macro so that it may be used in a comparison later.
\begin{ltxsyntax}
\cmditem{thefield}{field}
Expands to the unformatted \prm{field}. If the \prm{field} is undefined, this command expands to an empty string.
\cmditem{strfield}{field}
Similar to \cmd{thefield}, except that the field is automatically sanitized such that its value may safely be used in the formation of a control sequence name.
\cmditem{csfield}{field}
Similar to \cmd{thefield}, but prevents expansion.
\cmditem{usefield}{command}{field}
Executes \prm{command} using the unformatted \prm{field} as its argument.
\cmditem{thelist}{literal list}
Expands to the unformatted \prm{literal list}. If the list is undefined, this command expands to an empty string. Note that this command will dump the \prm{literal list} in the internal format used by this package. This format is not suitable for printing.
\cmditem{strlist}{literal list}
Similar to \cmd{thelist}, except that the list internal representation is automatically sanitized such that its value may safely be used in the formation of a control sequence name.
\cmditem{thefirstlistitem}{literal list}
Expands to the unformatted first item in \prm{literal list}. If the \prm{literal list} is undefined, this command expands to an empty string.
\cmditem{strfirstlistitem}{literal list}
Similar to \cmd{thefirstlistitem}, except that the item is automatically sanitized such that its value may safely be used in the formation of a control sequence name.
\cmditem{usefirstlistitem}{command}{literal list}
Executes \prm{command} using the unformatted first item of \prm{literal list} as its argument.
\cmditem{thename}{name list}
Expands to the unformatted \prm{name list}. If the list is undefined, this command expands to an empty string. Note that this command will dump the \prm{name list} in the internal format used by this package. This format is not suitable for printing.
\cmditem{strname}{name list}
Similar to \cmd{thename}, except that the name internal representation is automatically sanitized such that its value may safely be used in the formation of a control sequence name.
\cmditem{savefield}{field}{macro}
\cmditem*{savefield*}{field}{macro}
Copies an unformatted \prm{field} to a \prm{macro}. The regular variant of this command defines the \prm{macro} globally, the starred one works locally.
\cmditem{savelist}{literal list}{macro}
\cmditem*{savelist*}{literal list}{macro}
Copies an unformatted \prm{literal list} to a \prm{macro}. The regular variant of this command defines the \prm{macro} globally, the starred one works locally.
\cmditem{savename}{name list}{macro}
\cmditem*{savename*}{name list}{macro}
Copies an unformatted \prm{name list} to a \prm{macro}. The regular variant of this command defines the \prm{macro} globally, the starred one works locally.
\cmditem{savefieldcs}{field}{csname}
\cmditem*{savefieldcs*}{field}{csname}
Similar to \cmd{savefield}, but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{savelistcs}{literal list}{csname}
\cmditem*{savelistcs*}{literal list}{csname}
Similar to \cmd{savelist}, but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{savenamecs}{name list}{csname}
\cmditem*{savenamecs*}{name list}{csname}
Similar to \cmd{savename}, but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{restorefield}{field}{macro}
Restores a \prm{field} from a \prm{macro} defined with \cmd{savefield} before. The field is restored within a local scope.
\cmditem{restorelist}{literal list}{macro}
Restores a \prm{literal list} from a \prm{macro} defined with \cmd{savelist} before. The list is restored within a local scope.
\cmditem{restorename}{name list}{macro}
Restores a \prm{name list} from a \prm{macro} defined with \cmd{savename} before. The list is restored within a local scope.
\cmditem{clearfield}{field}
Clears the \prm{field} within a local scope. A field cleared this way is treated as undefined by subsequent data commands.
\cmditem{clearlist}{literal list}
Clears the \prm{literal list} within a local scope. A list cleared this way is treated as undefined by subsequent data commands.
\cmditem{clearname}{name list}
Clears the \prm{name list} within a local scope. A list cleared this way is treated as undefined by subsequent data commands.
\end{ltxsyntax}
\subsubsection{Stand-alone Tests}
\label{aut:aux:tst}
The commands in this section are various kinds of stand"=alone tests for use in bibliography and citation styles.
\begin{ltxsyntax}
\cmditem{if$<$datetype$>$julian}{true}{false}
Expands to \prm{true} if the date <datetype>date (\opt{date}, \opt{urldate}, \opt{eventdate} etc.) Was converted to the Julian Calendar due to the settings of the \opt{julian}and \opt{gregorianstart} options.
\cmditem{ifdatejulian}{true}{false}
As \cmd{if$<$datetype$>$julian} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{if$<$datetype$>$julian} command is aliased to this command.
\cmditem{if$<$datetype$>$dateera}{era}{true}{false}
Expands to \prm{true} if the date <datetype>date (\opt{date}, \opt{urldate}, \opt{eventdate} etc.) has an era specification equal to \prm{era} and \prm{false} otherwise. The supported \prm{era} strings which \biber determines and passes in the \file{.bbl} are:
\begin{description}
\item[bce]~BCE/BC era
\item[ce]~CE/AD era
\end{description}
This command is useful for determining whether to print the location
strings in \secref{aut:lng:key:dt}.
\cmditem{ifdateera}{era}{true}{false}
As \cmd{if$<$datetype$>$dateera} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{if$<$datetype$>$dateera} command is aliased to this command.
\cmditem{if$<$datetype$>$datecirca}{true}{false}
Expands to \prm{true} if the date <datetype>date (\opt{date}, \opt{urldate}, \opt{eventdate} etc.) had a <circa> marker in the source and \prm{false} otherwise. See \secref{bib:use:dat}. This command is useful for determining whether to print the location strings in \secref{aut:lng:key:dt}.
\cmditem{ifdatecirca}{true}{false}
As \cmd{if$<$datetype$>$datecirca} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{if$<$datetype$>$datecirca} command is aliased to this command.
\cmditem{if$<$datetype$>$dateuncertain}{true}{false}
Expands to \prm{true} if the date <datetype>date (\opt{date}, \opt{urldate}, \opt{eventdate} etc.) had an uncertainty marker in the source and \prm{false} otherwise. See \secref{bib:use:dat}. This command is useful for determining whether to print, for example, a question mark after a year.
\cmditem{ifdateuncertain}{true}{false}
As \cmd{if$<$datetype$>$dateuncertain} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{if$<$datetype$>$dateuncertain} command is aliased to this command.
\cmditem{ifenddateuncertain}{true}{false}
As \cmd{ifend$<$datetype$>$dateuncertain} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{ifend$<$datetype$>$dateuncertain} command is aliased to this command.
\cmditem{if$<$datetype$>$dateunknown}{true}{false}
Expands to \prm{true} if the date <datetype>date (\opt{date}, \opt{urldate}, \opt{eventdate} etc.) is marked as unknown (as opposed to open) in the source and \prm{false} otherwise. See \secref{bib:use:dat}.
\cmditem{ifdateunknown}{true}{false}
As \cmd{if$<$datetype$>$dateunknown} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{if$<$datetype$>$dateunknown} command is aliased to this command.
\cmditem{ifenddateunknown}{true}{false}
As \cmd{ifend$<$datetype$>$dateunknown} but for use in \cmd{mkbibdate*} formatting commands (\secref{aut:fmt:lng}) inside which the appropriate \cmd{ifend$<$datetype$>$dateunknown} command is aliased to this command.
\cmditem{iflabeldateisdate}{true}{false}
Expands to \prm{true} if labeldate is defined and was obtained from date, and to \prm{false} otherwise.
\cmditem{ifdatehasyearonlyprecision}{datetype}{true}{false}
Expands to \prm{true} if the \prm{datetype}date is defined and would be shown with year precision \cmd{print$<$datetype$>$date}, and to false otherwise.
\cmditem{ifdatehastime}{datetype}{true}{false}
Expands to \prm{true} if the \prm{datetype}date is defined, has a time component and \opt{$<$datetype$>$dateusetime} is true, and to false otherwise.
\cmditem{ifdateshavedifferentprecision}{datetype1}{datetype2}{true}{false}
Expands to \prm{true} if the two dates \prm{datetype1} and \prm{datetype2} would show in different precision when printed with \cmd{print$<$datetype1$>$date} and \cmd{print$<$datetype2$>$date} respectively, and to \prm{false} otherwise.
\cmditem{ifdateyearsequal}{datetype1}{datetype2}{true}{false}
Expands to \prm{true} if the two dates \prm{datetype1} and \prm{datetype2} have the same year and era. Since the sign of the date is saved in the era field, years should be compared using this command to avoid confusion when the two years have opposite signs
\cmditem{ifdatesequal}{datetype1}{datetype2}{true}{false}
Expands to \prm{true} if the two dates \prm{datetype1} and \prm{datetype2} are the same. Here \prm{datetype2} may be the <end> bit of \prm{datetype1} (or vice versa).
\cmditem{ifdaterangesequal}{datetype1}{datetype2}{true}{false}
Expands to \prm{true} if the two date ranges---that is the start and the end date---\prm{datetype1} and \prm{datetype2} are the same.
\cmditem{ifcaselang}[language]{true}{false}
Expands to \prm{true} if the optional \prm{language} is one of those
declared by \cmd{DeclareCaseLangs} (see \secref{aut:aux:msc}) and to
\prm{false} otherwise. Without the optional argument, checks the current
value of \cmd{currentlang}.
\cmditem{ifsortingnamekeytemplatename}{string}{true}{false}
Expands to \prm{true} if the \prm{string} is equal to the current in scope sorting name key template name (see \ref{aut:ctm:srt}), and to \prm{false} otherwise.
\cmditem{ifuniquenametemplatename}{string}{true}{false}
Expands to \prm{true} if the \prm{string} is equal to the current in scope uniqueness name key template name (see \ref{aut:ctm:srt}), and to \prm{false} otherwise.
\cmditem{iflabelalphanametemplatename}{string}{true}{false}
Expands to \prm{true} if the \prm{string} is equal to the current in scope alphabetic label name template name (see \ref{aut:ctm:srt}), and to \prm{false} otherwise.
\cmditem{iffieldundef}{field}{true}{false}
Expands to \prm{true} if the \prm{field} is undefined, and to \prm{false} otherwise.
\cmditem{iflistundef}{literal list}{true}{false}
Expands to \prm{true} if the \prm{literal list} is undefined, and to \prm{false} otherwise.
\cmditem{ifnameundef}{name list}{true}{false}
Expands to \prm{true} if the \prm{name list} is undefined, and to \prm{false} otherwise.
\cmditem{iffieldsequal}{field 1}{field 2}{true}{false}
Expands to \prm{true} if the values of \prm{field 1} and \prm{field 2} are equal, and to \prm{false} otherwise.
\cmditem{iflistsequal}{literal list 1}{literal list 2}{true}{false}
Expands to \prm{true} if the values of \prm{literal list 1} and \prm{literal list 2} are equal, and to \prm{false} otherwise.
\cmditem{ifnamesequal}{name list 1}{name list 2}{true}{false}
Expands to \prm{true} if the values of \prm{name list 1} and \prm{name list 2} are equal, and to \prm{false} otherwise.
\cmditem{iffieldequals}{field}{macro}{true}{false}
Expands to \prm{true} if the value of the \prm{field} is equal to the definition of \prm{macro}, and to \prm{false} otherwise.
\cmditem{iflistequals}{literal list}{macro}{true}{false}
Expands to \prm{true} if the value of the \prm{literal list} is equal to the definition of \prm{macro}, and to \prm{false} otherwise.
\cmditem{ifnameequals}{name list}{macro}{true}{false}
Expands to \prm{true} if the value of the \prm{name list} is equal to the definition of \prm{macro}, and to \prm{false} otherwise.
\cmditem{iffieldequalcs}{field}{csname}{true}{false}
Similar to \cmd{iffieldequals} but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{iflistequalcs}{literal list}{csname}{true}{false}
Similar to \cmd{iflistequals} but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{ifnameequalcs}{name list}{csname}{true}{false}
Similar to \cmd{ifnameequals} but takes the control sequence name \prm{csname} (without a leading backslash) as an argument, rather than a macro name.
\cmditem{iffieldequalstr}{field}{string}{true}{false}
Executes \prm{true} if the value of the \prm{field} is equal to \prm{string}, and \prm{false} otherwise. This command is robust.
\cmditem{iffieldxref}{field}{true}{false}
If the \bibfield{crossref}\slash \bibfield{xref} field of an entry is defined, this command checks if the \prm{field} is related to the cross"=referenced parent entry. It executes \prm{true} if the \prm{field} of the child entry is equal to the corresponding \prm{field} of the parent entry, and \prm{false} otherwise. If the \bibfield{crossref}\slash \bibfield{xref} field is undefined, it always executes \prm{false}. This command is robust. See the description of the \bibfield{crossref} and \bibfield{xref} fields in \secref{bib:fld:spc} as well as \secref{bib:cav:ref} for further information concerning cross"=referencing.
\cmditem{iflistxref}{literal list}{true}{false}
Similar to \cmd{iffieldxref} but checks if a \prm{literal list} is related to the cross"=referenced parent entry. See the description of the \bibfield{crossref} and \bibfield{xref} fields in \secref{bib:fld:spc} as well as \secref{bib:cav:ref} for further information concerning cross"=referencing.
\cmditem{ifnamexref}{name list}{true}{false}
Similar to \cmd{iffieldxref} but checks if a \prm{name list} is related to the cross"=referenced parent entry. See the description of the \bibfield{crossref} and \bibfield{xref} fields in \secref{bib:fld:spc} as well as \secref{bib:cav:ref} for further information concerning cross"=referencing.
\cmditem{ifcurrentfield}{field}{true}{false}
Executes \prm{true} if the current field is \prm{field}, and \prm{false} otherwise. This command is robust. It is intended for use in field formatting directives and always executes \prm{false} when used in any other context.
\cmditem{ifcurrentlist}{literal list}{true}{false}
Executes \prm{true} if the current list is \prm{literal list}, and \prm{false} otherwise. This command is robust. It is intended for use in list formatting directives and always executes \prm{false} when used in any other context.
\cmditem{ifcurrentname}{name list}{true}{false}
Executes \prm{true} if the current list is \prm{name list}, and \prm{false} otherwise. This command is robust. It is intended for use in list formatting directives and always executes \prm{false} when used in any other context.
\cmditem{ifuseprefix}{true}{false}
Expands to \prm{true} if the \opt{useprefix} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
\cmditem{ifuseauthor}{true}{false}
This is just a particular case of the \cmd{ifuse$<$name$>$} macro below but is mentioned here as \bibfield{author} is part of the default data model. Expands to \prm{true} if the \opt{useauthor} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
\cmditem{ifuseeditor}{true}{false}
This is just a particular case of the \cmd{ifuse$<$name$>$} macro below but is mentioned here as \bibfield{editor} is part of the default data model. Expands to \prm{true} if the \opt{useeditor} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
\cmditem{ifusetranslator}{true}{false}
This is just a particular case of the \cmd{ifuse$<$name$>$} macro below but is mentioned here as \bibfield{translator} is part of the default data model. Expands to \prm{true} if the \opt{usetranslator} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
\cmditem{ifuse$<$name$>$}{true}{false}
Expands to \prm{true} if the \opt{use$<$name$>$} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
\cmditem{ifcrossrefsource}{true}{false}
Expands to \prm{true} if the entry was inclued in the \file{.bbl} due to being referenced more than \opt{mincrossrefs} times and false otherwise. See \secref{use:opt:pre:gen}. Also expands to false if the entry was directly cited.
\cmditem{ifxrefsource}{true}{false}
Expands to \prm{true} if the entry was inclued in the \file{.bbl} due to being referenced more than \opt{minxrefs} times and false otherwise. See \secref{use:opt:pre:gen}. Also expands to false if the entry was directly cited.
\cmditem{ifsingletitle}{true}{false}
Expands to \prm{true} if there is only one work by the \opt{labelname} name in the bibliography, and to \prm{false} otherwise. If \opt{labelname} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{singletitle}.
\cmditem{ifnocite}{true}{false}
Expands to \prm{true} if the entry was \emph{only} included in the \file{.bbl} via \cmd{nocite}. That is, returns \prm{false} if an entry was both \cmd{nocite}'d and \cmd{cite}'d.
\cmditem{ifuniquetitle}{true}{false}
Expands to \prm{true} if there is only one work with the title \opt{labeltitle} and to \prm{false} otherwise. If \opt{labeltitle} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniquetitle}.
\cmditem{ifuniquebaretitle}{true}{false}
Expands to \prm{true} if \bibfield{labelname} is empty and there is only one work with the title \opt{labeltitle} and to \prm{false} otherwise. If \opt{labeltitle} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniquebaretitle}.
\cmditem{ifuniquework}{true}{false}
Expands to \prm{true} if there is only one work by the \opt{labelname} name with the \opt{labeltitle} title in the bibliography, and to \prm{false} otherwise. If neither \opt{labelname} nor \opt{labeltitle} are set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniquework}. If both \bibfield{singletitle} and \bibfield{uniquetitle} are false for the same entry, this could be because another entry has the same \bibfield{labdlname} and yet another, different, entry has the same \bibfield{labeltitle}. \bibfield{uniquework} would let you know that there is another entry that has \emph{both} the same \bibfield{labelname} \emph{and} the same \bibfield{labeltitle}. This could be helpful in cases where multiple people maintain bibliography datasources and there is a risk of adding the same work with different keys without other parties realising this. This test could help to find such duplicates.
\cmditem{ifuniqueprimaryauthor}{true}{false}
Expands to \prm{true} if the primary (first) author name of \opt{labelname} is unique in the bibliography list and to \prm{false} otherwise. This effectively answers the question <is there more than one author with the same base name>. The base name parts are defined by \cmd{DeclareUniquenameTemplate} see \secref{aut:cav:amb}. This is required by some styles (e.g. APA) which mandates primary author disambiguation only and only if there are (different) primary authors with the same family name. If \opt{labelname} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniqueprimaryauthor}.
\cmditem{ifandothers}{list}{true}{false}
Expands to \prm{true} if the \prm{list} is defined and has been truncated in the \file{bib} file with the keyword <\texttt{and others}>, and to \prm{false} otherwise. The \prm{list} may be a literal list or a name list.
\cmditem{ifmorenames}{true}{false}
Expands to \prm{true} if the current name list has been or will be truncated, and to \prm{false} otherwise. This command is intended for use in formatting directives for name lists. It will always expand to \prm{false} when used elsewhere. This command performs the equivalent of an \cmd{ifandothers} test for the current list. If this test is negative, it also checks if the \cnt{listtotal} counter is larger than \cnt{liststop}. This command may be used in a formatting directive to decide if a note such as «and others» or «et al.» is to be printed at the end of the list. Note that you still need to check whether you are in the middle or at the end of the list, \ie whether \cnt{listcount} is smaller than or equal to \cnt{liststop}, see \secref{aut:bib:dat} for details.
\cmditem{ifmoreitems}{true}{false}
This command is similar to \cmd{ifmorenames} but checks the current literal list. It is intended for use in formatting directives for literal lists. It will always expand to \prm{false} when used elsewhere.
\cmditem{if$<$namepart$>$inits}{true}{false}
Expands to \prm{true} or \prm{false}, depending on the state of the \opt{$<$namepart$>$inits} package option (see \secref{use:opt:pre:int}). This command is intended for use in formatting directives for name lists.
\cmditem{ifterseinits}{true}{false}
Expands to \prm{true} or \prm{false}, depending on the state of the \opt{terseinits} package option (see \secref{use:opt:pre:int}). This command is intended for use in formatting directives for name lists.
\cmditem{ifentrytype}{type}{true}{false}
Executes \prm{true} if the entry type of the entry currently being processed is \prm{type}, and \prm{false} otherwise.
\cmditem{ifkeyword}{keyword}{true}{false}
Executes \prm{true} if the \prm{keyword} is found in the \bibfield{keywords} field of the entry currently being processed, and \prm{false} otherwise.
\cmditem{ifentrykeyword}{entrykey}{keyword}{true}{false}
A variant of \cmd{ifkeyword} which takes an entry key as its first argument. This is useful for testing an entry other than the one currently processed. A user-facing version of this command is available for use in documents see \secref{use:eq}.
\cmditem{ifcategory}{category}{true}{false}
Executes \prm{true} if the entry currently being processed has been assigned to a \prm{category} with \cmd{addtocategory}, and \prm{false} otherwise.
\cmditem{ifentrycategory}{entrykey}{category}{true}{false}
A variant of \cmd{ifcategory} which takes an entry key as its first argument. This is useful for testing an entry other than the one currently processed. A user-facing version of this command is available for use in documents see \secref{use:eq}
\cmditem{ifciteseen}{true}{false}
Executes \prm{true} if the entry currently being processed has been cited before, and \prm{false} otherwise. This command is robust and intended for use in citation styles. If there are any \env{refsection} environments in the document, the citation tracking is local to these environments. Note that the citation tracker needs to be enabled explicitly with the package option \opt{citetracker}. The behavior of this test depends on the mode the citation tracker is operating in, see \secref{use:opt:pre:int} for details. If the citation tracker is disabled, the test always yields \prm{false}. Also see the \cmd{citetrackertrue} and \cmd{citetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{ifentryseen}{entrykey}{true}{false}
A variant of \cmd{ifciteseen} which takes an entry key as its first argument. Since the \prm{entrykey} is expanded prior to performing the test, it is possible to test for entry keys in a field such as \bibfield{xref}:
\begin{ltxexample}
\ifentryseen{<<\thefield{xref}>>}{true}{false}
\end{ltxexample}
%
Apart from the additional argument, \cmd{ifentryseen} behaves like \cmd{ifciteseen}. A user-facing version of this command is available for use in documents see \secref{use:eq}.
\cmditem{ifentryinbib}{entrykey}{true}{false}
Executes \prm{true} if the entry \prm{entrykey} appears in the current bibliography, and \prm{false} otherwise. A user-facing version of this command is available for use in documents see \secref{use:eq}.
\cmditem{iffirstcitekey}{true}{false}
Executes \prm{true} if the entry currently being processed is the first one in the citation list, and \prm{false} otherwise. This command relies on the \cnt{citecount}, \cnt{citetotal}, \cnt{multicitecount} and \cnt{multicitetotal} counters (\secref{aut:fmt:ilc}) and thus is intended for use only in the \prm{loopcode} of a citation command defined with \cmd{DeclareCiteCommand}.
\cmditem{iflastcitekey}{true}{false}
Similar \cmd{iffirstcitekey}, but executes \prm{true} if the entry currently being processed is the last one in the citation list, and \prm{false} otherwise.
\cmditem{ifciteibid}{true}{false}
Expands to \prm{true} if the entry currently being processed is the same as the last one, and to \prm{false} otherwise. This command is intended for use in citation styles. If there are any \env{refsection} environments in the document, the tracking is local to these environments. Note that the <ibidem> tracker needs to be enabled explicitly with the package option \opt{ibidtracker}. The behavior of this test depends on the mode the tracker is operating in, see \secref{use:opt:pre:int} for details. If the tracker is disabled, the test always yields \prm{false}. Also see the \cmd{citetrackertrue} and \cmd{citetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{ifciteidem}{true}{false}
Expands to \prm{true} if the primary name (\ie the author or editor) in the entry currently being processed is the same as the last one, and to \prm{false} otherwise. This command is intended for use in citation styles. If there are any \env{refsection} environments in the document, the tracking is local to these environments. Note that the <idem> tracker needs to be enabled explicitly with the package option \opt{idemtracker}. The behavior of this test depends on the mode the tracker is operating in, see \secref{use:opt:pre:int} for details. If the tracker is disabled, the test always yields \prm{false}. Also see \cmd{citetrackertrue} and \cmd{citetrackerfalse} in \secref{aut:aux:msc}.
\cmditem{ifopcit}{true}{false}
This command is similar to \cmd{ifciteibid} except that it expands to \prm{true} if the entry currently being processed is the same as the last one \emph{by this author or editor}. Note that the <opcit> tracker needs to be enabled explicitly with the package option \opt{opcittracker}. The behavior of this test depends on the mode the tracker is operating in, see \secref{use:opt:pre:int} for details. If the tracker is disabled, the test always yields \prm{false}. Also see the \cmd{citetrackertrue} and \cmd{citetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{ifloccit}{true}{false}
This command is similar to \cmd{ifopcit} except that it also compares the \prm{postnote} arguments and expands to \prm{true} only if they match and are numerical (in the sense of \cmd{ifnumerals} from \secref{aut:aux:tst}), \ie \cmd{ifloccit} will yield \texttt{true} if the citation refers to the same page cited before. Note that the <loccit> tracker needs to be enabled explicitly with the package option \opt{loccittracker}. The behavior of this test depends on the mode the tracker is operating in, see \secref{use:opt:pre:int} for details. If the tracker is disabled, the test always yields \prm{false}. Also see the \cmd{citetrackertrue} and \cmd{citetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{iffirstonpage}{true}{false}
The behavior of this command is responsive to the package option \opt{pagetracker}. If the option is set to \texttt{page}, it expands to \prm{true} if the current item is the first one on the page, and to \prm{false} otherwise. If the option is set to \texttt{spread}, it expands to \prm{true} if the current item is the first one on the double-page spread, and to \prm{false} otherwise. If the page tracker is disabled, this test always yields \prm{false}. Depending on the context, the <item> may be a citation or an entry in the bibliography or a bibliography list. Note that this test distinguishes between body text and footnotes. For example, if used in the first footnote on a page, it will expand to \prm{true} even if there is a citation in the body text prior to the footnote. Also see the \cmd{pagetrackertrue} and \cmd{pagetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{ifsamepage}{instance 1}{instance 2}{true}{false}
This command expands to \prm{true} if two instances of a reference are located on the same page or double-page spread, and to \prm{false} otherwise. An instance of a reference may be a citation or an entry in the bibliography or a bibliography list. These instances are identified by the value of the \cnt{instcount} counter, see \secref{aut:fmt:ilc}. The behavior of this command is responsive to the package option \opt{pagetracker}. If this option is set to \texttt{spread}, \cmd{ifsamepage} is in fact an <if same spread> test. If the page tracker is disabled, this test always yields \prm{false}. The arguments \prm{instance 1} and \prm{instance 2} are treated as integer expressions in the sense of \etex's \cmd{numexpr}. This implies that it is possible to make calculations within these arguments, for example:
\begin{ltxexample}
\ifsamepage{<<\value>>{instcount}}{<<\value>>{instcount}<<-1>>}{true}{false}
\end{ltxexample}
Note that \cmd{value} is not prefixed by \cmd{the} and that the subtraction is included in the second argument in the above example. If \prm{instance 1} or \prm{instance 2} is an invalid number (for example, a negative one), the test yields \prm{false}. Also note that this test does not distinguish between body text and footnotes. Also see the \cmd{pagetrackertrue} and \cmd{pagetrackerfalse} switches in \secref{aut:aux:msc}.
\cmditem{ifinteger}{string}{true}{false}
Executes \prm{true} if the \prm{string} is a positive integer, and \prm{false} otherwise. This command is robust.
\cmditem{ifnumeral}{string}{true}{false}
Executes \prm{true} if the \prm{string} is an Arabic or Roman numeral, and \prm{false} otherwise. This command is robust. See also \cmd{DeclareNumChars} and \cmd{NumCheckSetup} in \secref{aut:aux:msc}.
\cmditem{ifnumerals}{string}{true}{false}
Executes \prm{true} if the \prm{string} is a range or a list of Arabic or Roman numerals, and \prm{false} otherwise. This command is robust. In contrast to \cmd{ifnumeral}, it will also execute \prm{true} with arguments like «52--58», «14/15», «1,~3,~5», and so on. See also \cmd{DeclareNumChars}, \cmd{DeclareRangeChars}, \cmd{DeclareRangeCommands}, \cmd{NumCheckSetup}, and \cmd{NumsCheckSetup} in \secref{aut:aux:msc}.
\cmditem{ifpages}{string}{true}{false}
Similar to \cmd{ifnumerals}, but also considers \cmd{DeclarePageCommands} and \cmd{PagesCheckSetup} from \secref{aut:aux:msc}.
\cmditem{iffieldint}{field}{true}{false}
Similar to \cmd{ifinteger}, but uses the value of a \prm{field} rather than a literal string in the test. If the \prm{field} is undefined, it executes \prm{false}.
\cmditem{iffieldnum}{field}{true}{false}
Similar to \cmd{ifnumeral}, but uses the value of a \prm{field} rather than a literal string in the test. If the \prm{field} is undefined, it executes \prm{false}.
\cmditem{iffieldnums}{field}{true}{false}
Similar to \cmd{ifnumerals}, but uses the value of a \prm{field} rather than a literal string in the test. If the \prm{field} is undefined, it executes \prm{false}.
\cmditem{iffieldpages}{field}{true}{false}
Similar to \cmd{ifpages}, but uses the value of a \prm{field} rather than a literal string in the test. If the \prm{field} is undefined, it executes \prm{false}.
\cmditem{ifbibstring}{string}{true}{false}
Expands to \prm{true} if the \prm{string} is a known localisation key, and to \prm{false} otherwise. The localisation keys defined by default are listed in \secref{aut:lng:key}. New ones may be defined with \cmd{NewBibliographyString}.
\cmditem{ifbibxstring}{string}{true}{false}
Similar to \cmd{ifbibstring}, but the \prm{string} is expanded.
\cmditem{iffieldbibstring}{field}{true}{false}
Similar to \cmd{ifbibstring}, but uses the value of a \prm{field} rather than a literal string in the test. If the \prm{field} is undefined, it expands to \prm{false}.
\cmditem{iffieldplusstringbibstring}{field}{string}{true}{false}
Similar to \cmd{iffieldbibstring}, but appends \prm{string} to the value of \prm{field} and checks if the resulting string is a known localisation key. Expands to \prm{false} if \prm{field} is undefined.
\cmditem{ifdriver}{entrytype}{true}{false}
Expands to \prm{true} if a driver for the \prm{entrytype} is available, and to \prm{false} otherwise.
\cmditem{ifcapital}{true}{false}
Executes \prm{true} if \biblatex's punctuation tracker would capitalize a localisation string at the current location, and \prm{false} otherwise. This command is robust. It may be useful for conditional capitalization of certain parts of a name in a formatting directive.
\cmditem{ifcitation}{true}{false}
Expands to \prm{true} when located in a citation, and to \prm{false} otherwise. Note that this command is responsive to the outermost context in which it is used. For example, if a citation command defined with \cmd{DeclareCiteCommand} executes a driver defined with \cmd{DeclareBibliographyDriver}, any \cmd{ifcitation} tests in the driver code will yield \prm{true}. See \secref{aut:cav:mif} for a practical example.
\cmditem{ifvolcite}{true}{false}
Expands to \prm{true} when located in \cmd{volcite} or a related citation command (\secref{use:cit:spc}), and to \prm{false} otherwise.
\cmditem{ifbibliography}{true}{false}
Expands to \prm{true} when located in a bibliography, and to \prm{false} otherwise. Note that this command is responsive to the outermost context in which it is used. For example, if a driver defined with \cmd{DeclareBibliographyDriver} executes a citation command defined with \cmd{DeclareCiteCommand}, any \cmd{ifbibliography} tests in the citation code will yield \prm{true}. See \secref{aut:cav:mif} for a practical example.
\cmditem{ifnatbibmode}{true}{false}
Expands to \prm{true} or \prm{false} depending on the \opt{natbib} option from \secref{use:opt:ldt}.
\cmditem{ifciteindex}{true}{false}
Expands to \prm{true} or \prm{false} depending on the \opt{indexing} option from \secref{use:opt:pre:gen}.
\cmditem{ifbibindex}{true}{false}
Expands to \prm{true} or \prm{false} depending on the \opt{indexing} option from \secref{use:opt:pre:gen}.
\cmditem{iffootnote}{true}{false}
Expands to \prm{true} when located in a footnote, and to \prm{false} otherwise. Note that footnotes in \env{minipage} environments are considered to be part of the body text. This command will only expand to \prm{true} in footnotes a the bottom of the page and in endnotes as provided by the \sty{endnotes} package.
\cntitem{citecounter}
This counter indicates how many times the entry currently being processed is cited in the current reference section. Note that this feature needs to be enabled explicitly with the package option \opt{citecounter}. If the option is set to \texttt{context}, citations in the body text and in footnotes are counted separately. In this case, \cnt{citecounter} will hold the value of the context it is used in.
\cntitem{maxcitecounter}
This counter holds the maximum value of \cnt{citecounter} across all entries in the current reference section. Like \cnt{citecounter} it is only available if the \opt{citecounter} option is enabled and tracks footnotes and text separately if the option is set to \texttt{context}.
\cntitem{uniquename}
This counter refers to the \bibfield{labelname} list. It is set on a per-name basis. Its value is \texttt{0} if the base parts of the name (by default just the <family> part of the name) are unique, \texttt{1} if adding the other non-base parts of the name (as specified in the uniquename template defined by \cmd{DeclareUniquenameTemplate}) as initials will make it unique, and \texttt{2} if adding the full form of the non-base parts of the name are required to disambiguate the name. This information is required by author-year and author-title citation schemes which add additional parts of the name when citing different authors with the same family name. For example, (given the default \cmd{DeclareUniquenameTemplate} definition) if there is one <John Doe> and one <Edward Doe> in the list of references, this counter will be set to \texttt{1}. If there is one <John Doe> and one <Jane Doe>, the value of the counter will be \texttt{2}. If the option is set to \texttt{init}\slash \texttt{allinit}\slash \texttt{mininit}, the counter will be limited to \texttt{1}. This is useful for citations styles which use initials to disambiguate names but never print the full name in citations. If adding the initials is not sufficient to disambiguate the name, \cnt{uniquename} will also be set to \texttt{0} for that name. This feature needs to be enabled explicitly with the package option \opt{uniquename}. Note that the \cnt{uniquename} counter is local to \cmd{printnames} and that it is only set for the \bibfield{labelname} list and for the name list that \bibfield{labelname} has been derived from (typically \bibfield{author} or \bibfield{editor}). Its value is zero in any other context, i.e., it must be evaluated in the name formatting directives handling name lists. See \secref{aut:cav:amb} for further details and practical examples. This counter can be overridden on a per-namepart basis by consulting the \cmd{namepart<namepart>un} macros during name formatting, see \secref{aut:bbx:drv}.
\cntitem{uniquelist}
This counter refers to the \bibfield{labelname} list. It is set on a per-field basis. Its value indicates the number of names required to disambiguate the name list if automatic \cnt{maxnames}\slash \cnt{minnames} truncation would lead to ambiguous citations. For example, if there is one work by <Doe\slash Smith\slash Johnson> and another one by <Doe\slash Edwards\slash Williams>, setting \kvopt{maxnames}{1} would lead to <Doe et al.> in both cases. In this case, \cnt{uniquelist} would be set to \texttt{2} on the \bibfield{labelname} lists of both entries because at least the first two names are required to disambiguate them. Note that the \cnt{uniquelist} counter is local to \cmd{printnames} and that it is only set for the \bibfield{labelname} list and to the name list \bibfield{labelname} has been derived from (typically \bibfield{author} or \bibfield{editor}). Its value is zero in any other context. If available, the \cnt{uniquelist} value will be used automatically by \cmd{printnames} when processing the name list, \ie it will automatically override \cnt{maxnames}\slash \cnt{minnames}. This feature needs to be enabled explicitly with the package option \opt{uniquelist}. See \secref{aut:cav:amb} for further details and practical examples.
\cntitem{parenlevel}
The current nesting level of parentheses and\slash or brackets. This information is only available if the \opt{parentracker} from \secref{use:opt:pre:int} is enabled.
\end{ltxsyntax}
\subsubsection{Tests with \cmd{ifboolexpr} and \cmd{ifthenelse}}
\label{aut:aux:ife}
The tests introduced in \secref{aut:aux:tst} may also be used with the \cmd{ifboolexpr} command provided by the \sty{etoolbox} package and the \cmd{ifthenelse} command provided by the \sty{ifthen} package. The syntax of the tests is slightly different in this case: the \prm{true} and \prm{false} arguments are omitted from the test itself and passed to the \cmd{ifboolexpr} or \cmd{ifthenelse} command instead. Note that the use of these commands implies some processing overhead. If you do not need any boolean operators, it is more efficient to use the stand"=alone tests from \secref{aut:aux:tst}.
\begin{ltxsyntax}
\cmditem{ifboolexpr}{expression}{true}{false}
\sty{etoolbox} command which allows for complex tests with boolean operators and grouping:
\begin{lstlisting}[style=ifthen]{}
\ifboolexpr{ (
test {\ifnameundef{editor}}
and
not test {\iflistundef{location}}
)
or test {\iffieldundef{year}}
}
{...}
{...}
\end{lstlisting}
\cmditem{ifthenelse}{tests}{true}{false}
\sty{ifthen} command which allows for complex tests with boolean operators and grouping:
\begin{lstlisting}[style=ifthen]{}
\ifthenelse{ \(
\ifnameundef{editor}
\and
\not \iflistundef{location}
\)
\or \iffieldundef{year}
}
{...}
{...}
\end{lstlisting}
%
The additional tests provided by \biblatex are only available when \cmd{ifboolexpr} or \cmd{ifthenelse} are used in citation commands and in the bibliography.
\end{ltxsyntax}
\subsubsection{Miscellaneous Commands}
\label{aut:aux:msc}
The section introduced miscellaneous commands and little helpers for use in bibliography and citation styles.
\begin{ltxsyntax}
\cmditem{newbibmacro}{name}[arguments][optional]{definition}
\cmditem*{newbibmacro*}{name}[arguments][optional]{definition}
Defines a macro to be executed via \cmd{usebibmacro} later. The syntax of this command is very similar to \cmd{newcommand} except that \prm{name} may contain characters such as numbers and punctuation marks and does not start with a backslash. The optional argument \prm{arguments} is an integer specifying the number of arguments taken by the macro. If \prm{optional} is given, it specifies a default value for the first argument of the macro, which automatically becomes an optional argument. In contrast to \cmd{newcommand}, \cmd{newbibmacro} issues a warning message if the macro is already defined, and automatically falls back to \cmd{renewbibmacro}. As with \cmd{newcommand}, the regular variant of this command uses the \cmd{long} prefix in the definition while the starred one does not. If a macro has been declared to be long, it may take arguments containing \cmd{par} tokens. \cmd{newbibmacro} and \cmd{renewbibmacro} are provided for convenience. Style authors are free to use \cmd{newcommand} or \cmd{def} instead. However, note that most shared definitions found in \path{biblatex.def} are defined with \cmd{newbibmacro}, hence they must be used and modified accordingly.
\cmditem{renewbibmacro}{name}[arguments][optional]{definition}
\cmditem*{renewbibmacro*}{name}[arguments][optional]{definition}
Similar to \cmd{newbibmacro} but redefines \prm{name}. In contrast to \cmd{renewcommand}, \cmd{renewbibmacro} issues a warning message if the macro is undefined, and automatically falls back to \cmd{newbibmacro}.
\cmditem{providebibmacro}{name}[arguments][optional]{definition}
\cmditem*{providebibmacro*}{name}[arguments][optional]{definition}
Similar to \cmd{newbibmacro} but only defines \prm{name} if it is undefined. This command is similar in concept to \cmd{providecommand}.
\cmditem{letbibmacro}{alias}{name}
\cmditem*{letbibmacro*}{alias}{name}
This command defines the macro \prm{alias} to be an alias of the macro \prm{name}. The definition is perfomed by \cmd{csletcs}.
An error is issued if \prm{name} is undefined.
The regular variant of this command sanitizes \prm{name} while the starred variant does not.
\cmditem{usebibmacro}{name}
\cmditem*{usebibmacro*}{name}
This command executes the macro \prm{name}, as defined with \cmd{newbibmacro}. If the macro takes any arguments, they are simply appended after \prm{name}. The regular variant of this command sanitizes
\prm{name} while the starred variant does not.
\cmditem{savecommand}{command}
\cmditem{restorecommand}{command}
These commands save and restore any \prm{command}, which must be a command name starting with a backslash. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savebibmacro}{name}
\cmditem{restorebibmacro}{name}
These commands save and restore the macro \prm{name}, where \prm{name} is the identifier of a macro defined with \cmd{newbibmacro}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savefieldformat}[entry type]{format}
\cmditem{restorefieldformat}[entry type]{format}
These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareFieldFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savelistformat}[entry type]{format}
\cmditem{restorelistformat}[entry type]{format}
These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareListFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savenameformat}[entry type]{format}
\cmditem{restorenameformat}[entry type]{format}
These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareNameFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savelistwrapperformat}[entry type]{format}
\cmditem{restorelistwrapperformat}[entry type]{format}
These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareListWrapperFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savenamewrapperformat}[entry type]{format}
\cmditem{restorenamewrapperformat}[entry type]{format}
These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareNameWrapperFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{ifbibmacroundef}{name}{true}{false}
Expands to \prm{true} if the bibliography macro \prm{name} is undefined, and to \prm{false} otherwise.
\cmditem{iffieldformatundef}[entry type]{name}{true}{false}
\cmditem{iflistformatundef}[entry type]{name}{true}{false}
\cmditem{ifnameformatundef}[entry type]{name}{true}{false}
\cmditem{iflistwrapperformatundef}[entry type]{name}{true}{false}
\cmditem{ifnamewrapperformatundef}[entry type]{name}{true}{false}
Expands to \prm{true} if the formatting directive \prm{format} is undefined, and to \prm{false}
otherwise.
\cmditem{usedriver}{code}{entrytype}
Executes the bibliography driver for an \prm{entrytype}. Calling this command in the \prm{loopcode} of a citation command defined with \cmd{DeclareCiteCommand} is a simple way to print full citations similar to a bibliography entry. Commands such as \cmd{newblock}, which are not applicable in a citation, are disabled automatically by default. The global initialization can be changed with \cmd{AtUsedriver}, see \secref{aut:fmt:hok}. Additional local initialization commands may be passed as the \prm{code} argument. This argument is executed inside the group in which \cmd{usedriver} runs the respective driver. Note that it is mandatory in terms of the syntax but may be left empty. Also note that this command will automatically switch languages if the \opt{autolang} package option is enabled.
\cmditem{bibhypertarget}{name}{text}
A wrapper for \sty{hyperref}'s \cmd{hypertarget} command. The \prm{name} is the name of the anchor, the \prm{text} is arbitrary printable text or code which serves as an anchor. If there are any \env{refsection} environments in the document, the \prm{name} is local to the current environment. If the \opt{hyperref} package option is disabled or the \sty{hyperref} package has not been loaded, this command will simply pass on its \prm{text} argument. See also the formatting directive \texttt{bibhypertarget} in \secref{aut:fmt:ich}.
\cmditem{bibhyperlink}{name}{text}
A wrapper for \sty{hyperref}'s \cmd{hyperlink} command. The \prm{name} is the name of an anchor defined with \cmd{bibhypertarget}, the \prm{text} is arbitrary printable text or code to be transformed into a link. If there are any \env{refsection} environments in the document, the \prm{name} is local to the current environment. If the \opt{hyperref} package option is disabled or the \sty{hyperref} package has not been loaded, this command will simply pass on its \prm{text} argument. See also the formatting directive \texttt{bibhyperlink} in \secref{aut:fmt:ich}.
\cmditem{bibhyperref}[entrykey]{text}
Transforms \prm{text} into an internal link pointing to \prm{entrykey} in the bibliography. If \prm{entrykey} is omitted, this command uses the key of the entry currently being processed. This command is employed to transform citations into clickable links pointing to the corresponding entry in the bibliography. The link target is marked automatically by \biblatex. If there are multiple bibliographies in a document, the target will be the first occurence of \prm{entrykey} in one of the bibliographies. If there are \env{refsection} environments, the links are local to the environment. See also the formatting directive \texttt{bibhyperref} in \secref{aut:fmt:ich}.
\cmditem{ifhyperref}{true}{false}
Expands to \prm{true} if the \opt{hyperref} package option is enabled (which implies that the \sty{hyperref} package has been loaded), and to \prm{false} otherwise.
\cmditem{docsvfield}{field}
Similar to the \cmd{docsvlist} command from the \sty{etoolbox} package, except that it takes a field name as its argument. The value of this field is parsed as a comma"=separated list. If the \prm{field} is undefined, this command expands to an empty string.
\cmditem{forcsvfield}{handler}{field}
Similar to the \cmd{forcsvlist} command from the \sty{etoolbox} package, except that it takes a field name as its argument. The value of this field is parsed as a comma"=separated list. If the \prm{field} is undefined, this command expands to an empty string.
\cmditem{MakeCapital}{text}
Similar to \cmd{MakeUppercase} but only converts the first printable character in \prm{text} to uppercase. Note that the restrictions that apply to \cmd{MakeUppercase} also apply to this command. Namely, all commands in \prm{text} must either be robust or prefixed with \cmd{protect} since the \prm{text} is expanded during capitalization. Apart from Ascii characters and the standard accent commands, this command also handles the active characters of the \sty{inputenc} package as well as the shorthands of the \sty{babel} package. If the \prm{text} starts with a control sequence, nothing is capitalized. This command is robust.
\cmditem{MakeSentenceCase}{text}
\cmditem*{MakeSentenceCase*}{text}
Converts its \prm{text} argument to sentence case, \ie the first word is capitalized and the remainder of the string is converted to lowercase. This command is robust. The starred variant differs from the regular version in that it considers the language of the entry, as specified in the \bibfield{langid} field. If the \bibfield{langid} field is defined and holds a language declared with \cmd{DeclareCaseLangs} (see below)\footnote{By default, converting to sentence case is enabled for the following language identifiers: \texttt{american}, \texttt{british}, \texttt{canadian}, \texttt{english}, \texttt{australian}, \texttt{newzealand} as well as the aliases \texttt{USenglish} and \texttt{UKenglish}. Use \cmd{DeclareCaseLangs} to extend or change this list.}, then the sentence case conversion is performed. If the \bibfield{langid} field is undefined, then the language list declared with \cmd{DeclareCaseLangs} is checked for the presence of the main document language derived from the \opt{language} option. If found, sentence case conversion is performed, if not, the \prm{text} is not altered in any way. It is recommended to use \cmd{MakeSentenceCase*} rather than the regular variant in formatting directives.
Depending on the option \opt{casechanger} \cmd{MakeCaseChange} and \cmd{MakeCaseChange*} are either implemented using the \sty{expl3} module \sty{l3text} or original \LaTeXe code.
Both variants support the traditional \bibtex convention for \file{bib} files that anything wrapped in a pair of curly braces is not modified when changing the case. For example:
\begin{ltxexample}
\MakeSentenceCase{an Introduction to LaTeX}
\MakeSentenceCase{an Introduction to {LaTeX}}
\end{ltxexample}
%
would yield:
\begin{lstlisting}[style=plain]{}
An introduction to latex
An introduction to LaTeX
\end{lstlisting}
%
In \file{bib} files designed with traditional \bibtex in mind, it has been fairly common to only wrap single letters in braces to prevent case"=changing:
\begin{lstlisting}[style=bibtex]{}
title = {An Introduction to {L}a{T}e{X}}
\end{lstlisting}
%
The problem with this convention is that the braces will suppress the kerning on both sides of the enclosed letter. It is preferable to wrap the entire word in braces as shown in the first example.
Macros in titles must also be protected with braces
\begin{lstlisting}[style=bibtex]{}
title = {The {\TeX book}},
\end{lstlisting}
%
The behaviour of \cmd{MakeSentenceCase} differs slightly between the \opt{latex2e} and \opt{expl3} implementation. Generally speaking, the \opt{expl3} code is closer to the \bibtex behaviour of \texttt{change.case\$}. It is also better equipped to deal with non-ASCII input and macros than the \opt{latex2e} implementation. \cmd{MakeSentenceCase} behaves as follows.
\begin{itemize}\setlength{\labelsep}{1em}
\item The first letter of its argument is capitalised with \cmd{MakeUppercase}. This is different from \bibtex's \texttt{change.case\$}, which does not touch the first letter of its argument.
Note that with the \opt{latex2e} code a pair of braces that starts with a control sequence will be treated as a single character for capitalisation purposes. This means that the entire argument of a command protected with a single pair of braces is capitalised.
\item With the \opt{latex2e} code expandable commands are expanded before the case change, which means that the case change applies to the replacement text. Unexpandable commands are not touched.
\bibtex does not interpret macros and therefore passes commands through unchanged (this does not necessarily apply to the \emph{arguments} of those commands). The \opt{expl3} implementation also does not expand commands and only applies case change to the arguments.
\item Text wrapped in one or more pairs of braces is protected from case change \emph{unless} it starts with a control sequence. This is the same behaviour as with \bibtex. Note that the braces could either be explicit groups or argument delimiters.
\item Text in a single pair of braces that starts with a control sequence is not protected and will be subject to case changes. Note that this need not apply to braces that are argument delimiters, in fact the \opt{latex2e} implementation of \cmd{MakeSentenceCase} may in some cases produce an error or otherwise undesirable output if the argument of a command starts with a control sequence. \bibtex's case change function does not differentiate between argument delimiters and brace groups and always subjects text at brace level~1 to case change if it starts with a control sequence.
\end{itemize}
For most intents and purposes the following rules should give a sensible result.
\begin{itemize}\setlength{\labelsep}{1em}
\item Protect all words whose case should not be changed by wrapping them in one pair of braces.
\item If words are already in the braced argument of a command such as \cmd{mkbibquote} or \cmd{emph}, they are automatically protected.
\begin{itemize}
\item To \emph{undo} this protection wrap the command in braces again.
\item It is not possible to selectively re-apply protection if it has been undone with an additional pair of braces. If a more fine-grained control is needed, work-arounds like splitting the argument could be tried.
\end{itemize}
\item While it is possible to protect words from case change at the beginning of a field with a pair of braces, it is not possible to undo the case protection that a command automatically implies by wrapping it in braces in that position. In that case work-arounds are necessary.
\end{itemize}
%
\begin{lstlisting}[style=bibtex]{}
title = {The Story of {HMS} \emph{Erebus}
in {\emph{Really}} Strong Wind},
\end{lstlisting}
would be converted to sentence case by \cmd{MakeSentenceCase} as
\begin{quote}
The story of HMS \emph{Erebus} in {\emph{really}} strong wind
\end{quote}
If the \sty{expl3} implementation of the case changing functions is selected, the \bibtex case protection behaviour can be exchanged for a slightly simpler version. When \opt{bibtexcaseprotection} set to \opt{false}, braces no longer automatically imply case protection. Instead words can be protected from case change with \cmd{NoCaseChange}. The examples from above would then read
\begin{lstlisting}[style=bibtex]{}
title = {An Introduction to \NoCaseChange{LaTeX}},
title = {The Story of \NoCaseChange{HMS \emph{Erebus}}
in \emph{Really} Strong Wind},
\end{lstlisting}
Generally, this option should allow for a saner case protection input, because curly braces are no longer overloaded with different levels of meaning, but it is a big departure from the standard case protection input that has been with the \latex world for a long time.
Due to its complex implementation \cmd{MakeSentenceCase} can not accept arbitrary input, it only safely operates on raw text or field data. In the standard styles the \bibfield{title} and other \bibfield{title}-like field formats do not work together with \cmd{MakeSentenceCase} because of their argument structure, so the standard styles offer a dedicated \texttt{titlecase} field format to apply this command. To enable sentence casing in standard styles for languages that support it you would use:
\begin{ltxexample}
\DeclareFieldFormat{titlecase}{<<\MakeSentenceCase*{#1}>>}
\end{ltxexample}
%
Sentence casing can then be disabled by resetting that field format to
\begin{ltxexample}
\DeclareFieldFormat{titlecase}{<<#1>>}
\end{ltxexample}
Custom styles may follow a different approach, but style authors are encouraged to apply the same general ideas to their styles.
\cmditem{mkpageprefix}[pagination][postpro]{text}
This command is intended for use in field formatting directives which format the page numbers in the \prm{postnote} argument of citation commands and the \bibfield{pages} field of bibliography entries. It will parse its \prm{text} argument and prefix it with <p.> or <pp.> by default. The optional \prm{pagination} argument holds the name of a field indicating the pagination type. This may be either \bibfield{pagination} or \bibfield{bookpagination}, with \bibfield{pagination} being the default. The spacing between the prefix and the \prm{text} may be modified by redefining \cmd{ppspace}. The default is an unbreakable interword space. See \secref{bib:use:pag, use:cav:pag} for further details. See also \cmd{DeclareNumChars}, \cmd{DeclareRangeChars}, \cmd{DeclareRangeCommands}, and \cmd{NumCheckSetup}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. If only one optional argument is given, it is taken as \prm{pagination}. Here are two typical examples:
\begin{ltxexample}
\DeclareFieldFormat{postnote}{<<\mkpageprefix[pagination][\mknormrange]{#1}>>}
\DeclareFieldFormat{pages}{<<\mkpageprefix[bookpagination]{#1}>>}
\end{ltxexample}
%
\cmditem{mkpagetotal}[pagination][postpro]{text}
This command is similar to \cmd{mkpageprefix} except that it is intended for the \bibfield{pagetotal} field of bibliography entries, \ie it will print «123 pages» rather than «page 123». The optional \prm{pagination} argument defaults to \bibfield{bookpagination}. The spacing inserted between the pagination suffix and the \prm{text} may be modified by redefining the macro \cmd{ppspace}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. If only one optional argument is given, it is taken as \prm{pagination}. Here is a typical example:
\begin{ltxexample}
\DeclareFieldFormat{pagetotal}{<<\mkpagetotal[bookpagination]{#1}>>}
\end{ltxexample}
%
The optional argument \bibfield{bookpagination} is omissible in this case.
The pagination strings are taken from \texttt{$<$pagination$>$total} and \texttt{$<$pagination$>$totals}.
\begin{table}
\caption{\cmd{mkcomprange} setup}
\label{aut:aux:tab1}
\tablesetup\lnstyle
\begin{tabularx}{\textwidth}{@{}>{\ttfamily}X@{}p{0.25\textwidth}@{}p{0.25\textwidth}@{}p{0.25\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Input} &
\multicolumn{3}{@{}H}{Output} \\
\cmidrule(r){1-1}\cmidrule{2-4}
& \multicolumn{1}{@{}H}{\ttfamily mincomprange=10}
& \multicolumn{1}{@{}H}{\ttfamily mincomprange=100}
& \multicolumn{1}{@{}H}{\ttfamily mincomprange=1000} \\
\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4}
11--15 & 11--5 & 11--15 & 11--15 \\
111--115 & 111--5 & 111--5 & 111--115 \\
1111--1115 & 1111--5 & 1111--5 & 1111--5 \\
\cmidrule{2-4}
& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=1000}
& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=100}
& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=10} \\
\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4}
1111--1115 & 1111--5 & 1111--5 & 1111--5 \\
1111--1155 & 1111--55 & 1111--55 & 1111--1155 \\
1111--1555 & 1111--555 & 1111--1555 & 1111--1555 \\
\cmidrule{2-4}
& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=1}
& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=10}
& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=100} \\
\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4}
1111--1115 & 1111--5 & 1111--15 & 1111--115 \\
1111--1155 & 1111--55 & 1111--55 & 1111--155 \\
1111--1555 & 1111--555 & 1111--555 & 1111--555 \\
\bottomrule
\end{tabularx}
\end{table}
\cmditem{mkcomprange}[postpro][itempostpro]{text}
\cmditem*{mkcomprange*}[postpro][itempostpro]{text}
This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and compress them. For example, «125--129» may be formatted as «125--9». You may configure the behavior of \cmd{mkcomprange} by adjusting the \latex counters \cnt{mincomprange}, \cnt{maxcomprange}, and \cnt{mincompwidth}, as illustrated in \tabref{aut:aux:tab1}. The default settings are \texttt{10}, \texttt{100000}, and \texttt{1}, respectively. This means that the command tries to compress as much as possible by default. Use \cmd{setcounter} to adjust the parameters. The scanner recognises \cmd{bibrangedash} and hyphens as range dashes. It will normalize the dash by replacing any number of consecutive hyphens with \cmd{bibrangedash}. Lists of ranges delimited with \cmd{bibrangessep} are also supported. The scanner will normalise any comma or semi-colons surrounded by optional space by replacing them with \cmd{bibrangessep}. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This is important if you want to combine \cmd{mkcomprange} with other formatting macros which also need to parse their \prm{text} argument, such as \cmd{mkpageprefix}. Simply nesting these commands will not work as expected. Use the \prm{postpro} argument to set up the processing chain as follows:
\begin{ltxexample}
\DeclareFieldFormat{postnote}{\mkcomprange[<<{>>\mkpageprefix[pagination]<<}>>]{#1}}
\end{ltxexample}
%
Note that \cmd{mkcomprange} is executed first, using \cmd{mkpageprefix} as post-processor. Also note that the \prm{postpro} argument is wrapped in an additional pair of braces. This is only required in this particular case to prevent \latex's optional argument scanner from getting confused by the nested brackets. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. For example:
\begin{ltxexample}
\mkcomprange[\mkpageprefix]{5, 123-129, 423-439}
\mkcomprange*[\mkpageprefix]{5, 123-129, 423-439}
\end{ltxexample}
%
will output:
\begin{ltxexample}
pp. 5, 123-9, 423-39
p. 5, pp. 123-9, pp. 423-39
\end{ltxexample}
%
The second optional argument \prm{itempostpro} is used to post-process each individual number item in the formatted list. It can be used to convert numbers from cardinals to ordinals. If only one optional argument is present, it is treated as \prm{postpro}.
\cmditem{mknormrange}[postpro][itempostpro]{text}
\cmditem*{mknormrange*}[postpro][itempostpro]{text}
This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and will normalise them. The command is similar to \cmd{mkcomprange} except that the page ranges will not be compressed. The scanner recognises \cmd{bibrangedash} and hyphens as range dashes. It will normalize the dash by replacing any number of consecutive hyphens with \cmd{bibrangedash}. Lists of ranges delimited with \cmd{bibrangessep} are also supported. The scanner will normalise any comma or semi-colons surrounded by optional space by replacing them with \cmd{bibrangessep}. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. See \cmd{mkcomprange} on how to use this argument. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. The second optional argument \prm{itempostpro} is used to post-process each individual number item in the formatted list. It can be used to convert numbers from cardinals to ordinals. If only one optional argument is present, it is treated as \prm{postpro}.
\cmditem{mkfirstpage}[postpro][itempostpro]{text}
\cmditem*{mkfirstpage*}[postpro][itempostpro]{text}
This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and print the start page of the range only. The scanner recognizes \cmd{bibrangedash} and hyphens as range dashes. Lists of ranges delimited with \cmd{bibrangessep} are also supported. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. See \cmd{mkcomprange} on how to use this argument. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. The second optional argument \prm{itempostpro} is used to post-process each individual number item in the formatted list. It can be used to convert numbers from cardinals to ordinals. If only one optional argument is present, it is treated as \prm{postpro}. For example:
\begin{ltxexample}
\mkfirstpage[\mkpageprefix]{5, 123-129, 423-439}
\mkfirstpage*[\mkpageprefix]{5, 123-129, 423-439}
\end{ltxexample}
%
will output:
\begin{ltxexample}
pp. 5, 123, 423
p. 5, p. 123, p. 423
\end{ltxexample}
\cmditem{rangelen}{rangefield}
Takes the name of a bibfield declared as a range field in the data model and returns the length of the range. This is calculated by \biber and can handle many special cases. It will return $-1$ for open ended ranges. Specifically \cmd{rangelen} can:
\begin{itemize}
\item Calculate the total of multiple ranges in the same field such as <1-10, 20-30>
\item Handle implicit ranges such as <22-4> and <130-33>
\item Handle roman numeral ranges in upper and lower case and consisting of both ASCII and Unicode roman numeral representations.
\end{itemize}
%
Here are some examples:
\begin{tabular}{ll}
pages = <10> & |\rangelen{pages}| returns '1'\\
pages = <10-15> & |\rangelen{pages}| returns '6'\\
pages = <10-15,47-53> & |\rangelen{pages}| returns '13'\\
pages = <10-> & |\rangelen{pages}| returns '-1'\\
pages = <-10> & |\rangelen{pages}| returns '-1'\\
pages = <48-9> & |\rangelen{pages}| returns '2'\\
pages = <172-77> & |\rangelen{pages}| returns '6'\\
pages = <i-vi> & |\rangelen{pages}| returns '6'\\
pages = <X-XX> & |\rangelen{pages}| returns '11'\\
pages = <ⅥⅠ-ⅻ> & |\rangelen{pages}| returns '6'\\
pages = <ⅥⅠ-ⅻ, 145-7, 135-39> & |\rangelen{pages}| returns '14'
\end{tabular}
The \cmd{rangelen} command can be used in tests:
\begin{ltxexample}
\ifnumcomp{\rangelen{pages}}{=}{1}{add 'f'}{do nothing}
\end{ltxexample}
\cmditem{DeclareNumChars}{characters}
\cmditem*{DeclareNumChars*}{characters}
This command configures the \cmd{ifnumeral}, \cmd{ifnumerals}, and \cmd{ifpages} tests from \secref{aut:aux:tst}. The setup will also affect \cmd{iffieldnum}, \cmd{iffieldnums}, \cmd{iffieldpages} as well as \cmd{mkpageprefix} and \cmd{mkpagetotal}. The \prm{characters} argument is an undelimited list of characters which are to be considered as being part of a number. The regular version of this command replaces the current setting, the starred version appends its argument to the current list. The default setting is:
\begin{ltxexample}
\DeclareNumChars{.}
\end{ltxexample}
%
This means that a (section or other) number like <3.4.5> will be considered as a number. Note that Arabic and Roman numerals are detected by default, there is no need to declare them explicitly.
\cmditem{DeclareRangeChars}{characters}
\cmditem*{DeclareRangeChars*}{characters}
This command configures the \cmd{ifnumerals} and \cmd{ifpages} tests from \secref{aut:aux:tst}. The setup will also affect \cmd{iffieldnums} and \cmd{iffieldpages} as well as \cmd{mkpageprefix} and \cmd{mkpagetotal}. The \prm{characters} argument is an undelimited list of characters which are to be considered as range indicators. The regular version of this command replaces the current setting, the starred version appends its argument to the current list. The default setting is:
\begin{ltxexample}
\DeclareRangeChars{~,;-+/}
\end{ltxexample}
For engines that fully support Unicode these defaults are extended with
\begin{ltxexample}[escapeinside={(*@}{@*)}]
\DeclareRangeChars*{(*@–—@*)}
\end{ltxexample}
%
This means that strings like <3--5>, <35+>, <8/9> and so on will be considered as a range by \cmd{ifnumerals} and \cmd{ifpages}. Non-range characters in such strings are recognized as numbers. So strings like <3a--5a> and <35b+> are not deemed to be ranges by default. See also \secref{bib:use:pag, use:cav:pag} for further details.
\cmditem{DeclareRangeCommands}{commands}
\cmditem*{DeclareRangeCommands*}{commands}
This command is similar to \cmd{DeclareRangeChars}, except that the \prm{commands} argument is an undelimited list of commands which are to be considered as range indicators. The regular version of this command replaces the current setting, the starred version appends its argument to the current list. The default list is rather long and should cover all common cases; here is a shorter example:
\begin{ltxexample}
\DeclareRangeCommands{\&\bibrangedash\textendash\textemdash\psq\psqq}
\end{ltxexample}
%
See also \secref{bib:use:pag, use:cav:pag} for further details.
\cmditem{DeclarePageCommands}{commands}
\cmditem*{DeclarePageCommands*}{commands}
This command is similar to \cmd{DeclareRangeCommands}, except that it only affects the \cmd{ifpages} and \cmd{iffieldpages} tests but not \cmd{ifnumerals} and \cmd{iffieldnums}. The default setting is:
\begin{ltxexample}
\DeclarePageCommands{\pno\ppno}
\end{ltxexample}
\cmditem{NumCheckSetup}{code}
Use this command to temporarily redefine any commands which interfere with the tests performed by \cmd{ifnumeral}, \cmd{ifnumerals}, and \cmd{ifpages} from \secref{aut:aux:tst}. The setup will also affect \cmd{iffieldnum}, \cmd{iffieldnums}, \cmd{iffieldpages} as well as \cmd{mkpageprefix} and \cmd{mkpagetotal}. The \prm{code} will be executed in a group by these commands. Since the above mentioned commands will expand the string to be analyzed, it is possible to remove commands to be ignored by the tests by making them expand to an empty string. See also \secref{bib:use:pag, use:cav:pag} for further details.
\cmditem{NumsCheckSetup}{code}
Like \cmd{NumCheckSetup} but only applies to \cmd{ifnumerals} and \cmd{ifpages} from \secref{aut:aux:tst} and their derivative tests.
\cmditem{PagesCheckSetup}{code}
Like \cmd{NumCheckSetup} but only applies to \cmd{ifpages} from \secref{aut:aux:tst} and its derivative tests. The default setting is makes \cmd{pnfmt} transparent to the test:
\begin{ltxexample}
\PagesCheckSetup{\let\pnfmt\@firstofone}
\end{ltxexample}
\cmditem{DeclareBabelToExplLanguageMapping}{babel language}{expl language}
This command is only available if the \sty{expl3} case changing code is used.
Use \prm{expl language} as \prm{language} argument for the \sty{l3text} case changing functions when \sty{babel language} is active. This command is only required if \prm{babel language} should correspond to a language for which \sty{l3text} has special rules set up. The default invocations of this command are
\begin{ltxexample}
\DeclareBabelToExplLanguageMapping{dutch}{nl}
\DeclareBabelToExplLanguageMapping{greek}{el}
\DeclareBabelToExplLanguageMapping{turkish}{tr}
\end{ltxexample}
\cmditem{UndeclareBabelToExplLanguageMapping}{babel language}
This command is only available if the \sty{expl3} case changing code is used.
Removes the \sty{babel}-to-\sty{expl3} language mapping for \prm{babel language}. If the argument is an asterisk \texttt{*}, all language mappings are removed.
\cmditem{DeclareCaseLangs}{languages}
\cmditem*{DeclareCaseLangs*}{languages}
Defines the list of languages which are considered by the \cmd{MakeSentenceCase*} command as it converts a string to sentence case. The \prm{languages} argument is a comma"=separated list of \sty{babel}/\sty{polyglossia} language identifiers. The regular version of this command replaces the current setting, the starred version appends its argument to the current list. The default setting is:
\begin{ltxexample}
\DeclareCaseLangs{%
american,british,canadian,english,australian,newzealand,USenglish,UKenglish}
\end{ltxexample}
%
See the \sty{babel}/\sty{polyglossia} manuals and \tabref{bib:fld:tab1} for a list of languages identifiers.
\cmditem{BibliographyWarning}{message}
This command is similar to \cmd{PackageWarning} but prints the entry key of the entry currently being processed in addition to the input line number. It may be used in the bibliography as well as in citation commands. If the \prm{message} is fairly long, use \cmd{MessageBreak} to include line breaks. Note that the standard \cmd{PackageWarning} command does not provide a meaningful clue when used in the bibliography since the input line number is the line on which the \cmd{printbibliography} command was given.
\boolitem{pagetracker}
\leavevmode\vspace{\numexpr2\baselineskip}% fix margin spilling into the text
These commands activate or deactivate the citation tracker locally (this will affect the \cmd{iffirstonpage} and \cmd{ifsamepage} test from \secref{aut:aux:tst}). They are intended for use in the definition of citation commands or anywhere in the document body. If a citation command is to be excluded from page tracking, use \cmd{pagetrackerfalse} in the \prm{precode} argument of \cmd{DeclareCiteCommand}. See \secref{aut:cbx:cbx} for details. Note that these commands have no effect if page tracking has been disabled globally.
\boolitem{citetracker}
\leavevmode\vspace{\numexpr2\baselineskip}% fix margin spilling into the text
These commands activate or deactivate all citation trackers locally (this will affect the \cmd{ifciteseen}, \cmd{ifentryseen}, \cmd{ifciteibid}, and \cmd{ifciteidem} tests from \secref{aut:aux:tst}). They are intended for use in the definition of citation commands or anywhere in the document body. If a citation command is to be excluded from tracking, use \cmd{citetrackerfalse} in the \prm{precode} argument of \cmd{DeclareCiteCommand}. See \secref{aut:cbx:cbx} for details. Note that these commands have no effect if tracking has been disabled globally.
\boolitem{backtracker}
\leavevmode\vspace{\numexpr2\baselineskip}% fix margin spilling into the text
These commands activate or deactivate the \texttt{backref} tracker locally. They are intended for use in the definition of citation commands or anywhere in the document body. If a citation command is to be excluded from backtracking, use \cmd{backtrackerfalse} in the \prm{precode} argument of \cmd{DeclareCiteCommand}. Note that these commands have no effect if the \texttt{backref} option has been not been set globally.
\end{ltxsyntax}
\subsection[Punctuation]{Punctuation and Spacing}
\label{aut:pct}
The \biblatex package provides elaborate facilities designed to manage and track punctuation and spacing in the bibliography and in citations. These facilities work on two levels. The high"=level commands discussed in \secref{aut:pct:new} deal with punctuation and whitespace inserted by the bibliography style between the individual segments of a bibliography entry. The commands in \secref{aut:pct:chk, aut:pct:pct, aut:pct:spc} work at a lower level. They use \tex's space factor and modified space factor codes to track punctuation in a robust and efficient way. This way it is possible to detect trailing punctuation marks within fields, not only those explicitly inserted between fields. The same technique is also used for automatic capitalization of localisation strings, see \cmd{DeclareCapitalPunctuation} in \secref{aut:pct:cfg} as well as \secref{aut:str} for details. Note that these facilities are only made available locally in citations and bibliographies. They will not affect any other part of a document.
\subsubsection{Block and Unit Punctuation}
\label{aut:pct:new}
The major segments of a bibliography entry are <blocks> and <units>. A block is the larger segment of the two, a unit is shorter or at most equal in length. For example, the values of fields such as \bibfield{title} or \bibfield{note} usually form a unit which is separated from subsequent data by a period or a comma. A block may comprise several fields which are treated as separate units, for example \bibfield{publisher}, \bibfield{location}, and \bibfield{year}. The segmentation of an entry into blocks and units is at the discretion of the bibliography style. An entry is segmented by inserting \cmd{newblock} and \cmd{newunit} commands at suitable places and \cmd{finentry} at the very end (see \secref{aut:bbx:drv} for an example). See also \secref{aut:cav:pct} for some practical hints.
\begin{ltxsyntax}
\csitem{newblock}
Records the end of a block. This command does not print anything, it merely marks the end of the block. The block delimiter \cmd{newblockpunct} will be inserted by a subsequent \cmd{printtext}, \cmd{printfield}, \cmd{printlist}, \cmd{printnames}, or \cmd{bibstring} command. You may use \cmd{newblock} at suitable places without having to worry about spurious blocks. A new block will only be started by the next \cmd{printfield} (or similar) command if this command prints anything. See \secref{aut:cav:pct} for further details.
\csitem{newunit}
Records the end of a unit and puts the default delimiter \cmd{newunitpunct} in the punctuation buffer. This command does not print anything, it merely marks the end of the unit. The punctuation buffer will be inserted by the next \cmd{printtext}, \cmd{printfield}, \cmd{printlist}, \cmd{printnames}, or \cmd{bibstring} command. You may use \cmd{newunit} after commands like \cmd{printfield} without having to worry about spurious punctuation and whitespace. The buffer will only be inserted by the next \cmd{printfield} or similar command if \emph{both} fields are non"=empty. This also applies to \cmd{printtext}, \cmd{printlist}, \cmd{printnames}, and \cmd{bibstring}. See \secref{aut:cav:pct} for further details.
\csitem{finentry}
Inserts \cmd{finentrypunct}. This command should be used at the very end of every bibliography entry.
\cmditem{setunit}{punctuation}
\cmditem*{setunit*}{punctuation}
The \cmd{setunit} command is similar to \cmd{newunit} except that it uses \prm{punctuation} instead of \cmd{newunitpunct}. The starred variant differs from the regular version in that it checks if the last \cmd{printtext}, \cmd{printfield}, \cmd{printlist}, \cmd{printnames}, or \cmd{bibstring} command did actually print anything. If not, it does nothing.
\cmditem{printunit}{punctuation}
\cmditem*{printunit*}{punctuation}
The \cmd{printunit} command is similar to \cmd{setunit} except that \prm{punctuation} persists in the buffer. This ensures that \prm{punctuation} is inserted before the next non"=empty field printed by the \cmd{printtext}, \cmd{printfield}, \cmd{printlist}, \cmd{printnames}, or \cmd{bibstring} commands---regardless of any intermediate calls to \cmd{newunit} or \cmd{setunit}.
\cmditem{setpunctfont}{command}
This command, which is intended for use in field formatting directives, provides an alternative way of dealing with unit punctuation after a field printed in a different font (for example, a title printed in italics). The standard \latex way of dealing with this is adding a small amount of space, the so-called italic correction. This command allows adapting the punctuation to the font of the preceding field. The \prm{command} should be a text font command which takes one argument, such as \cmd{emph} or \cmd{textbf}. This command will only affect punctuation marks inserted by one of the commands from \secref{aut:pct:pct}. The font adaption is applied to the next punctuation mark only and will be reset automatically thereafter. If you want to reset it manually before it takes effect, issue \cmd{resetpunctfont}. If the \opt{punctfont} package option is disabled, this command does nothing. Note that the \cmd{mkbibemph}, \cmd{mkbibitalic} and \cmd{mkbibbold} wrappers from \secref{aut:fmt:ich} incorporate this feature by default.
\csitem{resetpunctfont}
This command resets the unit punctuation font defined with \cmd{setpunctfont} before it takes effect. If the \opt{punctfont} package option is disabled, this command does nothing.
\end{ltxsyntax}
\subsubsection{Punctuation Tests}
\label{aut:pct:chk}
The following commands may be used to test for preceding punctuation marks at any point in citations and the bibliography.
\begin{ltxsyntax}
\cmditem{ifpunct}{true}{false}
Executes \prm{true} if preceded by any punctuation mark except for an abbreviation dot, and \prm{false} otherwise.
\cmditem{ifterm}{true}{false}
Executes \prm{true} if preceded by a terminal punctuation mark, and \prm{false} otherwise. A terminal punctuation mark is any punctuation mark which has been registered for automatic capitalization, either with \cmd{DeclareCapitalPunctuation} or by default, see \secref{aut:pct:cfg} for details. By default, this applies to periods, exclamation marks, and question marks.
\cmditem{ifpunctmark}{character}{true}{false}
Executes \prm{true} if preceded by the punctuation mark \prm{character}, and \prm{false} otherwise. The \prm{character} may be a comma, a semicolon, a colon, a period, an exclamation mark, a question mark, or an asterisk. Note that a period denotes an end-of"=sentence period. Use the asterisk to test for the dot after an abbreviation. If this command is used in a formatting directive for name lists, \ie in the argument to \cmd{DeclareNameFormat}, the \prm{character} may also be an apostrophe.
\cmditem{ifprefchar}{true}{false}
Executes \prm{true} if preceded by any prefix character declared by \cmd{DeclarePrefChars}.
\end{ltxsyntax}
\subsubsection{Adding Punctuation}
\label{aut:pct:pct}
The following commands are designed to prevent double punctuation marks. Bibliography and citation styles should always use these commands instead of literal punctuation marks. All \cmd{add...} commands in this section automatically remove preceding whitespace with \cmd{unspace} (see \secref{aut:pct:spc}). Note that the behavior of all \cmd{add...} commands discussed below is the package default, which is restored whenever \biblatex switches languages. This behavior may be adjusted with \cmd{DeclarePunctuationPairs} from \secref{aut:pct:cfg}.
\begin{ltxsyntax}
\csitem{adddot}
Adds a period unless it is preceded by any punctuation mark. The purpose of this command is inserting the dot after an abbreviation. Any dot inserted this way is recognized as such by the other punctuation commands. This command may also be used to turn a previously inserted literal period into an abbreviation dot.
\csitem{addcomma}
Adds a comma unless it is preceded by another comma, a semicolon, a colon, or a period.
\csitem{addsemicolon}
Adds a semicolon unless it is preceded by a comma, another semicolon, a colon, or a period.
\csitem{addcolon}
Adds a colon unless it is preceded by a comma, a semicolon, another colon, or a period.
\csitem{addperiod}
Adds a period unless it is preceded by an abbreviation dot or any other punctuation mark. This command may also be used to turn a previously inserted abbreviation dot into a period, for example at the end of a sentence.
\csitem{addexclam}
Adds an exclamation mark unless it is preceded by any punctuation mark except for an abbreviation dot.
\csitem{addquestion}
Adds a question mark unless it is preceded by any punctuation mark except for an abbreviation dot.
\csitem{isdot}
Turns a previously inserted literal period into an abbreviation dot. In contrast to \cmd{adddot}, nothing is inserted if this command is not preceded by a period.
\csitem{nopunct}
Adds an internal marker which will cause the next punctuation command to print nothing.
\end{ltxsyntax}
\subsubsection{Adding Whitespace}
\label{aut:pct:spc}
The following commands are designed to prevent spurious whitespace. Bibliography and citation styles should always use these commands instead of literal whitespace. In contrast to the commands in \secref{aut:pct:chk, aut:pct:pct}, they are not restricted to citations and the bibliography but available globally.
\begin{ltxsyntax}
\csitem{unspace}
Removes preceding whitespace, \ie removes all skips and penalties from the end of the current horizontal list. This command is implicitly executed by all of the following commands.
\csitem{addspace}
Adds a breakable interword space.
\csitem{addnbspace}
Adds a non"=breakable interword space.
\csitem{addthinspace}
Adds a \emph{breakable} thin space.
\csitem{addnbthinspace}
Adds a non"=breakable thin space. This is similar to \cmd{,} and \cmd{thinspace}.
\csitem{addlowpenspace}
Adds a space penalized by the value of the \cnt{lownamepenalty} counter, see \secref{use:fmt:len, aut:fmt:len} for details.
\csitem{addhighpenspace}
Adds a space penalized by the value of the \cnt{highnamepenalty} counter, see \secref{use:fmt:len, aut:fmt:len} for details.
\csitem{addlpthinspace}
Similar to \cmd{addlowpenspace} but adds a breakable thin space.
\csitem{addhpthinspace}
Similar to \cmd{addhighpenspace} but adds a breakable thin space.
\csitem{addabbrvspace}
Adds a space penalized by the value of the \cnt{abbrvpenalty} counter, see \secref{use:fmt:len, aut:fmt:len} for details.
\csitem{addabthinspace}
Similar to \cmd{addabbrvspace} but using a thin space.
\csitem{adddotspace}
Executes \cmd{adddot} and adds a space penalized by the value of the \cnt{abbrvpenalty} counter, see \secref{use:fmt:len, aut:fmt:len} for details.
\csitem{addslash}
Adds a breakable slash. This command differs from the \cmd{slash} command in the \latex kernel in that a linebreak after the slash is not penalized at all.
\end{ltxsyntax}
Note that the commands in this section implicitly execute \cmd{unspace} to remove spurious whitespace, hence they may be used to override each other. For example, you may use \cmd{addnbspace} to transform a previously inserted interword space into a non"=breakable one and \cmd{addspace} to turn a non"=breakable space into a breakable one.
\subsubsection{Configuring Punctuation and Capitalization}
\label{aut:pct:cfg}
The following commands configure various features related to punctuation and automatic capitalization.
\begin{ltxsyntax}
\cmditem{DeclarePrefChars}{characters}
\cmditem*{DeclarePrefChars*}{characters}
This command declares characters that are to be treated specially when testing to see if \cmd{bibnamedelimc} is to be inserted between a name prefix and a family name. If a character is in the list of \prm{characters}, \cmd{bibnamedelimc} is not inserted. It is used to allow abbreviated name prefices like <d'Argent> where no space should be inserted after the apostrophe. The starred version appends its argument to the list of prefix characters, the unstarred version replaces the current setting. The default setting is:
\begin{ltxexample}
\DeclarePrefChars{'-}
\end{ltxexample}
For engines that fully support Unicode these defaults are extended with
\begin{ltxexample}[escapeinside={(*@}{@*)}]
\DeclarePrefChars*{(*@’@*)}
\end{ltxexample}
\cmditem{DeclareAutoPunctuation}{characters}
This command defines the punctuation marks to be considered by the citation commands as they scan ahead for punctuation. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. The default setting is:
\begin{ltxexample}
\DeclareAutoPunctuation{.,;:!?}
\end{ltxexample}
%
This definition is restored automatically whenever the \opt{autopunct} package option is set to \texttt{true}. Executing |\DeclareAutoPunctuation{}| is equivalent to setting \kvopt{autopunct}{false}, \ie it disables this feature.
\cmditem{DeclareCapitalPunctuation}{characters}
When \biblatex inserts localisation strings, \ie key terms such as <edition> or <volume>, it automatically capitalizes them after terminal punctuation marks. This command defines the punctuation marks which will cause localisation strings to be capitalized if one of them precedes a string. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. The package default is:
\begin{ltxexample}
\DeclareCapitalPunctuation{.!?}
\end{ltxexample}
%
Using \cmd{DeclareCapitalPunctuation} with an empty argument is equivalent to disabling automatic capitalization. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. By default, strings are capitalized after periods, exclamation marks, and question marks. All strings are generally capitalized at the beginning of a paragraph (in fact whenever \tex is in vertical mode).
\cmditem{DeclarePunctuationPairs}{identifier}{characters}
Use this command to declare valid pairs of punctuation marks. This will affect the punctuation commands discussed in \secref{aut:pct:pct}. For example, the description of \cmd{addcomma} states that this command adds a comma unless it is preceded by another comma, a semicolon, a colon, or a period. In other words, commas after abbreviation dots, exclamation marks, and question marks are permitted. These valid pairs are declared as follows:
\begin{ltxexample}
\DeclarePunctuationPairs{comma}{*!?}
\end{ltxexample}
%
The \prm{identifier} selects the command to be configured. The identifiers correspond to the names of the punctuation commands from \secref{aut:pct:pct} without the \cmd{add} prefix, \ie valid \prm{identifier} strings are \texttt{dot}, \texttt{comma}, \texttt{semicolon}, \texttt{colon}, \texttt{period}, \texttt{exclam}, \texttt{question}. The \prm{characters} argument is an undelimited list of punctuation marks. Valid \prm{characters} are comma, semicolon, colon, period, exclamation mark, question mark, and asterisk. A period in the \prm{characters} argument denotes an end-of"=sentence period, an asterisk the dot after an abbreviation. This is the default setup, which is automatically restored whenever \biblatex switches languages and corresponds to the behavior described in \secref{aut:pct:pct}:
\begin{ltxexample}
\DeclarePunctuationPairs{dot}{}
\DeclarePunctuationPairs{comma}{*!?}
\DeclarePunctuationPairs{semicolon}{*!?}
\DeclarePunctuationPairs{colon}{*!?}
\DeclarePunctuationPairs{period}{}
\DeclarePunctuationPairs{exclam}{*}
\DeclarePunctuationPairs{question}{*}
\end{ltxexample}
%
Since this feature is language specific, \cmd{DeclarePunctuationPairs} must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. Note that some localisation modules may use a setup which is different from the package default.\footnote{As of this writing, the \texttt{american} module uses different settings for <American-style> punctuation.}
\cmditem{DeclareQuotePunctuation}{characters}
This command controls <American-style> punctuation. The \cmd{mkbibquote} wrapper from \secref{aut:fmt:ich} can interact with the punctuation facilities discussed in \secref{aut:pct:new, aut:pct:pct, aut:pct:spc}. Punctuation marks after \cmd{mkbibquote} will be moved inside the quotes if they have been registered with \cmd{DeclareQuotePunctuation}. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. Here is an example:
\begin{ltxexample}
\DeclareQuotePunctuation{.,}
\end{ltxexample}
%
Executing |\DeclareQuotePunctuation{}| is equivalent to disabling this feature. This is the package default. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. See also \secref{use:loc:us}.
\csitem{uspunctuation}
A shorthand using the lower-level commands \cmd{DeclareQuotePunctuation} and \cmd{DeclarePunctuationPairs} to activate <American-style> punctuation. See \secref{use:loc:us} for details. This shorthand is provided for convenience only. The effective settings are applied by the lower-level commands.
\csitem{stdpunctuation}
Undoes the settings applied by \cmd{uspunctuation}, restoring standard punctuation. As standard punctuation is the default setting, you only need this command to override a previously executed \cmd{uspunctuation} command. See \secref{use:loc:us} for details.
\end{ltxsyntax}
\subsubsection{Correcting Punctuation Tracking}
\label{aut:pct:ctr}
The facilities for punctuation tracking and automatic capitalization are very reliable under normal circumstances, but there are always marginal cases which may require manual intervention. Typical cases are localisation strings printed as the first word in a footnote (which is usually treated as the beginning of a paragraph as far as capitalization is concerned, but \tex is not in vertical mode at this point) or punctuation after periods which are not really end"=of"=sentence periods (for example, after an ellipsis like «[\dots\unkern]» a command such as \cmd{addperiod} would do nothing since parentheses and brackets are transparent to the punctuation tracker). In such cases, use the following commands in bibliography and citation styles to mark the beginning or middle of a sentence if and where required:
\begin{ltxsyntax}
\csitem{bibsentence}
This command marks the beginning of a sentence. A localisation string immediately after this command will be capitalized and the punctuation tracker is reset, \ie this command hides all preceding punctuation marks from the punctuation tracker and enforces capitalization.
\csitem{midsentence}
This command marks the middle of a sentence. A localisation string immediately after this command will not be capitalized and the punctuation tracker is reset, \ie this command hides all preceding punctuation marks from the punctuation tracker and suppresses capitalization.
\csitem*{midsentence*}
The starred variant of \cmd{midsentence} differs from the regular one in that a preceding abbreviation dot is not hidden from the punctuation tracker, \ie any code after \cmd{midsentence*} will see a preceding abbreviation dot. All other punctuation marks are hidden from the punctuation tracker and capitalization is suppressed.
\end{ltxsyntax}
\subsection{Localization Strings}
\label{aut:str}
Localization strings are key terms such as <edition> or <volume> which are automatically translated by \biblatex's localisation modules. See \secref{aut:lng} for an overview and \secref{aut:lng:key} for a list of all strings supported by default. The commands in this section are used to print the localised term.
\begin{ltxsyntax}
\cmditem{bibstring}[wrapper]{key}
Prints the localisation string \prm{key}, where \prm{key} is an identifier in lowercase letters (see \secref{aut:lng:key}). The string will be capitalized as required, see \secref{aut:pct:cfg} for details.
Depending on the \opt{abbreviate} package option from \secref{use:opt:pre:gen}, \cmd{bibstring} prints the short or the long version of the string. If localisation strings are nested, \ie if \cmd{bibstring} is used in another string, it will behave like \cmd{bibxstring}.
If the \prm{wrapper} argument is given, the string is passed to the \prm{wrapper} for formatting. This is intended for font commands such as \cmd{emph}.
\cmditem{biblstring}[wrapper]{key}
Similar to \cmd{bibstring} but always prints the long string, ignoring the \opt{abbreviate} option.
\cmditem{bibsstring}[wrapper]{key}
Similar to \cmd{bibstring} but always prints the short string, ignoring the \opt{abbreviate} option.
\cmditem{bibncpstring}[wrapper]{key}
Similar to \cmd{bibstring} but the term is never capitalized.
\cmditem{bibncplstring}[wrapper]{key}
Similar to \cmd{biblstring} but the term is never capitalized.
\cmditem{bibncpsstring}[wrapper]{key}
Similar to \cmd{bibsstring} but the term is never capitalized.
\cmditem{bibcpstring}[wrapper]{key}
Similar to \cmd{bibstring} but the term is always capitalized.
\cmditem{bibcplstring}[wrapper]{key}
Similar to \cmd{biblstring} but the term is always capitalized.
\cmditem{bibcpsstring}[wrapper]{key}
Similar to \cmd{bibsstring} but the term is always capitalized.
\cmditem{bibucstring}[wrapper]{key}
Similar to \cmd{bibstring} but the whole term is uppercased.
\cmditem{bibuclstring}[wrapper]{key}
Similar to \cmd{biblstring} but the whole term is uppercased.
\cmditem{bibucsstring}[wrapper]{key}
Similar to \cmd{bibsstring} but the whole term is uppercased.
\cmditem{biblcstring}[wrapper]{key}
Similar to \cmd{bibstring} but the whole term is lowercased.
\cmditem{biblclstring}[wrapper]{key}
Similar to \cmd{biblstring} but the whole term is lowercased.
\cmditem{biblcsstring}[wrapper]{key}
Similar to \cmd{bibsstring} but the whole term is lowercased.
\cmditem{bibxstring}{key}
A simplified but expandable version of \cmd{bibstring}. Note that this variant does not capitalize automatically, nor does it hook into the punctuation tracker. It is intended for special cases in which strings are nested or an expanded localisation string is required in a test.
\cmditem{bibxlstring}[wrapper]{key}
Similar to \cmd{bibxstring} but always uses the long string, ignoring the \opt{abbreviate} option.
\cmditem{bibxsstring}[wrapper]{key}
Similar to \cmd{bibxstring} but always uses the short string, ignoring the \opt{abbreviate} option.
\cmditem{mainlang}
Switches from the current language to the main document language. This can be used the \prm{wrapper} argument in the localisation string commands above.
\end{ltxsyntax}
\subsection{Localization Modules}
\label{aut:lng}
A localisation module provides translations for key terms such as <edition> or <volume> as well as definitions for language specific features such as the date format and ordinals. These definitions are provided in files with the suffix \file{lbx}. The base name of the file must be a language name known to the \sty{babel}/\sty{polyglossia} packages. The \file{lbx} files may also be used to map \sty{babel}/\sty{polyglossia} language names to the backend modules of the \biblatex package. All localisation modules are loaded on demand in the document body. Note that the contents of the file are processed in a group and that the category code of the character \texttt{@} is temporarily set to <letter>.
\subsubsection{Localization Commands}
\label{aut:lng:cmd}
The user"=level versions of the localisation commands were already introduced in \secref{use:lng}. When used in \file{lbx} files, however, the syntax of localisation commands is different from the user syntax in the preamble and the configuration file. When used in localisation files, there is no need to specify the \prm{language} because the mapping of strings to a language is already provided by the name of the \file{lbx} file.
\begin{ltxsyntax}
\cmditem{DeclareBibliographyStrings}{definitions}
This command is only available in \file{lbx} files. It is used to define localisation strings. The \prm{definitions} consist of \keyval pairs which assign an expression to an identifier. A complete list of all keys supported by default is given is \secref{aut:lng:key}. Note that the syntax of the value is different in \file{lbx} files. The value assigned to a key consists of two expressions, each of which is wrapped in an additional pair of brackets. This is best shown by example:
\begin{ltxexample}
\DeclareBibliographyStrings{%
bibliography = {{Bibliography}{Bibliography}},
shorthands = {{List of Abbreviations}{Abbreviations}},
editor = {{editor}{ed.}},
editors = {{editors}{eds.}},
}
\end{ltxexample}
%
The first value is the long, written out expression, the second one is an abbreviated or short form. Both strings must always be given even though they may be identical if an expression is always (or never) abbreviated. Depending on the setting of the \opt{abbreviate} package option (see \secref{use:opt:pre:gen}), \biblatex selects one expression when loading the \file{lbx} file. There is also a special key named \texttt{inherit} which copies the strings from a different language. This is intended for languages which only differ in a few expressions, such as German and Austrian or American and British English. For example, here are the complete definitions for Austrian:
\begin{ltxexample}
\DeclareBibliographyStrings{%
inherit = {german},
january = {{J\"anner}{J\"an.}},
}
\end{ltxexample}
The above examples are slightly simplified. Real localisation files should use the punctuation and formatting commands discussed in \secref{aut:pct:pct, use:fmt} instead of literal punctuation. Here is an excerpt from a real localisation file:
\begin{ltxexample}
bibliography = {{Bibliography}{Bibliography}},
shorthands = {{List of Abbreviations}{Abbreviations}},
editor = {{editor}{ed\adddot}},
editors = {{editors}{eds\adddot}},
byeditor = {{edited by}{ed\adddotspace by}},
mathesis = {{Master's thesis}{MA\addabbrvspace thesis}},
\end{ltxexample}
%
Note the handling of abbreviation dots, the spacing in abbreviated expressions, and the capitalization in the example above. All expressions should be capitalized as they usually are when used in the middle of a sentence. The \biblatex package will automatically capitalize the first word when required at the beginning of a sentence, see \cmd{DeclareCapitalPunctuation} in \secref{aut:pct:cfg} for details. Expressions intended for use in headings are special. They should be capitalized in a way that is suitable for titling and should not be abbreviated (but they may have a short form).
\cmditem{InheritBibliographyStrings}{language}
This command is only available in \file{lbx} files. It copies the localisation strings for \prm{language} to the current language, as specified by the name of the \file{lbx} file.
\cmditem{DeclareBibliographyExtras}{code}
This command is only available in \file{lbx} files. It is used to adapt language specific features such as the date format and ordinals. The \prm{code}, which may be arbitrary \latex code, will usually consist of redefinitions of the formatting commands from \secref{aut:fmt:lng}.
\cmditem{UndeclareBibliographyExtras}{code}
This command is only available in \file{lbx} files. It is used to restore any formatting commands modified with \cmd{DeclareBibliographyExtras}. If a redefined command is included in \secref{aut:fmt:lng}, there is no need to restore its previous definition since these commands are localised by all language modules anyway.
\cmditem{InheritBibliographyExtras}{language}
This command is only available in \file{lbx} files. It copies the bibliography extras for \prm{language} to the current language, as specified by the name of the \file{lbx} file.
\cmditem{DeclareHyphenationExceptions}{text}
This command corresponds to \cmd{DefineHyphenationExceptions} from \secref{use:lng}. The difference is that it is only available in \file{lbx} files and that the \prm{language} argument is omitted. The hyphenation exceptions will affect the language of the \file{lbx} file currently being processed.
\cmditem{DeclareRedundantLanguages}{language, language, ...}{langid, langid, ...}
This command provides the language mappings required by the \opt{clearlang} option from \secref{use:opt:pre:gen}.
The \prm{language} is the string given in the \bibfield{language} field (without the optional \texttt{lang} prefix); \prm{langid} is \sty{babel}/\sty{polyglossia}'s language identifier, as given in the optional argument of \cmd{usepackage} when loading \sty{babel} or the argument of \cmd{setdefaultlanguage} or \cmd{setotherlanguages} when using \sty{polyglossia}. This command may be used in \file{lbx} files or in the document preamble. Here are some examples:
\begin{ltxexample}
\DeclareRedundantLanguages{french}{french}
\DeclareRedundantLanguages{german}{german,ngerman,austrian,naustrian,
nswissgerman,swissgerman}
\DeclareRedundantLanguages{english,american}{english,american,british,
canadian,australian,newzealand,USenglish,UKenglish}
\end{ltxexample}
%
Note that this feature needs to be enabled globally with the \opt{clearlang} option from \secref{use:opt:pre:gen}. If it is disabled, all mappings will be ignored. If the \prm{langid} parameter is blank, \biblatex will clear the mappings for the corresponding \prm{language}, \ie the feature will be disabled for this \prm{language} only.
\cmditem{DeclareLanguageMapping}{language}{file}
This command maps a \sty{babel}/\sty{polyglossia} language identifier to an \file{lbx} file. The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglossia} package, \ie one of the identifiers listed in \tabref{bib:fld:tab1}. The \prm{file} argument is the name of an alternative \file{lbx} file without the \texttt{.lbx} suffix. Declaring the same mapping more than once is possible. Subsequent declarations will simply overwrite any previous ones. This command may only be used in the preamble. See \secref{aut:cav:lng} for further details.
\cmditem{DeclareLanguageMappingSuffix}{suffix}
This command defines a language file suffix which will be added when looking for \file{.lbx} language string definition files. This is intended for styles which provide their own \file{.lbx} files so that they will be used automatically. For example, the APA style defines:
\begin{ltxexample}
\DeclareLanguageMappingSuffix{-apa}
\end{ltxexample}
%
When the document language is <german>, \biblatex will look for the file \file{german-apa.lbx} which defines some APA specific strings and in turn loads \file{german.lbx}. If \cmd{DeclareLanguageMapping} is defined for a language, this overrides \cmd{DeclareLanguageMappingSuffix}.
The suffix will be applied to other language files loaded recursively by the loading of a language file. For example, given the suffix defined above, when loading <ngerman>, \biblatex will look for the file \file{ngerman-apa.lbx} and if this recursively loads <german>, then biblatex will look for \file{german-apa.lbx}. Infinite recursion is of course avoided.
\cmditem{NewBibliographyString}{key}
This command, which may be used in the preamble (including \file{cbx} and \file{bbx} files) as well as in \file{lbx} files, declares new localisation strings, \ie it initializes a new \prm{key} to be used in the \prm{definitions} of \cmd{DefineBibliographyStrings} or \cmd{DeclareBibliographyStrings}. The \prm{key} argument may also be a comma"=separated list of key names. When used in an \file{lbx}, the \prm{key} is initialized only for the language specified by the name of the \file{lbx} file. The keys listed in \secref{aut:lng:key} are defined by default.
\end{ltxsyntax}
\subsubsection{Localization Keys}
\label{aut:lng:key}
The localisation keys in this section are defined by default and covered by the localisation files which come with \biblatex. Note that these strings are only available in citations, the bibliography and bibliography lists. All expressions should be capitalized as they usually are when used in the middle of a sentence. \biblatex will capitalize them automatically at the beginning of a sentence. The only exceptions to these rules are the three strings intended for use in headings.
\paragraph{Headings}
\label{aut:lng:key:bhd}
The following strings are special because they are intended for use in headings and made available globally via macros. For this reason, they should be capitalized for use in headings and they must not include any local commands which are part of \biblatex's author interface.
\begin{keymarglist}
\item[bibliography] The term <bibliography>, also available as \cmd{bibname}.
\item[references] The term <references>, also available as \cmd{refname}.
\item[shorthands] The term <list of shorthands> or <list of abbreviations>, also available as \cmd{biblistname}.
\end{keymarglist}
\paragraph{Roles, Expressed as Functions}
\label{aut:lng:key:efn}
The following keys refer to roles which are expressed as a function (<editor>, <translator>) rather than as an action (<edited by>, <translated by>).
\begin{keymarglist}
\item[editor] The term <editor>, referring to the main editor. This is the most generic editorial role.
\item[editors] The plural form of \texttt{editor}.
\item[compiler] The term <compiler>, referring to an editor whose task is to compile a work.
\item[compilers] The plural form of \texttt{compiler}.
\item[founder] The term <founder>, referring to a founding editor.
\item[founders] The plural form of \texttt{founder}.
\item[continuator] An expression like <continuator>, <continuation>, or <continued>, referring to a past editor who continued the work of the founding editor but was subsequently replaced by the current editor.
\item[continuators] The plural form of \texttt{continuator}.
\item[redactor] The term <redactor>, referring to a secondary editor.
\item[redactors] The plural form of \texttt{redactor}.
\item[reviser] The term <reviser>, referring to a secondary editor.
\item[revisers] The plural form of \texttt{reviser}.
\item[collaborator] A term like <collaborator>, <collaboration>, <cooperator>, or <cooperation>, referring to a secondary editor.
\item[collaborators] The plural form of \texttt{collaborator}.
\item[translator] The term <translator>.
\item[translators] The plural form of \texttt{translator}.
\item[commentator] The term <commentator>, referring to the author of a commentary to a work.
\item[commentators] The plural form of \texttt{commentators}.
\item[annotator] The term <annotator>, referring to the author of annotations to a work.
\item[annotators] The plural form of \texttt{annotators}.
\item[organizer] The term <organizer>, referring to the organizer of an
event or work.
\item[organizers] The plural form of \texttt{organizer}.
\end{keymarglist}
\paragraph{Concatenated Editor Roles, Expressed as Functions}
\label{aut:lng:key:cef}
The following keys are similar in function to \texttt{editor}, \texttt{translator}, etc. They are used to indicate additional roles of the editor, \eg\ <editor and translator>, <editor and foreword>.
\begin{keymarglist}
\item[editortr] Used if \bibfield{editor}\slash \bibfield{translator} are identical.
\item[editorstr] The plural form of \texttt{editortr}.
\item[editorco] Used if \bibfield{editor}\slash \bibfield{commentator} are identical.
\item[editorsco] The plural form of \texttt{editorco}.
\item[editoran] Used if \bibfield{editor}\slash \bibfield{annotator} are identical.
\item[editorsan] The plural form of \texttt{editoran}.
\item[editorin] Used if \bibfield{editor}\slash \bibfield{introduction} are identical.
\item[editorsin] The plural form of \texttt{editorin}.
\item[editorfo] Used if \bibfield{editor}\slash \bibfield{foreword} are identical.
\item[editorsfo] The plural form of \texttt{editorfo}.
\item[editoraf] Used if \bibfield{editor}\slash \bibfield{aftword} are identical.
\item[editorsaf] The plural form of \texttt{editoraf}.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{translator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[editortrco] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator} are identical.
\item[editorstrco] The plural form of \texttt{editortrco}.
\item[editortran] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{annotator} are identical.
\item[editorstran] The plural form of \texttt{editortran}.
\item[editortrin] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{introduction} are identical.
\item[editorstrin] The plural form of \texttt{editortrin}.
\item[editortrfo] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{foreword} are identical.
\item[editorstrfo] The plural form of \texttt{editortrfo}.
\item[editortraf] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{aftword} are identical.
\item[editorstraf] The plural form of \texttt{editortraf}.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[editorcoin] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[editorscoin] The plural form of \texttt{editorcoin}.
\item[editorcofo] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[editorscofo] The plural form of \texttt{editorcofo}.
\item[editorcoaf] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\item[editorscoaf] The plural form of \texttt{editorcoaf}.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{annotator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[editoranin] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{introduction} are identical.
\item[editorsanin] The plural form of \texttt{editoranin}.
\item[editoranfo] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{foreword} are identical.
\item[editorsanfo] The plural form of \texttt{editoranfo}.
\item[editoranaf] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{aftword} are identical.
\item[editorsanaf] The plural form of \texttt{editoranaf}.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[editortrcoin] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[editorstrcoin] The plural form of \texttt{editortrcoin}.
\item[editortrcofo] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[editorstrcofo] The plural form of \texttt{editortrcofo}.
\item[editortrcoaf] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\item[editorstrcoaf] The plural form of \texttt{editortrcoaf}.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[editortranin] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[editorstranin] The plural form of \texttt{editortranin}.
\item[editortranfo] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[editorstranfo] The plural form of \texttt{editortranfo}.
\item[editortranaf] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\item[editorstranaf] The plural form of \texttt{editortranaf}.
\end{keymarglist}
\paragraph{Concatenated Translator Roles, Expressed as Functions}
\label{aut:lng:key:ctf}
The following keys are similar in function to \texttt{translator}. They are used to indicate additional roles of the translator, \eg\ <translator and commentator>, <translator and introduction>.
\begin{keymarglist}
\item[translatorco] Used if \bibfield{translator}\slash \bibfield{commentator} are identical.
\item[translatorsco] The plural form of \texttt{translatorco}.
\item[translatoran] Used if \bibfield{translator}\slash \bibfield{annotator} are identical.
\item[translatorsan] The plural form of \texttt{translatoran}.
\item[translatorin] Used if \bibfield{translator}\slash \bibfield{introduction} are identical.
\item[translatorsin] The plural form of \texttt{translatorin}.
\item[translatorfo] Used if \bibfield{translator}\slash \bibfield{foreword} are identical.
\item[translatorsfo] The plural form of \texttt{translatorfo}.
\item[translatoraf] Used if \bibfield{translator}\slash \bibfield{aftword} are identical.
\item[translatorsaf] The plural form of \texttt{translatoraf}.
\end{keymarglist}
%
Keys for \bibfield{translator}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[translatorcoin] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[translatorscoin] The plural form of \texttt{translatorcoin}.
\item[translatorcofo] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[translatorscofo] The plural form of \texttt{translatorcofo}.
\item[translatorcoaf] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\item[translatorscoaf] The plural form of \texttt{translatorcoaf}.
\end{keymarglist}
%
Keys for \bibfield{translator}\slash \bibfield{annotator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[translatoranin] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{introduction} are identical.
\item[translatorsanin] The plural form of \texttt{translatoranin}.
\item[translatoranfo] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{foreword} are identical.
\item[translatorsanfo] The plural form of \texttt{translatoranfo}.
\item[translatoranaf] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{aftword} are identical.
\item[translatorsanaf] The plural form of \texttt{translatoranaf}.
\end{keymarglist}
\paragraph{Roles, Expressed as Actions}
\label{aut:lng:key:eac}
The following keys refer to roles which are expressed as an action (<edited by>, <translated by>) rather than as a function (<editor>, <translator>).
\begin{keymarglist}
\item[byauthor] The expression <[created] by \prm{name}>.
\item[byeditor] The expression <edited by \prm{name}>.
\item[bycompiler] The expression <compiled by \prm{name}>.
\item[byfounder] The expression <founded by \prm{name}>.
\item[bycontinuator] The expression <continued by \prm{name}>.
\item[byredactor] The expression <redacted by \prm{name}>.
\item[byreviser] The expression <revised by \prm{name}>.
\item[byreviewer] The expression <reviewed by \prm{name}>.
\item[bycollaborator] An expression like <in collaboration with \prm{name}> or <in cooperation with \prm{name}>.
\item[bytranslator] The expression <translated by \prm{name}> or <translated from \prm{language} by \prm{name}>.
\item[bycommentator] The expression <commented by \prm{name}>.
\item[byannotator] The expression <annotated by \prm{name}>.
\item[byorganizer] The expression <[organized] by \prm{name}>.
\end{keymarglist}
\paragraph{Concatenated Editor Roles, Expressed as Actions}
\label{aut:lng:key:cea}
The following keys are similar in function to \texttt{byeditor}, \texttt{bytranslator}, etc. They are used to indicate additional roles of the editor, \eg\ <edited and translated by>, <edited and furnished with an introduction by>, <edited, with a foreword, by>.
\begin{keymarglist}
\item[byeditortr] Used if \bibfield{editor}\slash \bibfield{translator} are identical.
\item[byeditorco] Used if \bibfield{editor}\slash \bibfield{commentator} are identical.
\item[byeditoran] Used if \bibfield{editor}\slash \bibfield{annotator} are identical.
\item[byeditorin] Used if \bibfield{editor}\slash \bibfield{introduction} are identical.
\item[byeditorfo] Used if \bibfield{editor}\slash \bibfield{foreword} are identical.
\item[byeditoraf] Used if \bibfield{editor}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{translator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[byeditortrco] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator} are identical.
\item[byeditortran] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{annotator} are identical.
\item[byeditortrin] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{introduction} are identical.
\item[byeditortrfo] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{foreword} are identical.
\item[byeditortraf] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[byeditorcoin] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[byeditorcofo] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[byeditorcoaf] Used if \bibfield{editor}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{annotator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[byeditoranin] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{introduction} are identical.
\item[byeditoranfo] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{foreword} are identical.
\item[byeditoranaf] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[byeditortrcoin] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[byeditortrcofo] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[byeditortrcoaf] Used if \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{annotator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[byeditortranin] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[byeditortranfo] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[byeditortranaf] Used if \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
\paragraph{Concatenated Translator Roles, Expressed as Actions}
\label{aut:lng:key:cta}
The following keys are similar in function to \texttt{bytranslator}. They are used to indicate additional roles of the translator, \eg\ <translated and commented by>, <translated and furnished with an introduction by>, <translated, with a foreword, by>.
\begin{keymarglist}
\item[bytranslatorco] Used if \bibfield{translator}\slash \bibfield{commentator} are identical.
\item[bytranslatoran] Used if \bibfield{translator}\slash \bibfield{annotator} are identical.
\item[bytranslatorin] Used if \bibfield{translator}\slash \bibfield{introduction} are identical.
\item[bytranslatorfo] Used if \bibfield{translator}\slash \bibfield{foreword} are identical.
\item[bytranslatoraf] Used if \bibfield{translator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{translator}\slash \bibfield{commentator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[bytranslatorcoin] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{introduction} are identical.
\item[bytranslatorcofo] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{foreword} are identical.
\item[bytranslatorcoaf] Used if \bibfield{translator}\slash \bibfield{commentator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
%
Keys for \bibfield{translator}\slash \bibfield{annotator}\slash \prm{role} combinations:
\begin{keymarglist}
\item[bytranslatoranin] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{introduction} are identical.
\item[bytranslatoranfo] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{foreword} are identical.
\item[bytranslatoranaf] Used if \bibfield{translator}\slash \bibfield{annotator}\slash \bibfield{aftword} are identical.
\end{keymarglist}
\paragraph{Roles, Expressed as Objects}
\label{aut:lng:key:rob}
Roles which are related to supplementary material may also be expressed as objects (<with a commentary by>) rather than as functions (<commentator>) or as actions (<commented by>).
\begin{keymarglist}
\item[withcommentator] The expression <with a commentary by \prm{name}>.
\item[withannotator] The expression <with annotations by \prm{name}>.
\item[withintroduction] The expression <with an introduction by \prm{name}>.
\item[withforeword] The expression <with a foreword by \prm{name}>.
\item[withafterword] The expression <with an afterword by \prm{name}>.
\end{keymarglist}
\paragraph{Supplementary Material}
\label{aut:lng:key:mat}
\begin{keymarglist}
\item[commentary] The term <commentary>.
\item[annotations] The term <annotations>.
\item[introduction] The term <introduction>.
\item[foreword] The term <foreword>.
\item[afterword] The term <afterword>.
\end{keymarglist}
\paragraph{Publication Details}
\label{aut:lng:key:pdt}
\begin{keymarglist}
\item[volume] The term <volume>, referring to a book.
\item[volumes] The plural form of \texttt{volume}.
\item[involumes] The term <in>, as used in expressions like <in \prm{number of volumes} volumes>.
\item[jourvol] The term <volume>, referring to a journal.
\item[jourser] The term <series>, referring to a journal.
\item[book] The term <book>, referring to a document division.
\item[part] The term <part>, referring to a part of a book or a periodical.
\item[issue] The term <issue>, referring to a periodical.
\item[newseries] The expression <new series>, referring to a journal.
\item[oldseries] The expression <old series>, referring to a journal.
\item[edition] The term <edition>.
\item[in] The term <in>, referring to the title of a work published as part of another one, \eg\ <\prm{title of article} in \prm{title of journal}>.
\item[inseries] The term <in>, as used in expressions like <volume \prm{number} in \prm{name of series}>.
\item[ofseries] The term <of>, as used in expressions like <volume \prm{number} of \prm{name of series}>.
\item[number] The term <number>, referring to an issue of a journal.
\item[chapter] The term <chapter>, referring to a chapter in a book.
\item[version] The term <version>, referring to a revision number.
\item[reprint] The term <reprint>.
\item[reprintof] The expression <reprint of \prm{title}>.
\item[reprintas] The expression <reprinted as \prm{title}>.
\item[reprintfrom] The expression <reprinted from \prm{title}>.
\item[translationof] The expression <translation of \prm{title}>.
\item[translationas] The expression <translated as \prm{title}>.
\item[translationfrom] The expression <translated from [the] \prm{language}>.
\item[reviewof] The expression <review of \prm{title}>.
\item[origpubas] The expression <originally published as \prm{title}>.
\item[origpubin] The expression <originally published in \prm{year}>.
\item[astitle] The term <as>, as used in expressions like <published by \prm{publisher} as \prm{title}>.
\item[bypublisher] The term <by>, as used in expressions like <published by \prm{publisher}>.
\end{keymarglist}
\paragraph{Publication State}
\label{aut:lng:key:pst}
\begin{keymarglist}
\item[inpreparation] The expression <in preparation> (the manuscript is being prepared for publication).
\item[submitted] The expression <submitted> (the manuscript has been submitted to a journal or conference).
\item[forthcoming] The expression <forthcoming> (the manuscript has been accepted by a press or journal).
\item[inpress] The expression <in press> (the manuscript is fully copyedited and out of the author's hands; it is in the final stages of the production process).
\item[prepublished] The expression <pre-published> (the manuscript is published in a preliminary form or location, such as online version in advance of print publication).
\end{keymarglist}
\paragraph{Pagination}
\label{aut:lng:key:pag}
\begin{keymarglist}
\item[page] The term <page>.
\item[pages] The plural form of \texttt{page}.
\item[column] The term <column>, referring to a column on a page.
\item[columns] The plural form of \texttt{column}.
\item[section] The term <section>, referring to a document division (usually abbreviated as \S).
\item[sections] The plural form of \texttt{section} (usually abbreviated as \S\S).
\item[paragraph] The term <paragraph> (\ie a block of text, not to be confused with \texttt{section}).
\item[paragraphs] The plural form of \texttt{paragraph}.
\item[verse] The term <verse> as used when referring to a work which is cited by verse numbers.
\item[verses] The plural form of \texttt{verse}.
\item[line] The term <line> as used when referring to a work which is cited by line numbers.
\item[lines] The plural form of \texttt{line}.
\item[pagetotal] The term <page> as used in \cmd{mkpageprefix}.
\item[pagetotals] The plural form of \texttt{pagetotal}.
\item[columntotal] The term <column>, referring to a column on a page, as used in \cmd{mkpageprefix}.
\item[columntotals] The plural form of \texttt{columntotal}.
\item[sectiontotal] The term <section>, referring to a document division (usually abbreviated as \S), as used in \cmd{mkpageprefix}.
\item[sectiontotals] The plural form of \texttt{sectiontotal} (usually abbreviated as \S\S).
\item[paragraphtotal] The term <paragraph> (\ie a block of text, not to be confused with \texttt{section}) as used in \cmd{mkpageprefix}.
\item[paragraphtotals] The plural form of \texttt{paragraphtotal}.
\item[versetotal] The term <verse> as used when referring to a work which is cited by verse numbers when used in \cmd{mkpageprefix}.
\item[versetotals] The plural form of \texttt{versetotal}.
\item[linetotal] The term <line> as used when referring to a work which is cited by line numbers when used in \cmd{mkpageprefix}.
\item[linetotals] The plural form of \texttt{linetotal}.
\end{keymarglist}
\paragraph{Types}
\label{aut:lng:key:typ}
The following keys are typically used in the \bibfield{type} field of \bibtype{thesis}, \bibtype{report}, \bibtype{misc}, and other entries:
\begin{keymarglist}
\item[bathesis] An expression equivalent to the term <Bachelor's thesis>.
\item[mathesis] An expression equivalent to the term <Master's thesis>.
\item[phdthesis] The term <PhD thesis>, <PhD dissertation>, <doctoral thesis>, etc.
\item[candthesis] An expression equivalent to the term <Candidate thesis>. Used for <Candidate> degrees that have no clear equivalent to the Master's or doctoral level.
\item[techreport] The term <technical report>.
\item[resreport] The term <research report>.
\item[software] The term <computer software>.
\item[datacd] The term <data \textsc{cd}> or <\textsc{cd-rom}>.
\item[audiocd] The term <audio \textsc{cd}>.
\end{keymarglist}
\paragraph{Miscellaneous}
\label{aut:lng:key:msc}
\begin{keymarglist}
\item[nodate] The term to use in place of a date when there is no date for an entry \eg\ <n.d.>
\item[and] The term <and>, as used in a list of authors or editors, for example.
\item[andothers] The expression <and others> or <et alii>, used to mark the truncation of a name list.
\item[andmore] Like \texttt{andothers} but used to mark the truncation of a literal list.
\end{keymarglist}
\paragraph{Labels}
\label{aut:lng:key:lab}
The following strings are intended for use as labels, \eg\ <Address: \prm{url}> or <Abstract: \prm{abstract}>.
\begin{keymarglist}
\item[url] The term <address> in the sense of an internet address.
\item[urlfrom] An expression like <available from \prm{url}> or <available at \prm{url}>.
\item[urlseen] An expression like <accessed on \prm{date}>, <retrieved on \prm{date}>, <visited on \prm{date}>, referring to the access date of an online resource.
\item[file] The term <file>.
\item[library] The term <library>.
\item[abstract] The term <abstract>.
\item[annotation] The term <annotations>.
\end{keymarglist}
\paragraph{Citations}
\label{aut:lng:key:cit}
Traditional scholarly expressions used in citations:
\begin{keymarglist}
\item[idem] The term equivalent to the Latin <idem> (<the same [person]>).
\item[idemsf] The feminine singular form of \texttt{idem}.
\item[idemsm] The masculine singular form of \texttt{idem}.
\item[idemsn] The neuter singular form of \texttt{idem}.
\item[idempf] The feminine plural form of \texttt{idem}.
\item[idempm] The masculine plural form of \texttt{idem}.
\item[idempn] The neuter plural form of \texttt{idem}.
\item[idempp] The plural form of \texttt{idem} suitable for a mixed gender list of names.
\item[ibidem] The term equivalent to the Latin <ibidem> (<in the same place>).
\item[opcit] The term equivalent to the Latin term <opere citato> (<[in] the work [already] cited>).
\item[loccit] The term equivalent to the Latin term <loco citato> (<[at] the place [already] cited>).
\item[confer] The term equivalent to the Latin <confer> (<compare>).
\item[sequens] The term equivalent to the Latin <sequens> (<[and] the following [page]>), as used to indicate a range of two pages when only the starting page is provided (\eg\ <25\,sq.> or <25\,f.> instead of <25--26>).
\item[sequentes] The term equivalent to the Latin <sequentes> (<[and] the following [pages]>), as used to indicate an open"=ended range of pages when only the starting page is provided (\eg\ <25\,sqq.> or <25\,ff.>).
\item[passim] The term equivalent to the Latin <passim> (<throughout>, <here and there>, <scatteredly>).
\end{keymarglist}
%
Other expressions frequently used in citations:
\begin{keymarglist}
\item[see] The term <see>.
\item[seealso] The expression <see also>.
\item[seenote] An expression like <see note \prm{footnote}> or <as in \prm{footnote}>, used to refer to a previous footnote in a citation.
\item[backrefpage] An expression like <see page \prm{page}> or <cited on page \prm{page}>, used to introduce back references in the bibliography.
\item[backrefpages] The plural form of \texttt{backrefpage}, \eg\ <see pages \prm{pages}> or <cited on pages \prm{pages}>.
\item[quotedin] An expression like <quoted in \prm{citation}>, used when quoting a passage which was already a quotation in the cited work.
\item[citedas] An expression like <henceforth cited as \prm{shorthand}>, used to introduce a shorthand in a citation.
\item[thiscite] The expression used in some verbose citation styles to differentiate between the page range of the cited item (typically an article in a journal, collection, or conference proceedings) and the page number the citation refers to. For example: \enquote{Author, Title, in: Book, pp. 45--61, \texttt{thiscite} p. 52.}
\end{keymarglist}
\paragraph{Month Names}
\label{aut:lng:key:mon}
\begin{keymarglist}
\item[january] The name <January>.
\item[february] The name <February>.
\item[march] The name <March>.
\item[april] The name <April>.
\item[may] The name <May>.
\item[june] The name <June>.
\item[july] The name <July>.
\item[august] The name <August>.
\item[september] The name <September>.
\item[october] The name <October>.
\item[november] The name <November>.
\item[december] The name <December>.
\end{keymarglist}
\paragraph{Language Names}
\label{aut:lng:key:lng}
\begin{keymarglist}
\item[langamerican] The language <American> or <American English>.
\item[langbrazilian] The language <Brazilian> or <Brazilian Portuguese>.
\item[langbulgarian] The language <Bulgarian>.
\item[langcatalan] The language <Catalan>.
\item[langcroatian] The language <Croatian>.
\item[langczech] The language <Czech>.
\item[langdanish] The language <Danish>.
\item[langdutch] The language <Dutch>.
\item[langenglish] The language <English>.
\item[langestonian] The language <Estonian>.
\item[langfinnish] The language <Finnish>.
\item[langfrench] The language <French>.
\item[langgerman] The language <German>.
\item[langgreek] The language <Greek>.
\item[langhungarian] The language <Hungarian>.
\item[langitalian] The language <Italian>.
\item[langjapanese] The language <Japanese>.
\item[langlatin] The language <Latin>.
\item[langlatvian] The language <Latvian>.
\item[langlithuanian] The language <Lithuanian>.
\item[langnorwegian] The language <Norwegian>.
\item[langpolish] The language <Polish>.
\item[langportuguese] The language <Portuguese>.
\item[langrussian] The language <Russian>.
\item[langserbian] The language <Serbian>.
\item[langslovak] The language <Slovak>.
\item[langslovene] The language <Slovene>.
\item[langspanish] The language <Spanish>.
\item[langswedish] The language <Swedish>.
\item[langturkish] The language <Turkish>.
\item[langukrainian] The language <Ukrainian>.
\end{keymarglist}
%
The following strings are intended for use in phrases like <translated from [the] English by \prm{translator}>:
\begin{keymarglist}
\item[fromamerican] The expression <from [the] American> or <from [the] American English>.
\item[frombrazilian] The expression <from [the] Brazilian> or <from [the] Brazilian Portuguese>.
\item[frombulgarian] The expression <from [the] Bulgarian>.
\item[fromcatalan] The expression <from [the] Catalan>.
\item[fromcroatian] The expression <from [the] Croatian>.
\item[fromczech] The expression <from [the] Czech>.
\item[fromdanish] The expression <from [the] Danish>.
\item[fromdutch] The expression <from [the] Dutch>.
\item[fromenglish] The expression <from [the] English>.
\item[fromestonian] The expression <from [the] Estonian>.
\item[fromfinnish] The expression <from [the] Finnish>.
\item[fromfrench] The expression <from [the] French>.
\item[fromgerman] The expression <from [the] German>.
\item[fromgreek] The expression <from [the] Greek>.
\item[fromhungarian] The language <from [the] Hungarian>.
\item[fromitalian] The expression <from [the] Italian>.
\item[fromjapanese] The expression <from [the] Japanese>.
\item[fromlatin] The expression <from [the] Latin>.
\item[fromlatvian] The expression <from [the] Latvian>.
\item[fromlithuanian] The language <from [the] Lithuanian>.
\item[fromnorwegian] The expression <from [the] Norwegian>.
\item[frompolish] The expression <from [the] Polish>.
\item[fromportuguese] The expression <from [the] Portuguese>.
\item[fromrussian] The expression <from [the] Russian>.
\item[fromserbian] The expression <from [the] Serbian>.
\item[fromslovak] The expression <from [the] Slovak>.
\item[fromslovene] The expression <from [the] Slovene>.
\item[fromspanish] The expression <from [the] Spanish>.
\item[fromswedish] The expression <from [the] Swedish>.
\item[fromturkish] The expression <from [the] Turkish>.
\item[fromukrainian] The expression <from [the] Ukrainian>.
\end{keymarglist}
\paragraph{Country Names}
\label{aut:lng:key:cnt}
Country names are localised by using the string \texttt{country} plus the \acr{ISO}-3166 country code as the key. The short version of the translation should be the \acr{ISO}-3166 country code. Note that only a small number of country names is defined by default, mainly to illustrate this scheme. These keys are used in the \bibfield{location} list of \bibtype{patent} entries but they may be useful for other purposes as well.
\begin{keymarglist}
\item[countryde] The name <Germany>, abbreviated as \texttt{DE}.
\item[countryeu] The name <European Union>, abbreviated as \texttt{EU}.
\item[countryep] Similar to \opt{countryeu} but abbreviated as \texttt{EP}. This is intended for \bibfield{patent} entries.
\item[countryfr] The name <France>, abbreviated as \texttt{FR}.
\item[countryuk] The name <United Kingdom>, abbreviated (according to \acr{ISO}-3166) as \texttt{GB}.
\item[countryus] The name <United States of America>, abbreviated as \texttt{US}.
\end{keymarglist}
\paragraph{Patents and Patent Requests}
\label{aut:lng:key:pat}
Strings related to patents are localised by using the term \texttt{patent} plus the \acr{ISO}-3166 country code as the key. Note that only a small number of patent keys is defined by default, mainly to illustrate this scheme. These keys are used in the \bibfield{type} field of \bibtype{patent} entries.
\begin{keymarglist}
\item[patent] The generic term <patent>.
\item[patentde] The expression <German patent>.
\item[patenteu] The expression <European patent>.
\item[patentfr] The expression <French patent>.
\item[patentuk] The expression <British patent>.
\item[patentus] The expression <U.S. patent>.
\end{keymarglist}
%
Patent requests are handled in a similar way, using the string \texttt{patreq} as the base name of the key:
\begin{keymarglist}
\item[patreq] The generic term <patent request>.
\item[patreqde] The expression <German patent request>.
\item[patreqeu] The expression <European patent request>.
\item[patreqfr] The expression <French patent request>.
\item[patrequk] The expression <British patent request>.
\item[patrequs] The expression <U.S. patent request>.
\end{keymarglist}
\paragraph{Dates and Times}
\label{aut:lng:key:dt}
Abbreviation strings for standard eras. Both secular and Christian variants
are supported.
\begin{keymarglist}
\item[commonera] The era <CE>
\item[beforecommonera] The era <BCE>
\item[annodomini] The era <AD>
\item[beforechrist] The era <BC>
\end{keymarglist}
Abbreviation strings for <circa> dates:
\begin{keymarglist}
\item[circa] The string <circa>
\end{keymarglist}
Abbreviation strings for seasons parsed from \acr{ISO8601-2} Extended Format dates:
\begin{keymarglist}
\item[spring] The string <spring>
\item[summer] The string <summer>
\item[autumn] The string <autumn>
\item[winter] The string <winter>
\end{keymarglist}
Abbreviation strings for AM/PM:
\begin{keymarglist}
\item[am] The string <AM>
\item[pm] The string <PM>
\end{keymarglist}
\subsection{Formatting Commands}
\label{aut:fmt}
This section corresponds to \secref{use:fmt} in the user part of this manual. Bibliography and citation styles should incorporate the commands and facilities discussed in this section in order to provide a certain degree of high"=level configurability. Users should not be forced to write new styles if all they want to do is modify the spacing in the bibliography or the punctuation used in citations.
\subsubsection{User-definable Commands and Hooks}
\label{aut:fmt:fmt}
This section corresponds to \secref{use:fmt:fmt} in the user part of the manual. The commands and hooks discussed here are meant to be redefined by users, but bibliography and citation styles may provide a default definition which is different from the package default. These commands are defined in \path{biblatex.def}. Note that all commands starting with \cmd{mk\dots} take one mandatory argument.
\begin{ltxsyntax}
\csitem{bibsetup}
Arbitrary code to be executed at the beginning of the bibliography, intended for commands which affect the layout of the bibliography.
\csitem{bibfont}
Arbitrary code setting the font used in the bibliography. This is very similar to \cmd{bibsetup} but intended for switching fonts.
\csitem{citesetup}
Arbitrary code to be executed at the beginning of each citation command.
\csitem{newblockpunct}
The separator inserted between <blocks> in the sense explained in \secref{aut:pct:new}. The default definition is controlled by the package option \opt{block} (see \secref{use:opt:pre:gen}).
\csitem{newunitpunct}
The separator inserted between <units> in the sense explained in \secref{aut:pct:new}. This will usually be a period or a comma plus an interword space. The default definition is a period and a space.
\csitem{finentrypunct}
The punctuation printed at the very end of every bibliography entry, usually a period. The default definition is a period.
\csitem{entrysetpunct}
The punctuation printed between bibliography subentries of an entry set. The default definition is a semicolon and a space.
\csitem{bibnamedelima}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend after the first name element if the element is less than three characters long and before the last element. The default definition is \cmd{addhighpenspace}, \ie a space penalized by the value of the \cnt{highnamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimb}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend between all name elements where \cmd{bibnamedelima} does not apply. The default definition is \cmd{addlowpenspace}, \ie a space penalized by the value of the \cnt{lownamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimc}
This delimiter controls the spacing between name parts. The default name formats use it between the name prefix and the family name if \kvopt{useprefix}{true}. The default definition is \cmd{addhighpenspace}, \ie a space penalized by the value of the \cnt{highnamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimd}
This delimiter controls the spacing between name parts. The default name formats use it between all name parts where \cmd{bibnamedelimc} does not apply. The default definition is \cmd{addlowpenspace}, \ie a space penalized by the value of the \cnt{lownamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimi}
This delimiter replaces \cmd{bibnamedelima/b} after initials. Note that this only applies to initials given as such in the \file{bib} file, not to the initials automatically generated by \biblatex which use their own set of delimiters.
\csitem{bibinitperiod}
The punctuation inserted automatically by the backend after all initials unless \cmd{bibinithyphendelim} applies. The default definition is a period (\cmd{adddot}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibinitdelim}
The spacing inserted automatically by the backend between multiple initials unless \cmd{bibinithyphendelim} applies. The default definition is an unbreakable interword space. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibinithyphendelim}
The punctuation inserted automatically by the backend between the initials of hyphenated name parts, replacing \cmd{bibinitperiod} and \cmd{bibinitdelim}. The default definition is a period followed by an unbreakable hyphen. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibindexnamedelima}
Replaces \cmd{bibnamedelima} in the index.
\csitem{bibindexnamedelimb}
Replaces \cmd{bibnamedelimb} in the index.
\csitem{bibindexnamedelimc}
Replaces \cmd{bibnamedelimc} in the index.
\csitem{bibindexnamedelimd}
Replaces \cmd{bibnamedelimd} in the index.
\csitem{bibindexnamedelimi}
Replaces \cmd{bibnamedelimi} in the index.
\csitem{bibindexinitperiod}
Replaces \cmd{bibinitperiod} in the index.
\csitem{bibindexinitdelim}
Replaces \cmd{bibinitdelim} in the index.
\csitem{bibindexinithyphendelim}
Replaces \cmd{bibinithyphendelim} in the index.
\csitem{revsdnamepunct}
The punctuation to be printed between the given and family name parts when a name is reversed. The default is a comma. This command should be incorporated in formatting directives for name lists. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedash}
The dash to be used as a replacement for recurrent authors or editors in the bibliography. The default is an <em> or an <en> dash, depending on the indentation of the list of references.
\csitem{labelnamepunct}\DeprecatedMark
A separator to be printed after the name used for alphabetizing in the bibliography (\bibfield{author} or \bibfield{editor}, if the \bibfield{author} field is undefined) instead of \cmd{newunitpunct}. The default is \cmd{newunitpunct}, \ie it is not handled differently from regular unit punctuation but permits convenient reconfiguration. This punctuation command is deprecated and has been superseded by the context-sensitive \cmd{nametitledelim} (see \secref{use:fmt:csd}). For backwards compatibility reasons, however, \cmd{nametitledelim} still defaults to \cmd{labelnamepunct} in the \texttt{bib} and \texttt{biblist} contexts. Style authors may want to consider replacing \cmd{labelnampunct} with \texttt{\textbackslash printdelim\{nametitledelim\}} and users may want to prefer modifying the context-sensitive \texttt{nametitledelim} with \cmd{DeclareDelimFormat} over redefining \cmd{labelnamepunct}.
\csitem{subtitlepunct}
The separator to be printed between the fields \bibfield{title} and \bibfield{subtitle}, \bibfield{booktitle} and \bibfield{booksubtitle}, as well as \bibfield{maintitle} and \bibfield{mainsubtitle}. Use this separator instead of \cmd{newunitpunct} at this location. The default is \cmd{newunitpunct}, \ie it is not handled differently from regular unit punctuation but permits convenient reconfiguration.
\csitem{intitlepunct}
The separator to be printed between the word «in» and the following title in entry types such as \bibtype{article}, \bibtype{inbook}, \bibtype{incollection}, etc. Use this separator instead of \cmd{newunitpunct} at this location. The default definition is a colon plus an interword space.
\csitem{bibpagespunct}
The separator to be printed before the \bibfield{pages} field. Use this separator instead of \cmd{newunitpunct} at this location. The default is a comma plus an interword space.
\csitem{bibpagerefpunct}
The separator to be printed before the \bibfield{pageref} field. Use this separator instead of \cmd{newunitpunct} at this location. The default is an interword space.
\csitem{bibeidpunct}
The separator printed before the \bibfield{eid} field (similar to \cmd{bibpagespunct}). The default is a comma plus an interword space.
\csitem{multinamedelim}\CSdelimMark
The delimiter to be printed between multiple items in a name list like \bibfield{author} or \bibfield{editor} if there are more than two names in the list. If there are only two names in the list, use the \cmd{finalnamedelim} instead. This command should be incorporated in all formatting directives for name lists. The default is a comma followed by an interword space.
\csitem{finalnamedelim}\CSdelimMark
Use this command instead of \cmd{multinamedelim} before the final name in a name list. The default is the localised term <and>, separated by interword spaces.
\csitem{revsdnamedelim}\CSdelimMark
The extra delimiter to be printed after the first name in a name list consisting of two names (in addition to \cmd{finalnamedelim}) if the first name is reversed. This command should be incorporated in all formatting directives for name lists.
\csitem{andothersdelim}\CSdelimMark
The delimiter to be printed before the localisation string <\texttt{andothers}> if a name list like \bibfield{author} or \bibfield{editor} is truncated. This command should be incorporated in all formatting directives for name lists. The default is an interword space.
\csitem{multilistdelim}\CSdelimMark
The delimiter to be printed between multiple items in a literal list like \bibfield{publisher} or \bibfield{location} if there are more than two names in the list. If there are only two items in the list, use the \cmd{finallistdelim} instead. This command should be incorporated in all formatting directives for literal lists. The default is a comma plus an interword space.
\csitem{finallistdelim}\CSdelimMark
Use this command instead of \cmd{multilistdelim} before the final item in a literal list. The default is the localised term <and>, separated by interword spaces.
\csitem{andmoredelim}\CSdelimMark
The delimiter to be printed before the localisation string <\texttt{andmore}> if a literal list like \bibfield{publisher} or \bibfield{location} is truncated. This command should be incorporated in all formatting directives for literal lists. The default is an interword space.
\csitem{multicitedelim}
The delimiter printed between citations if multiple entry keys are passed to a single citation command. This command should be incorporated in the definition of all citation commands, for example in the \prm{sepcode} argument passed to \cmd{DeclareCiteCommand}. See \secref{aut:cbx:cbx} for details. The default is a semicolon plus an interword space.
\csitem{multiciterangedelim}
The delimiter printed between two citations if they are compressed to a range. The default is \cmd{bibrangedash}.
\csitem{multicitesubentrydelim}
The delimiter printed between subentry citations of the same set. This delimiter is only used in citation styles that reduce citations of the same set to a more compact form (\opt{subentry} of \texttt{numeric-comp}). The default is a comma.
\csitem{multicitesubentryrangedelim}
The delimiter printed between two citations of the same set if they are compressed to a range. The default is \cmd{multiciterangedelim}.
\csitem{supercitedelim}
Similar to \cmd{multinamedelim}, but intended for the \cmd{supercite} command only. The default is a comma.
\csitem{superciterangedelim}
Analogue of \cmd{multiciterangedelim} for \cmd{supercite}. The default is \cmd{bibrangedash}.
\csitem{supercitesubentrydelim}
Analogue of \cmd{multicitesubentrydelim} for \cmd{supercite}. The default is \cmd{supercitedelim}.
\csitem{supercitesubentryrangedelim}
Analogue of \cmd{multicitesubentryrangedelim} for \cmd{supercite}. The default is \cmd{superciterangedelim}.
\csitem{compcitedelim}
Similar to \cmd{multicitedelim}, but intended for citation styles that <compress> multiple citations, \ie print the author only once if subsequent citations share the same author etc. The default definition is a comma plus an interword space.
\csitem{textcitedelim}
Similar to \cmd{multicitedelim}, but intended for \cmd{textcite} and related commands (\secref{use:cit:cbx}). The default is a comma plus an interword space. The standard styles modify this provisional definition to ensure that the delimiter before the final citation is the localised term <and>, separated by interword spaces.
\csitem{nametitledelim}\CSdelimMark
The delimiter to be printed between the author\slash editor and the title. This command should be incorporated in the definition of all citation commands of author-title and some verbose citation styles and in the bibliography drivers---in author-year bibliographies \cs{nametitledelim} may be printed between the author\slash editor-year block and the title. The default definition inside bibliographies is the now deprecated \cmd{labelnamepunct} (for backwrds compatibility reasons) and is a comma plus an interword space otherwise.
\csitem{nameyeardelim}\CSdelimMark
The delimiter to be printed between the author\slash editor and the year. This command should be incorporated in the definition of all citation commands of author-year citation styles and in the bibliography drivers. The default definition is an interword space.
\csitem{namelabeldelim}\CSdelimMark
The delimiter printed between the name\slash title and the label. This command should be incorporated in the definition of all citation commands of alphabetic and numeric citation styles. The default definition is an interword space.
\csitem{nonameyeardelim}\CSdelimMark
The delimiter printed between the substitute for the labelname when it does not exist (usually the label or title in standard styles) and the year citation styles and the bibliography drivers. This command should be incorporated in the definition of all citation commands of author-year citation styles and in the bibliography drivers. The default definition is an interword space.
\csitem{authortypedelim}\CSdelimMark
The delimiter printed between the author and the \texttt{authortype}. The default is a comma followed by a space.
\csitem{editortypedelim}\CSdelimMark
The delimiter printed between the editor and the \texttt{editor} or \texttt{editortype} string. The default is a comma followed by a space.
\csitem{translatortypedelim}\CSdelimMark
The delimiter printed between the translator and the \texttt{translator} string. The default is a comma followed by a space.
\csitem{labelalphaothers}
A string to be appended to the non"=numeric portion of the \bibfield{labelalpha} field (\ie the field holding the citation label used by alphabetic citation styles) if the number of authors\slash editors exceeds the \opt{maxalphanames} threshold or the \bibfield{author}\slash \bibfield{editor} list was truncated in the \file{bib} file with the keyword <\texttt{and others}>. This will typically be a single character such as a plus sign or an asterisk. The default is a plus sign. This command may also be redefined to an empty string to disable this feature. In any case, it must be redefined in the preamble.
\csitem{sortalphaothers}
Similar to \cmd{labelalphaothers} but used in the sorting process. Setting it to a different value is advisable if the latter contains formatting commands. If \cmd{sortalphaothers} is not redefined, it defaults to \cmd{labelalphaothers}.
\csitem{volcitedelim}
The delimiter to be printed between the volume portion and the page/text portion of \cmd{volcite} and related commands (\secref{use:cit:spc}).
\csitem{prenotedelim}\CSdelimMark
The delimiter to be printed after the \prm{prenote} argument of a citation command. The default is an interword space.
\csitem{postnotedelim}\CSdelimMark
The delimiter to be printed before the \prm{postnote} argument of a citation command. The default is a comma plus an interword space.
\csitem{extpostnotedelim}\CSdelimMark
The delimiter printed between the citation and the parenthetical \prm{postnote} argument of a citation command when the postnote occurs outside of the citation parentheses. In the standard styles, this occurs when the citation uses the shorthand field of the entry. The default is an interword space.
\csitem{multiprenotedelim}\CSdelimMark
The delimiter to be printed after the \prm{multiprenote} argument of a citation command.
\csitem{multipostnotedelim}\CSdelimMark
The delimiter to be printed before the \prm{multipostnote} argument of a citation command.
\cmditem{mkbibname<namepart>}{text}
Formatting hook for the name part <namepart>, to be used in all formatting directives for name lists. The default datamodel defines the name parts <family>, <given>, <prefix> and <suffix> and therefore the following macros are automatically defined:
\begin{ltxexample}
\mkbibnamefamily
\mkbibnamegiven
\mkbibnameprefix
\mkbibnamesuffix
\end{ltxexample}
\cmditem{mkbibcompletename<formatorder>}{text}
Formatting hook for the complete name in format order <formatorder>. The default styles use the name format orders <family>, <family-given> and <given-family>, therefore the following macros are automatically defined:
\begin{ltxexample}
\mkbibcompletenamefamily
\mkbibcompletenamefamilygiven
\mkbibcompletenamegivenfamily
\end{ltxexample}
%
These formatting hooks should enclose the complete name in the bibliography macro \cmd{name:<formatorder>}. Initially all hooks expand to \cmd{mkbibcompletename}.
\cmditem{mkbibcompletename}{text}
The initial value of all default formatting hooks \cmd{mkbibcompletename<formatorder>}.
\csitem{datecircadelim}\CSdelimMark
When formatting dates with the global option \opt{datecirca} enabled, the delimiter printed after any localised <circa> term. Defaults to interword space.
\csitem{dateeradelim}\CSdelimMark
When formatting dates with the global option \opt{dateera} set, the delimiter printed before the localisation era term. Defaults to interword space.
\csitem{dateuncertainprint}
Prints date uncertainty information when the global option \opt{dateuncertain} is enabled and the \cmd{ifdateuncertain} test is true. By default, prints the language specific \cmd{bibdateuncertain} string (\secref{use:fmt:lng}).
\csitem{enddateuncertainprint}
Prints date uncertainty information when the global option \opt{dateuncertain} is enabled and the \cmd{ifenddateuncertain} test is true. By default, prints the language specific \cmd{bibdateuncertain} string (\secref{use:fmt:lng}).
\csitem{datecircaprint}
Prints date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifdatecirca} test is true. By default, prints the <circa> localised term (\secref{aut:lng:key:dt}) and the \opt{datecircadelim} delimiter.
\csitem{enddatecircaprint}
Prints date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifenddatecirca} test is true. By default, prints the <circa> localised term (\secref{aut:lng:key:dt}) and the \opt{datecircadelim} delimiter.
\csitem{datecircaprintiso}
Prints \acr{ISO8601-2} format date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifdatecirca} test is true. Prints \cmd{textasciitilde}.
\csitem{enddatecircaprintiso}
Prints \acr{ISO8601-2} format date circa information when the global option \opt{datecirca} is enabled and the \cmd{ifenddatecirca} test is true. Prints \cmd{textasciitilde}.
\csitem{dateeraprint}{yearfield}
Prints date era information when the global option \opt{dateera} is set to <secular> or <christian>. By default, prints the \opt{dateeradelim} delimiter and the appropriate localised era term (\secref{aut:lng:key:dt}). If the \opt{dateeraauto} option is set, then the passed \prm{yearfield} (which is the name of a year field such as <year>, <origyear>, <endeventyear> etc.) is tested to see if its value is earlier than the \opt{dateeraauto} threshold and if so, then the BCE/CE localisation will be output too. The default setting for \opt{dateeraauto} is 0 and so only BCE/BC localisation strings are candidates for output. Detects whether the start or end year era information is to be printed by looking at the \prm{yearfield} name passed to it.
\csitem{dateeraprintpre}
Prints date era information when the global option \opt{dateera} is set to <astronomical>. By default, prints \opt{bibdataeraprefix}. Detects whether the start or end year era information is to be printed by looking at the \prm{yearfield} name passed to it.
\csitem{relatedpunct}
The separator between the \bibfield{relatedtype} bibliography localisation string and the data from the first related entry.
\csitem{relateddelim}
The generic separator between the data of multiple related entries. The default definition is an optional dot plus linebreak.
\csitem{relateddelim$<$relatedtype$>$}
The separator between the data of multiple related entries inside related entries of type <relatedtype>. There is no default, if such a type-specific delimiter does not exist, \cmd{relateddelim} is used.
\csitem{begrelateddelim}
The generic separator before the block of related entries. The default definition is \cmd{newunitpunct}.
\csitem{begrelateddelim$<$relatedtype$>$}
The separator between the block of related entries of type <relatedtype>. There is no default, if such a type-specific delimiter does not exist, \cmd{relateddelim} is used.
\end{ltxsyntax}
\subsubsection{Language-specific Commands}
\label{aut:fmt:lng}
This section corresponds to \secref{use:fmt:lng} in the user part of the manual. The commands discussed here are usually handled by the localisation modules, but may also be redefined by users on a per"=language basis. Note that all commands starting with \cmd{mk\dots} take one or more mandatory arguments.
\begin{ltxsyntax}
\csitem{bibrangedash}
The language specific dash to be used for ranges of numbers. Defaults to \cmd{textendash}.
\csitem{bibrangessep}
The language specific separator to be used between multiple ranges. Defaults to a comma followed by a space.
\csitem{bibdatesep}
The language specific separator used between date components in terse date formats. Defaults to \cmd{hyphen}.
\csitem{bibdaterangesep}
The language specific separator to be used for date ranges. Defaults to \cmd{textendash} for all date formats apart from \opt{ymd} which defaults to a \cmd{slash}. The date format option \opt{iso} is hard-coded to \cmd{slash} since this is a standards compliant format.
\csitem{mkbibdatelong}
Takes the names of three field as arguments which correspond to three date components (in the order year\slash month\slash day) and uses their values to print the date in the language specific long date format.
\csitem{mkbibdateshort}
Similar to \cmd{mkbibdatelong} but using the language specific short date format.
\csitem{mkbibtimezone}
Modifies a timezone string passed in as the only argument. By default this changes <Z> to the value of \cmd{bibtimezone}.
\csitem{bibdateuncertain}
The language specific marker to be used after uncertain dates when the global option \opt{dateuncertain} is enabled. Defaults to a space followed by a question mark.
\csitem{bibdateeraprefix}
The language specific marker which is printed as a prefix to beginning BCE/BC dates in a date range when the option \opt{dateera} is set to <astronomical>. Defaults to \cmd{textminus}, if defined and \cmd{textendash} otherwise.
\csitem{bibdateeraendprefix}
The language specific marker which is printed as a prefix to end BCE/BC dates in a date range when the option \opt{dateera} is set to <astronomical>. Defaults to a thin space followed by \cmd{bibdateeraprefix} when \cmd{bibdaterangesep} is set to a dash and to \cmd{bibdateeraprefix} otherwise. This is a separate macro so that you may add extra space before a negative date marker which, for example follows a dash date range marker as this can look a little odd.
\csitem{bibtimesep}
The language specific marker which separates time components. Default to a colon.
\csitem{bibutctimezone}
The language specific string printed for the UTC timezone. Defaults to <Z>.
\csitem{bibtimezonesep}
The language specific marker which separates an optional time zone component from a time. Empty by default.
\csitem{bibtzminsep}
The language specific marker which separates hour and minute component of offset timezones. Defaults to a \cmd{bibtimesep}.
\csitem{bibdatetimesep}
The language specific separator printed between date and time components when printing time components along with date components (see the \opt{$<$datetype$>$dateusetime} option in \secref{use:opt:pre:gen}). Defaults to a space for non-\acr{ISO8601-2} output formats, and 'T' for \acr{ISO8601-2} output format.
\csitem{finalandcomma}
Prints the comma to be inserted before the final <and> in an enumeration, if applicable in the respective language.
\csitem{finalandsemicolon}
Prints the semicolon to be inserted before the final <and> in an enumeration, if applicable in the respective language.
\cmditem{mkbibordinal}{integer}
Takes an integer argument and prints it as an ordinal number.
\cmditem{mkbibmascord}{integer}
Similar to \cmd{mkbibordinal}, but prints a masculine ordinal, if applicable in the respective language.
\cmditem{mkbibfemord}{integer}
Similar to \cmd{mkbibordinal}, but prints a feminine ordinal, if applicable in the respective language.
\cmditem{mkbibneutord}{integer}
Similar to \cmd{mkbibordinal}, but prints a neuter ordinal, if applicable in the respective language.
\cmditem{mkbibordedition}{integer}
Similar to \cmd{mkbibordinal}, but intended for use with the term <edition>.
\cmditem{mkbibordseries}{integer}
Similar to \cmd{mkbibordinal}, but intended for use with the term <series>.
\end{ltxsyntax}
\subsubsection{User-definable Lengths and Counters}
\label{aut:fmt:len}
This section corresponds to \secref{use:fmt:len} in the user part of the manual. The length registers and counters discussed here are meant to be altered by users. Bibliography and citation styles should incorporate them where applicable and may also provide a default setting which is different from the package default.
\begin{ltxsyntax}
\lenitem{bibhang}
The hanging indentation of the bibliography, if applicable. This length is initialized to \cmd{parindent} at load-time. If \cmd{parindent} is zero length for some reason, \cmd{bibhang} will default to \texttt{1em}.
\lenitem{biblabelsep}
The horizontal space between entries and their corresponding labels. Bibliography styles which use \env{list} environments and print a label should set \len{labelsep} to \len{biblabelsep} in the definition of the respective environment. This length is initialized to twice the value of \cmd{labelsep} at load-time.
\lenitem{bibitemsep}
The vertical space between the individual entries in the bibliography. Bibliography styles using \env{list} environments should set \len{itemsep} to \len{bibitemsep} in the definition of the respective environment. This length is initialized to \cmd{itemsep} at load-time.
\lenitem{bibnamesep}
Vertical space to be inserted between two entries in the bibliography whenever an entry starts with a name which is different from the initial name of the previous entry. The default value is zero. Setting this length to a positive value greater than \len{bibitemsep} will group the bibliography by author\slash editor name. Note that \len{bibitemsep}, \len{bibnamesep}, and \len{bibinitsep} obey the rules for \cmd{addvspace}, that is, when vertical space introduced by any of these commands immediately follows on from space introduced by another of them, the resulting total space is equal to the largest of them.
\lenitem{bibinitsep}
Vertical space to be inserted between two entries in the bibliography whenever an entry starts with a letter which is different from the initial letter of the previous entry. The default value is zero. Setting this length to a positive value greater than \len{bibitemsep} will group the bibliography alphabetically. Note that \len{bibitemsep}, \len{bibnamesep}, and \len{bibinitsep} obey the rules for \cmd{addvspace}, that is, when vertical space introduced by any of these commands immediately follows on from space introduced by another of them, the resulting total space is equal to the largest of them.
\lenitem{bibparsep}
The vertical space between paragraphs within an entry in the bibliography. Bibliography styles using \env{list} environments should set \len{parsep} to \len{bibparsep} in the definition of the respective environment. The default value is zero.
\cntitem{abbrvpenalty}
The penalty used by \cmd{addabbrvspace}, \cmd{addabthinspace}, and \cmd{adddotspace}, see \secref{aut:pct:spc} for details. This counter is initialized to \cmd{hyphenpenalty} at load-time.
\cntitem{highnamepenalty}
The penalty used by \cmd{addhighpenspace} and \cmd{addhpthinspace}, see \secref{aut:pct:spc} for details. The counter is initialized to \cmd{hyphenpenalty} at load-time.
\cntitem{lownamepenalty}
The penalty used by \cmd{addlowpenspace} and \cmd{addlpthinspace}, see \secref{aut:pct:spc} for details. The counter is initialized to half the \cmd{hyphenpenalty} at load-time.
\cntitem{biburlbigbreakpenalty}
The \sty{biblatex} version of \sty{url}'s \len{UrlBigBreakPenalty}. The default value is \texttt{100}.
\cntitem{biburlbreakpenalty}
The \sty{biblatex} version of \sty{url}'s \len{UrlBreakPenalty}. The default value is \texttt{200}.
\cntitem{biburlnumpenalty}
If this counter is set to a value greater than zero, \biblatex will permit linebreaks after numbers in all strings formatted with the \cmd{url} command from the \sty{url} package. This will affect \acr{url}s and \acr{doi}s in the bibliography. The breakpoints will be penalized by the value of this counter. If \acr{url}s and/or \acr{doi}s in the bibliography run into the margin, try setting this counter to a value greater than zero but less than 10000 (you normally want to use a high value like 9000). Setting the counter to zero disables this feature. This is the default setting.
\cntitem{biburlucpenalty}
Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all uppercase letters.
\cntitem{biburllcpenalty}
Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all lowercase letters.
\lenitem{biburlbigskip}
The \sty{biblatex} version of \len{Urlmuskip}. This length holds the additional (stretchable) space inserted around breakable characters in the \cmd{url} command from the \sty{url} package. The default value is \texttt{0mu plus 3mu}.
\lenitem{biburlnumskip}
The additional space inserted after numbers in strings formatted with the \cmd{url} command from the \sty{url} package. This will affect \acr{url}s and \acr{doi}s in the bibliography. If \acr{url}s and/or \acr{doi}s in the bibliography run into the margin, it may help to set this length to add some small stretchable space, for example \texttt{0mu plus 1mu}. The default setting is \texttt{0mu}. This value is only used if \cnt{biburlnumpenalty} is set to a value different from zero.
\lenitem{biburlucskip}
Similar to \cnt{biburlnumskip}, except that it will add space after all uppercase letters.
\lenitem{biburllcskip}
Similar to \cnt{biburlnumskip}, except that it will add space after all uppercase letters.
\end{ltxsyntax}
\subsubsection{Auxiliary Commands and Hooks}
\label{aut:fmt:ich}
The auxiliary commands and facilities in this section serve a special purpose. Some of them are used by \biblatex to communicate with bibliography and citation styles in some way or other.
\begin{ltxsyntax}
\cmditem{mkbibemph}{text}
A generic command which prints its argument as emphasized text. This is a simple wrapper around the standard \cmd{emph} command. Apart from that, it uses \cmd{setpunctfont} from \secref{aut:pct:new} to adapt the font of the next punctuation mark following the text set in italics. If the \opt{punctfont} package option is disabled, this command behaves like \cmd{emph}.
\cmditem{mkbibitalic}{text}
Similar in concept to \cmd{mkbibemph} but prints italicized text. This is a simple wrapper around the standard \cmd{textit} command which incorporates \cmd{setpunctfont}. If the \opt{punctfont} package option is disabled, this command behaves like \cmd{textit}.
\cmditem{mkbibbold}{text}
Similar in concept to \cmd{mkbibemph} but prints bold text. This is a simple wrapper around the standard \cmd{textbf} command which incorporates \cmd{setpunctfont}. If the \opt{punctfont} package option is disabled, this command behaves like \cmd{textbf}.
\cmditem{mkbibquote}{text}
A generic command which wraps its argument in quotation marks. If the \sty{csquotes} package is loaded, this command uses the language sensitive quotation marks provided by that package. \cmd{mkbibquote} also supports <American-style> punctuation, see \cmd{DeclareQuotePunctuation} in \secref{aut:pct:cfg} for details.
\cmditem{mkbibparens}{text}
A generic command which wraps its argument in parentheses. This command is nestable. When nested, it will alternate between parentheses and brackets, depending on the nesting level.
\cmditem{mkbibbrackets}{text}
A generic command which wraps its argument in square brackets. This command is nestable. When nested, it will alternate between brackets and parentheses, depending on the nesting level.
\cmditem{bibopenparen}<text>|{\ltxsyntaxlabelfont\cmd{bibcloseparen}}|
Alternative syntax for \cmd{mkbibparens}. This will also work across groups. Note that \cmd{bibopenparen} and \cmd{bibcloseparen} must always be balanced.
\cmditem{bibopenbracket}<text>|{\ltxsyntaxlabelfont\cmd{bibclosebracket}}|
Alternative syntax for \cmd{mkbibbrackets}. This will also work across groups. Note that \cmd{bibopenbracket} and \cmd{bibclosebracket} must always be balanced.
\cmditem{mkbibfootnote}{text}
A generic command which prints its argument as a footnote. This is a wrapper around the standard \latex \cmd{footnote} command which removes spurious whitespace preceding the footnote mark and prevents nested footnotes. By default, \cmd{mkbibfootnote} requests capitalization at the beginning of the note and automatically adds a period at the end. You may change this behavior by redefining the \cmd{bibfootnotewrapper} macro introduced below.
\cmditem{mkbibfootnotetext}{text}
Similar to \cmd{mkbibfootnote} but uses the \cmd{footnotetext} command.
\cmditem{mkbibendnote}{text}
Similar in concept to \cmd{mkbibfootnote} except that it prints its argument as an endnote. \cmd{mkbibendnote} removes spurious whitespace preceding the endnote mark and prevents nested notes. It supports the \cmd{endnote} command provided by the \sty{endnotes} package as well as the \cmd{pagenote} command provided by the \sty{pagenote} package and the \sty{memoir} class. If both commands are available, \cmd{endnote} takes precedence. If no endnote support is available, \cmd{mkbibendnote} issues an error and falls back to \cmd{footnote}. By default, \cmd{mkbibendnote} requests capitalization at the beginning of the note and automatically adds a period at the end. You may change this behavior by redefining the \cmd{bibendnotewrapper} macro introduced below.
\cmditem{mkbibendnotetext}{text}
Similar to \cmd{mkbibendnote} but uses the \cmd{endnotetext} command. Please note that as of this writing, neither the \sty{pagenote} package nor the \sty{memoir} class provide a corresponding \cmd{pagenotetext} command. In this case, \cmd{mkbibendnote} will issue an error and fall back to \cmd{footnotetext}.
\cmditem{bibfootnotewrapper}{text}
An inner wrapper which encloses the \prm{text} argument of \cmd{mkbibfootnote} and \cmd{mkbibfootnotetext}. For example, \cmd{mkbibfootnote} eventually boils down to this:
\begin{ltxexample}
\footnote{<<\bibfootnotewrapper{>>text<<}>>}
\end{ltxexample}
%
The wrapper ensures capitalization at the beginning of the note and adds a period at the end. The default definition is:
\begin{ltxexample}
\newcommand{\bibfootnotewrapper}[1]{<<\bibsentence>> #1<<\addperiod>>}
\end{ltxexample}
%
If you don't want capitalization at the beginning or a period at the end of the note, do not modify \cmd{mkbibfootnote} but redefine \cmd{bibfootnotewrapper} instead.
\cmditem{bibendnotewrapper}{text}
Similar in concept to \cmd{bibfootnotewrapper} but related to the \cmd{mkbibendnote} and \cmd{mkbibendnotetext} commands.
\cmditem{mkbibsuperscript}{text}
A generic command which prints its argument as superscripted text. This is a simple wrapper around the standard \latex \cmd{textsuperscript} command which removes spurious whitespace and allows hyphenation of the preceding word.
\cmditem{mkbibmonth}{integer}
This command takes an integer argument and prints it as a month name. Even though the output of this command is language specific, its definition is not, hence it is normally not redefined in localisation modules.
\cmditem{mkbibseason}{string}
This command takes a season localisation string and prints the version of the string corresponding to the setting of the \opt{dateabbrev} package option. Even though the output of this command is language specific, its definition is not, hence it is normally not redefined in localisation modules.
\cmditem{mkyearzeros}{integer}
This command strips leading zeros from a year or enforces them, depending on the \opt{datezeros} package option (\secref{use:opt:pre:gen}). It is intended for use in the definition of date formatting macros. If zeros are enforced, this command calls \cmd{forcezerosy} and thus expands its argument with \cmd{protected@edef}.
\cmditem{mkmonthzeros}{integer}
This command strips leading zeros from a month or enforces them, depending on the \opt{datezeros} package option (\secref{use:opt:pre:gen}). It is intended for use in the definition of date formatting macros. If zeros are enforced, this command calls \cmd{forcezerosmdt} and thus expands its argument with \cmd{protected@edef}.
\cmditem{mkdayzeros}{integer}
This command strips leading zeros from a day or enforces them, depending on the \opt{datezeros} package option (\secref{use:opt:pre:gen}). It is intended for use in the definition of date formatting macros. If zeros are enforced, this command calls \cmd{forcezerosmdt} and thus expands its argument with \cmd{protected@edef}.
\cmditem{mktimezeros}{integer}
This command strips leading zeros from a number or preserves them, depending on the \opt{timezeros} package option (\secref{use:opt:pre:gen}). It is intended for use in the definition of time formatting macros. If zeros are enforced, this command calls \cmd{forcezerosmdt} and thus expands its argument with \cmd{protected@edef}.
\cmditem{forcezerosy}{integer}
This command adds zeros to a year (or any number supposed to be 4-digits). It is intended for date formatting and ordinals. The argument is expanded with \cmd{protected@edef} before it is processed.
\cmditem{forcezerosmdt}{integer}
This command adds zeros to a month, day or time part (or any number supposed to be 2-digits). It is intended for date/time formatting and ordinals. The argument is expanded with \cmd{protected@edef} before it is processed.
\cmditem{stripzeros}{integer}
This command strips leading zeros from a number. It is intended for date formatting and ordinals.
\optitem{$<$labelfield$>$width}
For every field marked as a <Label field> in the data model, a formatting directive is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
\optitem{labelnumberwidth}
Similar to \texttt{shorthandwidth}, but referring to the \bibfield{labelnumber} field and the length register \cmd{labelnumberwidth}. Numeric styles should adjust this directive such that it corresponds to the format used in the bibliography.
\optitem{labelalphawidth}
Similar to \texttt{shorthandwidth}, but referring to the \bibfield{labelalpha} field and the length register \cmd{labelalphawidth}. Alphabetic styles should adjust this directive such that it corresponds to the format used in the bibliography.
\optitem{bibhyperref}
A special formatting directive for use with \cmd{printfield} and \cmd{printtext}. This directive wraps its argument in a \cmd{bibhyperref} command, see \secref{aut:aux:msc} for details.
\optitem{bibhyperlink}
A special formatting directive for use with \cmd{printfield} and \cmd{printtext}. It wraps its argument in a \cmd{bibhyperlink} command, see \secref{aut:aux:msc} for details. The \prm{name} argument passed to \cmd{bibhyperlink} is the value of the \bibfield{entrykey} field.
\optitem{bibhypertarget}
A special formatting directive for use with \cmd{printfield} and \cmd{printtext}. It wraps its argument in a \cmd{bibhypertarget} command, see \secref{aut:aux:msc} for details. The \prm{name} argument passed to \cmd{bibhypertarget} is the value of the \bibfield{entrykey} field.
\optitem{volcitepages}
A special formatting directive which controls the format of the page\slash text portion in the argument of citation commands like \cmd{volcite}.
\optitem{volcitevolume}
A special formatting directive which controls the format of the volume portion in the argument of citation commands like \cmd{volcite}.
\optitem{date}
A special formatting directive which controls the format of \cmd{printdate} (\secref{aut:bib:dat}). Note that the date format (long/short etc.) is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. This formatting directive only controls additional formatting such as fonts etc.
\optitem{labeldate}
As \texttt{date} but controls the format of \cmd{printlabeldate}.
\optitem{$<$datetype$>$date}
As \texttt{date} but controls the format of \cmd{print$<$datetype$>$date}.
\optitem{time}
A special formatting directive which controls the format of \cmd{printtime} (\secref{aut:bib:dat}). Note that the time format (24h/12h etc.) is controlled by the package option \opt{time} from \secref{use:opt:pre:gen}. This formatting directive only controls additional formatting such as fonts etc.
\optitem{labeltime}
As \texttt{time} but controls the format of \cmd{printlabeltime}.
\optitem{$<$datetype$>$time}
As \texttt{time} but controls the format of \cmd{print$<$datetype$>$time}.
\end{ltxsyntax}
\subsubsection{Auxiliary Lengths, Counters, and Other Features}
\label{aut:fmt:ilc}
The length registers and counters discussed here are used by \biblatex to pass information to bibliography and citation styles. Think of them as read"=only registers. Note that all counters are \latex counters. Use |\value{counter}| to read out the current value.
\begin{ltxsyntax}
\lenitem{$<$labelfield$>$width}
For every field marked as a <label> field in the data model, a length register is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
\lenitem{labelnumberwidth}
This length register indicates the width of the widest \bibfield{labelnumber}. Numeric bibliography styles
should incorporate this length in the definition of the bibliography environment.
\lenitem{labelalphawidth}
This length register indicates the width of the widest \bibfield{labelalpha}. Alphabetic bibliography styles should incorporate this length in the definition of the bibliography environment.
\cntitem{maxextraalpha}
This counter holds the highest number found in any \bibfield{extraalpha} field.
\cntitem{maxextradate}
This counter holds the highest number found in any \bibfield{extradate} field.
\cntitem{maxextraname}
This counter holds the highest number found in any \bibfield{extraname} field.
\cntitem{maxextratitle}
This counter holds the highest number found in any \bibfield{extratitle} field.
\cntitem{maxextratitleyear}
This counter holds the highest number found in any \bibfield{extratitleyear} field.
\cntitem{refsection}
This counter indicates the current \env{refsection} environment. When queried in a bibliography heading, the counter returns the value of the \opt{refsection} option passed to \cmd{printbibliography}.
\cntitem{refsegment}
This counter indicates the current \env{refsegment} environment. When queried in a bibliography heading, this counter returns the value of the \opt{refsegment} option passed to \cmd{printbibliography}.
\cntitem{maxnames}
This counter holds the setting of the \opt{maxnames} package option.
\cntitem{minnames}
This counter holds the setting of the \opt{minnames} package option.
\cntitem{maxitems}
This counter holds the setting of the \opt{maxitems} package option.
\cntitem{minitems}
This counter holds the setting of the \opt{minitems} package option.
\cntitem{instcount}
This counter is incremented by \biblatex for every citation as well as for every entry in the bibliography and bibliography lists. The value of this counter uniquely identifies a single instance of a reference in the document.
\cntitem{citetotal}
This counter, which is only available in the \prm{loopcode} of a citation command defined with \cmd{DeclareCiteCommand}, holds the total number of valid entry keys passed to the citation command.
\cntitem{citecount}
This counter, which is only available in the \prm{loopcode} of a citation command defined with \cmd{DeclareCiteCommand}, holds the number of the entry key currently being processed by the \prm{loopcode}.
\cntitem{multicitetotal}
This counter is similar to \cnt{citetotal} but only available in multicite commands. It holds the total number of citations passed to the multicite command. Note that each of these citations may consist of more than one entry key. This information is provided by the \cnt{citetotal} counter.
\cntitem{multicitecount}
This counter is similar to \cnt{citecount} but only available in multicite commands. It holds the number of the citation currently being processed. Note that this citation may consist of more than one entry key. This information is provided by the \cnt{citetotal} and \cnt{citecount} counters.
\cntitem{listtotal}
This counter holds the total number of items in the current list. It is intended for use in list formatting directives and does not hold a meaningful value when used anywhere else. As an exception, it may also be used in the second optional argument to \cmd{printnames} and \cmd{printlist}, see \secref{aut:bib:dat} for details. For every list, there is also a counter by the same name which holds the total number of items in the corresponding list. For example, the \cnt{author} counter holds the total number of items in the \bibfield{author} list. This applies to both name lists and literal lists. These counters are similar to \cnt{listtotal} except that they may also be used independently of list formatting directives. For example, a bibliography style might check the \cnt{editor} counter to decide Whether or not to print the term «editor» or rather its plural form «editors» after the list of editors.
\cntitem{listcount}
This counter holds the number of the list item currently being processed. It is intended for use in list formatting directives and does not hold a meaningful value when used anywhere else.
\cntitem{liststart}
This counter holds the \prm{start} argument passed to \cmd{printnames} or \cmd{printlist}. It is intended for use in list formatting directives and does not hold a meaningful value when used anywhere else.
\cntitem{liststop}
This counter holds the \prm{stop} argument passed to \cmd{printnames} or \cmd{printlist}. It is intended for use in list formatting directives and does not hold a meaningful value when used anywhere else.
\csitem{currentlang}
The name of the currently active language for \biblatex. Can be used anywhere and
defaults to the main document language. This is automatically switched
inside entries which define \bibfield{langid}, given suitable settings of the
\opt{autolang} and \opt{language} options. Note that this does not track
all document language changes, only the current \biblatex\ setting.
\csitem{currentfield}
The name of the field currently being processed by \cmd{printfield}. This information is only available locally in field formatting directives.
\csitem{currentlist}
The name of the literal list currently being processed by \cmd{printlist}. This information is only available locally in list formatting directives.
\csitem{currentname}
The name of the name list currently being processed by \cmd{printnames}. This information is only available locally in name formatting directives.
\end{ltxsyntax}
\subsubsection{General Purpose Hooks}
\label{aut:fmt:hok}
\begin{ltxsyntax}
\cmditem{AtBeginBibliography}{code}
Appends the \prm{code} to an internal hook executed at the beginning of the bibliography. The \prm{code} is executed at the beginning of the list of references, immediately after the \prm{begin code} of \cmd{defbibenvironment}. This command may only be used in the preamble.
\cmditem{AtBeginShorthands}{code}
Appends the \prm{code} to an internal hook executed at the beginning of the list of shorthands. The \prm{code} is executed at the beginning of the list of shorthands, immediately after the \prm{begin code} of \cmd{defbibenvironment}. This command may only be used in the preamble.
This is just an alias for:
\begin{ltxexample}
\AtBeginBiblist{shorthand}{code}
\end{ltxexample}
\cmditem{AtBeginBiblist}{biblistname}{code}
Appends the \prm{code} to an internal hook executed at the beginning of the bibliography list \prm{biblistname}. The \prm{code} is executed at the beginning of the bibliography list, immediately after the \prm{begin code} of \cmd{defbibenvironment}. This command may only be used in the preamble.
\cmditem{AtEveryBibitem}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every item in the bibliography. The \prm{code} is executed immediately after the \prm{item code} of \cmd{defbibenvironment}. The bibliographic data of the respective entry is available at this point. This command may only be used in the preamble.
\cmditem{AtEveryLositem}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every item in the list of shorthands. The \prm{code} is executed immediately after the \prm{item code} of \cmd{defbibenvironment}. The bibliographic data of the respective entry is available at this point. This command may only be used in the preamble.
This is just an alias for:
\begin{ltxexample}
\AtEveryBiblistitem{shorthand}{code}
\end{ltxexample}
\cmditem{AtEveryBiblistitem}{biblistname}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every item in the bibliography list named \prm{biblistname}. The \prm{code} is executed immediately after the \prm{item code} of \cmd{defbibenvironment}. The bibliographic data of the respective entry is available at this point. This command may only be used in the preamble.
\cmditem{AtNextBibliography}{code}
Similar to \cmd{AtBeginBibliography} but only affecting the next \cmd{printbibliography}. The internal hook is cleared after being executed once. This command may be used in the document body.
\cmditem{AtUsedriver}{code}
\cmditem*{AtUsedriver}*{code}
Appends the \prm{code} to an internal hook executed when initializing \cmd{usedriver}. The starred variant of the command clears the initialisation hook, so the defaults can be overwritten. This command may only be used in the preamble.
The default setting is:
\begin{ltxexample}
\AtUsedriver{%
\delimcontext{bib}%
\let\finentry\blx@finentry@usedrv
\let\newblock\relax
\let\abx@macro@bibindex\@empty
\let\abx@macro@pageref\@empty}
\end{ltxexample}
\cmditem{AtEveryCite}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every citation command. The \prm{code} is executed immediately before the \prm{precode} of the command (see \secref{aut:cbx:cbx}). No bibliographic data is available at this point. This command may only be used in the preamble.
\cmditem{AtEveryCitekey}{code}
Appends the \prm{code} to an internal hook executed once for every entry key passed to a citation command. The \prm{code} is executed immediately before the \prm{loopcode} of the command (see \secref{aut:cbx:cbx}). The bibliographic data of the respective entry is available at this point. This command may only be used in the preamble.
\cmditem{AtEveryMultiCite}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every multicite command. The \prm{code} is executed immediately before the \bibfield{multiprenote} field (\secref{aut:cbx:fld}) is printed. No bibliographic data is available at this point. This command may only be used in the preamble.
\cmditem{AtNextCite}{code}
Similar to \cmd{AtEveryCite} but only affecting the next citation command. The internal hook is cleared after being executed once. This command may be used in the document body.
\cmditem{AtEachCitekey}{code}
Similar to \cmd{AtEveryCitekey} but only affecting the current citation command. This command may be used in the document body. The \prm{code} is appended to the internal hook locally when located in a citation, as determined by \cmd{ifcitation}.
\cmditem{AtNextCitekey}{code}
Similar to \cmd{AtEveryCitekey} but only affecting the next entry key. The internal hook is cleared after being executed once. This command may be used in the document body.
\cmditem{AtNextMultiCite}{code}
Similar to \cmd{AtEveryMultiCite} but only affecting the next multicite command. The internal hook is cleared after being executed once. This command may be used in the document body.
\cmditem{AtVolcite}{code}
\cmditem*{AtVolcite}*{code}
Appends the \prm{code} to an internal hook executed when initializing \cmd{volcite}. The starred variant of the command clears the initialisation hook, so the defaults can be overwritten. This command may only be used in the preamble.
The default setting is:
\begin{ltxexample}
\AtVolcite{%
\DeclareFieldAlias{postnote}{volcitenote}}
\end{ltxexample}
\cmditem{AtDataInput}[entrytype]{code}
Appends the \prm{code} to an internal hook executed once for every entry as the bibliographic data is imported from the \file{bbl} file. The \prm{entrytype} is the entry type the \prm{code} applies to. If it applies to all entry types, omit the optional argument. The \prm{code} is executed immediately after the entry has been imported. This command may only be used in the preamble. Note that \prm{code} may be executed multiple times for an entry. This occurs when the same entry is cited in different \env{refsection} environments or the \opt{sorting} option settings incorporate more than one sorting template. The \cnt{refsection} counter holds the number of the respective reference section while the data is imported.
\cmditem{UseBibitemHook}
Executes the internal hook corresponding to \cmd{AtEveryBibitem}.
\cmditem{UseUsedriverHook}
Executes the internal hook corresponding to \cmd{AtUsedriver}.
\cmditem{UseEveryCiteHook}
Executes the internal hook corresponding to \cmd{AtEveryCite}.
\cmditem{UseEveryCitekeyHook}
Executes the internal hook corresponding to \cmd{AtEveryCitekey}.
\cmditem{UseEveryMultiCiteHook}
Executes the internal hook corresponding to \cmd{AtMultiEveryCite}.
\cmditem{UseNextCiteHook}
Executes and clears the internal hook corresponding to \cmd{AtNextCite}.
\cmditem{UseNextCitekeyHook}
Executes and clears the internal hook corresponding to \cmd{AtNextCitekey}.
\cmditem{UseNextMultiCiteHook}
Executes and clears the internal hook corresponding to \cmd{AtNextMultiCite}.
\cmditem{UseVolciteHook}
Executes the internal hook corresponding to \cmd{AtVolcite}.
\cmditem{DeferNextCitekeyHook}
Locally un-defines the internal hook specified by \cmd{AtNextCitekey}. This essentially defers the hook to the next entry key in the citation list, when executed in the \prm{precode} argument of \cmd{DeclareCiteCommand} (\secref{aut:cbx:cbx}).
\cmditem{AtEveryEntrykey}{code}{success}{failure}
Appends \prm{code} to an internal hook executed every time an entrykey is processed for a citation command or \cmd{nocite}. The \prm{code} is passed one argument (\lstinline{#1}), which contains the entrykey. If the code can be appended to the hook \prm{success} is executed, otherwise \prm{failure} is executed. Unlike \cmd{AtEveryCitekey} the entry data of the current entrykey is not available when \prm{code} is processed, indeed it is not even known whether or not there is any entry data at all.
\end{ltxsyntax}
\subsubsection{File hooks}
\label{aut:fmt:hok:fil}
\biblatex has rudimentary support for injecting arbitrary code before and after a file is loaded via file hooks. For files that are loaded using \biblatex's file interface---that includes all bibliography and citation styles---the following three hooks are available
\begin{ltxsyntax}
\cmditem{blx@filehook@preload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected before it is loaded.
\cmditem{blx@filehook@postload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected after it is loaded.
\cmditem{blx@filehook@failure@$<$filename with extension$>$}
This hook is executed if \file{$<$filename with extension$>$} can not be found.
\end{ltxsyntax}
\biblatex generally only loads files once even if they were requested multiple times,
so the hooks will only be executed once.
Naturally, the file hooks need to be populated before the files are loaded, so the safest would be to populate them before \biblatex is loaded.
It is advisable to only append code to avoid overwriting previous hook contents.
Since the name of the file hook include the dot and the file extension they will usually have to be defined with a command like \cmd{csappto} from \sty{etoolbox}.
The \file{.lbx} files are special and may have to be loaded several times in some situations.
Their file hooks are
\begin{ltxsyntax}
\cmditem{blx@lbxfilehook@once@preload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected before it is loaded in a situation where the \file{.lbx} files are loaded only once.
\cmditem{blx@lbxfilehook@once@postload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected after it is loaded in a situation where the \file{.lbx} files are loaded only once.
\cmditem{blx@lbxfilehook@once@failure@$<$filename with extension$>$}
This hook is executed if \file{$<$filename with extension$>$} can not be found in a situation where the \file{.lbx} files are loaded only once.
\cmditem{blx@lbxfilehook@simple@preload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected before it is loaded in a situation where the \file{.lbx} files may be loaded multiple times.
\cmditem{blx@lbxfilehook@simple@postload@$<$filename with extension$>$}
If \file{$<$filename with extension$>$} is found, this hook is exected after it is loaded in a situation where the \file{.lbx} files may be loaded multiple times.
\cmditem{blx@lbxfilehook@simple@failure@$<$filename with extension$>$}
This hook is executed if \file{$<$filename with extension$>$} can not be found in a situation where the \file{.lbx} files may be loaded multiple times.
\end{ltxsyntax}
The following code sets up \sty{beamer} to print the bibliography labels instead of its bibliography icons when \file{numeric.bbx} after is loaded
\begin{ltxexample}
\csappto{blx@filehook@postload@numeric.bbx}{%
\mode<presentation>{%
\setbeamertemplate{bibliography item}{%
\insertbiblabel}}}
\end{ltxexample}
\subsection{Hints and Caveats}
\label{aut:cav}
This section provides some additional hints concerning the author interface of this package. It also addresses common problems and potential misconceptions.
\subsubsection{Entry Sets}
\label{aut:cav:set}
Entry sets have already been introduced in \secref{use:use:set}. This section discusses how to process entry sets in a bibliography style. From the perspective of the driver, there is no difference between static and dynamic entry sets. Both types are handled in the same way. You will normally use the \cmd{entryset} command from \secref{aut:bib:dat} to loop over all set members (in the order in which they are listed in the \bibfield{entryset} field of the \bibtype{set} entry, or in the order in which they were passed to \cmd{defbibentryset}, respectively) and append \cmd{finentry} at the end. That's it. The formatting is handled by the drivers for the entry types of the individual set members:
\begin{ltxexample}
\DeclareBibliographyDriver{set}{%
<<\entryset>>{}{}%
\finentry}
\end{ltxexample}
%
You may have noticed that the \texttt{numeric} styles which come with this package support subdivided entry sets, \ie the members of the set are marked with a letter or some other marker such that citations may either refer to the entire set or to a specific set member. The markers are generated as follows by the bibliography style:
\begin{ltxexample}
\DeclareBibliographyDriver{set}{%
\entryset
{<<\printfield{entrysetcount}>>%
<<\setunit*{\addnbspace}>>}
{}%
\finentry}
\end{ltxexample}
%
The \bibfield{entrysetcount} field holds an integer indicating the position of a set member in the entry set. The conversion of this number to a letter or some other marker is handled by the formatting directive of the \bibfield{entrysetcount} field. All the driver needs to do is print the field and add some white space (or start a new line). Printing the markers in citations works in a similar way. Where a numeric style normally says |\printfield{labelnumber}|, you simply append the \bibfield{entrysetcount} field:
\begin{ltxexample}
\printfield{labelnumber}<<\printfield{entrysetcount}>>
\end{ltxexample}
%
Since this field is only defined when processing citations referring to a set member, there is no need to add any additional tests.
Citing entry sets directly requires that a meaningful way of identifying sets is available in the style. This is obvious for styles based on numeric or alphabetic labels but not obvious (and rarely required) in styles which construct citations based on textual names/titles/dates etc. The default provided styles which no not construct citations based on labels (\texttt{authoryear}, \texttt{authortitle}, \texttt{verbose} etc.) therefore do not support citing sets directly as there is no obvious default identifier to use in such cases and such styles rarely, if ever, employ sets anyway. Custom styles may of course choose to define and print a citation identifier for directly cited sets.
\subsubsection{Electronic Publishing Information}
\label{aut:cav:epr}
The standard styles feature dedicated support for arXiv references. Support for other resources is easily added. The standard styles handle the \bibfield{eprint} field as follows:
\begin{ltxexample}
\iffieldundef{eprinttype}
{\printfield{eprint}}
{\printfield[<<eprint:\strfield{eprinttype}>>]{eprint}}
\end{ltxexample}
%
If an \bibfield{eprinttype} field is available, the above code tries to use the field format \texttt{eprint:\prm{eprinttype}}. If this format is undefined, \cmd{printfield} automatically falls back to the field format \texttt{eprint}. There are two predefined field formats, the type"=specific format \texttt{eprint:arxiv} and the fallback format \texttt{eprint}:
\begin{ltxexample}
\DeclareFieldFormat{<<eprint>>}{...}
\DeclareFieldFormat{<<eprint:arxiv>>}{...}
\end{ltxexample}
%
In other words, adding support for additional resources is as easy as defining a field format named \texttt{eprint:\prm{resource}} where \prm{resource} is an identifier to be used in the \bibfield{eprinttype} field.
\subsubsection{External Abstracts and Annotations}
\label{aut:cav:prf}
External abstracts and annotations have been discussed in \secref{use:use:prf}. This section provides some more background for style authors. The standard styles use the following macros (from \path{biblatex.def}) to handle abstracts and annotations:
\begin{ltxexample}
\newbibmacro*{annotation}{%
\iffieldundef{annotation}
{\printfile[annotation]{<<\bibannotationprefix\thefield{entrykey}.tex>>}}%
{\printfield{annotation}}}
\newcommand*{<<\bibannotationprefix>>}{bibannotation-}
\newbibmacro*{abstract}{%
\iffieldundef{abstract}
{\printfile[abstract]{<<\bibabstractprefix\thefield{entrykey}.tex>>}}%
{\printfield{abstract}}}
\newcommand*{<<\bibabstractprefix>>}{bibabstract-}
\end{ltxexample}
%
If the \bibfield{abstract}\slash \bibfield{annotation} field is undefined, the above code tries to load the abstracts\slash annotations from an external file. The \cmd{printfile} commands also incorporate file name prefixes which may be redefined by users. Note that you must enable \cmd{printfile} explicitly by setting the \opt{loadfiles} package option from \secref{use:opt:pre:gen}. This feature is disabled by default for performance reasons.
\subsubsection[Name Disambiguation]{Name Disambiguation}
\label{aut:cav:amb}
The \opt{uniquename} and \opt{uniquelist} options introduced in \secref{use:opt:pre:int} support various modes of operation. This section explains the differences between these modes by way of example. The \opt{uniquename} option disambiguates individual names in the \bibfield{labelname} list. The \opt{uniquelist} option disambiguates the \bibfield{labelname} list if it has become ambiguous after \opt{maxnames}\slash \opt{minnames} truncation. You can use either option stand-alone or combine both.
Name disambiguation works by taking a <base> which is composed of one or more nameparts and then determining what needs to be added, if anything, to this <base> to make the name unique in the current refsection. Name disambiguation is controlled by the uniquename template declared with the following command:
\begin{ltxsyntax}
\cmditem{DeclareUniquenameTemplate}[name]{specification}
Defines the \opt{uniquename} template \prm{name}. The \prm{name} is optional and defaults to \prm{<global>}.
The \prm{specification} is an ordered list of \cmd{namepart} commands which define the nameparts to use in determining the uniquename information.
\cmditem{namepart}[options]{namepart}
\prm{namepart} is one of the datamodel nameparts defined with the \cmd{DeclareDatamodelConstant} command (see \secref{aut:bbx:drv}). The \prm{options} are:
\begin{optionlist*}
\boolitem[false]{use}
Only use the \prm{namepart} in constructing the uniquename information if there is a corresponding option \opt{use<namepart>} and that option is true.
\boolitem[false]{base}
The \prm{namepart} is part of the <base> which is the main piece of namepart(s) information which is being disambiguated by uniqueness information. For example, a family name which may be disambiguated by further given names. <base> \prm{namepart}s must occur before any non-<base> \prm{nameparts}. There \emph{must} be at least one <base> \prm{namepart} and \biber will report an error if this is not the case.
\choitem{disambiguation}{none, init, initorfull, full}
The \prm{namepart} will be disambiguated at most by information at the given value. If this option is not present then the default is inferred from the \opt{uniquename} package option setting (see \secref{use:opt:wu}). The <disambiguation> option is ignored for \prm{namepart}s which have the <base> option set to <true> since it is these nameparts which are being disambiguated by the value of the non-base \prm{namepart}s and therefore <disambiguation> does not apply.
\begin{description}
\item[none]~Do not use the \prm{namepart} to perform any name disambiguation
\item[init]~Use only the initials of the \prm{namepart} to perform name disambiguation
\item[initorfull]~Use initials and if necessary the full \prm{namepart} to perform name disambiguation
\item[full]~Use only the full \prm{namepart} to perform name
disambiguation even if initials would suffice
\end{description}
\end{optionlist*}
\end{ltxsyntax}
%
The default uniquename template is:
\begin{ltxexample}
\DeclareUniquenameTemplate{
\namepart[use=true, base=true]{prefix}
\namepart[base=true]{family}
\namepart{given}
}
\end{ltxexample}
%
This means that the <base> to be disambiguated consists of the <family> namepart, along with any prefix, if the \opt{useprefix} option is true. The disambiguation is performed by adding anything up to the full namepart of any non <base> nameparts in the specification, here just the <given> namepart.
\paragraph{Individual Names (\opt{uniquename})}
Let's start off with some \opt{uniquename} examples. Consider the following data:
\begin{lstlisting}{}
John Doe 2008
Edward Doe 2008
John Smith 2008
Jane Smith 2008
\end{lstlisting}
%
Let's assume we're using an author-year style and set \kvopt{uniquename}{false}. In this case, we would get the following citations:
\begin{lstlisting}{}
Doe 2008a
Doe 2008b
Smith 2008a
Smith 2008b
\end{lstlisting}
%
Since the family names are ambiguous and all works have been published in the same year, an extra letter is appended to the year to disambiguate the citations. Many style guides, however, mandate that the extra letter be used to disambiguate works by the same authors only, not works by different authors with the same family name. In order to disambiguate the author's family name, you are expected to add additional parts of the name, either as initials or in full. This requirement is addressed by the \opt{uniquename} option. Here are the same citations with \kvopt{uniquename}{init}:
\begin{lstlisting}{}
J. Doe 2008
E. Doe 2008
Smith 2008a
Smith 2008b
\end{lstlisting}
%
\kvopt{uniquename}{init} restricts name disambiguation to initials. Since <J. Smith> would still be ambiguous, no additional name parts are added for the <Smiths>. With \kvopt{uniquename}{full}, names are printed in full where required:
\begin{lstlisting}{}
J. Doe 2008
E. Doe 2008
John Smith 2008
Jane Smith 2008
\end{lstlisting}
%
In order to illustrate the difference between \kvopt{uniquename}{init\slash full} and \texttt{allinit\slash allfull}, we need to introduce the notion of a <visible> name. In the following, <visible> names are all names at a position before the \opt{maxnames}\slash \opt{minnames}\slash \opt{uniquelist} truncation point. For example, given this data:
\begin{lstlisting}{}
William Jones/Edward Doe/Jane Smith
John Doe
John Smith
\end{lstlisting}
%
and \kvopt{maxnames}{1}, \kvopt{minnames}{1}, \kvopt{uniquename}{init/full}, we would get the following names in citations:
\begin{lstlisting}{}
Jones et al.
Doe
Smith
\end{lstlisting}
%
When disambiguating names, \kvopt{uniquename}{init/full} only consider the visible names. Since all visible family names are distinct in this example, no further name parts are added. Let's compare that to the output of \kvopt{uniquename}{allinit}:
\begin{lstlisting}{}
Jones et al.
J. Doe
Smith
\end{lstlisting}
%
\texttt{allinit} considers all names in all \bibfield{labelname} lists, including those which are hidden and replaced by <et al.> as the list is truncated. In this example, <John Doe> is disambiguated from <Edward Doe>. Since the ambiguity of the two <Smiths> can't be resolved by adding initials, no initials are added in this case. Now let's compare that to the output of \kvopt{uniquename}{allfull} which also disambiguates <John Smith> from <Jane Smith>:
\begin{lstlisting}{}
Jones et al.
J. Doe
John Smith
\end{lstlisting}
%
The options \kvopt{uniquename}{mininit/minfull} are similar to \texttt{init\slash full} in that they only consider visible names, but they perform minimal disambiguation. That is, they will disambiguate individual names only if they occur in identical lists of base nameparts (for the concept of <base> nameparts, see \cmd{DeclareUniquenameTemplate in \secref{aut:cav:amb}}). Consider the following data:
\begin{lstlisting}{}
John Doe/William Jones
Edward Doe/William Jones
John Smith/William Edwards
Edward Smith/Allan Johnson
\end{lstlisting}
%
With \kvopt{uniquename}{init/full}, we would get:
\begin{lstlisting}{}
J. Doe and Jones
E. Doe and Jones
J. Smith and Edwards
E. Smith and Johnson
\end{lstlisting}
%
With \kvopt{uniquename}{mininit/minfull}:
\begin{lstlisting}{}
J. Doe and Jones
E. Doe and Jones
Smith and Edwards
Smith and Johnson
\end{lstlisting}
%
The <Smiths> are not disambiguated because the visible name lists are not ambiguous and the \opt{mininit/minfull} options serve to disambiguate names occurring in identical base namepart lists only. Another way of looking at this is that they globally disambiguate base namepart lists. When it comes to ambiguous lists, note that a truncated list is considered to be distinct from an untruncated one even if the visible names are identical. For example, consider the following data:
\begin{lstlisting}{}
John Doe/William Jones
Edward Doe
\end{lstlisting}
%
With \kvopt{maxnames}{1}, \kvopt{uniquename}{init/full}, we would get:
\begin{lstlisting}{}
J. Doe et al.
E. Doe
\end{lstlisting}
%
With \kvopt{uniquename}{mininit/minfull}:
\begin{lstlisting}{}
Doe et al.
Doe
\end{lstlisting}
%
Because the lists differ in the <et al.>, the names are not disambiguated.
\paragraph{Lists of Names (\opt{uniquelist})}
Ambiguity is also an issue with name lists. If the \bibfield{labelname} list is truncated by the \opt{maxnames}\slash \opt{minnames} options, it may become ambiguous. This type of ambiguity is addressed by the \opt{uniquelist} option. Consider the following data:
\begin{lstlisting}{}
Doe/Jones/Smith 2005
Smith/Johnson/Doe 2005
Smith/Doe/Edwards 2005
Smith/Doe/Jones 2005
\end{lstlisting}
%
Many author-year styles truncate long author/editor lists in citations. For example, with \kvopt{maxnames}{1} we would get:
\begin{lstlisting}{}
Doe et al. 2005
Smith et al. 2005a
Smith et al. 2005b
Smith et al. 2005c
\end{lstlisting}
%
Since the authors are ambiguous after truncation, the extra letter is added to the year to ensure unique citations. Here again, many style guides mandate that the extra letter be used to disambiguate works by the same authors only. In order to disambiguate author lists, you are usually required to add more names, exceeding the \opt{maxnames}\slash \opt{minnames} truncation point. The \opt{uniquelist} feature addresses this requirement. With \kvopt{uniquelist}{true}, we would get:
\begin{lstlisting}{}
Doe et al. 2005
Smith, Johnson et al. 2005
Smith, Doe and Edwards 2005
Smith, Doe and Jones 2005
\end{lstlisting}
%
The \opt{uniquelist} option overrides \opt{maxnames}\slash \opt{minnames} on a per-entry basis. Essentially, what happens is that the <et al.> part of the citation is expanded to the point of no ambiguity---but no further than that. \opt{uniquelist} may also be combined with \opt{uniquename}. Consider the following data:
\begin{lstlisting}{}
John Doe/Allan Johnson/William Jones 2009
John Doe/Edward Johnson/William Jones 2009
John Doe/Jane Smith/William Jones 2009
John Doe/John Smith/William Jones 2009
John Doe/John Edwards/William Jones 2009
John Doe/John Edwards/Jack Johnson 2009
\end{lstlisting}
%
With \kvopt{maxnames}{1}:
\begin{lstlisting}{}
Doe et al. 2009a
Doe et al. 2009b
Doe et al. 2009c
Doe et al. 2009d
Doe et al. 2009e
Doe et al. 2009f
\end{lstlisting}
%
With \kvopt{maxnames}{1}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}:
\begin{lstlisting}{}
Doe, A. Johnson et al. 2009
Doe, E. Johnson et al. 2009
Doe, Jane Smith et al. 2009
Doe, John Smith et al. 2009
Doe, Edwards and Jones 2009
Doe, Edwards and Johnson 2009
\end{lstlisting}
%
With \kvopt{uniquelist}{minyear}, list disambiguation only happens if the visible list is identical to another visible list with the same \bibfield{labelyear}. This is useful for author-year styles which only require that the citation as a whole be unique, but do not guarantee unambiguous authorship information in citations. This mode is conceptually related to \kvopt{uniquename}{mininit/minfull}. Consider this example:
\begin{lstlisting}{}
Smith/Jones 2000
Smith/Johnson 2001
\end{lstlisting}
%
With \kvopt{maxnames}{1} and \kvopt{uniquelist}{true}, we would get:
\begin{lstlisting}{}
Smith and Jones 2000
Smith and Johnson 2001
\end{lstlisting}
%
With \kvopt{uniquelist}{minyear}:
\begin{lstlisting}{}
Smith et al. 2000
Smith et al. 2001
\end{lstlisting}
%
With \kvopt{uniquelist}{minyear}, it is not clear that the authors are different for the two works but the citations as a whole are still unambiguous since the year is different. In contrast to that, \kvopt{uniquelist}{true} disambiguates the authorship even if this information is not required to uniquely locate the works in the bibliography. Let's consider another example:
\begin{lstlisting}{}
Vogel/Beast/Garble/Rook 2000
Vogel/Beast/Tremble/Bite 2000
Vogel/Beast/Acid/Squeeze 2001
\end{lstlisting}
%
With \kvopt{maxnames}{3}, \kvopt{minnames}{1}, \kvopt{uniquelist}{true}, we would get:
\begin{lstlisting}{}
Vogel, Beast, Garble et al. 2000
Vogel, Beast, Tremble et al. 2000
Vogel, Beast, Acid et al. 2001
\end{lstlisting}
%
With \kvopt{uniquelist}{minyear}:
\begin{lstlisting}{}
Vogel, Beast, Garble et al. 2000
Vogel, Beast, Tremble et al. 2000
Vogel et al. 2001
\end{lstlisting}
%
In the last citation, \kvopt{uniquelist}{minyear} does not override \opt{maxnames}\slash \opt{minnames} as the citation does not need disambiguating from the other two because the year is different.
\subsubsection{Trackers in Floats and \acr{TOC}/\acr{LOT}/\acr{LOF}}
\label{aut:cav:flt}
If a citation is given in a float (typically in the caption of a figure or table), scholarly back references like <ibidem> or back references based on the page tracker get ambiguous because floats are objects which are (physically and logically) placed outside the flow of text, hence the logic of such references applies poorly to them. To avoid any such ambiguities, the citation and page trackers are temporarily disabled in all floats unless explicitly requested with \opt{trackfloats}. In addition to that, these trackers plus the back reference tracker (\opt{backref}) are temporarily disabled in the table of contents, the list of figures, and the list of tables.
\subsubsection{Mixing Programming Interfaces}
\label{aut:cav:mif}
The \biblatex package provides two main programming interfaces for style authors. The \cmd{DeclareBibliographyDriver} command, which defines a handler for an entry type, is typically used in \file{bbx} files. \cmd{DeclareCiteCommand}, which defines a new citation command, is typically used in \file{cbx} files. However, in some cases it is convenient to mix these two interfaces. For example, the \cmd{fullcite} command prints a verbose citation similar to the full bibliography entry. It is essentially defined as follows:
\begin{ltxexample}
\DeclareCiteCommand{\fullcite}
{...}
{<<\usedriver>>{...}{<<\thefield{entrytype}>>}}
{...}
{...}
\end{ltxexample}
%
As you can see, the core code which prints the citations simply executes the bibliography driver defined with \cmd{DeclareBibliographyDriver} for the type of the current entry. When writing a citation style for a verbose citation scheme, it is often convenient to use the following structure:
\begin{ltxexample}
\ProvidesFile{example.cbx}[2007/06/09 v1.0 biblatex citation style]
\DeclareCiteCommand{\cite}
{...}
{<<\usedriver>>{...}{<<cite:\thefield{entrytype}>>}}
{...}
{...}
\DeclareBibliographyDriver{<<cite:article>>}{...}
\DeclareBibliographyDriver{<<cite:book>>}{...}
\DeclareBibliographyDriver{<<cite:inbook>>}{...}
...
\end{ltxexample}
%
Another case in which mixing interfaces is helpful are styles using cross"=references within the bibliography. For example, when printing an \bibtype{incollection} entry, the data inherited from the \bibtype{collection} parent entry would be replaced by a short pointer to the respective parent entry:
\begin{enumerate}
\renewcommand*\labelenumi{[\theenumi]}
\setlength{\leftskip}{0.5em}
\item Audrey Author: \emph{Title of article}. In: [\textln{2}], pp.~134--165.
\item Edward Editor, ed.: \emph{Title of collection}. Publisher: Location, 1995.
\end{enumerate}
One way to implement such cross"=references within the bibliography is to think of them as citations which use the value of the \bibfield{xref} or \bibfield{crossref} field as the entry key. Here is an example:
\begin{ltxexample}
\ProvidesFile{example.bbx}[2007/06/09 v1.0 biblatex bibliography style]
\DeclareCiteCommand{<<\bbx@xref>>}
{}
{...}% code for cross-references
{}
{}
\DeclareBibliographyDriver{incollection}{%
...
\iffieldundef{xref}
{...}% code if no cross-reference
{<<\bbx@xref>>{<<\thefield{xref}>>}}%
...
}
\end{ltxexample}
%
When defining \cmd{bbx@xref}, the \prm{precode}, \prm{postcode}, and \prm{sepcode} arguments of \cmd{DeclareCiteCommand} are left empty in the above example because they will not be used anyway. The cross"=reference is printed by the \prm{loopcode} of \cmd{bbx@xref}. For further details on the \bibfield{xref} field, refer to \secref{bib:fld:spc} and to the hints in \secref{bib:cav:ref}. Also see the \cmd{iffieldxref}, \cmd{iflistxref}, and \cmd{ifnamexref} tests in \secref{aut:aux:tst}. The above could also be implemented using the \cmd{entrydata} command from \secref{aut:bib:dat}:
\begin{ltxexample}
\ProvidesFile{example.bbx}[2007/06/09 v1.0 biblatex bibliography style]
\DeclareBibliographyDriver{incollection}{%
...
\iffieldundef{xref}
{...}% code if no cross-reference
{<<\entrydata>>{<<\thefield{xref}>>}{%
% code for cross-references
...
}}%
...
}
\end{ltxexample}
\subsubsection{Using the Punctuation Tracker}
\label{aut:cav:pct}
\paragraph{The Basics}
There is one fundamental principle style authors should keep in mind when designing a bibliography driver: block and unit punctuation is handled asynchronously. This is best explained by way of example. Consider the following code snippet:
\begin{ltxexample}
\printfield{title}%
\newunit
\printfield{edition}%
\newunit
\printfield{note}%
\end{ltxexample}
%
If there is no \bibfield{edition} field, this piece of code will not print:
\begin{lstlisting}[style=highlight]{}
Title. . Note
\end{lstlisting}
%
but rather:
\begin{lstlisting}[style=highlight]{}
Title. Note
\end{lstlisting}
%
because the unit punctuation tracker works asynchronously. \cmd{newunit} will not print the unit punctuation immediately. It merely records a unit boundary and puts \cmd{newunitpunct} on the punctuation buffer. This buffer will be handled by \emph{subsequent} \cmd{printfield}, \cmd{printlist}, or similar commands but only if the respective field or list is defined. Commands like \cmd{printfield} will consider three factors prior to inserting any block or unit punctuation:
\begin{itemize}
\item Has a new unit/block been requested at all?\par
= Is there any preceding \cmd{newunit} or \cmd{newblock} command?
\item Did the preceding commands print anything?\par
= Is there any preceding \cmd{printfield} or similar command?\par
= Did this command actually print anything?\par
\item Are we about to print anything now?\par
= Is the field/list to be processed now defined?
\end{itemize}
%
Block and unit punctuation will only be inserted if \emph{all} of these conditions apply. Let's reconsider the above example:
\begin{ltxexample}
\printfield{title}%
\newunit
\printfield{edition}%
\newunit
\printfield{note}%
\end{ltxexample}
%
Here's what happens if the \bibfield{edition} field is undefined. The first \cmd{printfield} command prints the title and sets an internal <new~text> flag. The first \cmd{newunit} sets an internal <new~unit> flag. No punctuation has been printed at this point. The second \cmd{printfield} does nothing because the \bibfield{edition} field is undefined. The next \cmd{newunit} command sets the internal flag <new unit> again. Still no punctuation has been printed. The third \cmd{printfield} checks if the \bibfield{note} field is defined. If so, it looks at the <new~text> and <new~unit> flags. If both are set, it inserts the punctuation buffer before printing the note. It then clears the <new~unit> flag and sets the <new~text> flag again.
This may all sound more complicated than it is. In practice, it means that it is possible to write large parts of a bibliography driver in a sequential way. The advantage of this approach becomes obvious when trying to write the above code without using the punctuation tracker. Such an attempt will lead to a rather convoluted set of \cmd{iffieldundef} tests required to check for all possible field combinations (note that the code below handles three fields; a typical driver may need to cater for some two dozen fields):
\begin{ltxexample}
\iffieldundef{title}%
{\iffieldundef{edition}
{\printfield{note}}
{\printfield{edition}%
\iffieldundef{note}%
{}
{. \printfield{note}}}}
{\printfield{title}%
\iffieldundef{edition}
{}
{. \printfield{edition}}%
\iffieldundef{note}
{}
{. \printfield{note}}}%
\end{ltxexample}
\paragraph{Common Mistakes}
It is a fairly common misconception to think of the unit punctuation as something that is handled synchronously. This typically causes problems if the driver includes any literal text. Consider this erroneous code snippet which will generate misplaced unit punctuation:
\begin{ltxexample}
\printfield{title}%
\newunit
<<(>>\printfield{series} \printfield{number}<<)>>%
\end{ltxexample}
%
This code will yield the following result:
\begin{lstlisting}[style=highlight]{}
Title <<(.>> Series Number<<)>>
\end{lstlisting}
%
Here's what happens. The first \cmd{printfield} prints the title. Then \cmd{newunit} marks a unit boundary but does not print anything. The unit punctuation is printed by the \emph{next} \cmd{printfield} command. That's the asynchronous part mentioned before. However, the opening parenthesis is printed immediately before the next \cmd{printfield} inserts the unit punctuation, leading to a misplaced period. When inserting \emph{any} literal text such as parentheses (including those printed by commands such as \cmd{bibopenparen} and \cmd{mkbibparens}), always wrap the text in a \cmd{printtext} command. For the punctuation tracker to work as expected, it needs to know about all literal text inserted by a driver. This is what \cmd{printtext} is all about. \cmd{printtext} interfaces with the punctuation tracker and ensures that the punctuation buffer is inserted before the literal text gets printed. It also sets the internal <new~text> flag. Note there is in fact a third piece of literal text in this example: the space after |\printfield{series}|. In the corrected example, we will use the punctuation tracker to handle that space.
\begin{ltxexample}
\printfield{title}%
\newunit
<<\printtext{(}>>%
\printfield{series}%
<<\setunit*{\addspace}>>%
\printfield{number}%
<<\printtext{)}>>%
\end{ltxexample}
%
While the above code will work as expected, the recommended way to handle parentheses, quotes, and other things which enclose more than one field, is to define a field format:
\begin{ltxexample}
\DeclareFieldFormat{<<parens>>}{<<\mkbibparens{#1}>>}
\end{ltxexample}
%
Field formats may be used with both \cmd{printfield} and \cmd{printtext}, hence we can use them to enclose several fields in a single pair of parentheses:
\begin{ltxexample}
<<\printtext[parens]{>>%
\printfield{series}%
\setunit*{\addspace}%
\printfield{number}%
<<}>>%
\end{ltxexample}
%
We still need to handle cases in which there is no series information at all, so let's improve the code some more:
\begin{ltxexample}
<<\iffieldundef{series}>>
{}
{\printtext[parens]{%
\printfield{series}%
\setunit*{\addspace}%
\printfield{number}}}%
\end{ltxexample}
%
One final hint: localisation strings are not literal text as far as the punctuation tracker is concerned. Since \cmd{bibstring} and similar commands interface with the punctuation tracker, there is no need to wrap them in a \cmd{printtext} command.
\paragraph{Advanced Usage}
The punctuation tracker may also be used to handle more complex scenarios. For example, suppose that we want the fields \bibfield{location}, \bibfield{publisher}, and \bibfield{year} to be rendered in one of the following formats, depending on the available data:
\begin{ltxexample}
...text<<. Location: Publisher, Year.>> Text...
...text<<. Location: Publisher.>> Text...
...text<<. Location: Year.>> Text...
...text<<. Publisher, Year.>> Text...
...text<<. Location.>> Text...
...text<<. Publisher.>> Text...
...text<<. Year.>> Text...
\end{ltxexample}
%
This problem can be solved with a rather convoluted set of \cmd{iflistundef} and \cmd{iffieldundef} tests which check for all possible field combinations:
\begin{ltxexample}
\iflistundef{location}
{\iflistundef{publisher}
{\printfield{year}}
{\printlist{publisher}%
\iffieldundef{year}
{}
{, \printfield{year}}}}
{\printlist{location}%
\iflistundef{publisher}%
{\iffieldundef{year}
{}
{: \printfield{year}}}
{: \printlist{publisher}%
\iffieldundef{year}
{}
{, \printfield{year}}}}%
\end{ltxexample}
%
The above could be written in a somewhat more readable way by employing \cmd{ifthenelse} and the boolean operators discussed in \secref{aut:aux:ife}. The approach would still be essentially the same. However, it may also be written sequentially:
\begin{ltxexample}
\newunit
\printlist{location}%
\setunit*{\addcolon\space}%
\printlist{publisher}%
\setunit*{\addcomma\space}%
\printfield{year}%
\newunit
\end{ltxexample}
%
In practice, you will often use a combination of explicit tests and the implicit tests performed by the punctuation tracker. For example, consider the following format (note the punctuation after the location if there is no publisher):
\begin{ltxexample}
...text. Location: Publisher, Year. Text...
...text. Location: Publisher. Text...
...text<<. Location, Year.>> Text...
...text. Publisher, Year. Text...
...text. Location. Text...
...text. Publisher. Text...
...text. Year. Text...
\end{ltxexample}
%
This can be handled by the following code:
\begin{ltxexample}
\newunit
\printlist{location}%
\iflistundef{publisher}
{\setunit*{\addcomma\space}}
{\setunit*{\addcolon\space}}%
\printlist{publisher}%
\setunit*{\addcomma\space}%
\printfield{year}%
\newunit
\end{ltxexample}
%
Since the punctuation after the location is special if there is no publisher, we need one \cmd{iflistundef} test to catch this case. Everything else is handled by the punctuation tracker.
\subsubsection{Custom Localization Modules}
\label{aut:cav:lng}
Style guides may include provisions as to how strings like <edition> should be abbreviated or they may mandate certain fixed expressions. For example, the \acr{mla} style guide requires authors to use the term <Works~Cited> rather than <Bibliography> or <References> in the heading of the bibliography. Localization commands such as \cmd{DefineBibliographyStrings} from \secref{use:lng} may indeed be used in \file{cbx} and \file{bbx} files to handle such cases. However, overloading style files with translations is rather inconvenient. This is where \cmd{DeclareLanguageMapping} from \secref{aut:lng:cmd} comes into play. This command maps an \file{lbx} file with alternative translations to a \sty{babel}/\sty{polyglossia} language. For example, you could create a file named \path{french-humanities.lbx} which provides French translations adapted for use in the humanities and map it to the \sty{babel}/\sty{polyglossia} language \texttt{french} in the preamble or in the configuration file:
\begin{ltxexample}
\DeclareLanguageMapping{french}{french-humanities}
\end{ltxexample}
%
If the document language is set to \texttt{french}, \path{french-humanities.lbx} will replace \path{french.lbx}. Coming back to the \acr{mla} example mentioned above, an \acr{mla} style may come with an \path{american-mla.lbx} file to provide strings which comply with the \acr{mla} style guide. It would declare the following mapping in the \file{cbx} and/or \file{bbx} file:
\begin{ltxexample}
\DeclareLanguageMapping{american}{american-mla}
\end{ltxexample}
%
Use \cmd{DeclareLanguageMappingSuffix} (see \secref{aut:lng:cmd}) to define such a mapping for all languages.
Since the alternative \file{lbx} file can inherit strings from the standard \path{american.lbx} module, \path{american-mla.lbx} may be as short as this:
\begin{ltxexample}
\ProvidesFile{american-mla.lbx}[2008/10/01 v1.0 biblatex localization]
<<\InheritBibliographyExtras>>{<<american>>}
\DeclareBibliographyStrings{%
<<inherit>> = {<<american>>},
bibliography = {{Works Cited}{Works Cited}},
references = {{Works Cited}{Works Cited}},
}
\endinput
\end{ltxexample}
%
Alternative \file{lbx} files must ensure that the localisation module is complete. They should do so by inheriting data from the corresponding standard module. If the language \texttt{american} is mapped to \path{american-mla.lbx}, \biblatex will not load \path{american.lbx} unless this module is requested explicitly. In the above example, inheriting <strings> and <extras> will cause \biblatex to load \path{american.lbx} before applying the modifications in \path{american-mla.lbx}.
Note that \cmd{DeclareLanguageMapping} is not intended to handle language variants (\eg American English vs. British English) or \sty{babel}/\sty{polyglossia} language aliases (\eg \texttt{USenglish} vs. \texttt{american}). For example, \sty{babel}/\sty{polyglossia} offers the \texttt{USenglish} option which is similar to \texttt{american}. Therefore, \biblatex comes with an \path{USenglish.lbx} file which simply inherits all data from \path{american.lbx} (which in turn gets the <strings> from \path{english.lbx}). In other words, the mapping of language variants and \sty{babel}/\sty{polyglossia} language aliases happens on the file level, the point being that \biblatex's language support can be extended simply by adding additional \file{lbx} files. There is no need for centralized mapping. If you need support for, say, Portuguese (babel/polyglossia: \file{portuges}), you create a file named \path{portuges.lbx}. If \sty{babel}/\sty{polyglossia} offered an alias named \texttt{brasil}, you would create \path{brasil.lbx} and inherit the data from \path{portuges.lbx}. In contrast to that, the point of \cmd{DeclareLanguageMapping} is handling \emph{stylistic} variants like <humanities vs. natural sciences> or <\acr{mla} vs. \acr{apa}> etc. which will typically be built on top of existing \file{lbx} files.
\subsubsection{Grouping}
\label{aut:cav:grp}
In a citation or bibliography style, you may need to set flags or store certain values for later use. In this case, it is crucial to understand the basic grouping structure imposed by this package. As a rule of thumb, you are working in a large group whenever author commands such as those discussed in \secref{aut:aux} are available because the author interface of this package is only enabled locally. If any bibliographic data is available, there is at least one additional group. Here are some general rules:
\begin{itemize}
\item The entire list of references printed by \cmd{printbibliography} and similar commands is processed in a group. Each entry in the list is processed in an additional group which encloses the \prm{item code} of \cmd{defbibenvironment} as well as all driver code.
\item The entire bibliography list printed by \cmd{printbiblist} is processed in a group. Each entry in the list is processed in an additional group which encloses the \prm{item code} of \cmd{defbibenvironment} as well as all driver code.
\item All citation commands defined with \cmd{DeclareCiteCommand} are processed in a group holding the complete citation code consisting of the \prm{precode}, \prm{sepcode}, \prm{loopcode}, and \prm{postcode} arguments. The \prm{loopcode} is enclosed in an additional group every time it is executed. If any \prm{wrapper} code has been specified, the entire unit consisting of the wrapper code and the citation code is wrapped in an additional group.
\item In addition to the grouping imposed by all backend commands defined with \cmd{DeclareCiteCommand}, all <autocite> and <multicite> definitions imply an additional group.
\item \cmd{printfile}, \cmd{printtext}, \cmd{printfield}, \cmd{printlist}, and \cmd{printnames} form groups. This implies that all formatting directives will be processed within a group of their own.
\item All \file{lbx} files are loaded and processed in a group. If an \file{lbx} file contains any code which is not part of \cmd{DeclareBibliographyExtras}, the definitions must be global.
\end{itemize}
Note that using \cmd{aftergroup} in citation and bibliography styles is unreliable because the precise number of groups employed in a certain context may change in future versions of this package. If the above list states that something is processed in a group, this means that there is \emph{at least one} group. There may also be several nested ones.
\subsubsection{Namespaces}
\label{aut:cav:nam}
In order to minimize the risk of name clashes, \latex packages typically prefix the names of internal macros with a short string specific to the package. For example, if the \sty{foobar} package requires a macro for internal use, it would typically be called \cmd{FB@macro} or \cmd{foo@macro} rather than \cmd{macro} or \cmd{@macro}. Here is a list of the prefixes used or recommended by \biblatex:
\begin{marglist}
\item[\texttt{blx}] All macros with names like \cmd{blx@name} are strictly reserved for internal use. This also applies to counter names, length registers, boolean switches, and so on. These macros may be altered in backwards"=incompatible ways, they may be renamed or even removed at any time without further notice. Such changes will not even be mentioned in the revision history or the release notes. In short: never use any macros with the string \texttt{blx} in their name in any styles.
\item[\texttt{abx}] Macros prefixed with \texttt{abx} are also internal macros but they are fairly stable. It is always preferable to use the facilities provided by the official author interface, but there may be cases in which using an \texttt{abx} macro is convenient.
\item[\texttt{bbx}] This is the recommended prefix for internal macros defined in bibliography styles.
\item[\texttt{cbx}] This is the recommended prefix for internal macros defined in citation styles.
\item[\texttt{lbx}] This is the recommended base prefix for internal macros defined in localisation modules. The localisation module should add a second prefix to specify the language. For example, an internal macro defined by the Spanish localisation module would be named \cmd{lbx@es@macro}.
\end{marglist}
\appendix
\section*{Appendix}
\addcontentsline{toc}{section}{Appendix}
\section{Default Driver Source Mappings}
\label{apx:maps}
These are the driver default source mappings.
\subsection{\opt{bibtex}}\label{apx:maps:bibtex}
The \opt{bibtex} driver is of course the most comprehensive and mature of the \biblatex/\biber supported data formats. These source mapping defaults are how the aliases from sections \secref{bib:typ:als} and \secref{bib:fld:als} are implemented.
\begin{ltxexample}
\DeclareDriverSourcemap[datatype=bibtex]{
\map{
\step[typesource=conference, typetarget=inproceedings]
\step[typesource=electronic, typetarget=online]
\step[typesource=www, typetarget=online]
}
\map{
\step[typesource=mastersthesis, typetarget=thesis, final]
\step[fieldset=type, fieldvalue=mathesis]
}
\map{
\step[typesource=phdthesis, typetarget=thesis, final]
\step[fieldset=type, fieldvalue=phdthesis]
}
\map{
\step[typesource=techreport, typetarget=report, final]
\step[fieldset=type, fieldvalue=techreport]
}
\map{
\step[fieldsource=address, fieldtarget=location]
\step[fieldsource=school, fieldtarget=institution]
\step[fieldsource=annote, fieldtarget=annotation]
\step[fieldsource=archiveprefix, fieldtarget=eprinttype]
\step[fieldsource=journal, fieldtarget=journaltitle]
\step[fieldsource=primaryclass, fieldtarget=eprintclass]
\step[fieldsource=key, fieldtarget=sortkey]
\step[fieldsource=pdf, fieldtarget=file]
}
}
\end{ltxexample}
\section{Default Inheritance Setup}
\label{apx:ref}
The following table shows the \biber cross-referencing rules defined by default.
Please refer to \secref{bib:cav:ref, aut:ctm:ref} for explanation.
\begingroup
\tablesetup
\def\sep{\textrm{, }}
\def\skip{\textrm{--}}
\def\note#1{\textrm{#1}}
\begin{longtable}[l]{%
@{}V{0.2\textwidth}%
@{}V{0.4\textwidth}%
@{}V{0.3\textwidth}%
@{}V{0.3\textwidth}@{}}
\toprule
\multicolumn{2}{@{}H}{Types} & \multicolumn{2}{@{}H}{Fields} \\
\cmidrule(r){1-2}\cmidrule{3-4}
\multicolumn{1}{@{}H}{Source} & \multicolumn{1}{@{}H}{Target} &
\multicolumn{1}{@{}H}{Source} & \multicolumn{1}{@{}H}{Target} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4}
\endhead
\bottomrule
\endfoot
{\normalsize*} & {\normalsize*} &
ids\par
crossref\par
xref\par
entryset\par
entrysubtype\par
execute\par
label\par
options\par
presort\par
related\par
relatedoptions\par
relatedstring\par
relatedtype\par
shorthand\par
shorthandintro\par
sortkey &
\skip\par \skip\par \skip\par \skip\par
\skip\par \skip\par \skip\par \skip\par
\skip\par \skip\par \skip\par \skip\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
mvbook\sep book &
inbook\sep bookinbook\sep suppbook &
author\par author &
author\par bookauthor \\\addlinespace
mvbook &
book\sep inbook\sep bookinbook\sep suppbook &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
maintitle\par mainsubtitle\par maintitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
mvcollection\sep mvreference &
collection\sep reference\sep incollection\sep inreference\sep suppcollection &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
maintitle\par mainsubtitle\par maintitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
mvproceedings &
proceedings\sep inproceedings &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
maintitle\par mainsubtitle\par maintitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
book &
inbook\sep bookinbook\sep suppbook &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
booktitle\par booksubtitle\par booktitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
collection\sep reference &
incollection\sep inreference\sep suppcollection &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
booktitle\par booksubtitle\par booktitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
proceedings &
inproceedings &
title\par subtitle\par titleaddon\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
booktitle\par booksubtitle\par booktitleaddon\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
periodical &
article\sep suppperiodical &
title\par subtitle\par
shorttitle\par sorttitle\par indextitle\par indexsorttitle &
journaltitle\par journalsubtitle\par
\skip\par \skip\par \skip\par \skip \\\addlinespace
{\normalsize*} & {\normalsize*} & {\normalsize*} & {\normalsize*}\\
\end{longtable}
\endgroup
\section{Default Sorting Templates}
\label{apx:srt}
\subsection[Alphabetic 1]{Alphabetic Templates 1}
\label{apx:srt:a1}
The following table shows the standard alphabetic sorting templates defined by default. Please refer to \secref{use:srt} for explanation.
\begingroup
\sorttablesetup
\begin{longtable}[l]{@{}%
V{0.100\textwidth}@{}%
L{0.100\textwidth}@{}%
L{0.175\textwidth}@{}%
L{0.175\textwidth}@{}%
L{0.150\textwidth}@{}%
L{0.300\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Option} & \multicolumn{5}{@{}H}{Template name} \\
\cmidrule(r){1-1}\cmidrule{2-6}
\endhead
\bottomrule
\endfoot
nty & presort\alt mm &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sorttitle\alt title &
\new sortyear\alt year &
\new volume\\
nyt & presort\alt mm &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sortyear\alt year &
\new sorttitle\alt title &
\new volume\\
nyvt & presort\alt mm &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sortyear\alt year &
\new volume &
\new sorttitle\alt title \\
\textrm{all} & presort\alt mm &
\new sortkey \\
\end{longtable}
\endgroup
\subsection[Alphabetic 2]{Alphabetic Templates 2}
\label{apx:srt:a2}
The following table shows the alphabetic sorting templates for \texttt{alphabetic} styles defined by default. Please refer to \secref{use:srt} for explanation.
\begingroup
\sorttablesetup
\begin{longtable}[l]{@{}%
V{0.100\textwidth}@{}%
L{0.100\textwidth}@{}%
L{0.175\textwidth}@{}%
L{0.175\textwidth}@{}%
L{0.150\textwidth}@{}%
L{0.150\textwidth}@{}%
L{0.150\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Option} & \multicolumn{6}{@{}H}{Template name} \\
\cmidrule(r){1-1}\cmidrule{2-7}
\endhead
\bottomrule
\endfoot
anyt & presort\alt mm &
\new labelalpha &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sortyear\alt year &
\new sorttitle\alt title &
\new volume\\
anyvt & presort\alt mm &
\new labelalpha &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sortyear\alt year &
\new volume &
\new sorttitle\alt title \\
\textrm{all} & presort\alt mm &
\new labelalpha &
\new sortkey \\
\end{longtable}
\endgroup
\subsection[Chronological]{Chronological Templates}
\label{apx:srt:chr}
The following table shows the chronological sorting templates defined by default. Please refer to \secref{use:srt} for explanation.
\begingroup
\sorttablesetup
\begin{longtable}[l]{@{}%
V{0.100\textwidth}@{}%
L{0.100\textwidth}@{}%
L{0.225\textwidth}@{}%
L{0.175\textwidth}@{}%
L{0.400\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Option} & \multicolumn{4}{@{}H}{Template name} \\
\cmidrule(r){1-1}\cmidrule{2-5}
\endhead
\bottomrule
\endfoot
ynt & presort\alt mm &
\new sortyear\alt year \alt 9999 &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sorttitle\alt title \\
ydnt & presort\alt mm &
\new sortyear\note{ (desc.)}\alt year\note{ (desc.)} \alt 9999 &
\new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title &
\new sorttitle\alt title \\
\textrm{all} & presort\alt mm &
\new sortkey \\
\end{longtable}
\endgroup
\section{\biblatexml}
\label{apx:biblatexml}
The \biblatexml\ XML datasource format is designed to be an extensible and modern data source format for \biblatex\ users. There are limitations with \bibtex\ format \file{.bib} files, in particular one might mention UTF-8 support and name formats. \biber\ goes some way to addressing the UTF-8 limitations by using a modified version of the \texttt{btparse} C library but the rather archaic name parsing rules for \bibtex\ are hard-coded and specific to simple Western names.
\biblatexml is an XML format for bibliographic data. When \biber\ either reads or writes \biblatexml\ format datasources, it automatically writes a RelaXNG XML schema for the datasources which is dynamically generated from the active \biblatex\ datamodel. There is no static schema for \biblatexml\ datasources because the allowable fields etc. depend on the data model. The format of \biblatexml\ datasources is relatively self-explanatory---it is usually only necessary to generate a \biblatexml\ datasource from existing \bibtex\ format datasources (using \biber's <tool> mode) in order to understand the format. \biber also allows users to validate \biblatexml\ datasources against the data model generated schema.
Since the \biblatexml\ format is XML and depends on the data model and the data model is extensible by the user (see \secref{aut:ctm:dm}), the \biblatexml\ format can deal with extensions that \bibtex\ format data sources cannot, e.g. new nameparts, options at sub-entry scope. Since it is an XML format, it is relatively easy to transform it into other XML formats or HTML using standard XML processing libraries and tools.
Here is an explanation of the format with examples. By convention, \biblatexml\ files have a \file{.bltxml} extension and \file{kpsewhich} understands this file extension.
\subsection{Header}
\biblatexml\ files begin with the standard XML header:
\begin{lstlisting}[language=xml]
<?xml version="1.0" encoding="UTF-8"?>
\end{lstlisting}
%
The schema model, type and schema type namespace are given in the following line:
\begin{lstlisting}[language=xml]
<?xml-model href="biblatexml.rng"
type="application/xml"
schematypens="http://relaxng.org/ns/structure/1.0"?>
\end{lstlisting}
%
When \biber\ generates \biblatexml\ data sources, it automatically adds this line and points the schema model (href) attribute at the automatically generated RelaXNG XML schema for ease of validation.
\subsection{Body}
The body of a \biblatexml\ data source looks like:
\begin{lstlisting}[language=xml]
<bltx:entries
xmlns:bltx="http://biblatex-biber.sourceforge.net/biblatexml">
<bltx:entry id="" entrytype="">
</bltx:entry>
.
.
.
<bltx:entry id="" entrytype="">
</bltx:entry>
</bltx:entries>
\end{lstlisting}
%
The body is one or more \bibfield{entry} elements inside the top-level \bibfield{entries} element and everything is in the \bibfield{bltx} namespace. An entry has an \bibfield{id} attribute corresponding to a \bibtex\ entry key and a \bibfield{entrytype} attribute corresponding to a \bibtex\ entrytype. For example, the \biblatexml\
\begin{lstlisting}[language=xml]
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="biblatexml.rng"
type="application/xml"
schematypens="http://relaxng.org/ns/structure/1.0"?>
<bltx:entries
xmlns:bltx="http://biblatex-biber.sourceforge.net/biblatexml">
<bltx:entry id="key1" entrytype="book">
</bltx:entry>
</bltx:entries>
\end{lstlisting}
%
Corresponds to the \bibtex\ \file{.bib}
\begin{lstlisting}[style=bibtex]{}
@book{key1,
}
\end{lstlisting}
%
In general, the XML elements in a \biblatexml\ format datasource file have names corresponding to the fields in the datamodel, just like \bibtex\ format datasources. So for example, the \bibtex\ format source
\begin{lstlisting}[style=bibtex]{}
@book{key1,
TITLE = {...},
ISSUE = {...},
NOTE = {...}
}
\end{lstlisting}
%
would be, in \biblatexml
\begin{lstlisting}[language=xml]
<bltx:entry id="key1" entrytype="book">
<bltx:title>...</bltx:title>
<bltx:issue>...</bltx:issue>
<bltx:note>...</bltx:note>
</bltx:entry>
\end{lstlisting}
%
The following exceptions to this simple mapping are to be noted
\subsubsection{Key aliases}
Citation key aliases are specified like this:
\begin{lstlisting}[language=xml]
<bltx:ids>
<bltx:key>alias1</bltx:key>
<bltx:key>alias2</bltx:key>
</bltx:ids>
\end{lstlisting}
%
this corresponds to the \bibtex\ format
\begin{lstlisting}[style=bibtex]{}
@book{key1,
IDS = {alias1,alias2}
}
\end{lstlisting}
\subsubsection{Names}
Name specifications in \biblatexml\ are somewhat more complex in order to generalise the name handling abilities of \biblatex. The user has to be more explicit about the name parts and this allows a much great scope for the handling of different types of names and name parts. A name in \biblatexml\ format looks like this
\begin{lstlisting}[language=xml]
<bltx:names type="author" morenames="1" useprefix="true">
<bltx:name gender="sm">
<bltx:namepart type="given">
<bltx:namepart initial="J">John</bltx:namepart>
<bltx:namepart initial="A">Arthur</bltx:namepart>
</bltx:namepart>
<bltx:namepart type="family">Smith</bltx:namepart>
<bltx:namepart type="prefix" initial="v">von</bltx:namepart>
</bltx:name>
<bltx:name useprefix="false">
<bltx:namepart type="given">
<bltx:namepart>Raymond</bltx:namepart>
</bltx:namepart>
<bltx:namepart type="family">Brown</bltx:namepart>
</bltx:name>
</bltx:names>
\end{lstlisting}
%
A name list field is contained in the \bibfield{names} element with the mandatory \bibfield{type} attribute giving the name of the name list. Things to note:
\begin{itemize}
\item The optional \bibfield{morenames} attribute performs the same task as the \bibtex\ datasource format <and others> string at the end of a name.
\item Note that optional \opt{useprefix} option can be specified at the level of a name list or an individual name in the name list. This is impossible with \bibtex\ datasources.
\item Individual names may have an optional \bibfield{gender} attribute which must be one of those defined in the datamodel <gender> constant list. This is currently not used by standard styles but is available in \biblatex name formats if necessary.
\item A name list is composed of one or more \bibfield{name} elements.
\item Each name is composed of name parts of a \bibfield{type} defined by the data model <nameparts> constant.
\item Each name part may have an option \bibfield{initial} attribute which makes explicit the initial of the name part. If this is not present, \biber\ attempts to automatically determine the initial from the name part.
\item Name parts may have name parts so that compound names can be handled.
\end{itemize}
%
Ignoring the \biblatexml-only features, a corresponding \bibtex\ format datasource would look like this:
\begin{lstlisting}[style=bibtex]{}
AUTHOR = {von Smith, John Arthur and Brown, Raymond and others}
\end{lstlisting}
\subsubsection{Lists}
Datasource list fields (see \secref{bib:fld:typ}) can be represented in two ways, depending on whether there is more than one element in the list:
\begin{lstlisting}[language=xml]
<bltx:publisher>London</bltx:publisher>
<bltx:location>
<bltx:item>London</bltx:item>
<bltx:item>Moscow</bltx:item>
</bltx:location>
\end{lstlisting}
\subsubsection{Ranges}
Datasource range fields (see \secref{bib:fld:typ}) are represented like this:
\begin{lstlisting}[language=xml]
<bltx:pages>
<bltx:item>
<bltx:start>1</bltx:start>
<bltx:end>10</bltx:end>
</bltx:item>
<bltx:item>
<bltx:start>30</bltx:start>
<bltx:end>34</bltx:end>
</bltx:item>
</bltx:pages>
\end{lstlisting}
%
A range field is a list of ranges, each with its own \bibfield{item}. A range item has a \bibfield{start} element and an optional \bibfield{end} element, since ranges can be open-ended.
\subsubsection{Dates}
Datasource date fields (see \secref{bib:fld:typ}) can be represented in two ways, depending on whether they constitute a date range:
\begin{lstlisting}[language=xml]
<bltx:date>1985-04-02</bltx:date>
<bltx:date type="event">
<bltx:start>1990-05-16</bltx:start>
<bltx:end>1990-05-17</bltx:end>
</bltx:date>
\end{lstlisting}
%
The \bibfield{type} attribute on a date element corresponds to a particular type of date defined in the data model.
\subsubsection{Related Entries}
Related entries are specified as follows:
\begin{lstlisting}[language=xml]
<bltx:related>
<bltx:item type="reprint"
ids="rel1,rel2"
string="Somestring"
options="skipbiblist"/>
</bltx:related>
\end{lstlisting}
%
This corresponds to the \bibtex\ format:
\begin{lstlisting}[style=bibtex]{}
@book{key1,
RELATED = {rel2,rel2},
RELATEDTYPE = {reprint},
RELATEDSTRING = {Somestring},
RELATEDOPTIONS = {skipbiblist}
}
\end{lstlisting}
%
As per \secref{aut:ctm:rel}, the \bibfield{string} and \bibfield{options} attributes are optional.
\section{Option Scope}
\label{apx:opt}
The following table provides an overview of the scope of various options.
Per-entry, per-namelist and per-name options are set in the datasource, for
example, in a \file{.bib}file. See the \biber documentation for details
but here are a few examples. Per-entry:
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
OPTIONS = {sortingnamekeytemplatename=template1},
}
\end{lstlisting}
%
Per-namelist and per-name options require either the \biblatexml datasource
format or the extend \bibtex name format supported by \biber (see the
\biber documentation for details). Per-namelist:
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
AUTHOR = {sortingnamekeytemplatename=template1 and Arthur Smith and Bill Brown},
}
\end{lstlisting}
%
Per-name:
\begin{lstlisting}[style=bibtex]{}
@BOOK{key,
AUTHOR = {sortingnamekeytemplatename=template1, family=Smith, given=Arthur and Bill Brown},
}
\end{lstlisting}
\begingroup
\tablesetup
\let\+\tickmarkyes
\let\_\tickmarkno
\begin{longtable}[l]{@{}%
V{0.3\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}%
C{0.1\textwidth}@{}}
\toprule
\multicolumn{1}{@{}H}{Option} &
\multicolumn{7}{@{}H}{Scope} \\
\cmidrule{2-8}
& \multicolumn{1}{@{}H}{Load-time} &
\multicolumn{1}{@{}H}{Global} &
\multicolumn{1}{@{}H}{Per-refcontext} &
\multicolumn{1}{@{}H}{Per-type} &
\multicolumn{1}{@{}H}{Per-entry} &
\multicolumn{1}{@{}H}{Per-namelist} &
\multicolumn{1}{@{}H}{Per-name} \\
\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule(r){4-4}\cmidrule(r){5-5}\cmidrule(r){6-6}\cmidrule(r){7-7}\cmidrule(r){8-8}
\endhead
\bottomrule
\endfoot
abbreviate &\+&\+&\_&\+&\+&\_&\_\\
alldates &\+&\+&\_&\_&\_&\_&\_\\
alldatesusetime &\+&\+&\_&\_&\_&\_&\_\\
alltimes &\+&\+&\_&\_&\_&\_&\_\\
arxiv &\+&\+&\_&\_&\_&\_&\_\\
autocite &\+&\+&\_&\_&\_&\_&\_\\
autopunct &\+&\+&\_&\_&\_&\_&\_\\
autolang &\+&\+&\_&\_&\_&\_&\_\\
backend &\+&\_&\_&\_&\_&\_&\_\\
backref &\+&\+&\_&\_&\_&\_&\_\\
backrefsetstyle &\+&\+&\_&\_&\_&\_&\_\\
backrefstyle &\+&\+&\_&\_&\_&\_&\_\\
bibencoding &\+&\+&\_&\_&\_&\_&\_\\
bibstyle &\+&\_&\_&\_&\_&\_&\_\\
bibtexcaseprotection &\+&\+&\_&\+&\+&\_&\_\\
bibwarn &\+&\+&\_&\_&\_&\_&\_\\
block &\+&\+&\_&\_&\_&\_&\_\\
casechanger &\+&\_&\_&\_&\_&\_&\_\\
citecounter &\+&\+&\_&\_&\_&\_&\_\\
citereset &\+&\+&\_&\_&\_&\_&\_\\
citestyle &\+&\_&\_&\_&\_&\_&\_\\
citetracker &\+&\+&\_&\+&\+&\_&\_\\
clearlang &\+&\+&\_&\+&\+&\_&\_\\
datamodel &\+&\_&\_&\_&\_&\_&\_\\
dataonly &\+&\+&\_&\+&\+&\_&\_\\
date &\+&\+&\_&\_&\_&\_&\_\\
labeldate &\+&\+&\_&\_&\_&\_&\_\\
$<$datetype$>$date &\+&\+&\_&\_&\_&\_&\_\\
dateabbrev &\+&\+&\_&\+&\+&\_&\_\\
datecirca &\+&\+&\_&\_&\_&\_&\_\\
dateera &\+&\+&\_&\_&\_&\_&\_\\
dateerauto &\+&\+&\_&\_&\_&\_&\_\\
dateuncertain &\+&\+&\_&\_&\_&\_&\_\\
datezeros &\+&\+&\_&\_&\_&\_&\_\\
defernumbers &\+&\+&\_&\_&\_&\_&\_\\
doi &\+&\+&\_&\+&\+&\_&\_\\ % style
eprint &\+&\+&\_&\+&\+&\_&\_\\ % style
$<$namepart$>$inits &\+&\+&\_&\+&\+&\+&\+\\
gregorianstart &\+&\+&\_&\_&\_&\_&\_\\
hyperref &\+&\+&\_&\_&\_&\_&\_\\
ibidtracker &\+&\+&\_&\+&\+&\_&\_\\
idemtracker &\+&\+&\_&\+&\+&\_&\_\\
indexing &\+&\+&\_&\+&\+&\_&\_\\
isbn &\+&\+&\_&\+&\+&\_&\_\\ % style
julian &\+&\+&\_&\_&\_&\_&\_\\
labelalpha &\+&\+&\_&\+&\+&\_&\_\\
labelalphanametemplatename &\_&\_&\+&\_&\+&\+&\+\\
labelnamefield &\_&\_&\_&\_&\+&\_&\_\\
labelnumber &\+&\+&\_&\+&\+&\_&\_\\
labeltitle &\+&\+&\_&\+&\+&\_&\_\\
labeltitlefield &\_&\_&\_&\_&\+&\_&\_\\
labeltitleyear &\+&\+&\_&\+&\+&\_&\_\\
labeldateparts &\+&\+&\_&\+&\+&\_&\_\\
labeltime &\+&\+&\_&\_&\_&\_&\_\\
labeldateusetime &\+&\+&\_&\_&\_&\_&\_\\
labelprefix &\_&\_&\+&\_&\_&\_&\_\\
$<$datetype$>$time &\+&\+&\_&\_&\_&\_&\_\\
$<$datetype$>$dateusetime &\+&\+&\_&\_&\_&\_&\_\\
language &\+&\+&\_&\_&\_&\_&\_\\
loadfiles &\+&\+&\_&\_&\_&\_&\_\\
loccittracker &\+&\+&\_&\+&\+&\_&\_\\
maxalphanames &\+&\+&\_&\+&\+&\_&\_\\
maxbibnames &\+&\+&\_&\+&\+&\_&\_\\
maxcitenames &\+&\+&\_&\+&\+&\_&\_\\
maxsortnames &\+&\+&\_&\+&\+&\_&\_\\
maxitems &\+&\+&\_&\+&\+&\_&\_\\
maxnames &\+&\+&\_&\+&\+&\_&\_\\
maxparens &\+&\+&\_&\_&\_&\_&\_\\
mcite &\+&\_&\_&\_&\_&\_&\_\\
minalphanames &\+&\+&\_&\+&\+&\_&\_\\
minbibnames &\+&\+&\_&\+&\+&\_&\_\\
mincitenames &\+&\+&\_&\+&\+&\_&\_\\
minsortnames &\+&\+&\_&\+&\+&\_&\_\\
mincrossrefs &\+&\+&\_&\_&\_&\_&\_\\
minxrefs &\+&\+&\_&\_&\_&\_&\_\\
minitems &\+&\+&\_&\+&\+&\_&\_\\
minnames &\+&\+&\_&\+&\+&\_&\_\\
nametemplates &\_&\_&\+&\_&\+&\+&\+\\
natbib &\+&\_&\_&\_&\_&\_&\_\\
nohashothers &\+&\+&\_&\+&\+&\+&\_\\
nosortothers &\+&\+&\_&\+&\+&\+&\_\\
noinherit &\_&\_&\_&\_&\+&\_&\_\\
notetype &\+&\+&\_&\_&\_&\_&\_\\
opcittracker &\+&\+&\_&\+&\+&\_&\_\\
openbib &\+&\+&\_&\_&\_&\_&\_\\
pagetracker &\+&\+&\_&\_&\_&\_&\_\\
parentracker &\+&\+&\_&\_&\_&\_&\_\\
punctfont &\+&\+&\_&\_&\_&\_&\_\\
refsection &\+&\+&\_&\_&\_&\_&\_\\
refsegment &\+&\+&\_&\_&\_&\_&\_\\
related &\+&\+&\_&\+&\+&\_&\_\\ % style
safeinputenc &\+&\+&\_&\_&\_&\_&\_\\
seconds &\+&\+&\_&\_&\_&\_&\_\\
singletitle &\+&\+&\_&\+&\+&\_&\_\\
skipbib &\+&\+&\_&\+&\+&\_&\_\\
skipbiblist &\+&\+&\_&\+&\+&\_&\_\\
skiplab &\+&\+&\_&\+&\+&\_&\_\\
sortcase &\+&\+&\_&\_&\_&\_&\_\\
sortcites &\+&\+&\_&\_&\_&\_&\_\\
sorting &\+&\+&\_&\_&\_&\_&\_\\
sortingnamekeytemplatename &\_&\_&\+&\_&\+&\+&\+\\
sortlocale &\+&\+&\_&\_&\_&\_&\_\\
sortlos &\+&\+&\_&\_&\_&\_&\_\\
sortupper &\+&\+&\_&\_&\_&\_&\_\\
style &\+&\_&\_&\_&\_&\_&\_\\
terseinits &\+&\+&\_&\+&\+&\+&\+\\
texencoding &\+&\+&\_&\_&\_&\_&\_\\
timezeros &\+&\+&\_&\_&\_&\_&\_\\
timezones &\+&\+&\_&\_&\_&\_&\_\\
uniquelist &\+&\+&\_&\+&\+&\+&\_\\
uniquename &\+&\+&\_&\+&\+&\+&\+\\
uniquenametemplatename &\_&\_&\+&\_&\+&\+&\+\\
uniquetitle &\+&\+&\_&\+&\+&\_&\_\\
uniquebaretitle &\+&\+&\_&\+&\+&\_&\_\\
uniquework &\+&\+&\_&\+&\+&\_&\_\\
uniqueprimaryauthor &\+&\+&\_&\+&\+&\_&\_\\
url &\+&\+&\_&\+&\+&\_&\_\\ % style
useprefix &\+&\+&\_&\+&\+&\+&\+\\
use$<$name$>$ &\+&\+&\_&\+&\+&\_&\_\\
\end{longtable}
\endgroup
\section{Revision History}
\label{apx:log}
This revision history is a list of changes relevant to users of this package. Changes of a more technical nature which do not affect the user interface or the behavior of the package are not included in the list. More technical details are to be found in the \file{CHANGES.md} file. The numbers on the right indicate the relevant section of this manual.
\begin{changelog}
\begin{release}{3.15a}{2020-08-23}
\item Fixed bug with long arguments in \cmd{DeclareFieldFormat} and friends
\end{release}
\begin{release}{3.15}{2020-08-16}
\item Added \opt{starnocited} option to sourcemaps\see{aut:ctm:map}
\item Added the \opt{glob} option to \cmd{addbibresource}\see{use:bib:res}
\item Added \bibfield{eid} to more entry types\see{bib:typ:blx}
\item Added \cmd{bibeidpunct}\see{use:fmt:fmt}
\item Added \bibfield{issuetitleaddon} and \bibfield{journaltitleaddon}\see{bib:fld:dat}
\item \texttt{numeric-comp} compresses \opt{subentry} set references now\see{use:opt:pre:bbx}
\item Added \opt{subentrycomp} to \texttt{numeric-comp} style\see{use:opt:pre:bbx}
\item Added \cmd{multiciterangedelim}, \cmd{multicitesubentrydelim},
\cmd{multicitesubentryrangedelim}, \cmd{superciterangedelim},
\cmd{supercitesubentrydelim}, \cmd{supercitesubentryrangedelim}%
\see{use:fmt:fmt}
\item Implemented \opt{expl3} case changing functions\see{aut:aux:msc}
\item Added \opt{casechanger} option\see{use:opt:ldt}
\item Added \opt{bibtexcaseprotection} option\see{use:opt:pre:gen}
\item Added \cmd{mautocite} and \cmd{Mautocite}\see{use:cit:mct}
\item Added \opt{trackfloats} and \opt{backreffloats}\see{use:opt:pre:gen}
\item Added \opt{block} option to \cmd{printbibliography} and friends\see{use:bib:bib}
\item Added \cmd{NumsCheckSetup} and \cmd{PagesCheckSetup}\see{aut:aux:msc}
\item Added \cmd{AtEveryEntrykey}\see{aut:fmt:hok}
\item Added \cmd{ifdatesequal} and \cmd{ifdaterangesequal}\see{aut:aux:tst}
\item Clarified \cmd{ifuniqueprimaryauthor} semantics\see{aut:aux:tst}
\item Added \cmd{bibncpstring}, \cmd{bibncplstring} and \cmd{bibncpsstring}\see{aut:str}
\item Added Lithuanian localisation (Valdemaras Klumbys)
\item Added Serbian localisation (Andrej Radović)
\item Added Turkish localisation (Abdulkerim Gok)
\item Added file hooks\see{aut:fmt:hok:fil}
\item Deprecated \cmd{ifkomabibtotoc} and \cmd{ifkomabibtotocnumbered}\see{use:cav:scr}
\end{release}
\begin{release}{3.14}{2019-12-01}
\item Added new mapping verbs for citation sources\see{aut:ctm:map}
\item Added documentation for new \biber granular \bibtype{xdata} functionality\see{use:use:xdat}
\item Enhanced \sty{polyglossia} support
\end{release}
\begin{release}{3.13a}{2019-08-31}
\item Bugfix release
\end{release}
\begin{release}{3.13}{2019-08-17}
\item Added new \bibtype{dataset} entry type\see{bib:typ:blx}
\item Promoted \bibtype{software} to regular entry type\see{bib:typ:blx}
\item Added \bibfield{entrykey} alias for entry keys in labels\see{aut:ctm:lab}
\item Added \opt{appendstrict} sourcemapping option\see{aut:ctm:map}
\item Added \opt{nohashothers} and \opt{nosortothers}\see{use:opt:pre:int}
\item Enhanced \cmd{addbibresource} with globbing\see{use:bib:res}
\item Added \cmd{DeclareBiblatexOption}\see{aut:bbx:bbx}
\item Expanded scope possibilities for several options\see{apx:opt}
\item Added \cmd{ifvolcite} test\see{aut:aux:tst}
\item Added special fields \bibfield{volcitevolume} and \bibfield{volcitepages}%
\see{aut:cbx:fld}
\item Added \cmd{AtVolcite} hook\see{aut:fmt:hok}
\item Added \cmd{pnfmt} \see{use:cit:msc}
\item Added \cmd{mkbibcompletename} and \cmd{mkbibcompletename<formatorder>}\see{use:fmt:fmt}
\item Made \cmd{postnotedelim} and friends context sensitive\see{use:fmt:fmt}
\item Added \cmd{multipostnotedelim} and \cmd{multiprenotedelim}\see{use:fmt:fmt}
\item Added \cmd{thefirstlistitem} and friends\see{aut:aux:dat}
\item Added \prm{itempostpro} argument to \cmd{mkcomprange}, \cmd{mknormrange} and \cmd{mkfirstpage}\see{aut:aux:msc}
\item Added \len{biburlbigskip} and friends\see{use:fmt:len}
\item Added \cnt{biburlbigbreakpenalty} and \cnt{biburlbreakpenalty} and friends\see{use:fmt:len}
\item Added \cmd{DeclarePrintbibliographyDefaults}\see{use:bib:bib}
\item Added \bibfield{doi} to \bibtype{online}\see{bib:typ:blx}
\end{release}
\begin{release}{3.12}{2018-10-30}
\item Added literal and named annotation functionality\see{use:annote}
\item Added \cmd{ifnocite}\see{aut:aux:tst}
\item Added case-insensitive versions of matching operators\see{aut:ctm:map}
\item Added \bibfield{langid}s optional argument to \cmd{DeclareSortTranslit}\see{aut:ctm:srt}
\item Added \opt{noroman} option\see{use:opt:pre:int}
\item Changed \bibfield{sortyear} to an integer field\see{bib:fld:spc}
\item Added \bibfield{extraname}\see{aut:bbx:fld:lab}
\item Added \opt{bibencoding} option to \cmd{addbibresource}\see{use:bib:res}
\item Changed type of \bibfield{number} from integer to literal \see{bib:fld:dat}
\item Removed \opt{noerroretextools} option\see{int:pre:inc}
\item Added \opt{maxsortnames} and \opt{minsortnames}\see{use:opt:pre:gen}
\item Added \cmd{DeprecateFieldFormatWithReplacement} and friends\see{aut:bib:fmt}
\item Added list and name wrappers\see{aut:bib:fmt}
\item Added \cs{ifdateyearsequal}\see{aut:aux:tst}
\item Added <and higher> sectioning values for \opt{citereset}, \opt{refsection} and \opt{refsegment} options\see{use:opt:pre:gen}
\item Added Hungarian localisation\see{use:loc:hun}
\item Added \cmd{DeclareCitePunctuationPosition}\see{aut:cbx:cbx}
\end{release}
\begin{release}{3.11}{2018-02-20}
\item Added \opt{entrynocite} option to sourcemapping\see{aut:ctm:map}
\item Added \opt{driver} and \opt{biblistfilter} options to \cmd{printbiblist}\see{use:bib:biblist}
\item Added \cmd{mknormrange}\see{aut:aux:msc}
\item Added \cmd{ifdateannotation}\see{use:annote}
\item Extended \cmd{iffieldannotation} and friends\see{use:annote}
\item Changed \cmd{DeclareSourcemap} so that it can be used multiple times\see{aut:ctm:map}
\item Added Latvian localisation (Rihards Skuja)
\item Added \opt{locallabelwidth} option\see{use:opt:pre:gen}
\end{release}
\begin{release}{3.10}{2017-12-19}
\item Changed \opt{edtf} to \opt{iso}\see{use:opt:pre:gen}
\item Added \opt{noerroretextools} option\see{int:pre:inc}
\end{release}
\begin{release}{3.9}{2017-11-21}
\item Added \cmd{iffieldplusstringbibstring}\see{aut:aux:tst}
\item Fixed \cmd{mkpagetotal}\see{aut:aux:msc}
\end{release}
\begin{release}{3.8}{2017-11-04}
\item Added \kvopt{hyperref}{manual} option\see{use:opt:pre:gen}
\item Added field \bibfield{extradatescope}\see{aut:bbx:fld:lab}
\item Added \cmd{DeclareExtradate}\see{aut:ctm:fld}
\item Added \cmd{DeprecateFieldWithReplacement}, \cmd{DeprecateListWithReplacement} and \cmd{DeprecateNameWithReplacement}\see{aut:bib:dat}
\item Added \cmd{letbibmacro}\see{aut:aux:msc}
\item Renamed \opt{extrayear} to \opt{extradate}\see{aut:bbx:fld:lab}
\item Added \opt{sortsets} global option\see{use:opt:pre:gen}
\item Added \cmd{iflabelalphanametemplatename} and \cmd{uniquenametemplatename}\see{aut:aux:tst}
\item Renamed \cmd{ifsortingnamescheme} to \cmd{ifsortingnamekeytemplatename}\see{aut:aux:tst}
\item Renamed \opt{sortingnamekeyscheme} to \opt{sortingnamekeytemplate}\see{use:bib:context}
\item Renamed \cmd{DeclareSortingNamekeyScheme} to \cmd{DeclareSortingNamekeyTemplate}\see{aut:ctm:srt}
\item Renamed \cmd{DeclareSortingScheme} to \cmd{DeclareSortingTemplate}\see{aut:ctm:srt}
\item Changes to \cmd{DeclareUniquenameTemplate} and \cmd{DeclareLabelalphaNameTemplate} scopes\see{aut:cav:amb} and \see{aut:ctm:lab}
\item Added new \opt{disambiguation} option to \cmd{DeclareUniquenameTemplate}\see{aut:cav:amb}
\item Added new user-facing versions of some entry-querying commands\see{use:eq}
\item Changed \bibfield{origlanguage} to a list in line with \bibfield{language}\see{bib:fld:dat}
\item Deprecated \bibfield{childentrykey} and \bibfield{childentrytype}\see{aut:bbx:fld:gen}
\item Added \bibfield{bibnamehash} and name list specific variants\see{aut:bbx:fld:gen}
\item Added ALA-LC Russian romanisation transliteration support\see{aut:ctm:srt}
\item Added \bibfield{urlraw}\see{aut:bbx:fld:gen}
\item Added \cmd{AtUsedriver}\see{aut:fmt:hok}
\item Added Bulgarian localisation (Kaloyan Ganev)
\item \bibfield{sortyear} is now a literal, not an integer\see{bib:fld:spc}
\item Added \cmd{DeclareLanguageMappingSuffix}\see{aut:lng:cmd}
\item Changed default for \cmd{DeclarePrefChars}\see{aut:pct:cfg}
\item Added \cmd{authortypedelim}, \cmd{editortypedelim} and \cmd{translatortypedelim}\see{use:fmt:fmt}
\item Added \cmd{DeclareDelimAlias}\see{use:fmt:csd}
\item Added \opt{slovenian} as alias for \opt{slovene} due to Polyglossia
name for the language\see{bib:fld:spc}
\item Added Ukrainian localisation (Sergiy M. Ponomarenko)
\end{release}
\begin{release}{3.7}{2016-12-08}
\item Corrected default for \cmd{bibdateeraprefix}\see{aut:fmt:lng}
\item Added \cmd{DeclareSortInclusion}\see{aut:ctm:srt}
\item Added \cmd{relateddelim$<$relatedtype$>$}\see{use:fmt:fmt}
\end{release}
\begin{release}{3.6}{2016-09-15}
\item Corrected some documentation and fixed a bug with labeldate
localisation strings.
\end{release}
\begin{release}{3.5}{2016-09-10}
\item Added \cmd{ifuniquebaretitle} test\see{aut:aux:tst}
\item Documented \cmd{labelnamesource} and \cmd{labeltitlesource}\see{aut:bbx:fld:gen}
\item Added \cmd{bibdaterangesep}\see{use:fmt:lng}
\item Added \opt{refsection} option to \cmd{DeclareSourcemap}\see{aut:ctm:map}
\item Added \opt{suppress} option to inheritance specifications\see{aut:ctm:ref}
\item Added \cmd{ifuniquework}\see{aut:aux:tst}
\item Changed \cmd{DeclareStyleSourcemap} so that it can be used multiple times\see{aut:ctm:map}
\item Added \cmd{forcezerosy} and \cmd{forcezerosmdt}\see{aut:fmt:ich}
\item Changed \cmd{mkdatezeros} to \cmd{mkyearzeros}, \cmd{mkmonthszeros}
and \cmd{mkdayzeros}\see{aut:fmt:ich}
\item Added \bibfield{namehash} and \bibfield{fullhash} for all name list fields\see{aut:bbx:fld:gen}
\item Generalised \opt{giveninits} option to all nameparts\see{use:opt:pre:int}
\item Added \opt{inits} option to \cmd{DeclareSortingNamekeyScheme}\see{aut:ctm:srt}
\item Removed option \opt{sortgiveninits}. Use the option \opt{inits} to \cmd{DeclareSortingNamekeyScheme} instead
\item Added \cmd{DeclareLabelalphaNameTemplate}\see{aut:ctm:lab}
\item Added full \acr{EDTF} Levels 0 and 1 compliance for parsing and printing times\see{bib:use:dat}
\item Changed dates to be fully \acr{EDTF} Levels 0 and 1 compliant. Associated tests and localisation strings\see{bib:use:dat}
\item Added \opt{timezeros}\see{use:opt:pre:gen}
\item Added \opt{mktimezeros}\see{aut:fmt:ich}
\item Changed \opt{iso8601} to \opt{edtf}\see{use:opt:pre:gen}
\item Added \cmd{DeclareUniquenameTemplate}\see{aut:cav:amb}
\item Removed experimental RIS support
\item \opt{sortnamekeyscheme} and \opt{useprefix} can be now be set per-namelist and per-name for
\bibtex datasources\see{aut:ctm:srt}
\item Added \cmd{DeclareDelimcontextAlias}\see{use:fmt:csd}
\item Added Estonian localisation (Benson Muite)
\item Reference contexts may now be named\see{use:bib:context}
\item Added \opt{notfield} step in Sourcemaps\see{aut:ctm:map}
\end{release}
\begin{release}{3.4}{2016-05-10}
\item Added \cmd{ifcrossrefsource} and \cmd{ifxrefsource}\see{aut:aux:tst}
\item Added data annotation feature\see{use:annote}
\item Added package option \opt{minxrefs}\see{use:opt:pre:gen}
\item Added \cmd{ifuniqueprimaryauthor} and associated global option\see{aut:aux:tst}
\item Added \cmd{DeprecateField}, \cmd{DeprecateList} and \cmd{DeprecateName}\see{aut:bib:dat}
\item Added \cmd{ifcaselang}\see{aut:aux:tst}
\item Added \cmd{DeclareSortTranslit}\see{aut:ctm:srt}
\item Added \opt{uniquetitle} test\see{aut:aux:tst}
\item Added \cmd{namelabeldelim}\see{use:fmt:fmt}
\item New starred variants of the \cmd{assignrefcontext*} macros\see{use:bib:context}
\item New context-sensitive delimiter interface\see{use:fmt:csd}
\item Moved \opt{prefixnumbers} option to \cmd{newrefcontext} and renamed to \opt{labelprefix}\see{use:bib:context}
\item Added \cmd{DeclareDatafieldSet}\see{aut:ctm:dsets}
\end{release}
\begin{release}{3.3}{2016-03-01}
\item New macros for auto-assignment of refcontexts\see{use:bib:context}
\item Schema documentation for \biblatexml\see{apx:biblatexml}
\item Sourcemapping documentation and examples for \biblatexml\see{aut:ctm:map}
\item Changes for name formats to generalise available name parts\see{aut:bib:fmt}
\item \opt{useprefix} can now be specified per-namelist and per-name in \biblatexml datasources
\item New sourcemapping options for creating new entries dynamically and looping over map steps\see{aut:ctm:map}
\item Added \opt{noalphaothers} and enhanced name range selection in \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
\item Added \cmd{DeclareDatamodelConstant}\see{aut:ctm:dm}
\item Renamed \opt{firstinits} to \opt{giveninits} and \opt{sortfirstinits} to \opt{sortgiveninits}\see{use:opt:pre:int}
\item Added \cmd{DeclareSortingNamekeyScheme}\see{aut:ctm:srt}
\item Removed messy experimental endnote and zoterordf support for \biber
\item Added \cmd{nonameyeardelim}\see{use:fmt:fmt}
\item Added \cmd{extpostnotedelim}\see{use:fmt:fmt}
\end{release}
\begin{release}{3.2}{2015-12-28}
\item Added \opt{pstrwidth} and \opt{pcompound} to \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
\item Added \cmd{AtEachCitekey}\see{aut:fmt:hok}
\end{release}
\begin{release}{3.1}{2015-09}
\item Added \cmd{DeclareNolabel}\see{aut:ctm:lab}
\item Added \cmd{DeclareNolabelwidthcount}\see{aut:ctm:lab}
\end{release}
\begin{release}{3.0}{2015-04-20}
\item Improved Danish (Jonas Nyrup) and Spanish (ludenticus) translations
\item \bibfield{labelname} and \bibfield{labeltitle} are now resolved by \biblatex instead of \biber for more flexibility and future extensibility
\item New \cmd{entryclone} sourcemap verb for cloning entries during sourcemapping\see{aut:ctm:map}
\item New \cmd{pernottype} negated per-type sourcemap verb\see{aut:ctm:map}
\item New range calculation command \cmd{frangelen}\see{aut:aux:msc}
\item New bibliography context functionality\see{use:bib:context}
\item Name lists in the data model now automatically create internals for \cmd{ifuse$<$name$>$} tests and booleans\see{use:opt:bib:hyb} and \see{aut:aux:tst}
\end{release}
\begin{release}{2.9a}{2014-06-25}
\item \texttt{resetnumbers} now allows passing a number to reset to\see{use:bib:bib}
\end{release}
\begin{release}{2.9}{2014-02-25}
\item Generalised shorthands facility\see{use:bib:biblist}
\item Sorting locales can now be defined as part of a sorting scheme\see{aut:ctm:srt}
\item Added \bibfield{sortinithash}\see{aut:bbx:fld:gen}
\item Added Slovene localisation (Tea Tušar and Bogdan Filipič)
\item Added \cmd{mkbibitalic}\see{aut:fmt:ich}
\item Recommend \texttt{begentry} and \texttt{finentry} bibliography macros\see{aut:bbx:drv}
\end{release}
\begin{release}{2.8a}{2013-11-25}
\item Split option \opt{language=auto} into \opt{language=autocite} and \opt{language=autobib}\see{use:opt:pre:gen}
\end{release}
\begin{release}{2.8}{2013-10-21}
\item New \bibfield{langidopts}\see{bib:fld:spc}
\item \bibfield{hyphenation} field renamed to \bibfield{langid}\see{bib:fld:spc}
\item \sty{polyglossia} support
\item Renamed \opt{babel} option to \opt{autolang}\see{use:opt:pre:gen}
\item Corrected Dutch localisation
\item Added \opt{datelabel=year} option\see{use:opt:pre:gen}
\item Added \bibfield{datelabelsource} field\see{aut:bbx:fld:gen}
\end{release}
\begin{release}{2.7a}{2013-07-14}
\item Bugfix - respect maxnames and uniquelist in \cmd{finalandsemicolon}
\item Corrected French localisation
\end{release}
\begin{release}{2.7}{2013-07-07}
\item Added field \bibfield{eventtitleaddon} to default datamodel and styles\see{bib:fld:dat}
\item Added \cmd{ifentryinbib}, \cmd{iffirstcitekey} and \cmd{iflastcitekey}\see{aut:aux:tst}
\item Added \bibfield{postpunct} special field, documented \bibfield{multiprenote} and \bibfield{multipostnote} special fields\see{aut:cbx:fld}
\item Added \cmd{UseBibitemHook}, \cmd{AtEveryMultiCite}, \cmd{AtNextMultiCite}, \cmd{UseEveryCiteHook}, \cmd{UseEveryCitekeyHook}, \cmd{UseEveryMultiCiteHook}, \cmd{UseNextCiteHook}, \cmd{UseNextCitekeyHook}, \cmd{UseNextMultiCiteHook}, \cmd{DeferNextCitekeyHook}\see{aut:fmt:hok}
\item Fixed \cmd{textcite} and related commands in the numeric and verbose styles\see{use:cit:cbx}
\item Added multicite variants of \cmd{volcite} and related commands\see{use:cit:spc}
\item Added \cmd{finalandsemicolon}\see{use:fmt:lng}
\item Added citation delimiter \cmd{textcitedelim} for \cmd{textcite} and related commands to styles\see{aut:fmt:fmt}
\item Updated Russian localisation (Oleg Domanov)
\item Fixed Brazilian and Finnish localisation
\end{release}
\begin{release}{2.6}{2013-04-30}
\item Added \cmd{printunit}\see{aut:pct:new}
\item Added field \bibfield{clonesourcekey}\see{aut:bbx:fld:gen}
\item New options for \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
\item Added \cmd{DeclareLabeldate} and retired \cmd{DeclareLabelyear}\see{aut:ctm:fld}
\item Added \texttt{nodate} localisation string\see{aut:lng:key:msc}
\item Added \cmd{rangelen}\see{aut:aux:msc}
\item Added starred variants of \cmd{citeauthor} and \cmd{Citeauthor}\see{use:cit:txt}
\item Restored original \texttt{url} format. Added \texttt{urlfrom} localisation key\see{aut:lng:key:lab}
\item Added \cmd{AtNextBibliography}\see{aut:fmt:hok}
\item Fixed related entry processing to allow nested and cyclic related entries
\item Added Croatian localisation (Ivo Pletikosić)
\item Added Polish localisation (Anastasia Kandulina, Yuriy Chernyshov)
\item Fixed Catalan localisation
\item Added smart ``of'' for titles to Catalan and French localisation
\item Misc bug fixes
\end{release}
\begin{release}{2.5}{2013-01-10}
\item Made \texttt{url} work as a localisation string, defaulting to previously hard-coded value <\textsc{URL}>.
\item Changed some \biber\ option names to cohere with \biber\ 1.5.
\item New sourcemap step for conditionally removing entire entries\see{aut:ctm:map}
\item Updated Catalan localisation (Sebastià Vila-Marta)
\end{release}
\begin{release}{2.4}{2012-11-28}
\item Added \bibfield{relatedoptions} field\see{aut:ctm:rel}
\item Added \cmd{DeclareStyleSourcemap}\see{aut:ctm:map}
\item Renamed \cmd{DeclareDefaultSourcemap} to \cmd{DeclareDriverSourcemap}\see{aut:ctm:map}
\item Documented \cmd{DeclareFieldInputHandler}, \cmd{DeclareListInputHandler} and \cmd{DeclareNameInputHandler}.
\item Added Czech localisation (Michal Hoftich)
\item Updated Catalan localisation (Sebastià Vila-Marta)
\end{release}
\begin{release}{2.3}{2012-11-01}
\item Better detection of situations which require a \biber\ or \LaTeX\ re-run
\item New append mode for \cmd{DeclareSourcemap} so that fields can be combined\see{aut:ctm:map}
\item Extended auxiliary indexing macros
\item Added support for plural localisation strings with \bibfield{relatedtype}\see{aut:ctm:rel}
\item Added \cmd{csfield} and \cmd{usefield}\see{aut:aux:dat}
\item Added starred variant of \cmd{usebibmacro}\see{aut:aux:msc}
\item Added \cmd{ifbibmacroundef}, \cmd{iffieldformatundef}, \cmd{iflistformatundef}
and \cmd{ifnameformatundef}\see{aut:aux:msc}
\item Added Catalan localisation (Sebastià Vila-Marta)
\item Misc bug fixes
\end{release}
\begin{release}{2.2}{2012-08-17}
\item Misc bug fixes
\item Added \cmd{revsdnamepunct}\see{use:fmt:fmt}
\item Added \cmd{ifterseinits}\see{aut:aux:tst}
\end{release}
\begin{release}{2.1}{2012-08-01}
\item Misc bug fixes
\item Updated Norwegian localisation (Håkon Malmedal)
\item Increased data model auto-loading possibilities\see{aut:ctm:dm}
\end{release}
\begin{release}{2.0}{2012-07-01}
\item Misc bug fixes
\item Generalised \opt{singletitle} test a little\see{aut:aux:tst}
\item Added new special field \bibfield{extratitleyear}\see{aut:bbx:fld}
\item Customisable data model\see{aut:ctm:dm}
\item Added \cmd{DeclareDefaultSourcemap}\see{aut:ctm:map}
\item Added \opt{labeltitle} option\see{use:opt:pre:int}
\item Added new special field \bibfield{extratitle}\see{aut:bbx:fld}
\item Made special field \bibfield{labeltitle} customisable\see{aut:bbx:fld}
\item Removed field \bibfield{reprinttitle}\see{use:rel}
\item Added related entry feature\see{use:rel}
\item Added \cmd{DeclareNoinit}\see{aut:ctm:noinit}
\item Added \cmd{DeclareNosort}\see{aut:ctm:nosort}
\item Added \opt{sorting} option for \cmd{printbibliography} and \cmd{printshorthands}\see{use:bib:bib}
\item Added \texttt{ids} field for citekey aliasing\see{bib:fld}
\item Added \opt{sortfirstinits} option\see{use:opt:pre:int}
\item Added data stream modification feature\see{aut:ctm:map}
\item Added customisable labels feature\see{aut:ctm:lab}
\item Added \cmd{citeyear*} and \cmd{citedate*}\see{use:cit:txt}
\end{release}
% \begin{release}{1.7}{2011-11-13}
% \item Added \texttt{xdata} containers\see{use:use:xdat}
% \item Added special entry type \bibfield{xdata}\see{bib:typ:blx}
% \item Added special field \bibfield{xdata}\see{bib:fld:spc}
% \item Support \opt{maxnames}/\opt{minnames} globally/per-type/per-entry\see{use:opt:pre:gen}
% \item Support \opt{maxbibnames}/\opt{minbibnames} globally/per-type/per-entry\see{use:opt:pre:gen}
% \item Support \opt{maxcitenames}/\opt{mincitenames} globally/per-type/per-entry\see{use:opt:pre:gen}
% \item Support \opt{maxitems}/\opt{minitems} globally/per-type/per-entry\see{use:opt:pre:gen}
% \item Support \opt{maxalphanames}/\opt{minalphanames} globally/per-type/per-entry\see{use:opt:pre:int}
% \item Support \opt{uniquelist} globally/per-type/per-entry\see{use:opt:pre:int}
% \item Support \opt{uniquename} globally/per-type/per-entry\see{use:opt:pre:int}
% \item Added \cmd{textcite} and \cmd{textcites} to all \texttt{verbose} citation styles\see{use:xbx:cbx}
% \item Added special field formats \texttt{date}, \texttt{urldate}, \texttt{origdate}, \texttt{eventdate}\see{aut:fmt:ich}
% \item Added \cmd{mkcomprange*}\see{aut:aux:msc}
% \item Added \cmd{mkfirstpage*}\see{aut:aux:msc}
% \item Added \cmd{volcitedelim}\see{aut:fmt:fmt}
% \item Added missing documentation for \cmd{ifentrytype}\see{aut:aux:tst}
% \item Added \cmd{mkbibneutord}\see{use:fmt:lng}
% \item Added counter \cnt{biburlnumpenalty}\see{aut:fmt:len}
% \item Added counter \cnt{biburlucpenalty}\see{aut:fmt:len}
% \item Added counter \cnt{biburllcpenalty}\see{aut:fmt:len}
% \item Added localisation keys \texttt{book}, \texttt{part}, \texttt{issue}, \texttt{forthcoming}\see{aut:lng:key}
% \item Added some \texttt{lang...} and \texttt{from...} localisation keys\see{aut:lng:key}
% \item Expanded documentation\see{apx:opt}
% \item Added support for Russian (Oleg Domanov)
% \item Updated support for Dutch (Pieter Belmans)
% \item Fixed compatibility issue with \sty{textcase} package
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.6}{2011-07-29}
% \item Added special field \bibfield{sortshorthand}\see{bib:fld:spc}
% \item Revised options \opt{maxnames}/\opt{minnames}\see{use:opt:pre:gen}
% \item Options \opt{maxcitenames}/\opt{mincitenames} now supported by backend\see{use:opt:pre:gen}
% \item Options \opt{maxbibnames}/\opt{minbibnames} now supported by backend\see{use:opt:pre:gen}
% \item Added options \opt{maxalphanames}/\opt{minalphanames}\see{use:opt:pre:int}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{printbibliography}\see{use:bib:bib}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printbibliography}\see{use:bib:bib}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbysection}\see{use:bib:bib}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbysection}\see{use:bib:bib}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbysegment}\see{use:bib:bib}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbysegment}\see{use:bib:bib}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbycategory}\see{use:bib:bib}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbycategory}\see{use:bib:bib}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{printshorthands}\see{use:bib:biblist}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printshorthands}\see{use:bib:biblist}
% \item Added special field format \bibfield{volcitevolume}\see{use:cit:spc}
% \item Added special field format \bibfield{volcitepages}\see{use:cit:spc}
% \item Added special field \bibfield{hash}\see{aut:bbx:fld:gen}
% \item Added \cmd{mkcomprange}\see{aut:aux:msc}
% \item Added \cmd{mkfirstpage}\see{aut:aux:msc}
% \item Removed \cmd{mkpagefirst}\see{aut:aux:msc}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.5a}{2011-06-17}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.5}{2011-06-08}
% \item Added option \kvopt{uniquename}{mininit/minfull}\see{use:opt:pre:int}
% \item Added option \kvopt{uniquelist}{minyear}\see{use:opt:pre:int}
% \item Updated documentation of \cnt{uniquename} counter\see{aut:aux:tst}
% \item Updated documentation of \cnt{uniquelist} counter\see{aut:aux:tst}
% \item Expanded documentation for \opt{uniquename/uniquelist} options\see{aut:cav:amb}
% \item Added editorial role \texttt{reviser}\see{bib:use:edr}
% \item Added localisation keys \texttt{reviser}, \texttt{revisers}, \texttt{byreviser}\see{aut:lng:key}
% \item Added bibliography heading \texttt{none}\see{use:bib:hdg}
% \item Fixed some \sty{memoir} compatibility issues
% \end{release}
% \begin{release}{1.4c}{2011-05-12}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.4b}{2011-04-12}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.4a}{2011-04-06}
% \item Enable \opt{uniquename} and \opt{uniquelist} in all \texttt{authortitle} styles\see{use:xbx:cbx}
% \item Enable \opt{uniquename} and \opt{uniquelist} in all \texttt{authoryear} styles\see{use:xbx:cbx}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.4}{2011-03-31}
% \item Added package option \opt{uniquelist}\see{use:opt:pre:int}
% \item Added special counter \cnt{uniquelist}\see{aut:aux:tst}
% \item Revised and improved package option \opt{uniquename}\see{use:opt:pre:int}
% \item Revised and improved special counter \cnt{uniquename}\see{aut:aux:tst}
% \item Added \cmd{bibnamedelimi}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelima}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimb}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimc}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimd}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimi}\see{use:fmt:fmt}
% \item Added \cmd{bibindexinitperiod}\see{use:fmt:fmt}
% \item Added \cmd{bibindexinitdelim}\see{use:fmt:fmt}
% \item Added \cmd{bibindexinithyphendelim}\see{use:fmt:fmt}
% \item Fixed conflict with some \acr{AMS} classes
% \end{release}
% \begin{release}{1.3a}{2011-03-18}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.3}{2011-03-14}
% \item Support \bibtype{thesis} with \bibfield{isbn}\see{bib:typ:blx}
% \item Updated \opt{terseinits} option\see{use:opt:pre:gen}
% \item Allow macros in argument to \cmd{addbibresource} and friends\see{use:bib:res}
% \item Allow macros in argument to \cmd{bibliography}\see{use:bib:res}
% \item Introducing experimental support for Zotero \acr{RDF}/\acr{XML}\see{use:bib:res}
% \item Introducing experimental support for EndNote \acr{XML}\see{use:bib:res}
% \item Added option \opt{citecounter}\see{use:opt:pre:int}
% \item Added \cnt{citecounter}\see{aut:aux:tst}
% \item Added \cmd{smartcite} and \cmd{Smartcite}\see{use:cit:cbx}
% \item Added \cmd{smartcites} and \cmd{Smartcites}\see{use:cit:mlt}
% \item Added \cmd{svolcite} and \cmd{Svolcite}\see{use:cit:spc}
% \item Added \cmd{bibnamedelima}\see{use:fmt:fmt}
% \item Added \cmd{bibnamedelimb}\see{use:fmt:fmt}
% \item Added \cmd{bibnamedelimc}\see{use:fmt:fmt}
% \item Added \cmd{bibnamedelimd}\see{use:fmt:fmt}
% \item Added \cmd{bibinitperiod}\see{use:fmt:fmt}
% \item Added \cmd{bibinitdelim}\see{use:fmt:fmt}
% \item Added \cmd{bibinithyphendelim}\see{use:fmt:fmt}
% \item Expanded documentation\see{use:cav:nam}
% \item Added \prm{position} parameter \texttt{f} to \cmd{DeclareAutoCiteCommand}\see{aut:cbx:cbx}
% \end{release}
% \begin{release}{1.2a}{2011-02-13}
% \item Fix in \cmd{mkbibmonth}\see{aut:fmt:ich}
% \end{release}
% \begin{release}{1.2}{2011-02-12}
% \item Added entry type \bibtype{mvbook}\see{bib:typ:blx}
% \item Added entry type \bibtype{mvcollection}\see{bib:typ:blx}
% \item Added entry type \bibtype{mvproceedings}\see{bib:typ:blx}
% \item Added entry type \bibtype{mvreference}\see{bib:typ:blx}
% \item Introducing remote resources\see{use:bib:res}
% \item Introducing experimental \acr{RIS} support\see{use:bib:res}
% \item Added \cmd{addbibresource}\see{use:bib:res}
% \item \cmd{bibliography} now deprecated\see{use:bib:res}
% \item \cmd{bibliography*} replaced by \cmd{addglobalbib}\see{use:bib:res}
% \item Added \cmd{addsectionbib}\see{use:bib:res}
% \item Updated and expanded documentation\see{bib:cav:ref}
% \item Introducing smart \bibfield{crossref} data inheritance\see{bib:cav:ref:bbr}
% \item Introducing \bibfield{crossref} configuration interface\see{aut:ctm:ref}
% \item Added \cmd{DefaultInheritance}\see{aut:ctm:ref}
% \item Added \cmd{DeclareDataInheritance}\see{aut:ctm:ref}
% \item Added \cmd{ResetDataInheritance}\see{aut:ctm:ref}
% \item Added \cmd{ifkeyword}\see{aut:aux:tst}
% \item Added \cmd{ifentrykeyword}\see{aut:aux:tst}
% \item Added \cmd{ifcategory}\see{aut:aux:tst}
% \item Added \cmd{ifentrycategory}\see{aut:aux:tst}
% \item Added \cmd{ifdriver}\see{aut:aux:tst}
% \item Added \cmd{forcsvfield}\see{aut:aux:msc}
% \item Extended \cmd{mkpageprefix}\see{aut:aux:msc}
% \item Extended \cmd{mkpagetotal}\see{aut:aux:msc}
% \item Extended \cmd{mkpagefirst}\see{aut:aux:msc}
% \item Added localisation key \texttt{inpreparation}\see{aut:lng:key}
% \item Rearranged manual slightly, moving some tables to the appendix
% \end{release}
% \begin{release}{1.1b}{2011-02-04}
% \item Added option \opt{texencoding}\see{use:opt:pre:gen}
% \item Added option \opt{safeinputenc}\see{use:opt:pre:gen}
% \item Expanded documentation\see{bib:cav:enc:enc}
% \item Improved \opt{mergedate} option of bibliography style \texttt{authoryear}\see{use:xbx:bbx}
% \item Removed \opt{pass} option of \cmd{DeclareSortingScheme}\see{aut:ctm:srt}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.1a}{2011-01-08}
% \item Added unsupported entry type \bibtype{bibnote}\see{bib:typ:ctm}
% \item Added \cmd{bibliography*}\see{use:bib:res}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.1}{2011-01-05}
% \item Added option \opt{maxbibnames}\see{use:opt:pre:gen}
% \item Added option \opt{minbibnames}\see{use:opt:pre:gen}
% \item Added option \opt{maxcitenames}\see{use:opt:pre:gen}
% \item Added option \opt{mincitenames}\see{use:opt:pre:gen}
% \item Fixed \kvopt{idemtracker}{strict} and \kvopt{idemtracker}{constrict}\see{use:opt:pre:int}
% \item Added option \opt{mergedate} to bibliography style \texttt{authoryear}\see{use:xbx:bbx}
% \item Added support for \opt{prefixnumbers} to bibliography style \texttt{alphabetic}\see{use:xbx:bbx}
% \item Made option \bibfield{useprefix} settable on a per-type basis\see{use:opt:bib}
% \item Made option \bibfield{useauthor} settable on a per-type basis\see{use:opt:bib}
% \item Made option \bibfield{useeditor} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{usetranslator} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{skipbib} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{skiplos} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{skiplab} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{dataonly} settable on a per-type basis\see{use:opt:bib}
% \item Made option \opt{labelalpha} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{labelnumber} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{labelyear} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{singletitle} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{uniquename} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{indexing} settable on a per-type basis\see{use:opt:pre:gen}
% \item Made option \opt{indexing} settable on a per-entry basis\see{use:opt:pre:gen}
% \item Extended \cmd{ExecuteBibliographyOptions}\see{use:cfg:opt}
% \item Added \cmd{citedate}\see{use:cit:txt}
% \item Improved static entry sets\see{use:use:set}
% \item Introducing dynamic entry sets\see{use:use:set}
% \item Added \cmd{defbibentryset}\see{use:bib:set}
% \item Added option \opt{mcite}\see{use:opt:ldt}
% \item Added \sty{mcite}\slash\sty{mciteplus}-like commands\see{use:cit:mct}
% \item Added \cmd{sortalphaothers}\see{use:fmt:fmt}
% \item Extended \cmd{DeclareNameFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareIndexNameFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareListFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareIndexListFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareFieldFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareIndexFieldFormat}\see{aut:bib:fmt}
% \item Added \cmd{DeclareNameFormat*}\see{aut:bib:fmt}
% \item Added \cmd{DeclareIndexNameFormat*}\see{aut:bib:fmt}
% \item Added \cmd{DeclareListFormat*}\see{aut:bib:fmt}
% \item Added \cmd{DeclareIndexListFormat*}\see{aut:bib:fmt}
% \item Added \cmd{DeclareFieldFormat*}\see{aut:bib:fmt}
% \item Added \cmd{DeclareIndexFieldFormat*}\see{aut:bib:fmt}
% \item Introducing configurable sorting schemes
% \item Added \cmd{DeclareSortingScheme}\see{aut:ctm:srt}
% \item Added \cmd{DeclarePresort}\see{aut:ctm:srt}
% \item Added \cmd{DeclareSortExclusion}\see{aut:ctm:srt}
% \item Added \cmd{DeclareLabelname}\see{aut:ctm:fld}
% \item Added \cmd{DeclareLabelyear}\see{aut:ctm:fld}
% \item Improved special field \bibfield{labelname}\see{aut:bbx:fld}
% \item Improved special field \bibfield{labelyear}\see{aut:bbx:fld}
% \item Added \cmd{entrydata*}\see{aut:bib:dat}
% \item Added \cmd{RequireBiber}\see{aut:aux:msc}
% \item Added option \opt{check} to \cmd{printbibliography}\see{use:bib:bib}
% \item Added option \opt{check} to \cmd{printshorthands}\see{use:bib:biblist}
% \item Added \cmd{defbibcheck}\see{use:bib:flt}
% \item Updated support for Portuguese (José Carlos Santos)
% \item Fixed conflict with \sty{titletoc}
% \item Fixed some bugs
% \end{release}
% \begin{release}{1.0}{2010-11-19}
% \item First officially stable release
% \item Renamed option \kvopt{bibencoding}{inputenc} to \kvopt{bibencoding}{auto}\see{use:opt:pre:gen}
% \item Made \kvopt{bibencoding}{auto} the package default\see{use:opt:pre:gen}
% \item Added option \kvopt{backend}{bibtexu}\see{use:opt:pre:gen}
% \item Slightly updated documentation\see{bib:cav:enc}
% \item Updated support for Dutch (Alexander van Loon)
% \item Updated support for Italian (Andrea Marchitelli)
% \end{release}
%\begin{release}{0.9e}{2010-10-09}
%\item Updated and expanded manual\see{bib:cav:enc}
%\item Added option \opt{sortupper}\see{use:opt:pre:gen}
%\item Added option \opt{sortlocale}\see{use:opt:pre:gen}
%\item Added option \opt{backrefsetstyle}\see{use:opt:pre:gen}
%\item Added \cmd{bibpagerefpunct}\see{use:fmt:fmt}
%\item Added \cmd{backtrackertrue} and \cmd{backtrackerfalse}\see{aut:aux:msc}
%\item Disable back reference tracking in \acr{TOC}/\acr{LOT}/\acr{LOF}\see{aut:cav:flt}
%\item Improved back reference tracking for \bibtype{set} entries
%\item Fixed some bugs
%\end{release}
%
%\begin{release}{0.9d}{2010-09-03}
%\item Added workaround for \sty{hyperref} space factor issue
%\item Added workaround for \sty{xkeyval}'s flawed class option inheritance
%\item Added workaround for \sty{fancyvrb}'s flawed brute-force \cmd{VerbatimFootnotes}
%\item Removed option \kvopt{date}{none}\see{use:opt:pre:gen}
%\item Removed option \kvopt{urldate}{none}\see{use:opt:pre:gen}
%\item Removed option \kvopt{origdate}{none}\see{use:opt:pre:gen}
%\item Removed option \kvopt{eventdate}{none}\see{use:opt:pre:gen}
%\item Removed option \kvopt{alldates}{none}\see{use:opt:pre:gen}
%\item Added option \kvopt{date}{iso8601}\see{use:opt:pre:gen}
%\item Added option \kvopt{urldate}{iso8601}\see{use:opt:pre:gen}
%\item Added option \kvopt{origdate}{iso8601}\see{use:opt:pre:gen}
%\item Added option \kvopt{eventdate}{iso8601}\see{use:opt:pre:gen}
%\item Added option \kvopt{alldates}{iso8601}\see{use:opt:pre:gen}
%\end{release}
%
%\begin{release}{0.9c}{2010-08-29}
%\item Added field \bibfield{eprintclass}\see{bib:fld:dat}
%\item Added field alias \bibfield{archiveprefix}\see{bib:fld:als}
%\item Added field alias \bibfield{primaryclass}\see{bib:fld:als}
%\item Updated documentation\see{use:use:epr}
%\item Tweaked package option \kvopt{babel}{other*}\see{use:opt:pre:gen}
%\item Updated support for Brazilian (Mateus Araújo)
%\item Fixed some bugs
%\end{release}
%
%\begin{release}{0.9b}{2010-08-04}
%
%\item New dependency on \sty{logreq} package\see{int:pre:req}
%\item Improved separator masking in literal lists\see{bib:use:and}
%\item Added citation style \texttt{authortitle-ticomp}\see{use:xbx:cbx}
%\item Added option \opt{citepages} to all \texttt{verbose} citation styles\see{use:xbx:cbx}
%\item Added support for prefixes to all \texttt{numeric} citation styles\see{use:xbx:cbx}
%\item Added support for prefixes to all \texttt{numeric} bibliography styles\see{use:xbx:bbx}
%\item Renamed package option \opt{defernums} to \opt{defernumbers}\see{use:opt:pre:gen}
%\item Added option \opt{sortcase}\see{use:opt:pre:gen}
%\item Added option \opt{dateabbrev}\see{use:opt:pre:gen}
%\item Added option \kvopt{date}{none}\see{use:opt:pre:gen}
%\item Added option \kvopt{urldate}{none}\see{use:opt:pre:gen}
%\item Added option \kvopt{origdate}{none}\see{use:opt:pre:gen}
%\item Added option \kvopt{eventdate}{none}\see{use:opt:pre:gen}
%\item Added option \kvopt{alldates}{none}\see{use:opt:pre:gen}
%\item Added option \opt{clearlang}\see{use:opt:pre:gen}
%\item Added option \opt{prefixnumbers} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{resetnumbers} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{omitnumbers} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added special field \bibfield{prefixnumber}\see{aut:bbx:fld}
%\item Added \cmd{DeclareRedundantLanguages}\see{aut:lng:cmd}
%\item Added support for handles (\acr{HDL}s)\see{use:use:epr}
%\item Extended \cmd{defbibfilter}\see{use:bib:flt}
%\item Added \cmd{nametitledelim}\see{use:fmt:fmt}
%\item Improved \cmd{newbibmacro}\see{aut:aux:msc}
%\item Improved \cmd{renewbibmacro}\see{aut:aux:msc}
%\item Added \cmd{biblstring}\see{aut:str}
%\item Added \cmd{bibsstring}\see{aut:str}
%\item Added \cmd{bibcplstring}\see{aut:str}
%\item Added \cmd{bibcpsstring}\see{aut:str}
%\item Added \cmd{bibuclstring}\see{aut:str}
%\item Added \cmd{bibucsstring}\see{aut:str}
%\item Added \cmd{biblclstring}\see{aut:str}
%\item Added \cmd{biblcsstring}\see{aut:str}
%\item Added \cmd{bibxlstring}\see{aut:str}
%\item Added \cmd{bibxsstring}\see{aut:str}
%\item Added \cmd{mkbibbold}\see{aut:fmt:ich}
%\item Modified and extended log messages\see{bib:cav:ide}
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.9a}{2010-03-19}
%
%\item Modified citation style \texttt{numeric}\see{use:xbx:cbx}
%\item Modified citation style \texttt{numeric-comp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{numeric-verb}\see{use:xbx:cbx}
%\item Modified citation style \texttt{alphabetic}\see{use:xbx:cbx}
%\item Modified citation style \texttt{alphabetic-verb}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authoryear}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authoryear-comp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authoryear-ibid}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authoryear-icomp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle-comp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle-ibid}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle-icomp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle-terse}\see{use:xbx:cbx}
%\item Modified citation style \texttt{authortitle-tcomp}\see{use:xbx:cbx}
%\item Modified citation style \texttt{draft}\see{use:xbx:cbx}
%\item Modified citation style \texttt{debug}\see{use:xbx:cbx}
%\item Added option \opt{bibwarn}\see{use:opt:pre:gen}
%\item Added \cmd{printbibheading}\see{use:bib:bib}
%\item Added option \opt{env} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{env} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added \cmd{defbibenvironment}\see{use:bib:hdg}
%\item Removed \env{thebibliography}\see{aut:bbx:bbx}
%\item Removed \env{theshorthands}\see{aut:bbx:bbx}
%\item Removed \cmd{thebibitem}\see{aut:bbx:bbx}
%\item Removed \cmd{thelositem}\see{aut:bbx:bbx}
%\item Updated documentation\see{aut:bbx:bbx}
%\item Updated documentation\see{aut:bbx:env}
%\item Added \cmd{intitlepunct}\see{use:fmt:fmt}
%\item Added option \opt{parentracker}\see{use:opt:pre:int}
%\item Added option \opt{maxparens}\see{use:opt:pre:int}
%\item Added counter \cnt{parenlevel}\see{aut:aux:tst}
%\item Added \cmd{parentext}\see{use:cit:txt}
%\item Added \cmd{brackettext}\see{use:cit:txt}
%\item Improved \cmd{mkbibparens}\see{aut:fmt:ich}
%\item Improved \cmd{mkbibbrackets}\see{aut:fmt:ich}
%\item Added \cmd{bibopenparen} and \cmd{bibcloseparen}\see{aut:fmt:ich}
%\item Added \cmd{bibopenbracket} and \cmd{bibclosebracket}\see{aut:fmt:ich}
%\item Added special field \bibfield{childentrykey}\see{aut:bbx:fld}
%\item Added special field \bibfield{childentrytype}\see{aut:bbx:fld}
%\item Added \cmd{ifnatbibmode}\see{aut:aux:tst}
%\item Added missing documentation of \cmd{ifbibxstring}\see{aut:aux:tst}
%\item Added \cmd{providebibmacro}\see{aut:aux:msc}
%\item Added localisation key \texttt{backrefpage}\see{aut:lng:key}
%\item Added localisation key \texttt{backrefpages}\see{aut:lng:key}
%\item Slightly expanded documentation\see{bib:use:dat}
%\item Slightly expanded documentation\see{aut:bbx:fld:dat}
%\item Added support for Finnish (translations by Hannu Väisänen)
%\item Updated support for Greek (translations by Prokopis)
%
%\end{release}
%
%\begin{release}{0.9}{2010-02-14}
%
%\item Added entry type \bibtype{bookinbook}\see{bib:typ:blx}
%\item Support \bibfield{eventtitle}/\bibfield{eventdate}/\bibfield{venue} in \bibtype{proceedings}\see{bib:typ:blx}
%\item Support \bibfield{eventtitle}/\bibfield{eventdate}/\bibfield{venue} in \bibtype{inproceedings}\see{bib:typ:blx}
%\item Added support for multiple editorial roles\see{bib:use:edr}
%\item Added field \bibfield{editora}\see{bib:fld:dat}
%\item Added field \bibfield{editorb}\see{bib:fld:dat}
%\item Added field \bibfield{editorc}\see{bib:fld:dat}
%\item Added field \bibfield{editoratype}\see{bib:fld:dat}
%\item Added field \bibfield{editorbtype}\see{bib:fld:dat}
%\item Added field \bibfield{editorctype}\see{bib:fld:dat}
%\item Removed field \bibfield{redactor}\see{bib:fld:dat}
%\item Added field \bibfield{pubstate}\see{bib:fld:dat}
%\item Support \bibfield{pubstate} in all entry types\see{bib:typ:blx}
%\item Support full dates in all entry types\see{bib:typ:blx}
%\item Modified and extended date handling\see{bib:use:dat}
%\item Updated documentation\see{bib:use:iss}
%\item Removed field \bibfield{day}\see{bib:fld:dat}
%\item Modified data type of field \bibfield{year}\see{bib:fld:dat}
%\item Extended field \bibfield{date}\see{bib:fld:dat}
%\item Removed field \bibfield{origyear}\see{bib:fld:dat}
%\item Added field \bibfield{origdate}\see{bib:fld:dat}
%\item Added field \bibfield{eventdate}\see{bib:fld:dat}
%\item Removed fields \bibfield{urlday}/\bibfield{urlmonth}/\bibfield{urlyear}\see{bib:fld:dat}
%\item Updated documentation\see{bib:use:dat}
%\item Extended option \opt{date}\see{use:opt:pre:gen}
%\item Extended option \opt{urldate}\see{use:opt:pre:gen}
%\item Added option \opt{origdate}\see{use:opt:pre:gen}
%\item Added option \opt{eventdate}\see{use:opt:pre:gen}
%\item Added option \opt{alldates}\see{use:opt:pre:gen}
%\item Added option \opt{datezeros}\see{use:opt:pre:gen}
%\item Added option \opt{language}\see{use:opt:pre:gen}
%\item Added option \cnt{notetype}\see{use:opt:pre:gen}
%\item Added option \cnt{backrefstyle}\see{use:opt:pre:gen}
%\item Modified option \opt{indexing}\see{use:opt:pre:gen}
%\item Made option \kvopt{hyperref}{auto} the default\see{use:opt:pre:gen}
%\item Added option \kvopt{backend}{biber}\see{use:opt:pre:gen}
%\item Updated documentation\see{bib:cav:enc}
%\item Added option \opt{isbn}\see{use:opt:pre:bbx}
%\item Added option \opt{url}\see{use:opt:pre:bbx}
%\item Added option \opt{doi}\see{use:opt:pre:bbx}
%\item Added option \opt{eprint}\see{use:opt:pre:bbx}
%\item Improved citation style \texttt{authortitle-comp}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authortitle-icomp}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authortitle-tcomp}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authoryear-comp}\see{use:xbx:cbx}
%\item Added citation style \texttt{authoryear-icomp}\see{use:xbx:cbx}
%\item Added citation style \texttt{verbose-trad3}\see{use:xbx:cbx}
%\item Improved bibliography style \texttt{authortitle}\see{use:xbx:bbx}
%\item Improved bibliography style \texttt{authoryear}\see{use:xbx:bbx}
%\item Improved bibliography style \texttt{verbose}\see{use:xbx:bbx}
%\item Added option \opt{title} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{title} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Extended \cmd{defbibheading}\see{use:bib:hdg}
%\item Added options \opt{subtype}/\opt{notsubtype} to \cmd{printbibliography}\see{use:bib:biblist}
%\item Added options \opt{subtype}/\opt{notsubtype} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added test \opt{subtype} to \cmd{defbibfilter}\see{use:bib:flt}
%\item Added option \opt{segment} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added options \opt{type}/\opt{nottype} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added options \opt{keyword}/\opt{notkeyword} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added options \opt{category}/\opt{notcategory} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added option \opt{filter} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added \cmd{footcitetext}\see{use:cit:std}
%\item Added \cmd{footcitetexts}\see{use:cit:mlt}
%\item Added \cmd{ftvolcite}\see{use:cit:spc}
%\item Added \cmd{textcites} and \cmd{Textcites}\see{use:cit:mlt}
%\item Added \cmd{nohyphenation}\see{use:fmt:aux}
%\item Added \cmd{textnohyphenation}\see{use:fmt:aux}
%\item Added \cmd{mkpagefirst}\see{aut:aux:msc}
%\item Added \cmd{pagenote} support to \cmd{mkbibendnote}\see{aut:fmt:ich}
%\item Added \cmd{mkbibfootnotetext}\see{aut:fmt:ich}
%\item Added \cmd{mkbibendnotetext}\see{aut:fmt:ich}
%\item Added \cmd{bibfootnotewrapper}\see{aut:fmt:ich}
%\item Added \cmd{bibendnotewrapper}\see{aut:fmt:ich}
%\item Added \cmd{mkdatezeros}\see{aut:fmt:ich}
%\item Added \cmd{stripzeros}\see{aut:fmt:ich}
%\item Added support for \acr{jstor} links\see{use:use:epr}
%\item Added support for PubMed links\see{use:use:epr}
%\item Added support for Google Books links\see{use:use:epr}
%\item Improved \cmd{DeclareBibliographyDriver}\see{aut:bbx:bbx}
%\item Improved \cmd{DeclareBibliographyAlias}\see{aut:bbx:bbx}
%\item Added special fields \bibfield{day}/\bibfield{month}/\bibfield{year}\see{aut:bbx:fld}
%\item Added special fields \bibfield{endday}/\bibfield{endmonth}/\bibfield{endyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{origday}/\bibfield{origmonth}/\bibfield{origyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{origendday}/\bibfield{origendmonth}/\bibfield{origendyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{eventday}/\bibfield{eventmonth}/\bibfield{eventyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{eventendday}/\bibfield{eventendmonth}/\bibfield{eventendyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{urlday}/\bibfield{urlmonth}/\bibfield{urlyear}\see{aut:bbx:fld}
%\item Added special fields \bibfield{urlendday}/\bibfield{urlendmonth}/\bibfield{urlendyear}\see{aut:bbx:fld}
%\item Renamed special field \bibfield{labelyear} to \bibfield{extrayear}\see{aut:bbx:fld}
%\item Added new special field \bibfield{labelyear}\see{aut:bbx:fld}
%\item Renamed \cnt{maxlabelyear} to \cnt{maxextrayear}\see{aut:fmt:ilc}
%\item Renamed \cmd{bibdate} to \cmd{printdate}, modified \cmd{printdate}\see{aut:bib:dat}
%\item Added \cmd{printdateextra}\see{aut:bib:dat}
%\item Renamed \cmd{biburldate} to \cmd{printurldate}, modified \cmd{printurldate}\see{aut:bib:dat}
%\item Added \cmd{printorigdate}\see{aut:bib:dat}
%\item Added \cmd{printeventdate}\see{aut:bib:dat}
%\item Added \cmd{bibdatedash}\see{use:fmt:lng}
%\item Added \cmd{mkbibdatelong} and \cmd{mkbibdateshort}\see{use:fmt:lng}
%\item Removed \cmd{bibdatelong} and \cmd{bibdateshort}\see{use:fmt:lng}
%\item Removed \cmd{biburldatelong} and \cmd{biburldateshort}\see{use:fmt:lng}
%\item Added \cmd{ifciteindex}\see{aut:aux:tst}
%\item Added \cmd{ifbibindex}\see{aut:aux:tst}
%\item Added \cmd{iffieldint}\see{aut:aux:tst}
%\item Added \cmd{iffieldnum}\see{aut:aux:tst}
%\item Added \cmd{iffieldnums}\see{aut:aux:tst}
%\item Added \cmd{ifpages}\see{aut:aux:tst}
%\item Added \cmd{iffieldpages}\see{aut:aux:tst}
%\item Added \cmd{DeclarePageCommands} and \cmd{DeclarePageCommands*}\see{aut:aux:msc}
%\item Improved \cmd{NewBibliographyString}\see{aut:lng:cmd}
%\item Removed localisation key \texttt{editor}\see{aut:lng:key}
%\item Removed localisation key \texttt{editors}\see{aut:lng:key}
%\item Renamed localisation key \texttt{typeeditor} to \texttt{editor}\see{aut:lng:key}
%\item Renamed localisation key \texttt{typeeditors} to \texttt{editors}\see{aut:lng:key}
%\item Renamed localisation key \texttt{typecompiler} to \texttt{compiler}\see{aut:lng:key}
%\item Renamed localisation key \texttt{typecompilers} to \texttt{compilers}\see{aut:lng:key}
%\item Added localisation key \texttt{founder}\see{aut:lng:key}
%\item Added localisation key \texttt{founders}\see{aut:lng:key}
%\item Added localisation key \texttt{continuator}\see{aut:lng:key}
%\item Added localisation key \texttt{continuators}\see{aut:lng:key}
%\item Added localisation key \texttt{collaborator}\see{aut:lng:key}
%\item Added localisation key \texttt{collaborators}\see{aut:lng:key}
%\item Removed localisation key \texttt{byauthor}\see{aut:lng:key}
%\item Renamed localisation key \texttt{bytypeauthor} to \texttt{byauthor}\see{aut:lng:key}
%\item Removed localisation key \texttt{byeditor}\see{aut:lng:key}
%\item Renamed localisation key \texttt{bytypeeditor} to \texttt{byeditor}\see{aut:lng:key}
%\item Renamed localisation key \texttt{bytypecompiler} to \texttt{bycompiler}\see{aut:lng:key}
%\item Added localisation key \texttt{byfounder}\see{aut:lng:key}
%\item Added localisation key \texttt{bycontinuator}\see{aut:lng:key}
%\item Added localisation key \texttt{bycollaborator}\see{aut:lng:key}
%\item Added localisation key \texttt{inpress}\see{aut:lng:key}
%\item Added localisation key \texttt{submitted}\see{aut:lng:key}
%\item Added support for Dutch (translations by Alexander van Loon)
%\item Added support for Greek (translations by Apostolos Syropoulos)
%\item Added notes on Greek\see{use:loc:grk}
%
%\end{release}
%
%\begin{release}{0.8i}{2009-09-20}
%
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8h}{2009-08-10}
%
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8g}{2009-08-06}
%
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8f}{2009-07-25}
%
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8e}{2009-07-04}
%
%\item Added \cmd{mkbibordedition}\see{use:fmt:lng}
%\item Added \cmd{mkbibordseries}\see{use:fmt:lng}
%\item Added \cmd{mkbibendnote}\see{aut:fmt:ich}
%\item Added several localisation keys related to \texttt{editor}\see{aut:lng:key}
%\item Added several localisation keys related to \texttt{translator}\see{aut:lng:key}
%\item Added localisation key \texttt{thiscite}\see{aut:lng:key}
%\item Removed several \texttt{country...} localisation keys\see{aut:lng:key}
%\item Removed several \texttt{patent...} localisation keys\see{aut:lng:key}
%\item Removed several \texttt{patreq...} localisation keys\see{aut:lng:key}
%\item Updated and clarified documentation\see{aut:lng:key}
%\item Added support for Brazilian Portuguese (by Augusto Ritter Stoffel)
%\item Added preliminary support for Portuguese/Portugal\see{use:opt:pre:gen}
%\item Added revised Swedish translations (by Per Starbäck)\see{use:opt:pre:gen}
%\item Expanded documentation\see{aut:cav:nam}
%\item Improved concatenation of editorial and other roles
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8d}{2009-05-30}
%
%\item Removed package option \opt{bibtex8}\see{use:opt:pre:gen}
%\item Added package option \opt{backend}\see{use:opt:pre:gen}
%\item Slightly modified package option \bibfield{loccittracker}\see{use:opt:pre:int}
%\item Added \cmd{volcite} and \cmd{Volcite}\see{use:cit:spc}
%\item Added \cmd{pvolcite} and \cmd{Pvolcite}\see{use:cit:spc}
%\item Added \cmd{fvolcite}\see{use:cit:spc}
%\item Added \cmd{tvolcite} and \cmd{Tvolcite}\see{use:cit:spc}
%\item Added \cmd{avolcite} and \cmd{Avolcite}\see{use:cit:spc}
%\item Added \cmd{notecite} and \cmd{Notecite}\see{use:cit:spc}
%\item Added \cmd{Pnotecite} and \cmd{Pnotecite}\see{use:cit:spc}
%\item Added \cmd{fnotecite}\see{use:cit:spc}
%\item Added \cmd{addabthinspace}\see{aut:pct:spc}
%\item Disable citation and page trackers in \acr{TOC}/\acr{LOT}/\acr{LOF}\see{aut:cav:flt}
%\item Disable citation and page trackers in floats\see{aut:cav:flt}
%\item Improved on-demand loading of localisation modules
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8c}{2009-01-10}
%
%\item Added <idem> tracker\see{use:opt:pre:int}
%\item Added package option \opt{idemtracker}\see{use:opt:pre:int}
%\item Added \cmd{ifciteidem}\see{aut:aux:tst}
%\item Added \cmd{ifentryseen}\see{aut:aux:tst}
%\item Improved citation style \texttt{verbose-trad1}\see{use:xbx:cbx}
%\item Improved citation style \texttt{verbose-trad2}\see{use:xbx:cbx}
%\item Renamed \len{bibitemextrasep} to \len{bibnamesep}\see{use:fmt:len}
%\item Slightly modified \len{bibnamesep}\see{use:fmt:len}
%\item Added \len{bibinitsep}\see{use:fmt:len}
%\item Increased default value of \cnt{highnamepenalty}\see{use:fmt:len}
%\item Increased default value of \cnt{lownamepenalty}\see{use:fmt:len}
%\item Updated documentation\see{use:loc:us}
%\item Added \cmd{uspunctuation}\see{aut:pct:cfg}
%\item Added \cmd{stdpunctuation}\see{aut:pct:cfg}
%\item Added \cmd{midsentence*}\see{aut:pct:ctr}
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8b}{2008-12-13}
%
%\item Added package/entry option \opt{usetranslator}\see{use:opt:bib}
%\item Added \cmd{ifusetranslator}\see{aut:aux:tst}
%\item Consider \bibfield{translator} when sorting\see{use:srt}
%\item Consider \bibfield{translator} when generating \bibfield{labelname}\see{aut:bbx:fld}
%\item Added field \bibfield{eventtitle}\see{bib:fld:dat}
%\item Support \bibfield{eventtitle} in \bibtype{proceedings} entries\see{bib:typ:blx}
%\item Support \bibfield{eventtitle} in \bibtype{inproceedings} entries\see{bib:typ:blx}
%\item Added unsupported entry type \bibtype{commentary}\see{bib:typ:ctm}
%\item Permit \cmd{NewBibliographyString} in \file{lbx} files\see{aut:lng:cmd}
%\item Improved behavior of \cmd{mkbibquote} in <American-punctuation> mode\see{aut:fmt:ich}
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.8a}{2008-11-29}
%
%\item Updated documentation (important, please read)\see{int:feb}
%\item Added package option \kvopt{hyperref}{auto}\see{use:opt:pre:gen}
%\item Improved bibliography style \texttt{reading}\see{use:xbx:bbx}
%\item Updated \acr{KOMA}-Script support for version 3.x\see{use:cav:scr}
%\item Slightly modified special field \bibfield{fullhash}\see{aut:bbx:fld}
%\item Added documentation of \cmd{DeclareNumChars*}\see{aut:aux:msc}
%\item Added documentation of \cmd{DeclareRangeChars*}\see{aut:aux:msc}
%\item Added documentation of \cmd{DeclareRangeCommands*}\see{aut:aux:msc}
%\item Added \cmd{MakeSentenceCase}\see{aut:aux:msc}
%\item Added \cmd{DeclareCaseLangs}\see{aut:aux:msc}
%\item Support nested \cmd{mkbibquote} with American punctuation\see{aut:fmt:ich}
%\item Improved \cmd{ifpunctmark}\see{aut:pct:chk}
%\item Improved punctuation tracker\see{aut:pct:pct}
%\item Added \cmd{DeclarePunctuationPairs}\see{aut:pct:cfg}
%\item Added \cmd{DeclareLanguageMapping}\see{aut:lng:cmd}
%\item Added support for custom localisation modules\see{aut:cav:lng}
%\item Added extended \pdf bookmarks to this manual
%\item Fixed various bugs
%
%\end{release}
%
%\begin{release}{0.8}{2008-10-02}
%
%\item Added \cmd{DefineHyphenationExceptions}\see{use:lng}
%\item Added \cmd{DeclareHyphenationExceptions}\see{aut:lng:cmd}
%\item Added \cmd{mkpagetotal}\see{aut:aux:msc}
%\item Improved \acr{KOMA}-Script support\see{use:cav:scr}
%\item Added \cmd{ifkomabibtotoc}\see{use:cav:scr}
%\item Added \cmd{ifkomabibtotocnumbered}\see{use:cav:scr}
%\item Added \cmd{ifmemoirbibintoc}\see{use:cav:mem}
%\item Updated documentation\see{use:bib:hdg}
%\item Updated documentation of \cmd{iffootnote}\see{aut:aux:tst}
%\item Added several new localisation keys\see{aut:lng:key}
%\item Rearranged some localisation keys (\texttt{section} vs. \texttt{paragraph})\see{aut:lng:key}
%\item Added unsupported entry type \bibtype{letter}\see{bib:typ:ctm}
%\item Added entry type \bibtype{suppbook}\see{bib:typ:blx}
%\item Added entry type \bibtype{suppcollection}\see{bib:typ:blx}
%\item Added entry type \bibtype{suppperiodical}\see{bib:typ:blx}
%\item Support \bibtype{reference} and \bibtype{inreference}\see{bib:typ:blx}
%\item Support \bibtype{review} as an alias\see{bib:typ:ctm}
%\item Added field \bibfield{origpublisher}\see{bib:fld:dat}
%\item Added field alias \bibfield{annote}\see{bib:fld:als}
%\item Expanded documentation\see{bib:cav:enc}
%\item Added \cmd{DeclareCapitalPunctuation}\see{aut:pct:cfg}
%\item Removed \cmd{EnableCapitalAfter} and \cmd{DisableCapitalAfter}\see{aut:pct:cfg}
%\item Added support for <American-style> punctuation\see{aut:pct:cfg}
%\item Added \cmd{DeclareQuotePunctuation}\see{aut:pct:cfg}
%\item Improved \cmd{mkbibquote}\see{aut:fmt:ich}
%\item Expanded documentation\see{use:loc:us}
%\item Improved all \texttt{numeric} citation styles\see{use:xbx:cbx}
%\item Improved \texttt{numeric} bibliography style\see{use:xbx:bbx}
%\item Added citation style \texttt{authoryear-ibid}\see{use:xbx:cbx}
%\item Improved all \texttt{authoryear} citation styles\see{use:xbx:cbx}
%\item Improved \texttt{authoryear} bibliography style\see{use:xbx:bbx}
%\item Added \opt{pageref} option to \texttt{verbose-note} style\see{use:xbx:cbx}
%\item Added \opt{pageref} option to \texttt{verbose-inote} style\see{use:xbx:cbx}
%\item Added citation style \texttt{reading}\see{use:xbx:cbx}
%\item Added bibliography style \texttt{reading}\see{use:xbx:bbx}
%\item Added citation style \texttt{draft}\see{use:xbx:cbx}
%\item Added bibliography style \texttt{draft}\see{use:xbx:bbx}
%\item Improved \sty{natbib} compatibility style\see{use:cit:nat}
%\item Added \cmd{ifcitation}\see{aut:aux:tst}
%\item Added \cmd{ifbibliography}\see{aut:aux:tst}
%\item Added \cmd{printfile}\see{aut:bib:dat}
%\item Added package option \opt{loadfiles}\see{use:opt:pre:gen}
%\item Added support for bibliographic data in external files\see{use:use:prf}
%\item Expanded documentation\see{aut:cav:prf}
%\item Modified field \bibfield{edition}\see{bib:fld:dat}
%\item Modified special field \bibfield{labelyear}\see{aut:bbx:fld}
%\item Modified special field \bibfield{labelalpha}\see{aut:bbx:fld}
%\item Added special field \bibfield{extraalpha}\see{aut:bbx:fld}
%\item Added counter \cnt{maxlabelyear}\see{aut:fmt:ilc}
%\item Added counter \cnt{maxextraalpha}\see{aut:fmt:ilc}
%\item Added \cmd{mknumalph}\see{use:fmt:aux}
%\item Added \cmd{mkbibacro}\see{use:fmt:aux}
%\item Added \cmd{autocap}\see{use:fmt:aux}
%\item Added package option \opt{firstinits}\see{use:opt:pre:gen}
%\item Added \cmd{iffirstinits}\see{aut:aux:tst}
%\item Added support for eprint data\see{use:use:epr}
%\item Added support for arXiv\see{use:use:epr}
%\item Expanded documentation \see{aut:cav:epr}
%\item Added field \bibfield{eprint}\see{bib:fld:dat}
%\item Added field \bibfield{eprinttype}\see{bib:fld:dat}
%\item Added eprint support to all standard entry types\see{bib:typ:blx}
%\item Added package option \opt{arxiv}\see{use:opt:pre:gen}
%\item Introduced concept of an entry set\see{use:use:set}
%\item Expanded documentation\see{aut:cav:set}
%\item Added entry type \bibtype{set}\see{bib:typ:blx}
%\item Added field \bibfield{entryset}\see{bib:fld:spc}
%\item Added special field \bibfield{entrysetcount}\see{aut:bbx:fld}
%\item Added \cmd{entrydata}\see{aut:bib:dat}
%\item Expanded documentation\see{aut:cav:mif}
%\item Added \cmd{entryset}\see{aut:bib:dat}
%\item Added \cmd{strfield}\see{aut:aux:dat}
%\item Improved \cmd{usedriver}\see{aut:aux:msc}
%\item Added \cmd{bibpagespunct}\see{use:fmt:fmt}
%\item Expanded documentation\see{aut:cav:pct}
%\item Added entry option \opt{skipbib}\see{use:opt:bib}
%\item Added entry option \opt{skiplos}\see{use:opt:bib}
%\item Added entry option \opt{skiplab}\see{use:opt:bib}
%\item Added entry option \opt{dataonly}\see{use:opt:bib}
%\item Modified special field \bibfield{namehash}\see{aut:bbx:fld}
%\item Added special field \bibfield{fullhash}\see{aut:bbx:fld}
%\item Added \cmd{DeclareNumChars}\see{aut:aux:msc}
%\item Added \cmd{DeclareRangeChars}\see{aut:aux:msc}
%\item Added \cmd{DeclareRangeCommands}\see{aut:aux:msc}
%\item Added support for Swedish (translations by Per Starbäck and others)
%\item Updated various localisation files
%\item Various minor improvements throughout
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.7}{2007-12-09}
%
%\item Expanded documentation\see{int:feb}
%\item New dependency on \sty{etoolbox} package\see{int:pre:req}
%\item Made \sty{url} a required package\see{int:pre:req}
%\item Modified package option \opt{sorting}\see{use:opt:pre:gen}
%\item Introduced concept of an entry option\see{use:opt:bib}
%\item Added option \bibfield{useauthor}\see{use:opt:bib}
%\item Added option \bibfield{useeditor}\see{use:opt:bib}
%\item Modified option \bibfield{useprefix}\see{use:opt:bib}
%\item Removed field \bibfield{useprefix}\see{bib:fld:spc}
%\item Added field \bibfield{options}\see{bib:fld:spc}
%\item Updated documentation\see{use:srt}
%\item Added citation style \texttt{authortitle-ibid}\see{use:xbx:cbx}
%\item Added citation style \texttt{authortitle-icomp}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-cterse} to \texttt{authortitle-tcomp}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-verb} to \texttt{verbose}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-cverb} to \texttt{verbose-ibid}\see{use:xbx:cbx}
%\item Added citation style \texttt{verbose-note}\see{use:xbx:cbx}
%\item Added citation style \texttt{verbose-inote}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-trad} to \texttt{verbose-trad1}\see{use:xbx:cbx}
%\item Removed citation style \texttt{authortitle-strad}\see{use:xbx:cbx}
%\item Added citation style \texttt{verbose-trad2}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authoryear}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authoryear-comp}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authortitle-terse}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authortitle-tcomp}\see{use:xbx:cbx}
%\item Improved all verbose citation styles\see{use:xbx:cbx}
%\item Expanded documentation\see{bib:fld:typ}
%\item Modified entry type \bibtype{article}\see{bib:typ:blx}
%\item Added entry type \bibtype{periodical}\see{bib:typ:blx}
%\item Added entry type \bibtype{patent}\see{bib:typ:blx}
%\item Extended entry types \bibfield{proceedings} and \bibfield{inproceedings}\see{bib:typ:blx}
%\item Extended entry type \bibfield{article}\see{bib:typ:blx}
%\item Extended entry type \bibfield{booklet}\see{bib:typ:blx}
%\item Extended entry type \bibfield{misc}\see{bib:typ:blx}
%\item Added entry type alias \bibtype{electronic}\see{bib:typ:als}
%\item Added new custom types\see{bib:typ:ctm}
%\item Support \bibfield{pagetotal} field where applicable\see{bib:typ:blx}
%\item Added field \bibfield{holder}\see{bib:fld:dat}
%\item Added field \bibfield{venue}\see{bib:fld:dat}
%\item Added field \bibfield{version}\see{bib:fld:dat}
%\item Added field \bibfield{journaltitle}\see{bib:fld:dat}
%\item Added field \bibfield{journalsubtitle}\see{bib:fld:dat}
%\item Added field \bibfield{issuetitle}\see{bib:fld:dat}
%\item Added field \bibfield{issuesubtitle}\see{bib:fld:dat}
%\item Removed field \bibfield{journal}\see{bib:fld:dat}
%\item Added field alias \bibfield{journal}\see{bib:fld:als}
%\item Added field \bibfield{shortjournal}\see{bib:fld:dat}
%\item Added field \bibfield{shortseries}\see{bib:fld:dat}
%\item Added field \bibfield{shorthandintro}\see{bib:fld:dat}
%\item Added field \bibfield{xref}\see{bib:fld:spc}
%\item Added field \bibfield{authortype}\see{bib:fld:dat}
%\item Added field \bibfield{editortype}\see{bib:fld:dat}
%\item Added field \bibfield{reprinttitle}\see{bib:fld:dat}
%\item Improved handling of field \bibfield{type}\see{bib:fld:dat}
%\item Improved handling of field \bibfield{series}\see{bib:fld:dat}
%\item Updated documentation\see{bib:use:ser}
%\item Renamed field \bibfield{id} to \bibfield{eid}\see{bib:fld:dat}
%\item Added field \bibfield{pagination}\see{bib:fld:dat}
%\item Added field \bibfield{bookpagination}\see{bib:fld:dat}
%\item Added special field \bibfield{sortinit}\see{aut:bbx:fld}
%\item Introduced concept of a multicite command\see{use:cit:mlt}
%\item Added \cmd{cites}\see{use:cit:mlt}
%\item Added \cmd{Cites}\see{use:cit:mlt}
%\item Added \cmd{parencites}\see{use:cit:mlt}
%\item Added \cmd{Parencites}\see{use:cit:mlt}
%\item Added \cmd{footcites}\see{use:cit:mlt}
%\item Added \cmd{supercites}\see{use:cit:mlt}
%\item Added \cmd{Autocite}\see{use:cit:aut}
%\item Added \cmd{autocites}\see{use:cit:aut}
%\item Added \cmd{Autocites}\see{use:cit:aut}
%\item Added \cmd{DeclareMultiCiteCommand}\see{aut:cbx:cbx}
%\item Added counter \cnt{multicitecount}\see{aut:fmt:ilc}
%\item Added counter \cnt{multicitetotal}\see{aut:fmt:ilc}
%\item Renamed \cmd{citefulltitle} to \cmd{citetitle*}\see{use:cit:txt}
%\item Added \cmd{cite*}\see{use:cit:cbx}
%\item Added \cmd{citeurl}\see{use:cit:txt}
%\item Added documentation of field \bibfield{nameaddon}\see{bib:fld:dat}
%\item Added field \bibfield{entrysubtype}\see{bib:fld:spc}
%\item Added field \bibfield{execute}\see{bib:fld:spc}
%\item Added custom fields \bibfield{verb{[a--c]}}\see{bib:fld:ctm}
%\item Added custom fields \bibfield{name{[a--c]}type}\see{bib:fld:ctm}
%\item Consider \bibfield{sorttitle} field when falling back to \bibfield{title}\see{use:srt}
%\item Removed package option \opt{labelctitle}\see{use:opt:pre:int}
%\item Removed field \opt{labelctitle}\see{aut:bbx:fld}
%\item Added package option \opt{singletitle}\see{use:opt:pre:int}
%\item Added \cmd{ifsingletitle}\see{aut:aux:tst}
%\item Added \cmd{ifuseauthor}\see{aut:aux:tst}
%\item Added \cmd{ifuseeditor}\see{aut:aux:tst}
%\item Added \cmd{ifopcit}\see{aut:aux:tst}
%\item Added \cmd{ifloccit}\see{aut:aux:tst}
%\item Added package option \opt{uniquename}\see{use:opt:pre:int}
%\item Added special counter \cnt{uniquename}\see{aut:aux:tst}
%\item Added package option \opt{natbib}\see{use:opt:ldt}
%\item Added compatibility commands for the \sty{natbib} package\see{use:cit:nat}
%\item Added package option \opt{defernums}\see{use:opt:pre:gen}
%\item Improved support for numeric labels\see{use:cav:lab}
%\item Added package option \opt{mincrossrefs}\see{use:opt:pre:gen}
%\item Added package option \opt{bibencoding}\see{use:opt:pre:gen}
%\item Expanded documentation\see{bib:cav:enc}
%\item Updated documentation\see{bib:cav:ide}
%\item Added package option \opt{citetracker}\see{use:opt:pre:int}
%\item Added package option \opt{ibidtracker}\see{use:opt:pre:int}
%\item Added package option \bibfield{opcittracker}\see{use:opt:pre:int}
%\item Added package option \bibfield{loccittracker}\see{use:opt:pre:int}
%\item Added \cmd{citetrackertrue} and \cmd{citetrackerfalse}\see{aut:aux:msc}
%\item Modified package option \opt{pagetracker}\see{use:opt:pre:int}
%\item Added \cmd{pagetrackertrue} and \cmd{pagetrackerfalse}\see{aut:aux:msc}
%\item Text commands now excluded from tracking\see{use:cit:txt}
%\item Updated documentation of \cmd{iffirstonpage}\see{aut:aux:tst}
%\item Updated documentation of \cmd{ifsamepage}\see{aut:aux:tst}
%\item Removed package option \opt{keywsort}\see{use:opt:pre:gen}
%\item Added package option \opt{refsection}\see{use:opt:pre:gen}
%\item Added package option \opt{refsegment}\see{use:opt:pre:gen}
%\item Added package option \opt{citereset}\see{use:opt:pre:gen}
%\item Added option \opt{section} to \cmd{bibbysegment}\see{use:bib:bib}
%\item Added option \opt{section} to \cmd{bibbycategory}\see{use:bib:bib}
%\item Added option \opt{section} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Extended documentation of \env{refsection} environment\see{use:bib:sec}
%\item Added \cmd{newrefsection}\see{use:bib:sec}
%\item Added \cmd{newrefsegment}\see{use:bib:seg}
%\item Added heading definition \texttt{subbibliography}\see{use:bib:hdg}
%\item Added heading definition \texttt{subbibintoc}\see{use:bib:hdg}
%\item Added heading definition \texttt{subbibnumbered}\see{use:bib:hdg}
%\item Make all citation commands scan ahead for punctuation\see{use:cit}
%\item Updated documentation of \cmd{DeclareAutoPunctuation}\see{aut:pct:cfg}
%\item Removed \cmd{usecitecmd}\see{aut:cbx:cbx}
%\item Updated documentation of \opt{autocite} package option\see{use:opt:pre:gen}
%\item Updated documentation of \opt{autopunct} package option\see{use:opt:pre:gen}
%\item Added \cmd{citereset}\see{use:cit:msc}
%\item Added \cmd{citereset*}\see{use:cit:msc}
%\item Added \cmd{mancite}\see{use:cit:msc}
%\item Added \cmd{citesetup}\see{use:fmt:fmt}
%\item Added \cmd{compcitedelim}\see{use:fmt:fmt}
%\item Added \cmd{labelnamepunct}\see{use:fmt:fmt}
%\item Added \cmd{subtitlepunct}\see{use:fmt:fmt}
%\item Added \cmd{finallistdelim}\see{use:fmt:fmt}
%\item Added \cmd{andmoredelim}\see{use:fmt:fmt}
%\item Added \cmd{labelalphaothers}\see{use:fmt:fmt}
%\item Added \len{bibitemextrasep}\see{use:fmt:len}
%\item Renamed \cmd{blxauxprefix} to \cmd{blxauxsuffix}\see{use:use:aux}
%\item Added \cmd{DeclareBibliographyOption}\see{aut:bbx:bbx}
%\item Added \cmd{DeclareEntryOption}\see{aut:bbx:bbx}
%\item Renamed \cmd{InitializeBibliographyDrivers} to \cmd{InitializeBibliographyStyle}\see{aut:bbx:bbx}
%\item Added \cmd{InitializeCitationStyle}\see{aut:cbx:cbx}
%\item Added \cmd{OnManualCitation}\see{aut:cbx:cbx}
%\item Extended documentation of \cmd{DeclareCiteCommand}\see{aut:cbx:cbx}
%\item Modified \cmd{DeclareAutoCiteCommand}\see{aut:cbx:cbx}
%\item Improved \cmd{printtext}\see{aut:bib:dat}
%\item Improved \cmd{printfield}\see{aut:bib:dat}
%\item Improved \cmd{printlist}\see{aut:bib:dat}
%\item Improved \cmd{printnames}\see{aut:bib:dat}
%\item Improved \cmd{indexfield}\see{aut:bib:dat}
%\item Improved \cmd{indexlist}\see{aut:bib:dat}
%\item Improved \cmd{indexnames}\see{aut:bib:dat}
%\item Modified \cmd{DeclareFieldFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareListFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareNameFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareFieldAlias}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareListAlias}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareNameAlias}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexFieldFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexListFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexNameFormat}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexFieldAlias}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexListAlias}\see{aut:bib:fmt}
%\item Modified \cmd{DeclareIndexNameAlias}\see{aut:bib:fmt}
%\item Improved \cmd{iffirstonpage}\see{aut:aux:tst}
%\item Improved \cmd{ifciteseen}\see{aut:aux:tst}
%\item Improved \cmd{ifandothers}\see{aut:aux:tst}
%\item Added \cmd{ifinteger}\see{aut:aux:tst}
%\item Added \cmd{ifnumeral}\see{aut:aux:tst}
%\item Added \cmd{ifnumerals}\see{aut:aux:tst}
%\item Removed \cmd{ifpage}\see{aut:aux:tst}
%\item Removed \cmd{ifpages}\see{aut:aux:tst}
%\item Moved \cmd{ifblank} to \sty{etoolbox} package\see{aut:aux:tst}
%\item Removed \cmd{xifblank}\see{aut:aux:tst}
%\item Moved \cmd{docsvlist} to \sty{etoolbox} package\see{aut:aux:msc}
%\item Updated documentation of \cmd{docsvfield}\see{aut:aux:msc}
%\item Added \cmd{ifciteibid}\see{aut:aux:tst}
%\item Added \cmd{iffootnote}\see{aut:aux:tst}
%\item Added \cmd{iffieldxref}\see{aut:aux:tst}
%\item Added \cmd{iflistxref}\see{aut:aux:tst}
%\item Added \cmd{ifnamexref}\see{aut:aux:tst}
%\item Added \cmd{ifmoreitems}\see{aut:aux:tst}
%\item Added \cmd{ifbibstring}\see{aut:aux:tst}
%\item Added \cmd{iffieldbibstring}\see{aut:aux:tst}
%\item Added \cmd{mkpageprefix}\see{aut:aux:msc}
%\item Added \cmd{NumCheckSetup}\see{aut:aux:msc}
%\item Added \cmd{pno}\see{use:cit:msc}
%\item Added \cmd{ppno}\see{use:cit:msc}
%\item Added \cmd{nopp}\see{use:cit:msc}
%\item Added \cmd{ppspace}\see{aut:aux:msc}
%\item Added \cmd{psq}\see{use:cit:msc}
%\item Added \cmd{psqq}\see{use:cit:msc}
%\item Added \cmd{sqspace}\see{aut:aux:msc}
%\item Expanded documentation\see{bib:use:pag}
%\item Expanded documentation\see{use:cav:pag}
%\item Added \cmd{RN}\see{use:cit:msc}
%\item Added \cmd{Rn}\see{use:cit:msc}
%\item Added \cmd{RNfont}\see{use:cit:msc}
%\item Added \cmd{Rnfont}\see{use:cit:msc}
%\item Added package option \opt{punctfont}\see{use:opt:pre:gen}
%\item Added \cmd{setpunctfont}\see{aut:pct:new}
%\item Added \cmd{resetpunctfont}\see{aut:pct:new}
%\item Added \cmd{nopunct}\see{aut:pct:pct}
%\item Added \cmd{bibxstring}\see{aut:str}
%\item Added \cmd{mkbibemph}\see{aut:fmt:ich}
%\item Added \cmd{mkbibquote}\see{aut:fmt:ich}
%\item Added \cmd{mkbibfootnote}\see{aut:fmt:ich}
%\item Added \cmd{mkbibsuperscript}\see{aut:fmt:ich}
%\item Added \cmd{currentfield}\see{aut:fmt:ilc}
%\item Added \cmd{currentlist}\see{aut:fmt:ilc}
%\item Added \cmd{currentname}\see{aut:fmt:ilc}
%\item Added \cmd{AtNextCite}\see{aut:fmt:hok}
%\item Added \cmd{AtNextCitekey}\see{aut:fmt:hok}
%\item Added \cmd{AtDataInput}\see{aut:fmt:hok}
%\item Added several new localisation keys\see{aut:lng:key}
%\item Added support for Norwegian (translations by Johannes Wilm)
%\item Added support for Danish (translations by Johannes Wilm)
%\item Expanded documentation\see{aut:cav:grp}
%\item Expanded documentation\see{aut:cav:mif}
%\item Numerous improvements under the hood
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.6}{2007-01-06}
%
%\item Added package option \kvopt{sorting}{none}\see{use:opt:pre:gen}
%\item Renamed package option \kvopt{block}{penalty} to \kvopt{block}{ragged}\see{use:opt:pre:gen}
%\item Changed data type of \bibfield{origlanguage} back to field\see{bib:fld:dat}
%\item Support \bibfield{origlanguage} field if \bibfield{translator} is present\see{bib:typ:blx}
%\item Renamed field \bibfield{articleid} to \bibfield{id}\see{bib:fld:dat}
%\item Support \bibfield{id} field in \bibfield{article} entries\see{bib:typ:blx}
%\item Support \bibfield{series} field in \bibfield{article} entries\see{bib:typ:blx}
%\item Support \bibfield{doi} field\see{bib:typ:blx}
%\item Updated documentation of all entry types\see{bib:typ:blx}
%\item Updated documentation of field \bibfield{series}\see{bib:fld:dat}
%\item Added field \bibfield{redactor}\see{bib:fld:dat}
%\item Added field \bibfield{shortauthor}\see{bib:fld:dat}
%\item Added field \bibfield{shorteditor}\see{bib:fld:dat}
%\item Improved support for corporate authors and editors\see{bib:use:inc}
%\item Updated documentation of field \bibfield{labelname}\see{aut:bbx:fld}
%\item Added field alias \bibfield{key}\see{bib:fld:als}
%\item Added package option \opt{autocite}\see{use:opt:pre:gen}
%\item Added package option \opt{autopunct}\see{use:opt:pre:gen}
%\item Added \cmd{autocite}\see{use:cit:aut}
%\item Added \cmd{DeclareAutoCiteCommand}\see{aut:cbx:cbx}
%\item Added \cmd{DeclareAutoPunctuation}\see{aut:pct:cfg}
%\item Added option \opt{filter} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added \cmd{defbibfilter}\see{use:bib:flt}
%\item Added package option \opt{maxitems}\see{use:opt:pre:gen}
%\item Added package option \opt{minitems}\see{use:opt:pre:gen}
%\item Added option \opt{maxitems} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{minitems} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{maxitems} to \cmd{bibbysection}\see{use:bib:bib}
%\item Added option \opt{minitems} to \cmd{bibbysection}\see{use:bib:bib}
%\item Added option \opt{maxitems} to \cmd{bibbysegment}\see{use:bib:bib}
%\item Added option \opt{minitems} to \cmd{bibbysegment}\see{use:bib:bib}
%\item Added option \opt{maxitems} to \cmd{bibbycategory}\see{use:bib:bib}
%\item Added option \opt{minitems} to \cmd{bibbycategory}\see{use:bib:bib}
%\item Added option \opt{maxitems} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added option \opt{minitems} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added counter \cnt{maxitems}\see{aut:fmt:ilc}
%\item Added counter \cnt{minitems}\see{aut:fmt:ilc}
%\item Added adapted headings for \sty{scrartcl}, \sty{scrbook}, \sty{scrreprt}\see{int:pre:cmp}
%\item Added adapted headings for \sty{memoir}\see{int:pre:cmp}
%\item Added \cmd{Cite}\see{use:cit:std}
%\item Added \cmd{Parencite}\see{use:cit:std}
%\item Added \cmd{Textcite}\see{use:cit:cbx}
%\item Added \cmd{parencite*}\see{use:cit:cbx}
%\item Added \cmd{supercite}\see{use:cit:cbx}
%\item Added \cmd{Citeauthor}\see{use:cit:txt}
%\item Added \cmd{nameyeardelim}\see{use:fmt:fmt}
%\item Added \cmd{multilistdelim}\see{use:fmt:fmt}
%\item Completed documenation\see{use:fmt:fmt}
%\item Completed documenation\see{aut:fmt:fmt}
%\item Added \cmd{usecitecmd}\see{aut:cbx:cbx}
%\item Added \cmd{hyphenate}\see{use:fmt:aux}
%\item Added \cmd{hyphen}\see{use:fmt:aux}
%\item Added \cmd{nbhyphen}\see{use:fmt:aux}
%\item Improved \cmd{ifsamepage}\see{aut:aux:tst}
%\item Removed \cmd{ifnameequalstr}\see{aut:aux:tst}
%\item Removed \cmd{iflistequalstr}\see{aut:aux:tst}
%\item Added \cmd{ifcapital}\see{aut:aux:tst}
%\item Added documentation of \cmd{MakeCapital}\see{aut:aux:msc}
%\item Added starred variant to \cmd{setunit}\see{aut:pct:new}
%\item Improved \cmd{ifterm}\see{aut:pct:chk}
%\item Straightened out documentation of \cmd{thelist}\see{aut:aux:dat}
%\item Straightened out documentation of \cmd{thename}\see{aut:aux:dat}
%\item Added \cmd{docsvfield}\see{aut:aux:msc}
%\item Added \cmd{docsvlist}\see{aut:aux:msc}
%\item Removed \cmd{CopyFieldFormat}\see{aut:bib:fmt}
%\item Removed \cmd{CopyIndexFieldFormat}\see{aut:bib:fmt}
%\item Removed \cmd{CopyListFormat}\see{aut:bib:fmt}
%\item Removed \cmd{CopyIndexListFormat}\see{aut:bib:fmt}
%\item Removed \cmd{CopyNameFormat}\see{aut:bib:fmt}
%\item Removed \cmd{CopyIndexNameFormat}\see{aut:bib:fmt}
%\item Added \cmd{savefieldformat}\see{aut:aux:msc}
%\item Added \cmd{restorefieldformat}\see{aut:aux:msc}
%\item Added \cmd{savelistformat}\see{aut:aux:msc}
%\item Added \cmd{restorelistformat}\see{aut:aux:msc}
%\item Added \cmd{savenameformat}\see{aut:aux:msc}
%\item Added \cmd{restorenameformat}\see{aut:aux:msc}
%\item Added \cmd{savebibmacro}\see{aut:aux:msc}
%\item Added \cmd{restorebibmacro}\see{aut:aux:msc}
%\item Added \cmd{savecommand}\see{aut:aux:msc}
%\item Added \cmd{restorecommand}\see{aut:aux:msc}
%\item Added documentation of \texttt{shorthands} driver\see{aut:bbx:bbx}
%\item Rearranged, renamed, and extended localisation keys\see{aut:lng:key}
%\item Renamed counter \cnt{citecount} to \cnt{instcount}\see{aut:fmt:ilc}
%\item Added new counter \cnt{citecount}\see{aut:fmt:ilc}
%\item Added counter \cnt{citetotal}\see{aut:fmt:ilc}
%\item Rearranged and expanded documentation\see{bib:use}
%\item Expanded documentation\see{bib:cav}
%\item Expanded documentation\see{use:cav:scr}
%\item Expanded documentation\see{use:cav:mem}
%\item Completed support for Spanish\see{use:loc:esp}
%\item Added support for Italian (translations by Enrico Gregorio)
%\item Added language alias \opt{australian}\see{bib:fld:spc}
%\item Added language alias \opt{newzealand}\see{bib:fld:spc}
%\item Various minor improvements throughout
%
%\end{release}
%
%\begin{release}{0.5}{2006-11-12}
%
%\item Added \cmd{usedriver}\see{aut:aux:msc}
%\item Added package option \opt{pagetracker}\see{use:opt:pre:gen}
%\item Added \cmd{iffirstonpage}\see{aut:aux:tst}
%\item Added \cmd{ifsamepage}\see{aut:aux:tst}
%\item Corrected documentation of \cmd{ifciteseen}\see{aut:aux:tst}
%\item Added package option \opt{terseinits}\see{use:opt:pre:gen}
%\item Modified default value of package option \opt{maxnames}\see{use:opt:pre:gen}
%\item Renamed package option \opt{index} to \opt{indexing}\see{use:opt:pre:gen}
%\item Extended package option \opt{indexing}\see{use:opt:pre:gen}
%\item Removed package option \opt{citeindex}\see{use:opt:pre:gen}
%\item Removed package option \opt{bibindex}\see{use:opt:pre:gen}
%\item Added package option \opt{labelalpha}\see{use:opt:pre:int}
%\item Updated documentation of field \bibfield{labelalpha}\see{aut:bbx:fld}
%\item Added package option \opt{labelctitle}\see{use:opt:pre:int}
%\item Updated documentation of field \bibfield{labelctitle}\see{aut:bbx:fld}
%\item Added package option \opt{labelnumber}\see{use:opt:pre:int}
%\item Updated documentation of field \bibfield{labelnumber}\see{aut:bbx:fld}
%\item Added package option \opt{labelyear}\see{use:opt:pre:int}
%\item Updated documentation of field \bibfield{labelyear}\see{aut:bbx:fld}
%\item Added citation style \texttt{authortitle-verb}\see{use:xbx:cbx}
%\item Added citation style \texttt{authortitle-cverb}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{traditional} to \texttt{authortitle-trad}\see{use:xbx:cbx}
%\item Improved citation style \texttt{authortitle-trad}\see{use:xbx:cbx}
%\item Added citation style \texttt{authortitle-strad}\see{use:xbx:cbx}
%\item Improved bibliography style \texttt{authoryear}\see{use:xbx:bbx}
%\item Improved bibliography style \texttt{authortitle}\see{use:xbx:bbx}
%\item Added option \opt{maxnames} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{minnames} to \cmd{printbibliography}\see{use:bib:bib}
%\item Added option \opt{maxnames} to \cmd{bibbysection}\see{use:bib:bib}
%\item Added option \opt{minnames} to \cmd{bibbysection}\see{use:bib:bib}
%\item Added option \opt{maxnames} to \cmd{bibbysegment}\see{use:bib:bib}
%\item Added option \opt{minnames} to \cmd{bibbysegment}\see{use:bib:bib}
%\item Added option \opt{maxnames} to \cmd{bibbycategory}\see{use:bib:bib}
%\item Added option \opt{minnames} to \cmd{bibbycategory}\see{use:bib:bib}
%\item Added option \opt{maxnames} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Added option \opt{minnames} to \cmd{printshorthands}\see{use:bib:biblist}
%\item Renamed \env{bibsection} to \env{refsection} (conflict with \sty{memoir})\see{use:bib:sec}
%\item Renamed \env{bibsegment} to \env{refsegment} (consistency)\see{use:bib:seg}
%\item Extended \env{refsection} environment\see{use:bib:sec}
%\item Renamed \env{bibsection} counter to \env{refsection}\see{aut:fmt:ilc}
%\item Renamed \env{bibsegment} counter to \env{refsegment}\see{aut:fmt:ilc}
%\item Updated documentation\see{use:use:mlt}
%\item Added counter \cnt{citecount}\see{aut:fmt:ilc}
%\item Modified default definition of \cmd{blxauxprefix}\see{use:use:aux}
%\item Added \cmd{CopyFieldFormat}\see{aut:bib:fmt}
%\item Added \cmd{CopyIndexFieldFormat}\see{aut:bib:fmt}
%\item Added \cmd{CopyListFormat}\see{aut:bib:fmt}
%\item Added \cmd{CopyIndexListFormat}\see{aut:bib:fmt}
%\item Added \cmd{CopyNameFormat}\see{aut:bib:fmt}
%\item Added \cmd{CopyIndexNameFormat}\see{aut:bib:fmt}
%\item Added \cmd{clearfield}\see{aut:aux:dat}
%\item Added \cmd{clearlist}\see{aut:aux:dat}
%\item Added \cmd{clearname}\see{aut:aux:dat}
%\item Added \cmd{restorefield}\see{aut:aux:dat}
%\item Added \cmd{restorelist}\see{aut:aux:dat}
%\item Added \cmd{restorename}\see{aut:aux:dat}
%\item Renamed \cmd{bibhyperlink} to \cmd{bibhyperref}\see{aut:aux:msc}
%\item Added new command \cmd{bibhyperlink}\see{aut:aux:msc}
%\item Added \cmd{bibhypertarget}\see{aut:aux:msc}
%\item Renamed formatting directive \texttt{bibhyperlink} to \texttt{bibhyperref}\see{aut:fmt:ich}
%\item Added new formatting directive \texttt{bibhyperlink}\see{aut:fmt:ich}
%\item Added formatting directive \texttt{bibhypertarget}\see{aut:fmt:ich}
%\item Added \cmd{addlpthinspace}\see{aut:pct:spc}
%\item Added \cmd{addhpthinspace}\see{aut:pct:spc}
%\item Added field \bibfield{annotator}\see{bib:fld:dat}
%\item Added field \bibfield{commentator}\see{bib:fld:dat}
%\item Added field \bibfield{introduction}\see{bib:fld:dat}
%\item Added field \bibfield{foreword}\see{bib:fld:dat}
%\item Added field \bibfield{afterword}\see{bib:fld:dat}
%\item Updated documentation of field \bibfield{translator}\see{bib:fld:dat}
%\item Added field \bibfield{articleid}\see{bib:fld:dat}
%\item Added field \bibfield{doi}\see{bib:fld:dat}
%\item Added field \bibfield{file}\see{bib:fld:dat}
%\item Added field alias \bibfield{pdf}\see{bib:fld:als}
%\item Added field \bibfield{indextitle}\see{bib:fld:dat}
%\item Added field \bibfield{indexsorttitle}\see{bib:fld:spc}
%\item Changed data type of \bibfield{language}\see{bib:fld:dat}
%\item Changed data type of \bibfield{origlanguage}\see{bib:fld:dat}
%\item Updated documentation of entry type \bibfield{book}\see{bib:typ:blx}
%\item Updated documentation of entry type \bibfield{collection}\see{bib:typ:blx}
%\item Updated documentation of entry type \bibfield{inbook}\see{bib:typ:blx}
%\item Updated documentation of entry type \bibfield{incollection}\see{bib:typ:blx}
%\item Extended entry type \bibfield{misc}\see{bib:typ:blx}
%\item Added \cmd{UndefineBibliographyExtras}\see{use:lng}
%\item Added \cmd{UndeclareBibliographyExtras}\see{aut:lng:cmd}
%\item Added \cmd{finalandcomma}\see{use:fmt:lng}
%\item Added localisation key \texttt{citedas}\see{aut:lng:key}
%\item Renamed localisation key \texttt{editby} to \texttt{edited}\see{aut:lng:key}
%\item Renamed localisation key \texttt{transby} to \texttt{translated}\see{aut:lng:key}
%\item Added localisation key \texttt{annotated}\see{aut:lng:key}
%\item Added localisation key \texttt{commented}\see{aut:lng:key}
%\item Added localisation key \texttt{introduced}\see{aut:lng:key}
%\item Added localisation key \texttt{foreworded}\see{aut:lng:key}
%\item Added localisation key \texttt{afterworded}\see{aut:lng:key}
%\item Added localisation key \texttt{commentary}\see{aut:lng:key}
%\item Added localisation key \texttt{annotations}\see{aut:lng:key}
%\item Added localisation key \texttt{introduction}\see{aut:lng:key}
%\item Added localisation key \texttt{foreword}\see{aut:lng:key}
%\item Added localisation key \texttt{afterword}\see{aut:lng:key}
%\item Added localisation key \texttt{doneby}\see{aut:lng:key}
%\item Added localisation key \texttt{itemby}\see{aut:lng:key}
%\item Added localisation key \texttt{spanish}\see{aut:lng:key}
%\item Added localisation key \texttt{latin}\see{aut:lng:key}
%\item Added localisation key \texttt{greek}\see{aut:lng:key}
%\item Modified localisation key \texttt{fromenglish}\see{aut:lng:key}
%\item Modified localisation key \texttt{fromfrench}\see{aut:lng:key}
%\item Modified localisation key \texttt{fromgerman}\see{aut:lng:key}
%\item Added localisation key \texttt{fromspanish}\see{aut:lng:key}
%\item Added localisation key \texttt{fromlatin}\see{aut:lng:key}
%\item Added localisation key \texttt{fromgreek}\see{aut:lng:key}
%\item Expanded documentation\see{bib:use}
%\item Updated documentation\see{use:xbx:cbx}
%\item Updated documentation\see{use:xbx:bbx}
%\item Updated documentation\see{use:fmt:fmt}
%\item Updated documentation\see{aut:fmt:fmt}
%\item Updated and completed documentation\see{use:fmt:lng}
%\item Updated and completed documentation\see{aut:fmt:lng}
%\item Added support for Spanish (translations by Ignacio Fernández Galván)
%\item Various memory-related optimizations in \path{biblatex.bst}
%
%\end{release}
%
%\begin{release}{0.4}{2006-10-01}
%
%\item Added package option \opt{sortlos}\see{use:opt:pre:gen}
%\item Added package option \opt{bibtex8}\see{use:opt:pre:gen}
%\item Made \bibfield{pageref} field local to \env{refsection} environment\see{aut:bbx:fld}
%\item Renamed field \bibfield{labeltitle} to \bibfield{labelctitle}\see{aut:bbx:fld}
%\item Added new field \bibfield{labeltitle}\see{aut:bbx:fld}
%\item Added new field \bibfield{sortkey}\see{bib:fld:spc}
%\item Updated documentation\see{use:srt}
%\item Removed \cmd{iffieldtrue}\see{aut:aux:tst}
%\item Renamed counter \cnt{namepenalty} to \cnt{highnamepenalty}\see{use:fmt:len}
%\item Added counter \cnt{lownamepenalty}\see{use:fmt:len}
%\item Added documentation of \cmd{noligature}\see{use:fmt:aux}
%\item Added \cmd{addlowpenspace}\see{aut:pct:spc}
%\item Added \cmd{addhighpenspace}\see{aut:pct:spc}
%\item Added \cmd{addabbrvspace}\see{aut:pct:spc}
%\item Added \cmd{adddotspace}\see{aut:pct:spc}
%\item Added \cmd{addslash}\see{aut:pct:spc}
%\item Expanded documentation\see{use:cav}
%\item Various minor improvements throughout
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.3}{2006-09-24}
%
%\item Renamed citation style \texttt{authortitle} to \texttt{authortitle-terse}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-comp} to \texttt{authortitle-cterse}\see{use:xbx:cbx}
%\item Renamed citation style \texttt{authortitle-verb} to \texttt{authortitle}\see{use:xbx:cbx}
%\item Added new citation style \texttt{authortitle-comp}\see{use:xbx:cbx}
%\item Citation style \texttt{traditional} now supports <loc.~cit.>\see{use:xbx:cbx}
%\item Added package option \opt{date}\see{use:opt:pre:gen}
%\item Added package option \opt{urldate}\see{use:opt:pre:gen}
%\item Introduced new data type: literal lists\see{bib:fld}
%\item Renamed \cmd{citename} to \cmd{citeauthor}\see{use:cit:txt}
%\item Renamed \cmd{citelist} to \cmd{citename}\see{use:cit:low}
%\item Added new \cmd{citelist} command\see{use:cit:low}
%\item Renamed \cmd{printlist} to \cmd{printnames}\see{aut:bib:dat}
%\item Added new \cmd{printlist} command\see{aut:bib:dat}
%\item Renamed \cmd{indexlist} to \cmd{indexnames}\see{aut:bib:dat}
%\item Added new \cmd{indexlist} command\see{aut:bib:dat}
%\item Renamed \cmd{DeclareListFormat} to \cmd{DeclareNameFormat}\see{aut:bib:fmt}
%\item Added new \cmd{DeclareListFormat} command\see{aut:bib:fmt}
%\item Renamed \cmd{DeclareListAlias} to \cmd{DeclareNameAlias}\see{aut:bib:fmt}
%\item Added new \cmd{DeclareListAlias} command\see{aut:bib:fmt}
%\item Renamed \cmd{DeclareIndexListFormat} to \cmd{DeclareIndexNameFormat}\see{aut:bib:fmt}
%\item Added new \cmd{DeclareIndexListFormat} command\see{aut:bib:fmt}
%\item Renamed \cmd{DeclareIndexListAlias} to \cmd{DeclareIndexNameAlias}\see{aut:bib:fmt}
%\item Added new \cmd{DeclareIndexListAlias} command\see{aut:bib:fmt}
%\item Renamed \cmd{biblist} to \cmd{thename}\see{aut:aux:dat}
%\item Added new \cmd{thelist} command\see{aut:aux:dat}
%\item Renamed \cmd{bibfield} to \cmd{thefield}\see{aut:aux:dat}
%\item Renamed \cmd{savelist} to \cmd{savename}\see{aut:aux:dat}
%\item Added new \cmd{savelist} command\see{aut:aux:dat}
%\item Renamed \cmd{savelistcs} to \cmd{savenamecs}\see{aut:aux:dat}
%\item Added new \cmd{savelistcs} command\see{aut:aux:dat}
%\item Renamed \cmd{iflistundef} to \cmd{ifnameundef}\see{aut:aux:tst}
%\item Added new \cmd{iflistundef} test\see{aut:aux:tst}
%\item Renamed \cmd{iflistsequal} to \cmd{ifnamesequal}\see{aut:aux:tst}
%\item Added new \cmd{iflistsequal} test\see{aut:aux:tst}
%\item Renamed \cmd{iflistequals} to \cmd{ifnameequals}\see{aut:aux:tst}
%\item Added new \cmd{iflistequals} test\see{aut:aux:tst}
%\item Renamed \cmd{iflistequalcs} to \cmd{ifnameequalcs}\see{aut:aux:tst}
%\item Added new \cmd{iflistequalcs} test\see{aut:aux:tst}
%\item Renamed \cmd{iflistequalstr} to \cmd{ifnameequalstr}\see{aut:aux:tst}
%\item Added new \cmd{iflistequalstr} test\see{aut:aux:tst}
%\item Renamed \cmd{ifcurrentlist} to \cmd{ifcurrentname}\see{aut:aux:tst}
%\item Added new \cmd{ifcurrentlist} test\see{aut:aux:tst}
%\item Entry type alias \bibtype{conference} now resolved by \bibtex\see{bib:typ:als}
%\item Entry type alias \bibtype{mastersthesis} now resolved by \bibtex\see{bib:typ:als}
%\item Entry type alias \bibtype{phdthesis} now resolved by \bibtex\see{bib:typ:als}
%\item Entry type alias \bibtype{techreport} now resolved by \bibtex\see{bib:typ:als}
%\item Entry type alias \bibtype{www} now resolved by \bibtex\see{bib:typ:als}
%\item Added new custom fields \bibfield{lista} through \bibfield{listf}\see{bib:fld:ctm}
%\item Changed data type of \bibfield{location}\see{bib:fld:dat}
%\item Changed data type of \bibfield{origlocation}\see{bib:fld:dat}
%\item Changed data type of \bibfield{publisher}\see{bib:fld:dat}
%\item Changed data type of \bibfield{institution}\see{bib:fld:dat}
%\item Changed data type of \bibfield{organization}\see{bib:fld:dat}
%\item Modified values of \bibfield{gender} field for \sty{jurabib} compatibility\see{bib:fld:spc}
%\item Modified and extended \texttt{idem\dots} keys for \sty{jurabib} compatibility\see{aut:lng:key}
%\item Improved \cmd{addtocategory}\see{use:bib:cat}
%\item Removed formatting command \cmd{mkshorthand}\see{use:fmt:fmt}
%\item Added field formatting directive \texttt{shorthandwidth}\see{aut:fmt:ich}
%\item Added documentation of \cmd{shorthandwidth}\see{aut:fmt:ilc}
%\item Removed formatting command \cmd{mklabelnumber}\see{use:fmt:fmt}
%\item Added field formatting directive \texttt{labelnumberwidth}\see{aut:fmt:ich}
%\item Added documentation of \cmd{labelnumberwidth}\see{aut:fmt:ilc}
%\item Removed formatting command \cmd{mklabelalpha}\see{use:fmt:fmt}
%\item Added field formatting directive \texttt{labelalphawidth}\see{aut:fmt:ich}
%\item Added documentation of \cmd{labelalphawidth}\see{aut:fmt:ilc}
%\item Renamed \cmd{bibitem} to \cmd{thebibitem}\see{aut:bbx:env}
%\item Renamed \cmd{lositem} to \cmd{thelositem}\see{aut:bbx:env}
%\item Modified \cmd{AtBeginBibliography}\see{aut:fmt:hok}
%\item Added \cmd{AtBeginShorthands}\see{aut:fmt:hok}
%\item Added \cmd{AtEveryLositem}\see{aut:fmt:hok}
%\item Extended \sty{showkeys} compatibility to list of shorthands\see{int:pre:cmp}
%\item Added compatibility code for the \sty{hyperref} package\see{int:pre:cmp}
%\item Added package option \opt{hyperref}\see{use:opt:pre:gen}
%\item Added package option \opt{backref}\see{use:opt:pre:gen}
%\item Added field \bibfield{pageref}\see{aut:bbx:fld}
%\item Added \cmd{ifhyperref}\see{aut:aux:msc}
%\item Added \cmd{bibhyperlink}\see{aut:aux:msc}
%\item Added field formatting directive \texttt{bibhyperlink}\see{aut:fmt:ich}
%\item Renamed \cmd{ifandothers} to \cmd{ifmorenames}\see{aut:aux:tst}
%\item Added new \cmd{ifandothers} test\see{aut:aux:tst}
%\item Removed field \bibfield{moreauthor}\see{aut:bbx:fld}
%\item Removed field \bibfield{morebookauthor}\see{aut:bbx:fld}
%\item Removed field \bibfield{moreeditor}\see{aut:bbx:fld}
%\item Removed field \bibfield{morelabelname}\see{aut:bbx:fld}
%\item Removed field \bibfield{moretranslator}\see{aut:bbx:fld}
%\item Removed field \bibfield{morenamea}\see{aut:bbx:fld}
%\item Removed field \bibfield{morenameb}\see{aut:bbx:fld}
%\item Removed field \bibfield{morenamec}\see{aut:bbx:fld}
%\item Updated documentation\see{aut:int}
%\item Updated documentation\see{aut:bbx:bbx}
%\item Updated documentation\see{aut:bbx:env}
%\item Updated documentation\see{aut:bbx:drv}
%\item Expanded documentation\see{aut:fmt}
%\item Modified internal \bibtex interface
%\item Fixed some typos in the manual
%\item Fixed some bugs
%
%\end{release}
%
%\begin{release}{0.2}{2006-09-06}
%
%\item Added bibliography categories\see{use:bib:cat}
%\item Added \cmd{DeclareBibliographyCategory}\see{use:bib:cat}
%\item Added \cmd{addtocategory}\see{use:bib:cat}
%\item Added \texttt{category} and \texttt{notcategory} filters\see{use:bib:bib}
%\item Added \cmd{bibbycategory}\see{use:bib:bib}
%\item Added usage examples for bibliography categories\see{use:use:div}
%\item Added documentation of configuration file\see{use:cfg:cfg}
%\item Added documentation of \cmd{ExecuteBibliographyOptions}\see{use:cfg:opt}
%\item Added documentation of \cmd{AtBeginBibliography}\see{aut:fmt:hok}
%\item Added \cmd{AtEveryBibitem}\see{aut:fmt:hok}
%\item Added \cmd{AtEveryCite}\see{aut:fmt:hok}
%\item Added \cmd{AtEveryCitekey}\see{aut:fmt:hok}
%\item Added optional argument to \cmd{printtext}\see{aut:bib:dat}
%\item Added \cmd{ifpage}\see{aut:aux:tst}
%\item Added \cmd{ifpages}\see{aut:aux:tst}
%\item Added field \bibfield{titleaddon}\see{bib:fld:dat}
%\item Added field \bibfield{booktitleaddon}\see{bib:fld:dat}
%\item Added field \bibfield{maintitleaddon}\see{bib:fld:dat}
%\item Added field \bibfield{library}\see{bib:fld:dat}
%\item Added field \bibfield{part}\see{bib:fld:dat}
%\item Added field \bibfield{origlocation}\see{bib:fld:dat}
%\item Added field \bibfield{origtitle}\see{bib:fld:dat}
%\item Added field \bibfield{origyear}\see{bib:fld:dat}
%\item Added field \bibfield{origlanguage}\see{bib:fld:dat}
%\item Modified profile of field \bibfield{language}\see{bib:fld:dat}
%\item Extended entry type \bibtype{book}\see{bib:typ:blx}
%\item Extended entry type \bibtype{inbook}\see{bib:typ:blx}
%\item Extended entry type \bibtype{collection}\see{bib:typ:blx}
%\item Extended entry type \bibtype{incollection}\see{bib:typ:blx}
%\item Extended entry type \bibtype{proceedings}\see{bib:typ:blx}
%\item Extended entry type \bibtype{inproceedings}\see{bib:typ:blx}
%\item Added entry type alias \bibtype{www}\see{bib:typ:als}
%\item Added compatibility code for the \sty{showkeys} package\see{int:pre:cmp}
%\item Support printable characters in \bibfield{keyword} and \texttt{notkeyword} filters\see{use:bib:bib}
%\item Support printable characters in \bibfield{keywords} field\see{bib:fld:spc}
%\item Ignore spaces after commas in \bibfield{keywords} field\see{bib:fld:spc}
%\item Internal rearrangement of all bibliography styles
%\item Fixed various bugs
%
%\end{release}
%
%\begin{release}{0.1}{2006-09-02}
%
%\item Initial public release
%
%\end{release}
\end{changelog}
\end{document}
%%% Local Variables:
%%% coding: utf-8
%%% eval: (auto-fill-mode -1)
%%% eval: (visual-line-mode)
%%% End:
|