% $Id: biblatex.tex,v 1.5 2011/06/08 18:45:46 lehman stable $ \documentclass{ltxdockit}[2011/03/25] \usepackage{btxdockit} \usepackage[latin9]{inputenc} \usepackage[american]{babel} \usepackage[strict]{csquotes} \usepackage{tabularx} \usepackage{longtable} \usepackage{booktabs} \usepackage{shortvrb} \MakeAutoQuote{«}{»} \MakeAutoQuote*{<}{>} \MakeShortVerb{\|} \rcsid{$Id: biblatex.tex,v 1.5 2011/06/08 18:45:46 lehman stable $} \newcommand*{\biber}{Biber\xspace} \newcommand*{\biblatex}{Biblatex\xspace} \newcommand*{\biblatexhome}{http://sourceforge.net/projects/biblatex/} \newcommand*{\biblatexctan}{http://www.ctan.org/tex-archive/macros/latex/contrib/biblatex/} \titlepage{% title={The \sty{biblatex} Package}, subtitle={Programmable Bibliographies and Citations}, url={\biblatexhome}, author={Philipp Lehman}, email={plehman@gmx.net}, revision={\rcsrevision}, date={\rcstoday}} \hypersetup{% pdftitle={The \biblatex Package}, pdfsubject={Programmable Bibliographies and Citations}, pdfauthor={Philipp Lehman}, 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{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}}} % 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*{\BiberOnly}{% \textcolor{spot}{\margnotefont Biber only}} \newrobustcmd*{\BiberOnlyMark}{% \leavevmode\marginpar{\BiberOnly}} \newrobustcmd*{\BibTeXOnly}{% \textcolor{spot}{\margnotefont BibTeX only}} \newrobustcmd*{\BibTeXOnlyMark}{% \leavevmode\marginpar{\BibTeXOnly}} \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 \sty{biblatex} package. Look at the sample documents which ship with \sty{biblatex} to get a first impression.\fnurl{\biblatexctan/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 \sty{biblatex}} \label{int:abt} This package provides advanced bibliographic facilities for use with \latex in conjunction with \bibtex. The package is a complete reimplementation of the bibliographic facilities provided by \latex. It redesigns the way in which \latex interacts with \bibtex at a fairly fundamental level. With \sty{biblatex}, \bibtex is only used to sort the bibliography and to generate labels. Instead of being implemented in \file{bst} files, the formatting of the bibliography is entirely controlled by \latex macros, hence the name \sty{biblatex}. Good working knowledge in \latex should be sufficient to design new bibliography and citation styles. There is no need to learn \bibtex's postfix stack language. This package also supports subdivided bibliographies, multiple bibliographies within one document, and separate lists of bibliographic shorthands. Bibliographies may be subdivided into parts and\slash or segmented by topics. Just like the bibliography styles, all citation commands may be freely defined. The package is completely localized and can interface with the \sty{babel} package. Please refer to \tabref{bib:fld:tab1} for a list of languages currently supported by this package. \subsection{License} Copyright \textcopyright\ 2006--2011 Philipp Lehman. Permission is granted to copy, distribute and\slash or modify this software under the terms of the \lppl, version 1.3.\fnurl{http://www.ctan.org/tex-archive/macros/latex/base/lppl.txt} This package is author"=maintained. \subsection{Feedback} \label{int:feb} Please use the \sty{biblatex} project page on SourceForge to report bugs and submit feature requests.\fnurl{http://sourceforge.net/projects/biblatex/} There are two trackers on this page: \texttt{Bugs} for bug reports and \texttt{Features} for feature requests.\fnurl{http://sourceforge.net/tracker2/?group_id=244752} Select a tracker, then click on to submit your report or request. I may consider implementing a new feature if the request is reasonable, seems to be relevant to a considerable number of users, and complies with the architecture and philosophy of \sty{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. I can not provide end-user support by email or via the project page. \subsection{Acknowledgments} The language modules of this package include contributions by the following contributors (in the order of submission): Ignacio Fernández Galván (Spanish), Enrico Gregorio (Italian), Johannes Wilm (Danish\slash Norwegian), Per Starbäck, Carl-Gustav Werner, Filip Åsblom (Swedish), Augusto Ritter Stoffel (Brazilian), Alexander van Loon (Dutch), Apostolos Syropoulos (Greek), Hannu Väisänen (Finnish), Prokopis (Greek), Mateus Araújo (Brazilian), Andrea Marchitelli (Italian), José Carlos Santos (Portuguese). \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 \sty{biblatex} to function. The package will not work if they are not available. \begin{marglist} \item[\etex] The \sty{biblatex} package requires \etex. \tex distributions have been shipping \etex binaries for quite some time, the popular distributions use them by default these days. The \sty{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[\bibtex] By default, the \sty{biblatex} package uses \bibtex as a database backend. While a legacy \bibtex binary is sufficient to run \sty{biblatex}, using \bin{bibtex8} is recommended. If your \tex distribution does not ship with \bin{bibtex8}, you can get it from \acr{CTAN}.\fnurl{http://www.ctan.org/tex-archive/biblio/bibtex/8-bit/} \item[Biber] Biber is the next"=generation backend of \sty{biblatex}. You only need one backend, either \bibtex or Biber. Biber is available from SourceForge.\fnurl{http://biblatex-biber.sourceforge.net/} \item[etoolbox] This \latex package, which is loaded automatically, provides generic programming facilities required by \sty{biblatex}. It is available from \acr{CTAN}.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/etoolbox/} \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{http://www.ctan.org/tex-archive/macros/latex/contrib/logreq/} \end{marglist} Apart from the above resources, \sty{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 required for \sty{biblatex} to function, but they provide recommended additional functions or enhance existing features. The package loading order does not matter. \begin{marglist} \item[babel] The \sty{babel} package provides the core architecture for multilingual typesetting. If you are writing in a language other than American English, using this package is strongly recommended. If loaded, \sty{biblatex} package will detect \sty{babel} automatically. \item[csquotes] If this package is available, \sty{biblatex} will use its language sensitive quotation facilities to enclose certain titles in quotation marks. If not, \sty{biblatex} uses quotes suitable for American English as a fallback. When writing in any other language, loading \sty{csquotes} is strongly recommended.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/csquotes/} \end{marglist} \subsubsection{Compatible Classes and Packages} \label{int:pre:cmp} The \sty{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 \sty{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. \end{marglist} \subsubsection{Incompatible Packages} \label{int:pre:inc} The packages listed in this section are not compatible with \sty{biblatex}. Since it reimplements the bibliographic facilities of \latex from the ground up, \sty{biblatex} naturally conflicts with all packages modifying the same facilities. This is not specific to \sty{biblatex}. Some of the packages listed below are also incompatible with each other for the same reason. \begin{marglist} % FIXME: complete list % % amsrefs % apacite % drftcite % footbib % multibbl % overcite % bibtopicprefix \item[babelbib] The \sty{babelbib} package provides support for multilingual bibliographies. This is a standard feature of \sty{biblatex}. Use the \bibfield{hyphenation} field and the package option \opt{babel} for similar functionality. Note that \sty{biblatex} automatically adjusts to the main document language if \sty{babel} 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 \sty{biblatex} but the approaches taken by both packages are quite different. Since both \sty{jurabib} and \sty{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 \sty{biblatex} package also supports grouped citations, which are called or 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[ucs] The \sty{ucs} package provides support for \utf encoded input. Either use \sty{inputenc}'s standard \file{utf8} module or a Unicode enabled engine such as \xetex or \luatex instead. \end{marglist} \section{Database Guide} \label{bib} This part of the manual documents the \bibtex interface of this package. Note that you can not use \sty{biblatex} in conjunction with arbitrary \file{bst} files because the package depends on a special \bibtex interface. \subsection{Entry Types} \label{bib:typ} This section gives an overview of the entry types supported by \sty{biblatex} 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 ship with this package and they also serve as a model for custom styles. Note that the fields are not strictly required in all cases, see \secref{bib:use:key} for details. The fields marked as are optional in a technical sense. Bibliographical formatting rules usually require more than just the fields. The standard styles will generally not perform any formal validity checks, but custom styles may do so. 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. \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, issuetitle, issuesubtitle, 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, 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, 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, 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, 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, editor, title, booktitle, year/date} \optitem{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, 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{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, 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, date, month, year, 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 intrinsicly 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, url} \optitem{subtitle, titleaddon, language, version, note, organization, date, month, year, addendum, pubstate, 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, date, month, year, 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, issuetitle, issuesubtitle, language, series, volume, number, issue, date, month, year, 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{editor, title, year/date} \optitem{subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, eventtitle, eventdate, venue, language, volume, part, volumes, series, number, note, organization, publisher, location, month, isbn, 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{editor, title, year/date} \optitem{subtitle, titleaddon, eventtitle, 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, editor, title, booktitle, year/date} \optitem{subtitle, titleaddon, maintitle, mainsubtitle, maintitleaddon, booksubtitle, booktitleaddon, eventtitle, eventdate, venue, language, volume, part, volumes, series, number, note, organization, publisher, location, month, isbn, 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, 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{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, 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, language, howpublished, note, location, isbn, date, month, year, addendum, pubstate, url, urldate} \typeitem{custom[a--f]} Custom types for special bibliography styles. Not used by the standard styles. \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 \bibtex as the data is exported. Bibliography styles will see the entry type the alias points to, not the alias name. All unknown entry types are generally exported as \bibtype{misc}. \begin{typelist} \typeitem{conference} A \bibtex 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 localized term . 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 localized term . 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 localized term . 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{Unsupported 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 support for these types. When using the standard styles, they will be treated as \bibtype{misc} entries. \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 casette, 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{software} Computer software. \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} casette, 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 \sty{biblatex}. See \secref{bib:fld:typ} for an introduction to the data types supported by this package and \secref{bib:fld:dat, bib:fld:spc} for the actual field listings. \subsubsection{Data Types} \label{bib:fld:typ} In \file{bib} files 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 \bibtex via the keyword <|and|>, which is used to separate the individual items in the list. The \sty{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. 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 \bibtex's fields to \sty{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 four name components: the first name, the name prefix (von, van, of, da, de, della, \dots), the last name, and the name suffix (junior, senior, \dots). 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}. \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 localization keys. For each item in the list, a test is performed to determine whether it is a known localization key (the localization keys defined by default are listed in \secref{aut:lng:key}). If so, the localized string is printed. If not, the item is printed as is. 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] are literal fields with one special feature: all dashes are normalized and replaced by the command \cmd{bibrangedash}. Any number of consecutive dashes will only yield a single range dash. A typical example of a range field is the \bibfield{pages} field. \item[Integer fields] hold unformatted integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{month} field. \item[Date fields] hold a date specification in \texttt{yyyy-mm-dd} format or a date range in \texttt{yyyy-mm-dd/yyyy-mm-dd} format. Date fields are special in that the date is parsed and split up into its components. See \secref{bib:use:dat} for details. 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{url} and \bibfield{doi}. \item[Key fields] may hold printable data or localization keys. A test is performed to determine whether the value of the field is a known localization key (the localization keys defined by default are listed in \secref{aut:lng:key}). If so, the localized string is printed. If not, the value is printed as is. A typical example is the \bibfield{type} field. \item[Special fields] are fields which require a special format not mentioned above. The field description will include details on the required format in this case. Typical examples are the fields \bibfield{hyphenation}, \bibfield{keywords}, and \bibfield{gender} from \secref{bib:fld:spc}. \end{description} \end{description} The data type of a field will usually not change, regardless of the type of entry it is used in. However, there are a few special cases. The field descriptions in \secref{bib:fld:dat} include the details or pointers to the relevant sections in this manual in such cases. For example, the \bibfield{location} field, which is a literal list by default, is treated as a key list when used in \bibtype{patent} entries. The \bibfield{series} field, which is a literal field by default, is handled in a special way when used in \bibtype{article} entries, see \secref{bib:use:ser} for details. \subsubsection{Data Fields} \label{bib:fld:dat} The fields listed in this section are the regular ones holding printable data. The name on the left is the name of the field, as used by both \bibtex and \sty{biblatex}. The \sty{biblatex} data type is given to the right of the name. See \secref{bib:fld:typ} for explanation of the various data types. \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}. \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 specifiy 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 specifiy 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 specifiy 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 specifiy 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}. 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}. \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{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}. Not 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 \sty{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 or rather than the month or a number. Since the placement of \bibfield{issue} is similar to \bibfield{month} and \bibfield{number}, this field may also be useful with double issues and other special cases. See also \bibfield{month}, \bibfield{number}, and \secref{bib:use:iss}. \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{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{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 localization keys. If localization keys are used, the prefix \texttt{lang} is omissible. See also \bibfield{origlanguage} and compare \bibfield{hyphenation} 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 and is treated as a key list. 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}{integer} 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. See also \bibfield{date} as well as \secref{bib:use:iss, bib:use:dat}. \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}. With \bibtype{patent} entries, this is the number or record token of a patent or patent request. \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}. \fielditem{origlanguage}{key} If the work is a translation, the language 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). \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 . 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} 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} 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} A special designation to be used by the citation style instead of the usual label. This field is intended for citation aliasing. If defined, it overrides the default label. If any of the cited bibliography entries includes a \bibfield{shorthand} field, \sty{biblatex} automatically builds a list of shorthands which may be printed in addition to the regular bibliography; see \secref{use:bib:los} for details. 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} A short version or an acronym of the \bibfield{journaltitle}. Not used by the standard bibliography styles. \fielditem{shortseries}{literal} A short version or an acronym of the \bibfield{series} field. Not used by the standard bibliography styles. \fielditem{shorttitle}{literal} 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}{verbatim} The \acr{URL} of an online publication. \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}{literal} The volume of a multi"=volume book or a periodical. See also \bibfield{part}. \fielditem{volumes}{literal} The total number of volumes of a multi"=volume work. Depending on the entry type, this field refers to \bibfield{title} or \bibfield{maintitle}. \fielditem{year}{literal} The year of publication. See also \bibfield{date} and \secref{bib:use:dat}. \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. \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 \sty{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}{comma"=separated values} This field is specific to entry sets. See \secref{use:use:set} for details. \fielditem{entrysubtype}{identifier} 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{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}{\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 . 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} \tablesetup \begin{tabularx}{\textwidth}{@{}p{100pt}@{}p{100pt}@{}X@{}} \toprule \multicolumn{1}{@{}H}{Language} & \multicolumn{1}{@{}H}{Region/Dialect} & \multicolumn{1}{@{}H}{Babel Identifiers} \\ \cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule{3-3} 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} \\ Finnish & Finland & \opt{finnish} \\ French & France, Canada & \opt{french}, \opt{francais}, \opt{canadien} \\ German & Germany & \opt{german}, \opt{ngerman} \\ & Austria & \opt{austrian}, \opt{naustrian} \\ Greek & Greece & \opt{greek} \\ Italian & Italy & \opt{italian} \\ Norwegian & Norway & \opt{norsk}, \opt{nynorsk} \\ Portuguese& Brazil & \opt{brazil} \\ & Portugal & \opt{portuges} \\ Spanish & Spain & \opt{spanish} \\ Swedish & Sweden & \opt{swedish} \\ \bottomrule \end{tabularx} \caption{Supported Languages} \label{bib:fld:tab1} \end{table} \fielditem{hyphenation}{identifier} The language of the bibliography entry. The identifier must be a language name known to the \sty{babel} package. This information may be used to switch hyphenation patterns and localize 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 babel version. The \sty{biblatex} package always treats it as an alias for \opt{american}. It is preferable to use the language identifiers \opt{american} and \opt{british} to avoid any possible confusion. Compare \bibfield{language} in \secref{bib:fld:dat}. \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 \sty{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}{comma-separated values} A comma"=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 spaces after commas are ignored. \fielditem{options}{comma-separated \keyval options} A comma"=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. This field is only used internally during sorting. Please refer to \secref{use:srt} for further details. Also see \secref{aut:ctm:srt}. \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, \sty{biblatex} uses this field during sorting and ignores everything else, except for the \bibfield{presort} field. This field is only used internally during sorting. Please refer to \secref{use:srt} for further details. \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. It is only used internally during sorting. Please refer to \secref{use:srt} for further details. \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. It is only used internally during sorting. 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 rather than . In this case, you could put «Introduction to\dots» in the \bibfield{sorttitle} field. Please refer to \secref{use:srt} for further details. \fielditem{sortyear}{literal} A field used to modify the sorting order of the bibliography. If present, this field is used instead of the \bibfield{year} field when sorting the bibliography. It is only used internally during sorting. Please refer to \secref{use:srt} for further details. \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{mincrossrefs} 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 \sty{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 \sty{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 \sty{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 \sty{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: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 \sty{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 in \secref{bib:typ:blx} are not strictly required in all cases. The bibliography styles which ship 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 \sty{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 \bibtex 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 \sty{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 \sty{biblatex} will still work if these fields do not contain a literal . 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 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. \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 localization 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 localization key. If so, the localized 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 localization key. Consider the following example which makes use of the localization 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 localization keys defined by default. \subsubsection{Date Specifications} \label{bib:use:dat} \begin{table} \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 Format} & \multicolumn{1}{H}{Long Format} \\ \cmidrule{1-1}\cmidrule(l){2-2}\cmidrule(l){3-3} 1850 & 1850 & 1850 \\ 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 \\ \bottomrule \end{tabularx} \caption{Date Specifications} \label{bib:use:tab1} \end{table} The date fields \bibfield{date}, \bibfield{origdate}, \bibfield{eventdate}, and \bibfield{urldate} require a date specification in \texttt{yyyy-mm-dd} format. Date ranges are given as \texttt{yyyy-mm-dd\slash yyyy-mm-dd}. Partial dates are valid provided that date components are omitted at the end only. You may specify an open ended date range by giving the range separator and omitting the end date (\eg \texttt{yyyy/}). See \tabref{bib:use:tab1} for some examples of valid date specifications and the formatted date autmatically generated by \sty{biblatex}. The formatted date is language specific and will be adapted automatically. If there is no \bibfield{date} field in an entry, \sty{biblatex} will also consider the fields \bibfield{year} and \bibfield{month} for backwards compatibility with traditional \bibtex. Style author 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 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. \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 or 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{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 \sty{biblatex} add prefixes like or 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 . 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 . 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 localization 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 localization 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 localization strings for each additional pagination scheme: the singular form (whose localization key corresponds to the value of the \bibfield{pagination} field) and the plural form (whose localization 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} \paragraph{The \bibfield{crossref} field (\bibtex)} \label{bib:cav:ref:btx} The \bibfield{crossref} field is a convenient way to establish a parent\slash child relation between two associated entries. Unfortunately, \bibtex uses symmetric field mapping which reduces the usefulness of the \bibfield{crossref} field significantly. The are two issues with symmetric field mapping, as seen in the following example: \begin{lstlisting}[style=bibtex]{} @Book{book, <> = {Author}, <> = {Author}, <> = {Booktitle}, <<booktitle>> = {Booktitle}, <<subtitle>> = {Booksubtitle}, <<booksubtitle>> = {Booksubtitle}, publisher = {Publisher}, location = {Location}, date = {1995}, } @InBook{inbook, crossref = {book}, title = {Title}, <<subtitle>> = {}, pages = {5--25}, } \end{lstlisting} % As \bibtex is not capable of mapping the \bibfield{title} field of the parent to the \bibfield{booktitle} field of the child, the title of the book needs to be given twice. The style then needs to ignore the \bibfield{booktitle} of the parent since it is only required to work around this fundamental limitation of \bibtex. The problem with the \bibfield{subtitle} field is the inverse of that. Since the \bibfield{subtitle} of the parent would become the \bibfield{subtitle}, rather than in the \bibfield{booksubtitle}, of the child, we need to add an empty \bibfield{subtitle} field to the child entry to prevent inheritance of this field. Of course we also need to duplicate the subtitle in the parent entry to ensure that it is available as \bibfield{booksubtitle} in the child entry. In short, using \bibtex's \bibfield{crossref} field tends to bloat database files and corrupt the data model. \paragraph{The \bibfield{crossref} field (Biber)} \label{bib:cav:ref:bbr} With Biber, the limitations of \bibtex's \bibfield{crossref} field belong to the past. 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 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, \sty{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, \sty{biblatex} will automatically add it to the bibliography. The threshold is controlled by the \opt{mincrossrefs} package option from \secref{use:opt:pre:gen}. The \bibfield{xref} field is supported with all backends. See also \secref{bib:fld:spc}. \subsubsection{Capacity Issues} \label{bib:cav:btx} \paragraph{\bibtex} A venerable tool originally developed in the 1980s, \bibtex uses static memory allocation, much to the dismay of users working with large bibliographical databases. With a large \file{bib} file which contains several hundred entries, \bibtex is very likely to run out of memory. The number of entries it can cope with depends on the number of fields defined by the \bibtex style (\file{bst}). Style files which define a considerable number of fields, such as \path{biblatex.bst}, are more likely to trigger such problems. Unfortunately, traditional \bibtex does not output a clear error message when it runs out of memory but exposes a rather cryptical kind of faulty behavior. The warning messages printed in this case look like this: \begin{lstlisting}[style=plain]{} Warning--I'm ignoring Jones1995's extra "year" field --line 422 of file huge.bib Warning--I'm ignoring Jones1995's extra "volume" field --line 423 of file huge.bib \end{lstlisting} % These warning messages could indeed indicate that the entry \texttt{Jones1995} is faulty because it includes two \bibfield{year} and two \bibfield{volume} fields. If that is not the case and the \file{bib} file is fairly large, this is most likely a capacity issue. What makes these warnings so confusing is that they are not tied to a specific entry. If you remove the allegedly faulty entry, a different one will trigger similar warnings. This is one reason why switching to \file{bibtex8} or Biber is advisable. \paragraph{\file{bibtex8}} \file{bibtex8} is a venerable tool as well and will also run out of memory with its default capacity. Switching from traditional \bibtex to \file{bibtex8} is still an improvement because the capacity of the latter may be increased at run"=time via command"=line switches and it also prints unambiguous error messages, for example: \begin{table} \tablesetup \begin{tabularx}{\textwidth}{@{}>{\raggedright\ttfamily}X% @{}>{\raggedright\ttfamily}X% rR{50pt}R{50pt}R{50pt}@{}} \toprule \multicolumn{1}{@{}H}{Parameter} & \multicolumn{1}{@{}H}{Switch} & \multicolumn{4}{@{}H}{Capacity} \\ \cmidrule{3-6} && \multicolumn{1}{@{}H}{Default} & \multicolumn{1}{@{}>{\sffamily\bfseries\spotcolor\ttfamily}r}{-{}-big} & \multicolumn{1}{@{}>{\sffamily\bfseries\spotcolor\ttfamily}r}{-{}-huge} & \multicolumn{1}{@{}>{\sffamily\bfseries\spotcolor\ttfamily}r@{}}{-{}-wolfgang} \\ \cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule{3-6} max\_cites & -{}-mcites & 750 & 2000 & 5000 & 7500 \\ max\_ent\_ints & -{}-mentints & 3000 & 4000 & 5000 & 7500 \\ max\_ent\_strs & -{}-mentstrs & 3000 & 6000 & 10000 & 10000 \\ max\_fields & -{}-mfields & 17250 & 30000 & 85000 & 125000 \\ max\_strings & -{}-mstrings & 4000 & 10000 & 19000 & 30000 \\ pool\_size & -{}-mpool & 65530 & 130000 & 500000 & 750000 \\ wiz\_fn\_space & -{}-mwizfuns & 3000 & 6000 & 10000 & 10000 \\ hash\_prime & & 4253 & 8501 & 16319 & 30011 \\ hash\_size & & 5000 & 10000 & 19000 & 35000 \\ \bottomrule \end{tabularx} \caption[Capacity of \bin{bibtex8}]{Capacity and Switches of \bin{bibtex8}} \label{bib:cav:tab2} \end{table} \begin{lstlisting}[style=plain]{} 17289 fields: Sorry---you've exceeded BibTeX's total number of fields 17250 \end{lstlisting} % \Tabref{bib:cav:tab2} gives an overview of the various capacity parameters of \file{bibtex8} and the command"=line switches used to increase their default values. There are two ways to increase the capacity on the command"=line. You may use a high"=level switch like |--huge| to select a different set of defaults or low"=level switches such as |--mfields| to modify a single parameter. The first thing you should always do is run \file{bibtex8} with the |--wolfgang| switch. Don't even bother trying anything else. With a very large database, however, even that capacity may be too small. In this case, you need to resort to the low"=level switches. Here is an example of a set of switches which should cope with a \file{bib} file containing about 1000 entries: \begin{lstlisting}[style=plain]{} bibtex8 --wolfgang --mcites 30000 --mentints 30000 --mentstrs 40000 --mfields 250000 --mstrings 35000 --mpool 750000 --csfile csfile.csf auxfile \end{lstlisting} % When taking a closer look at \tabref{bib:cav:tab2}, you will notice that there are two parameters which can not be modified directly, |hash_prime| and |hash_size|. Increasing these values is only possible with the high"=level switches. That is why the above command includes the |--wolfgang| switch in addition to the low"=level switches. This situation is very unfortunate because the hash size effectively sets a cap on some other parameters. For example, |max_strings| can not be greater than |hash_size|. If you hit this cap, all you can do is recompile \file{bibtex8} with a larger capacity. Also note that the |wiz_fn_space| parameter is not related to the \file{bib} file but to the memory requirements of the \file{bst} file. \file{biblatex.bst} needs a value of about 6000. The value 10000 implicitly used by the |--wolfgang| switch is fine. \paragraph{Biber} Biber eliminates all of the above limitations. \subsubsection{Sorting and Encoding Issues} \label{bib:cav:enc} \paragraph{\bibtex} \label{bib:cav:enc:btx} Traditional \bibtex can only alphabetize Ascii characters correctly. If the bibliographic data includes non"=Ascii characters, they have to be given in Ascii notation. For example, instead of typing a letter like <ä> directly, you need to input it as |\"a|, using an accent command and the Ascii letter. This Ascii notation needs to be wrapped in a pair of curly braces. Traditional \bibtex will then ignore the accent and use the Ascii letter for sorting. Here are a few examples: \begin{lstlisting}[style=bibtex,upquote]{} author = {S<<{\'a}>>nchez, Jos<<{\'e}>>}, editor = {Ma<<{\ss}>>mann, R<<{\"u}>>diger}, translator = {Ferdi<<{\`e}>>re, Fr<<{\c{c}}>>ois}, title = {<<{\OE}>>uvres compl<<{\`e}>>tes}, \end{lstlisting} % Apart from it being inconvenient, there are two major issues with this convention. One subtle problem is that the extra set of braces suppresses the kerning on both sides of all non"=Ascii letters. But first and foremost, simply ignoring all accents may not be the correct way to handle them. For example, in Danish, the letter <å> is the very last letter of the alphabet, so it should be alphabetized after <z>. \bibtex will sort it like an <a>. The <æ> ligature and the letter <ø> are also sorted after <z> in this language. There are similar cases in Norwegian. In Swedish, the letter <ö> is the very last letter of the alphabet and the letters <å> and <ä> are also alphabetized after <z>, rather than like an <a>. What's more, even the sorting of Ascii characters is done in a rather peculiar way by traditional \bibtex because the sorting algorithm uses Ascii codepage order (\texttt{0-9,A-Z,a-z}). This implies that the lowercase letter <a> would end up after the uppercase <Z>, which is not even acceptable in the language \bibtex was originally designed for. The traditional \file{bst} files work around this problem by converting all strings used for sorting to lowercase, \ie sorting is effectively case"=insensitive. See also \secref{bib:cav:enc:enc}. \paragraph{\file{bibtex8}} \label{bib:cav:enc:bt8} Switching to \file{bibtex8} will help in such cases. \file{bibtex8} can sort case"=sensitively and it can handle 8-bit characters properly, provided that you supply it with a suitable \file{csf} file and give the |--csfile| switch on the command line. This also implies that it is possible to apply language specific sorting rules to the bibliography. The \sty{biblatex} package comes with \file{csf} files for some common Western European encodings. \bin{bibtex8} also ships with a few \file{csf} files. Note that \file{biblatex.bst} can not detect if it is running under traditional \bibtex or \file{bibtex8}, hence the \opt{bibtex8} package option. By default, sorting is case-insensitive since this is required for traditional \bibtex. If the \opt{bibtex8} package option is enabled, sorting is case-sensitive. Since \file{bibtex8} is backwards compatible with traditional \bibtex, it is possible to mix 8-bit input and Ascii notation. This is useful if the encoding used in the \file{bib} file does not cover all required characters. There are also a few marginal cases in which the Ascii notation scheme would yield better sorting results. A typical example is the ligature <½>. \file{bibtex8} will handle this ligature like a single character. Depending on the sorting scheme defined in the \file{csf} file, it could be treated like an <o> or alphabetized after the letter <o> but it can not be sorted as <oe>. The Ascii notation (|\oe|) is equivalent to <oe> during sorting: \begin{lstlisting}[style=bibtex,upquote]{} title = {<<¼>>uvres compl<<è>>tes}, title = {<<{\OE}>>uvres compl<<è>>tes}, \end{lstlisting} % Sometimes even that is not sufficient and further tricks are required. For example, the letter <ß> in German is particularly tricky. This letter is essentially alphabetized as <ss> but after <ss>. The name <Baßmann> would be alphabetized as follows: Basmann\slash Bassmann\slash Baßmann\slash Bastmann. In this case, the Ascii notation (|\ss|) would yield slightly better sorting results than <ß> in conjunction with a \file{csf} file which treats <ß> like <s>: \begin{lstlisting}[style=bibtex,upquote]{} author = {Ba<<{\ss}>>mann, Paul}, \end{lstlisting} % To get it absolutely right, however, you need to resort to the \bibfield{sortname} field: \begin{lstlisting}[style=bibtex,upquote]{} author = {Ba<<ß>>mann, Paul}, sortname = {Ba<<sszz>>mann, Paul}, \end{lstlisting} % Not only \bibtex, \latex needs to know about the encoding as well. See \secref{bib:cav:enc:enc} on how to specify encodings. \paragraph{Biber} 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{http://unicode.org/reports/tr10/} Collation tailoring based on the Unicode Common Locale Data Repository (\acr{CLDR}) is in the process of being added.\fnurl{http://cldr.unicode.org/} The bottom line is that Biber will deliver sorting results far superior to both \bibtex and \file{bibtex8} in many cases. If you are interested in the technical details, section 1.8 of Unicode Technical Standard \#10 will provide you with a very concise summary of why the inadequateness of traditional \bibtex and even \bin{bibtex8} is of a very general nature and not limited to the lack of \utf support.\fnurl{http://unicode.org/reports/tr10/#Common_Misperceptions} 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 <ß> mentioned as an example in \secref{bib:cav:enc:bt8} without any manual intervention. All you need to do to get localized sorting is specify the locale: \begin{lstlisting}[style=latex]{} \usepackage[backend=biber,sortlocale=de]{biblatex} \end{lstlisting} % If the language of the document corresponds to the main locale of the operating system, \opt{sortlocale} is omissible as Biber will detect the locale settings of the environment automatically. 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 \sty{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 is set properly. Depending on the backend, the \bibtex side may demand attention, too. When using \bin{bibtex8}, you need to supply \bin{bibtex8} with a matching \file{csf} file as it needs to know about the encoding of the \file{bib} file to be able to alphabetize the entries correctly. Unfortunately, there is no way for \sty{biblatex} to pass this information to \bin{bibtex8} automatically. The only way is setting its |--csfile| option on the command line when running \bin{bibtex8}. When using Biber, 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 (this will work with \bibtex, \file{bibtex8}, and Biber): \begin{lstlisting}[style=latex]{} \usepackage{biblatex} \end{lstlisting} \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 (\bibtex, \file{bibtex8}, Biber): \begin{lstlisting}[style=latex]{} \usepackage[latin1]{inputenc} \usepackage[bibencoding=ascii]{biblatex} \end{lstlisting} \item Latin\,9 encoding (\acr{ISO}-8859-15) in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex (\file{bibtex8}, Biber): \begin{lstlisting}[style=latex]{} \usepackage[latin9]{inputenc} \usepackage[bibencoding=auto]{biblatex} \end{lstlisting} % Since \kvopt{bibencoding}{auto} is the default setting, the option is omissible. The following setup will have the same effect: \begin{lstlisting}[style=latex]{} \usepackage[latin9]{inputenc} \usepackage{biblatex} \end{lstlisting} \item \utf encoding in the \file{tex} file, Latin\,1 (\acr{ISO}-8859-1) in the \file{bib} file with \pdftex or traditional \tex (\file{bibtex8}, Biber): \begin{lstlisting}[style=latex]{} \usepackage[utf8]{inputenc} \usepackage[bibencoding=latin1]{biblatex} \end{lstlisting} The same scenario with \xetex or \luatex in native \utf mode: \begin{lstlisting}[style=latex]{} \usepackage[bibencoding=latin1]{biblatex} \end{lstlisting} \item Using \utf encoding in both the \file{tex} and the \file{bib} file is not possible with traditional \bibtex or \bin{bibtex8} since neither of them is capable of handling \utf. Unless you switch to Biber, you need to use an 8-bit encoding such as Latin\,1 (see above) or resort to Ascii notation in this case: \begin{lstlisting}[style=latex]{} \usepackage[utf8]{inputenc} \usepackage[bibencoding=ascii]{biblatex} \end{lstlisting} The same scenario with \xetex or \luatex in native \utf mode: \begin{lstlisting}[style=latex]{} \usepackage[bibencoding=ascii]{biblatex} \end{lstlisting} \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 \sty{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{lstlisting}[style=latex]{} \usepackage[utf8]{inputenc} \usepackage[bibencoding=auto]{biblatex} \end{lstlisting} % Since \kvopt{bibencoding}{auto} is the default setting, the option is omissible: \begin{lstlisting}[style=latex]{} \usepackage[utf8]{inputenc} \usepackage{biblatex} \end{lstlisting} The same scenario with \xetex or \luatex in native \utf mode: \begin{lstlisting}[style=latex]{} \usepackage{biblatex} \end{lstlisting} \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{lstlisting}[style=latex]{} \usepackage[latin1]{inputenc} \usepackage[bibencoding=utf8]{biblatex} \end{lstlisting} \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 convers the Western European Unicode range. When loading \sty{inputenc} with the \file{utf8} option, \sty{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{lstlisting}[style=latex]{} \usepackage[utf8]{inputenc} \usepackage[safeinputenc]{biblatex} \end{lstlisting} % If this option is enabled, \sty{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 \texttt{\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 \texttt{\d{S}}). If you need full Unicode support, however, switch to \xetex or \luatex. \subsubsection{Editors and Compiler Scripts} \label{bib:cav:ide} This section is in need of an update to match the new script interface used by \sty{biblatex}. For the time being, see the documentation of the \sty{logreq} package\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/logreq/} and the Biblatex Developer's Wiki for a draft spec.\fnurl{http://sourceforge.net/apps/mediawiki/biblatex/index.php?title=Workflow_Automation} % FIXME: update! \section{User Guide} \label{use} This part of the manual documents the user interface of the \sty{biblatex} package. The user guide covers everything you need to know in order to use \sty{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 \sty{biblatex} is loaded, \ie in the optional argument to \cmd{usepackage}. \begin{optionlist} \valitem[numeric]{style}{file} Loads the bibliography style \path{file.bbx} and the citation style \path{file.cbx}. See \secref{use:xbx} for an overview of the standard styles. \valitem[numeric]{bibstyle}{file} Loads the bibliography style \path{file.bbx}. See \secref{use:xbx:bbx} for an overview of the standard bibliography styles. \valitem[numeric]{citestyle}{file} Loads the citation style \path{file.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. \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}] \BiberOnlyMark Use \prm{name}, as defined with \cmd{DeclareSortingScheme} (\secref{aut:ctm:srt}) \end{valuelist} Using any of the <alphabetic> sorting schemes 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 schemes or define new ones. \boolitem[true]{sortcase} Whether or not to sort the bibliography and the list of shorthands case"=sensitively. Note that case"=sensitive sorting is only supported by the \bin{bibtex8} and Biber backends. Sorting is always case"=insensitive with legacy \bibtex. See the \opt{backend} option for details. \boolitem[true]{sortupper}[\BiberOnly] This option corresponds to Biber's |--sortupper| command-line option. It has no effect with any other backend. If enabled, the bibliography is sorted in <uppercase before lowercase> order. Disabling this option means <lowercase before uppercase> order. \optitem{sortlocale}{\prm{locale}}[\BiberOnly] This option corresponds to Biber's |--sortlocale| command-line option. It has no effect with any other backend. If set, it specifies the locale to be used for sorting. While \sty{biblatex} provides no default value for this option, Biber will inherit the locale settings from the environment if no locale has been specified explicitly. \optitem[los]{sortlos}{\opt{bib}, \opt{los}} The sorting order of the list of shorthands. The following choices are available: \begin{valuelist} \item[bib] Sort according to the sorting order of the bibliography. \item[los] Sort by shorthand. \end{valuelist} \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 sorting order of the bibliography. This feature works with all citation styles. \intitem[3]{maxnames} A threshold affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list exceeds this threshold, \ie if it contains more than \prm{integer} names, it is automatically truncated according to the setting of the \opt{minnames} option. \intitem[1]{minnames} A limit affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list contains more than \prm{maxnames} names, it is automatically truncated to \prm{minnames} names in citations and in the bibliography. This also affects the sorting of the bibliography and the generation of labels. The \prm{minnames} value must be smaller than or equal to \prm{maxnames}. \intitem[\prm{maxnames}]{maxbibnames} The \opt{maxnames} and \opt{minnames} options may also be used locally in the optional arguments of \cmd{printbibliography} and \cmd{printshorthands} (see \secref{use:bib:bib,use:bib:los}). The \opt{maxbibnames} and \opt{minbibnames} options have precisely the same effect, except that they are settable in the preamble. Note that \prm{maxbibnames} should normally not be less then \prm{maxnames} because the latter affects the generation of labels. \intitem[\prm{minnames}]{minbibnames} Similar to \opt{maxbibnames} but defining the lower limit. This value must must be smaller than or equal to \prm{maxbibnames}. Note that \prm{minbibnames} should normally not be less then \prm{minnames} because the latter affects the generation of labels. \intitem[\prm{maxnames}]{maxcitenames} The number of names printed in citations normally corresponds to the \prm{maxnames} and \prm{minnames} values. The \opt{maxcitenames} and \opt{mincitenames} options define different values for use in all citations. Note that \prm{maxcitenames} should normally not be less then \prm{maxnames} because the latter affects the generation of labels. \intitem[\prm{minnames}]{mincitenames} Similar to \opt{maxcitenames} but defining the lower limit. This value must be smaller than or equal to \prm{maxcitenames}. Note that \prm{mincitenames} should normally not be less then \prm{minnames} because the latter affects the generation of labels. \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[auto]{language}{\opt{auto}, \prm{language}} This option controls multilingual support. When set to \opt{auto}, \sty{biblatex} will try to get the main document language from the \sty{babel} package (and fall back to English if \sty{babel} is not available). This is the default behavior. It is also possible to select the document language manually. In this case, the \opt{babel} option below will have no effect. Please refer to \tabref{use:opt:tab1} for a list of supported languages and the corresponding identifiers. \begin{table} \tablesetup \begin{tabularx}{\textwidth}{@{}p{100pt}@{}p{100pt}@{}>{\ttfamily}X@{}} \toprule \multicolumn{1}{@{}H}{Language} & \multicolumn{1}{@{}H}{Region/Dialect} & \multicolumn{1}{@{}H}{Identifier} \\ \cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule{3-3} Danish & Denmark & danish \\ Dutch & Netherlands & dutch \\ English & USA & american \\ & United Kingdom & british \\ & Canada & canadian \\ & Australia & australian \\ & New Zealand & newzealand \\ Finnish & Finland & finnish \\ French & France, Canada & french \\ German & Germany & german \\ & Austria & austrian \\ German (new) & Germany & ngerman \\ & Austria & naustrian \\ Greek & Greece & greek \\ Italian & Italy & italian \\ Norwegian & Norway & norwegian \\ Portuguese& Brazil & brazilian \\ & Portugal & portuguese \\ Spanish & Spain & spanish \\ Swedish & Sweden & swedish \\ \bottomrule \end{tabularx} \caption{Supported Languages} \label{use:opt:tab1} \end{table} \boolitem[true]{clearlang} If this option is enabled, \sty{biblatex} will automatically clear the \bibfield{language} field of all entries whose language matches the \sty{babel} 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}. \optitem[none]{babel}{\opt{none}, \opt{hyphen}, \opt{other}, \opt{other*}} This option controls which language environment is used if the \sty{babel} package is loaded and a bibliography entry includes a \bibfield{hyphenation} field (see \secref{bib:fld:spc}). Note that \sty{biblatex} automatically adjusts to the main document language if \sty{babel} 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. This option is for switching languages on a per"=entry basis within the bibliography. The possible choices are: \begin{valuelist} \item[none] Disable this feature, \ie do not use any language environment at all. \item[hyphen] Enclose the entry in a \env{hyphenrules} environment. This will load hyphenation patterns for the language specified in the \env{hyphenation} field of the entry, if available. \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} and \sty{biblatex} provide for the respective language, and translate key terms such as <editor> and <volume>. The extra definitions include localizations of the date format, of ordinals, and similar things. \item[other*] Enclose the entry in an \env{otherlanguage*} environment. Please note that \sty{biblatex} treats \env{otherlanguage*} like \env{otherlanguage} but other packages may make a distinction in this case. \end{valuelist} \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. \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}} 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. \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 \sty{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 ship 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 exactely two consecutive pages is printed using the starting page and the localization 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 localization 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} entires 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} \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 ship 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{section}, \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 a \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[section] Start a reference section at every \cmd{section} command. \item[subsection] Start a reference section at every \cmd{subsection} command. \end{valuelist} \optitem[none]{refsegment}{\opt{none}, \opt{part}, \opt{chapter}, \opt{section}, \opt{subsection}} Similar to the \opt{refsection} option but starts a new reference segment. This is equivalent to a \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{section}, \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[section] Perform a reset at every \cmd{section} command. \item[subsection] Perform a reset at every \cmd{subsection} 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 localization modules. If this option is enabled, key terms such as <editor> are abbreviated. If not, they are written out. \optitem[comp]{date}{\opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}} This option controls the basic format of printed date specifications. The following choices are available: \begin{valuelist} \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[iso8601] Use extended \acr{ISO-8601} format (\texttt{yyyy-mm-dd}), for example:\par 2010-01-01\par 2010-01-21/2010-01-30 \end{valuelist} % 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 in all short formats may be controlled separately with the \opt{datezeros} package option. \optitem[comp]{origdate}{\opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}} Similar to the \opt{date} option but controls the format of the \bibfield{origdate}. \optitem[comp]{eventdate}{\opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}} Similar to the \opt{date} option but controls the format of the \bibfield{eventdate}. \optitem[short]{urldate}{\opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}} Similar to the \opt{date} option but controls the format of the \bibfield{urldate}. \optitem{alldates}{\opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}} Sets all of the above date options to the same value. \boolitem[true]{datezeros} This option controls whether \texttt{short} and \texttt{terse} dates are printed with leading zeros. \boolitem[true]{dateabbrev} This option controls whether \texttt{long} and \texttt{comp} dates are printed with long or abbreviated month names. The option is similar to the generic \opt{abbreviate} option but specific to the date formatting. \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. \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[bibtex]{backend}{\opt{bibtex}, \opt{bibtex8}, \opt{bibtexu}, \opt{biber}} Specifies the database backend. The following backends are supported: \begin{valuelist} \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. Depending on the \file{csf} file, case"=sensitive sorting may be supported. \item[bibtexu] \bin{bibtexu} is a Unicode-enabled implementation of \bibtex which supports \utf. Note that \bin{bibtexu} is not actively supported by \sty{biblatex} and has not been tested as backend in any way. Biber is the recommended backend. \item[biber] Biber, the next"=generation backend of \sty{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. \end{valuelist} This option will typically be set permanently in the configuration file, see \secref{use:cfg} for details. Also see \secref{bib:cav:enc} for further instructions concerning the encoding of \file{bib} files. \optitem[auto]{texencoding}{\opt{auto}, \prm{encoding}} Specifies the encoding of the \file{tex} file. This option affects the data transfered from the backend to \sty{biblatex}. When using Biber, this corresponds to Biber's |--bblencoding| 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, \sty{biblatex} will get the main encoding from that package. If not, it assumes \utf encoding if \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 encoding of the \file{bib} files. When using Biber, this corresponds to Biber's |--bibencoding| 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, \sty{biblatex} assumes that the \file{tex} file and the \file{bib} file use the same encoding (\kvopt{bibencoding}{auto}). Note that some backends only support a limited number of encodings. See \secref{bib:cav:enc} for further instructions. \boolitem[false]{safeinputenc}[\BiberOnly] If this option is enabled, \sty{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, \sty{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 \bibtex 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 \bibtex and not specific to \sty{biblatex}. See the description of the \bibfield{crossref} field in \secref{bib:fld:spc} for further information.} Note that this package option merely affects the format of certain requests written to the transcript file. It will not have any effect if the editor or compiler script launching \bibtex does not include dedicated \sty{biblatex} support or if \bibtex is manually launched from the command"=line.\footnote{As of this writing, no \latex editors or compiler scripts with dedicated \sty{biblatex} support are known, but this will hopefully change in the future.} See \secref{bib:cav:ide} for details. 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. \end{optionlist} \paragraph{Style-specific} \label{use:opt:pre:bbx} The following options are provided by the standard styles (as opposed to the core package). Technically, they are preamble options like those in \secref{use:opt:pre:gen}. \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. \end{optionlist} \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{firstinits} 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, 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, see \secref{aut:cav:flt}. \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, see \secref{aut:cav:flt}. \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, see \secref{aut:cav:flt}. \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, see \secref{aut:cav:flt}. \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, see \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, \sty{biblatex} will issue errors. \boolitem[false]{firstinits} When enabled, all first and middle names will be rendered as initials. The option will affect the \cmd{iffirstinits} test from \secref{aut:aux:tst}. \boolitem[false]{terseinits} This option controls the format of initials generated by \sty{biblatex}. If enabled, initals 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. \BiberOnlyMark With Biber, the option works by redefining some macros which control the format of initials. See \secref{use:cav:nam} for details. \boolitem[false]{labelalpha} Whether or not to provide the special fields \bibfield{labelalpha} and \bibfield{extraalpha}, see \secref{aut:bbx:fld} for details. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \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 basis. \boolitem[false]{labelyear} Whether or not to provide the special fields \bibfield{labelyear} and \bibfield{extrayear}, see \secref{aut:bbx:fld} for details. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \boolitem[false]{singletitle} Whether or not to provide the data required by the \cmd{ifsingletitle} test, see \secref{aut:aux:tst} for details. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \optitem[false]{uniquename}{\opt{true}, \opt{false}, \opt{init}, \opt{full}, \opt{allinit}, \opt{allfull}, \opt{mininit}, \opt{minfull}}[\BiberOnly] 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 basis. The possible choices are: \begin{valuelist} \item[true] An alias for \opt{full}. \item[false] Disable this feature. \item[init] Disambiguate names using initials only. \item[full] Disambiguate names 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 lists with identical last names. \item[minfull] A variant of \texttt{full} which only disambiguates names in lists with identical last names. \end{valuelist} % Note that the \opt{uniquename} option will also affect \opt{uniquelist}, the \cmd{ifsingletitle} test, and the \bibfield{extrayear} field. See \secref{aut:cav:amb} for further details and practical examples. \optitem[false]{uniquelist}{\opt{true}, \opt{false}, \opt{minyear}}[\BiberOnly] 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 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{labelyear}{true}. \end{valuelist} % Note that the \opt{uniquelist} option will also affect the \cmd{ifsingletitle} test and the \bibfield{extrayear} field. See \secref{aut:cav:amb} for further details and practical examples. See \secref{aut:cav:amb} for further details and practical examples. \end{optionlist} \subsubsection{Entry Options} \label{use:opt:bib} Entry options are package options which can be adjusted on a per"=entry basis in the \bibfield{options} field from \secref{bib:fld:spc}. \paragraph{Preamble/Type/Entry Options} \label{use:opt:bib:hyb} The following options are settable on a per"=entry basis 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 behavior 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}. \BiberOnlyMark With Biber, this option is also settable on a per-type 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}. \BiberOnlyMark With Biber, this option is also settable on a per-type 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: \BiberOnlyMark With Biber, this option is also settable on a per-type 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[false]{useprefix} Whether the name prefix (von, van, of, da, de, della, etc.) is considered when printing the last name in citations. This also affects the sorting and formatting of the bibliography as well as the generation of certain types of labels. If this option is enabled, \sty{biblatex} always precedes the last name with the prefix. For example, Ludwig van Beethoven would be cited as «Beethoven» and alphabetized as «Beethoven, Ludwig van» by default. If this option is enabled, he is cited as «van Beethoven» and alphabetized as «Van Beethoven, Ludwig» instead. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \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. \end{optionlist} \paragraph{Type/Entry Options} \label{use:opt:bib:ded} The following options are only settable on a per"=entry basis in the \bibfield{options} field. They are not available globally. \begin{optionlist} \boolitem[false]{skipbib} If this option is enabled, the entry is excluded from the bibliography but it may still be cited. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \boolitem[false]{skiplos} If this option is enabled, the entry is excluded from the list of shorthands. It is still included in the bibliography and it may also be cited by shorthand. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \boolitem[false]{skiplab} If this option is enabled, \sty{biblatex} will not assign any labels to the entry. It is not required for normal operation. Use it with care. If enabled, \sty{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. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \boolitem[false]{dataonly} Setting this option is equivalent to \opt{skipbib}, \opt{skiplos}, and \opt{skiplab}. It is not required for normal operation. Use it with care. \BiberOnlyMark With Biber, this option is also settable on a per-type basis. \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 ship 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 ship with the \sty{biblatex} package. 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] 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] 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} option. \item[numeric-verb] 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] 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}. \item[alphabetic-verb] 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}. \item[authoryear] 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{labelyear}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}. \item[authoryear-comp] 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{labelyear}{true}, \kvopt{uniquename}{full}, \kvopt{uniquelist}{true}. \item[authoryear-ibid] 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{labelyear}{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] 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{labelyear}{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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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] 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 bibligraphy style \texttt{authortitle-comp} will load the \texttt{authortitle} style. \begin{marglist} \item[numeric] 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] 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] 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{labelyear}{true}, \kvopt{sorting}{nyt}, \kvopt{pagetracker}{true}, \kvopt{mergedate}{true}. \item[authortitle] 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] 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] 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] This draft style includes the entry keys in the bibliography. The bibligraphy will be sorted by entry key. The style will set the following package options at load time: \kvopt{sorting}{debug}. \item[debug] 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{Sorting Options} \label{use:srt} This package supports various sorting schemes for the bibliography. The sorting scheme 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 alphabetic sorting schemes supported by \sty{biblatex}. Chronological sorting schemes are listed in \apxref{apx:srt:chr}. A few explanations concerning these schemes 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, \sty{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{useauthor}, \opt{useeditor}, and \opt{usetranslator} options. If all three of them are disabled, the \bibfield{sortname} field is ignored as well. Note that all name fields are responsive to the setting of the global \opt{maxnames} and \opt{minnames} options. If no name field is available, either because all of them are undefined or because \opt{useauthor}, \opt{useeditor}, and \opt{usetranslator} are disabled, \sty{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, which is padded to four digits with leading zeros, or the string \texttt{0000} otherwise. Note that the sorting schemes 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 schemes in \apxref{apx:srt:a2} are intended to be used in conjunction with alphabetic styles only. The chronological sorting schemes 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} scheme 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} scheme is similar in concept but sorts the year in descending order. As with the \opt{ynt} scheme, the string \texttt{9999} is used as a fallback value. The remaining items are similar to the alphabetic sorting schemes discussed above. Note that the \opt{ydnt} sorting scheme 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 \sty{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. Also note that using \file{bibtex8} or Biber instead of legacy \file{bibtex} is strongly recommended. \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. Do not omit the \file{.bib} extension from the filename. Also note that the \prm{resource} is a single resource. Invoke \cmd{addbibresource} multiple times to add more resources, for example: \begin{lstlisting}[style=latex]{} \addbibresource{bibfile1.bib} \addbibresource{bibfile2.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{lstlisting} % 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{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 \ref{use:bib:sec}). \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} 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}[zoterordfxml] \item[bibtex] \bibtex format. \item[ris]\BiberOnlyMark Research Information Systems (\acr{RIS}) format.\fnurl{http://en.wikipedia.org/wiki/RIS_(file_format)} Note that an \texttt{ID} tag is required in all \acr{RIS} records. The \texttt{ID} value corresponds to the entry key. Support for this format is experimental. \item[zoterordfxml]\BiberOnlyMark Zotero \acr{RDF}/\acr{XML} format. Support for this format is experimental. Refer to the Biber manual for details. \item[endnotexml]\BiberOnlyMark EndNote \acr{XML} format. Support for this format is experimental. Refer to the Biber manual for details. \end{valuelist} \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} (\ref{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 enviroments 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{printshorthands} uses \texttt{shorthands}. See also \secref{use:bib:los,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{printshorthands} uses \texttt{shorthands}. See also \secref{use:bib:los,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. \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{maxnames} The threshold for all lists of names. This option overrides the \opt{maxnames} package option locally. The value may not be smaller than the global setting. \intitem{minnames} The name limit affecting all lists of names. This option overrides the \opt{minnames} package option locally. The value may not be smaller than the global setting. \intitem{maxitems} The threshold for all literal lists. This option overrides the \opt{maxitems} package option locally. \intitem{minitems} The item limit affecting all literal lists. This option overrides the \opt{minitems} package option locally. \intitem[0]{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. When giving a chain of multiple filters, the \texttt{section} filter must always be given first. \intitem[0]{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. \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{prefixnumbers}{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 current bibliography. The option assigns the \prm{string} as a prefix to all entries in the respective bibliography. 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{prefixnumber} field of all affected entries. See \secref{aut:bbx:fld:lab} for details. \boolitem{resetnumbers} 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. Use this option with care as \sty{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, \sty{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). \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}, \opt{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}. \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 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}, \opt{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}, and \opt{section}. \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{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}, and \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. \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. \end{ltxsyntax} \subsubsection{The List of Shorthands} \label{use:bib:los} If any entry includes a \bibfield{shorthand} field, \sty{biblatex} automatically builds a list of shorthands which may be printed in addition to the regular bibliography. The following command prints the list of shorthands. \begin{ltxsyntax} \cmditem{printshorthands}[key=value, \dots] This command prints the list of shorthands. It takes one 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{prefixnumbers}, \opt{resetnumbers}, and \opt{omitnumbers}. If there are any \env{refsection} environments in the document, the list of shorthands will be local to these environments; see \secref{use:bib:sec} for details. By default, this command uses the heading \texttt{shorthands}. See \secref{use:bib:hdg} for details. \end{ltxsyntax} \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 lists of shorthands 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{printshorthands} when printing the list of shorthands. 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{printshorthands}. \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{refsegment} option of \cmd{printbibliography} to select a segment when printing the bibliography. 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{printshorthands} 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 the list of shorthands. Here is an example of a definition based on the standard \latex \env{list} environment: \begin{lstlisting}[style=latex]{} \defbibenvironment{bibliography} {\list{} {\setlength{\leftmargin}{\bibhang}% \setlength{\itemindent}{-\leftmargin}% \setlength{\itemsep}{\bibitemsep}% \setlength{\parsep}{\bibparsep}}} {\endlist} {\item} \end{lstlisting} % 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{printshorthands} 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{printshorthands} 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{losname} (see \secref{aut:lng:key:bhd}). Here is an example of a simple heading definition: \begin{lstlisting}[style=latex]{} \defbibheading{bibliography}[\bibname]{% \chapter*{#1}% \markboth{#1}{#1}} \end{lstlisting} \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 localization 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{printshorthands} are predefined: \begin{valuelist*} \item[shorthands] This is the default heading used by \cmd{printshorthands} if the \opt{heading} option is not given. It is similar to \texttt{bibliography} above except that it uses the localization 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[losintoc] Similar to \texttt{shorthands} above but adds an entry to the table of contents. \item[losnumbered] Similar to \texttt{shorthands} 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{printshorthands}. 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{lstlisting}[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{lstlisting} % 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 \sty{biblatex}, is still supported. This is the same test using \sty{ifthen}-like syntax: \begin{lstlisting}[style=ifthen,morekeywords={\\type,\\keyword}]{} \defbibfilter{example}{% \( \type{book} \or \type{inbook} \) \and \keyword{abc} \and \not \keyword{x y z} } \end{lstlisting} % 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{lstlisting}[style=latex]{} \defbibcheck{<<abstract>>}{% \iffieldundef{abstract}{<<\skipentry>>}{}} ... \printbibliography[<<check=abstract>>] \end{lstlisting} % The following check will exclude all entries published before the year 2000: \begin{lstlisting}[style=latex]{} \defbibcheck{recent}{% \iffieldint{year} {\ifnumless{\thefield{year}}{2000} {\skipentry} {}} {\skipentry}} \end{lstlisting} % See the author guide, in particular \secref{aut:aux:tst,aut:aux:ife}, for further details. \end{ltxsyntax} \subsubsection{Dynamic Entry Sets} \label{use:bib:set} In addition to the \bibtype{set} entry type, \sty{biblatex} also supports dynamic entry sets defined on a per-document\slash per-refsection basis. The following command, which may be used in the dcument preamble or the document body, defines the set \prm{key}: \begin{ltxsyntax} \cmditem{defbibentryset}{key}{key1,key2,key3, \dots}|\BiberOnlyMark| 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. Note that dynamic entry sets require Biber. They will not work with any other backend. 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 \sty{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 ship with this package. \begin{ltxsyntax} \cmditem{textcite}[prenote][postnote]{key} \cmditem{Textcite}[prenote][postnote]{key} These citation commands are provided by all non-verbose styles which ship 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. \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{lstlisting}[style=latex]{} \parencites[35]{key1}[88--120]{key2}[23]{key3} \end{lstlisting} % 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{lstlisting}[style=latex]{} \parencites[35]{key1}[chapter 2 in][]{key2}[23]{key3} \end{lstlisting} % 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{lstlisting}[style=latex]{} \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{lstlisting} % 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{lstlisting}[style=latex,showspaces]{} \parencites[35]{key1}[78]{key2}<<\relax>>[...] \parencites[35]{key1}[78]{key2}<<\ >>{...} \end{lstlisting} % 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}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{Cites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} The multicite version of \cmd{cite} and \cmd{Cite}, respectively. \cmditem{parencites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{Parencites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} The multicite version of \cmd{parencite} and \cmd{Parencite}, respectively. \cmditem{footcites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{footcitetexts}(pre)(post)[pre][post]{key}|...|[pre][post]{key} The multicite version of \cmd{footcite} and \cmd{footcitetext}, respectively. \cmditem{smartcites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{Smartcites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} The multicite version of \cmd{smartcite} and \cmd{Smartcite}, respectively. \cmditem{textcites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{Textcites}(pre)(post)[pre][post]{key}|...|[pre][post]{key} The multicite version of \cmd{textcite} and \cmd{Textcite}, respectively. This command is only provided by non-verbose styles. \cmditem{supercites}(pre)(post)[pre][post]{key}|...|[pre][post]{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}(pre)(post)[pre][post]{key}|...|[pre][post]{key} \cmditem{Autocites}(pre)(post)[pre][post]{key}|...|[pre][post]{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 \sty{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} 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. \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} This command prints the year (\bibfield{year} field or year component of \bibfield{date}). \cmditem{citedate}[prenote][postnote]{key} This command prints the full date (\bibfield{date} or \bibfield{year}). \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 \sty{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 \file{bib} file 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. \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}[page]{key} \cmditem{Volcite}[prenote]{volume}[page]{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{page} 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. \cmditem{pvolcite}[prenote]{volume}[page]{key} \cmditem{Pvolcite}[prenote]{volume}[page]{key} Similar to \cmd{volcite} but based on \cmd{parencite}. \cmditem{fvolcite}[prenote]{volume}[page]{key} \cmditem{ftvolcite}[prenote]{volume}[page]{key} Similar to \cmd{volcite} but based on \cmd{footcite} and \cmd{footcitetext}, respectively. \cmditem{svolcite}[prenote]{volume}[page]{key} \cmditem{Svolcite}[prenote]{volume}[page]{key} Similar to \cmd{volcite} but based on \cmd{smartcite}. \cmditem{tvolcite}[prenote]{volume}[page]{key} \cmditem{Tvolcite}[prenote]{volume}[page]{key} Similar to \cmd{volcite} but based on \cmd{textcite}. \cmditem{avolcite}[prenote]{volume}[page]{key} \cmditem{Avolcite}[prenote]{volume}[page]{key} Similar to \cmd{volcite} but based on \cmd{autocite}. \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 \sty{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 \sty{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 localization 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 localization string \texttt{sequentes}, see \secref{aut:lng:key}. This command is only available locally in citations and the bibliography. \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 \sty{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\BiberOnlyMark} \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{lstlisting}[style=latex]{} \mcite{key1,setA,*keyA1,*keyA2,*keyA3,key2,setB,*keyB1,*keyB2,*keyB3} \end{lstlisting} % is essentially equivalent to this: \begin{lstlisting}[style=latex]{} \defbibentryset{setA}{keyA1,keyA2,keyA3}% \defbibentryset{setB}{keyB1,keyB2,keyB3}% \cite{key1,setA,key2,setB} \end{lstlisting} % 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{lstlisting}[style=latex]{} \mcite*[pre][post]{setA,*keyA1,*keyA2,*keyA3} \end{lstlisting} % will execute: \begin{lstlisting}[style=latex]{} \defbibentryset{setA}{keyA1,keyA2,keyA3}% \cite*[pre][post]{setA} \end{lstlisting} % 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 \sty{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} \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| \\ \bottomrule \end{tabular} \caption{\sty{mcite}-like commands} \label{use:cit:mct:tab1} \end{table} \begin{lstlisting}[style=latex]{} \cite{<<glashow>>,*salam,*weinberg} \end{lstlisting} % 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 \sty{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{lstlisting}[style=latex]{} \mcite{<<set1>>,*glashow,*salam,*weinberg} \end{lstlisting} % 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 ship with \texttt{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} \tablesetup \begin{tabular}{@{}V{0.5\textwidth}@{}V{0.1\textwidth}@{}p{0.4\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} \caption[\sty{mcite}-like syntax] {\sty{mcite}-like syntax (sample output with \kvopt{style}{numeric} and \opt{subentry} option)} \label{use:cit:mct:tab2} \end{table} \subsection{Localization Commands} \label{use:lng} The \sty{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 localization strings. The \prm{language} must be a language name known to the \sty{babel} package, \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{lstlisting}[style=latex]{} \DefineBibliographyStrings{american}{% bibliography = {Bibliography}, shorthands = {Abbreviations}, editor = {editor}, editors = {editors}, } \end{lstlisting} % 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 \sty{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} package. 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} package. The \prm{text} is a whitespace"=separated list of words. Hyphenation points are marked with a dash: \begin{lstlisting}[style=latex]{} \DefineHyphenationExceptions{american}{% hy-phen-ation ex-cep-tion } \end{lstlisting} \cmditem{NewBibliographyString}{key} This command declares new localization 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{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. 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{bibnamedelima}\BiberOnlyMark This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically after the first name element if the element is less than three characters long and before the last element. The default definition is an interword 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}\BiberOnlyMark This delimiter is inserted between the elements which make up a name part where \cmd{bibnamedelima} does not apply. The default definition is an interword 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. It is inserted between the name prefix and the last name if \kvopt{useprefix}{true}. The default definition is an interword 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 is inserted between all name parts where \cmd{bibnamedelimc} does not apply. The default definition is an interword 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}\BiberOnlyMark 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 \sty{biblatex} which use their own set of delimiters. \csitem{bibinitperiod}\BiberOnlyMark The punctuation inserted after 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}\BiberOnlyMark The spacing inserted 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}\BiberOnlyMark The punctuation inserted 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{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} The separator printed after the name used for alphabetizing in the bibliography (\bibfield{author} or \bibfield{editor}, if the \bibfield{author} field is undefined). 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{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{multinamedelim} 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} The delimiter printed instead of \cmd{multinamedelim} before the final name in a name list. The default is the localized term <and>, separated by interword spaces. Here is an example: \begin{lstlisting}[style=latex]{} Michel Goossens<<,>> Frank Mittelbach <<and>> Alexander Samarin Edward Jones <<and>> Joe Williams \end{lstlisting} % 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} An extra delimiter printed after the first name in a name list if the first name is reversed. 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{lstlisting}[style=latex]{} Jones, Edward<<, and>> Joe Williams \end{lstlisting} % 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} The delimiter printed before the localization string <\texttt{andothers}> if a name list like \bibfield{author} or \bibfield{editor} is truncated. The default is an interword space. \csitem{multilistdelim} 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} The delimiter printed instead of \cmd{multilistdelim} before the final item in a literal list. The default is the localized term <and>, separated by interword spaces. See \cmd{finalnamedelim} for further explanation. \csitem{andmoredelim} The delimiter printed before the localization 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{supercitedelim} Similar to \cmd{multicitedelim}, but used by the \cmd{supercite} command only. The default is a comma. \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{nametitledelim} The delimiter printed between the author\slash editor and the title by author-title and some verbose citation styles. The default definition is a comma plus an interword space. \csitem{nameyeardelim} The delimiter printed between the author\slash editor and the year by author-year citation styles. The default definition is an interword 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{maxnames} 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} \BiberOnlyMark 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{lstlisting}[style=latex]{} \renewcommand*{\labelalphaothers}{\textbf{+}} \renewcommand*{\sortalphaothers}{+} \end{lstlisting} % If \cmd{sortalphaothers} is not redefined, it defaults to \cmd{labelalphaothers}. \csitem{prenotedelim} 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} 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. \cmditem{mkbibnamelast}{text} This command, which takes one argument, is used to format the last name of all authors, editors, translators, etc. \cmditem{mkbibnamefirst}{text} Similar to \cmd{mkbibnamelast}, but intended for the first name. \cmditem{mkbibnameprefix}{text} Similar to \cmd{mkbibnamelast}, but intended for the name prefix. \cmditem{mkbibnameaffix}{text} Similar to \cmd{mkbibnamelast}, but intended for the name affix. \end{ltxsyntax} \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, 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. \csitem{bibdatedash} The language specific dash to be used for date ranges. \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{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{lstlisting}[style=latex]{} Michel Goossens, Frank Mittelbach<<,>> and Alexander Samarin \end{lstlisting} % \cmd{finalandcomma} is the comma before the word <and>. See also \cmd{multinamedelim}, \cmd{finalnamedelim}, and \cmd{revsdnamedelim} 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{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. \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} are cumulative. When they coincide, the largest value will be applied. \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} are cumulative. When they coincide, the largest value will be applied. \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} are cumulative. When they coincide, the largest value will be applied. \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 localization modules, holds the penalty used in short or abbreviated localization 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. \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} package. \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} package. \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} package. \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} package. \csitem{nohyphenation} A generic switch which suppresses hyphenation locally. Its scope should normally be confined to a group. \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{extrayear} 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 \sty{biblatex}'s punctuation tracker would capitalize a localization 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{lstlisting}[style=latex]{} \autocap{s}pecial issue \end{lstlisting} % 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{lstlisting}[style=latex]{} \autocap{\'e}dition sp\'eciale \end{lstlisting} % 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{lstlisting}[style=latex]{} \autocap{\oe}uvres \end{lstlisting} % 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 localization modules. \subsubsection{American} \label{use:loc:us} The American localization 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{lstlisting}[style=latex]{} \DefineBibliographyExtras{american}{% \stdpunctuation } \end{lstlisting} % By default, the <American punctuation> feature is enabled by the \texttt{american} localization module only. The above code is only required if you want American localization 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} package 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{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 localization module does not use the localization 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 localization module ignores \cmd{finalnamedelim} and \cmd{finallistdelim}. \csitem{forceE} Use this command in \file{bib} files if \sty{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 prevent confusing \bibtex. 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{Greek} \label{use:loc:grk} The Greek localization module requires \utf support. It will not work with any other encoding. Generally speaking, the \sty{biblatex} package is compatible with the \sty{inputenc} package and with \xelatex. The \sty{ucs} package will not work. Since \sty{inputenc}'s standard \file{utf8} module is missing glyph mappings for Greek, this leaves Greek users with \xelatex. 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 \sty{biblatex}. However, there is one fundamental limitation. As of this writing, \sty{biblatex} has no support for switching scripts. Greek titles in the bibliography should work fine, provided that you use Biber as a backend, but English and other titles in the bibliography may be rendered in Greek letters. If you need multi-script bibliographies, using \xelatex is the only sensible choice. \subsection{Usage Notes} \label{use:use} The following sections give a basic overview of the \sty{biblatex} package and discuss some typical usage scenarios. \subsubsection{Overview} \label{use:use:int} Using the \sty{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 \sty{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, \sty{biblatex} will request the respective data from \bibtex by writing commands to the auxiliary file \path{example.aux}. \item Run \bin{bibtex} on \path{example.aux}. \bibtex 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 \sty{biblatex}. \item Run \bin{latex} on \path{example.tex}. \sty{biblatex} will read the data from \path{example.bbl} and print all citations as well as the bibliography. \end{enumerate} Whenever a reference to a work which has not been cited before is added, this procedure must be repeated. This is also the case if the last reference to a work which has been cited before is removed because some citation labels may change in this case. In contrast to traditional \bibtex, there is normally no need to run \bin{latex} twice after running \bin{bibtex} as far as the handling of bibliographic data is concerned.\footnote{That is, unless the \opt{defernumbers} package option is enabled. This option requires two \latex runs after the data has been exported to the \file{bbl} file by \bibtex.} Note that this only applies to the most basic case. Using the \bibfield{xref} field or the \bibfield{entryset} field may require an additional \latex/\bibtex/\latex cycle. Some other facilities provided by \sty{biblatex} may also require an additional \bin{latex} run to get certain references and the page tracking right. In this case, the usual warning messages such as «There were undefined references» and «Label(s) may have changed. Rerun to get cross-references right» will be printed. When using Biber as a backend, the workflow is essentially the same. \subsubsection{Auxiliary Files} \label{use:use:aux} By default, the \sty{biblatex} package uses the main \file{aux} file only. Even if there are citation commands in a file included via \cmd{include}, which has its own \file{aux} file, you only need to run \bibtex on the main \file{aux} file. If you are using \env{refsection} environments in a document (see \secref{use:use:mlt}) \sty{biblatex} will create one additional \file{aux} file for every \env{refsection} environment. In this case, you also need to run \bin{bibtex} on each additional \file{aux} file. The name of the additional \file{aux} files is the base name of the main input file with the string \file{-blx} and a running number appended at the end. The \sty{biblatex} package issues a warning listing the files which require an additional \bibtex run. With the basic example presented in \secref{use:use:int}, it would issue the following warning: \begin{lstlisting}[style=plain] Package biblatex Warning: Please (re)run BibTeX on the file(s): (biblatex) example.aux (biblatex) and rerun LaTeX afterwards. \end{lstlisting} % If the input file contained three \env{refsection} environments, the warning would read as follows: \begin{lstlisting}[style=plain] Package biblatex Warning: Please (re)run BibTeX on the file(s): (biblatex) example1-blx.aux (biblatex) example2-blx.aux (biblatex) example3-blx.aux (biblatex) and rerun LaTeX afterwards. \end{lstlisting} % Apart from these \file{aux} files, \sty{biblatex} uses an additional \file{bib} file with the same suffix to pass certain control parameters to \bibtex. In the example above, this file would be named \path{example-blx.bib}. In the event of a file name conflict, you can change the suffix by redefining the macro \cmd{blxauxsuffix} in the document preamble. When using Biber, \sty{biblatex} writes a control file named \path{example.bcf} and ignores \cmd{blxauxsuffix}. There is also no auxiliary \file{bib} file in this case. Note that \sty{biblatex} will not overwrite any files it did not create. All auxiliary files created automatically by this package start with a special signature line. Before overwriting a file (excluding the main \file{aux} file, which is managed by \latex), \sty{biblatex} inspects the first line of the file to make sure that there is no file name conflict. If the file in question is missing the signature line, \sty{biblatex} will immediately issue an error message and abort before opening the output stream. In this case you should delete any spurious files accidentally left in the working directory. If the error persists, there may be a file name conflict with a file found in one of the \tex installation trees. Since the installation trees usually do not contain any \file{aux} files and the string \file{-blx} is fairly exotic in the name of a \file{bib} file, this is rather unlikely but theoretically possible. If you find out that this is indeed the case, you should redefine \cmd{blxauxsuffix} permanently in the \sty{biblatex} configuration file, \path{biblatex.cfg.} \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. Note that \sty{biblatex} creates one additional \file{aux} file for every \env{refsection} environment. These files have to be processed by \bibtex as well, see \secref{use:use:aux} for details. \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 \sty{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{lstlisting}[style=latex] \usepackage{<<nameref>>} \defbibheading{subbibliography}{% \section*{<<\nameref{refsection:\therefsection}>>}} \end{lstlisting} % Since giving one \cmd{printbibliography} command for each part of a subdivided bibliography is tedious, \sty{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{lstlisting}[style=latex] \printbibheading <<\bibbysection[heading=subbibliography]>> \end{lstlisting} % 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. Note that \env{refsegment} environments do not require additional \file{aux} files. 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:\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 \sty{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{lstlisting}[style=latex]{} \printbibheading <<\bibbysegment[heading=subbibliography]>> \end{lstlisting} % This is equivalent to giving one \cmd{printbibliography} command for every segment. \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{lstlisting}[style=latex]{} \printbibliography[<<type=article>>,...] \printbibliography[<<type=book>>,...] \printbibliography[<<nottype=article>>,<<nottype=book>>,...] \end{lstlisting} % It is even possible to give a chain of different types of filters: \begin{lstlisting}[style=latex]{} \printbibliography[<<section=2>>,<<type=book>>,<<keyword=abc>>,<<notkeyword=xyz>>] \end{lstlisting} % 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{lstlisting}[style=latex]{} \printbibliography[<<keyword=primary>>,...] \printbibliography[<<notkeyword=primary>>,...] \end{lstlisting} % Since \sty{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{lstlisting}[style=latex]{} \printbibliography[<<category=primary>>,...] \printbibliography[<<notcategory=primary>>,...] \end{lstlisting} % 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 \sty{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. \paragraph{Static entry sets} \BiberOnlyMark Static entry sets are defined in the \file{bib} file like any other entry. When using Biber as backend, 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 comma"=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. When using \bibtex, which has no native support for entry sets, setting up entry sets involves more work. \bibtex requires \bibfield{entryset} and \bibfield{crossref} fields to be used in a special way. The members of the set are given in the \bibfield{entryset} field of the \bibtype{set} entry. The \bibtype{set} entry also requires a \bibfield{crossref} field which points to the first key in the \bibfield{entryset} field. In addition to that, all members of the set require \bibfield{entryset} fields which are reverse pointers to the entry key of the \bibtype{set} head entry: \begin{lstlisting}[style=bibtex]{} @Set{set1, <<entryset>> = {<<key1>>,key2,key3}, <<crossref>> = {<<key1>>}, } @Article{key1, <<entryset>> = {set1}, author = {...}, title = {...}, ... } @InCollection{key2, <<entryset>> = {set1}, author = {...}, title = {...}, ... } @Article{key3, <<entryset>> = {set1}, author = {...}, title = {...}, ... } \end{lstlisting} % Note that citing any set member will automatically load the entire set with \bibtex. If you want to refer to an item as part of a set in one document\slash refsection and as a stand-alone reference in another one, you need two distinct entries with \bibtex. \paragraph[Dynamic entry sets]{Dynamic entry sets\BiberOnlyMark} 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. Note that dynamic entry sets require Biber. They will not work with any other backend. \subsubsection{Electronic Publishing Information} \label{use:use:epr} The \sty{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 using \sty{biblatex} in conjunction with one of the \sty{scrbook}, \sty{scrreprt}, or \sty{scrartcl} classes, the headings \texttt{bibliography} and \texttt{shorthands} from \secref{use:bib:hdg} are responsive to the bibliography"=related options of these classes.\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}.} You can override the default headings by using the \opt{heading} option of \cmd{printbibliography}, \cmd{printbibheading} and \cmd{printshorthands}. See \secref{use:bib:bib, use:bib:los, use:bib:hdg} for details. All default headings are adapted at load-time such that they blend with the behavior of these classes. If one of the above classes is detected, \sty{biblatex} will also provide the following additional tests which may be useful in custom heading definitions: \begin{ltxsyntax} \cmditem{ifkomabibtotoc}{true}{false} Expands to \prm{true} if the class would add the bibliography to the table of contents, and to \prm{false} otherwise. \cmditem{ifkomabibtotocnumbered}{true}{false} 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. \end{ltxsyntax} \subsubsection{Usage with the Memoir Class} \label{use:cav:mem} When using \sty{biblatex} with the \sty{memoir} class, most class facilites 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{shorthands} (\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 \sty{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 \sty{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, \sty{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, \sty{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, \sty{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{lstlisting}[style=latex]{} \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{lstlisting} % In some other cases, however, the tests may get it wrong and you need to resort to the auxiliary commands \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 \sty{biblatex}, you need to force the prefix for a single number manually: \begin{lstlisting}[style=latex]{} \cite[\pno~27a]{key} \end{lstlisting} % There is also a \cmd{ppno} command which forces a range prefix as well as a \cmd{nopp} command which suppresses all prefixes: \begin{lstlisting}[style=latex]{} \cite[\ppno~27a--28c]{key} \cite[\nopp 25]{key} \end{lstlisting} % 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{lstlisting}[style=latex]{} \cite[VII, \pno~5]{key} \cite[VII, \pno~3, \ppno~40--45]{key} \cite[see][\ppno~37--46, in particular \pno~40]{key} \end{lstlisting} % 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{lstlisting}[style=latex]{} \cite[\ppno~27~sq.]{key} \cite[\ppno~55~sqq.]{key} \end{lstlisting} % 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{lstlisting}[style=latex]{} \cite[27\psq]{key} \cite[55\psqq]{key} \end{lstlisting} % 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: \begin{lstlisting}[style=latex]{} \cite[p.~5]{key} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareFieldFormat{postnote}{#1} \end{lstlisting} % 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 \sty{biblatex} package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names, especially when they are using Biber as backend. 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 first or the last 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*{first name} may be composed of a first 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} First & John Edward \\ Prefix & --- \\ Last & Doe \\ Suffix & --- \\ \end{nameparts} % The spacing and the line"=breaking behavior of names is controlled by four 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 last 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 \\ \end{namedelims} % This is how the delimiters are employed: \begin{namesample} \item John\delim{~}{a}Edward\delim{ }{d}Doe \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} First & Charles-Jean Étienne Gustave Nicolas \\ Prefix & de \\ Last & 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 initals 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{Bibliography Filters 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. \subsubsection{Active Characters in Bibliography Headings} \label{use:cav:act} Packages using active characters, such as \sty{babel}, \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} package. 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{lstlisting}[style=latex]{} \chapter{...} <<\refsection>> ... <<\endrefsection>> \end{lstlisting} % This will not from a group, but otherwise works as usual. As far as \sty{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. \section{Author Guide} \label{aut} This part of the manual documents the author interface of the \sty{biblatex} package. The author guide covers everything you need to know in order to write new citation and bibliography styles or localization 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 \sty{biblatex}, we will have a look at some of its fundamental concepts. The \sty{biblatex} package interacts with \bibtex in a way that is somewhat different from the traditional way of doing things. Most notably, the \file{bbl} file is used differently and there is only one \file{bst} file which implements a structured data interface rather than exporting printable data. 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{lstlisting}[style=latex]{} \bibitem{companion} Michel Goossens, Frank Mittelbach, and Alexander Samarin. \newblock {\em The LaTeX Companion}. \newblock Addison-Wesley, Reading, Mass., 1994. \end{lstlisting} % By default, \latex generates numeric citation labels, hence \cmd{bibitem} writes lines such as the following to the \file{aux} file: \begin{lstlisting}[style=latex]{} \bibcite{companion}{1} \end{lstlisting} % 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{lstlisting}[style=latex]{} \bibcite{companion}{{1}{1994}{{Goossens et~al.}}{{Goossens, Mittelbach, and Samarin}}} \end{lstlisting} % The \sty{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{lstlisting}[style=latex]{} \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{lstlisting} % 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 \sty{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 \sty{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, \sty{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 the \file{aux} file, along with \cmd{citation} commands for all citations. We then wait for \bibtex to supply the required data. Since \sty{biblatex} uses a special \file{bst} file which implements its data interface on the \bibtex end, the \cmd{bibstyle} command is always |\bibstyle{biblatex}|. \item Run \bin{bibtex}: \bibtex supplies those entries from the \file{bib} file which were requested by the \cmd{citation} commands in the \file{aux} 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 \sty{biblatex} uses an alogrithm similar to the traditional procedure to generate numeric lables. In this case, the numbers are assigned as the bibliography is printed and then cycled through the \file{aux} 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} % With \sty{biblatex}, this entry is essentially exported in the following format: \begin{lstlisting}[style=latex]{} \entry{companion}{book}{} \name{author}{3}{% {{Goossens}{G.}{Michel}{M.}{}{}{}{}}% {{Mittelbach}{M.}{Frank}{F.}{}{}{}{}}% {{Samarin}{S.}{Alexander}{A.}{}{}{}{}}% } \list{publisher}{1}{% {Addison-Wesley}% } \list{location}{1}{% {Reading, Mass.}% } \field{title}{The LaTeX Companion} \field{year}{1994} \endentry \end{lstlisting} % 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 \sty{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{shorthands} {...} {...} {...} \InitializeBibliographyStyle{...} \DeclareBibliographyDriver{article}{...} \DeclareBibliographyDriver{book}{...} \DeclareBibliographyDriver{inbook}{...} ... \DeclareBibliographyDriver{shorthands}{...} \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. The \prm{entrytype} corresponds to the entry type used in \file{bib} files, specified in lowercase letters (see \secref{bib:typ}). The type \texttt{shorthands} has a special meaning. The \texttt{shorthands} driver handles all entries in the list of shorthands. 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. This command is optional. The \prm{entrytype} argument may also be an asterisk. In this case, the alias serves as a fallback which is used if no specific driver for the entry type has been defined. \cmditem{DeclareBibliographyOption}{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. For example, with a definition like the following: \begin{lstlisting}[style=latex] \DeclareBibliographyOption{somekey}[true]{...} \end{lstlisting} % giving <\texttt{somekey}> without a value is equivalent to <\kvopt{somekey}{true}>. \cmditem{DeclareEntryOption}{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 \sty{biblatex} prepares the data of the entry for use by a citation command or a bibliography driver. \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 the list of shorthands. 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{lstlisting}[style=latex]{} \defbibenvironment{bibliography} {\list {} {\setlength{\leftmargin}{\bibhang}% \setlength{\itemindent}{-\leftmargin}% \setlength{\itemsep}{\bibitemsep}% \setlength{\parsep}{\bibparsep}}} {\endlist} {\item} \end{lstlisting} % This definition employs a \env{list} environment with hanging indentation, using the \cmd{bibhang} length register provided by \sty{biblatex}. It allows for a certain degree of configurability by using \cmd{bibitemsep} and \cmd{bibparsep}, two length registers provided by \sty{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{lstlisting}[style=latex]{} \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{lstlisting} % 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 \sty{biblatex} in the \bibfield{labelnumber} field. We also employ several length registers and other facilities provided by \sty{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}. The list of shorthands is handled in a similar way. \cmd{printshorthands} uses the environment \opt{shorthands} 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{lstlisting}[style=latex]{} \defbibenvironment{shorthands} {\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{lstlisting} \subsubsection{Bibliography Drivers} \label{aut:bbx:drv} Before we go over the commands which form the data interface of the \sty{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 \bibtex's fields to \sty{biblatex}'s data types, see \secref{bib:fld}. \begin{lstlisting}[style=latex]{} \DeclareBibliographyDriver{book}{% \printnames{author}% \newunit\newblock \printfield{title}% \newunit\newblock \printlist{publisher}% \newunit \printlist{location}% \newunit \printfield{year}% \finentry} \end{lstlisting} % At this point, 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{lstlisting}[style=latex]{} \DeclareFieldFormat{title}{\emph{#1}} \end{lstlisting} % List formats are slightly more complex. After splitting up the list into individual items, \sty{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 indivdual 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{lstlisting}[style=latex]{} \DeclareListFormat{location}{% #1% \ifthenelse{\value{listcount}<\value{liststop}} {\addcomma\space} {}} \end{lstlisting} % Formatting directives for names are similar to those for literal lists, but the individual items in the list are names which are automatically dissected into their components. The list formatting directive is executed once for each name in the list and the components of the name are passed to the formatting directive as separate arguments. For example, |#1| is the last name and |#3| is the first name. Here is a simplified example: \begin{lstlisting}[style=latex]{} \DeclareNameFormat{author}{% \ifthenelse{\value{listcount}=1} {#1% \ifblank{#3}{}{\addcomma\space #3}} {\ifblank{#3}{}{#3\space}% #1}% \ifthenelse{\value{listcount}<\value{liststop}} {\addcomma\space} {}} \end{lstlisting} % The above directive reverses the name of the first author («Last, First») and prints the remaining names in their regular sequence («First Last»). Note that the only component which is guaranteed to be available is the last name, hence we have to check which parts of the name are actually present. If a certain component of a name is not available, the corresponding argument will be blank. As with directives for literal lists, the separator to be inserted between the indivdual items in the 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. \subsubsection{Special Fields} \label{aut:bbx:fld} The following lists and fields are used by \sty{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{entrykey}{string} The entry key of an item in the \file{bib} file. This is the string used by \sty{biblatex} and \bibtex to identify an entry in the \file{bib} file. \fielditem{childentrykey}{string} When citing a subentry of an entry set, \sty{biblatex} provides the data of the parent \bibtype{set} entry to citation commands. This implies that the \bibfield{entrykey} field holds the entry key of the parent. The entry key of the child entry being cited is provided in the \bibfield{childentrykey} field. This field is only available when citing a subentry of an entry set. \fielditem{entrytype}{string} The entry type (\bibtype{book}, \bibtype{inbook}, etc.), given in lowercase letters. \fielditem{childentrytype}{string} When citing a subentry of an entry set, \sty{biblatex} provides the data of the parent \bibtype{set} entry to citation commands. This implies that the \bibfield{entrytype} field holds the entry type of the parent. The entry type of the child entry being cited is provided in the \bibfield{childentrytype} field. This field is only available when citing a subentry of an entry set. \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{namehash}{string} A unique hash string derived from the \bibfield{labelname} list. This is intended for recurrence checks. For example, a citation style wich 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 the global \opt{maxnames} and \opt{minnames} options. It is automatically sanitized such that the hash may safely be used in the formation of control sequence names. It is not intended for printing. See also \bibfield{fullhash}. \fielditem{fullhash}{string} Like \bibfield{namehash}, this field is a unique hash string referring to the primary name of the entry. It differs from \bibfield{namehash} in two respects: 1) The \bibfield{shortauthor} and \bibfield{shorteditor} lists are ignored when generating the hash. 2) It is always derived from the full list, ignoring the \opt{maxnames} and \opt{minnames} options. For example, with \kvopt{maxnames}{1}, the following two entries will have the same \bibfield{namehash} but different \bibfield{fullhash} values: \begin{lstlisting}[style=bibtex]{} @Article{..., author = {Doe, John and Jones, Edward}, ... @Article{..., author = {Doe, John and Williams, Joe}, ... \end{lstlisting} % The \bibfield{fullhash} field is automatically sanitized such that the hash may safely be used in the formation of control sequence names. It is not intended for printing. See also \bibfield{namehash}. \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 letter of the string used during sorting. This is useful when subdividing the bibliography alphabetically. \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 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, \sty{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. 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{extrayear} 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}. \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{useauthor}, \opt{useeditor}, and \opt{usetranslator} 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. \BiberOnlyMark With Biber, this field may be customized. See \secref{aut:ctm:fld} for details. \fielditem{labelnumber}{literal} The number of the bibliography entry, as required by numeric citation schemes. If the \bibfield{shorthand} field is defined, \sty{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{prefixnumber}{literal} If the \opt{prefixnumbers} option of \cmd{printbibliography} has been set in order to prefix all entries in a subbibliography with a fixed string, this string is available in the \bibfield{prefixnumber} field of all affected entries. If no prefix has been set, the \bibfield{prefixnumber} field of the respective entry is undefined. See the \opt{prefixnumbers} option of \cmd{printbibliography} in \secref{use:bib:bib} for details. If the \bibfield{shorthand} field is defined, \sty{biblatex} does not assign the prefix to the \bibfield{prefixnumber} field of the respective entry. In this case, the \bibfield{prefixnumber} field is undefined. \fielditem{labeltitle}{literal} The title to be printed in citations. If a short title is available, \bibfield{labeltitle} is a copy of the \bibfield{shorttitle} field, otherwise \sty{biblatex} falls back to the \bibfield{title} field. Citation styles printing short titles may simply make use of this field instead of checking whether a \bibfield{shorttitle} field is available every time they print a title. This field is provided for convenience only and does not carry any additional meaning. \fielditem{labelyear}{literal} The publication year, as specified in the \bibfield{date} or the \bibfield{year} field, for use in author-year labels. A complete author-year label consists of the fields \bibfield{labelyear} plus \bibfield{extrayear}. Note that the \bibfield{labelyear} and \bibfield{extrayear} fields need to be requested with the package option \opt{labelyear}, see \secref{use:opt:pre:int} for details. See also \bibfield{extrayear}. \BiberOnlyMark With Biber, this field may be customized. See \secref{aut:ctm:fld} for details. \fielditem{extrayear}{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{extrayear} 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{extrayear}. Note that the \bibfield{labelyear} and \bibfield{extrayear} fields need to be requested with the package option \opt{labelyear}, see \secref{use:opt:pre:int} for details. See also \bibfield{labelyear}. \end{fieldlist} \paragraph{Date Component Fields} \label{aut:bbx:fld:dat} 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. \begin{table} \tablesetup \begin{tabularx}{\textwidth}{@{}>{\ttfamily}lX>{\ttfamily}lX@{}} \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 \\ & & endday & undefined \\ & & endmonth & undefined \\ & & endyear & undefined \\ date & 1997/ & day & undefined \\ & & month & undefined \\ & & year & 1997 \\ & & endday & undefined \\ & & endmonth & undefined \\ & & endyear & empty \\ urldate & 2009-01-31 & urlday & 31 \\ & & urlmonth & 01 \\ & & urlyear & 2009 \\ & & urlendday & undefined \\ & & urlendmonth & undefined \\ & & urlendyear & undefined \\ origdate & 2002-01/2002-02 & origday & undefined \\ & & origmonth & 01 \\ & & origyear & 2002 \\ & & origendday & undefined \\ & & origendmonth & 02 \\ & & origendyear & 2002 \\ eventdate & 1995-01-31/1995-02-05 & eventday & 31 \\ & & eventmonth & 01 \\ & & eventyear & 1995 \\ & & eventendday & 05 \\ & & eventendmonth & 02 \\ & & eventendyear & 1995 \\ \bottomrule \end{tabularx} \caption{Date Interface} \label{aut:bbx:fld:tab1} \end{table} \begin{fieldlist} \fielditem{day}{integer} 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}{integer} 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}{integer} 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{endday}{integer} If the date specification in the \bibfield{date} field is a range, this field holds the day component of the end date. \fielditem{endmonth}{integer} If the date specification in the \bibfield{date} field is a range, this field holds the month component of the end date. \fielditem{endyear}{integer} 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{origday}{integer} 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}{integer} 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}{integer} 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{origendday}{integer} If the date specification in the \bibfield{origdate} field is a range, this field holds the day component of the end date. \fielditem{origendmonth}{integer} If the date specification in the \bibfield{origdate} field is a range, this field holds the month component of the end date. \fielditem{origendyear}{integer} 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{eventday}{integer} 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}{integer} 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}{integer} 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{eventendday}{integer} If the date specification in the \bibfield{eventdate} field is a range, this field holds the day component of the end date. \fielditem{eventendmonth}{integer} If the date specification in the \bibfield{eventdate} field is a range, this field holds the month component of the end date. \fielditem{eventendyear}{integer} 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{urlday}{integer} This field holds the day component of the \bibfield{urldate} field. \fielditem{urlmonth}{integer} This field holds the month component of the \bibfield{urldate} field. \fielditem{urlyear}{integer} This field holds the year component of the \bibfield{urldate} field. \fielditem{urlendday}{integer} If the date specification in the \bibfield{urldate} field is a range, this field holds the day component of the end date. \fielditem{urlendmonth}{integer} If the date specification in the \bibfield{urldate} field is a range, this field holds the month component of the end date. \fielditem{urlendyear}{integer} 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. \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 \sty{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{lstlisting}[style=latex]{} \DeclareMultiCiteCommand{\cites}% {\cite}{\multicitedelim} \DeclareMultiCiteCommand{\parencites}[\mkbibparens]% {\parencite}{\multicitedelim} \DeclareMultiCiteCommand{\footcites}[\mkbibfootnote]% {\footcite}{\multicitedelim} \end{lstlisting} \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{lstlisting}[style=latex]{} \DeclareAutoCiteCommand{plain}{\cite}{\cites} \DeclareAutoCiteCommand{inline}{\parencite}{\parencites} \DeclareAutoCiteCommand{footnote}[l]{\footcite}{\footcites} \DeclareAutoCiteCommand{footnote}[f]{\smartcite}{\smartcites} \end{lstlisting} \end{ltxsyntax} \subsubsection{Special Fields} \label{aut:cbx:fld} The following fields are used by \sty{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. \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 \sty{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{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{lstlisting}[style=latex]{} \printnames[][1-3]{...} \end{lstlisting} One of \prm{start} and \prm{stop} may be omitted, hence the following arguments are all valid: \begin{lstlisting}[style=latex]{} \printnames[...][-1]{...} \printnames[...][2-]{...} \printnames[...][1-3]{...} \end{lstlisting} 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{lstlisting}[style=latex]{} \printnames[...][-\value{listtotal}]{...} \end{lstlisting} 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 \sty{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 format is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. 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{extrayear} field in the date specification. This is useful for bibliography styles designed for author-year citations. \csitem{printurldate} This command prints the \bibfield{urldate} of the entry. The format is controlled by the package option \opt{urldate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. \csitem{printorigdate} This command prints the \bibfield{origdate} of the entry. The format is controlled by the package option \opt{origdate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. \csitem{printeventdate} This command prints the \bibfield{eventdate} of the entry. The format is controlled by the package option \opt{eventdate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. \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{babel} 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. \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 passed to the \prm{code} as separate arguments. These arguments are as follows: \begin{argumentlist}{00} \item[\#1] The last names. If a name consists of a single part only (for example, <Aristotle>), this part will be treated as the last name. \item[\#2] The last names, given as initials. \item[\#3] The first names. This argument also includes all middle names. \item[\#4] The first names, given as initials. \item[\#5] The name prefixes, for example von, van, of, da, de, del, della, etc. Note that name prefixes are referred to as the <von part> of the name in the \bibtex documentation. \item[\#6] The name prefixes, given as initials. \item[\#7] The name affixes, for example <junior>, <senior>, <der Jüngere>, <der Ältere>, etc. Note that name affixes are referred to as the <junior part> of the name in the \bibtex documentation. \item[\#8] The name affixes, given as initials. \end{argumentlist} % If a certain part of a name is not available, the corresponding argument will be empty, hence you may use \cmd{ifblank} tests to check for the inidividual 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{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{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. \end{ltxsyntax} \subsection{Customization} \label{aut:ctm} \subsubsection{Sorting} \label{aut:ctm:srt} In addition to the predefined sorting schemes 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. Note that custom sorting schemes require Biber. They will not work with any other backend. \begin{ltxsyntax} \cmditem{DeclareSortingScheme}{name}{specification}|\BiberOnlyMark| Defines the sorting scheme \prm{name}. The \prm{name} is the identifier passed to the \opt{sorting} option (\secref{use:opt:pre:gen}) when selecting the sorting scheme. 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{name}, \cmd{list}, \cmd{field}, \cmd{literal}, and \cmd{citeorder} commands which are evalutated 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. The \cmd{sort} command supports the following optional arguments: \begin{optionlist*} \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{name}{name list} The \cmd{name} element adds a \prm{name list} to the sorting specification. If the \prm{name list} is undefined, the element is skipped. \cmditem{list}{literal list} The \cmd{list} element adds a \prm{literal list} to the sorting specification. If the \prm{literal list} is undefined, the element is skipped. \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. Padding is particularly useful with numeric fields. For example, the command \begin{lstlisting}[style=latex]{} \field[padside=left,padwidth=2,padchar=0]{volume} \end{lstlisting} % will pad the \bibfield{volume} field with leading zeros to a width of two characters. This way, volumes are sorted by numeric value (\texttt{01\slash 02\slash 11\slash 12}) rather than in alphabetic order (\texttt{1\slash 11\slash 12\slash 2}). \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 indicates that the entries should be kept in the order in which they were cited. It is usually the only element in the \prm{specification}: \begin{lstlisting}[style=latex]{} \DeclareSortingScheme{none}{ \sort{\citeorder} } \end{lstlisting} \end{ltxsyntax} Here are some examples. In the first example, we define a simple name\slash title\slash year scheme. 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{useauthor}, \opt{useeditor}, and \opt{usetranslator} are considered automatically in the sorting process: \begin{lstlisting}[style=latex]{} \DeclareSortingScheme{sample}{ \sort{ \name{<<author>>} \name{<<editor>>} \name{<<translator>>} } \sort{ \field{<<title>>} } \sort{ \field{<<year>>} } } \end{lstlisting} % In the next example, we define the same scheme 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} scheme: \begin{lstlisting}[style=latex]{} \DeclareSortingScheme{nty}{ \sort{ \field{<<presort>>} } \sort[<<final>>]{ \field{<<sortkey>>} } \sort{ \name{<<sortname>>} \name{author} \name{editor} \name{translator} \field{sorttitle} \field{title} } \sort{ \field{<<sorttitle>>} \field{title} } \sort{ \field{<<sortyear>>} \field{year} } } \end{lstlisting} \begin{ltxsyntax} \cmditem{DeclareSortExclusion}{entrytype, \dots}{field, \dots}|\BiberOnlyMark| 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}. This command may only be used in the preamble. \cmditem{DeclarePresort}[entrytype, \dots]{string}|\BiberOnlyMark| Specifies are 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. \end{ltxsyntax} \subsubsection{Special Fields} \label{aut:ctm:fld} Some of the automatically generated fields from \secref{aut:bbx:fld:lab} may be customized. Note that this requires Biber. \begin{ltxsyntax} \cmditem{DeclareLabelname}[entrytype, \dots]{specification}|\BiberOnlyMark| Defines the fields to consider when generating the \bibfield{labelname} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is a comma"=separated list of fields. 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{lstlisting}[style=latex]{} \DeclareLabelname{shortauthor,author,shorteditor,editor,translator} \end{lstlisting} % 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{DeclareLabelyear}[entrytype, \dots]{specification}|\BiberOnlyMark| Defines the date components to consider when generating the \bibfield{labelyear} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is a comma"=separated list of date components. The items are checked in the order listed and the first item which is available will be used as \bibfield{labelyear}. Note that the items are date components, not date fields. This is the default definition: \begin{lstlisting}[style=latex]{} \DeclareLabelyear{year,eventyear,origyear,urlyear} \end{lstlisting} % The \bibfield{labelyear} 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. See also \secref{aut:bbx:fld:dat}. \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. Note that customized data inheritance requires Biber. It will not work with any other backend. 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}|\BiberOnlyMark| 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. 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. \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} Sets the \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}{source, \dots}{target, \dots}{rules}|\BiberOnlyMark| 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. \cmditem{inherit}[option]{source}{target} Defines an inheritance rule by mapping a \prm{source} field to a \prm{target} field. The \prm{option} is the \opt{override} option explained above. When set locally, it takes precedence over any global options set with \cmd{DefaultInheritance}. \cmditem{noinherit}{source} Unconditionally prevents inheritance of the \prm{source} field. \csitem{ResetDataInheritance}\BiberOnlyMark 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{lstlisting}[style=latex]{} \DefaultInheritance{<<all=true>>,<<override=false>>} \end{lstlisting} % This example shows how to configure the default inheritance behavior. The above settings are the package defaults. \begin{lstlisting}[style=latex]{} \DefaultInheritance[ <<\except>>{<<*>>}{<<online>>}{<<all=false>>} ]{all=true,override=false} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareDataInheritance{<<collection>>}{<<incollection>>}{ <<\inherit>>{<<title>>}{<<booktitle>>} \inherit{subtitle}{booksubtitle} \inherit{titleaddon}{booktitleaddon} } \end{lstlisting} % So far we have looked at setting up the defaults. 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{lstlisting}[style=latex]{} \DeclareDataInheritance{<<mvbook,book>>}{<<inbook,bookinbook>>}{ \inherit{<<author>>}{<<author>>} \inherit{<<author>>}{<<bookauthor>>} } \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareDataInheritance{<<*>>}{<<inbook,incollection>>}{ <<\noinherit>>{<<introduction>>} } \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareDataInheritance{<<*>>}{<<*>>}{ \noinherit{abstract} } \end{lstlisting} % This rule, which applies to all entries, regardless of the source and target entry types, prevents inheritance of the \bibfield{abstract} field. \begin{lstlisting}[style=latex]{} \DefaultInheritance{all=true,override=false} \ResetDataInheritance \end{lstlisting} % This example demonstrates how to emulate \bibtex's cross"=referencing mechanism. It enables inheritance by default, disables overwriting, and clears all other inheritance rules and mappings. \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{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{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{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{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} 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} 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} 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{ifsingletitle}{true}{false} Expands to \prm{true} if there is only one work by the author\slash editor in the bibliography, and to \prm{false} otherwise. Note that this feature needs to be enabled explicitly with the package option \opt{singletitle}. \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{iffirstinits}{true}{false} Expands to \prm{true} or \prm{false}, depending on the state of the \opt{firstinits} package option (see \secref{use:opt:pre:int}). This command is intended for use in formatting directives for name lists. \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. \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. \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{lstlisting}[style=latex]{} \ifentryseen{<<\thefield{xref}>>}{true}{false} \end{lstlisting} % Apart from the additional argument, \cmd{ifentryseen} behaves like \cmd{ifciteseen}. \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 the list of shorthands. 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 the list of shorthands. 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{lstlisting}[style=latex]{} \ifsamepage{<<\value>>{instcount}}{<<\value>>{instcount}<<-1>>}{true}{false} \end{lstlisting} 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}, and \cmd{NumCheckSetup} in \secref{aut:aux:msc}. \cmditem{ifpages}{string}{true}{false} Similar to \cmd{ifnumerals}, but also considers \cmd{DeclarePageCommands} 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 localization key, and to \prm{false} otherwise. The localization 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{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 \sty{biblatex}'s punctuation tracker would capitalize a localization 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{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{uniquename}\BiberOnlyMark This counter refers to the \bibfield{labelname} list. It is set on a per-name basis. Its value is \texttt{0} if the last name is unique, \texttt{1} if adding the other parts of the name (first name, prefix, suffix) as initials will make it unique, and \texttt{2} if the full name is 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 last name. For example, 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 to the name list \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. \cntitem{uniquelist}\BiberOnlyMark 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 \sty{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{usebibmacro}{name} Executes the macro \prm{name}, as defined with \cmd{newbibmacro}. If the macro takes any arguments, they are simply appended after \prm{name}. \cmd{usebibmacro} is robust. \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 localization 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 localization 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 localization 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 localization 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 localization files. \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. Additional 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{babel} 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 \sty{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 coverts 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{hyphenation} field. It only converts the \prm{text} to sentence case if the \bibfield{hyphenation} field is undefined or if it 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.} Otherwise, the \prm{text} is not altered in any way. It is recommended to use \cmd{MakeSentenceCase*} rather than the regular variant in formatting directives. 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{lstlisting}[style=latex]{} \MakeSentenceCase{an Introduction to LaTeX} \MakeSentenceCase{an Introduction to {LaTeX}} \end{lstlisting} % 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. \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}. This must be a macro taking one mandatory argument. If only one optional argument is given, it is taken as \prm{pagination}. Here are two typical examples: \begin{lstlisting}[style=latex]{} \DeclareFieldFormat{postnote}{<<\mkpageprefix[pagination]{#1}>>} \DeclareFieldFormat{pages}{<<\mkpageprefix[bookpagination]{#1}>>} \end{lstlisting} % The optional argument \bibfield{pagination} in the first example is omissible. \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}. This must be a macro taking one mandatory argument. If only one optional argument is given, it is taken as \prm{pagination}. Here is a typical example: \begin{lstlisting}[style=latex]{} \DeclareFieldFormat{pagetotal}{<<\mkpagetotal[bookpagination]{#1}>>} \end{lstlisting} % The optional argument \bibfield{bookpagination} is omissible in this case. \cmditem{mkpagefirst}[pagination][postpro]{text} \cmditem*{mkpagefirst*}[postpro]{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. The regular version uses \cmd{mkpageprefix} to format the \prm{text} after truncation, passing the \prm{pagination} and/or \prm{postpro} arguments to \cmd{mkpageprefix}. The starred version prints the truncated \prm{text} as is. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This must be a macro taking one mandatory argument. \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{lstlisting}[style=latex]{} \DeclareNumChars{.} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareRangeChars{~,;-+/} \end{lstlisting} % 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}. 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{lstlisting}[style=latex]{} \DeclareRangeCommands{\&\bibrangedash\textendash\textemdash\psq\psqq} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclarePageCommands{\pno\ppno} \end{lstlisting} \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{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} languages 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{lstlisting}[style=latex]{} \DeclareCaseLangs{% american,british,canadian,english,australian,newzealand, USenglish,UKenglish} \end{lstlisting} % See the \sty{babel} manual 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. \cmditem{RequireBiber}[severity] This command is intended for use in \file{cbx}\slash\file{bbx} files and in the \texttt{@preamble} of \file{bib} files. It checks the selected backend and warns if it is not Biber. The optional \prm{severity} argument is an integer specifying the severity. The value 1 triggers an informational message stating that Biber is recommended; 2 triggers a warning stating that Biber is required and the style\slash\file{bib} file may not work properly; 3 triggers an error stating that Biber is strictly required and the style\slash\file{bib} file will not work at all with any other backend. If \cmd{RequireBiber} is used multiple times, the highest \prm{severity} takes precedence. \file{cbx}\slash\file{bbx} files on the one hand and the \texttt{@preamble} snippets of all \file{bib} files on the other are tracked seperately. If the optional \prm{severity} argument is omitted, the default severity is 2 (warning). \boolitem{pagetracker} 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} 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} 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 \sty{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 localization 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{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 preceeding 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} 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. \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 \sty{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{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{lstlisting}[style=latex]{} \DeclareAutoPunctuation{.,;:!?} \end{lstlisting} % 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 \sty{biblatex} inserts localization 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 localization strings to be capitalized if one of them preceds 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{lstlisting}[style=latex]{} \DeclareCapitalPunctuation{.!?} \end{lstlisting} % 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 localization 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{lstlisting}[style=latex]{} \DeclarePunctuationPairs{comma}{*!?} \end{lstlisting} % 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 \sty{biblatex} switches languages and corresponds to the behavior described in \secref{aut:pct:pct}: \begin{lstlisting}[style=latex]{} \DeclarePunctuationPairs{dot}{} \DeclarePunctuationPairs{comma}{*!?} \DeclarePunctuationPairs{semicolon}{*!?} \DeclarePunctuationPairs{colon}{*!?} \DeclarePunctuationPairs{period}{} \DeclarePunctuationPairs{exclam}{*} \DeclarePunctuationPairs{question}{*} \end{lstlisting} % 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 localization module). See \secref{use:lng, aut:lng} for details. Note that some localization 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{lstlisting}[style=latex]{} \DeclareQuotePunctuation{.,} \end{lstlisting} % 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 localization 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 localization strings printed as the first word in a footnote (which is usually treated as the beginning of a paragaph 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 localization 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 localization 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 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 \sty{biblatex}'s localization 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 localized term. \begin{ltxsyntax} \cmditem{bibstring}[wrapper]{key} Prints the localization 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 localization 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{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 localization 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. \end{ltxsyntax} \subsection{Localization Modules} \label{aut:lng} A localization 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} package. The \file{lbx} files may also be used to map \sty{babel}'s language names to the backend modules of the \sty{biblatex} package. All localization 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 localization commands were already introduced in \secref{use:lng}. When used in \file{lbx} files, however, the syntax of localization commands is different from the user syntax in the preamble and the configuration file. When used in localization 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 localization 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{lstlisting}[style=latex]{} \DeclareBibliographyStrings{% bibliography = {{Bibliography}{Bibliography}}, shorthands = {{List of Abbreviations}{Abbreviations}}, editor = {{editor}{ed.}}, editors = {{editors}{eds.}}, } \end{lstlisting} % 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}), \sty{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{lstlisting}[style=latex]{} \DeclareBibliographyStrings{% inherit = {german}, january = {{J\"anner}{J\"an.}}, } \end{lstlisting} The above examples are slightly simplified. Real localization files should use the punctuation and formatting commands discussed in \secref{aut:pct:pct, use:fmt} instead of literal puntuation. Here is an excerpt from a real localization file: \begin{lstlisting}[style=latex]{} 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{lstlisting} % 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 \sty{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 localization 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 localized 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, ...}{babel, babel, ...} 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{babel} is \sty{babel}'s language identifier, as given in the optional argument of \cmd{usepackage} when loading \sty{babel}. This command may be used in \file{lbx} files or in the document preamble. Here are some examples: \begin{lstlisting}[style=latex]{} \DeclareRedundantLanguages{french}{french} \DeclareRedundantLanguages{german}{german,ngerman,austrian,naustrian} \DeclareRedundantLanguages{english,american}{english,american,british, canadian,australian,newzealand,USenglish,UKenglish} \end{lstlisting} % 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{babel} parameter is blank, \sty{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} language identifier to an \file{lbx} file. The \prm{language} must be a language name known to the \sty{babel} 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{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 localization 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} \subsubsection{Localization Keys} \label{aut:lng:key} The localization keys in this section are defined by default and covered by the localization files which come with \sty{biblatex}. Note that these strings are only available in citations, the bibliography, and the list of shorthands. All expressions should be capitalized as they usually are when used in the middle of a sentence. \sty{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 \sty{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{losname}. \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}. \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[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}>. \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[jourvol] The term <volume>, referring to a journal. \item[jourser] The term <series>, referring to a journal. \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}>. \end{keymarglist} \paragraph{Publication State} \label{aut:lng:key:pst} \begin{keymarglist} \item[inpress] The expression <in press>. \item[inpreparation] The expression <in preparation>, referring to manuscript being prepared for publication. \item[submitted] The expression <submitted>, referring to an article or paper submitted to a journal or conference. \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}. \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[mathesis] An expression equivalent to the term <Master's thesis>. \item[phdthesis] The term <PhD thesis>, <PhD dissertation>, <doctoral thesis>, etc. \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[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[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[langdanish] The language <Danish>. \item[langdutch] The language <Dutch>. \item[langenglish] The language <English>. \item[langfrench] The language <French>. \item[langgerman] The language <German>. \item[langgreek] The language <Greek>. \item[langitalian] The language <Italian>. \item[langlatin] The language <Latin>. \item[langnorwegian] The language <Norwegian>. \item[langportuguese] The language <Portuguese>. \item[langspanish] The language <Spanish>. \item[langswedish] The language <Swedish>. \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[fromdanish] The expression <from [the] Danish>. \item[fromdutch] The expression <from [the] Dutch>. \item[fromenglish] The expression <from [the] English>. \item[fromfrench] The expression <from [the] French>. \item[fromgerman] The expression <from [the] German>. \item[fromgreek] The expression <from [the] Greek>. \item[fromitalian] The expression <from [the] Italian>. \item[fromlatin] The expression <from [the] Latin>. \item[fromnorwegian] The expression <from [the] Norwegian>. \item[fromportuguese] The expression <from [the] Portuguese>. \item[fromspanish] The expression <from [the] Spanish>. \item[fromswedish] The expression <from [the] Swedish>. \end{keymarglist} \paragraph{Country Names} \label{aut:lng:key:cnt} Country names are localized 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 localized 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} \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{bibnamedelima}\BiberOnlyMark 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}\BiberOnlyMark 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 last 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}\BiberOnlyMark 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 \sty{biblatex} which use their own set of delimiters. \csitem{bibinitperiod}\BiberOnlyMark 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}\BiberOnlyMark 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}\BiberOnlyMark 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{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} The 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). 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{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{multinamedelim} 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. \csitem{finalnamedelim} Use this command instead of \cmd{multinamedelim} before the final name in a name list. \csitem{revsdnamedelim} The extra delimiter to be printed after the first name in a name list (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} The delimiter to be printed before the localization 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. \csitem{multilistdelim} 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. \csitem{finallistdelim} Use this command instead of \cmd{multilistdelim} before the final item in a literal list. \csitem{andmoredelim} The delimiter to be printed before the localization 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. \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. \csitem{supercitedelim} Similar to \cmd{multinamedelim}, but intended for the \cmd{supercite} command only. \csitem{compcitedelim} Similar to \cmd{multicitedelim}, but intended for citation styles which <compress> multiple citations, \ie print the author only once if subsequent citations share the same author etc. \csitem{nametitledelim} 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. \csitem{nameyeardelim} 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. \csitem{prenotedelim} The delimiter to be printed after the \prm{prenote} argument of a citation command. \csitem{postnotedelim} The delimiter to be printed after the \prm{postnote} argument of a citation command. \cmditem{mkbibnamelast}{text} Formatting hook for the last name, to be used in all formatting directives for name lists. \cmditem{mkbibnamefirst}{text} Similar to \cmd{mkbibnamelast}, but intended for the first name. \cmditem{mkbibnameprefix}{text} Similar to \cmd{mkbibnamelast}, but intended for the name prefix. \cmditem{mkbibnameaffix}{text} Similar to \cmd{mkbibnamelast}, but intended for the name affix. \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 localization 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 range dash. \csitem{bibdatedash} The language specific date range dash. \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{finalandcomma} Prints the comma 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{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. Bibliography styles should incorporate this length in the definition of the bibliography environment, if applicable. \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. \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. \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. \cntitem{abbrvpenalty} The penalty used by \cmd{addabbrvspace}, \cmd{addabthinspace}, and \cmd{adddotspace}, see \secref{aut:pct:spc} for details. \cntitem{lownamepenalty} The penalty used by \cmd{addlowpenspace} and \cmd{addlpthinspace}, see \secref{aut:pct:spc} for details. \cntitem{highnamepenalty} The penalty used by \cmd{addhighpenspace} and \cmd{addhpthinspace}, see \secref{aut:pct:spc} for details. \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 \sty{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 in italics. 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{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 preceeding 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} execept that it prints its argument as an endnote. \cmd{mkbibendnote} removes spurious whitespace preceeding 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{lstlisting}[style=latex]{} \footnote{<<\bibfootnotewrapper{>>text<<}>>} \end{lstlisting} % The wrapper ensures capitalization at the beginning of the note and adds a period at the end. The default definition is: \begin{lstlisting}[style=latex]{} \newcommand{\bibfootnotewrapper}[1]{<<\bibsentence>> #1<<\addperiod>>} \end{lstlisting} % 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 preceeding 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 localization modules. \cmditem{mkdatezeros}{integer} This command strips leading zeros from a number or preserves 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. \cmditem{stripzeros}{integer} This command strips leading zeros from a number. It is intended for date formatting and ordinals. \optitem{shorthandwidth} A special field formatting directive which is used internally by \sty{biblatex}. When the bibliographic data is read from the \file{bbl} file, \sty{biblatex} measures the values of all \bibfield{shorthand} fields and sets the length register \cmd{shorthandwidth} to the width of the widest shorthand (see \secref{aut:fmt:ilc}). In order to determine the correct width, the package considers two factors: the definition of \cmd{bibfont} and this formatting directive. All styles should adjust this directive such that it corresponds to the format used in the list of shorthands. \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. \end{ltxsyntax} \subsubsection{Auxiliary Lengths, Counters, and Other Features} \label{aut:fmt:ilc} The length registers and counters discussed here are used by \sty{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{shorthandwidth} This length register indicates the width of the widest \bibfield{shorthand}. Bibliography styles should incorporate this length in the definition of the list of shorthands, if applicable. \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{maxextrayear} This counter holds the highest number found in any \bibfield{extrayear} 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 \sty{biblatex} for every citation as well as for every entry in the bibliography and the list of shorthands. 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{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. \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. \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{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{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{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, if there are any \env{refsection} environments in the document and an entry is cited in more than one of them, the \prm{code} may be executed multiple times for an entry. The \cnt{refsection} counter holds the number of the respective reference section while the data is imported. \end{ltxsyntax} \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{lstlisting}[style=latex]{} \DeclareBibliographyDriver{set}{% <<\entryset>>{}{}% \finentry} \end{lstlisting} % You may have noticed that the \texttt{numeric} styles which ship 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{lstlisting}[style=latex]{} \DeclareBibliographyDriver{set}{% \entryset {<<\printfield{entrysetcount}>>% <<\setunit*{\addnbspace}>>} {}% \finentry} \end{lstlisting} % 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{lstlisting}[style=latex]{} \printfield{labelnumber}<<\printfield{entrysetcount}>> \end{lstlisting} % Since this field is only defined when processing citations referring to a set member, there is no need to add any additional tests. \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{lstlisting}[style=latex]{} \iffieldundef{eprinttype} {\printfield{eprint}} {\printfield[<<eprint:\strfield{eprinttype}>>]{eprint}} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareFieldFormat{<<eprint>>}{...} \DeclareFieldFormat{<<eprint:arxiv>>}{...} \end{lstlisting} % 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{lstlisting}[style=latex]{} \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{lstlisting} % 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\BiberOnlyMark} \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. \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 last 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 last name. In order to disambiguate the author's last 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 last 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 last names. 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 last name lists only. Another way of looking at this is that they globally disambiguate last name 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. 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 \sty{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{lstlisting}[style=latex]{} \DeclareCiteCommand{\fullcite} {...} {<<\usedriver>>{...}{<<\thefield{entrytype}>>}} {...} {...} \end{lstlisting} % 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 bibligraphy driver: block and unit punctuation is handled asynchronously. This is best explained by way of example. Consider the following code snippet: \begin{lstlisting}[style=latex]{} \printfield{title}% \newunit \printfield{edition}% \newunit \printfield{note}% \end{lstlisting} % 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{lstlisting}[style=latex]{} \printfield{title}% \newunit \printfield{edition}% \newunit \printfield{note}% \end{lstlisting} % 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 interal <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 interal 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{lstlisting}[style=latex]{} \iffieldundef{title}% {\iffieldundef{edition} {\printfield{note}} {\printfield{edition}% \iffieldundef{note}% {} {. \printfield{note}}}} {\printfield{title}% \iffieldundef{edition} {} {. \printfield{edition}}% \iffieldundef{note} {} {. \printfield{note}}}% \end{lstlisting} \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{lstlisting}[style=latex]{} \printfield{title}% \newunit <<(>>\printfield{series} \printfield{number}<<)>>% \end{lstlisting} % 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{lstlisting}[style=latex]{} \printfield{title}% \newunit <<\printtext{(}>>% \printfield{series}% <<\setunit*{\addspace}>>% \printfield{number}% <<\printtext{)}>>% \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareFieldFormat{<<parens>>}{<<\mkbibparens{#1}>>} \end{lstlisting} % 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{lstlisting}[style=latex]{} <<\printtext[parens]{>>% \printfield{series}% \setunit*{\addspace}% \printfield{number}% <<}>>% \end{lstlisting} % We still need to handle cases in which there is no series information at all, so let's improve the code some more: \begin{lstlisting}[style=latex]{} <<\iffieldundef{series}>> {} {\printtext[parens]{% \printfield{series}% \setunit*{\addspace}% \printfield{number}}}% \end{lstlisting} % One final hint: localization 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{lstlisting}[style=latex]{} ...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{lstlisting} % 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{lstlisting}[style=latex]{} \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{lstlisting} % 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{lstlisting}[style=latex]{} \newunit \printlist{location}% \setunit*{\addcolon\space}% \printlist{publisher}% \setunit*{\addcomma\space}% \printfield{year}% \newunit \end{lstlisting} % 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{lstlisting}[style=latex]{} ...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{lstlisting} % This can be handled by the following code: \begin{lstlisting}[style=latex]{} \newunit \printlist{location}% \iflistundef{publisher} {\setunit*{\addcomma\space}} {\setunit*{\addcolon\space}}% \printlist{publisher}% \setunit*{\addcomma\space}% \printfield{year}% \newunit \end{lstlisting} % 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} 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} language \texttt{french} in the preamble or in the configuration file: \begin{lstlisting}[style=latex]{} \DeclareLanguageMapping{french}{french-humanities} \end{lstlisting} % 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{lstlisting}[style=latex]{} \DeclareLanguageMapping{american}{american-mla} \end{lstlisting} % 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 localization module is complete. They will typically do so by inheriting data from the corresponding standard module. If the language \texttt{american} is mapped to \path{american-mla.lbx}, \sty{biblatex} will not load \path{american.lbx} unless this module is requested explicitly. In the above example, inheriting <strings> and <extras> will cause \sty{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} language aliases (\eg \texttt{USenglish} vs. \texttt{american}). For example, \sty{babel} offers the \texttt{USenglish} option which is similar to \texttt{american}. Therefore, \sty{biblatex} ships 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} language aliases happens on the file level, the point being that \sty{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: \file{portuges}), you create a file named \path{portuges.lbx}. If \sty{babel} 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 list of shorthands printed by \cmd{printshorthands} 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 \sty{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 localization modules. The localization module should add a second prefix to specify the language. For example, an internal macro defined by the Spanish localization module would be named \cmd{lbx@es@macro}. \end{marglist} \appendix \section*{Appendix} \addcontentsline{toc}{section}{Appendix} \section{Default \bibfield{crossref} 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.2\textwidth}% @{}V{0.2\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 \textasteriskcentered & \textasteriskcentered & crossref\par xref\par entryset\par entrysubtype\par execute\par label\par options\par presort\par related\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 \\ mvbook\sep book & inbook\sep bookinbook\sep suppbook & author\par author & author\par bookauthor \\ 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 \\ 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 \\ 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 \\ 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 \\ 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 \\ 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 \\ 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 \\ \end{longtable} \endgroup \section{Default Sorting Schemes} \label{apx:srt} \subsection[Alphabetic 1]{Alphabetic Schemes 1} \label{apx:srt:a1} The following table shows the standard alphabetic sorting schemes 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}{Sorting scheme} \\ \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\alt 0000 \\ 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\alt 0000 \\ nyvt & presort\alt mm & \new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title & \new sortyear\alt year & \new volume\alt 0000 & \new sorttitle\alt title \\ \textrm{all} & presort\alt mm & \new sortkey \\ \end{longtable} \endgroup \subsection[Alphabetic 2]{Alphabetic Schemes 2} \label{apx:srt:a2} The following table shows the alphabetic sorting schemes 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}{Sorting scheme} \\ \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\alt 0000 \\ anyvt & presort\alt mm & \new labelalpha & \new sortname\alt author\alt editor\alt translator\alt sorttitle\alt title & \new sortyear\alt year & \new volume\alt 0000 & \new sorttitle\alt title \\ \textrm{all} & presort\alt mm & \new labelalpha & \new sortkey \\ \end{longtable} \endgroup \subsection[Chronological ]{Chronological Schemes} \label{apx:srt:chr} The following table shows the chronological sorting schemes 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}{Sorting scheme} \\ \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{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. If an entry in the revision history states that a feature has been \emph{improved} or \emph{extended}, this indicates a modification which either does not affect the syntax and behavior of the package or is syntactically backwards compatible (such as the addition of an optional argument to an existing command). Entries stating that a feature has been \emph{modified}, \emph{renamed}, or \emph{removed} demand attention. They indicate a modification which may require changes to existing styles or documents in some, hopefully rare, cases. The numbers on the right indicate the relevant section of this manual. \begin{changelog} \begin{release}{1.5}{2011-06-08} \item Added option \kvopt{uniquename}{mininit/minfull}\see{use:opt:pre:int}\BiberOnlyMark \item Added option \kvopt{uniquelist}{minyear}\see{use:opt:pre:int}\BiberOnlyMark \item Updated documentation of \cnt{uniquename} counter\see{aut:aux:tst}\BiberOnlyMark \item Updated documentation of \cnt{uniquelist} counter\see{aut:aux:tst}\BiberOnlyMark \item Expanded documentation for \opt{uniquename/uniquelist} options\see{aut:cav:amb}\BiberOnlyMark \item Added editorial role \texttt{reviser}\see{bib:use:edr} \item Added localization 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}\BiberOnlyMark \item Added special counter \cnt{uniquelist}\see{aut:aux:tst}\BiberOnlyMark \item Revised and improved package option \opt{uniquename}\see{use:opt:pre:int}\BiberOnlyMark \item Revised and improved special counter \cnt{uniquename}\see{aut:aux:tst}\BiberOnlyMark \item Added \cmd{bibnamedelimi}\see{use:fmt:fmt}\BiberOnlyMark \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}\BiberOnlyMark \item Introducing experimental support for EndNote \acr{XML}\see{use:bib:res}\BiberOnlyMark \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}\BiberOnlyMark \item Added \cmd{bibnamedelimb}\see{use:fmt:fmt}\BiberOnlyMark \item Added \cmd{bibnamedelimc}\see{use:fmt:fmt} \item Added \cmd{bibnamedelimd}\see{use:fmt:fmt} \item Added \cmd{bibinitperiod}\see{use:fmt:fmt}\BiberOnlyMark \item Added \cmd{bibinitdelim}\see{use:fmt:fmt}\BiberOnlyMark \item Added \cmd{bibinithyphendelim}\see{use:fmt:fmt}\BiberOnlyMark \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}\BiberOnlyMark \item Introducing experimental \acr{RIS} support\see{use:bib:res}\BiberOnlyMark \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}\BiberOnlyMark \item Introducing \bibfield{crossref} configuration interface\see{aut:ctm:ref}\BiberOnlyMark \item Added \cmd{DefaultInheritance}\see{aut:ctm:ref}\BiberOnlyMark \item Added \cmd{DeclareDataInheritance}\see{aut:ctm:ref}\BiberOnlyMark \item Added \cmd{ResetDataInheritance}\see{aut:ctm:ref}\BiberOnlyMark \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 localization 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}\BiberOnlyMark \item Added option \opt{safeinputenc}\see{use:opt:pre:gen}\BiberOnlyMark \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}\BiberOnlyMark \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}\BiberOnlyMark \item Made option \bibfield{useauthor} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \bibfield{useeditor} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{usetranslator} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{skipbib} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{skiplos} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{skiplab} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{dataonly} settable on a per-type basis\see{use:opt:bib}\BiberOnlyMark \item Made option \opt{labelalpha} settable on a per-type basis\see{use:opt:pre:int}\BiberOnlyMark \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}\BiberOnlyMark \item Made option \opt{singletitle} settable on a per-type basis\see{use:opt:pre:int}\BiberOnlyMark \item Made option \opt{uniquename} settable on a per-type basis\see{use:opt:pre:int}\BiberOnlyMark \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}\BiberOnlyMark \item Introducing dynamic entry sets\see{use:use:set}\BiberOnlyMark \item Added \cmd{defbibentryset}\see{use:bib:set}\BiberOnlyMark \item Added option \opt{mcite}\see{use:opt:ldt}\BiberOnlyMark \item Added \sty{mcite}\slash\sty{mciteplus}-like commands\see{use:cit:mct}\BiberOnlyMark \item Added \cmd{sortalphaothers}\see{use:fmt:fmt}\BiberOnlyMark \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\BiberOnlyMark \item Added \cmd{DeclareSortingScheme}\see{aut:ctm:srt}\BiberOnlyMark \item Added \cmd{DeclarePresort}\see{aut:ctm:srt}\BiberOnlyMark \item Added \cmd{DeclareSortExclusion}\see{aut:ctm:srt}\BiberOnlyMark \item Added \cmd{DeclareLabelname}\see{aut:ctm:fld}\BiberOnlyMark \item Added \cmd{DeclareLabelyear}\see{aut:ctm:fld}\BiberOnlyMark \item Improved special field \bibfield{labelname}\see{aut:bbx:fld}\BiberOnlyMark \item Improved special field \bibfield{labelyear}\see{aut:bbx:fld}\BiberOnlyMark \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:los} \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:los} %\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 localization key \texttt{backrefpage}\see{aut:lng:key} %\item Added localization 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:los} %\item Extended \cmd{defbibheading}\see{use:bib:hdg} %\item Added options \opt{subtype}/\opt{notsubtype} to \cmd{printbibliography}\see{use:bib:los} %\item Added options \opt{subtype}/\opt{notsubtype} to \cmd{printshorthands}\see{use:bib:los} %\item Added test \opt{subtype} to \cmd{defbibfilter}\see{use:bib:flt} %\item Added option \opt{segment} to \cmd{printshorthands}\see{use:bib:los} %\item Added options \opt{type}/\opt{nottype} to \cmd{printshorthands}\see{use:bib:los} %\item Added options \opt{keyword}/\opt{notkeyword} to \cmd{printshorthands}\see{use:bib:los} %\item Added options \opt{category}/\opt{notcategory} to \cmd{printshorthands}\see{use:bib:los} %\item Added option \opt{filter} to \cmd{printshorthands}\see{use:bib:los} %\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 localization key \texttt{editor}\see{aut:lng:key} %\item Removed localization key \texttt{editors}\see{aut:lng:key} %\item Renamed localization key \texttt{typeeditor} to \texttt{editor}\see{aut:lng:key} %\item Renamed localization key \texttt{typeeditors} to \texttt{editors}\see{aut:lng:key} %\item Renamed localization key \texttt{typecompiler} to \texttt{compiler}\see{aut:lng:key} %\item Renamed localization key \texttt{typecompilers} to \texttt{compilers}\see{aut:lng:key} %\item Added localization key \texttt{founder}\see{aut:lng:key} %\item Added localization key \texttt{founders}\see{aut:lng:key} %\item Added localization key \texttt{continuator}\see{aut:lng:key} %\item Added localization key \texttt{continuators}\see{aut:lng:key} %\item Added localization key \texttt{collaborator}\see{aut:lng:key} %\item Added localization key \texttt{collaborators}\see{aut:lng:key} %\item Removed localization key \texttt{byauthor}\see{aut:lng:key} %\item Renamed localization key \texttt{bytypeauthor} to \texttt{byauthor}\see{aut:lng:key} %\item Removed localization key \texttt{byeditor}\see{aut:lng:key} %\item Renamed localization key \texttt{bytypeeditor} to \texttt{byeditor}\see{aut:lng:key} %\item Renamed localization key \texttt{bytypecompiler} to \texttt{bycompiler}\see{aut:lng:key} %\item Added localization key \texttt{byfounder}\see{aut:lng:key} %\item Added localization key \texttt{bycontinuator}\see{aut:lng:key} %\item Added localization key \texttt{bycollaborator}\see{aut:lng:key} %\item Added localization key \texttt{inpress}\see{aut:lng:key} %\item Added localization 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 localization keys related to \texttt{editor}\see{aut:lng:key} %\item Added several localization keys related to \texttt{translator}\see{aut:lng:key} %\item Added localization key \texttt{thiscite}\see{aut:lng:key} %\item Removed several \texttt{country...} localization keys\see{aut:lng:key} %\item Removed several \texttt{patent...} localization keys\see{aut:lng:key} %\item Removed several \texttt{patreq...} localization 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 localization 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 localization 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 localization keys\see{aut:lng:key} %\item Rearranged some localization 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 localization 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:los} %\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 localization 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:los} %\item Added option \opt{minitems} to \cmd{printshorthands}\see{use:bib:los} %\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 localization 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:los} %\item Added option \opt{minnames} to \cmd{printshorthands}\see{use:bib:los} %\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 localization key \texttt{citedas}\see{aut:lng:key} %\item Renamed localization key \texttt{editby} to \texttt{edited}\see{aut:lng:key} %\item Renamed localization key \texttt{transby} to \texttt{translated}\see{aut:lng:key} %\item Added localization key \texttt{annotated}\see{aut:lng:key} %\item Added localization key \texttt{commented}\see{aut:lng:key} %\item Added localization key \texttt{introduced}\see{aut:lng:key} %\item Added localization key \texttt{foreworded}\see{aut:lng:key} %\item Added localization key \texttt{afterworded}\see{aut:lng:key} %\item Added localization key \texttt{commentary}\see{aut:lng:key} %\item Added localization key \texttt{annotations}\see{aut:lng:key} %\item Added localization key \texttt{introduction}\see{aut:lng:key} %\item Added localization key \texttt{foreword}\see{aut:lng:key} %\item Added localization key \texttt{afterword}\see{aut:lng:key} %\item Added localization key \texttt{doneby}\see{aut:lng:key} %\item Added localization key \texttt{itemby}\see{aut:lng:key} %\item Added localization key \texttt{spanish}\see{aut:lng:key} %\item Added localization key \texttt{latin}\see{aut:lng:key} %\item Added localization key \texttt{greek}\see{aut:lng:key} %\item Modified localization key \texttt{fromenglish}\see{aut:lng:key} %\item Modified localization key \texttt{fromfrench}\see{aut:lng:key} %\item Modified localization key \texttt{fromgerman}\see{aut:lng:key} %\item Added localization key \texttt{fromspanish}\see{aut:lng:key} %\item Added localization key \texttt{fromlatin}\see{aut:lng:key} %\item Added localization 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}