summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex/biblatex.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex/biblatex.tex')
-rw-r--r--Master/texmf-dist/doc/latex/biblatex/biblatex.tex1914
1 files changed, 1034 insertions, 880 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex/biblatex.tex b/Master/texmf-dist/doc/latex/biblatex/biblatex.tex
index 6ed0af92e75..dce955d9c86 100644
--- a/Master/texmf-dist/doc/latex/biblatex/biblatex.tex
+++ b/Master/texmf-dist/doc/latex/biblatex/biblatex.tex
@@ -45,13 +45,12 @@
\MakeAutoQuote*{<}{>}
\MakeShortVerb{\|}
-\newcommand*{\biber}{Biber\xspace}
-\newcommand*{\biblatex}{BibLaTeX\xspace}
-\newcommand*{\biblatexml}{BibLaTeXML\xspace}
-\newcommand*{\ris}{RIS\xspace}
+\newcommand*{\biber}{\sty{biber}\xspace}
+\newcommand*{\biblatex}{\sty{biblatex}\xspace}
+\newcommand*{\biblatexml}{\sty{biblatexml}\xspace}
+\newcommand*{\ris}{\sty{RIS}\xspace}
\newcommand*{\biblatexhome}{http://sourceforge.net/projects/biblatex/}
-\newcommand*{\biblatexctan}{%
- http://www.ctan.org/tex-archive/macros/latex/contrib/biblatex/}
+\newcommand*{\biblatexctan}{http://ctan.org/pkg/biblatex/}
\titlepage{%
title={The \biblatex Package},
@@ -60,7 +59,7 @@
author={Philipp Lehman \\(with Philip Kime, Audrey Boruvka and Joseph Wright)},
email={},
revision={3.4},
- date={//2016}}
+ date={\today}}
\hypersetup{%
pdftitle={The \biblatex Package},
@@ -125,18 +124,15 @@
\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}}
\newrobustcmd*{\LF}{%
\textcolor{spot}{\margnotefont Label field}}
\newrobustcmd*{\LFMark}{%
\leavevmode\marginpar{\LF}}
+\newrobustcmd*{\CSdelim}{%
+ \textcolor{spot}{\margnotefont Context Sensitive}}
+\newrobustcmd*{\CSdelimMark}{%
+ \leavevmode\marginpar{\CSdelim}}
+
% following snippet is based on code by Michael Ummels (TeX Stack Exchange)
% <http://tex.stackexchange.com/a/13073/8305>
@@ -166,18 +162,18 @@ For a quick start guide, browse \secref{int:abt, bib:typ, bib:fld, bib:use, use:
\subsection[About]{About \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. A custom backend \biber by default is used which processes the \bibtex format data files and them performs all sorting, label generation (and a great deal more). Legacy \bibtex is also supported as a backend, albeit with a reduced feature set. Biblatex does not use the backend to format the bibliography information as with traditional \bibtex: instead of being implemented in \bibtex style files, the formatting of the bibliography is entirely controlled by TeX macros. Good working knowledge in \latex should be sufficient to design new bibliography and citation styles. 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 information such as abbreviations of various fields. Bibliographies may be subdivided into parts and\slash or segmented by topics. Just like the bibliography styles, all citation commands may be freely defined. With \biber as the backend, features such as customisable sorting, multiple bibliographies with different sorting, customisable labels, dynamic data modification are available. Please refer to \secref{int:pre:bibercompat} for information on \biber/\biblatex version compatibility. 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.
+This package provides advanced bibliographic facilities for use with \latex. The package is a complete reimplementation of the bibliographic facilities provided by \latex. The \biblatex\ package works with the \enquote{backend} (program) \biber, which is used to process \bibtex\ format data files and them performs all sorting, label generation (and a great deal more). Formatting of the bibliography is entirely controlled by \tex\ macros. Good working knowledge in \latex should be sufficient to design new bibliography and citation styles. This package also supports subdivided bibliographies, multiple bibliographies within one document, and separate lists of bibliographic information such as abbreviations of various fields. Bibliographies may be subdivided into parts and\slash or segmented by topics. Just like the bibliography styles, all citation commands may be freely defined. Features such as full Unicode support for bibliography data, customisable sorting, multiple bibliographies with different sorting, customisable labels and dynamic data modification are available. Please refer to \secref{int:pre:bibercompat} for information on \biber/\biblatex version compatibility. The package is completely localised and can interface with the \sty{babel} and \sty{polyglossia} packages. Please refer to \tabref{bib:fld:tab1} for a list of languages currently supported by this package.
\subsection{License}
-Copyright \textcopyright\ 2006--2012 Philipp Lehman, 2012--2013 Philip Kime, Audrey Boruvka, Joseph Wright. 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}
+Copyright \textcopyright\ 2006--2012 Philipp Lehman, 2012--2016 Philip Kime, Audrey Boruvka, Joseph Wright. Permission is granted to copy, distribute and\slash or modify this software under the terms of the \lppl, version 1.3.\fnurl{http://www.latex-project.org/lppl.txt}
\subsection{Feedback}
\label{int:feb}
Please use the \biblatex project page on GitHub to report bugs and submit feature requests.\fnurl{http://github.com/plk/biblatex} Before making a feature request, please ensure that you have thoroughly studied this manual. If you do not want to report a bug or request a feature but are simply in need of assistance, you might want to consider posting your question on the \texttt{comp.text.tex} newsgroup or \tex-\latex Stack Exchange.\fnurl{http://tex.stackexchange.com/questions/tagged/biblatex}
-\subsection{Acknowledgments}
+\subsection{Acknowledgements}
The language modules of this package are made possible thanks to the following contributors:
Augusto Ritter Stoffel, Mateus Araújo (Brazilian);
@@ -199,6 +195,7 @@ Oleg Domanov (Russian);
Tea Tušar and Bogdan Filipič (Slovene);
Ignacio Fernández Galván (Spanish);
Per Starbäck, Carl-Gustav Werner, Filip Åsblom (Swedish).
+Martin Vrábel, Dávid Lupták (Slovak);
\subsection{Prerequisites}
\label{int:pre}
@@ -216,19 +213,16 @@ The resources listed in this section are strictly required for \biblatex to func
The \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 \biblatex package checks if it is running under \etex. Simply try compiling your documents as you usually do, the chances are that it just works. If you get an error message, try compiling the document with \bin{elatex} instead of \bin{latex} or \bin{pdfelatex} instead of \bin{pdflatex}, respectively.
\item[\biber]
-\biber is the default backend of \biblatex. You only need one backend, either \bibtex or \biber. \biber comes with TeXLive and is also available from SourceForge.\fnurl{http://biblatex-biber.sourceforge.net/}. There are some slight differences in name parsing of <von> parts with \biber as compared with \bibtex which you probably won't normally notice. \biber uses the \texttt{btparse} C library for \bibtex format file parsing which aimed to be compatible with \bibtex's parsing rules but also aimed at correcting some of the common problems. For details, see the manual page for the Perl \texttt{Text::BibTeX} module\fnurl{http://search.cpan.org/~ambs/Text-BibTeX}.
-
-\item[\bibtex]
-The \biblatex package can use legacy \bibtex as a data backend. While a legacy \bibtex binary is sufficient to run \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/}
+\biber is the backend of \biblatex used to transfer data from source files to the \latex code. \biber comes with TeX Live and is also available from SourceForge.\fnurl{http://biblatex-biber.sourceforge.net/}. \biber uses the \texttt{btparse} C library for \bibtex format file parsing which aimed to be compatible with \bibtex's parsing rules but also aimed at correcting some of the common problems. For details, see the manual page for the Perl \texttt{Text::BibTeX} module\fnurl{http://search.cpan.org/~ambs/Text-BibTeX}.
\item[etoolbox]
-This \latex package, which is loaded automatically, provides generic programming facilities required by \biblatex. It is available from \acr{CTAN}.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/etoolbox/}
+This \latex package, which is loaded automatically, provides generic programming facilities required by \biblatex. It is available from \acr{CTAN}.\fnurl{http://ctan.org/pkg/etoolbox}
\item[kvoptions]
-This \latex package, which is also loaded automatically, is used for internal option handling. It is available with the \sty{oberdiek} package bundle from \acr{CTAN}.\fnurl{http://www.ctan.org/pkg/kvoptions}
+This \latex package, which is also loaded automatically, is used for internal option handling. It is available with the \sty{oberdiek} package bundle from \acr{CTAN}.\fnurl{http://ctan.org/pkg/kvoptions}
\item[logreq]
-This \latex package, which is also loaded automatically, provides a frontend for writing machine-readable messages to an auxiliary log file. It is available from \acr{CTAN}.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/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://ctan.org/pkg/logreq/}
\end{marglist}
@@ -242,13 +236,13 @@ The packages listed in this section are not required for \biblatex to function,
\begin{marglist}
\item[babel/polyglossia]
-The \sty{babel} and \sty{polyglossia} packages provides the core architecture for multilingual typesetting. If you are writing in a language other than American English, using one of these packages is strongly recommended. If loaded, \biblatex package will detect \sty{babel} or \sty{polyglossia} automatically.
+The \sty{babel} and \sty{polyglossia} packages provides the core architecture for multilingual typesetting. If you are writing in a language other than American English, using one of these packages is strongly recommended. You should load \sty{babel} or \sty{polyglossia} before \biblatex and then \biblatex will detect \sty{babel} or \sty{polyglossia} automatically.
\item[csquotes]
-If this package is available, \biblatex will use its language sensitive quotation facilities to enclose certain titles in quotation marks. If not, \biblatex uses quotes suitable for American English as a fallback. When writing in any other language, loading \sty{csquotes} is strongly recommended.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/csquotes/}
+If this package is available, \biblatex will use its language sensitive quotation facilities to enclose certain titles in quotation marks. If not, \biblatex uses quotes suitable for American English as a fallback. When writing in a language other than American English, loading \sty{csquotes} is strongly recommended.\fnurl{http://ctan.org/pkg/csquotes/}
\item[xpatch]
-The \sty{xpatch} package extends the patching commands of \sty{etoolbox} to \biblatex bibliography macros, drivers and formatting directives.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/xpatch/}
+The \sty{xpatch} package extends the patching commands of \sty{etoolbox} to \biblatex bibliography macros, drivers and formatting directives.\fnurl{http://ctan.org/pkg/xpatch/}
\end{marglist}
@@ -280,16 +274,6 @@ The packages listed in this section are not compatible with \biblatex. Since it
\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 \biblatex. Use the \bibfield{langid} field and the package option \opt{autolang} for similar functionality. Note that \biblatex automatically adjusts to the main document language if \sty{babel} or \sty{polyglossia} is loaded. You only need the above mentioned features if you want to switch languages on a per"=entry basis within the bibliography. See \secref{bib:fld:spc, use:opt:pre:gen} for details. Also see \secref{use:lng}.
@@ -344,7 +328,7 @@ The \sty{ucs} package provides support for \utf encoded input. Either use \sty{i
\label{int:pre:bibercompat}
\biber\ versions are closely coupled with \biblatex\ versions. You
-need to have the right combination of the two. \biber\ will warn you
+need to have the right combination of the two. \biber\ will throw a fatal error
during processing if it encounters information which comes from a
\biblatex\ version which is incompatible. \tabref{tab:int:pre:bibercompat} shows a
compatibility matrix for the recent versions.
@@ -356,6 +340,9 @@ compatibility matrix for the recent versions.
\sffamily\bfseries\spotcolor Biber version
& \sffamily\bfseries\spotcolor \biblatex\ version\\
\midrule
+2.5 & 3.4\\
+2.4 & 3.3\\
+2.3 & 3.2\\
2.2 & 3.1\\
2.1 & 3.0\\
2.0 & 3.0\\
@@ -388,9 +375,7 @@ compatibility matrix for the recent versions.
\section{Database Guide}
\label{bib}
-It is important to distinguish between \bibtex the program and \bibtex the file format. \biblatex can be used with or without \bibtex the program since its default backend \biber uses fully supports the \bibtex file format (\file{bib}) and users should be able to move to \biblatex will little or no changes to their \bibtex data files when using \biber as a backend. If using \bibtex as the data backend, note that you cannot use arbitrary \file{bst} files because the package depends on a special \bibtex interface. When using \bibtex as a backend, \biblatex uses its own special \file{bst} file only. The entry guide below is backend agnostic unless otherwise stated.
-
-This section describes the default data model defined in the \file{blx-dm.def} file which is part of \path{biblatex}. The data model is defined using the macros documented in \secref{aut:ctm:dm}. It is possible to redefine the data model which both \biblatex and \biber use so that datasources can contain new entrytypes and fields (which of course will need style support). The data model specification also allows for constraints to be defined so that data sources can be validated against the data model (using \biber's \path{--validate_datamodel} option). Users who want to customise the data model need to look at the \file{blx-dm.def} file and to read \secref{aut:ctm:dm}.
+This section describes the default data model defined in the \file{blx-dm.def} file which is part of \path{biblatex}. The data model is defined using the macros documented in \secref{aut:ctm:dm}. It is possible to redefine the data model which both \biblatex and \biber use so that datasources can contain new entrytypes and fields (which of course will need style support). The data model specification also allows for constraints to be defined so that data sources can be validated against the data model (using \biber's \path{--validate-datamodel} option). Users who want to customise the data model need to look at the \file{blx-dm.def} file and to read \secref{aut:ctm:dm}.
\subsection{Entry Types}
\label{bib:typ}
@@ -571,7 +556,7 @@ A work with an author and a title which has not been formally published, such as
\typeitem{xdata}
-\BiberOnlyMark This entry type is special. \bibtype{xdata} entries hold data which may be inherited by other entries using the \bibfield{xdata} field. Entries of this type only serve as data containers; they may not be cited or added to the bibliography. See \secref{use:use:xdat} for details.
+This entry type is special. \bibtype{xdata} entries hold data which may be inherited by other entries using the \bibfield{xdata} field. Entries of this type only serve as data containers; they may not be cited or added to the bibliography. See \secref{use:use:xdat} for details.
\typeitem{custom[a--f]}
@@ -586,15 +571,15 @@ The entry types listed in this section are provided for backwards compatibility
\begin{typelist}
-\typeitem{conference} A \bibtex legacy alias for \bibtype{inproceedings}.
+\typeitem{conference} A legacy alias for \bibtype{inproceedings}.
\typeitem{electronic} An alias for \bibtype{online}.
-\typeitem{mastersthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localized term <Master's thesis>. You may still use the \bibfield{type} field to override that.
+\typeitem{mastersthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localised term <Master's thesis>. You may still use the \bibfield{type} field to override that.
-\typeitem{phdthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localized term <PhD thesis>. You may still use the \bibfield{type} field to override that.
+\typeitem{phdthesis} Similar to \bibtype{thesis} except that the \bibfield{type} field is optional and defaults to the localised term <PhD thesis>. You may still use the \bibfield{type} field to override that.
-\typeitem{techreport} Similar to \bibtype{report} except that the \bibfield{type} field is optional and defaults to the localized term <technical report>. You may still use the \bibfield{type} field to override that.
+\typeitem{techreport} Similar to \bibtype{report} except that the \bibfield{type} field is optional and defaults to the localised term <technical report>. You may still use the \bibfield{type} field to override that.
\typeitem{www}
@@ -689,7 +674,7 @@ In datasources such as a \file{bib} file, all bibliographic data is specified in
\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 given name, the name prefix (von, van, of, da, de, della, \dots), the family 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}.
-\BiberOnlyMark With \biber, name list fields automatically have an \cmd{ifuse*} test created as per the name lists in the default data model (see \secref{aut:aux:tst}). They are also automatically have a \opt{ifuse*} option created which controls labelling and sorting behaviour with the name (see \secref{use:opt:bib:hyb}). \biber supports a customisable list of name parts but current this is defined to be the same set of parts as supported by \bibtex:
+Name list fields automatically have an \cmd{ifuse*} test created as per the name lists in the default data model (see \secref{aut:aux:tst}). They are also automatically have a \opt{ifuse*} option created which controls labelling and sorting behaviour with the name (see \secref{use:opt:bib:hyb}). \biber supports a customisable list of name parts but current this is defined to be the same set of parts as supported by traditional \bibtex:
\begin{itemize}
\item Family name (also known as <last> part)
@@ -706,7 +691,7 @@ The supported list of name parts is defined as a constant list in the default da
\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}.
+\item[Key lists] are a variant of literal lists which may hold printable data or localisation keys. For each item in the list, a test is performed to determine whether it is a known localisation key (the localisation keys defined by default are listed in \secref{aut:lng:key}). If so, the localised string is printed. If not, the item is printed as is. A typical example of a key list is \bibfield{language}.
\end{description}
\end{description}
@@ -719,23 +704,23 @@ The supported list of name parts is defined as a constant list in the default da
\item[Literal fields] are printed as is. Typical examples of literal fields are \bibfield{title} and \bibfield{note}.
-\item[Range fields] consist of one or more ranges where all dashes are normalized and replaced by the command \cmd{bibrangedash}. A range is something optionally followed by one or more dashes optionally followed by some non-dash (e.g. \texttt{5--7}). Any number of consecutive dashes will only yield a single range dash. A typical example of a range field is the \bibfield{pages} field. See also the \BiberOnlyMark\cmd{bibrangessep} command which can be used to customise the separator between multiple ranges. With \biber, range fields will be skipped and will generate a warning if they do not consist of one or more ranges. You can normalise messy range fields before they are parsed using \cmd{DeclareSourcemap} (see \secref{aut:ctm:map}).
+\item[Range fields] consist of one or more ranges where all dashes are normalized and replaced by the command \cmd{bibrangedash}. A range is something optionally followed by one or more dashes optionally followed by some non-dash (e.g. \texttt{5--7}). Any number of consecutive dashes will only yield a single range dash. A typical example of a range field is the \bibfield{pages} field. See also the \cmd{bibrangessep} command which can be used to customise the separator between multiple ranges. Range fields will be skipped and will generate a warning if they do not consist of one or more ranges. You can normalise messy range fields before they are parsed using \cmd{DeclareSourcemap} (see \secref{aut:ctm:map}).
\item[Integer fields] hold unformatted integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{extrayear} field.
-\item[Datepart fields] hold unformatted integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{month} field.
+\item[Datepart fields] hold unformatted integers which may be converted to ordinals or strings as they are printed. A typical example is the \bibfield{month} field. For every field X of datatype \bibfield{date} in the datamodel, datepart fields are automatically created with the following names: \bibfield{Xyear}, \bibfield{Xendyear}, \bibfield{Xmonth}, \bibfield{Xendmonth}, \bibfield{Xday}, \bibfield{Xendday}.
-\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[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 datepart type components. The \bibfield{datepart} components (see above) are automatically defined and recognised when a field of datatype \bibfield{date} is defined in the datamodel. 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{file} and \bibfield{doi}.
\item[URI fields] are processed in verbatim mode and may contain special characters. They are also URL-escaped if they don't look like they already are. The typical example of a uri field is \bibfield{url}.
-\item[Separated value fields] A separated list of literal values. Examples are the \bibfield{keywords} and \bibfield{options} fields. The separator is always a comma when using \bibtex as the backend but can be configured to be any Perl regular expression when using \biber via the \opt{xsvsep} option which defaults to the usual \bibtex comma surrounded by optional whitespace.
+\item[Separated value fields] A separated list of literal values. Examples are the \bibfield{keywords} and \bibfield{options} fields. The separator can be configured to be any Perl regular expression via the \opt{xsvsep} option which defaults to the usual \bibtex comma surrounded by optional whitespace.
\item[Pattern fields] A literal field which must match a particular pattern. An example is the \bibfield{gender} field from \secref{bib:fld:spc}.
-\item[Key fields] May hold printable data or 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[Key fields] May hold printable data or localisation keys. A test is performed to determine whether the value of the field is a known localisation key (the localisation keys defined by default are listed in \secref{aut:lng:key}). If so, the localised string is printed. If not, the value is printed as is. A typical example is the \bibfield{type} field.
\item[Code fields] Holds \tex code.
@@ -747,7 +732,7 @@ The supported list of name parts is defined as a constant list in the default da
The fields listed in this section are the regular ones holding printable data in the default data model. The name on the left is the default data model name of the field as used by \biblatex and its backend. The \biblatex data type is given to the right of the name. See \secref{bib:fld:typ} for explanation of the various data types.
-\BiberOnlyMark Some fields are marked as <Label fields> which means that they are often used as abbreviation labels when printing bibliography lists in the sense of section \secref{use:bib:biblist}. \biblatex automatically creates supporting macros for such fields. See \secref{use:bib:biblist}.
+Some fields are marked as <Label fields> which means that they are often used as abbreviation labels when printing bibliography lists in the sense of section \secref{use:bib:biblist}. \biblatex automatically creates supporting macros for such fields. See \secref{use:bib:biblist}.
\begin{fieldlist}
@@ -961,7 +946,7 @@ A designation to be used by the citation style as a substitute for the regular l
\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{langid} in \secref{bib:fld:spc}.
+The language(s) of the work. Languages may be specified literally or as localisation keys. If localisation keys are used, the prefix \texttt{lang} is omissible. See also \bibfield{origlanguage} and compare \bibfield{langid} in \secref{bib:fld:spc}.
\fielditem{library}{literal}
@@ -1049,7 +1034,7 @@ The publication state of the work, \eg\ <in press>. See \secref{aut:lng:key:pst}
\fielditem{reprinttitle}{literal}
-\BibTeXOnlyMark The title of a reprint of the work. Not used by the standard styles.
+The title of a reprint of the work. Not used by the standard styles.
\fielditem{series}{literal}
@@ -1105,7 +1090,7 @@ The type of a \bibfield{manual}, \bibfield{patent}, \bibfield{report}, or \bibfi
\fielditem{url}{uri}
-The \acr{URL} of an online publication. If it is not URL-escaped (no <\%> chars), with \biber, it will be URI-escaped according to RFC 3987, that is, even Unicode chars will be correctly escaped.
+The \acr{URL} of an online publication. If it is not URL-escaped (no <\%> chars) it will be URI-escaped according to RFC 3987, that is, even Unicode chars will be correctly escaped.
\fielditem{urldate}{date}
@@ -1187,7 +1172,8 @@ Polish & Poland & \opt{polish} \\
Portuguese & Brazil & \opt{brazil} \\
& Portugal & \opt{portuguese}, \opt{portuges} \\
Russian & Russia & \opt{russian} \\
-Slovene & Slovenian & \opt{slovene} \\
+Slovak & Slovakia & \opt{slovak} \\
+Slovene & Slovenia & \opt{slovene} \\
Spanish & Spain & \opt{spanish} \\
Swedish & Sweden & \opt{swedish} \\
\bottomrule
@@ -1198,7 +1184,7 @@ Swedish & Sweden & \opt{swedish} \\
\fielditem{langid}{identifier}
-The language id of the bibliography entry. The alias \bibfield{hyphenation} is provided for backwards compatibility. The identifier must be a language name known to the \sty{babel}/\sty{polyglossia} packages. This information may be used to switch hyphenation patterns and 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 \sty{babel} version. The \biblatex package always treats it as an alias for \opt{american}. It is preferable to use the language identifiers \opt{american} and \opt{british} (\sty{babel}) or a language specific option to specify a language variant (\sty{polyglossia}, using the \bibfield{langidopts} field) to avoid any possible confusion. Compare \bibfield{language} in \secref{bib:fld:dat}.
+The language id of the bibliography entry. The alias \bibfield{hyphenation} is provided for backwards compatibility. The identifier must be a language name known to the \sty{babel}/\sty{polyglossia} packages. This information may be used to switch hyphenation patterns and localise strings in the bibliography. Note that the language names are case sensitive. The languages currently supported by this package are given in \tabref{bib:fld:tab1}. Note that \sty{babel} treats the identifier \opt{english} as an alias for \opt{british} or \opt{american}, depending on the \sty{babel} version. The \biblatex package always treats it as an alias for \opt{american}. It is preferable to use the language identifiers \opt{american} and \opt{british} (\sty{babel}) or a language specific option to specify a language variant (\sty{polyglossia}, using the \bibfield{langidopts} field) to avoid any possible confusion. Compare \bibfield{language} in \secref{bib:fld:dat}.
\fielditem{langidopts}{literal}
@@ -1218,7 +1204,7 @@ would wrap the bibliography entry in:
\end{ltxexample}
%
-\fielditem{ids}{separated list of entrykeys\BiberOnlyMark}
+\fielditem{ids}{separated list of entrykeys}
Citation key aliases for the main citation key. An entry may be cited by any of its aliases and \biblatex will treat the citation as if it had used the primary citation key. This is to aid users who change their citation keys but have legacy documents which use older keys for the same entry. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
@@ -1246,21 +1232,21 @@ A separated list of entry options in \keyval notation. This field is used to set
A special field used to modify the sorting order of the bibliography. This field is the first item the sorting routine considers when sorting the bibliography, hence it may be used to arrange the entries in groups. This may be useful when creating subdivided bibliographies with the bibliography filters. Please refer to \secref{use:srt} for further details. Also see \secref{aut:ctm:srt}. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
-\fielditem{related}{separated values\BiberOnlyMark}
+\fielditem{related}{separated values}
Citation keys of other entries which have a relationship to this entry. The relationship is specified by the \bibfield{relatedtype} field. Please refer to \secref{use:rel} for further details.
-\fielditem{relatedoptions}{separated values\BiberOnlyMark}
+\fielditem{relatedoptions}{separated values}
Per"=type options to set for a related entry. Note that this does not set the options on the related entry itself, only the \opt{dataonly} clone which is used as a datasource for the parent entry.
-\fielditem{relatedtype}{identifier\BiberOnlyMark}
+\fielditem{relatedtype}{identifier}
-An identifier which specified the type of relationship for the keys listed in the \bibfield{related} field. The identifier is a localized bibliography string printed
+An identifier which specified the type of relationship for the keys listed in the \bibfield{related} field. The identifier is a localised bibliography string printed
before the data from the related entry list. It is also used to identify type-specific
formatting directives and bibliography macros for the related entries. Please refer to \secref{use:rel} for further details.
-\fielditem{relatedstring}{literal\BiberOnlyMark}
+\fielditem{relatedstring}{literal}
A field used to override the bibliography string specified by \bibfield{relatedtype}. Please refer to \secref{use:rel} for further details.
@@ -1272,7 +1258,7 @@ A field used to modify the sorting order of the bibliography. Think of this fiel
A name or a list of names used to modify the sorting order of the bibliography. If present, this list is used instead of \bibfield{author} or \bibfield{editor} when sorting the bibliography. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
-\fielditem{sortshorthand}{literal\BiberOnlyMark}
+\fielditem{sortshorthand}{literal}
Similar to \bibfield{sortkey} but used in the list of shorthands. If present, \biblatex uses this field instead of \bibfield{shorthand} when sorting the list of shorthands. This is useful if the \bibfield{shorthand} field holds shorthands with formatting commands such as \cmd{emph} or \cmd{textbf}. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
@@ -1284,13 +1270,13 @@ A field used to modify the sorting order of the bibliography. If present, this f
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. Please refer to \secref{use:srt} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
-\fielditem{xdata}{separated list of entrykeys\BiberOnlyMark}
+\fielditem{xdata}{separated list of entrykeys}
This field inherits data from one or more \bibtype{xdata} entries. Conceptually, the \bibfield{xdata} field is related to \bibfield{crossref} and \bibfield{xref}: \bibfield{crossref} establishes a logical parent/child relation and inherits data; \bibfield{xref} establishes as logical parent/child relation without inheriting data; \bibfield{xdata} inherits data without establishing a relation. The value of the \bibfield{xdata} may be a single entry key or a separated list of keys. See \secref{use:use:xdat} for further details. This field is consumed by the backend processing and does not appear in the \path{.bbl}.
\fielditem{xref}{entry key}
-This field is an alternative cross"=referencing mechanism. It differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent entry specified in the \bibfield{xref} field. If the number of child entries referencing a specific parent entry hits a certain threshold, the parent entry is automatically added to the bibliography even if it has not been cited explicitly. The threshold is settable with the \opt{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 \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}.
+This field is an alternative cross"=referencing mechanism. It differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent entry specified in the \bibfield{xref} field. If the number of child entries referencing a specific parent entry hits a certain threshold, the parent entry is automatically added to the bibliography even if it has not been cited explicitly. The threshold is settable with the \opt{minxrefs} package option from \secref{use:opt:pre:gen}. Style authors should note that whether or not the \bibfield{xref} fields of the child entries are defined on the \biblatex level depends on the availability of the parent entry. If the parent entry is available, the \bibfield{xref} fields of the child entries will be defined. If not, their \bibfield{xref} fields will be undefined. Whether the parent entry is added to the bibliography implicitly because of the threshold or explicitly because it has been cited does not matter. See also the \bibfield{crossref} field in this section as well as \secref{bib:cav:ref}.
\end{fieldlist}
@@ -1566,7 +1552,7 @@ Note that only the \bibfield{editor} is considered in citations and when sorting
...
\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.
+You may add more roles by initializing and defining a new localisation key whose name corresponds to the identifier in the \bibfield{editor...type} field. See \secref{use:lng,aut:lng:cmd} for details.
\subsubsection{Publication and Journal Series}
\label{bib:use:ser}
@@ -1582,7 +1568,7 @@ The \bibfield{series} field is used by traditional \bibtex styles both for the m
...
\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:
+The \bibtype{article} entry type makes use of the \bibfield{series} field as well, but handles it in a special way. First, a test is performed to determine whether the value of the field is an integer. If so, it will be printed as an ordinal. If not, another test is performed to determine whether it is a localisation key. If so, the localised string is printed. If not, the value is printed as is. Consider the following example of a journal published in numbered series:
\begin{lstlisting}[style=bibtex]{}
@Article{...,
@@ -1594,7 +1580,7 @@ The \bibtype{article} entry type makes use of the \bibfield{series} field as wel
...
\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}:
+This entry will be printed as «\emph{Journal Name}. 3rd ser. 15.7 (1995)». Some journals use designations such as «old series» and «new series» instead of a number. Such designations may be given in the \bibfield{series} field as well, either as a literal string or as a localisation key. Consider the following example which makes use of the localisation key \texttt{newseries}:
\begin{lstlisting}[style=bibtex]{}
@Article{...,
@@ -1605,7 +1591,7 @@ This entry will be printed as «\emph{Journal Name}. 3rd ser. 15.7 (1995)». Som
...
\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.
+This entry will be printed as «\emph{Journal Name}. New ser. 9 (1998)». See \secref{aut:lng:key} for a list of localisation keys defined by default.
\subsubsection{Date Specifications}
\label{bib:use:dat}
@@ -1658,7 +1644,7 @@ When specifying a page or page range, either in the \bibfield{pages} field of an
%
The \bibfield{bookpagination} field affects the formatting of the \bibfield{pages} and \bibfield{pagetotal} fields in the list of references. Since \texttt{page} is the default, this field is omissible in the above example. In this case, the page range will be formatted as <pp.~53--65>. Suppose that, when quoting from this work, it is customary to use verse numbers rather than page numbers in citations. This is reflected by the \bibfield{pagination} field, which affects the formatting of the \prm{postnote} argument to any citation command. With a citation like |\cite[17]{key}|, the postnote will be formatted as <v.~17>. Setting the \bibfield{pagination} field to \texttt{section} would yield <\S~17>. See \secref{use:cav:pag} for further usage instructions.
-The \bibfield{pagination} and \bibfield{bookpagination} fields are key fields. This package will try to use their value as a 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.
+The \bibfield{pagination} and \bibfield{bookpagination} fields are key fields. This package will try to use their value as a localisation key, provided that the key is defined. Always use the singular form of the key name in \file{bib} files, the plural is formed automatically. The keys \texttt{page}, \texttt{column}, \texttt{line}, \texttt{verse}, \texttt{section}, and \texttt{paragraph} are predefined, with \texttt{page} being the default. The string <\texttt{none}> has a special meaning when used in a \bibfield{pagination} or \bibfield{bookpagination} field. It suppresses the prefix for the respective entry. If there are no predefined localisation keys for the pagination scheme required by a certain entry, you can simply add them. See the commands \cmd{NewBibliographyString} and \cmd{DefineBibliographyStrings} in \secref{use:lng}. You need to define two localisation strings for each additional pagination scheme: the singular form (whose localisation key corresponds to the value of the \bibfield{pagination} field) and the plural form (whose localisation key must be the singular plus the letter <\texttt{s}>). See the predefined keys in \secref{aut:lng:key} for examples.
\subsection{Hints and Caveats}
\label{bib:cav}
@@ -1668,37 +1654,7 @@ This section provides some additional hints concerning the data interface of thi
\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, the \bibtex program 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},
- <<bookauthor>> = {Author},
- <<title>> = {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 no longer required. Entries are specified in a natural way:
+\biber features a highly customizable cross-referencing mechanism with flexible data inheritance rules. Duplicating certain fields in the parent entry or adding empty fields to the child entry is no longer required. Entries are specified in a natural way:
\begin{lstlisting}[style=bibtex]{}
@Book{book,
@@ -1735,137 +1691,31 @@ See \apxref{apx:ref} for a list of mapping rules set up by default. Note that al
\paragraph{The \bibfield{xref} field}
\label{bib:cav:ref:ref}
-In addition to the \bibfield{crossref} field, \biblatex supports a simplified cross"=referencing mechanism based on the \bibfield{xref} field. This is useful if you want to establish a parent\slash child relation between two associated entries but prefer to keep them independent as far as the data is concerned. The \bibfield{xref} field differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent. If the parent is referenced by a certain number of child entries, \biblatex will automatically add it to the bibliography. The threshold is controlled by the \opt{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\lnstyle
-\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.
+In addition to the \bibfield{crossref} field, \biblatex supports a simplified cross"=referencing mechanism based on the \bibfield{xref} field. This is useful if you want to establish a parent\slash child relation between two associated entries but prefer to keep them independent as far as the data is concerned. The \bibfield{xref} field differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent. If the parent is referenced by a certain number of child entries, \biblatex will automatically add it to the bibliography. The threshold is controlled by the \opt{minxrefs} package option from \secref{use:opt:pre:gen}.u See also \secref{bib:fld:spc}.
\subsubsection{Sorting and Encoding Issues}
\label{bib:cav:enc}
-\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:
+\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 also supported.\fnurl{http://cldr.unicode.org/}
-\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 \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 also supported.\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:
+Supporting Unicode implies much more than handling \utf input. Unicode is a complex standard covering more than its most well-known parts, the Unicode character encoding and transport encodings such as \utf. It also standardizes aspects such as string collation, which is required for language-sensitive sorting. For example, by using the Unicode Collation Algorithm, \biber can handle the character <ß> without any manual intervention. All you need to do to get localised sorting is specify the locale:
\begin{ltxexample}
-\usepackage[backend=biber,sortlocale=de]{biblatex}
+\usepackage[sortlocale=de]{biblatex}
\end{ltxexample}
%
-or if you are using german as the main document language via Babel or Polyglossia:
+or if you are using German as the main document language via \sty{babel} or \sty{polyglossia}:
\begin{ltxexample}
-\usepackage[backend=biber,sortlocale=auto]{biblatex}
+\usepackage[sortlocale=auto]{biblatex}
\end{ltxexample}
%
-This will make \biblatex pass the Babel/Polyglossia main document language
+This will make \biblatex pass the \sty{babel}/\sty{polyglossia} main document language
as the locale which \biber will map into a suitable default locale. \biber
will not try to get locale information from its environment as this makes
document processing dependent on something not in the document which is
against \tex's spirit of reproducibility. This also makes sense since
-Babel/Polyglossia are in fact the relevant environment for a document. Note
+\sty{babel}/\sty{polyglossia} are in fact the relevant environment for a document. Note
that this will also work with 8-bit encodings such as Latin\,9, \ie you can
take advantage of Unicode-based sorting even though you are not using \utf
input. See \secref{bib:cav:enc:enc} on how to specify input and data
@@ -1873,25 +1723,25 @@ encodings properly.
\paragraph{Specifying Encodings}
\label{bib:cav:enc:enc}
-When using a non-Ascii encoding in the \file{bib} file, it is important to understand what \biblatex can do for you and what may require manual intervention. The package takes care of the \latex side, \ie it ensures that the data imported from the \file{bbl} file is interpreted correctly, provided that the \opt{bibencoding} package option 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 \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:
+When using a non-Ascii encoding in the \file{bib} file, it is important to understand what \biblatex can do for you and what may require manual intervention. The package takes care of the \latex side, \ie it ensures that the data imported from the \file{bbl} file is interpreted correctly, provided that the \opt{bibencoding} package option is set properly. All of this is handled automatically and no further steps, apart from setting the \opt{bibencoding} option in certain cases, are required. Here are a few typical usage scenarios along with the relevant lines from the document preamble:
\begin{itemize}
\setlength{\itemsep}{0pt}
-\item Ascii notation in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex (this will work with \bibtex, \file{bibtex8}, and \biber):
+\item Ascii notation in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex:
\begin{ltxexample}
\usepackage{biblatex}
\end{ltxexample}
-\item Latin\,1 encoding (\acr{ISO}-8859-1) in the \file{tex} file, Ascii notation in the \file{bib} file with \pdftex or traditional \tex (\bibtex, \file{bibtex8}, \biber):
+\item Latin\,1 encoding (\acr{ISO}-8859-1) in the \file{tex} file, Ascii notation in the \file{bib} file with \pdftex or traditional \tex :
\begin{ltxexample}
\usepackage[latin1]{inputenc}
\usepackage[bibencoding=ascii]{biblatex}
\end{ltxexample}
-\item Latin\,9 encoding (\acr{ISO}-8859-15) in both the \file{tex} and the \file{bib} file with \pdftex or traditional \tex (\file{bibtex8}, \biber):
+\item Latin\,9 encoding (\acr{ISO}-8859-15) in both the \file{tex} and the \file{bib} file with \pdftex or traditional:
\begin{ltxexample}
\usepackage[latin9]{inputenc}
@@ -1905,7 +1755,7 @@ Since \kvopt{bibencoding}{auto} is the default setting, the option is omissible.
\usepackage{biblatex}
\end{ltxexample}
-\item \utf encoding in the \file{tex} file, Latin\,1 (\acr{ISO}-8859-1) in the \file{bib} file with \pdftex or traditional \tex (\file{bibtex8}, \biber):
+\item \utf encoding in the \file{tex} file, Latin\,1 (\acr{ISO}-8859-1) in the \file{bib} file with \pdftex or traditional \tex:
\begin{ltxexample}
\usepackage[utf8]{inputenc}
@@ -1918,19 +1768,6 @@ The same scenario with \xetex or \luatex in native \utf mode:
\usepackage[bibencoding=latin1]{biblatex}
\end{ltxexample}
-\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{ltxexample}
-\usepackage[utf8]{inputenc}
-\usepackage[bibencoding=ascii]{biblatex}
-\end{ltxexample}
-
-The same scenario with \xetex or \luatex in native \utf mode:
-
-\begin{ltxexample}
-\usepackage[bibencoding=ascii]{biblatex}
-\end{ltxexample}
-
\end{itemize}
\biber can handle Ascii notation, 8-bit encodings such as Latin\,1, and \utf. It is also capable of reencoding the \file{bib} data on the fly (replacing the limited macro-level reencoding feature of \biblatex). This will happen automatically if required, provided that you specify the encoding of the \file{bib} files properly. In addition to the scenarios discussed above, \biber can also handle the following cases:
@@ -1977,16 +1814,17 @@ Some workarounds may be required when using traditional \tex or \pdftex with \ut
\usepackage[safeinputenc]{biblatex}
\end{ltxexample}
%
-If this option is enabled, \biblatex will ignore \sty{inputenc}'s \opt{utf8} option and use Ascii. \biber will then try to convert the \file{bib} data to Ascii notation. For example, it will convert \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.
+If this option is enabled, \biblatex will ignore \sty{inputenc}'s \opt{utf8} option and use Ascii. \biber will then try to convert the \file{bib} data to Ascii notation. For example, it will convert \k{S} to |\k{S}|. This option is similar to setting \kvopt{texencoding}{ascii} but will only take effect in this specific scenario (\sty{inputenc}\slash \sty{inputenx} with \utf). This workaround takes advantage of the fact that both Unicode and the \utf transport encoding are backwards compatible with Ascii.
\end{itemize}
-This solution may be acceptable as a workaround if the data in the \file{bib} file is mostly Ascii anyway, with only a few strings, such as some authors' names, causing problems. However, keep in mind that it will not magically make traditional \tex or \pdftex support Unicode. It may help if the occasional odd character is not supported by \sty{inputenc}, but may still be processed by \tex when using an accent command (\eg |\d{S}| instead of \texttt{\d{S}}). If you need full Unicode support, however, switch to \xetex or \luatex.
+This solution may be acceptable as a workaround if the data in the \file{bib} file is mostly Ascii anyway, with only a few strings, such as some authors' names, causing problems. However, keep in mind that it will not magically make traditional \tex or \pdftex support Unicode. It may help if the occasional odd character is not supported by \sty{inputenc}, but may still be processed by \tex when using an accent command (\eg |\d{S}| instead of \d{S}). If you need full Unicode support, however, switch to \xetex or \luatex.
Typical errors when \sty{inputenc} cannot handle a certain UTF-8 character are:
\begin{verbatim}
-Package inputenc Error: Unicode char \u8: not set up for use with LaTeX
+! Package inputenc Error: Unicode char <char> (U+<codepoint>)
+(inputenc) not set up for use with LaTeX.
\end{verbatim}
%
but also less obvious things like:
@@ -1995,13 +1833,6 @@ but also less obvious things like:
! Argument of \UTFviii@three@octets has an extra }.
\end{verbatim}
-\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 \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}
@@ -2019,7 +1850,7 @@ The following options must be used as \biblatex is loaded, \ie in the optional a
\begin{optionlist}
-\optitem[biber]{backend}{\opt{bibtex}, \opt{bibtex8}, \opt{bibtexu}, \opt{biber}}
+\optitem[biber]{backend}{\opt{bibtex}, \opt{bibtex8}, \opt{biber}}
Specifies the database backend. The following backends are supported:
@@ -2029,25 +1860,24 @@ Specifies the database backend. The following backends are supported:
\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[bibtex8] \bin{bibtex8}, the 8-bit implementation of \bibtex, supports Ascii and 8-bit encodings such as Latin~1.
-\item[bibtexu] \bin{bibtexu} is a Unicode-enabled implementation of \bibtex which supports \utf. Note that \bin{bibtexu} is not actively supported by \biblatex and has not been tested as backend in any way. \biber is the recommended backend.
\end{valuelist}
-See \secref{bib:cav:enc} for further instructions concerning the encoding of \file{bib} files. This option is only available at load-time as internally, the code chooses completely different paths depending on the backend. This means that you can't set the backend with, for example, \cmd{ExecuteBibliographyOptions} in the preamble.
+See \secref{use:bibtex} for details of using \bibtex as a backend.
\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.
+Loads the bibliography style \prm{file}\path{.bbx} and the citation style \prm{file}\path{.cbx}. See \secref{use:xbx} for an overview of the standard styles.
\valitem[numeric]{bibstyle}{file}
-Loads the bibliography style \path{file.bbx}. See \secref{use:xbx:bbx} for an overview of the standard bibliography styles.
+Loads the bibliography style \prm{file}\path{.bbx}. See \secref{use:xbx:bbx} for an overview of the standard bibliography styles.
\valitem[numeric]{citestyle}{file}
-Loads the citation style \path{file.cbx}. See \secref{use:xbx:cbx} for an overview of the standard citation styles.
+Loads the citation style \prm{file}\path{.cbx}. See \secref{use:xbx:cbx} for an overview of the standard citation styles.
\boolitem[false]{natbib}
@@ -2083,35 +1913,24 @@ The sorting order of the bibliography. Unless stated otherwise, the entries are
\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})
+\item[\prm{name}] 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]
+Whether or not to sort the bibliography and the list of shorthands case"=sensitively.
-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.
+\boolitem[true]{sortupper}
-\optitem{sortlocale}{\opt{auto}, \prm{locale}}[\BiberOnly]
+This option corresponds to \biber's |--sortupper| command-line option. If enabled, the bibliography is sorted in <uppercase before lowercase> order. Disabling this option means <lowercase before uppercase> order.
-This option sets the global sorting locale. Every sorting scheme inherits this locale if none is specified using the \prm{locale} option to \cmd{printbibliography}. Setting this to \opt{auto} requests that it be set to the Babel/Polyglossia main document language identifier, if these packages are used and \texttt{en\_US} otherwise. \biber will map Babel/Polyglossia language identifiers into sensible locale identifiers (see the \biber documentation). You can therefore specify either a normal locale identifier like \texttt{de\_DE\_phonebook}, \texttt{es\_ES} or one of the supported Babel/Polyglossia language identifiers if the mapping \biber makes of this is fine for you.
+\optitem{sortlocale}{\opt{auto}, \prm{locale}}
-\optitem[los]{sortlos}{\opt{bib}, \opt{los}}[\BibTeXOnly]
+This option sets the global sorting locale. Every sorting scheme inherits this locale if none is specified using the \prm{locale} option to \cmd{printbibliography}. Setting this to \opt{auto} requests that it be set to the \sty{babel}/\sty{polyglossia} main document language identifier, if these packages are used and \texttt{en\_US} otherwise. \biber will map \sty{babel}/\sty{polyglossia} language identifiers into sensible locale identifiers (see the \biber documentation). You can therefore specify either a normal locale identifier like \texttt{de\_DE\_phonebook}, \texttt{es\_ES} or one of the supported \sty{babel}/\sty{polyglossia} language identifiers if the mapping \biber makes of this is fine for you.
-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}
-
-The sorting order of shorthands with \biber is more flexible and is set with the \opt{sorting} option to the \cmd{printbiblist} command.
-
-\boolitem[true]{related}[\BiberOnly]
+\boolitem[true]{related}
Whether or not to use information from related entries or not. See \secref{use:rel}.
@@ -2161,7 +1980,7 @@ This option controls whether the citation commands scan ahead for punctuation ma
\optitem[autobib]{language}{\opt{autobib}, \opt{autocite}, \opt{auto}, \prm{language}}
-This option controls multilingual support. When set to \opt{autobib}, \opt{autocite} or \opt{auto}, \biblatex will try to get the main document language from the \sty{babel}/\sty{polyglossia} package (and fall back to English if \sty{babel}/\sty{polyglossia} is not available). It is also possible to select the document language manually. In this case, the \opt{autolang} option below will have no effect. Please refer to \tabref{bib:fld:tab1} for a list of supported languages and the corresponding identifiers. \opt{autobib} switches the language for each entry in the bibliography using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{autocite} switches the language for each citation using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{auto} is a shorthand to set both \opt{autobib} and \opt{autocite}. The default is to switch languages automatically only for bibliography entries (\opt{autobib}).
+This option controls multilingual support. When set to \opt{autobib}, \opt{autocite} or \opt{auto}, \biblatex will try to get the main document language from the \sty{babel}/\sty{polyglossia} package (and fall back to English if \sty{babel}/\sty{polyglossia} is not available). It is also possible to select the package language manually. In this case, the language chosen will override the \bibfield{langid} of entries and you should still choose a language switching environment with the \opt{autolang} option to select how the switch to the manually chosen language is handled. Please refer to \tabref{bib:fld:tab1} for a list of supported languages and the corresponding identifiers. \opt{autobib} switches the language for each entry in the bibliography using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{autocite} switches the language for each citation using the \bibfield{langid} field and the language environment specified by the \opt{autolang} option. \opt{auto} is a shorthand to set both \opt{autobib} and \opt{autocite}.
\boolitem[true]{clearlang}
@@ -2180,7 +1999,7 @@ Disable this feature, \ie do not use any language environment at all.
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}/\sty{polyglossia} and \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.
+Enclose the entry in an \env{otherlanguage} environment. This will load hyphenation patterns for the specified language, enable all extra definitions which \sty{babel}/\sty{polyglossia} and \biblatex provide for the respective language, and translate key terms such as <editor> and <volume>. The extra definitions include localisations of the date format, of ordinals, and similar things.
\item[other*]
Enclose the entry in an \env{otherlanguage*} environment. Please note that \biblatex treats \env{otherlanguage*} like \env{otherlanguage} but other packages may make a distinction in this case.
@@ -2240,9 +2059,9 @@ This option controls how sequences of consecutive pages in the list of back refe
\item[two] Compress any sequence of two or more consecutive pages to a range, \eg the above list is compressed to <1--2, 11--13, 21--24>.
-\item[two+] Similar in concept to \opt{two} but a sequence of exactly two consecutive pages is printed using the starting page and the localization string \texttt{sequens}, \eg the above list is compressed to <1\,sq., 11--13, 21--24>.
+\item[two+] Similar in concept to \opt{two} but a sequence of exactly two consecutive pages is printed using the starting page and the localisation string \texttt{sequens}, \eg the above list is compressed to <1\,sq., 11--13, 21--24>.
-\item[three+] Similar in concept to \opt{two+} but a sequence of exactly three consecutive pages is printed using the starting page and the localization string \texttt{sequentes}, \eg the above list is compressed to <1\,sq., 11\,sqq., 21--24>.
+\item[three+] Similar in concept to \opt{two+} but a sequence of exactly three consecutive pages is printed using the starting page and the localisation string \texttt{sequentes}, \eg the above list is compressed to <1\,sq., 11\,sqq., 21--24>.
\item[all+] Similar in concept to \opt{three+} but any sequence of consecutive pages is printed as an open-ended range, \eg the above list is compressed to <1\,sq., 11\,sqq., 21\,sqq.>.
@@ -2321,7 +2140,7 @@ The starred versions of these commands will not trigger a reset.
\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.
+Whether or not to use long or abbreviated strings in citations and in the bibliography. This option affects the localisation modules. If this option is enabled, key terms such as <editor> are abbreviated. If not, they are written out.
\optitem[comp]{date}{\opt{year}, \opt{short}, \opt{long}, \opt{terse}, \opt{comp}, \opt{iso8601}}
@@ -2403,7 +2222,7 @@ See \secref{use:use:epr} for details on support for arXiv and electronic publish
\optitem[auto]{texencoding}{\opt{auto}, \prm{encoding}}
-Specifies the encoding of the \file{tex} file. This option affects the data transferred from the backend to \biblatex. When using \biber, this corresponds to \biber's |--output_encoding| option. The following choices are available:
+Specifies the encoding of the \file{tex} file. This option affects the data transferred from the backend to \biblatex. This corresponds to \biber's |--output_encoding| option. The following choices are available:
\begin{valuelist}
@@ -2417,7 +2236,7 @@ Note that setting \kvopt{texencoding}{\prm{encoding}} will also affect the \opt{
\optitem[auto]{bibencoding}{\opt{auto}, \prm{encoding}}
-Specifies the encoding of the \file{bib} files. When using \biber, this corresponds to \biber's |--input_encoding| option. The following choices are available:
+Specifies the encoding of the \file{bib} files. This corresponds to \biber's |--input_encoding| option. The following choices are available:
\begin{valuelist}
@@ -2427,9 +2246,9 @@ Specifies the encoding of the \file{bib} files. When using \biber, this correspo
\end{valuelist}
-By default, \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.
+By default, \biblatex assumes that the \file{tex} file and the \file{bib} file use the same encoding (\kvopt{bibencoding}{auto}).
-\boolitem[false]{safeinputenc}[\BiberOnly]
+\boolitem[false]{safeinputenc}
If this option is enabled, \biblatex will automatically force \kvopt{texencoding}{ascii} if the \sty{inputenc}\slash \sty{inputenx} package has been loaded and the input encoding is \utf, \ie it will ignore any macro-based \utf support and use Ascii only. \biber will then try to convert any non-Ascii data in the \file{bib} file to Ascii. For example, it will convert \texttt{\d{S}} to |\d{S}|. See \secref{bib:cav:enc:enc} for an explanation of why you may want to enable this option.
@@ -2439,7 +2258,11 @@ By default, \biblatex will report warnings issued by the backend concerning the
\intitem[2]{mincrossrefs}
-Sets the minimum number of cross references to \prm{integer} when requesting a backend run.\footnote{If an entry which is cross-referenced by other entries in the \file{bib} file hits this threshold, it is included in the bibliography even if it has not been cited explicitly. This is a standard feature of the \bibtex (also \biber) and not specific to \biblatex. See the description of the \bibfield{crossref} field in \secref{bib:fld:spc} for further information.} Note that when using the \bibtex backend, 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 \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 \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.
+Sets the minimum number of cross references to \prm{integer} when requesting a backend run.\footnote{If an entry which is cross-referenced by other entries in the \file{bib} file hits this threshold, it is included in the bibliography even if it has not been cited explicitly. This is a standard feature of the \bibtex format and not specific to \biblatex. See the description of the \bibfield{crossref} field in \secref{bib:fld:spc} for further information.} This option also affects the handling of the \bibfield{xref} field. See the field description in \secref{bib:fld:spc} as well as \secref{bib:cav:ref} for details.
+
+\intitem[2]{minxrefs}
+
+As \opt{mincrossrefs} but for \bibfield{xref} fields.
\end{optionlist}
@@ -2582,22 +2405,22 @@ When enabled, all first and middle names will be rendered as initials. The optio
\boolitem[false]{sortgiveninits}
-When enabled, sorting names will only use their initials. \BiberOnlyMark This is separate from \opt{giveninits} in case users want to show only inits but sort on full names, for example.
+When enabled, sorting names will only use their initials. This is separate from \opt{giveninits} in case users want to show only inits but sort on full names, for example.
\boolitem[false]{terseinits}
-This option controls the format of initials generated by \biblatex. If enabled, initials are rendered using a terse format without dots and spaces. For example, the initials of Donald Ervin Knuth would be rendered as <D.~E.> by default, and as <DE> if this option is enabled. The option will affect the \cmd{ifterseinits} test from \secref{aut:aux:tst}. \BiberOnlyMark With \biber, the option works by redefining some macros which control the format of initials. See \secref{use:cav:nam} for details.
+This option controls the format of initials generated by \biblatex. If enabled, initials are rendered using a terse format without dots and spaces. For example, the initials of Donald Ervin Knuth would be rendered as <D.~E.> by default, and as <DE> if this option is enabled. The option will affect the \cmd{ifterseinits} test from \secref{aut:aux:tst}. The option works by redefining some macros which control the format of initials. See \secref{use:cav:nam} for details.
\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. See also \opt{maxalphanames} and \opt{minalphanames}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
+This option is also settable on a per-type basis. See also \opt{maxalphanames} and \opt{minalphanames}. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
-\intitem[3]{maxalphanames}[\BiberOnly]
+\intitem[3]{maxalphanames}
Similar to the \opt{maxnames} option but customizes the format of the \bibfield{labelalpha} field.
-\intitem[1]{minalphanames}[\BiberOnly]
+\intitem[1]{minalphanames}
Similar to the \opt{minnames} option but customizes the format of the \bibfield{labelalpha} field.
@@ -2606,26 +2429,35 @@ Similar to the \opt{minnames} option but customizes the format of the \bibfield{
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]{labeltitle}[\BiberOnly]
+\boolitem[false]{labeltitle}
Whether or not to provide the special field \bibfield{extratitle}, see \secref{aut:bbx:fld} for details. Note that the special field \bibfield{labeltitle} is always provided and this option controls rather whether \bibfield{labeltitle} is used to generate \bibfield{extratitle} information. This option is also settable on a per-type basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
-\boolitem[false]{labeltitleyear}[\BiberOnly]
+\boolitem[false]{labeltitleyear}
Whether or not to provide the special field \bibfield{extratitleyear}, see \secref{aut:bbx:fld} for details. Note that the special field \bibfield{labeltitle} is always provided and this option controls rather whether \bibfield{labeltitle} is used to generate \bibfield{extratitleyear} information. This option is also settable on a per-type basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\boolitem[false]{labeldate}
Whether or not to provide the special fields \bibfield{labelyear}, \bibfield{labelmonth}, \bibfield{labelday} and \bibfield{extrayear}, see \secref{aut:bbx:fld} for details.
-\BiberOnlyMark With \biber, this option is also settable on a per-type basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
+This option is also settable on a per-type basis. Table \ref{use:opt:tab1} summarises the various \opt{extra*} disambiguation counters and what they track.
\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.
+This option is also settable on a per-type basis.
+
+\boolitem[false]{uniquetitle}
+
+Whether or not to provide the data required by the \cmd{ifuniquetitle} test, see \secref{aut:aux:tst} for details.
+This option is also settable on a per-type basis.
+
+\boolitem[false]{uniqueprimaryauthor}
+
+Whether or not to provide the data required by the \cmd{ifuniqueprimaryauthor} test, see \secref{aut:aux:tst} for details.
\optitem[false]{uniquename}{\opt{true}, \opt{false}, \opt{init}, \opt{full}, \opt{allinit}, \opt{allfull},
-\opt{mininit}, \opt{minfull}}[\BiberOnly]
+\opt{mininit}, \opt{minfull}}
Whether or not to update the \cnt{uniquename} counter, see \secref{aut:aux:tst} for details. This feature will disambiguate individual names in the \bibfield{labelname} list. This option is also settable on a per-type basis. The possible choices are:
@@ -2642,7 +2474,7 @@ Whether or not to update the \cnt{uniquename} counter, see \secref{aut:aux:tst}
%
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]
+\optitem[false]{uniquelist}{\opt{true}, \opt{false}, \opt{minyear}}
Whether or not to update the \cnt{uniquelist} counter, see \secref{aut:aux:tst} for details. This feature will disambiguate the \bibfield{labelname} list if it has become ambiguous after \opt{maxnames}\slash \opt{minnames} truncation. Essentially, it overrides \opt{maxnames}\slash \opt{minnames} on a per-field basis. This option is also settable on a per-type basis. The possible choices are:
@@ -2691,17 +2523,17 @@ The following options are settable on a per"=type basis or on a per"=entry in th
\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 and per-entry basis.
+This option is also settable on a per-type and per-entry basis.
\boolitem[true]{useeditor}
Whether the \bibfield{editor} replaces a missing \bibfield{author} in labels and during sorting. This may be useful if an entry includes an \bibfield{editor} field but is usually not cited by editor. Setting \kvopt{useeditor}{false} does not mean that the \bibfield{editor} is ignored completely. It means that the \bibfield{editor} does not replace a missing \bibfield{author} in labels and during sorting. The entry will then be alphabetized by \bibfield{title}. With the standard styles, the \bibfield{editor} is printed after the title in this case. See also \secref{use:srt}.
-\BiberOnlyMark With \biber, this option is also settable on a per-type and per-entry basis.
+This option is also settable on a per-type and per-entry basis.
\boolitem[false]{usetranslator}
Whether the \bibfield{translator} replaces a missing \bibfield{author}\slash \bibfield{editor} in labels and during sorting. Setting \kvopt{usetranslator}{true} does not mean that the \bibfield{translator} overrides the \bibfield{author}\slash \bibfield{editor}. It means that the \bibfield{translator} is considered as a fallback if the \bibfield{author}\slash \bibfield{editor} is missing or if \opt{useauthor} and \opt{useeditor} are set to \texttt{false}. In other words, in order to cite a book by translator rather than by author, you need to set the following options:
-\BiberOnlyMark With \biber, this option is also settable on a per-type and per-entry basis.
+This option is also settable on a per-type and per-entry basis.
\begin{lstlisting}[style=bibtex]{}
@Book{...,
@@ -2721,7 +2553,7 @@ defined. Global, per-type and per-entry options called <use$<$name$>$>are automa
\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, \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 scope. With \biblatexml datasources, this is settable on per-namelist and per-name scopes.
+This option is also settable on a per-type scope. With \biblatexml datasources, this is settable on per-namelist and per-name scopes.
\optitem{indexing}{\opt{true}, \opt{false}, \opt{cite}, \opt{bib}}
@@ -2739,26 +2571,22 @@ The following options are settable on a per"=type basis or on a per"=entry in th
\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}[\BibTeXOnly]
-
-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. This option is deprecated when using \biber as the backend. Use \opt{skipbiblist} instead.
+This option is also settable on a per-type basis.
-\boolitem[false]{skipbiblist}[\BiberOnly]
+\boolitem[false]{skipbiblist}
-This is the same as the \opt{skiplos} option when using the \bibtex backend. It is renamed for \biber to be consistent with the more generalised bibliography list functionality, see \secref{use:bib:biblist}. If this option is enabled, the entry is excluded from and bibliography lists. It is still included in the bibliography and it may also be cited by shorthand etc.
+If this option is enabled, the entry is excluded from and bibliography lists. It is still included in the bibliography and it may also be cited by shorthand etc.
This option is also settable on a per-type basis.
\boolitem[false]{skiplab}
If this option is enabled, \biblatex will not assign any labels to the entry. It is not required for normal operation. Use it with care. If enabled, \biblatex can not guarantee unique citations for the respective entry and citations styles which require labels may fail to create valid citations for the entry.
-\BiberOnlyMark With \biber, this option is also settable on a per-type basis.
+This option is also settable on a per-type basis.
\boolitem[false]{dataonly}
Setting this option is equivalent to \kvopt{uniquename}{false}, \kvopt{uniquelist}{false, }\opt{skipbib}, \opt{skiplos}/\opt{skipbiblist}, 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.
+This option is also settable on a per-type basis.
\paragraph{Entry Only Options}
\label{use:opt:bib:entry}
@@ -2948,7 +2776,7 @@ This style prints all bibliographic data in tabular format. It is intended for d
\subsection{Related Entries}
\label{use:rel}
-Almost all bibliography styles require authors to specify certain types of relationship between entries such as «Reprint of», «Reprinted in» etc. It is impossible to provide data fields to cover all of these relationships and so \biblatex provides a general mechanism for this using the entry fields \bibfield{related}, \bibfield{relatedtype} and \bibfield{relatedstring}. A related entry does not need to be cited and does not appear in the bibliography itself (unless of course it is also cited itself independently) as a clone is taken of the related entry to be used as a data source. The \bibfield{relatedtype} field should specify a localization string which will be printed before the information from the related entries is printed, for example «Orig. Pub. as». The \bibfield{relatedstring} field can be used to override the string determined via \bibfield{relatedtype}. Some examples:
+Almost all bibliography styles require authors to specify certain types of relationship between entries such as «Reprint of», «Reprinted in» etc. It is impossible to provide data fields to cover all of these relationships and so \biblatex provides a general mechanism for this using the entry fields \bibfield{related}, \bibfield{relatedtype} and \bibfield{relatedstring}. A related entry does not need to be cited and does not appear in the bibliography itself (unless of course it is also cited itself independently) as a clone is taken of the related entry to be used as a data source. The \bibfield{relatedtype} field should specify a localisation string which will be printed before the information from the related entries is printed, for example «Orig. Pub. as». The \bibfield{relatedstring} field can be used to override the string determined via \bibfield{relatedtype}. Some examples:
\begin{lstlisting}[style=bibtex]{}
@Book{key1,
@@ -2966,9 +2794,9 @@ Almost all bibliography styles require authors to specify certain types of relat
Here we specify that entry \texttt{key1} is a reprint of entry \texttt{key2}. In the bibliography driver for \texttt{Book} entries, when \cmd{usebibmacro\{related\}} is called for entry \texttt{key1}:
\begin{itemize}
-\item If the localization string «\texttt{reprintof}» is defined, it is printed in the \texttt{relatedstring:reprintof} format. If this formatting directive is undefined, the string is printed in the \texttt{relatedstring:default} format.
+\item If the localisation string «\texttt{reprintof}» is defined, it is printed in the \texttt{relatedstring:reprintof} format. If this formatting directive is undefined, the string is printed in the \texttt{relatedstring:default} format.
\item If the \texttt{related:reprintof} macro is defined, it is used to format the information contained in entry \texttt{key2}, otherwise the \texttt{related:default} macro is used
-\item If the \texttt{related:reprintof} format is defined, it is used to format both the localization string and data. If this format is not defined, then the \texttt{related} format is used instead.
+\item If the \texttt{related:reprintof} format is defined, it is used to format both the localisation string and data. If this format is not defined, then the \texttt{related} format is used instead.
\end{itemize}
%
It is also supported to have cascading and/or circular relations:
@@ -3027,7 +2855,124 @@ The first item considered in the sorting process is always the \bibfield{presort
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 \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 \biber instead of legacy \bibtex is strongly recommended.
+Using special fields such as \bibfield{sortkey}, \bibfield{sortname}, or \bibfield{sorttitle} is usually not required. The \biblatex package is quite capable of working out the desired sorting order by using the data found in the regular fields of an entry. You will only need them if you want to manually modify the sorting order of the bibliography or if any data required for sorting is missing. Please refer to the field descriptions in \secref{bib:fld:spc} for details on possible uses of the special fields.
+
+\subsection{Data Annotations}
+\label{use:annote}
+Ideally, there should be no formatting information in a bibliography data file, however, sometimes such questionable practice seems to the only way in which the desired results can be achieved. Data annotations are a way of addressing this by allowing users to attach semantic information (rather than typographical markup) to information in a bibliography data source so that the information can be used at markup time by a style. For example, if you wanted to highlight certain names in a work depending on whether they were a student author (indicated by a superscript asterisk in the references) or a corresponding author (indicated by bold face), then you might be tempted to try:
+
+\begin{lstlisting}[style=bibtex]{}
+@MISC{Article1,
+ AUTHOR = {Last1\textsuperscript{*}, First1 and \textbf{Last2}, \textbf{First2} and Last3, First3}
+}
+\end{lstlisting}
+%
+There are several problems with this. Firstly, it will break \bibtex's fragile name parsing routines and probably won't compile at all. Secondly, it is not only mixing up data with markup, it does so in a hard-coded way: this data can't easily be shared and used with other styles. While it is possible to achieve this formatting using \biblatex internals in a style or document, this is a complex and unreliable method which many users will not wish to use.
+
+In order to address these issues, \biblatex has a general data annotation facility which allows you to attach a comma"=separated list of annotations to data fields, items within data field lists (like names) and even parts of specific items such as parts of names (given name, family name etc.). There are macros provided to check for annotations which can be used in formatting directives.
+
+There are three «scopes» for data annotations, in order of increasing specificity:
+
+\begin{itemize}
+\item \opt{field}---applied to top-level fields in a data source entry
+\item \opt{item}---applied to items within a list field in a data source entry
+\item \opt{part}---applied to parts within items within a list field in a data source entry
+\end{itemize}
+%
+Data annotations are supported for \bibtex and \biblatexml data sources.
+
+Attaching annotations to data is easy in \biblatexml data sources as they are specified by simple XML attributes. Continuing with the example above, we would have:
+
+\begin{lstlisting}[language=xml]
+<bltx:entries xmlns:bltx="http://biblatex-biber.sourceforge.net/biblatexml">
+ <bltx:entry id="test" entrytype="misc">
+ <bltx:names type="author">
+ <bltx:name>
+ <bltx:namepart type="given" initial="F">First1</bltx:namepart>
+ <bltx:namepart type="family" initial="L" annotation="student">Last1</bltx:namepart>
+ </bltx:name>
+ <bltx:name annotation="corresponding">
+ <bltx:namepart type="given" initial="F">First2</bltx:namepart>
+ <bltx:namepart type="family" initial="L">Last2</bltx:namepart>
+ </bltx:name>
+ <bltx:name>
+ <bltx:namepart type="given" initial="F">First3</bltx:namepart>
+ <bltx:namepart type="family" initial="L">Last3</bltx:namepart>
+ </bltx:name>
+ </bltx:names>
+ </bltx:entry>
+</bltx:entries>
+\end{lstlisting}
+%
+Here the annotations are attached in an obvious way to the data items. With \bibtex data sources, the format for annotations is not quite as intuitive:
+
+\begin{lstlisting}[style=bibtex]{}
+@MISC{ann1,
+ AUTHOR = {Last1, First1 and Last2, First2 and Last3, First3},
+ AUTHOR+an = {1:family=student;2=corresponding},
+}
+\end{lstlisting}
+%
+Here the field name suffix \texttt{+an} is a user-definable\footnote{See \biber's \opt{--annotation-marker} option.} suffix which marks a data field as an annotation of the unsuffixed field. The format of annotation fields in \bibtex data sources is is as follows:
+
+\begin{lstlisting}
+<annotationspecs> ::= <annotationspec> [ ";" <annotationspec> ]
+<annotationspec> ::= [ <itemcount> [ ":" <part> ] ] "=" <annotations>
+<annotations> ::= <annotation> [ "," <annotation> ]
+<annotation> ::= (string)
+\end{lstlisting}
+%
+That is, one or more specifications separated by semi-colons. Each specification is an equals sign followed by a comma"=separated list of annotation keywords. To annotation a specific item in a list, put the number of the list item before the equals sign (lists start at 1). If you need to annotate a specific part of the list item, give its name after the list item number, preceded by a colon. Name part names are defined in the data model, see \secref{aut:bbx:drv}. Some examples:
+
+\begin{lstlisting}[style=bibtex]{}
+AUTHOR = {Last1, First1 and Last2, First2 and Last3, First3},
+AUTHOR+an = {3:given=annotation1, annotation2},
+TITLE = {A title},
+TITLE+an = {=a title annotation, another title annotation},
+LANGUAGE = {english and french},
+LANGUAGE+an = {1=annotation3; 2=annotation4}
+}
+\end{lstlisting}
+%
+To access the annotation information when formatting bibliography data, three macros are provided, corresponding to the three annotation scopes:
+
+\begin{ltxsyntax}
+
+\cmditem{iffieldannotation}{annotation}{true}{false}
+
+Executes \prm{true} if the current data field has an annotation \prm{annotation} and false otherwise.
+
+\cmditem{ifitemannotation}{annotation}{true}{false}
+
+Executes \prm{true} if the current item in the current data field has an annotation \prm{annotation} and false otherwise.
+
+\cmditem{ifpartannotation}{part}{annotation}{true}{false}
+
+Executes \prm{true} if the part named \prm{part} in current item in the current data field has an annotation \prm{annotation} and false otherwise.
+
+\end{ltxsyntax}
+%
+These macros are available in the same places as \cmd{currentfield}, \cmd{currentlist} and \cmd{currentname} (see \secref{aut:bib:fmt}), that is, inside formatting directives. They automatically determine the name of the current data field being processed and also the current \opt{listcount} value which determines the current item in list fields. Parts such as name parts need to be named explicitly. As an example of how to use the annotation information to solve the problem originally presented in this section, this could be used in the name formatting directives to put an asterisk after all family names annotated as «student»:
+
+\begin{lstlisting}[style=latex]{}
+ \ifpartannotation{family}{student}
+ {\textsuperscript{*}}
+ {}%
+\end{lstlisting}
+%
+To put the given and family names of name list items annotated as «corresponding» in boldface:
+
+\begin{lstlisting}[style=latex]{}
+\renewcommand*{\mkbibnamegiven}[1]{%
+ \ifitemannotation{corresponding}
+ {\textbf{#1}}
+ {#1}}
+
+\renewcommand*{\mkbibnamefamily}[1]{%
+ \ifitemannotation{corresponding}
+ {\textbf{#1}}
+ {#1}}
+\end{lstlisting}
\subsection{Bibliography Commands}
\label{use:bib}
@@ -3072,9 +3017,9 @@ The data type (format) of the resource. The following formats are currently supp
\item[bibtex] \bibtex format.
-\item[biblatexml]\BiberOnlyMark Experimental XML format for \biblatex. See \secref{apx:biblatexml}.
+\item[biblatexml] Experimental XML format for \biblatex. See \secref{apx:biblatexml}.
-\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[ris] 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.
\end{valuelist}
@@ -3171,10 +3116,6 @@ Filter the entries with filter \prm{name}, as defined with \cmd{defbibfilter}. S
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.
-
\valitem{resetnumbers}{true,false,number}
This option applies to numerical citation\slash bibliography styles only and requires that the \opt{defernumbers} option from \secref{use:opt:pre:gen} be enabled globally. If enabled, it will reset the numerical labels assigned to the entries in the respective bibliography, \ie the numbering will restart at~1. You can also pass a number to this option, for example: \texttt{resetnumbers=10} to reset numbering to the specified number to aid numbering continuity across documents. Use this option with care as \biblatex can not guarantee unique labels globally if they are reset manually.
@@ -3207,28 +3148,9 @@ This command prints a bibliography heading defined with \cmd{defbibheading}. It
%
To print a bibliography with a different sorting scheme than the global sorting scheme, use the bibliography context switching commands from \secref{use:bib:context}.
-\subsubsection{The List of Shorthands}
-\label{use:bib:los}
-
-\BibTeXOnlyMark This section applies only to \bibtex. When using \biber, the list of shorthands is just a special case of a bibliography list. See \secref{use:bib:biblist}.
-
-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.
-
-The \opt{sorting} option differs from \cmd{printbibliography} in that if omitted, the default is to sort by shorthand.
-
-\end{ltxsyntax}
-
\subsubsection{Bibliography Lists}
\label{use:bib:biblist}
-\BiberOnlyMark This section applies only to \biber. It is a generalisation of the shorthands facility available in earlier versions and with \bibtex. When using \bibtex as the backend, please refer to section \secref{use:bib:los}.
-
\biblatex can, in addition to printing normal bibliographies, also print arbitrary lists of information derived from the bibliography data such as a list of shorthand abbreviations for particular entries or a list of abbreviations of journal titles.
A bibliography list differs from a normal bibliography in that the same bibliography driver is used to print all entries rather than a specific driver being used for each entry depending on the entry type.
@@ -3237,7 +3159,7 @@ A bibliography list differs from a normal bibliography in that the same bibliogr
\cmditem{printbiblist}[key=value, \dots]{<biblistname>}
-This command prints a bibliography list. It takes an optional argument, which is a list of options given in \keyval notation. Valid options are all options supported by \cmd{printbibliography} (\secref{use:bib:bib}) except \opt{prefixnumbers}, \opt{resetnumbers}, and \opt{omitnumbers}. If there are any \env{refsection} environments in the document, the bibliography list will be local to these environments; see \secref{use:bib:sec} for details. By default, this command uses the heading \texttt{biblist}. See \secref{use:bib:hdg} for details.
+This command prints a bibliography list. It takes an optional argument, which is a list of options given in \keyval notation. Valid options are all options supported by \cmd{printbibliography} (\secref{use:bib:bib}) except \opt{resetnumbers} and \opt{omitnumbers}. If there are any \env{refsection} environments in the document, the bibliography list will be local to these environments; see \secref{use:bib:sec} for details. By default, this command uses the heading \texttt{biblist}. See \secref{use:bib:hdg} for details.
The \prm{biblistname} is a mandatory argument which names the bibliography list. This name is used to identify:
\begin{itemize}
@@ -3403,7 +3325,7 @@ The following headings, which are intended for use with \cmd{printbibliography}
\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.
+This is the default heading used by \cmd{printbibliography} if the \opt{heading} option is not given. Its default definition depends on the document class. If the class provides a \cmd{chapter} command, the heading is similar to the bibliography heading of the standard \latex \texttt{book} class, \ie it uses \cmd{chapter*} to create an unnumbered chapter heading which is not included in the table of contents. If there is no \cmd{chapter} command, it is similar to the bibliography heading of the standard \latex \texttt{article} class, \ie it uses \cmd{section*} to create an unnumbered section heading which is not included in the table of contents. The string used in the heading also depends on the document class. With \texttt{book}-like classes the localisation string \texttt{bibliography} is used, with other classes it is \texttt{references} (see \secref{aut:lng:key}). See also \secref{use:cav:scr, use:cav:mem} for class-specific hints.
\item[subbibliography]
Similar to \texttt{bibliography} but one sectioning level lower. This heading definition uses \cmd{section*} instead of \cmd{chapter*} with a \texttt{book}-like class and \cmd{subsection*} instead of \cmd{section*} otherwise.
@@ -3430,7 +3352,7 @@ The following headings intended for use with \cmd{printbiblist} are predefined:
\begin{valuelist*}
\item[biblist]
-This is the default heading used by \cmd{printbiblist} if the \opt{heading} option is not given. It is similar to \texttt{bibliography} above except that it uses the 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.
+This is the default heading used by \cmd{printbiblist} if the \opt{heading} option is not given. It is similar to \texttt{bibliography} above except that it uses the localisation string \texttt{shorthands} instead of \texttt{bibliography} or \texttt{references} (see \secref{aut:lng:key}). See also \secref{use:cav:scr, use:cav:mem} for class-specific hints.
\item[biblistintoc]
Similar to \texttt{biblist} above but adds an entry to the table of contents.
@@ -3536,14 +3458,16 @@ See the author guide, in particular \secref{aut:aux:tst,aut:aux:ife}, for furthe
\end{ltxsyntax}
-\subsubsection{Bibliography Contexts}\BiberOnlyMark
+\subsubsection{Reference Contexts}
\label{use:bib:context}
-References in a bibliography are cited and printed in a <context>. The context determines the data which is actually used to cite or provide bibliographic data for an entry. A context consists currently of the following information (the <context> concept is designed for future extensibility):
+References in a bibliography are cited and printed in a <context>. The context determines the data which is actually used to cite or provide bibliographic data for an entry. A context consists of the following information (the <context> concept is designed for future extensibility):
\begin{itemize}
\item A sorting scheme
\item A scheme for constructing the sorting keys for names
+ \item A string prefix for citation schemes which use alphabetic or numeric
+ labels
\end{itemize}
%
The point of bibliography contexts is twofold. Firstly, they are used to set options which influence a printed bibliography and secondly to influence the data printed by citation commands.
@@ -3593,6 +3517,34 @@ To demonstrate the second type of use of bibliography contexts, we have to under
%
Here, the second use of the citations, along with the \cmd{printbibliography} command will use data from the context of the custom <yntd> sorting scheme which may well be different from the data associated with the default <nyt> scheme. That is, the citation labels (in an authoryear style which uses \opt{extrayear}) may be different \emph{for the exact same entries} between different bibliography contexts and so the citations themselves may look different.
+By default, data for a citation is drawn from the reference context of the last bibliography in which it was printed. For example, in the fragment:
+
+\begin{ltxexample}[style=latex]{}
+\begin{document}
+
+\cite{book, article, misc}
+
+\printbibliography[type=book]
+
+\newrefcontext[labelprefix=A]
+\printbibliography[type=article]
+
+\newrefcontext[sorting=ydnt, resetnumbers]
+\printbibliography[type=misc]
+
+\end{document}
+\end{ltxexample}
+%
+Assuming the entrykeys are indicative of their entrytypes, this is the default situation for the citations which corresponds to what users normally expect:
+
+\begin{itemize}
+\item The citation of entry \bibfield{book} would draw its data from the global reference context, because the last bibliography in which it was printed was the one in the global reference context.
+\item The citation of entry \bibfield{article} would draw its data from reference context with \opt{labelprefix=A} and would therefore have a <A> prefix when cited.
+\item The citation of entry \bibfield{misc} would draw its data from the reference context with \opt{sorting=ydnt}
+\end{itemize}
+%
+In cases where the user has entries which occur in multiple bibliographies in different forms or with potentially different labels (in a numeric scheme with different \bibfield{labelprefix} values for example), it may be necessary to tell \biblatex from which reference context you wish to draw the citation information. As shown above this can be done by explicitly putting citations inside reference contexts. This can be onerous in a large document and so there is specific functionality for assigning citations to reference contexts programatically, see the \cmd{assignrefcontext*} macros below.
+
\begin{ltxsyntax}
\envitem{refcontext}[key=value, \dots]
@@ -3609,6 +3561,10 @@ Specify a sorting scheme defined previously with \cmd{DeclareSortingScheme}. Thi
Specify a sorting name key scheme defined previously with \cmd{DeclareSortingNamekeyScheme}. This scheme is used to construct sorting keys for names inside the context.
+\valitem{labelprefix}{string}
+
+This option applies to numerical citation\slash bibliography styles only and requires that the \opt{defernumbers} option from \secref{use:opt:pre:gen} be enabled globally. Setting this option will implicitly enable \opt{resetnumbers} for the any \cmd{printbibliography} in the scope of the context. The option assigns the \prm{string} as a prefix to all entries in the reference context. For example, if the \prm{string} is \texttt{A}, the numerical labels printed will be \texttt{[A1]}, \texttt{[A2]}, \texttt{[A3]}, etc. This is useful for subdivided numerical bibliographies where each subbibliography uses a different prefix. The \prm{string} is available to styles in the \bibfield{labelprefix} field of all affected entries. See \secref{aut:bbx:fld:lab} for details.
+
\end{optionlist*}
%
The \opt{refcontext} environment cannot be nested and \biblatex will generate an error if you try to do so.
@@ -3618,31 +3574,40 @@ The \opt{refcontext} environment cannot be nested and \biblatex will generate an
This command is similar to the \env{refcontext} environment except that it is a stand"=alone command rather than an environment. It automatically ends the previous context section (if any) and immediately starts a new one. Note that the context section started by the last \cmd{newrefcontext} command in the document will extend to the very end of the document. Use \cmd{endrefcontext} if you want to terminate it earlier.
\end{ltxsyntax}
%
-At the beginning of the document, there is always a global context containing global settings for each of the context attributes.
+At the beginning of the document, there is always a global context containing global settings for each of the reference context options.
\begin{ltxsyntax}
\cmditem{assignrefcontextkeyws}[key=value, \dots]{keyword1,keyword2, ...}
+\cmditem{assignrefcontextkeyws*}[key=value, \dots]{keyword1,keyword2, ...}
\cmditem{assignrefcontextcats}[key=value, \dots]{category1, category2, ...}
+\cmditem{assignrefcontextcats*}[key=value, \dots]{category1, category2, ...}
\cmditem{assignrefcontextentries}[key=value, \dots]{entrykey1, entrykey2, ...}
+\cmditem{assignrefcontextentries*}[key=value, \dots]{entrykey1, entrykey2, ...}
\end{ltxsyntax}
-These commands automate putting citations into refcontexts. Instead of wrapping citation commands in \env{refcontext} environments, which might be error-prone and tedious, you can register a comma"=separated list of \prm{keywords}, \prm{categories} or \prm{entrykeys} which, respectively, make the entries with any of the specified keywords, entries in any of the specified categories (see \secref{use:use:div}) or entries with any of the specified citation keys be cited in a particular refcontext specified by the \prm{refcontext key/values} which are parsed exactly as the per \env{refcontext} options. Such refcontext auto-assignments are specific to the current refsection. This is useful if you have multiple bibliographies, differently sorted whilst using \opt{defernumbers} as then \biblatex needs to know which bibliography (which is always in a particular refcontext) it should construct the citation from since the citations could well have different numbers in different bibliographies. You may specify the same citation key in any of these commands but be aware that assignment is done in the order \prm{keywords}, \prm{categories}, \prm{entrykeys} with the later specifications overriding the earlier. An example:
+These commands automate putting citations into refcontexts when the default behaviour is not sufficient. The default behaviour is that the data for a citation is drawn from the refcontext of the last bibliography in which it was printed. For citations that are used in some way but not printed in a bibliography or bibliography list, they default to drawing their data from the global refcontext established at the beginning of the document. To override this behaviour, instead of manually wrapping citation commands in \env{refcontext} environments, which might be error-prone and tedious, you can register a comma"=separated list of \prm{keywords}, \prm{categories} or \prm{entrykeys} which, respectively, make the entries with any of the specified keywords, entries in any of the specified categories (see \secref{use:use:div}) or entries with any of the specified citation keys draw their data from a particular refcontext specified by the \prm{refcontext key/values} which are parsed as the per the corresponding \env{refcontext} options. Such refcontext auto-assignments are specific to the current refsection. You may specify the same citation key in any of these commands but be aware that assignment is done in the order \prm{keywords}, \prm{categories}, \prm{entrykeys} with the later specifications overriding the earlier. An example:
\begin{ltxexample}[style=latex]{}
-\assignrefcontextentries[sorting=nty]{key1,key2}
-\cite{key1}, \cite{key2}
+\assignrefcontextentries[labelprefix=A]{key2}
+\cite{key1}
+\begin{refcontext}[labelprefix=B]
+\cite{key2}
+\end{refcontext}
\end{ltxexample}
%
-This forces all citations of entries \bibfield{key1} and \bibfield{key2} to be drawn from the refcontext specified by \opt{sorting=nty}. It is identical in function to:
+Here, the data for the citation of \bibfield{key2} will be drawn from refcontext \opt{labelprefix=A} and not \opt{labelprefix=B} (resulting in a label with prefix <A> and not <B>).
+The starred versions do not override a local refcontext and so with:
\begin{ltxexample}[style=latex]{}
-\begin{refcontext}[sorting=nty]
-\cite{key1}, \cite{key2}
+\assignrefcontextentries*[labelprefix=A]{key2}
+\cite{key1}
+\begin{refcontext}[labelprefix=B]
+\cite{key2}
\end{refcontext}
\end{ltxexample}
%
-which is not so convenient as such manual specification of refcontexts for citations requires manual insertion of refcontext changing commands wherever the citations occur.
+the data for the citation of \bibfield{key2} will be drawn from refcontext \opt{labelprefix=B}. Note that these commands are rarely necessary unless you have multiple bibliographies in which the same citations occur and \biblatex\ cannot by default tell which bibliography list a citation should refer to. See the example file \file{94-labelprefix.tex} for more details.
\subsubsection{Dynamic Entry Sets}
\label{use:bib:set}
@@ -3651,9 +3616,9 @@ In addition to the \bibtype{set} entry type, \biblatex also supports dynamic ent
\begin{ltxsyntax}
-\cmditem{defbibentryset}{key}{key1,key2,key3, \dots}\BiberOnlyMark
+\cmditem{defbibentryset}{key}{key1,key2,key3, \dots}
-The \prm{key} is the entry key of the set, which is used like any other entry key when referring to the set. The \prm{key} must be unique and it must not conflict with any other entry key. The second argument is a comma"=separated list of the entry keys which make up the set. \cmd{defbibentryset} implies the equivalent of a \cmd{nocite} command, \ie all sets which are declared are also added to the bibliography. When declaring the same set more than once, only the first invocation of \cmd{defbibentryset} will define the set. Subsequent definitions of the same \prm{key} are ignored and work like \cmd{nocite}\prm{key}. Dynamic entry sets defined in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0. Note that dynamic entry sets require \biber. They will not work with any other backend. See \secref{use:use:set} for further details.
+The \prm{key} is the entry key of the set, which is used like any other entry key when referring to the set. The \prm{key} must be unique and it must not conflict with any other entry key. The second argument is a comma"=separated list of the entry keys which make up the set. \cmd{defbibentryset} implies the equivalent of a \cmd{nocite} command, \ie all sets which are declared are also added to the bibliography. When declaring the same set more than once, only the first invocation of \cmd{defbibentryset} will define the set. Subsequent definitions of the same \prm{key} are ignored and work like \cmd{nocite}\prm{key}. Dynamic entry sets defined in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0. See \secref{use:use:set} for further details.
\end{ltxsyntax}
@@ -3868,7 +3833,9 @@ The following special commands are also provided by the core of \biblatex.
\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.
+This command is similar to the standard \latex \cmd{nocite} command. It
+adds the \prm{key} to the bibliography without printing a citation. If the
+\prm{key} is an asterisk, all entries available in the in-scope bibliography datasource(s) are added to the bibliography. Like all other citation commands, \cmd{nocite} commands in the document body are local to the enclosing \env{refsection} environment, if any. In contrast to standard \latex, \cmd{nocite} may also be used in the document preamble. In this case, the references are assigned to reference section~0.
\cmditem{fullcite}[prenote][postnote]{key}
@@ -4008,11 +3975,11 @@ Similar to \cmd{pno} but suppresses all prefixes. See \secref{use:cav:pag} for f
\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.
+In the \prm{postnote} argument to a citation command, this command indicates a range of two pages where only the starting page is given. See \secref{use:cav:pag} for further details and usage instructions. The suffix printed is the localisation string \texttt{sequens}, see \secref{aut:lng:key}. The spacing inserted between the suffix and the page number may be modified by redefining the macro \cmd{sqspace}. The default is an unbreakable interword space. Note that this command is only available locally in citations and the bibliography.
\csitem{psqq}
-Similar to \cmd{psq} but indicates an open-ended page range. See \secref{use:cav:pag} for further details and usage instructions. The suffix printed is the localization string \texttt{sequentes}, see \secref{aut:lng:key}. This command is only available locally in citations and the bibliography.
+Similar to \cmd{psq} but indicates an open-ended page range. See \secref{use:cav:pag} for further details and usage instructions. The suffix printed is the localisation string \texttt{sequentes}, see \secref{aut:lng:key}. This command is only available locally in citations and the bibliography.
\cmditem{RN}{integer}
@@ -4029,7 +3996,7 @@ Similar to \cmd{RN} but prints a lowercase Roman numeral. The formatting applied
The \opt{natbib} package option loads a \sty{natbib} compatibility module. The module defines aliases for the citation commands provided by the \sty{natbib} package. This includes aliases for the core citation commands \cmd{citet} and \cmd{citep} as well as the variants \cmd{citealt} and \cmd{citealp}. The starred variants of these commands, which print the full author list, are also supported. The \cmd{cite} command, which is handled in a particular way by \sty{natbib}, is not treated in a special way. The text commands (\cmd{citeauthor}, \cmd{citeyear}, etc.) are also supported, as are all commands which capitalize the name prefix (\cmd{Citet}, \cmd{Citep}, \cmd{Citeauthor}, etc.). Aliasing with \cmd{defcitealias}, \cmd{citetalias}, and \cmd{citepalias} is possible as well. Note that the compatibility commands will not emulate the citation format of the \sty{natbib} package. They merely alias \sty{natbib}'s commands to functionally equivalent facilities of the \biblatex package. The citation format depends on the main citation style. However, the compatibility style will adapt \cmd{nameyeardelim} to match the default style of the \sty{natbib} package.
-\subsubsection[\sty{mcite}-like Citation Commands]{\sty{mcite}-like Citation Commands\BiberOnlyMark}
+\subsubsection[\sty{mcite}-like Citation Commands]{\sty{mcite}-like Citation Commands}
\label{use:cit:mct}
The \opt{mcite} package option loads a special citation module which provides \sty{mcite}\slash \sty{mciteplus}-like citation commands. Strictly speaking, what the module provides are wrappers for the commands of the main citation style. For example, the following command:
@@ -4125,7 +4092,7 @@ The \biblatex package provides translations for key terms such as <edition> or <
\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}/\sty{polyglossia} packages, \ie one of the identifiers listed in \tabref{bib:fld:tab1} on page \pageref{bib:fld:tab1}. The \prm{definitions} are \keyval pairs which assign an expression to an identifier:
+This command is used to define localisation strings. The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglossia} packages, \ie one of the identifiers listed in \tabref{bib:fld:tab1} on page \pageref{bib:fld:tab1}. The \prm{definitions} are \keyval pairs which assign an expression to an identifier:
\begin{ltxexample}
\DefineBibliographyStrings{american}{%
@@ -4159,7 +4126,7 @@ The \prm{language} must be a language name known to the \sty{babel}/\sty{polyglo
\cmditem{NewBibliographyString}{key}
-This command declares new localization strings, \ie it initializes a new \prm{key} to be used in the
+This command declares new localisation strings, \ie it initializes a new \prm{key} to be used in the
\prm{definitions} of \cmd{DefineBibliographyStrings}. The \prm{key} argument may also be a comma"=separated
list of key names. The keys listed in \secref{aut:lng:key} are defined by default.
@@ -4173,7 +4140,7 @@ The commands and facilities presented in this section may be used to adapt the f
\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}.
+The commands in this section may be redefined with \cmd{renewcommand} in the document preamble. Those marked as <Context Sensitive> in the margin can also be customised with \cmd{DeclareDelimFormat} and are printed with \cmd{printdelim} (\secref{use:fmt:csd}). Note that all commands starting with \cmd{mk\dots} take one argument. All of these commands are defined in \path{biblatex$_$.def}.
\begin{ltxsyntax}
@@ -4195,13 +4162,13 @@ The separator inserted between <units> in the sense explained in \secref{aut:pct
\csitem{finentrypunct}
The punctuation printed at the very end of every bibliography entry, usually a period. The default definition is a period.
-\csitem{entrysetpunct}\BiberOnlyMark
+\csitem{entrysetpunct}
The punctuation printed between bibliography subentries of an entry set. The default definition is a semicolon and a space.
-\csitem{bibnamedelima}\BiberOnlyMark
+\csitem{bibnamedelima}
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
+\csitem{bibnamedelimb}
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}
@@ -4210,16 +4177,16 @@ This delimiter controls the spacing between name parts. It is inserted between t
\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
+\csitem{bibnamedelimi}
This delimiter replaces \cmd{bibnamedelima/b} after initials. Note that this only applies to initials given as such in the \file{bib} file, not to the initials automatically generated by \biblatex which use their own set of delimiters.
-\csitem{bibinitperiod}\BiberOnlyMark
+\csitem{bibinitperiod}
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
+\csitem{bibinitdelim}
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
+\csitem{bibinithyphendelim}
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}
@@ -4277,7 +4244,7 @@ The separator printed before the \bibfield{pageref} field. The default is an int
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:
+The delimiter printed instead of \cmd{multinamedelim} before the final name in a name list. The default is the localised term <and>, separated by interword spaces. Here is an example:
\begin{ltxexample}
Michel Goossens<<,>> Frank Mittelbach <<and>> Alexander Samarin
@@ -4296,16 +4263,16 @@ Jones, Edward<<, and>> Joe Williams
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.
+The delimiter printed before the localisation string <\texttt{andothers}> if a name list like \bibfield{author} or \bibfield{editor} is truncated. The default is an interword space.
\csitem{multilistdelim}
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.
+The delimiter printed instead of \cmd{multilistdelim} before the final item in a literal list. The default is the localised term <and>, separated by interword spaces. See \cmd{finalnamedelim} for further explanation.
\csitem{andmoredelim}
-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.
+The delimiter printed before the localisation string <\texttt{andmore}> if a literal list like \bibfield{publisher} or \bibfield{location} is truncated. The default is an interword space.
\csitem{multicitedelim}
The delimiter printed between citations if multiple entry keys are passed to a single citation command. The default is a semicolon plus an interword space.
@@ -4317,21 +4284,24 @@ Similar to \cmd{multicitedelim}, but used by the \cmd{supercite} command only. T
Similar to \cmd{multicitedelim}, but used by certain citation styles when <compressing> multiple citations. The default definition is a comma plus an interword space.
\csitem{textcitedelim}
-Similar to \cmd{multicitedelim}, but used by \cmd{textcite} and related commands (\secref{use:cit:cbx}). The default is a comma plus an interword space. The standard styles modify this provisional definition to ensure that the delimiter before the final citation is the localized term <and>, separated by interword spaces. See also \cmd{finalandcomma} and \cmd{finalandsemicolon} in \secref{use:fmt:lng}.
+Similar to \cmd{multicitedelim}, but used by \cmd{textcite} and related commands (\secref{use:cit:cbx}). The default is a comma plus an interword space. The standard styles modify this provisional definition to ensure that the delimiter before the final citation is the localised term <and>, separated by interword spaces. See also \cmd{finalandcomma} and \cmd{finalandsemicolon} in \secref{use:fmt:lng}.
-\csitem{nametitledelim}
-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{nametitledelim}\CSdelimMark
+The delimiter printed between the author\slash editor and the title by author-title and some verbose citation styles. The default definition inside bibliographies is \cmd{labelnamepunct} and is a comma plus an interword space otherwise.
-\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{nameyeardelim}\CSdelimMark
+The delimiter printed between the author\slash editor and the year by author-year citation styles. The default definition is an interword space.
-\csitem{nonameyeardelim}
+\csitem{namelabeldelim}\CSdelimMark
+The delimiter printed between the name\slash title and the label by alphabetic and numeric citation styles. The default definition is an interword space.
+
+\csitem{nonameyeardelim}\CSdelimMark
The delimiter printed between the substitute for the labelname when it does not exist (usually the label or title in standard styles) and the year in author-year citation styles. This is only used when there is no labelname since when the labelname exists, \cmd{nameyeardelim} is used. The default definition is an interword space.
\csitem{labelalphaothers}
A string to be appended to the non"=numeric portion of the \bibfield{labelalpha} field (\ie the field holding the citation label used by alphabetic citation styles) if the number of authors\slash editors exceeds the \opt{maxalphanames} threshold or the \bibfield{author}\slash \bibfield{editor} list was truncated in the \file{bib} file with the keyword <\texttt{and others}>. This will typically be a single character such as a plus sign or an asterisk. The default is a plus sign. This command may also be redefined to an empty string to disable this feature. In any case, it must be redefined in the preamble.
-\csitem{sortalphaothers}\BiberOnlyMark
+\csitem{sortalphaothers}
Similar to \cmd{labelalphaothers} but used in the sorting process. Setting it to a different value is advisable if the latter contains formatting commands, for example:
\begin{ltxexample}
@@ -4354,22 +4324,22 @@ The delimiter printed between the citation and the parenthetical \prm{postnote}
This command, which takes one argument, is used to format the name part <namepart> of name list fields. The default datamodel defines the name parts <family>, <given>, <prefix> and <suffix> and therefore the following macros are automatically defined:
\begin{ltxexample}
-\makebibnamefamily
-\makebibnamegiven
-\makebibnameprefix
-\makebibnamesuffix
+\mkbibnamefamily
+\mkbibnamegiven
+\mkbibnameprefix
+\mkbibnamesuffix
\end{ltxexample}
%
-For backwards compatibility with the legacy \bibtex name parts, the following are also defined:
+For backwards compatibility with the legacy \bibtex name parts, the following are also defined, will generate warnings and will set the correct macro:
\begin{ltxexample}
-\makebibnamelast
-\makebibnamefirst
-\makebibnameaffix
+\mkbibnamelast
+\mkbibnamefirst
+\mkbibnameaffix
\end{ltxexample}
\csitem{relatedpunct}
-The separator between the \bibfield{relatedtype} bibliography localization string and the data from the first related entry. Here is an example with \cmd{relatedpunct} set to a dash:
+The separator between the \bibfield{relatedtype} bibliography localisation string and the data from the first related entry. Here is an example with \cmd{relatedpunct} set to a dash:
\begin{ltxexample}
A. Smith. Title. 2000, (Orig. pub. as<<->>Origtitle)
@@ -4390,6 +4360,62 @@ Vol. E: Computer Modern Typefaces. 1986.
\end{ltxsyntax}
+
+\subsubsection{Context-sensitive Delimiters}
+\label{use:fmt:csd}
+The delimiters described in \secref{use:fmt:fmt} are globally defined. That is, no matter where you use them, they print the same thing. This is not necessarily desirable for delimiters which you might want to print different things in different contexts. Here <context> means things like <inside a text citation> or <inside a bibliography item>. For this reason, \biblatex\ provides a more sophisticated delimiter specification and user interface alongside the standard one based on normal macros defined with \cmd{newcommand}.
+
+\begin{ltxsyntax}
+
+\cmditem{DeclareDelimFormat}[context, \dots]{name, \dots}{code}
+\cmditem*{DeclareDelimFormat}*[context, \dots]{name, \dots}{code}
+
+Declares the delimiter macros in the comma"=separated list \prm{names} with the replacement test \prm{code}. If the optional comma"=separated list of \prm{contexts} is given, declare the \prm{names} only for those contexts. \prm{names} defined without any \prm{contexts} behave just like the global delimiter definitions which \cmd{newcommand} gives---just a plain macro with a replacement which can be used as \cmd{name}. However, you can also call delimiter macros defined in this way by using \cmd{printdelim}, which is context-aware. The starred version clears all \prm{context} specific declarations for all \prm{names} first.
+
+\cmditem{printdelim}[context]{name}
+
+Prints a delimiter with name \prm{name}, locally establishing a optional \prm{context} first. Without the optional \prm{context}, \cmd{printdelim} uses the currently active delimiter context.
+
+Delimiter contexts are simply a string, the value of the internal macro \cmd{blx@delimcontext} which can be set manually by the command \cmd{delimcontext}
+
+\cmditem{delimcontext}{context}
+
+Set the delimiter context to \prm{context}. This setting is not global so that delimiter contexts can be nested using the usual \latex group method.
+
+\end{ltxsyntax}
+%
+\biblatex\ has several default contexts which are established automatically in various places:
+
+\begin{description}
+\item[none] At begin document
+\item[bib] Inside a bibliography begun with \cmd{printbibliography} or inside a \cmd{usedriver}
+\item[biblist] Inside a bibliography list begun with \cmd{printbiblist}
+\item[<citecommand>] Inside a citation command \cmd{citecommand} defined with \cmd{DeclareCiteCommand}
+\end{description}
+
+For example, the defaults for \cmd{nametitledelim} are:
+
+\begin{ltxexample}[style=latex]{}
+\DeclareDelimFormat{nametitledelim}{\addcomma\space}
+\DeclareDelimFormat[textcite]{nametitledelim}{\addspace}
+\end{ltxexample}
+%
+This means that \cmd{nametitledelim} is defined globally as <\cmd{addcomma}\cmd{space}> as per the standard delimiter interface. However, in addition, the delimiter can be printed using \cmd{printdelim} which would print the same as \cmd{nametitledelim} apart from inside a \cmd{textcite}, in which it would print \cmd{addspace} which is more suitable for running text. If desired, a context can be forced with the optional argument to \cmd{printdelim}, so
+
+\begin{ltxexample}[style=latex]{}
+\printdelim[textcite]{nametitledelim}
+\end{ltxexample}
+%
+Would print \cmd{addspace} regardless of the surrounding context of the \cmd{printdelim}. Contexts are just arbitrary strings and so you can establish them at any time, using \cmd{delimcontext}. If \cmd{printdelim} finds no special value for the delimiter \prm{name} in the current context, it simply prints \cmd{name}. This means that style authors can use \cmd{printdelim} and users expecting to be able to use \cmd{renewcommand} to redefine delimiters can do so with one caveat---such a definition won't change any context-specific delimiters which are defined:
+
+\begin{ltxexample}[style=latex]{}
+\DeclareDelimFormat{delima}{X}
+\DeclareDelimFormat[textcite]{delima}{Y}
+\renewcommand*{delima}{Z}
+\end{ltxexample}
+%
+Here, \cmd{delima} always prints <Z>. \verb+\printdelim{delima}+ in any context other than <textcite> also prints \cmd{delima} and hence <Z> but in a <textcite> context prints <Y>. See the \file{04-delimiters.tex} example file that comes with \biblatex\ for more information.
+
\subsubsection{Language-specific Commands}
\label{use:fmt:lng}
@@ -4401,7 +4427,7 @@ The commands in this section are language specific. When redefining them, you ne
The language specific dash to be used for ranges of numbers.
-\csitem{bibrangessep}\BiberOnlyMark
+\csitem{bibrangessep}
The language specific separator to be used between multiple ranges.
@@ -4496,7 +4522,7 @@ The vertical space between paragraphs within an entry in the bibliography. The d
\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.}
+This counter, which is used by the localisation modules, holds the penalty used in short or abbreviated localisation strings. For example, a linebreak in expressions such as «et al.» or «ed. by» is unfortunate, but should still be possible to prevent overfull boxes. This counter is initialized to \cmd{hyphenpenalty} at load-time. The idea is making \tex treat the whole expression as if it were a single, hyphenatable word as far as line"=breaking is concerned. If you dislike such linebreaks, use a higher value. If you do not mind them at all, set this counter to zero. If you want to suppress them unconditionally, set it to <infinite> (10\,000 or higher).\footnote{The default values assigned to \cnt{abbrvpenalty}, \cnt{lownamepenalty}, and \cnt{highnamepenalty} are deliberately very low to prevent overfull boxes. This implies that you will hardly notice any effect on line-breaking if the text is set justified. If you set these counters to 10\,000 to suppress the respective breakpoints, you will notice their effect but you may also be confronted with overfull boxes. Keep in mind that line-breaking in the bibliography is often more difficult than in the body text and that you can not resort to rephrasing a sentence. In some cases it may be preferable to set the entire bibliography \cmd{raggedright} to prevent suboptimal linebreaks. In this case, even the fairly low default penalties will make a visible difference.}
\cntitem{highnamepenalty}
@@ -4553,7 +4579,7 @@ Generic command which typesets an acronym using the small caps variant of the cu
\cmditem{autocap}{character}
-Automatically converts the \prm{character} to its uppercase form if \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:
+Automatically converts the \prm{character} to its uppercase form if \biblatex's punctuation tracker would capitalize a localisation string at the current location. This command is robust. It is useful for conditional capitalization of certain strings in an entry. Note that the \prm{character} argument is a single character given in lowercase. For example:
\begin{ltxexample}
\autocap{s}pecial issue
@@ -4578,12 +4604,12 @@ This will yield <Œuvres> or <œuvres>.
\subsection[Language notes]{Language-specific Notes}
\label{use:loc}
-The facilities discussed in this section are specific to certain localization modules.
+The facilities discussed in this section are specific to certain localisation 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:
+The American localisation module uses \cmd{uspunctuation} from \secref{aut:pct:cfg} to enable <American-style> punctuation. If this feature is enabled, all trailing commas and periods after \cmd{mkbibquote} will be moved inside the quotes. If you want to disable this feature, use \cmd{stdpunctuation} as follows:
\begin{ltxexample}
\DefineBibliographyExtras{american}{%
@@ -4591,24 +4617,24 @@ The American localization module uses \cmd{uspunctuation} from \secref{aut:pct:c
}
\end{ltxexample}
%
-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.
+By default, the <American punctuation> feature is enabled by the \texttt{american} localisation module only. The above code is only required if you want American localisation without American punctuation. Since standard punctuation is the package default, it would be redundant with any other language.
It is highly advisable to always specify \texttt{american}, \texttt{british}, \texttt{australian}, etc. rather than \texttt{english} when loading the \sty{babel}/\sty{polyglossia} packages to avoid any possible confusion. Older versions of the \sty{babel} package used to treat \opt{english} as an alias for \opt{british}; more recent ones treat it as an alias for \opt{american}. The \biblatex package essentially treats \texttt{english} as an alias for \opt{american}, except for the above feature which is only enabled if \texttt{american} is requested explicitly.
\subsubsection{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.
+Handling the word <and> is more difficult in Spanish than in the other languages supported by this package because it may be <y> or <e>, depending on the initial sound of the following word. Therefore, the Spanish localisation module does not use the localisation string <\texttt{and}> but a special internal <smart and> command. The behavior of this command is controlled by the \cnt{smartand} counter.
\begin{ltxsyntax}
\cntitem{smartand}
-This counter controls the behavior of the internal <smart and> command. When set to 1, it prints <y> or <e>, depending on the context. When set to 2, it always prints <y>. When set to 3, it always prints <e>. When set to 0, the <smart and> feature is disabled. This counter is initialized to 1 at load-time and may be changed in the preamble. Note that setting this counter to a positive value implies that the Spanish localization module ignores \cmd{finalnamedelim} and \cmd{finallistdelim}.
+This counter controls the behavior of the internal <smart and> command. When set to 1, it prints <y> or <e>, depending on the context. When set to 2, it always prints <y>. When set to 3, it always prints <e>. When set to 0, the <smart and> feature is disabled. This counter is initialized to 1 at load-time and may be changed in the preamble. Note that setting this counter to a positive value implies that the Spanish localisation module ignores \cmd{finalnamedelim} and \cmd{finallistdelim}.
\csitem{forceE}
-Use this command in \file{bib} files if \biblatex gets the <and> before a certain name wrong. As its name suggests, it will enforce <e>. This command must be used in a special way to prevent confusing \bibtex. Here is an example:
+Use this command in \file{bib} files if \biblatex gets the <and> before a certain name wrong. As its name suggests, it will enforce <e>. This command must be used in a special way to be correct \bibtex datafile format. Here is an example:
\begin{lstlisting}[style=bibtex]{}
author = {Edward Jones and Eoin Maguire},
@@ -4626,12 +4652,12 @@ Similar to \cmd{forceE} but enforces <y>.
\subsubsection{Greek}
\label{use:loc:grk}
-The Greek localization module requires \utf support. It will not work with any other encoding. Generally speaking, the \biblatex package is compatible with the \sty{inputenc} package and with \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 \biblatex. However, there is one fundamental limitation. As of this writing, \biblatex has no support for switching scripts. Greek titles in the bibliography should work fine, 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.
+The Greek localisation module requires \utf support. It will not work with any other encoding. Generally speaking, the \biblatex package is compatible with the \sty{inputenc} package and with \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 \biblatex. However, there is one fundamental limitation. As of this writing, \biblatex has no support for switching scripts. Greek titles in the bibliography should work fine, but English and other titles in the bibliography may be rendered in Greek letters. If you need multi-script bibliographies, using \xelatex is the only sensible choice.
\subsubsection{Russian}
\label{use:loc:rus}
-Like the Greek localization module, the Russian module also requires \utf support. It will not work with any other encoding.
+Like the Greek localisation module, the Russian module also requires \utf support. It will not work with any other encoding.
\subsection{Usage Notes}
\label{use:use}
@@ -4656,8 +4682,6 @@ Using the \biblatex package is slightly different from using traditional \bibtex
%
With traditional \bibtex, the \cmd{bibliography} command serves two purposes. It marks the location of the bibliography and it also specifies the \file{bib} file(s). The file extension is omitted. With \biblatex, resources are specified in the preamble with \cmd{addbibresource} using the full name with \file{.bib} suffix. The bibliography is printed using the \cmd{printbibliography} command which may be used multiple times (see \secref{use:bib} for details). The document body may contain any number of citation commands (\secref{use:cit}). Processing this example file requires that a certain procedure be followed. Suppose our example file is called \path{example.tex} and our bibliographic data is in \path{bibfile.bib}. The procedure, then, is as follows:
-\paragraph{\biber}
-
\begin{enumerate}
\item Run \bin{latex} on \path{example.tex}. If the file contains any citations, \biblatex will request the respective data from \biber by writing commands to the auxiliary file \path{example.bcf}.
@@ -4666,58 +4690,16 @@ With traditional \bibtex, the \cmd{bibliography} command serves two purposes. It
\end{enumerate}
-\paragraph{\bibtex}
-
-\begin{enumerate}
-
-\item Run \bin{latex} on \path{example.tex}. If the file contains any citations, \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 \biblatex.
-\item Run \bin{latex} on \path{example.tex}. \biblatex will read the data from \path{example.bbl} and print all citations as well as the bibliography.
-
-\end{enumerate}
-
-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 the backend as far as the handling of bibliographic data is concerned.\footnote{That is, unless the \opt{defernumbers} package option is enabled. See \secref{aut:int}}
-
-\BibTeXOnlyMark Note that when using \bibtex as the backend 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 \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.
-
\subsubsection{Auxiliary Files}
\label{use:use:aux}
-\paragraph{\biber}
-
The \biblatex package uses one auxiliary \file{bcf} file only. Even if there are citation commands in a file included via \cmd{include}, you only need to run \biber on the main \file{bcf} file. All information \biber needs is in the \file{bcf} file, including information about all refsections if using multiple \env{refsection} environments (see \secref{use:use:mlt}).
-\paragraph{\bibtex}
-
-By default, the \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}) \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 \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, \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, \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 \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), \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, \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 \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.
-\BibTeXOnlyMark Note that with the \bibtex backend, \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}
@@ -4774,7 +4756,7 @@ Since giving one \cmd{printbibliography} command for each part of a subdivided b
<<\bibbysection[heading=subbibliography]>>
\end{ltxexample}
%
-When using a format with one cumulative bibliography subdivided by chapter (or any other document division) it may be more appropriate to use \env{refsegment} rather than \env{refsection} environments. The difference is that the \env{refsection} environment generates labels local to the environment while \env{refsegment} does not affect the generation of labels, hence they will be unique across the entire document. Note that when using \bibtex as the backend, \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.
+When using a format with one cumulative bibliography subdivided by chapter (or any other document division) it may be more appropriate to use \env{refsegment} rather than \env{refsection} environments. The difference is that the \env{refsection} environment generates labels local to the environment while \env{refsegment} does not affect the generation of labels, hence they will be unique across the entire document. The next example could also be given in \secref{use:use:div} because, visually, it creates one global bibliography subdivided into multiple segments.
\begin{ltxexample}
\documentclass{...}
@@ -4926,7 +4908,7 @@ An entry set is a group of entries which are cited as a single reference and lis
\paragraph{Static entry sets}
-\BiberOnlyMark Static entry sets are defined in the \file{bib} file like any other entry. When using \biber as the 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 separated list of entry keys:
+Static entry sets are defined in the \file{bib} file like any other entry. Defining an entry set is as simple as adding an entry of type \bibtype{set}. The entry has an \bibfield{entryset} field defining the members of the set as a separated list of entry keys:
\begin{lstlisting}[style=bibtex]{}
<<@Set>>{<<set1>>,
@@ -4936,36 +4918,7 @@ An entry set is a group of entries which are cited as a single reference and lis
%
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 as the backend, 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}
+\paragraph[Dynamic entry sets]{Dynamic entry sets}
Dynamic entry sets are set up and work much like static ones. The main difference is that they are defined in the document preamble or on the fly in the document body using the \cmd{defbibentryset} command from \secref{use:bib:set}:
@@ -4973,9 +4926,9 @@ Dynamic entry sets are set up and work much like static ones. The main differenc
\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.
+Dynamic entry sets in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0.
-\subsubsection[Data Containers]{Data Containers\BiberOnlyMark}
+\subsubsection[Data Containers]{Data Containers}
\label{use:use:xdat}
The \bibtype{xdata} entry type serves as a data container holding one or more fields. These fields may be inherited by other entries using the \bibfield{xdata} field. \bibtype{xdata} entries may not be cited or added to the bibliography, they only serve as a data source for other entries. This data inheritance mechanism is useful for fixed field combinations such as \bibfield{publisher}\slash \bibfield{location} and for other frequently used data:
@@ -5221,7 +5174,7 @@ The \prm{postnote} argument is handled as a field and the formatting of this fie
\subsubsection{Name Parts and Name Spacing}
\label{use:cav:nam}
-The \biblatex package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names, especially when they are using \biber as the 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 given or the family name. Each part of a name may be a single name or it may be composed of multiple names. For example, the name part \enquote*{given name} may be composed of a given and a middle name. The latter are referred to as name \emph{elements} in this section. Let's consider a simple name first: \enquote{John Edward Doe}. This name is composed of the following parts:
+The \biblatex package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names. The commands discussed in the following are documented in \secref{use:fmt:fmt,aut:fmt:fmt}. This section is meant to give an overview of how they are put together. A note on terminology: a name \emph{part} is a basic part of the name, for example the given or the family name. Each part of a name may be a single name or it may be composed of multiple names. For example, the name part \enquote*{given name} may be composed of a given and a middle name. The latter are referred to as name \emph{elements} in this section. Let's consider a simple name first: \enquote{John Edward Doe}. This name is composed of the following parts:
\begin{nameparts}
Given & John Edward \\
@@ -5310,15 +5263,45 @@ All \latex environments enclosed in \cmd{begin} and \cmd{end} form a group. This
%
This will not from a group, but otherwise works as usual. As far as \biblatex is concerned, it does not matter which syntax you use. The alternative syntax is also supported by the \env{refsegment} environment. Note that the commands \cmd{newrefsection} and \cmd{newrefsegment} do not form a group. See \secref{use:bib:sec, use:bib:seg} for details.
+\subsection{Using the fallback \bibtex\ backend}
+\label{use:bibtex}
+
+To utilise all of the features described here, \biblatex must be used with the
+\biber program as a backend. Indeed, the documentation in general assumes this. However, for a \emph{limited} subset of use cases it is possible to use the
+long-established \bibtex program (either the 7-bit \texttt{bibtex} or
+8-bit \texttt{bibtex8}) as the supporting backend. This works in much the
+same way as for \biber with the only proviso being that \bibtex is much more
+limited as a backend.
+
+Using \bibtex as the backend requires that the option \opt{backend=bibtex}
+or \opt{backend=bibtex8} is given at load time. The \biblatex package will
+then write appropriate data for use by \bibtex into the auxiliary file(s)
+and a special data file (automatically included in those to be read by
+\bibtex). The \bibtex(8) program should then be run on each auxiliary file:
+\biblatex will list all of the required files in the log.
+
+Key limitations of the \bibtex backend are:
+\begin{itemize}
+\item Sorting is global and is limited to Ascii ordering
+\item No re-encoding is possible and thus database entries must be in
+ LICR form to work reliably
+\item The data model is fixed
+\item Cross-referencing is more limited and entry sets must be written
+ into the \path{.bib} file
+\item Fixed memory capacity (using the \verb|--wolfgang| option with
+ \verb|bibtex8| is strongly recommended to minimize the likelihood of
+ an issue here)
+\end{itemize}
+
\section{Author Guide}
\label{aut}
-This part of the manual documents the author interface of the \biblatex package. The author guide covers everything you need to know in order to write new citation and bibliography styles or localization modules. You should read the user guide first before continuing with this part of the manual.
+This part of the manual documents the author interface of the \biblatex package. The author guide covers everything you need to know in order to write new citation and bibliography styles or localisation modules. You should read the user guide first before continuing with this part of the manual.
\subsection{Overview}
\label{aut:int}
-Before we get to the commands and facilities provided by \biblatex, we will have a look at some of its fundamental concepts. The \biblatex package uses auxiliary files in a special way. Most notably, the \file{bbl} file is used differently and when using \bibtex as the backend, 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:
+Before we get to the commands and facilities provided by \biblatex, we will have a look at some of its fundamental concepts. The \biblatex package uses auxiliary files in a special way. Most notably, the \file{bbl} file is used differently and there is no concept of a style-dependent \file{bst} file. With \latex's standard bibliographic facilities, a document includes any number of citation commands in the document body plus \cmd{bibliographystyle} and \cmd{bibliography}, usually towards the end of the document. The location of the former is arbitrary, the latter marks the spot where the list of references is to be printed:
\begin{ltxexample}
\documentclass{...}
@@ -5409,9 +5392,9 @@ In order to streamline the whole procedure, \biblatex essentially employs the \f
\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 (\bibtex backend) or \file{bcf} file (\biber backend), along with \cmd{citation} commands for all citations. We then wait for the backend to supply the required data. With \bibtex as a backend, since \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{latex}: The first step is similar to the traditional procedure described above: \cmd{bibstyle} and \cmd{bibdata} commands are written to th \file{bcf} file, along with \cmd{citation} commands for all citations. We then wait for the backend to supply the required data.
-\item Run \bin{biber} or \bin{bibtex}: The backend supplies those entries from the \file{bib} file which were requested by the \cmd{citation} commands in the auxiliary file. However, it does not write a printable bibliography to the \file{bbl} file, but rather a structured representation of the bibliographic data. Just like an \file{aux} file, this \file{bbl} file does not print anything when read in. It merely puts data in memory.
+\item Run \bin{biber}: The backend supplies those entries from the \file{bib} file which were requested by the \cmd{citation} commands in the auxiliary file. However, it does not write a printable bibliography to the \file{bbl} file, but rather a structured representation of the bibliographic data. Just like an \file{aux} file, this \file{bbl} file does not print anything when read in. It merely puts data in memory.
\item Run \bin{latex}: Starting with the second run, the \file{bbl} file is processed right at the beginning of the document body, just like an \file{aux} file. From this point on, all bibliographic data is available in memory so that all citations can be printed right away.\footnote{If the \opt{defernumbers} package option is enabled \biblatex uses an algorithm similar to the traditional procedure to generate numeric labels. In this case, the numbers are assigned as the bibliography is printed and then cycled through the backend auxiliary file. It will take an additional \latex run for them to be picked up in citations.} The citation commands have access to the complete bibliographic data, not only to a predefined label. The bibliography is generated from memory using the same data and may be filtered or split as required.
@@ -5429,7 +5412,7 @@ Let's consider the sample entry given above once more:
}
\end{lstlisting}
%
-With \biblatex and the \biber backend, this entry is essentially exported in the following format:
+This entry is essentially exported in the following format:
\begin{ltxexample}
\entry{companion}{book}{}
@@ -5509,7 +5492,7 @@ If a bibliography driver covers more than one entry type, this command may be us
\cmditem{DeclareBibliographyOption}[datatype]{key}[value]{code}
This command defines additional preamble options in \keyval format. The \prm{key} is the option key. The \prm{code} is arbitrary \tex code to be executed whenever the option is used. The value passed to the option is passed on to the \prm{code} as |#1|. The optional \prm{value} is a default value to be used if the bare key is given without any value. This is useful for boolean switches.
-The \prm{datatype} is a the datatype for the option. This optional parameter can only be used when using \biber which uses the value internally for various checks. If omitted, it defaults to <boolean>. For example, with a definition like the following:
+The \prm{datatype} is a the datatype for the option. If omitted, it defaults to <boolean>. For example, with a definition like the following:
\begin{ltxexample}
\DeclareBibliographyOption[boolean]{somekey}[true]{...}
@@ -5563,7 +5546,7 @@ This definition employs a \env{list} environment with hanging indentation, using
%
Some bibliography styles print labels in the bibliography. For example, a bibliography style designed for a numeric citation scheme will print the number of every entry such that the bibliography looks like a numbered list. In the first example, the first argument to \cmd{list} was empty. In this example, we need it to insert the number, which is provided by \biblatex in the \bibfield{labelnumber} field. We also employ several length registers and other facilities provided by \biblatex, see \secref{aut:fmt:ich, aut:fmt:ilc} for details. The \texttt{numeric} bibliography style uses the definition given above. The \texttt{alphabetic} style is similar, except that \textsf{\texttt{labelnumber}} is replaced by \texttt{labelalpha} and \texttt{labelnumberwidth} by \texttt{labelalphawidth}.
-Bibliography lists are handled in a similar way. \cmd{printbiblist} uses the environment named after the bibliography list by default (when using \bibtex, \cmd{printshorthands} always uses the \texttt{shorthand} environment). 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.
+Bibliography lists are handled in a similar way. \cmd{printbiblist} uses the environment named after the bibliography list by default. A typical example is given below. See \secref{aut:fmt:ich, aut:fmt:ilc} for details on the length registers and facilities used in this example.
\begin{ltxexample}
\defbibenvironment{shorthand}
@@ -5632,20 +5615,16 @@ List formats are slightly more complex. After splitting up the list into individ
{}}
\end{ltxexample}
%
-Formatting directives for names are similar to those for literal lists, but depend on the datamodel constant <nameparts> which has the default definition:
+Formatting directives for names are similar to those for literal lists.
+
+Names depend on the datamodel constant <nameparts> which has the default definition:
\begin{ltxexample}
\DeclareDatamodelConstant[type=list]{nameparts}
{prefix,family,suffix,given}
\end{ltxexample}
%
-All name formats should use the macro:
-
-\begin{ltxexample}
-\nameparts{#1}%
-\end{ltxexample}
-%
-which populates two macros for each name part defined in the datamodel:
+Inside name formats, this makes available two macros for each name part defined in the datamodel:
\begin{ltxexample}
\namepart<namepart>
@@ -5656,7 +5635,6 @@ The name formatting directive is executed once for each name in the name list. H
\begin{ltxexample}
\DeclareNameFormat{author}{%
- \nameparts{#1}%
\ifthenelse{\value{listcount}=1}
{\namepartfamily%
\ifblank{\namepartgiven}{}{\addcomma\space\namepartgiven}}
@@ -5687,7 +5665,7 @@ The entry key of an item in the \file{bib} file. This is the string used by \bib
When citing a subentry of an entry set, \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{datelabelsource}{literal\BiberOnlyMark}
+\fielditem{datelabelsource}{literal}
Holds the prefix coming before <date> of the date field name chosen by \cmd{DeclareLabeldate}. For example, if the label date field is \bibfield{eventdate}, then \bibfield{datelabelsource} will be <event>. In case \cmd{DeclareLabeldate} selects the \bibfield{date} field, then \bibfield{datelabelsource} will be defined but will be an empty string as the prefix coming before <date> in the date label name is empty. This is so that the contents of \bibfield{datelabelsource} can be used in constructing references to the field which \cmd{DeclareLabeldate} chooses. Since \cmd{DeclareLabeldate} can also select literal strings for fallbacks, if \bibfield{datelabelsource} is undefined, then either the \opt{labeldate} package option is set to false or \cmd{DeclareLabeldate} chose a literal string instead of a date field. Bear in mind that \cmd{DeclareLabeldate} can also be used to select non-date fields as a fallback and so \bibfield{datelabelsource} might contain a field name. So, in summary, the rules are
@@ -5721,7 +5699,7 @@ When citing a subentry of an entry set, \biblatex provides the data of the paren
This field holds an integer indicating the position of a set member in the entry set (starting at \texttt{1}). This field is only available in the subentries of an entry set.
-\fielditem{hash}{string\BiberOnlyMark}
+\fielditem{hash}{string}
This field is special in that it is only available locally in name formatting directives. It holds a hash string which uniquely identifies individual names in a name list. This information is available for all names in all name lists. See also \bibfield{namehash} and \bibfield{fullhash}.
@@ -5740,13 +5718,12 @@ If the \opt{backref} package option is enabled, this list holds the page numbers
\fielditem{sortinit}{literal}
This field holds the initial character of the information used during sorting.
-With \bibtex, this field is also used internally instead of \bibfield{sortinithash}.
-\fielditem{sortinithash}{string\BiberOnlyMark}
+\fielditem{sortinithash}{string}
-With \biber, this field holds a hash of the (locale-specific) Unicode Collation Algorithm primary weight of the first extended grapheme cluster (essentially the first character) of the string used during sorting. This is useful when subdividing the bibliography alphabetically and is used internally by \cmd{bibinitsep} (see \secref{use:fmt:len}).
+This field holds a hash of the (locale-specific) Unicode Collation Algorithm primary weight of the first extended grapheme cluster (essentially the first character) of the string used during sorting. This is useful when subdividing the bibliography alphabetically and is used internally by \cmd{bibinitsep} (see \secref{use:fmt:len}).
-\fielditem{clonesourcekey}{string\BiberOnlyMark}
+\fielditem{clonesourcekey}{string}
This field holds the entry key of the entry from which an entry was cloned. Clones are created for
entries which are mentioned in \bibfield{related} fields as part of related entry processing, for example.
@@ -5760,7 +5737,7 @@ entries which are mentioned in \bibfield{related} fields as part of related entr
\fielditem{labelalpha}{literal}
-When using \bibtex as the backend, a label similar to the labels generated by the \path{alpha.bst} style of traditional \bibtex. This default label consists of initials drawn from the \bibfield{labelname} list plus the last two digits of the publication year. The \bibfield{label} field may be used to override its non"=numeric portion. If the \bibfield{label} field is defined, \biblatex will use its value and append the last two digits of the publication year when generating \bibfield{labelalpha}. The \bibfield{shorthand} field may be used to override the entire label. If defined, \bibfield{labelalpha} is the \bibfield{shorthand} rather than an automatically generated label. \BiberOnlyMark With \biber, users can specify a template used to construct the alphabetic label (see \secref{aut:ctm:lab}) and the default template mirrors the format mentioned for bibtex above. A complete <alphabetic> label consists of the fields \bibfield{labelalpha} plus \bibfield{extraalpha}. Note that the \bibfield{labelalpha} and \bibfield{extraalpha} fields need to be requested with the package option \opt{labelalpha} (\secref{use:opt:pre:int}). See also \bibfield{extraalpha} as well as \cmd{labelalphaothers} in \secref{use:fmt:fmt}.
+A label similar to the labels generated by the \path{alpha.bst} style of traditional \bibtex. This default label consists of initials drawn from the \bibfield{labelname} list plus the last two digits of the publication year. The \bibfield{label} field may be used to override its non"=numeric portion. If the \bibfield{label} field is defined, \biblatex will use its value and append the last two digits of the publication year when generating \bibfield{labelalpha}. The \bibfield{shorthand} field may be used to override the entire label. If defined, \bibfield{labelalpha} is the \bibfield{shorthand} rather than an automatically generated label. Users can specify a template used to construct the alphabetic label (see \secref{aut:ctm:lab}) and the default template mirrors the format mentioned for bibtex above. A complete <alphabetic> label consists of the fields \bibfield{labelalpha} plus \bibfield{extraalpha}. Note that the \bibfield{labelalpha} and \bibfield{extraalpha} fields need to be requested with the package option \opt{labelalpha} (\secref{use:opt:pre:int}). See also \bibfield{extraalpha} as well as \cmd{labelalphaothers} in \secref{use:fmt:fmt}.
\fielditem{extraalpha}{integer}
@@ -5769,19 +5746,19 @@ The <alphabetic> citation scheme usually requires a letter to be appended to the
\listitem{labelname}{name}
The name to be printed in citations. This list is a copy of either the \bibfield{shortauthor}, the \bibfield{author}, the \bibfield{shorteditor}, the \bibfield{editor}, or the \bibfield{translator} list, which are normally checked for in this order. If no authors and editors are available, this list is undefined. Note that this list is also responsive to the \opt{use$<$name$>$}, options, see \secref{use:opt:bib}. Citation styles should use this list when printing the name in a citation. This list is provided for convenience only and does not carry any additional meaning.
-\BiberOnlyMark With \biber, this field may be customized. See \secref{aut:ctm:fld} for details.
+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, \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}
+\fielditem{labelprefix}{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, \biblatex does not assign the prefix to the \bibfield{prefixnumber} field of the respective entry. In this case, the \bibfield{prefixnumber} field is undefined.
+If the \opt{labelprefix} option of \cmd{newrefcontext} has been set in order to prefix all entries in a subbibliography with a fixed string, this string is available in the \bibfield{labelprefix} field of all affected entries. If no prefix has been set, the \bibfield{labelprefix} field of the respective entry is undefined. See the \opt{labelprefix} option of \cmd{newrefcontext} in \secref{use:bib:context} for details. If the \bibfield{shorthand} field is defined, \biblatex does not assign the prefix to the \bibfield{labelprefix} field of the respective entry. In this case, the \bibfield{labelprefix} field is undefined.
\fielditem{labeltitle}{literal}
-The printable title of a work. In some circumstances, a style might need to choose a title from a list of a possible title fields. For example, citation styles printing short titles may want to print the \bibfield{shorttitle} field if it exists but otherwise print the \bibfield{title} field. \BiberOnlyMark The list of fields to be considered when constructing \bibfield{labeltitle} may be customized. See \secref{aut:ctm:fld} for details. Note that the \bibfield{extratitle} field needs to be requested with the package option \opt{labeltitle}, see \secref{use:opt:pre:int} for details. See also \bibfield{extratitle}. Note also that the \bibfield{extratitleyear} field needs to be requested with the package option \opt{labeltitleyear}. See also \bibfield{extratitleyear}.
+The printable title of a work. In some circumstances, a style might need to choose a title from a list of a possible title fields. For example, citation styles printing short titles may want to print the \bibfield{shorttitle} field if it exists but otherwise print the \bibfield{title} field. The list of fields to be considered when constructing \bibfield{labeltitle} may be customized. See \secref{aut:ctm:fld} for details. Note that the \bibfield{extratitle} field needs to be requested with the package option \opt{labeltitle}, see \secref{use:opt:pre:int} for details. See also \bibfield{extratitle}. Note also that the \bibfield{extratitleyear} field needs to be requested with the package option \opt{labeltitleyear}. See also \bibfield{extratitleyear}.
\fielditem{extratitle}{integer}
@@ -5794,17 +5771,17 @@ It is sometimes useful, for example in author"=title citation schemes, to be abl
\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{labeldate}, see \secref{use:opt:pre:int} for details. See also \bibfield{extrayear}.
-\BiberOnlyMark With \biber, the source date field for this may be customized. See \secref{aut:ctm:fld} for details.
+The source date field for this may be customized. See \secref{aut:ctm:fld} for details.
\fielditem{labelmonth}{datepart}
The publication month, as specified in the \bibfield{date} or the \bibfield{month} field, for use in author-year labels. Note that the \bibfield{labelmonth} field needs to be requested with the package option \opt{labeldate}, see \secref{use:opt:pre:int} for details.
-\BiberOnlyMark With \biber, the source date field for this may be customized. See \secref{aut:ctm:fld} for details.
+The source date field for this may be customized. See \secref{aut:ctm:fld} for details.
\fielditem{labelday}{datepart}
The publication day, as specified in the \bibfield{date}, for use in author-year labels. Note that the \bibfield{labelday} field needs to be requested with the package option \opt{labeldate}, see \secref{use:opt:pre:int} for details.
-\BiberOnlyMark With \biber, the source date field for this may be customized. See \secref{aut:ctm:fld} for details.
+The source date field for this may be customized. See \secref{aut:ctm:fld} for details.
\fielditem{extrayear}{integer}
@@ -5815,6 +5792,8 @@ The author"=year citation scheme usually requires a letter to be appended to the
\paragraph{Date Component Fields}
\label{aut:bbx:fld:dat}
+Note that it is possible to define new date fields in the datamodel which behave exactly like the default data model date fields described in this section.
+
See \tabref{aut:bbx:fld:tab1} for an overview of how the date fields in \file{bib} files are related to the date fields provided by the style interface. When testing for a field like \bibfield{origdate} in a style, use code like:
\begin{ltxcode}
@@ -6094,6 +6073,17 @@ This section introduces the main data interface of the \biblatex package. These
\begin{ltxsyntax}
+\cmditem{DeprecateField}{field}{message}
+\cmditem{DeprecateList}{list}{message}
+\cmditem{DeprecateName}{name}{message}
+
+When an attempt is made to print \prm{field}, \prm{list}, \prm{name}, a
+deprecation warning issued with the additional \prm{message}. This aids
+style authors who are changing field names in their style. Note that the
+deprecated item must no longer be defined in the datamodel for this work;
+\prm{field}, \prm{list} or \prm{name} cannot be listed anywhere as an
+argument to \cmd{DeclareDatamodelFields}.
+
\cmditem{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.
@@ -6208,7 +6198,7 @@ contains the value of the name, \cmd{NewCount} contains the number of individual
\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}.
+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}
@@ -6225,7 +6215,7 @@ Defines the literal list format \prm{format}. This formatting directive is arbit
\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 a comma"=separated list which should be processed by \cmd{nameparts} (see example above). The default data mode defines four name part which correspond to the standard \bibtex name parts arguments:
+Defines the name list format \prm{format}. This formatting directive is arbitrary \prm{code} to be executed for every name in a list processed by \cmd{printnames}. If an \prm{entrytype} is specified, the format is specific to that type. The \prm{entrytype} argument may be a comma"=separated list of values. The individual parts of a name will be available in automatically created macros (see below). The default data mode defines four name part which correspond to the standard \bibtex name parts arguments:
\begin{argumentlist}{00}
\item[family] The family name(s), know as <last> in \bibtex. If a name consists of a single part only (for example, <Aristotle>), this part will be treated as the family name.
@@ -6234,13 +6224,7 @@ Defines the name list format \prm{format}. This formatting directive is arbitrar
\item[suffix] Any name suffices, for example Jr, Sr. Note that name suffices are referred to as the <Jr> part of the name in the \bibtex file format documentation.
\end{argumentlist}
%
-Each format should use the macro:
-
-\begin{ltxexample}
-\nameparts{#1}%
-\end{ltxexample}
-%
-which populates two macros for each name part in the datamodel for the name. So, for example, in the default data model, name formats will have defined the following macros:
+The value of the datamodel <nameparts> constant (see \secref{aut:bbx:drv}) creates two macros for each name part in the datamodel for the name. So, for example, in the default data model, name formats will have defined the following macros:
\begin{ltxexample}
\namepartprefix
@@ -6253,7 +6237,7 @@ which populates two macros for each name part in the datamodel for the name. So,
\namepartgiveni
\end{ltxexample}
%
-If a certain part of a name is not available, the corresponding macro will be empty, hence you may use \cmd{ifempty} (see \secref{aut:aux:tst}) tests to check for the individual parts of a name. The name of the name list currently being processed is available to the \prm{code} as \cmd{currentname}. Note that the formatting directive also handles the punctuation to be inserted between separate names and between the individual parts of a name. You need to check whether you are in the middle of or at the end of the list, \ie whether \cnt{listcount} is smaller than or equal to \cnt{liststop}. See also \secref{use:cav:nam}. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
+If a certain part of a name is not available, the corresponding macro will be empty, hence you may use, for example, the \sty{etoolbox} tests like \cmd{ifdefvoid} to check for the individual parts of a name. The name of the name list currently being processed is available to the \prm{code} as \cmd{currentname}. Note that the formatting directive also handles the punctuation to be inserted between separate names and between the individual parts of a name. You need to check whether you are in the middle of or at the end of the list, \ie whether \cnt{listcount} is smaller than or equal to \cnt{liststop}. See also \secref{use:cav:nam}. The starred variant of this command is similar to the regular version, except that all type-specific formats are cleared.
\cmditem{DeclareIndexFieldFormat}[entrytype, \dots]{format}{code}
\cmditem*{DeclareIndexFieldFormat}*{format}{code}
@@ -6304,20 +6288,76 @@ Declares \prm{alias} to be an alias for the name list format \prm{format}. If an
The related entries feature comprises the following components:
\begin{itemize}
\item Special fields in an entry to set up and describe relationships
-\item Optionally, localization strings to prefix the related data
+\item Optionally, localisation strings to prefix the related data
\item Macros to extract and print the related data
-\item Formats to format the localization string and related data
+\item Formats to format the localisation string and related data
\end{itemize}
%
The special fields are \bibfield{related}, \bibfield{relatedtype}, \bibfield{relatedstring} and \bibfield{relatedoptions}:
\begin{keymarglist}
\item[related] A separated list of keys of entries which are related to this entry in some way. Note the the order of the keys is important. The data from multiple related entries is printed in the order of the keys listed in this field.
-\item[relatedtype] The type of relationship. This serves three purposes. If the value of this field resolves to a localization string identifier, then the resulting localized string is printed before the data from the related entries. Secondly, if there is a macro called \texttt{related:\prm{relatedtype}}, this is used to format the data from the related entries. If no such macro exists, then the macro \texttt{related:default} is used. Lastly, if there is a format named \texttt{related:\prm{relatedtype}}, then it is used to format both the localized string and related entry data. If there is no related type specific format, the \texttt{related} format is used.
-\item[relatedstring] If an entry contains this field, then if value of the field resolves to a localization string identifier, the localization key value specified is printed before data from the related entries. If the field does not specify a localization key, its value is printed literally. If both \bibfield{relatedtype} and \bibfield{relatedstring} are present in an entry, \bibfield{relatedstring} is used for the pre-data string (but \bibfield{relatedtype} is still used to determine the macro and format to use when printing the data).
+\item[relatedtype] The type of relationship. This serves three purposes. If the value of this field resolves to a localisation string identifier, then the resulting localised string is printed before the data from the related entries. Secondly, if there is a macro called \texttt{related:\prm{relatedtype}}, this is used to format the data from the related entries. If no such macro exists, then the macro \texttt{related:default} is used. Lastly, if there is a format named \texttt{related:\prm{relatedtype}}, then it is used to format both the localised string and related entry data. If there is no related type specific format, the \texttt{related} format is used.
+\item[relatedstring] If an entry contains this field, then if value of the field resolves to a localisation string identifier, the localisation key value specified is printed before data from the related entries. If the field does not specify a localisation key, its value is printed literally. If both \bibfield{relatedtype} and \bibfield{relatedstring} are present in an entry, \bibfield{relatedstring} is used for the pre-data string (but \bibfield{relatedtype} is still used to determine the macro and format to use when printing the data).
\item[relatedoptions] A list of per"=entry options to set on the related entry (actually on the clone of the related entry which is used as a data source---the actual related entry is not modified because it might be cited directly itself).
\end{keymarglist}
-The related entry feature is enabled by default by the package option \opt{related} from \secref{use:opt:pre:gen}. The related information entry data from the related entries is included via a \cmd{usebibmacro\{related\}} call. Standard styles call this macro towards the end of each driver. Style authors should ensure the existence of (or take note of existing) localization strings which are useful as values for the \bibfield{relatedtype} field, such as \texttt{translationof} or perhaps \texttt{translatedas}. A plural variant can be identified with the localization key \prm{relatedtype}\texttt{s}. This key's corresponding string is printed whenever more than one entry is specified in \bibfield{related}. Bibliography macros and formatting directives for printing entries related by \prm{relatedtype} should be defined using the name \texttt{related:\prm{relatedtype}}. The file \path{biblatex$_$.def} contains macros and formats for some common relation types which can be used as templates. In particular, the \cmd{entrydata*} command is essential in such macros in order to make the data of the related entries available. Examples of entries using this feature can be found in the \biblatex distribution examples file \path{biblatex-examples.bib}. There are some specific formatting macros for this feature which control delimiters and separators in related entry information, see \secref{aut:fmt:fmt}.
+The related entry feature is enabled by default by the package option \opt{related} from \secref{use:opt:pre:gen}. The related information entry data from the related entries is included via a \cmd{usebibmacro\{related\}} call. Standard styles call this macro towards the end of each driver. Style authors should ensure the existence of (or take note of existing) localisation strings which are useful as values for the \bibfield{relatedtype} field, such as \texttt{translationof} or perhaps \texttt{translatedas}. A plural variant can be identified with the localisation key \prm{relatedtype}\texttt{s}. This key's corresponding string is printed whenever more than one entry is specified in \bibfield{related}. Bibliography macros and formatting directives for printing entries related by \prm{relatedtype} should be defined using the name \texttt{related:\prm{relatedtype}}. The file \path{biblatex$_$.def} contains macros and formats for some common relation types which can be used as templates. In particular, the \cmd{entrydata*} command is essential in such macros in order to make the data of the related entries available. Examples of entries using this feature can be found in the \biblatex distribution examples file \path{biblatex-examples.bib}. There are some specific formatting macros for this feature which control delimiters and separators in related entry information, see \secref{aut:fmt:fmt}.
+
+\subsubsection{Datasource Sets}
+\label{aut:ctm:dsets}
+
+It is useful to be able to define named sets of datasource field names for use in loops etc. In addition, \biber can use such sets in order to apply options and perform operations on particular sets of datasource fields. The following macros allow the user to define arbitrary sets of datasource fields, exposed to \biblatex as \sty{etoolbox} lists and to \biber in the \file{.bcf}.
+
+
+\begin{ltxsyntax}
+
+\cmditem{DeclareDatafieldSet}{name}{specification}
+
+Declare a set of datasource fields with name \prm{name}.
+
+\begin{optionlist*}
+
+\valitem{name}{set name}
+
+The name of the set.
+
+\end{optionlist*}
+
+The \prm{specification} is one or more \cmd{member} items:
+
+\cmditem{member}
+
+\begin{optionlist*}
+
+\valitem{fieldtype}{fieldtype}
+\valitem{datatype}{datatype}
+\valitem{field}{fieldname}
+
+\end{optionlist*}
+
+A \cmd{member} specification appends fields to the set. Fields can be specified by datamodel \prm{fieldtype} and/or \prm{datatype} (see \secref{aut:ctm:dm}). Alternatively, fields can be explicitly added by name using the \prm{field} option. Once defined, the set is available as an \sty{etoolbox} list called \cmd{datafieldset<setname>} and is also passed via the \file{.bcf} to \biber.
+
+For example, here are the default sets defined by \biblatex for name fields and title fields:
+
+\end{ltxsyntax}
+
+\begin{ltxexample}[style=latex]{}
+\DeclareDatafieldSet{setnames}{
+ \member[datatype=name, fieldtype=list]
+}
+
+\DeclareDatafieldSet{settitles}{
+ \member[field=title]
+ \member[field=booktitle]
+ \member[field=eventtitle]
+ \member[field=issuetitle]
+ \member[field=journaltitle]
+ \member[field=maintitle]
+ \member[field=origtitle]
+}
+\end{ltxexample}
+%
+This defines the macros \cmd{datafieldsetsetnames} and \cmd{datafieldsetsettitles} as \sty{etoolbox} lists containing the names of the member datasource fields specified.
\subsubsection{Dynamic Modification of Data}
\label{aut:ctm:map}
@@ -6334,7 +6374,7 @@ in a defined order. See the \biblatex\ manual regarding these macros:\\[2ex]
\begin{ltxsyntax}
-\cmditem{DeclareSourcemap}{specification}\BiberOnlyMark
+\cmditem{DeclareSourcemap}{specification}
Defines source data modification (mapping) rules which can be used to perform any combination of the following tasks:
@@ -6379,11 +6419,22 @@ A container for an ordered set of map \cmd{step}s, optionally restricted to part
As the same option on the parent \cmd{maps} element. This option allows an override on a per-map group basis. If this option is not specified, the default is the parent \cmd{maps} element option value. The short form \opt{overwrite} is equivalent to \kvopt{overwrite}{true}.
-\valitem{foreach}{field}
+\valitem{foreach}{loopval}
Loop over all \cmd{step}s in this \cmd{map}, setting the special variable |$MAPLOOP| %$
-to each of the comma-separated values contained in the entry field \prm{field}. This allows the user to repeat a group of \cmd{step}s for each value of another CSV field. Using regexp maps, it is possible to create a CSV field for use with this functionality. The special variable |$MAPUNIQ| %$
-may also be used the \cmd{step}s to generate a random unique string. This can be useful when creating keys for new entries.
+to each of the comma-separated values contained in \prm{loopval}. \prm{loopval} can either be the name of a datafield set defined with \cmd{DeclareDatafieldSet} (see \secref{aut:ctm:dsets}), a datasource field which is fetched and parsed as a comma"=separated values list or an explicit comma"=separated values list. \prm{loopval} is determined in this order. This allows the user to repeat a group of \cmd{step}s for each value \prm{loopval}. Using regexp maps, it is possible to create a CSV field for use with this functionality. The special variable |$MAPUNIQ| %$
+may also be used the \cmd{step}s to generate a random unique string. This can be useful when creating keys for new entries. An example:
+
+\begin{ltxexample}[style=latex]{}
+\DeclareSourcemap{
+ \maps[datatype=bibtex]{
+ \map[overwrite, foreach={author,editor, translator}]{
+ \step[fieldsource=\regexp{$MAPLOOP}, match={Smith}, replace={Jones}]
+ }
+ }
+}
+\end{ltxexample}
+% This loops over several name fields, making some textual replacememts.
\end{optionlist*}
@@ -6414,8 +6465,8 @@ A mapping step. Each step is applied sequentially to every relevant entry where
\valitem{replace}{regexp}
\valitem{fieldset}{entryfield}
\valitem{fieldvalue}{string}
-\valitem{entryclone}{string}
-\valitem{entrynew}{string}
+\valitem{entryclone}{clonekey}
+\valitem{entrynew}{entrynewkey}
\valitem{entrynewtype}{string}
\valitem{entrytarget}{string}
\boolitem[false]{entrynull}
@@ -6431,10 +6482,10 @@ For all boolean \cmd{step} options, the short form \opt{option} is equivalent to
\renewcommand{\labelitemii}{$\circ$}
\begin{itemize}
-\item If \texttt{entrynew} is set, a new entry is created with the entry key given as the value
- to \texttt{entrynew} and the entry type given in the option \texttt{entrynewtype}. This
+\item If \texttt{entrynew} is set, a new entry is created with the entry key \texttt{entrynewkey} and the entry type given in the option \texttt{entrynewtype}. This
entry is only in-scope during the processing of the current entry and can be referenced by
- \texttt{entrytarget}.
+ \texttt{entrytarget}. In \texttt{entrynewkey}, you may use standard Perl regular expression
+ backreferences to captures from a previous \texttt{match} step.
\item When a \texttt{fieldset} step has \texttt{entrytarget} set to the entrykey of an entry
created by \texttt{entrynew}, the target for the field set will be the \texttt{entrytarget} entry
rather than the entry being currently processed. This allows users to create new entries and set
@@ -6444,12 +6495,12 @@ For all boolean \cmd{step} options, the short form \opt{option} is equivalent to
as if it did not exist in the datasource. Obviously, you should
select the entries which you want to apply this to using prior
mapping steps.
-\item If \texttt{entryclone} is set, a clone of the entry is created with
- an entry key prefixed by \texttt{prefix}. Obviously this may cause
- labelling problems in author/year styles etc. and should be used with
- care. It is mainly intended for numbering issues with numeric styles and
- multiple bibliographies where the same entries occur in more than one
- bibliography.
+\item If \texttt{entryclone} is set, a clone of the entry is created with an entry key
+ \texttt{clonekey}. Obviously this may cause labelling problems in author/year styles etc.
+ and should be used with care. The cloned entry is in-scope during the processing of the
+ current entry and can be modified by passing its key as the value to \texttt{entrytarget}.
+ In \texttt{clonekey}, you may use standard Perl regular expression backreferences to
+ captures from a previous \texttt{match} step.
\item Change the \texttt{typesource} \prm{entrytype} to the
\texttt{typetarget} \prm{entrytype}, if defined. If
\texttt{final} is \texttt{true} then if the \prm{entrytype} of the entry is not \texttt{typesource}, processing of the parent \cmd{map} immediately terminates.
@@ -6488,7 +6539,7 @@ be changed (used as \texttt{fieldset}, \texttt{fieldtarget} or changed using \te
\begin{ltxsyntax}
-\cmditem{DeclareStyleSourcemap}{specification}\BiberOnlyMark
+\cmditem{DeclareStyleSourcemap}{specification}
This command sets the source mappings used by a style. Such mappings are conceptually separate from user mappings defined with \cmd{DeclareSourcemap} and are applied directly after user maps. The syntax is identical to \cmd{DeclareSourcemap}. This command is provided for style authors so that any maps defined for the style do not interfere with user maps or the default driver maps defined with \cmd{DeclareDriverSourcemap}. This command is for use in style files and can only be used once---subsequent uses will overwrite earlier definitions.
@@ -6496,7 +6547,7 @@ This command sets the source mappings used by a style. Such mappings are concept
\begin{ltxsyntax}
-\cmditem{DeclareDriverSourcemap}[datatype=driver]{specification}\BiberOnlyMark
+\cmditem{DeclareDriverSourcemap}[datatype=driver]{specification}
This command sets the driver default source mappings for the specified \prm{driver}. Such mappings are conceptually separate from user mappings defined with \cmd{DeclareSourcemap} and style mapping defined with \cmd{DeclareStyleSourcemap}. They consist of mappings which are part of the driver setup. Users should not normally need to change these. Driver default mapping are applied after user mappings (\cmd{DeclareSourcemap}) and style mappings (\cmd{DeclareStyleSourcemap}). These defaults are described in Appendix \secref{apx:maps}. The \prm{specification} is identical to that for \cmd{DeclareSourcemap} but without the \cmd{maps} elements: the \prm{specification} is just a list of \cmd{map} elements since each \cmd{DeclareDriverSourcemap} only applies to one datatype driver. See the default definitions in Appendix \secref{apx:maps} for examples.
@@ -6831,7 +6882,7 @@ These maps, respectively,
\item Set the pre-namelist \opt{useprefix} option on the \bibfield{author} name list to <false>
\end{itemize}
-\subsubsection{Data Model Specification}\BiberOnlyMark
+\subsubsection{Data Model Specification}
\label{aut:ctm:dm}
The data model which \biblatex uses consists of four main elements:
@@ -6844,7 +6895,7 @@ The data model which \biblatex uses consists of four main elements:
\item Specification of constraints which can be used to validate data against the data model
\end{itemize}
-The default data model is defined in the core \biblatex file \file{blx-dm.def} using the macros described in this section. The default data model is described in detail in \secref{bib}. The data model is used internally by \biblatex and also by the backends. The data model for the \bibtex backend is hard-coded and cannot be changed. Changing the data model is only supported for the \biber backend. In practice, changing the data model means that you can define the entrytypes and fields for your datasources and validate your data against the data model. Naturally, this is not much use unless your style supports any new entrytypes or fields and it raises issues of portability between styles (although this can be mitigated by using the dynamic data modification functionality described in \secref{aut:ctm:map}).
+The default data model is defined in the core \biblatex file \file{blx-dm.def} using the macros described in this section. The default data model is described in detail in \secref{bib}. The data model is used internally by \biblatex and also by the backend. In practice, changing the data model means that you can define the entrytypes and fields for your datasources and validate your data against the data model. Naturally, this is not much use unless your style supports any new entrytypes or fields and it raises issues of portability between styles (although this can be mitigated by using the dynamic data modification functionality described in \secref{aut:ctm:map}).
Validation against the data model means that after mapping your data sources into the data model, \biber (using its \path{--validate_datamodel} option) can check:
@@ -6867,9 +6918,9 @@ Alternatively, the name of the data model file can be different from any of the
\begin{ltxsyntax}
-\cmditem{DeclareDatamodelConstant}[options]{name}{constantdef}\BiberOnlyMark
+\cmditem{DeclareDatamodelConstant}[options]{name}{constantdef}
-Declares the \prm{name} as a datamodel constant with definition \prm{constantdef}. Such constants are typically used internally by the \biber backend.
+Declares the \prm{name} as a datamodel constant with definition \prm{constantdef}. Such constants are typically used internally by \biber.
\begin{optionlist*}
@@ -6879,7 +6930,7 @@ A constant can be a simple string (default if the \prm{type} option is omitted)
\end{optionlist*}
-\cmditem{DeclareDatamodelEntrytypes}[options]{entrytypes}\BiberOnlyMark
+\cmditem{DeclareDatamodelEntrytypes}[options]{entrytypes}
Declares the comma"=separated list of \prm{entrytypes} to be valid entrytypes in the data model. As usual in \tex csv lists, make sure each element is immediately followed by a comma or the closing brace---no extraneous whitespace.
@@ -6891,7 +6942,7 @@ This entrytype is not output to the \file{.bbl}. Typically used for special entr
\end{optionlist*}
-\cmditem{DeclareDatamodelFields}[options]{fields}\BiberOnlyMark
+\cmditem{DeclareDatamodelFields}[options]{fields}
Declares the comma"=separated list of \prm{fields} to be valid fields in the data model with associated comma"=separated \prm{options}. The \prm{type} and \prm{datatype} options are mandatory. All valid \prm{options} are:
@@ -6899,7 +6950,7 @@ Declares the comma"=separated list of \prm{fields} to be valid fields in the dat
\valitem{type}{field type}
-Set the type of the field as described in \secref{bib:fld:typ}. Is typically <field> or <list>.
+Set the type of the field as described in \secref{bib:fld:typ}, typically <field> or <list>.
\valitem{format}{field format}
@@ -6923,11 +6974,11 @@ The field can be used as a label in a bibliography or bibliography list. Specify
\end{optionlist*}
-\cmditem{DeclareDatamodelEntryfields}[entrytypes]{fields}\BiberOnlyMark
+\cmditem{DeclareDatamodelEntryfields}[entrytypes]{fields}
Declares that the comma"=separated list of \prm{fields} is valid for the comma"=separated list of \prm{entrytypes}. If \prm{entrytypes} is not given, the fields are valid for all entrytypes. As usual in \tex csv lists, make sure each element is immediately followed by a comma or the closing brace---no extraneous whitespace.
-\cmditem{DeclareDatamodelConstraints}[entrytypes]{specification}\BiberOnlyMark
+\cmditem{DeclareDatamodelConstraints}[entrytypes]{specification}
If a comma"=separated list of \prm{entrytypes} is given, the constraints apply only to those entrytypes. The \prm{specification} is an undelimited list of \cmd{constraint} directives which specify a constraint. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible.
@@ -7079,11 +7130,11 @@ This model specifies:
\subsubsection{Labels}
\label{aut:ctm:lab}
-Alphabetic styles use a label to identify bibliography entries. This label is constructed from components of the entry using a template which describes how to build the label. The template can be customised on a global or per-type basis. Label customisation requires \biber and will not work with any other backend.
+Alphabetic styles use a label to identify bibliography entries. This label is constructed from components of the entry using a template which describes how to build the label. The template can be customised on a global or per-type basis.
\begin{ltxsyntax}
-\cmditem{DeclareLabelalphaTemplate}[entrytype, \dots]{specification}\BiberOnlyMark
+\cmditem{DeclareLabelalphaTemplate}[entrytype, \dots]{specification}
Defines the alphabetic label template for the given entrytypes. If no entrytypes are specified in the first argument, then the global label template is defined. The \prm{specification} is an undelimited list of \cmd{labelelement} directives which specify the elements used to build the label. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7157,22 +7208,33 @@ For static (non-varwidth) disambiguation, treat family name name components sepa
As \opt{compound} but applies to name prefices. Only applies if the \biblatex option \kvopt{useprefix}{true}.
-\intitem{ifnames}
+\valitem{ifnames}{range}
-Only use this \cmd{field} specification if it is a name list field with \texttt{ifnames} names in it. This allows a \cmd{labelelement} to be conditionalised on name length (see below).
+Only use this \cmd{field} specification if it is a name list field with a number of names matching the \texttt{ifnames} range value. This allows a \cmd{labelelement} to be conditionalised on name length (see below). The range can specified as in the following examples:
+
+\begin{lstlisting}[language=xml]
+ifnames=3 -> Only apply to name lists containing exactly 3 names
+ifnames={2-4} -> Only apply to name lists containing minimum 2 and maximum 4 names
+ifnames={-3} -> Only apply to name lists containing at most 3 names
+ifnames={2-} -> Only apply to name lists containing at least 2 names
+\end{lstlisting}
-\intitem{names}
+\valitem{names}{range}
-By default, for name list fields, the names used range from the first name to the \cnt{maxalphanames}\slash \cnt{minalphanames} truncation. This option can be used to override this with an explicit range of names to consider. The plus <+> sign is a special end of range marker denoting the truncation point of max/minalphanames. The range seperator can be any number of characters with the Unicode Dash property. For example:
+By default, for name list fields, the names used range from the first name to the \cnt{maxalphanames}\slash \cnt{minalphanames} truncation. This option can be used to override this with an explicit range of names to consider. The plus <+> sign is a special end of range marker denoting the truncation point of max/minalphanames. The range separator can be any number of characters with the Unicode Dash property. For example:
\begin{lstlisting}[language=xml]
-name=3 -> Use first 3 names in the name list
+name=3 -> Use first 3 names in the name list
name={2-3} -> Use second and thirds names only
-name={-3} -> Same as 1-3
-name={2-} -> Use all names starting with the second name (ignoring max/minalphanames truncation)
+name={-3} -> Same as 1-3
+name={2-} -> Use all names starting with the second name (ignoring max/minalphanames truncation)
name={2-+} -> Use all names starting with the second name (respecting max/minalphanames truncation)
\end{lstlisting}
+\valitem{namessep}[empty]{string}
+
+An arbitrary string separator to put between names in a namelist.
+
\boolitem[false]{noalphaothers}
By default, \cmd{labelalphaothers} is appended to label parts derived from name lists if there are more names in the list than are shown in the label part. This option can be used to disable the default behaviour.
@@ -7349,7 +7411,7 @@ Here is another rather contrived example showing that you don't need to speciall
\literal{\%}
}
\labelelement{
- \field[strwidth=4, padchar=_]{<<labelname>>}
+ \field[namessep={/}, strwidth=4, padchar=_]{<<labelname>>}
}
\labelelement{
\field[strwidth=3, padchar=&, padside=left]{title}
@@ -7363,21 +7425,21 @@ Here is another rather contrived example showing that you don't need to speciall
which given:
\begin{lstlisting}[style=bibtex]{}
@Book{test,
- author = {XXX YY},
+ author = {XXX YY and WWW ZZ},
title = {T},
year = {2007},
}
\end{lstlisting}
would resulting a label looking like this:
\begin{verbatim}
-[>%YY__&&T07]
+[>%YY/ZZ__&&T07]
\end{verbatim}
Generating labels from fields may involve some difficulties when you have fields containing diacritics, hyphens, spaces etc. Often, you want to ignore things like separator characters or spaces when generating labels. An option is provided to customise the regular expression(s) to strip from a field before it is passed to the label generation system.
\begin{ltxsyntax}
-\cmditem{DeclareNolabel}{specification}\BiberOnlyMark
+\cmditem{DeclareNolabel}{specification}
Defines regular expressions to strip from any field before generating a label part for the field. The \prm{specification} is an undelimited list of \cmd{nolabel} directives which specify the regular expressions to remove from fields. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7400,7 +7462,7 @@ This \biber default strips punctuation, symbol, separator and control characters
\begin{ltxsyntax}
-\cmditem{DeclareNolabelwidthcount}{specification}\BiberOnlyMark
+\cmditem{DeclareNolabelwidthcount}{specification}
Defines regular expressions to ignore from any field when counting characters in fixed-width substrings. The \prm{specification} is an undelimited list of \cmd{nolabelwidthcount} directives which specify the regular expressions to ignore when counting characters for fixed-width substrings. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7417,11 +7479,11 @@ this setting is only taken into account when using fixed-width substrings
\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.
+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.
\begin{ltxsyntax}
-\cmditem{DeclareSortingScheme}[options]{name}{specification}\BiberOnlyMark
+\cmditem{DeclareSortingScheme}[options]{name}{specification}
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 \cmd{DeclareSortingScheme} command supports the following optional arguments:
@@ -7528,7 +7590,7 @@ This sorts the bibliography purely lexically by the order of the keys in the cit
%
This sorts «two» before «one», even though lexically, «one» would sort before «two». This is possible because the semantic order can be disambiguated by the further sorting on year. With the standard \opt{none} sorting scheme, the lexical order and semantic order are identical because there is nothing further to disambiguate them. This means that you can use \cmd{citeorder} just like any other sorting specification element, choosing how to further sort entries cited at the same time (in the same citation command).
-\cmditem{DeclareSortingNamekeyScheme}[schemename]{specification}\BiberOnlyMark
+\cmditem{DeclareSortingNamekeyScheme}[schemename]{specification}
Defines how the sorting keys for names are constructed. This can change the sorting order of names arbitrarily because you can choose how to put together the name parts when constructing the string to compare when sorting. The sorting key construction scheme so defined is called \prm{schemename} which defaults to «global» if this optional parameter is absent. When constructing the sorting key for a name, a sorting key for each name part is constructed and the key for each name is formed into an ordered key list with a special internal separator. The point of this option is to accommodate languages or situations where sorting of names needs to be customised (for example, Icelandic names are sometimes sorted by given names rather than by family names). This macro may be used multiple times to define schemes with different names which can then be referred to later. Sorting name key schemes can have the following scopes, in order of increasing precedence:
@@ -7689,23 +7751,65 @@ Finally, here is an example of a sorting scheme which overrides the global sorti
\begin{ltxsyntax}
-\cmditem{DeclareSortExclusion}{entrytype, \dots}{field, \dots}\BiberOnlyMark
+\cmditem{DeclareSortExclusion}{entrytype, \dots}{field, \dots}
Specifies fields to be excluded from sorting on a per-type basis. The \prm{entrytype} argument and the \prm{field} argument may be a comma"=separated list of values. A blank \prm{field} argument will clear all exclusions for this \prm{entrytype}. This command may only be used in the preamble.
-\cmditem{DeclarePresort}[entrytype, \dots]{string}\BiberOnlyMark
+\cmditem{DeclarePresort}[entrytype, \dots]{string}
Specifies a string to be used to automatically populate the \bibfield{presort} field of entries without a \bibfield{presort} field. The \bibfield{presort} may be defined globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the \prm{string} applies to the respective entry type. If not, it serves as the global default value. Specifying an \prm{entrytype} in conjunction with a blank \prm{string} will clear the type-specific setting. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble.
+\cmditem{DeclareSortTranslit}[entrytype]{specification}
+
+Languages which can be written in different scripts or alphabets often only have CLDR sorting tailoring for one script and it is expected that you transliterate into the supported script for sorting purposes. A common example is Sanskrit which is often written in academic contexts in IAST
+romanised script but which needs to be sorted in the <sa> locale which expects the Devanāgarī script. This means that it is necessary to transliterate into the sorting script internally. \cmd{DeclareSortTranslit} declares which parts of an entry you would like to transliterate for sorting purposes. Without the \prm{entrytype} parameter, the \prm{specification} applies to all entrytypes. The \prm{specification} is one or more \cmd{translit} commands:
+
+\cmditem{translit}{field or fieldset}{from}{to}
+
+Specifies that the data field \bibfield{field} or all fields in a fieldset \prm{fieldset} declared with \cmd{DeclareDatafieldSet} (see \secref{aut:ctm:dsets}) should be transliterated from script \prm{from} to script \prm{to} for sorting purposes. The field/set argument can also be <*> to apply transliteration to all fields. The valid \prm{from} and \prm{to} values are given in table \ref{tab:translit}. Note that \biblatex does not aim to support general transliteration, only those which are useful for sorting purposes. Please open a GitHub ticket for \biblatex\ if you think you need additional transliterations.
+
+An example of transliterating titles so that they sort correctly in Sanskrit:
+
+\begin{ltxexample}
+\DeclareDatafieldSet{settitles}{
+ \member[field=title]
+ \member[field=booktitle]
+ \member[field=eventtitle]
+ \member[field=issuetitle]
+ \member[field=journaltitle]
+ \member[field=maintitle]
+ \member[field=origtitle]
+}
+
+\DeclareSortTranslit{
+ \translit[settitles]{iast}{devanagari}
+}
+\end{ltxexample}
+
\end{ltxsyntax}
-\subsubsection[Bibliography List Filters]{Bibliography List Filters\BiberOnlyMark}
+\begin{table}
+\tablesetup\centering
+\begin{tabular}{lll}
+\toprule
+\sffamily\bfseries\spotcolor From
+ & \sffamily\bfseries\spotcolor To
+ & Description\\
+\midrule
+iast & devanagari & Sanskrit IAST\footnote{International Alphabet of Sanskrit Transliteration} to Devanāgarī\\
+\bottomrule
+\end{tabular}
+\caption{Valid transliteration pairs}
+\label{tab:translit}
+\end{table}
+
+\subsubsection[Bibliography List Filters]{Bibliography List Filters}
\label{aut:ctm:bibfilt}
When using customisable bibliography lists (See \secref{use:bib:biblist}), usually one wants to return in the \file{.bbl} only those entries which have the particular fields which the bibliography list is summarising. For example, when printing a normal list of shorthands, you want the list returned by \biber in the \file{.bbl} to contain only those entries which have a \bibfield{shorthand} field. This is accomplished by defining a bibliography list filter using the \cmd{DeclareBiblistFilter} command. This differs from the filters defined using \cmd{defbibfilter} (see \secref{use:bib:flt}) since the filters defined by \cmd{defbibfilter} run inside \biblatex after the \file{.bbl} has been generated. In addition, bibliography lists in the \file{.bbl} do not contain entry data, only the citation keys for the entries and so no filtering by \biblatex using \cmd{defbibfilter} is possible for bibliography lists.
\begin{ltxsyntax}
-\cmditem{DeclareBiblistFilter}{name}{specification}\BiberOnlyMark
+\cmditem{DeclareBiblistFilter}{name}{specification}
Defines a bibliography list filter with \prm{name}. The \prm{specification} consists of one or more \cmd{filter} or \cmd{filteror} macros, all of which must be satisfied for the entry to pass the filter:
@@ -7744,7 +7848,7 @@ Generating initials for name parts from a given name involves some difficulties
\begin{ltxsyntax}
-\cmditem{DeclareNoinit}{specification}\BiberOnlyMark
+\cmditem{DeclareNoinit}{specification}
Defines regular expressions to strip from names before generating initials. The \prm{specification} is an undelimited list of \cmd{noinit} directives which specify the regular expressions to remove from the name. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7774,7 +7878,7 @@ It can be useful to fine tune sorting so that it ignores certain parts of partic
\begin{ltxsyntax}
-\cmditem{DeclareNosort}{specification}\BiberOnlyMark
+\cmditem{DeclareNosort}{specification}
Defines regular expressions to strip from particular fields or types of fields when sorting. The \prm{specification} is an undelimited list of \cmd{nosort} directives which specify the regular expressions to remove from particular fields or type of field. Spaces, tabs and line endings may be used freely to visually arrange the \prm{specification}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7852,11 +7956,11 @@ Or if you wanted to ignore «The» at the beginning of any title field:
\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.
+Some of the automatically generated fields from \secref{aut:bbx:fld:lab} may be customized.
\begin{ltxsyntax}
-\cmditem{DeclareLabelname}[entrytype, \dots]{specification}\BiberOnlyMark
+\cmditem{DeclareLabelname}[entrytype, \dots]{specification}
Defines the fields to consider when generating the \bibfield{labelname} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} commands. The fields are checked in the order listed and the first field which is available will be used as \bibfield{labelname}. This is the default definition:
@@ -7872,9 +7976,9 @@ Defines the fields to consider when generating the \bibfield{labelname} field (s
%
The \bibfield{labelname} field may be customized globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the specification applies to the respective entry type. If not, it is applied globally. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble.
-\cmditem{DeclareLabeldate}[entrytype, \dots]{specification}\BiberOnlyMark
+\cmditem{DeclareLabeldate}[entrytype, \dots]{specification}
-Defines the date components to consider when generating \bibfield{labelyear}, \bibfield{labelmonth} and \bibfield{labelday} fields (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} or \cmd{literal} commands. The items are checked in the order listed and the first item which is available will be used to popluate the \bibfield{labelyear}, \bibfield{labelmonth} and \bibfield{labelday} fields. Note that the \cmd{field} items do not have to be datetype <date> in the data model so that you can create pseudo-year labels by, for example, using a \bibfield{pubstate} field contents, if available, as the year label by defining \cmd{DeclareLabeldate} suitably. Note also that a \cmd{literal} command will always be used when found and so this should always be the last thing in the list. If the value of a \cmd{literal} command is a valid localization string, then this will be resolved in the current language, otherwise the value is used as a literal string as-is. This is the default definition:
+Defines the date components to consider when generating \bibfield{labelyear}, \bibfield{labelmonth} and \bibfield{labelday} fields (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} or \cmd{literal} commands. The items are checked in the order listed and the first item which is available will be used to popluate the \bibfield{labelyear}, \bibfield{labelmonth} and \bibfield{labelday} fields. Note that the \cmd{field} items do not have to be datetype <date> in the data model so that you can create pseudo-year labels by, for example, using a \bibfield{pubstate} field contents, if available, as the year label by defining \cmd{DeclareLabeldate} suitably. Note also that a \cmd{literal} command will always be used when found and so this should always be the last thing in the list. If the value of a \cmd{literal} command is a valid localisation string, then this will be resolved in the current language, otherwise the value is used as a literal string as-is. This is the default definition:
\begin{ltxexample}
\DeclareLabeldate{%
@@ -7889,7 +7993,7 @@ Defines the date components to consider when generating \bibfield{labelyear}, \b
Note that the \bibfield{date} field is split by the backend into \bibfield{year}, \bibfield{month} which are also valid fields in the default data model. In order to support legacy data which directly sets \bibfield{year} and/or \bibfield{month}, the specification <\bibfield{date}> in \cmd{DeclareLabeldate} will also match \bibfield{year} and \bibfield{month} fields, if present.
The \bibfield{labelyear}, \bibfield{labelmonth} and \bibfield{labelday} fields may be customized globally or on a per-type basis. If the optional \prm{entrytype} argument is given, the specification applies to the respective entry type. If not, it is applied globally. The \prm{entrytype} argument may be a comma"=separated list of values. This command may only be used in the preamble. See also \secref{aut:bbx:fld:dat}.
-\cmditem{DeclareLabeltitle}[entrytype, \dots]{specification}\BiberOnlyMark
+\cmditem{DeclareLabeltitle}[entrytype, \dots]{specification}
Defines the fields to consider when generating the \bibfield{labeltitle} field (see \secref{aut:bbx:fld:lab}). The \prm{specification} is an ordered list of \cmd{field} commands. The fields are checked in the order listed and the first field which is available will be used as \bibfield{labeltitle}. This is the default definition:
@@ -7907,11 +8011,11 @@ The \bibfield{labeltitle} field may be customized globally or on a per-type basi
\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.
+\biber features a highly customizable cross-referencing mechanism with flexible data inheritance rules. This sections deals with the configuration interface. See \apxref{apx:ref} for the default configuration. A note on terminology: the \emph{child} or \emph{target} is the entry with the \bibfield{crossref} field, the \emph{parent} or \emph{source} is the entry the \bibfield{crossref} field points to. The child inherits data from the parent.
\begin{ltxsyntax}
-\cmditem{DefaultInheritance}[exceptions]{options}\BiberOnlyMark
+\cmditem{DefaultInheritance}[exceptions]{options}
Configures the default inheritance behavior. This command may only be used in the preamble. The default behavior may be customized be setting the following \prm{options}:
@@ -7929,7 +8033,7 @@ The optional \prm{exceptions} are an undelimited list of \cmd{except} directives
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
+\cmditem{DeclareDataInheritance}{source, \dots}{target, \dots}{rules}
Declares inheritance rules. The \prm{source} and \prm{target} arguments specify the parent and the child entry type. Either argument may be a single entry type, a comma"=separated list of types, or an asterisk. The asterisk matches all entry types. The \prm{rules} are an undelimited list of \cmd{inherit} and\slash or \cmd{noinherit} directives. Spaces, tabs, and line endings may be used freely to visually arrange the \prm{rules}. Blank lines are not permissible. This command may only be used in the preamble.
@@ -7941,7 +8045,7 @@ Defines an inheritance rule by mapping a \prm{source} field to a \prm{target} fi
Unconditionally prevents inheritance of the \prm{source} field.
-\csitem{ResetDataInheritance}\BiberOnlyMark
+\csitem{ResetDataInheritance}
Clears all inheritance rules defined with \cmd{DeclareDataInheritance}. This command may only be used in the preamble.
@@ -8006,6 +8110,33 @@ This rule, which applies to all entries, regardless of the source and target ent
%
This example demonstrates how to emulate traditional \bibtex's cross"=referencing mechanism. It enables inheritance by default, disables overwriting, and clears all other inheritance rules and mappings.
+In a bibliography entry, you can give an option <noinherit> where the value
+is a datafield set defined with \cmd{DeclareDatafieldSet}
+(\secref{aut:ctm:dsets}). This will block inheritance of the fields in the
+set on a per-entry basis. For example:
+
+\begin{ltxexample}
+\DeclareDatafieldSet{nobtitle}{
+ \member[field=booktitle]
+}
+\end{ltxexample}
+
+\begin{lstlisting}[style=bibtex]{}
+@INBOOK{s1,
+ OPTIONS = {noinherit=nobtitle},
+ TITLE = {Subtitle},
+ CROSSREF = {s2}
+}
+
+@BOOK{s2,
+ TITLE = {Title}
+}
+\end{lstlisting}
+%
+Here, \bibfield{s1} will not inherit the \bibfield{TITLE} of \bibfield{s2}
+as \bibfield{BOOKTITLE} as this is blocked by the datafield set given as
+the value to the \opt{noinherit} option.
+
\subsection{Auxiliary Commands}
\label{aut:aux}
@@ -8113,9 +8244,12 @@ The commands in this section are various kinds of stand"=alone tests for use in
\begin{ltxsyntax}
-\cmditem{ifempty}{arg}{true}{false}
+\cmditem{ifcaselang}[language]{true}{false}
-Fully expands \prm{arg} and then uses the \sty{etoolbox} \cmd{ifblank} test to determine whether to expand to \prm{true} or \prm{false}. This is useful for testing for emptiness of \prm{arg} regardless of whether \prm{arg} consists of macros or strings.
+Expands to \prm{true} if the the optional \prm{language} is one of those
+declared by \cmd{DeclareCaseLangs} (see \secref{aut:aux:msc}) and to
+\prm{false} otherwise. Without the optional argument, checks the current
+value of \cmd{currentlang}.
\cmditem{ifsortnamekeyscheme}{string}{true}{false}
@@ -8217,10 +8351,27 @@ This is just a particular case of the \cmd{ifuse$<$name$>$} macro below but is m
Expands to \prm{true} if the \opt{use$<$name$>$} option is enabled (either globally or for the current entry), and \prm{false} otherwise. See \secref{use:opt:bib} for details on this option.
+\cmditem{ifcrossrefsource}{true}{false}
+
+Expands to \prm{true} if the entry was inclued in the \file{.bbl} due to being referenced more than \opt{mincrossrefs} times and false otherwise. See \secref{use:opt:pre:gen}. Also expands to false if the entry was directly cited.
+
+\cmditem{ifxrefsource}{true}{false}
+
+Expands to \prm{true} if the entry was inclued in the \file{.bbl} due to being referenced more than \opt{minxrefs} times and false otherwise. See \secref{use:opt:pre:gen}. Also expands to false if the entry was directly cited.
+
\cmditem{ifsingletitle}{true}{false}
Expands to \prm{true} if there is only one work by the \opt{labelname} name in the bibliography, and to \prm{false} otherwise. If there is no \opt{labelname} name at all for the entry, then this expands to \prm{true} if there is only one work with the \opt{labeltitle} title in the bibliography and \prm{false} otherwise. If neither \opt{labelname} nor \opt{labeltitle} are set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{singletitle}.
+\cmditem{ifuniquetitle}{true}{false}
+
+Expands to \prm{true} if there is only one work with the title \opt{labeltitle} and to \prm{false} otherwise. If \opt{labeltitle} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniquetitle}.
+
+\cmditem{ifuniqueprimaryauthor}{true}{false}
+
+Expands to \prm{true} if there is only one work by the primary (first) author family
+name of \opt{labelname} and to \prm{false} otherwise. If \opt{labelname} is not set for an entry, this will always expand to \prm{false}. Note that this feature needs to be enabled explicitly with the package option \opt{uniqueprimaryauthor}.
+
\cmditem{ifandothers}{list}{true}{false}
Expands to \prm{true} if the \prm{list} is defined and has been truncated in the \file{bib} file with the keyword <\texttt{and others}>, and to \prm{false} otherwise. The \prm{list} may be a literal list or a name list.
@@ -8351,7 +8502,7 @@ Similar to \cmd{ifpages}, but uses the value of a \prm{field} rather than a lite
\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}.
+Expands to \prm{true} if the \prm{string} is a known localisation key, and to \prm{false} otherwise. The localisation keys defined by default are listed in \secref{aut:lng:key}. New ones may be defined with \cmd{NewBibliographyString}.
\cmditem{ifbibxstring}{string}{true}{false}
@@ -8367,7 +8518,7 @@ Expands to \prm{true} if a driver for the \prm{entrytype} is available, and to \
\cmditem{ifcapital}{true}{false}
-Executes \prm{true} if \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.
+Executes \prm{true} if \biblatex's punctuation tracker would capitalize a localisation string at the current location, and \prm{false} otherwise. This command is robust. It may be useful for conditional capitalization of certain parts of a name in a formatting directive.
\cmditem{ifcitation}{true}{false}
@@ -8397,10 +8548,10 @@ Expands to \prm{true} when located in a footnote, and to \prm{false} otherwise.
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
+\cntitem{uniquename}
This counter refers to the \bibfield{labelname} list. It is set on a per-name basis. Its value is \texttt{0} if the 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
+\cntitem{uniquelist}
This counter refers to the \bibfield{labelname} list. It is set on a per-field basis. Its value indicates the number of names required to disambiguate the name list if automatic \cnt{maxnames}\slash \cnt{minnames} truncation would lead to ambiguous citations. For example, if there is one work by <Doe\slash Smith\slash Johnson> and another one by <Doe\slash Edwards\slash Williams>, setting \kvopt{maxnames}{1} would lead to <Doe et al.> in both cases. In this case, \cnt{uniquelist} would be set to \texttt{2} on the \bibfield{labelname} lists of both entries because at least the first two names are required to disambiguate them. Note that the \cnt{uniquelist} counter is local to \cmd{printnames} and that it is only set for the \bibfield{labelname} list and to the name list \bibfield{labelname} has been derived from (typically \bibfield{author} or \bibfield{editor}). Its value is zero in any other context. If available, the \cnt{uniquelist} value will be used automatically by \cmd{printnames} when processing the name list, \ie it will automatically override \cnt{maxnames}\slash \cnt{minnames}. This feature needs to be enabled explicitly with the package option \opt{uniquelist}. See \secref{aut:cav:amb} for further details and practical examples.
\cntitem{parenlevel}
@@ -8483,27 +8634,27 @@ This command executes the macro \prm{name}, as defined with \cmd{newbibmacro}. I
\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.
+These commands save and restore any \prm{command}, which must be a command name starting with a backslash. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savebibmacro}{name}
\cmditem{restorebibmacro}{name}
-These commands save and restore the macro \prm{name}, where \prm{name} is the identifier of a macro defined with \cmd{newbibmacro}. Both commands work within a local scope. They are mainly provided for use in localization files.
+These commands save and restore the macro \prm{name}, where \prm{name} is the identifier of a macro defined with \cmd{newbibmacro}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savefieldformat}[entry type]{format}
\cmditem{restorefieldformat}[entry type]{format}
-These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareFieldFormat}. Both commands work within a local scope. They are mainly provided for use in localization files.
+These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareFieldFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savelistformat}[entry type]{format}
\cmditem{restorelistformat}[entry type]{format}
-These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareListFormat}. Both commands work within a local scope. They are mainly provided for use in localization files.
+These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareListFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{savenameformat}[entry type]{format}
\cmditem{restorenameformat}[entry type]{format}
-These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareNameFormat}. Both commands work within a local scope. They are mainly provided for use in localization files.
+These commands save and restore the formatting directive \prm{format}, as defined with \cmd{DeclareNameFormat}. Both commands work within a local scope. They are mainly provided for use in localisation files.
\cmditem{ifbibmacroundef}{name}{true}{false}
@@ -8551,7 +8702,7 @@ Similar to \cmd{MakeUppercase} but only coverts the first printable character in
\cmditem{MakeSentenceCase}{text}
\cmditem*{MakeSentenceCase*}{text}
-Converts its \prm{text} argument to sentence case, \ie the first word is capitalized and the remainder of the string is converted to lowercase. This command is robust. The starred variant differs from the regular version in that it considers the language of the entry, as specified in the \bibfield{langid} field. It only converts the \prm{text} to sentence case if the \bibfield{langid} 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:
+Converts its \prm{text} argument to sentence case, \ie the first word is capitalized and the remainder of the string is converted to lowercase. This command is robust. The starred variant differs from the regular version in that it considers the language of the entry, as specified in the \bibfield{langid} field. If the \bibfield{langid} field is defined and holds a language declared with \cmd{DeclareCaseLangs} (see below)\footnote{By default, converting to sentence case is enabled for the following language identifiers: \texttt{american}, \texttt{british}, \texttt{canadian}, \texttt{english}, \texttt{australian}, \texttt{newzealand} as well as the aliases \texttt{USenglish} and \texttt{UKenglish}. Use \cmd{DeclareCaseLangs} to extend or change this list.}, then the sentence case conversion is performed. If the \bibfield{langid} field is undefined, then the language list declared with \cmd{DeclareCaseLangs} is checked for the presence of the main document language derived from the \opt{language} option. If found, sentence case conversion is performed, if not, the \prm{text} is not altered in any way. It is recommended to use \cmd{MakeSentenceCase*} rather than the regular variant in formatting directives. Both variants support the traditional \bibtex convention for \file{bib} files that anything wrapped in a pair of curly braces is not modified when changing the case. For example:
\begin{ltxexample}
\MakeSentenceCase{an Introduction to LaTeX}
@@ -8633,7 +8784,7 @@ The optional argument \bibfield{bookpagination} is omissible in this case.
\cmditem{mkcomprange}[postpro]{text}
\cmditem*{mkcomprange*}[postpro]{text}
-This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and compress them. For example, «125--129» may be formatted as «125--9». You may configure the behavior of \cmd{mkcomprange} by adjusting the \latex counters \cnt{mincomprange}, \cnt{maxcomprange}, and \cnt{mincompwidth}, as illustrated in \tabref{aut:aux:tab1}. The default settings are \texttt{10}, \texttt{100000}, and \texttt{1}, respectively. This means that the command tries to compress as much as possible by default. Use \cmd{setcounter} to adjust the parameters. The scanner recognizes \cmd{bibrangedash} and hyphens as range dashes. It will normalize the dash by replacing any number of consecutive hyphens with \cmd{bibrangedash}. Lists of ranges delimited with \cmd{bibrangessep} (\biber\footnote{\biber will always convert commas/semicolon multi-range separators into \cmd{bibrangessep} so that it can be controlled in the style.}) or commas/semicolons (BibTeX) are also supported. With \biber, the scanner will normalise any comma or semi-colons surrounded by optional space by replacing them with \cmd{bibrangessep}. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This is important if you want to combine \cmd{mkcomprange} with other formatting macros which also need to parse their \prm{text} argument, such as \cmd{mkpageprefix}. Simply nesting these commands will not work as expected. Use the \prm{postpro} argument to set up the processing chain as follows:
+This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and compress them. For example, «125--129» may be formatted as «125--9». You may configure the behavior of \cmd{mkcomprange} by adjusting the \latex counters \cnt{mincomprange}, \cnt{maxcomprange}, and \cnt{mincompwidth}, as illustrated in \tabref{aut:aux:tab1}. The default settings are \texttt{10}, \texttt{100000}, and \texttt{1}, respectively. This means that the command tries to compress as much as possible by default. Use \cmd{setcounter} to adjust the parameters. The scanner recognizes \cmd{bibrangedash} and hyphens as range dashes. It will normalize the dash by replacing any number of consecutive hyphens with \cmd{bibrangedash}. Lists of ranges delimited with \cmd{bibrangessep} are also supported. The backend will normalise any comma or semi-colons surrounded by optional space by replacing them with \cmd{bibrangessep}. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This is important if you want to combine \cmd{mkcomprange} with other formatting macros which also need to parse their \prm{text} argument, such as \cmd{mkpageprefix}. Simply nesting these commands will not work as expected. Use the \prm{postpro} argument to set up the processing chain as follows:
\begin{ltxexample}
\DeclareFieldFormat{postnote}{\mkcomprange[<<{>>\mkpageprefix[pagination]<<}>>]{#1}}
@@ -8656,7 +8807,7 @@ p. 5, pp. 123-9, pp. 423-39
\cmditem{mkfirstpage}[postpro]{text}
\cmditem*{mkfirstpage*}[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 only. The scanner recognizes \cmd{bibrangedash} and hyphens as range dashes. Lists of ranges delimited with \cmd{bibrangessep} (\biber\footnote{\biber will always convert commas/semicolon multi-range separators into \cmd{bibrangessep} so that it can be controlled in the style.}) or commas/semicolons (BibTeX) are also supported. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. See \cmd{mkcomprange} on how to use this argument. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. For example:
+This command, which is intended for use in field formatting directives, will parse its \prm{text} argument for page ranges and print the start page of the range only. The scanner recognizes \cmd{bibrangedash} and hyphens as range dashes. Lists of ranges delimited with \cmd{bibrangessep} are also supported. If you want to hide a character from the list/range scanner for some reason, wrap the character or the entire string in curly braces. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. See \cmd{mkcomprange} on how to use this argument. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. For example:
\begin{ltxexample}
\mkfirstpage[\mkpageprefix]{5, 123-129, 423-439}
@@ -8670,26 +8821,9 @@ pp. 5, 123, 423
p. 5, p. 123, p. 423
\end{ltxexample}
-\cmditem{rangelen}{text}
-
-This command will parse its argument as a range and return the length of the range. It will return -1 for open-ended ranges.
-
-\begin{ltxexample}
-\rangelen{5-10} returns '5'
-\rangelen{-10} returns '0'
-\rangelen{5-} returns '0'
-\rangelen{5} returns '1'
-\end{ltxexample}
-%
-This can be used as part of tests in styles which require, for example, <f> as a suffix for ranges of only two pages as when a page range <36-37> should be printed as <36f>. This could be done using \cmd{ifnumcomp}:
-
-\begin{ltxexample}
-\ifnumcomp{\rangelen{\thefield{pages}}}{=}{1}{add 'f'}{do nothing}
-\end{ltxexample}
-
-\cmditem{frangelen}{rangefield}\BiberOnlyMark
+\cmditem{rangelen}{rangefield}
-Takes the name of a bibfield declared as a range field in the data model and returns the length of the range. This is calculated by \biber, can handle many special cases and is generally more robust than \cmd{rangelen}. It will return -1 for open ended ranges. Specifically \cmd{frangelen} can:
+Takes the name of a bibfield declared as a range field in the data model and returns the length of the range. This is calculated by \biber and can handle many special cases. It will return $-1$ for open ended ranges. Specifically \cmd{rangelen} can:
\begin{itemize}
\item Calculate the total of multiple ranges in the same field such as <1-10, 20-30>
@@ -8700,23 +8834,23 @@ Takes the name of a bibfield declared as a range field in the data model and ret
Here are some examples:
\begin{tabular}{ll}
-pages = <10> & |\frangelen{pages}| returns '1'\\
-pages = <10-15> & |\frangelen{pages}| returns '6'\\
-pages = <10-15,47-53> & |\frangelen{pages}| returns '13'\\
-pages = <10-> & |\frangelen{pages}| returns '-1'\\
-pages = <-10> & |\frangelen{pages}| returns '-1'\\
-pages = <48-9> & |\frangelen{pages}| returns '2'\\
-pages = <172-77> & |\frangelen{pages}| returns '6'\\
-pages = <i-vi> & |\frangelen{pages}| returns '6'\\
-pages = <X-XX> & |\frangelen{pages}| returns '11'\\
-pages = <ⅥⅠ-ⅻ> & |\frangelen{pages}| returns '6'\\
-pages = <ⅥⅠ-ⅻ, 145-7, 135-39> & |\frangelen{pages}| returns '14'
+pages = <10> & |\rangelen{pages}| returns '1'\\
+pages = <10-15> & |\rangelen{pages}| returns '6'\\
+pages = <10-15,47-53> & |\rangelen{pages}| returns '13'\\
+pages = <10-> & |\rangelen{pages}| returns '-1'\\
+pages = <-10> & |\rangelen{pages}| returns '-1'\\
+pages = <48-9> & |\rangelen{pages}| returns '2'\\
+pages = <172-77> & |\rangelen{pages}| returns '6'\\
+pages = <i-vi> & |\rangelen{pages}| returns '6'\\
+pages = <X-XX> & |\rangelen{pages}| returns '11'\\
+pages = <ⅥⅠ-ⅻ> & |\rangelen{pages}| returns '6'\\
+pages = <ⅥⅠ-ⅻ, 145-7, 135-39> & |\rangelen{pages}| returns '14'
\end{tabular}
-As with \cmd{rangelen}, \cmd{frangelen} can be used in tests:
+The \cmd{rangelen} command can be used in tests:
\begin{ltxexample}
-\ifnumcomp{\frangelen{pages}}{=}{1}{add 'f'}{do nothing}
+\ifnumcomp{\rangelen{pages}}{=}{1}{add 'f'}{do nothing}
\end{ltxexample}
\cmditem{DeclareNumChars}{characters}
@@ -8768,12 +8902,11 @@ Use this command to temporarily redefine any commands which interfere with the t
\cmditem{DeclareCaseLangs}{languages}
\cmditem*{DeclareCaseLangs*}{languages}
-Defines the list of languages which are considered by the \cmd{MakeSentenceCase*} command as it converts a string to sentence case. The \prm{languages} argument is a comma"=separated list of \sty{babel}/\sty{polyglossia} 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:
+Defines the list of languages which are considered by the \cmd{MakeSentenceCase*} command as it converts a string to sentence case. The \prm{languages} argument is a comma"=separated list of \sty{babel}/\sty{polyglossia} language identifiers. The regular version of this command replaces the current setting, the starred version appends its argument to the current list. The default setting is:
\begin{ltxexample}
\DeclareCaseLangs{%
- american,british,canadian,english,australian,newzealand,
- USenglish,UKenglish}
+ american,british,canadian,english,australian,newzealand,USenglish,UKenglish}
\end{ltxexample}
%
See the \sty{babel}/\sty{polyglossia} manuals and \tabref{bib:fld:tab1} for a list of languages identifiers.
@@ -8782,10 +8915,6 @@ See the \sty{babel}/\sty{polyglossia} manuals and \tabref{bib:fld:tab1} for a li
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 separately. 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.
@@ -8803,7 +8932,7 @@ These commands activate or deactivate the \texttt{backref} tracker locally. They
\subsection[Punctuation]{Punctuation and Spacing}
\label{aut:pct}
-The \biblatex package provides elaborate facilities designed to manage and track punctuation and spacing in the bibliography and in citations. These facilities work on two levels. The high"=level commands discussed in \secref{aut:pct:new} deal with punctuation and whitespace inserted by the bibliography style between the individual segments of a bibliography entry. The commands in \secref{aut:pct:chk, aut:pct:pct, aut:pct:spc} work at a lower level. They use \tex's space factor and modified space factor codes to track punctuation in a robust and efficient way. This way it is possible to detect trailing punctuation marks within fields, not only those explicitly inserted between fields. The same technique is also used for automatic capitalization of 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.
+The \biblatex package provides elaborate facilities designed to manage and track punctuation and spacing in the bibliography and in citations. These facilities work on two levels. The high"=level commands discussed in \secref{aut:pct:new} deal with punctuation and whitespace inserted by the bibliography style between the individual segments of a bibliography entry. The commands in \secref{aut:pct:chk, aut:pct:pct, aut:pct:spc} work at a lower level. They use \tex's space factor and modified space factor codes to track punctuation in a robust and efficient way. This way it is possible to detect trailing punctuation marks within fields, not only those explicitly inserted between fields. The same technique is also used for automatic capitalization of localisation strings, see \cmd{DeclareCapitalPunctuation} in \secref{aut:pct:cfg} as well as \secref{aut:str} for details. Note that these facilities are only made available locally in citations and bibliographies. They will not affect any other part of a document.
\subsubsection{Block and Unit Punctuation}
\label{aut:pct:new}
@@ -9003,13 +9132,13 @@ This definition is restored automatically whenever the \opt{autopunct} package o
\cmditem{DeclareCapitalPunctuation}{characters}
-When \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 precedes a string. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. The package default is:
+When \biblatex inserts localisation strings, \ie key terms such as <edition> or <volume>, it automatically capitalizes them after terminal punctuation marks. This command defines the punctuation marks which will cause localisation strings to be capitalized if one of them precedes a string. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. The package default is:
\begin{ltxexample}
\DeclareCapitalPunctuation{.!?}
\end{ltxexample}
%
-Using \cmd{DeclareCapitalPunctuation} with an empty argument is equivalent to disabling automatic capitalization. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a 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).
+Using \cmd{DeclareCapitalPunctuation} with an empty argument is equivalent to disabling automatic capitalization. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. By default, strings are capitalized after periods, exclamation marks, and question marks. All strings are generally capitalized at the beginning of a paragraph (in fact whenever \tex is in vertical mode).
\cmditem{DeclarePunctuationPairs}{identifier}{characters}
@@ -9031,7 +9160,7 @@ The \prm{identifier} selects the command to be configured. The identifiers corre
\DeclarePunctuationPairs{question}{*}
\end{ltxexample}
%
-Since this feature is language specific, \cmd{DeclarePunctuationPairs} must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a 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.}
+Since this feature is language specific, \cmd{DeclarePunctuationPairs} must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. Note that some localisation modules may use a setup which is different from the package default.\footnote{As of this writing, the \texttt{american} module uses different settings for <American-style> punctuation.}
\cmditem{DeclareQuotePunctuation}{characters}
@@ -9041,7 +9170,7 @@ This command controls <American-style> punctuation. The \cmd{mkbibquote} wrapper
\DeclareQuotePunctuation{.,}
\end{ltxexample}
%
-Executing |\DeclareQuotePunctuation{}| is equivalent to disabling this feature. This is the package default. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localization module). See \secref{use:lng, aut:lng} for details. See also \secref{use:loc:us}.
+Executing |\DeclareQuotePunctuation{}| is equivalent to disabling this feature. This is the package default. Since this feature is language specific, this command must be used in the argument to \cmd{DefineBibliographyExtras} (when used in the preamble) or \cmd{DeclareBibliographyExtras} (when used in a localisation module). See \secref{use:lng, aut:lng} for details. See also \secref{use:loc:us}.
\csitem{uspunctuation}
@@ -9056,17 +9185,17 @@ Undoes the settings applied by \cmd{uspunctuation}, restoring standard punctuati
\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 paragraph as far as capitalization is concerned, but \tex is not in vertical mode at this point) or punctuation after periods which are not really end"=of"=sentence periods (for example, after an ellipsis like «[\dots\unkern]» a command such as \cmd{addperiod} would do nothing since parentheses and brackets are transparent to the punctuation tracker). In such cases, use the following commands in bibliography and citation styles to mark the beginning or middle of a sentence if and where required:
+The facilities for punctuation tracking and automatic capitalization are very reliable under normal circumstances, but there are always marginal cases which may require manual intervention. Typical cases are localisation strings printed as the first word in a footnote (which is usually treated as the beginning of a paragraph as far as capitalization is concerned, but \tex is not in vertical mode at this point) or punctuation after periods which are not really end"=of"=sentence periods (for example, after an ellipsis like «[\dots\unkern]» a command such as \cmd{addperiod} would do nothing since parentheses and brackets are transparent to the punctuation tracker). In such cases, use the following commands in bibliography and citation styles to mark the beginning or middle of a sentence if and where required:
\begin{ltxsyntax}
\csitem{bibsentence}
-This command marks the beginning of a sentence. A 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.
+This command marks the beginning of a sentence. A localisation string immediately after this command will be capitalized and the punctuation tracker is reset, \ie this command hides all preceding punctuation marks from the punctuation tracker and enforces capitalization.
\csitem{midsentence}
-This command marks the middle of a sentence. A 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.
+This command marks the middle of a sentence. A localisation string immediately after this command will not be capitalized and the punctuation tracker is reset, \ie this command hides all preceding punctuation marks from the punctuation tracker and suppresses capitalization.
\csitem*{midsentence*}
@@ -9077,14 +9206,14 @@ The starred variant of \cmd{midsentence} differs from the regular one in that a
\subsection{Localization Strings}
\label{aut:str}
-Localization strings are key terms such as <edition> or <volume> which are automatically translated by \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.
+Localization strings are key terms such as <edition> or <volume> which are automatically translated by \biblatex's localisation modules. See \secref{aut:lng} for an overview and \secref{aut:lng:key} for a list of all strings supported by default. The commands in this section are used to print the localised term.
\begin{ltxsyntax}
\cmditem{bibstring}[wrapper]{key}
-Prints the 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}.
+Prints the localisation string \prm{key}, where \prm{key} is an identifier in lowercase letters (see \secref{aut:lng:key}). The string will be capitalized as required, see \secref{aut:pct:cfg} for details.
+Depending on the \opt{abbreviate} package option from \secref{use:opt:pre:gen}, \cmd{bibstring} prints the short or the long version of the string. If localisation strings are nested, \ie if \cmd{bibstring} is used in another string, it will behave like \cmd{bibxstring}.
If the \prm{wrapper} argument is given, the string is passed to the \prm{wrapper} for formatting. This is intended for font commands such as \cmd{emph}.
\cmditem{biblstring}[wrapper]{key}
@@ -9133,7 +9262,7 @@ 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.
+A simplified but expandable version of \cmd{bibstring}. Note that this variant does not capitalize automatically, nor does it hook into the punctuation tracker. It is intended for special cases in which strings are nested or an expanded localisation string is required in a test.
\cmditem{bibxlstring}[wrapper]{key}
@@ -9145,25 +9274,25 @@ Similar to \cmd{bibxstring} but always uses the short string, ignoring the \opt{
\cmditem{mainlang}
-Switches from the current language to the main document language. This can be used the \prm{wrapper} argument in the localization string commands above.
+Switches from the current language to the main document language. This can be used the \prm{wrapper} argument in the localisation string commands above.
\end{ltxsyntax}
\subsection{Localization Modules}
\label{aut:lng}
-A 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}/\sty{polyglossia} packages. The \file{lbx} files may also be used to map \sty{babel}/\sty{polyglossia} language names to the backend modules of the \biblatex package. All 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>.
+A localisation module provides translations for key terms such as <edition> or <volume> as well as definitions for language specific features such as the date format and ordinals. These definitions are provided in files with the suffix \file{lbx}. The base name of the file must be a language name known to the \sty{babel}/\sty{polyglossia} packages. The \file{lbx} files may also be used to map \sty{babel}/\sty{polyglossia} language names to the backend modules of the \biblatex package. All localisation modules are loaded on demand in the document body. Note that the contents of the file are processed in a group and that the category code of the character \texttt{@} is temporarily set to <letter>.
\subsubsection{Localization Commands}
\label{aut:lng:cmd}
-The user"=level versions of the 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.
+The user"=level versions of the localisation commands were already introduced in \secref{use:lng}. When used in \file{lbx} files, however, the syntax of localisation commands is different from the user syntax in the preamble and the configuration file. When used in localisation files, there is no need to specify the \prm{language} because the mapping of strings to a language is already provided by the name of the \file{lbx} file.
\begin{ltxsyntax}
\cmditem{DeclareBibliographyStrings}{definitions}
-This command is only available in \file{lbx} files. It is used to define 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:
+This command is only available in \file{lbx} files. It is used to define localisation strings. The \prm{definitions} consist of \keyval pairs which assign an expression to an identifier. A complete list of all keys supported by default is given is \secref{aut:lng:key}. Note that the syntax of the value is different in \file{lbx} files. The value assigned to a key consists of two expressions, each of which is wrapped in an additional pair of brackets. This is best shown by example:
\begin{ltxexample}
\DeclareBibliographyStrings{%
@@ -9183,7 +9312,7 @@ The first value is the long, written out expression, the second one is an abbrev
}
\end{ltxexample}
-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 punctuation. Here is an excerpt from a real localization file:
+The above examples are slightly simplified. Real localisation files should use the punctuation and formatting commands discussed in \secref{aut:pct:pct, use:fmt} instead of literal punctuation. Here is an excerpt from a real localisation file:
\begin{ltxexample}
bibliography = {{Bibliography}{Bibliography}},
@@ -9198,7 +9327,7 @@ Note the handling of abbreviation dots, the spacing in abbreviated expressions,
\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.
+This command is only available in \file{lbx} files. It copies the localisation strings for \prm{language} to the current language, as specified by the name of the \file{lbx} file.
\cmditem{DeclareBibliographyExtras}{code}
@@ -9206,7 +9335,7 @@ This command is only available in \file{lbx} files. It is used to adapt language
\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.
+This command is only available in \file{lbx} files. It is used to restore any formatting commands modified with \cmd{DeclareBibliographyExtras}. If a redefined command is included in \secref{aut:fmt:lng}, there is no need to restore its previous definition since these commands are localised by all language modules anyway.
\cmditem{InheritBibliographyExtras}{language}
@@ -9236,14 +9365,14 @@ This command maps a \sty{babel}/\sty{polyglossia} language identifier to an \fil
\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} or \cmd{DeclareBibliographyStrings}. The \prm{key} argument may also be a comma"=separated list of key names. When used in an \file{lbx}, the \prm{key} is initialized only for the language specified by the name of the \file{lbx} file. The keys listed in \secref{aut:lng:key} are defined by default.
+This command, which may be used in the preamble (including \file{cbx} and \file{bbx} files) as well as in \file{lbx} files, declares new localisation strings, \ie it initializes a new \prm{key} to be used in the \prm{definitions} of \cmd{DefineBibliographyStrings} or \cmd{DeclareBibliographyStrings}. The \prm{key} argument may also be a comma"=separated list of key names. When used in an \file{lbx}, the \prm{key} is initialized only for the language specified by the name of the \file{lbx} file. The keys listed in \secref{aut:lng:key} are defined by default.
\end{ltxsyntax}
\subsubsection{Localization Keys}
\label{aut:lng:key}
-The localization keys in this section are defined by default and covered by the localization files which come with \biblatex. Note that these strings are only available in citations, the bibliography and bibliography lists. All expressions should be capitalized as they usually are when used in the middle of a sentence. \biblatex will capitalize them automatically at the beginning of a sentence. The only exceptions to these rules are the three strings intended for use in headings.
+The localisation keys in this section are defined by default and covered by the localisation files which come with \biblatex. Note that these strings are only available in citations, the bibliography and bibliography lists. All expressions should be capitalized as they usually are when used in the middle of a sentence. \biblatex will capitalize them automatically at the beginning of a sentence. The only exceptions to these rules are the three strings intended for use in headings.
\paragraph{Headings}
\label{aut:lng:key:bhd}
@@ -9418,7 +9547,7 @@ The following keys refer to roles which are expressed as an action (<edited by>,
\item[byreviser] The expression <revised by \prm{name}>.
\item[byreviewer] The expression <reviewed by \prm{name}>.
\item[bycollaborator] An expression like <in collaboration with \prm{name}> or <in cooperation with \prm{name}>.
-\item[bytranslator] The expression <translated by \prm{name}> or <translated from \prm{language} by \prm{name}>.
+\item[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}
@@ -9714,6 +9843,7 @@ Other expressions frequently used in citations:
\item[langpolish] The language <Polish>.
\item[langportuguese] The language <Portuguese>.
\item[langrussian] The language <Russian>.
+\item[langslovak] The language <Slovak>.
\item[langslovene] The language <Slovene>.
\item[langspanish] The language <Spanish>.
\item[langswedish] The language <Swedish>.
@@ -9725,8 +9855,8 @@ The following strings are intended for use in phrases like <translated from [the
\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[fromcatalan] The expression <from [the] Catalan>.
-\item[fromczech] The expression <from [the] Czech>.
\item[fromcroatian] The expression <from [the] Croatian>.
+\item[fromczech] The expression <from [the] Czech>.
\item[fromdanish] The expression <from [the] Danish>.
\item[fromdutch] The expression <from [the] Dutch>.
\item[fromenglish] The expression <from [the] English>.
@@ -9741,6 +9871,7 @@ The following strings are intended for use in phrases like <translated from [the
\item[frompolish] The expression <from [the] Polish>.
\item[fromportuguese] The expression <from [the] Portuguese>.
\item[fromrussian] The expression <from [the] Russian>.
+\item[fromslovak] The expression <from [the] Slovak>.
\item[fromslovene] The expression <from [the] Slovene>.
\item[fromspanish] The expression <from [the] Spanish>.
\item[fromswedish] The expression <from [the] Swedish>.
@@ -9749,7 +9880,7 @@ The following strings are intended for use in phrases like <translated from [the
\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.
+Country names are localised by using the string \texttt{country} plus the \acr{ISO}-3166 country code as the key. The short version of the translation should be the \acr{ISO}-3166 country code. Note that only a small number of country names is defined by default, mainly to illustrate this scheme. These keys are used in the \bibfield{location} list of \bibtype{patent} entries but they may be useful for other purposes as well.
\begin{keymarglist}
\item[countryde] The name <Germany>, abbreviated as \texttt{DE}.
@@ -9763,7 +9894,7 @@ Country names are localized by using the string \texttt{country} plus the \acr{I
\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.
+Strings related to patents are localised by using the term \texttt{patent} plus the \acr{ISO}-3166 country code as the key. Note that only a small number of patent keys is defined by default, mainly to illustrate this scheme. These keys are used in the \bibfield{type} field of \bibtype{patent} entries.
\begin{keymarglist}
\item[patent] The generic term <patent>.
@@ -9797,10 +9928,10 @@ This section corresponds to \secref{use:fmt:fmt} in the user part of the manual.
\begin{ltxsyntax}
-\csitem{bibnamedelima}\BiberOnlyMark
+\csitem{bibnamedelima}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend after the first name element if the element is less than three characters long and before the last element. The default definition is \cmd{addhighpenspace}, \ie a space penalized by the value of the \cnt{highnamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
-\csitem{bibnamedelimb}\BiberOnlyMark
+\csitem{bibnamedelimb}
This delimiter controls the spacing between the elements which make up a name part. It is inserted automatically by the backend between all name elements where \cmd{bibnamedelima} does not apply. The default definition is \cmd{addlowpenspace}, \ie a space penalized by the value of the \cnt{lownamepenalty} counter (\secref{use:fmt:len}). Please refer to \secref{use:cav:nam} for further details.
\csitem{bibnamedelimc}
@@ -9809,16 +9940,16 @@ This delimiter controls the spacing between name parts. The default name formats
\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
+\csitem{bibnamedelimi}
This delimiter replaces \cmd{bibnamedelima/b} after initials. Note that this only applies to initials given as such in the \file{bib} file, not to the initials automatically generated by \biblatex which use their own set of delimiters.
-\csitem{bibinitperiod}\BiberOnlyMark
+\csitem{bibinitperiod}
The punctuation inserted automatically by the backend after all initials unless \cmd{bibinithyphendelim} applies. The default definition is a period (\cmd{adddot}). Please refer to \secref{use:cav:nam} for further details.
-\csitem{bibinitdelim}\BiberOnlyMark
+\csitem{bibinitdelim}
The spacing inserted automatically by the backend between multiple initials unless \cmd{bibinithyphendelim} applies. The default definition is an unbreakable interword space. Please refer to \secref{use:cav:nam} for further details.
-\csitem{bibinithyphendelim}\BiberOnlyMark
+\csitem{bibinithyphendelim}
The punctuation inserted automatically by the backend between the initials of hyphenated name parts, replacing \cmd{bibinitperiod} and \cmd{bibinitdelim}. The default definition is a period followed by an unbreakable hyphen. Please refer to \secref{use:cav:nam} for further details.
\csitem{bibindexnamedelima}
@@ -9876,7 +10007,7 @@ Use this command instead of \cmd{multinamedelim} before the final name in a name
The extra delimiter to be printed after the first name in a name list consisting of two names (in addition to \cmd{finalnamedelim}) if the first name is reversed. This command should be incorporated in all formatting directives for name lists.
\csitem{andothersdelim}
-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.
+The delimiter to be printed before the localisation string <\texttt{andothers}> if a name list like \bibfield{author} or \bibfield{editor} is truncated. This command should be incorporated in all formatting directives for name lists.
\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.
@@ -9885,7 +10016,7 @@ The delimiter to be printed between multiple items in a literal list like \bibfi
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.
+The delimiter to be printed before the localisation string <\texttt{andmore}> if a literal list like \bibfield{publisher} or \bibfield{location} is truncated. This command should be incorporated in all formatting directives for literal lists.
\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.
@@ -9905,6 +10036,9 @@ The delimiter to be printed between the author\slash editor and the title. This
\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{namelabeldelim}
+The delimiter printed between the name\slash title and the label. This command should be incorporated in the definition of all citation commands of alphabetic and numeric citation styles.
+
\csitem{nonameyeardelim}
The delimiter printed between the substitute for the labelname when it does not exist (usually the label or title in standard styles) and the year in author-year citation styles. This is only used when there is no labelname since when the labelname exists, \cmd{nameyeardelim} is used.
@@ -9920,20 +10054,20 @@ The delimiter to be printed after the \prm{postnote} argument of a citation comm
\csitem{extpostnotedelim}
The delimiter printed between the citation and the parenthetical \prm{postnote} argument of a citation command when the postnote occurs outside of the citation parentheses. In the standard styles, this occurs when the citation uses the shorthand field of the entry.
-\cmditem{mkbibnamelast}{text}
-Formatting hook for the last name, to be used in all formatting directives for name lists.
+\cmditem{mkbibnamefamily}{text}
+Formatting hook for the family 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{mkbibnamegiven}{text}
+Similar to \cmd{mkbibnamefamily}, but intended for the given 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.
+\cmditem{mkbibnamesuffix}{text}
+Similar to \cmd{mkbibnamefamily}, but intended for the name suffix.
\csitem{relatedpunct}
-The separator between the relatedtype bibliography localization string and the data from the first related entry.
+The separator between the relatedtype bibliography localisation string and the data from the first related entry.
\csitem{relateddelim}
The separator between the data of multiple related entries. The default definition is a linebreak.
@@ -9943,7 +10077,7 @@ The separator between the data of multiple related entries. The default definiti
\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.
+This section corresponds to \secref{use:fmt:lng} in the user part of the manual. The commands discussed here are usually handled by the localisation modules, but may also be redefined by users on a per"=language basis. Note that all commands starting with \cmd{mk\dots} take one or more mandatory arguments.
\begin{ltxsyntax}
@@ -10127,7 +10261,7 @@ A generic command which prints its argument as superscripted text. This is a sim
\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.
+This command takes an integer argument and prints it as a month name. Even though the output of this command is language specific, its definition is not, hence it is normally not redefined in localisation modules.
\cmditem{mkdatezeros}{integer}
@@ -10137,13 +10271,9 @@ This command strips leading zeros from a number or preserves them, depending on
This command strips leading zeros from a number. It is intended for date formatting and ordinals.
-\optitem{shorthandwidth}\BibTeXOnlyMark
+\optitem{<labelfield>width}
-A special field formatting directive which is used internally by \biblatex. When the bibliographic data is read from the \file{bbl} file, \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{<labelfield>width}\BiberOnlyMark
-
-With \biber, for every field marked as a <Label field> in the data model, a formatting directive is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
+For every field marked as a <Label field> in the data model, a formatting directive is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
\optitem{labelnumberwidth}
@@ -10202,13 +10332,9 @@ The length registers and counters discussed here are used by \biblatex to pass i
\begin{ltxsyntax}
-\lenitem{shorthandwidth}\BibTeXOnlyMark
-
-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{<labelfield>width}
-\lenitem{<labelfield>width}\BiberOnlyMark
-
-With \biber, for every field marked as a <Label field> in the data model, a length register is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
+For every field marked as a <Label field> in the data model, a length register is created as per \texttt{shorthandwidth} above. Since \bibfield{shorthand} is so marked in the default data model, this functionality is a superset of that described for \texttt{shorthandwidth}.
\lenitem{labelnumberwidth}
@@ -10287,6 +10413,14 @@ This counter holds the \prm{start} argument passed to \cmd{printnames} or \cmd{p
This counter holds the \prm{stop} argument passed to \cmd{printnames} or \cmd{printlist}. It is intended for use in list formatting directives and does not hold a meaningful value when used anywhere else.
+\csitem{currentlang}
+
+The name of the currently active language for \biblatex. Can be used anywhere and
+defaults to the main document language. This is automatically switched
+inside entries which define \bibfield{langid}, given suitable settings of the
+\opt{autolang} and \opt{language} options. Note that this does not track
+all document language changes, only the current \biblatex\ setting.
+
\csitem{currentfield}
The name of the field currently being processed by \cmd{printfield}. This information is only available locally in field formatting directives.
@@ -10314,13 +10448,13 @@ Appends the \prm{code} to an internal hook executed at the beginning of the bibl
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.
-When using \biber, this is just an alias for:
+This is just an alias for:
\begin{ltxexample}
\AtBeginBiblist{shorthand}{code}
\end{ltxexample}
-\cmditem{AtBeginBiblist}{biblistname}{code}\BiberOnlyMark
+\cmditem{AtBeginBiblist}{biblistname}{code}
Appends the \prm{code} to an internal hook executed at the beginning of the bibliography list \prm{biblistname}. The \prm{code} is executed at the beginning of the bibliography list, immediately after the \prm{begin code} of \cmd{defbibenvironment}. This command may only be used in the preamble.
@@ -10332,13 +10466,13 @@ Appends the \prm{code} to an internal hook executed at the beginning of every it
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.
-When using \biber, this is just an alias for:
+This is just an alias for:
\begin{ltxexample}
\AtEveryBiblistitem{shorthand}{code}
\end{ltxexample}
-\cmditem{AtEveryBiblistitem}{biblistname}{code}\BiberOnlyMark
+\cmditem{AtEveryBiblistitem}{biblistname}{code}
Appends the \prm{code} to an internal hook executed at the beginning of every item in the bibliography list named \prm{biblistname}. The \prm{code} is executed immediately after the \prm{item code} of \cmd{defbibenvironment}. The bibliographic data of the respective entry is available at this point. This command may only be used in the preamble.
@@ -10488,7 +10622,7 @@ External abstracts and annotations have been discussed in \secref{use:use:prf}.
%
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}
+\subsubsection[Name Disambiguation]{Name Disambiguation}
\label{aut:cav:amb}
The \opt{uniquename} and \opt{uniquelist} options introduced in \secref{use:opt:pre:int} support various modes of operation. This section explains the differences between these modes by way of example. The \opt{uniquename} option disambiguates individual names in the \bibfield{labelname} list. The \opt{uniquelist} option disambiguates the \bibfield{labelname} list if it has become ambiguous after \opt{maxnames}\slash \opt{minnames} truncation. You can use either option stand-alone or combine both.
@@ -10928,7 +11062,7 @@ We still need to handle cases in which there is no series information at all, so
\printfield{number}}}%
\end{ltxexample}
%
-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.
+One final hint: localisation strings are not literal text as far as the punctuation tracker is concerned. Since \cmd{bibstring} and similar commands interface with the punctuation tracker, there is no need to wrap them in a \cmd{printtext} command.
\paragraph{Advanced Usage}
@@ -11033,7 +11167,7 @@ Since the alternative \file{lbx} file can inherit strings from the standard \pat
\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}, \biblatex will not load \path{american.lbx} unless this module is requested explicitly. In the above example, inheriting <strings> and <extras> will cause \biblatex to load \path{american.lbx} before applying the modifications in \path{american-mla.lbx}.
+Alternative \file{lbx} files must ensure that the localisation 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}, \biblatex will not load \path{american.lbx} unless this module is requested explicitly. In the above example, inheriting <strings> and <extras> will cause \biblatex to load \path{american.lbx} before applying the modifications in \path{american-mla.lbx}.
Note that \cmd{DeclareLanguageMapping} is not intended to handle language variants (\eg American English vs. British English) or \sty{babel}/\sty{polyglossia} language aliases (\eg \texttt{USenglish} vs. \texttt{american}). For example, \sty{babel}/\sty{polyglossia} offers the \texttt{USenglish} option which is similar to \texttt{american}. Therefore, \biblatex 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}/\sty{polyglossia} language aliases happens on the file level, the point being that \biblatex's language support can be extended simply by adding additional \file{lbx} files. There is no need for centralized mapping. If you need support for, say, Portuguese (babel/polyglossia: \file{portuges}), you create a file named \path{portuges.lbx}. If \sty{babel}/\sty{polyglossia} offered an alias named \texttt{brasil}, you would create \path{brasil.lbx} and inherit the data from \path{portuges.lbx}. In contrast to that, the point of \cmd{DeclareLanguageMapping} is handling \emph{stylistic} variants like <humanities vs. natural sciences> or <\acr{mla} vs. \acr{apa}> etc. which will typically be built on top of existing \file{lbx} files.
@@ -11075,7 +11209,7 @@ In order to minimize the risk of name clashes, \latex packages typically prefix
\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}.
+\item[\texttt{lbx}] This is the recommended base prefix for internal macros defined in localisation modules. The localisation module should add a second prefix to specify the language. For example, an internal macro defined by the Spanish localisation module would be named \cmd{lbx@es@macro}.
\end{marglist}
@@ -11398,7 +11532,7 @@ ydnt & presort\alt mm &
\end{longtable}
\endgroup
-\section{\biblatexml}\BiberOnlyMark
+\section{\biblatexml}
\label{apx:biblatexml}
The \biblatexml\ XML datasource format is designed to be an extensible and modern data source format for \biblatex\ users. There are limitations with \bibtex\ format \file{.bib} files, in particular one might mention UTF-8 support and name formats. \biber\ goes some way to addressing the UTF-8 limitations by using a modified version of the \texttt{btparse} C library but the rather archaic name parsing rules for \bibtex\ are hard-coded and specific to simple Western names.
@@ -11695,9 +11829,11 @@ minalphanames &\+&\+&\+&\+\\
minbibnames &\+&\+&\+&\+\\
mincitenames &\+&\+&\+&\+\\
mincrossrefs &\+&\+&\_&\_\\
+minxrefs &\+&\+&\_&\_\\
minitems &\+&\+&\+&\+\\
minnames &\+&\+&\+&\+\\
natbib &\+&\_&\_&\_\\
+noinherit &\_&\_&\_&\+\\
notetype &\+&\+&\_&\_\\
opcittracker &\+&\+&\_&\_\\
openbib &\+&\+&\_&\_\\
@@ -11726,6 +11862,7 @@ terseinits &\+&\+&\_&\_\\
texencoding &\+&\+&\_&\_\\
uniquelist &\+&\+&\+&\+\\
uniquename &\+&\+&\+&\+\\
+uniquetitle &\+&\+&\+&\_\\
urldate &\+&\+&\_&\_\\
url &\+&\+&\_&\_\\
useprefix &\+&\+&\+&\+\\
@@ -11736,18 +11873,35 @@ use$<$name$>$ &\+&\+&\+&\+\\
\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.
+This revision history is a list of changes relevant to users of this package. Changes of a more technical nature which do not affect the user interface or the behavior of the package are not included in the list. More technical details are to be found in the CHANGES file. The numbers on the right indicate the relevant section of this manual.
\begin{changelog}
+\begin{release}{3.4}{2016-05-10}
+\item Added \cmd{ifcrossrefsource} and \cmd{ifxrefsource}\see{aut:aux:tst}
+\item Added data annotation feature\see{use:annote}
+\item Added package option \opt{minxrefs}\see{use:opt:pre:gen}
+\item Added \cmd{ifuniqueprimaryauthor} and associated global option\see{aut:aux:tst}
+\item Added \cmd{DeprecateField}, \cmd{DeprecateList} and \cmd{DeprecateName}\see{aut:bib:dat}
+\item Added \cmd{ifcaselang}\see{aut:aux:tst}
+\item Added \cmd{DeclareSortTranslit}\see{aut:ctm:srt}
+\item Added \opt{uniquetitle} test\see{aut:aux:tst}
+\item Added \cmd{namelabeldelim}\see{use:fmt:fmt}
+\item New starred variants of the \cmd{assignrefcontext*} macros\see{use:bib:context}
+\item New context-sensitive delimiter interface\see{use:fmt:csd}
+\item Moved \opt{prefixnumbers} option to \cmd{newrefcontext} and renamed to \opt{labelprefix}\see{use:bib:context}
+\item Added \cmd{DeclareDatafieldSet}\see{aut:ctm:dsets}
+\end{release}
+
\begin{release}{3.3}{2016-03-01}
-\item Schema documentation for \biblatexml\see{apx:biblatexml}\BiberOnlyMark
-\item Sourcemapping documentation and examples for \biblatexml\see{aut:ctm:map}\BiberOnlyMark
-\item Changes for name formats to generalise available name parts\see{aut:bib:fmt}\BiberOnlyMark
+\item New macros for auto-assignment of refcontexts\see{use:bib:context}
+\item Schema documentation for \biblatexml\see{apx:biblatexml}
+\item Sourcemapping documentation and examples for \biblatexml\see{aut:ctm:map}
+\item Changes for name formats to generalise available name parts\see{aut:bib:fmt}
\item \opt{useprefix} can now be specified per-namelist and per-name in \biblatexml datasources
-\item New sourcemapping options for creating new entries dynamically and looping over map steps\see{aut:ctm:map}\BiberOnlyMark
+\item New sourcemapping options for creating new entries dynamically and looping over map steps\see{aut:ctm:map}
\item Added \opt{noalphaothers} and enhanced name range selection in \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
-\item Added \cmd{DeclareDatamodelConstant}\see{aut:ctm:dm}\BiberOnlyMark
+\item Added \cmd{DeclareDatamodelConstant}\see{aut:ctm:dm}
\item Renamed \opt{firstinits} and \opt{sortfirstinits}
\item Added \cmd{DeclareSortingNamekeyScheme}\see{aut:ctm:srt}
\item Removed messy experimental endnote and zoterordf support for \biber
@@ -11756,13 +11910,13 @@ This revision history is a list of changes relevant to users of this package. Ch
\end{release}
\begin{release}{3.2}{2015-12-28}
-\item Added \opt{pstrwidth} and \opt{pcompound} to \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}\BiberOnlyMark
+\item Added \opt{pstrwidth} and \opt{pcompound} to \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
\item Added \cmd{AtEachCitekey}\see{aut:fmt:hok}
\end{release}
\begin{release}{3.1}{2015-09}
-\item Added \cmd{DeclareNolabel}\see{aut:ctm:lab}\BiberOnlyMark
-\item Added \cmd{DeclareNolabelwidthcount}\see{aut:ctm:lab}\BiberOnlyMark
+\item Added \cmd{DeclareNolabel}\see{aut:ctm:lab}
+\item Added \cmd{DeclareNolabelwidthcount}\see{aut:ctm:lab}
\end{release}
\begin{release}{3.0}{2015-04-20}
@@ -11780,20 +11934,20 @@ This revision history is a list of changes relevant to users of this package. Ch
\end{release}
\begin{release}{2.9}{2014-02-25}
-\item Generalised shorthands facility\see{use:bib:biblist}\BiberOnlyMark
-\item Sorting locales can now be defined as part of a sorting scheme\see{aut:ctm:srt}\BiberOnlyMark
-\item Added \bibfield{sortinithash}\see{aut:bbx:fld:gen}\BiberOnlyMark
+\item Generalised shorthands facility\see{use:bib:biblist}
+\item Sorting locales can now be defined as part of a sorting scheme\see{aut:ctm:srt}
+\item Added \bibfield{sortinithash}\see{aut:bbx:fld:gen}
\item Added Slovene localisation (Tea Tušar and Bogdan Filipič)
\item Added \cmd{mkbibitalic}\see{aut:fmt:ich}
\item Recommend \texttt{begentry} and \texttt{finentry} bibliography macros\see{aut:bbx:drv}
\end{release}
\begin{release}{2.8a}{2013-11-25}
-\item Split option \opt{language=auto} into \opt{language=autocite} and \opt{language=autobib}\see{use:opt:pre:gen}\BiberOnlyMark
+\item Split option \opt{language=auto} into \opt{language=autocite} and \opt{language=autobib}\see{use:opt:pre:gen}
\end{release}
\begin{release}{2.8}{2013-10-21}
-\item New \bibfield{langidopts}\see{bib:fld:spc}\BiberOnlyMark
+\item New \bibfield{langidopts}\see{bib:fld:spc}
\item \bibfield{hyphenation} field renamed to \bibfield{langid}\see{bib:fld:spc}
\item \sty{polyglossia} support
\item Renamed \opt{babel} option to \opt{autolang}\see{use:opt:pre:gen}
@@ -11816,54 +11970,54 @@ This revision history is a list of changes relevant to users of this package. Ch
\item Added multicite variants of \cmd{volcite} and related commands\see{use:cit:spc}
\item Added \cmd{finalandsemicolon}\see{use:fmt:lng}
\item Added citation delimiter \cmd{textcitedelim} for \cmd{textcite} and related commands to styles\see{aut:fmt:fmt}
-\item Updated Russian localization (Oleg Domanov)
-\item Fixed Brazilian and Finnish localization
+\item Updated Russian localisation (Oleg Domanov)
+\item Fixed Brazilian and Finnish localisation
\end{release}
\begin{release}{2.6}{2013-04-30}
\item Added \cmd{printunit}\see{aut:pct:new}
-\item Added field \bibfield{clonesourcekey}\see{aut:bbx:fld:gen}\BiberOnlyMark
-\item New options for \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}\BiberOnlyMark
-\item Added \cmd{DeclareLabeldate} and retired \cmd{DeclareLabelyear}\see{aut:ctm:fld}\BiberOnlyMark
-\item Added \texttt{nodate} localization string\see{aut:lng:key:msc}
+\item Added field \bibfield{clonesourcekey}\see{aut:bbx:fld:gen}
+\item New options for \cmd{DeclareLabelalphaTemplate}\see{aut:ctm:lab}
+\item Added \cmd{DeclareLabeldate} and retired \cmd{DeclareLabelyear}\see{aut:ctm:fld}
+\item Added \texttt{nodate} localisation string\see{aut:lng:key:msc}
\item Added \cmd{rangelen}\see{aut:aux:msc}
\item Added starred variants of \cmd{citeauthor} and \cmd{Citeauthor}\see{use:cit:txt}
-\item Restored original \texttt{url} format. Added \texttt{urlfrom} localization key\see{aut:lng:key:lab}
+\item Restored original \texttt{url} format. Added \texttt{urlfrom} localisation key\see{aut:lng:key:lab}
\item Added \cmd{AtNextBibliography}\see{aut:fmt:hok}
\item Fixed related entry processing to allow nested and cyclic related entries
-\item Added Croatian localization (Ivo Pletikosić)
-\item Added Polish localization (Anastasia Kandulina, Yuriy Chernyshov)
-\item Fixed Catalan localization
-\item Added smart ``of'' for titles to Catalan and French localization
+\item Added Croatian localisation (Ivo Pletikosić)
+\item Added Polish localisation (Anastasia Kandulina, Yuriy Chernyshov)
+\item Fixed Catalan localisation
+\item Added smart ``of'' for titles to Catalan and French localisation
\item Misc bug fixes
\end{release}
\begin{release}{2.5}{2013-01-10}
-\item Made \texttt{url} work as a localization string, defaulting to previously hard-coded value <\textsc{URL}>.
+\item Made \texttt{url} work as a localisation string, defaulting to previously hard-coded value <\textsc{URL}>.
\item Changed some \biber\ option names to cohere with \biber\ 1.5.
-\item New sourcemap step for conditionally removing entire entries\see{aut:ctm:map}\BiberOnlyMark
-\item Updated Catalan localization (Sebastià Vila-Marta)
+\item New sourcemap step for conditionally removing entire entries\see{aut:ctm:map}
+\item Updated Catalan localisation (Sebastià Vila-Marta)
\end{release}
\begin{release}{2.4}{2012-11-28}
-\item Added \bibfield{relatedoptions} field\see{aut:ctm:rel}\BiberOnlyMark
-\item Added \cmd{DeclareStyleSourcemap}\see{aut:ctm:map}\BiberOnlyMark
-\item Renamed \cmd{DeclareDefaultSourcemap} to \cmd{DeclareDriverSourcemap}\see{aut:ctm:map}\BiberOnlyMark
+\item Added \bibfield{relatedoptions} field\see{aut:ctm:rel}
+\item Added \cmd{DeclareStyleSourcemap}\see{aut:ctm:map}
+\item Renamed \cmd{DeclareDefaultSourcemap} to \cmd{DeclareDriverSourcemap}\see{aut:ctm:map}
\item Documented \cmd{DeclareFieldInputHandler}, \cmd{DeclareListInputHandler} and \cmd{DeclareNameInputHandler}.
-\item Added Czech localization (Michal Hoftich)
-\item Updated Catalan localization (Sebastià Vila-Marta)
+\item Added Czech localisation (Michal Hoftich)
+\item Updated Catalan localisation (Sebastià Vila-Marta)
\end{release}
\begin{release}{2.3}{2012-11-01}
\item Better detection of situations which require a \biber\ or \LaTeX\ re-run
-\item New append mode for \cmd{DeclareSourcemap} so that fields can be combined\see{aut:ctm:map}\BiberOnlyMark
+\item New append mode for \cmd{DeclareSourcemap} so that fields can be combined\see{aut:ctm:map}
\item Extended auxiliary indexing macros
-\item Added support for plural localization strings with \bibfield{relatedtype}\see{aut:ctm:rel}\BiberOnlyMark
+\item Added support for plural localisation strings with \bibfield{relatedtype}\see{aut:ctm:rel}
\item Added \cmd{csfield} and \cmd{usefield}\see{aut:aux:dat}
\item Added starred variant of \cmd{usebibmacro}\see{aut:aux:msc}
\item Added \cmd{ifbibmacroundef}, \cmd{iffieldformatundef}, \cmd{iflistformatundef}
and \cmd{ifnameformatundef}\see{aut:aux:msc}
-\item Added Catalan localization (Sebastià Vila-Marta)
+\item Added Catalan localisation (Sebastià Vila-Marta)
\item Misc bug fixes
\end{release}
@@ -11875,42 +12029,42 @@ This revision history is a list of changes relevant to users of this package. Ch
\begin{release}{2.1}{2012-08-01}
\item Misc bug fixes
-\item Updated Norwegian localization (Håkon Malmedal)
-\item Increased data model auto-loading possibilities\see{aut:ctm:dm}\BiberOnlyMark
+\item Updated Norwegian localisation (Håkon Malmedal)
+\item Increased data model auto-loading possibilities\see{aut:ctm:dm}
\end{release}
\begin{release}{2.0}{2012-07-01}
\item Misc bug fixes
-\item Generalised \opt{singletitle} test a little\see{aut:aux:tst}\BiberOnlyMark
-\item Added new special field \bibfield{extratitleyear}\see{aut:bbx:fld}\BiberOnlyMark
-\item Customisable data model\see{aut:ctm:dm}\BiberOnlyMark
-\item Added \cmd{DeclareDefaultSourcemap}\see{aut:ctm:map}\BiberOnlyMark
-\item Added \opt{labeltitle} option\see{use:opt:pre:int}\BiberOnlyMark
-\item Added new special field \bibfield{extratitle}\see{aut:bbx:fld}\BiberOnlyMark
-\item Made special field \bibfield{labeltitle} customisable\see{aut:bbx:fld}\BiberOnlyMark
-\item Removed field \bibfield{reprinttitle}\see{use:rel}\BiberOnlyMark
-\item Added related entry feature\see{use:rel}\BiberOnlyMark
-\item Added \cmd{DeclareNoinit}\see{aut:ctm:noinit}\BiberOnlyMark
-\item Added \cmd{DeclareNosort}\see{aut:ctm:nosort}\BiberOnlyMark
-\item Added \opt{sorting} option for \cmd{printbibliography} and \cmd{printshorthands}\see{use:bib:bib}\BiberOnlyMark
-\item Added \texttt{ids} field for citekey aliasing\see{bib:fld}\BiberOnlyMark
-\item Added \opt{sortfirstinits} option\see{use:opt:pre:int}\BiberOnlyMark
-\item Added data stream modification feature\see{aut:ctm:map}\BiberOnlyMark
-\item Added customisable labels feature\see{aut:ctm:lab}\BiberOnlyMark
+\item Generalised \opt{singletitle} test a little\see{aut:aux:tst}
+\item Added new special field \bibfield{extratitleyear}\see{aut:bbx:fld}
+\item Customisable data model\see{aut:ctm:dm}
+\item Added \cmd{DeclareDefaultSourcemap}\see{aut:ctm:map}
+\item Added \opt{labeltitle} option\see{use:opt:pre:int}
+\item Added new special field \bibfield{extratitle}\see{aut:bbx:fld}
+\item Made special field \bibfield{labeltitle} customisable\see{aut:bbx:fld}
+\item Removed field \bibfield{reprinttitle}\see{use:rel}
+\item Added related entry feature\see{use:rel}
+\item Added \cmd{DeclareNoinit}\see{aut:ctm:noinit}
+\item Added \cmd{DeclareNosort}\see{aut:ctm:nosort}
+\item Added \opt{sorting} option for \cmd{printbibliography} and \cmd{printshorthands}\see{use:bib:bib}
+\item Added \texttt{ids} field for citekey aliasing\see{bib:fld}
+\item Added \opt{sortfirstinits} option\see{use:opt:pre:int}
+\item Added data stream modification feature\see{aut:ctm:map}
+\item Added customisable labels feature\see{aut:ctm:lab}
\item Added \cmd{citeyear*} and \cmd{citedate*}\see{use:cit:txt}
\end{release}
% \begin{release}{1.7}{2011-11-13}
-% \item Added \texttt{xdata} containers\see{use:use:xdat}\BiberOnlyMark
-% \item Added special entry type \bibfield{xdata}\see{bib:typ:blx}\BiberOnlyMark
-% \item Added special field \bibfield{xdata}\see{bib:fld:spc}\BiberOnlyMark
-% \item Support \opt{maxnames}/\opt{minnames} globally/per-type/per-entry\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Support \opt{maxbibnames}/\opt{minbibnames} globally/per-type/per-entry\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Support \opt{maxcitenames}/\opt{mincitenames} globally/per-type/per-entry\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Support \opt{maxitems}/\opt{minitems} globally/per-type/per-entry\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Support \opt{maxalphanames}/\opt{minalphanames} globally/per-type/per-entry\see{use:opt:pre:int}\BiberOnlyMark
-% \item Support \opt{uniquelist} globally/per-type/per-entry\see{use:opt:pre:int}\BiberOnlyMark
-% \item Support \opt{uniquename} globally/per-type/per-entry\see{use:opt:pre:int}\BiberOnlyMark
+% \item Added \texttt{xdata} containers\see{use:use:xdat}
+% \item Added special entry type \bibfield{xdata}\see{bib:typ:blx}
+% \item Added special field \bibfield{xdata}\see{bib:fld:spc}
+% \item Support \opt{maxnames}/\opt{minnames} globally/per-type/per-entry\see{use:opt:pre:gen}
+% \item Support \opt{maxbibnames}/\opt{minbibnames} globally/per-type/per-entry\see{use:opt:pre:gen}
+% \item Support \opt{maxcitenames}/\opt{mincitenames} globally/per-type/per-entry\see{use:opt:pre:gen}
+% \item Support \opt{maxitems}/\opt{minitems} globally/per-type/per-entry\see{use:opt:pre:gen}
+% \item Support \opt{maxalphanames}/\opt{minalphanames} globally/per-type/per-entry\see{use:opt:pre:int}
+% \item Support \opt{uniquelist} globally/per-type/per-entry\see{use:opt:pre:int}
+% \item Support \opt{uniquename} globally/per-type/per-entry\see{use:opt:pre:int}
% \item Added \cmd{textcite} and \cmd{textcites} to all \texttt{verbose} citation styles\see{use:xbx:cbx}
% \item Added special field formats \texttt{date}, \texttt{urldate}, \texttt{origdate}, \texttt{eventdate}\see{aut:fmt:ich}
% \item Added \cmd{mkcomprange*}\see{aut:aux:msc}
@@ -11921,8 +12075,8 @@ This revision history is a list of changes relevant to users of this package. Ch
% \item Added counter \cnt{biburlnumpenalty}\see{aut:fmt:len}
% \item Added counter \cnt{biburlucpenalty}\see{aut:fmt:len}
% \item Added counter \cnt{biburllcpenalty}\see{aut:fmt:len}
-% \item Added localization keys \texttt{book}, \texttt{part}, \texttt{issue}, \texttt{forthcoming}\see{aut:lng:key}
-% \item Added some \texttt{lang...} and \texttt{from...} localization keys\see{aut:lng:key}
+% \item Added localisation keys \texttt{book}, \texttt{part}, \texttt{issue}, \texttt{forthcoming}\see{aut:lng:key}
+% \item Added some \texttt{lang...} and \texttt{from...} localisation keys\see{aut:lng:key}
% \item Expanded documentation\see{apx:opt}
% \item Added support for Russian (Oleg Domanov)
% \item Updated support for Dutch (Pieter Belmans)
@@ -11931,11 +12085,11 @@ This revision history is a list of changes relevant to users of this package. Ch
% \end{release}
% \begin{release}{1.6}{2011-07-29}
-% \item Added special field \bibfield{sortshorthand}\see{bib:fld:spc}\BiberOnlyMark
+% \item Added special field \bibfield{sortshorthand}\see{bib:fld:spc}
% \item Revised options \opt{maxnames}/\opt{minnames}\see{use:opt:pre:gen}
-% \item Options \opt{maxcitenames}/\opt{mincitenames} now supported by backend\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Options \opt{maxbibnames}/\opt{minbibnames} now supported by backend\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Added options \opt{maxalphanames}/\opt{minalphanames}\see{use:opt:pre:int}\BiberOnlyMark
+% \item Options \opt{maxcitenames}/\opt{mincitenames} now supported by backend\see{use:opt:pre:gen}
+% \item Options \opt{maxbibnames}/\opt{minbibnames} now supported by backend\see{use:opt:pre:gen}
+% \item Added options \opt{maxalphanames}/\opt{minalphanames}\see{use:opt:pre:int}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{printbibliography}\see{use:bib:bib}
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printbibliography}\see{use:bib:bib}
% \item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbysection}\see{use:bib:bib}
@@ -11948,7 +12102,7 @@ This revision history is a list of changes relevant to users of this package. Ch
% \item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printshorthands}\see{use:bib:biblist}
% \item Added special field format \bibfield{volcitevolume}\see{use:cit:spc}
% \item Added special field format \bibfield{volcitepages}\see{use:cit:spc}
-% \item Added special field \bibfield{hash}\see{aut:bbx:fld:gen}\BiberOnlyMark
+% \item Added special field \bibfield{hash}\see{aut:bbx:fld:gen}
% \item Added \cmd{mkcomprange}\see{aut:aux:msc}
% \item Added \cmd{mkfirstpage}\see{aut:aux:msc}
% \item Removed \cmd{mkpagefirst}\see{aut:aux:msc}
@@ -11960,13 +12114,13 @@ This revision history is a list of changes relevant to users of this package. Ch
% \end{release}
% \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 option \kvopt{uniquename}{mininit/minfull}\see{use:opt:pre:int}
+% \item Added option \kvopt{uniquelist}{minyear}\see{use:opt:pre:int}
+% \item Updated documentation of \cnt{uniquename} counter\see{aut:aux:tst}
+% \item Updated documentation of \cnt{uniquelist} counter\see{aut:aux:tst}
+% \item Expanded documentation for \opt{uniquename/uniquelist} options\see{aut:cav:amb}
% \item Added editorial role \texttt{reviser}\see{bib:use:edr}
-% \item Added localization keys \texttt{reviser}, \texttt{revisers}, \texttt{byreviser}\see{aut:lng:key}
+% \item Added localisation keys \texttt{reviser}, \texttt{revisers}, \texttt{byreviser}\see{aut:lng:key}
% \item Added bibliography heading \texttt{none}\see{use:bib:hdg}
% \item Fixed some \sty{memoir} compatibility issues
% \end{release}
@@ -11986,11 +12140,11 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 package option \opt{uniquelist}\see{use:opt:pre:int}
+% \item Added special counter \cnt{uniquelist}\see{aut:aux:tst}
+% \item Revised and improved package option \opt{uniquename}\see{use:opt:pre:int}
+% \item Revised and improved special counter \cnt{uniquename}\see{aut:aux:tst}
+% \item Added \cmd{bibnamedelimi}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelima}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimb}\see{use:fmt:fmt}
% \item Added \cmd{bibindexnamedelimc}\see{use:fmt:fmt}
@@ -12011,20 +12165,20 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 Introducing experimental support for Zotero \acr{RDF}/\acr{XML}\see{use:bib:res}
+% \item Introducing experimental support for EndNote \acr{XML}\see{use:bib:res}
% \item Added option \opt{citecounter}\see{use:opt:pre:int}
% \item Added \cnt{citecounter}\see{aut:aux:tst}
% \item Added \cmd{smartcite} and \cmd{Smartcite}\see{use:cit:cbx}
% \item Added \cmd{smartcites} and \cmd{Smartcites}\see{use:cit:mlt}
% \item Added \cmd{svolcite} and \cmd{Svolcite}\see{use:cit:spc}
-% \item Added \cmd{bibnamedelima}\see{use:fmt:fmt}\BiberOnlyMark
-% \item Added \cmd{bibnamedelimb}\see{use:fmt:fmt}\BiberOnlyMark
+% \item Added \cmd{bibnamedelima}\see{use:fmt:fmt}
+% \item Added \cmd{bibnamedelimb}\see{use:fmt:fmt}
% \item Added \cmd{bibnamedelimc}\see{use:fmt:fmt}
% \item Added \cmd{bibnamedelimd}\see{use:fmt:fmt}
-% \item Added \cmd{bibinitperiod}\see{use:fmt:fmt}\BiberOnlyMark
-% \item Added \cmd{bibinitdelim}\see{use:fmt:fmt}\BiberOnlyMark
-% \item Added \cmd{bibinithyphendelim}\see{use:fmt:fmt}\BiberOnlyMark
+% \item Added \cmd{bibinitperiod}\see{use:fmt:fmt}
+% \item Added \cmd{bibinitdelim}\see{use:fmt:fmt}
+% \item Added \cmd{bibinithyphendelim}\see{use:fmt:fmt}
% \item Expanded documentation\see{use:cav:nam}
% \item Added \prm{position} parameter \texttt{f} to \cmd{DeclareAutoCiteCommand}\see{aut:cbx:cbx}
% \end{release}
@@ -12038,18 +12192,18 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 Introducing remote resources\see{use:bib:res}
+% \item Introducing experimental \acr{RIS} support\see{use:bib:res}
% \item Added \cmd{addbibresource}\see{use:bib:res}
% \item \cmd{bibliography} now deprecated\see{use:bib:res}
% \item \cmd{bibliography*} replaced by \cmd{addglobalbib}\see{use:bib:res}
% \item Added \cmd{addsectionbib}\see{use:bib:res}
% \item Updated and expanded documentation\see{bib:cav:ref}
-% \item Introducing smart \bibfield{crossref} data inheritance\see{bib:cav:ref:bbr}\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 Introducing smart \bibfield{crossref} data inheritance\see{bib:cav:ref:bbr}
+% \item Introducing \bibfield{crossref} configuration interface\see{aut:ctm:ref}
+% \item Added \cmd{DefaultInheritance}\see{aut:ctm:ref}
+% \item Added \cmd{DeclareDataInheritance}\see{aut:ctm:ref}
+% \item Added \cmd{ResetDataInheritance}\see{aut:ctm:ref}
% \item Added \cmd{ifkeyword}\see{aut:aux:tst}
% \item Added \cmd{ifentrykeyword}\see{aut:aux:tst}
% \item Added \cmd{ifcategory}\see{aut:aux:tst}
@@ -12059,16 +12213,16 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 Added localisation key \texttt{inpreparation}\see{aut:lng:key}
% \item Rearranged manual slightly, moving some tables to the appendix
% \end{release}
% \begin{release}{1.1b}{2011-02-04}
-% \item Added option \opt{texencoding}\see{use:opt:pre:gen}\BiberOnlyMark
-% \item Added option \opt{safeinputenc}\see{use:opt:pre:gen}\BiberOnlyMark
+% \item Added option \opt{texencoding}\see{use:opt:pre:gen}
+% \item Added option \opt{safeinputenc}\see{use:opt:pre:gen}
% \item Expanded documentation\see{bib:cav:enc:enc}
% \item Improved \opt{mergedate} option of bibliography style \texttt{authoryear}\see{use:xbx:bbx}
-% \item Removed \opt{pass} option of \cmd{DeclareSortingScheme}\see{aut:ctm:srt}\BiberOnlyMark
+% \item Removed \opt{pass} option of \cmd{DeclareSortingScheme}\see{aut:ctm:srt}
% \item Fixed some bugs
% \end{release}
@@ -12086,29 +12240,29 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 \bibfield{useprefix} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \bibfield{useauthor} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \bibfield{useeditor} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{usetranslator} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{skipbib} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{skiplos} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{skiplab} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{dataonly} settable on a per-type basis\see{use:opt:bib}
+% \item Made option \opt{labelalpha} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{labelnumber} settable on a per-type basis\see{use:opt:pre:int}
-% \item Made option \opt{labelyear} settable on a per-type basis\see{use:opt:pre:int}\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{labelyear} settable on a per-type basis\see{use:opt:pre:int}
+% \item Made option \opt{singletitle} settable on a per-type basis\see{use:opt:pre:int}
+% \item Made option \opt{uniquename} settable on a per-type basis\see{use:opt:pre:int}
% \item Made option \opt{indexing} settable on a per-type basis\see{use:opt:pre:gen}
% \item Made option \opt{indexing} settable on a per-entry basis\see{use:opt:pre:gen}
% \item Extended \cmd{ExecuteBibliographyOptions}\see{use:cfg:opt}
% \item Added \cmd{citedate}\see{use:cit:txt}
-% \item Improved static entry sets\see{use:use:set}\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 Improved static entry sets\see{use:use:set}
+% \item Introducing dynamic entry sets\see{use:use:set}
+% \item Added \cmd{defbibentryset}\see{use:bib:set}
+% \item Added option \opt{mcite}\see{use:opt:ldt}
+% \item Added \sty{mcite}\slash\sty{mciteplus}-like commands\see{use:cit:mct}
+% \item Added \cmd{sortalphaothers}\see{use:fmt:fmt}
% \item Extended \cmd{DeclareNameFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareIndexNameFormat}\see{aut:bib:fmt}
% \item Extended \cmd{DeclareListFormat}\see{aut:bib:fmt}
@@ -12121,14 +12275,14 @@ This revision history is a list of changes relevant to users of this package. Ch
% \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 Introducing configurable sorting schemes
+% \item Added \cmd{DeclareSortingScheme}\see{aut:ctm:srt}
+% \item Added \cmd{DeclarePresort}\see{aut:ctm:srt}
+% \item Added \cmd{DeclareSortExclusion}\see{aut:ctm:srt}
+% \item Added \cmd{DeclareLabelname}\see{aut:ctm:fld}
+% \item Added \cmd{DeclareLabelyear}\see{aut:ctm:fld}
+% \item Improved special field \bibfield{labelname}\see{aut:bbx:fld}
+% \item Improved special field \bibfield{labelyear}\see{aut:bbx:fld}
% \item Added \cmd{entrydata*}\see{aut:bib:dat}
% \item Added \cmd{RequireBiber}\see{aut:aux:msc}
% \item Added option \opt{check} to \cmd{printbibliography}\see{use:bib:bib}
@@ -12275,8 +12429,8 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Added localisation key \texttt{backrefpage}\see{aut:lng:key}
+%\item Added localisation key \texttt{backrefpages}\see{aut:lng:key}
%\item Slightly expanded documentation\see{bib:use:dat}
%\item Slightly expanded documentation\see{aut:bbx:fld:dat}
%\item Added support for Finnish (translations by Hannu Väisänen)
@@ -12395,28 +12549,28 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Removed localisation key \texttt{editor}\see{aut:lng:key}
+%\item Removed localisation key \texttt{editors}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{typeeditor} to \texttt{editor}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{typeeditors} to \texttt{editors}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{typecompiler} to \texttt{compiler}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{typecompilers} to \texttt{compilers}\see{aut:lng:key}
+%\item Added localisation key \texttt{founder}\see{aut:lng:key}
+%\item Added localisation key \texttt{founders}\see{aut:lng:key}
+%\item Added localisation key \texttt{continuator}\see{aut:lng:key}
+%\item Added localisation key \texttt{continuators}\see{aut:lng:key}
+%\item Added localisation key \texttt{collaborator}\see{aut:lng:key}
+%\item Added localisation key \texttt{collaborators}\see{aut:lng:key}
+%\item Removed localisation key \texttt{byauthor}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{bytypeauthor} to \texttt{byauthor}\see{aut:lng:key}
+%\item Removed localisation key \texttt{byeditor}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{bytypeeditor} to \texttt{byeditor}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{bytypecompiler} to \texttt{bycompiler}\see{aut:lng:key}
+%\item Added localisation key \texttt{byfounder}\see{aut:lng:key}
+%\item Added localisation key \texttt{bycontinuator}\see{aut:lng:key}
+%\item Added localisation key \texttt{bycollaborator}\see{aut:lng:key}
+%\item Added localisation key \texttt{inpress}\see{aut:lng:key}
+%\item Added localisation key \texttt{submitted}\see{aut:lng:key}
%\item Added support for Dutch (translations by Alexander van Loon)
%\item Added support for Greek (translations by Apostolos Syropoulos)
%\item Added notes on Greek\see{use:loc:grk}
@@ -12452,12 +12606,12 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Added several localisation keys related to \texttt{editor}\see{aut:lng:key}
+%\item Added several localisation keys related to \texttt{translator}\see{aut:lng:key}
+%\item Added localisation key \texttt{thiscite}\see{aut:lng:key}
+%\item Removed several \texttt{country...} localisation keys\see{aut:lng:key}
+%\item Removed several \texttt{patent...} localisation keys\see{aut:lng:key}
+%\item Removed several \texttt{patreq...} localisation keys\see{aut:lng:key}
%\item Updated and clarified documentation\see{aut:lng:key}
%\item Added support for Brazilian Portuguese (by Augusto Ritter Stoffel)
%\item Added preliminary support for Portuguese/Portugal\see{use:opt:pre:gen}
@@ -12484,7 +12638,7 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Improved on-demand loading of localisation modules
%\item Fixed some bugs
%
%\end{release}
@@ -12543,7 +12697,7 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 support for custom localisation modules\see{aut:cav:lng}
%\item Added extended \pdf bookmarks to this manual
%\item Fixed various bugs
%
@@ -12560,8 +12714,8 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 several new localisation keys\see{aut:lng:key}
+%\item Rearranged some localisation keys (\texttt{section} vs. \texttt{paragraph})\see{aut:lng:key}
%\item Added unsupported entry type \bibtype{letter}\see{bib:typ:ctm}
%\item Added entry type \bibtype{suppbook}\see{bib:typ:blx}
%\item Added entry type \bibtype{suppcollection}\see{bib:typ:blx}
@@ -12635,7 +12789,7 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Updated various localisation files
%\item Various minor improvements throughout
%\item Fixed some bugs
%
@@ -12859,7 +13013,7 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 several new localisation keys\see{aut:lng:key}
%\item Added support for Norwegian (translations by Johannes Wilm)
%\item Added support for Danish (translations by Johannes Wilm)
%\item Expanded documentation\see{aut:cav:grp}
@@ -12952,7 +13106,7 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Rearranged, renamed, and extended localisation keys\see{aut:lng:key}
%\item Renamed counter \cnt{citecount} to \cnt{instcount}\see{aut:fmt:ilc}
%\item Added new counter \cnt{citecount}\see{aut:fmt:ilc}
%\item Added counter \cnt{citetotal}\see{aut:fmt:ilc}
@@ -13056,30 +13210,30 @@ This revision history is a list of changes relevant to users of this package. Ch
%\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 Added localisation key \texttt{citedas}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{editby} to \texttt{edited}\see{aut:lng:key}
+%\item Renamed localisation key \texttt{transby} to \texttt{translated}\see{aut:lng:key}
+%\item Added localisation key \texttt{annotated}\see{aut:lng:key}
+%\item Added localisation key \texttt{commented}\see{aut:lng:key}
+%\item Added localisation key \texttt{introduced}\see{aut:lng:key}
+%\item Added localisation key \texttt{foreworded}\see{aut:lng:key}
+%\item Added localisation key \texttt{afterworded}\see{aut:lng:key}
+%\item Added localisation key \texttt{commentary}\see{aut:lng:key}
+%\item Added localisation key \texttt{annotations}\see{aut:lng:key}
+%\item Added localisation key \texttt{introduction}\see{aut:lng:key}
+%\item Added localisation key \texttt{foreword}\see{aut:lng:key}
+%\item Added localisation key \texttt{afterword}\see{aut:lng:key}
+%\item Added localisation key \texttt{doneby}\see{aut:lng:key}
+%\item Added localisation key \texttt{itemby}\see{aut:lng:key}
+%\item Added localisation key \texttt{spanish}\see{aut:lng:key}
+%\item Added localisation key \texttt{latin}\see{aut:lng:key}
+%\item Added localisation key \texttt{greek}\see{aut:lng:key}
+%\item Modified localisation key \texttt{fromenglish}\see{aut:lng:key}
+%\item Modified localisation key \texttt{fromfrench}\see{aut:lng:key}
+%\item Modified localisation key \texttt{fromgerman}\see{aut:lng:key}
+%\item Added localisation key \texttt{fromspanish}\see{aut:lng:key}
+%\item Added localisation key \texttt{fromlatin}\see{aut:lng:key}
+%\item Added localisation key \texttt{fromgreek}\see{aut:lng:key}
%\item Expanded documentation\see{bib:use}
%\item Updated documentation\see{use:xbx:cbx}
%\item Updated documentation\see{use:xbx:bbx}