-
Notifications
You must be signed in to change notification settings - Fork 8
/
new4-UserGuide.tex
4455 lines (3072 loc) · 308 KB
/
new4-UserGuide.tex
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
\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}. Note that the \sty{l3text} module assumes \utf input and that your \sty{expl3} version should be new enough (at least version 2020-04-06). \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 and detected document encoding (\opt{expl3} is selected if \sty{expl3} is at least version 2020-04-06 and the document encoding is detected as \utf).
\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\\