diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex/biblatex.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/biblatex/biblatex.tex | 340 |
1 files changed, 313 insertions, 27 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex/biblatex.tex b/Master/texmf-dist/doc/latex/biblatex/biblatex.tex index 9b4df45b42c..7969dd0631d 100644 --- a/Master/texmf-dist/doc/latex/biblatex/biblatex.tex +++ b/Master/texmf-dist/doc/latex/biblatex/biblatex.tex @@ -1,4 +1,4 @@ -% $Id: biblatex.tex,v 1.6 2011/07/29 19:21:28 lehman stable $ +% $Id: biblatex.tex,v 1.7 2011/11/13 19:09:07 lehman stable $ \documentclass{ltxdockit}[2011/03/25] \usepackage{btxdockit} \usepackage[latin9]{inputenc} @@ -8,11 +8,12 @@ \usepackage{longtable} \usepackage{booktabs} \usepackage{shortvrb} +\usepackage{pifont} \MakeAutoQuote{«}{»} \MakeAutoQuote*{<}{>} \MakeShortVerb{\|} -\rcsid{$Id: biblatex.tex,v 1.6 2011/07/29 19:21:28 lehman stable $} +\rcsid{$Id: biblatex.tex,v 1.7 2011/11/13 19:09:07 lehman stable $} \newcommand*{\biber}{Biber\xspace} \newcommand*{\biblatex}{Biblatex\xspace} @@ -39,6 +40,7 @@ \newcolumntype{H}{>{\sffamily\bfseries\spotcolor}l} \newcolumntype{L}{>{\raggedright\let\\=\tabularnewline}p} \newcolumntype{R}{>{\raggedleft\let\\=\tabularnewline}p} +\newcolumntype{C}{>{\centering\let\\=\tabularnewline}p} \newcolumntype{V}{>{\raggedright\let\\=\tabularnewline\ttfamily}p} \newcommand*{\sorttablesetup}{% @@ -48,6 +50,8 @@ \def\alt{\par\makebox[1.25em][r]{\ensuremath\hookrightarrow}\,}% \def\note##1{\textrm{##1}}} +\newcommand{\tickmarkyes}{\Pisymbol{psy}{183}} +\newcommand{\tickmarkno}{\textendash} \providecommand*{\textln}[1]{#1} \providecommand*{\lnstyle}{} @@ -143,7 +147,9 @@ Hannu Väisänen (Finnish), Prokopis (Greek), Mateus Araújo (Brazilian), Andrea Marchitelli (Italian), -José Carlos Santos (Portuguese). +José Carlos Santos (Portuguese), +Oleg Domanov (Russian), +Pieter Belmans (Dutch). \subsection{Prerequisites} \label{int:pre} @@ -458,6 +464,10 @@ A work with an author and a title which has not been formally published, such as \reqitem{author, title, year/date} \optitem{subtitle, titleaddon, language, howpublished, note, location, isbn, date, month, year, addendum, pubstate, url, urldate} +\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. + \typeitem{custom[a--f]} Custom types for special bibliography styles. Not used by the standard styles. @@ -903,7 +913,7 @@ The name(s) of the publisher(s). See also \secref{bib:use:and}. \fielditem{pubstate}{key} -The publication state of the work, \eg <in press>. See \secref{aut:lng:key:pst} for known publication states. +The publication state of the work, \eg\ <in press>. See \secref{aut:lng:key:pst} for known publication states. \fielditem{reprinttitle}{literal} @@ -1042,6 +1052,7 @@ Italian & Italy & \opt{italian} \\ Norwegian & Norway & \opt{norsk}, \opt{nynorsk} \\ Portuguese& Brazil & \opt{brazil} \\ & Portugal & \opt{portuges} \\ +Russian & Russia & \opt{russian} \\ Spanish & Spain & \opt{spanish} \\ Swedish & Sweden & \opt{swedish} \\ \bottomrule @@ -1098,6 +1109,10 @@ 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. It is only used internally during sorting. Please refer to \secref{use:srt} for further details. +\fielditem{xdata}{comma-separated list of entry keys\BiberOnlyMark} + +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 comma"=separated list of keys. See \secref{use:use:xdat} for further details. + \fielditem{xref}{entry key} This field is an alternative cross"=referencing mechanism. It differs from \bibfield{crossref} in that the child entry will not inherit any data from the parent entry specified in the \bibfield{xref} field. If the number of child entries referencing a specific parent entry hits a certain threshold, the parent entry is automatically added to the bibliography even if it has not been cited explicitly. The threshold is settable with the \opt{mincrossrefs} package option from \secref{use:opt:pre:gen}. Style authors should note that whether or not the \bibfield{xref} fields of the child entries are defined on the \sty{biblatex} level depends on the availability of the parent entry. If the parent entry is available, the \bibfield{xref} fields of the child entries will be defined. If not, their \bibfield{xref} fields will be undefined. Whether the parent entry is added to the bibliography implicitly because of the threshold or explicitly because it has been cited does not matter. See also the \bibfield{crossref} field in this section as well as \secref{bib:cav:ref}. @@ -1508,7 +1523,7 @@ As \bibtex is not capable of mapping the \bibfield{title} field of the parent to \paragraph{The \bibfield{crossref} field (Biber)} \label{bib:cav:ref:bbr} -With Biber, the limitations of \bibtex's \bibfield{crossref} field belong to the past. Biber features a highly customizable cross-referencing mechanism with flexible data inheritance rules. Duplicating certain fields in the parent entry or adding empty fields to the child entry is longer required. Entries are specified in a natural way: +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: \begin{lstlisting}[style=bibtex]{} @Book{book, @@ -1762,7 +1777,7 @@ The same scenario with \xetex or \luatex in native \utf mode: \end{itemize} -Some workarounds may be required when using traditional \tex or \pdftex with \utf encoding because \sty{inputenc}'s \file{utf8} module does not cover all of Unicode. Roughly speaking, it only convers the Western European Unicode range. When loading \sty{inputenc} with the \file{utf8} option, \sty{biblatex} will normally instruct Biber to reencode the \file{bib} data to \utf. This may lead to \sty{inputenc} errors if some of the characters in the \file{bib} file are outside the limited Unicode range supported by \sty{inputenc}. +Some workarounds may be required when using traditional \tex or \pdftex with \utf encoding because \sty{inputenc}'s \file{utf8} module does not cover all of Unicode. Roughly speaking, it only covers the Western European Unicode range. When loading \sty{inputenc} with the \file{utf8} option, \sty{biblatex} will normally instruct Biber to reencode the \file{bib} data to \utf. This may lead to \sty{inputenc} errors if some of the characters in the \file{bib} file are outside the limited Unicode range supported by \sty{inputenc}. \begin{itemize} @@ -1950,6 +1965,7 @@ Italian & Italy & italian \\ Norwegian & Norway & norwegian \\ Portuguese& Brazil & brazilian \\ & Portugal & portuguese \\ +Russian & Russia & russian \\ Spanish & Spain & spanish \\ Swedish & Sweden & swedish \\ \bottomrule @@ -3353,7 +3369,7 @@ Similar to \cmd{fullcite} but puts the entire citation in a footnote and adds a \cmditem{volcite}[prenote]{volume}[page]{key} \cmditem{Volcite}[prenote]{volume}[page]{key} -These commands are similar to \cmd{cite} and \cmd{Cite} but intended for references to multi"=volume works which are cited by volume and page number. Instead of the \prm{postnote}, they take a mandatory \prm{volume} and an optional \prm{page} argument. Since they merely compose the postnote and pass it to the \cmd{cite} command provided by the citation style as a \prm{postnote} argument, these commands are style independent. The format of the volume portion is controlled by the field formatting directive \opt{volcitevolume}, the format of the page/text portion is controlled by the field formatting directive \opt{volcitepages}. +These commands are similar to \cmd{cite} and \cmd{Cite} but intended for references to multi"=volume works which are cited by volume and page number. Instead of the \prm{postnote}, they take a mandatory \prm{volume} and an optional \prm{page} argument. Since they merely compose the postnote and pass it to the \cmd{cite} command provided by the citation style as a \prm{postnote} argument, these commands are style independent. The format of the volume portion is controlled by the field formatting directive \opt{volcitevolume}, the format of the page/text portion is controlled by the field formatting directive \opt{volcitepages} (\secref{aut:fmt:ich}). The delimiter printed between the volume portion and the page/text portion may be modified by redefining the macro \cmd{volcitedelim} (\secref{aut:fmt:fmt}). \cmditem{pvolcite}[prenote]{volume}[page]{key} \cmditem{Pvolcite}[prenote]{volume}[page]{key} @@ -3870,6 +3886,10 @@ Similar to \cmd{mkbibordinal}, but prints a masculine ordinal, if applicable in Similar to \cmd{mkbibordinal}, but prints a feminine ordinal, if applicable in the respective language. +\cmditem{mkbibneutord}{integer} + +Similar to \cmd{mkbibordinal}, but prints a neuter ordinal, if applicable in the respective language. + \cmditem{mkbibordedition}{integer} Similar to \cmd{mkbibordinal}, but intended for use with the term <edition>. @@ -4045,6 +4065,11 @@ Similar to \cmd{forceE} but enforces <y>. The Greek localization module requires \utf support. It will not work with any other encoding. Generally speaking, the \sty{biblatex} package is compatible with the \sty{inputenc} package and with \xelatex. The \sty{ucs} package will not work. Since \sty{inputenc}'s standard \file{utf8} module is missing glyph mappings for Greek, this leaves Greek users with \xelatex. Note that you may need to load additional packages which set up Greek fonts. As a rule of thumb, a setup which works for regular Greek documents should also work with \sty{biblatex}. However, there is one fundamental limitation. As of this writing, \sty{biblatex} has no support for switching scripts. Greek titles in the bibliography should work fine, provided that you use Biber as a backend, but English and other titles in the bibliography may be rendered in Greek letters. If you need multi-script bibliographies, using \xelatex is the only sensible choice. +\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. + \subsection{Usage Notes} \label{use:use} @@ -4318,7 +4343,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 backend, defining an entry set is as simple as adding an entry of type \bibtype{set}. The entry has an \bibfield{entryset} field defining the members of the set as a comma"=separated list of entry keys: +\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 comma"=separated list of entry keys: \begin{lstlisting}[style=bibtex]{} <<@Set>>{<<set1>>, @@ -4367,6 +4392,46 @@ Dynamic entry sets are set up and work much like static ones. The main differenc % Dynamic entry sets in the document body are local to the enclosing \env{refsection} environment, if any. Otherwise, they are assigned to reference section~0. Those defined in the preamble are assigned to reference section~0. Note that dynamic entry sets require Biber. They will not work with any other backend. +\subsubsection[Data Containers]{Data Containers\BiberOnlyMark} +\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: + +\begin{lstlisting}[style=bibtex]{} +<<@XData>>{<<hup>>, + publisher = {Harvard University Press}, + location = {Cambridge, Mass.}, +} +@Book{..., + author = {...}, + title = {...}, + date = {...}, + <<xdata>> = {<<hup>>}, +} +\end{lstlisting} +% +Using a comma"=separated list of keys in its \bibfield{xdata} field, an entry may inherit data from several \bibtype{xdata} entries. Cascading \bibtype{xdata} entries are supported as well, \ie an \bibtype{xdata} entry may reference one or more other \bibtype{xdata} entries: + +\begin{lstlisting}[style=bibtex]{} +@XData{macmillan:name, + publisher = {Macmillan}, +} +@XData{macmillan:place, + location = {New York and London}, +} +@XData{macmillan, + xdata = {macmillan:name,macmillan:place}, +} +@Book{..., + author = {...}, + title = {...}, + date = {...}, + xdata = {macmillan}, +} +\end{lstlisting} +% +See also \secref{bib:typ:blx,bib:fld:spc}. + \subsubsection{Electronic Publishing Information} \label{use:use:epr} @@ -4573,7 +4638,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 \sty{biblatex} package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names, especially when they are using Biber as backend. The commands discussed in the following are documented in \secref{use:fmt:fmt,aut:fmt:fmt}. This section is meant to give an overview of how they are put together. A note on terminology: a name \emph{part} is a basic part of the name, for example the first or the last name. Each part of a name may be a single name or it may be composed of multiple names. For example, the name part \enquote*{first name} may be composed of a first and a middle name. The latter are referred to as name \emph{elements} in this section. Let's consider a simple name first: \enquote{John Edward Doe}. This name is composed of the following parts: +The \sty{biblatex} package gives users and style authors very fine"=grained control of name spacing and the line"=breaking behavior of names, especially when they are using Biber as 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 first or the last name. Each part of a name may be a single name or it may be composed of multiple names. For example, the name part \enquote*{first name} may be composed of a first and a middle name. The latter are referred to as name \emph{elements} in this section. Let's consider a simple name first: \enquote{John Edward Doe}. This name is composed of the following parts: \begin{nameparts} First & John Edward \\ @@ -5370,7 +5435,7 @@ This command is similar to \cmd{printtext} except that the second argument is a \csitem{printdate} -This command prints the date of the entry, as specified in the fields \bibfield{date} or \bibfield{month}\slash \bibfield{year}. The format is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. +This command prints the date of the entry, as specified in the fields \bibfield{date} or \bibfield{month}\slash \bibfield{year}. The date format is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. Additional formatting (fonts etc.) may be applied by adjusting the field format \texttt{date} (\secref{aut:fmt:ich}). Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. \csitem{printdateextra} @@ -5378,15 +5443,15 @@ Similar to \cmd{printdate} but incorporates the \bibfield{extrayear} field in th \csitem{printurldate} -This command prints the \bibfield{urldate} of the entry. The format is controlled by the package option \opt{urldate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. +Similar to \cmd{printdate} but prints the \bibfield{urldate} of the entry. The date format is controlled by the package option \opt{urldate} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{urldate} (\secref{aut:fmt:ich}). \csitem{printorigdate} -This command prints the \bibfield{origdate} of the entry. The format is controlled by the package option \opt{origdate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. +Similar to \cmd{printdate} but prints the \bibfield{origdate} of the entry. The date format is controlled by the package option \opt{origdate} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{origdate} (\secref{aut:fmt:ich}). \csitem{printeventdate} -This command prints the \bibfield{eventdate} of the entry. The format is controlled by the package option \opt{eventdate} from \secref{use:opt:pre:gen}. Note that this command interfaces with the punctuation tracker. There is no need to wrap it in a \cmd{printtext} command. +Similar to \cmd{printdate} but prints the \bibfield{eventdate} of the entry. The date format is controlled by the package option \opt{eventdate} from \secref{use:opt:pre:gen}. Additional formatting may be applied by adjusting the field format \texttt{eventdate} (\secref{aut:fmt:ich}). \cmditem{indexfield}[format]{field} @@ -5975,6 +6040,10 @@ This command is similar to \cmd{ifmorenames} but checks the current literal list Expands to \prm{true} or \prm{false}, depending on the state of the \opt{firstinits} package option (see \secref{use:opt:pre:int}). This command is intended for use in formatting directives for name lists. +\cmditem{ifentrytype}{type}{true}{false} + +Executes \prm{true} if the entry type of the entry currently being processed is \prm{type}, and \prm{false} otherwise. + \cmditem{ifkeyword}{keyword}{true}{false} Executes \prm{true} if the \prm{keyword} is found in the \bibfield{keywords} field of the entry currently being processed, and \prm{false} otherwise. @@ -6336,6 +6405,7 @@ The optional argument \bibfield{bookpagination} is omissible in this case. \end{table} \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 commas and/or semicolons 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}. 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: @@ -6343,11 +6413,37 @@ This command, which is intended for use in field formatting directives, will par \DeclareFieldFormat{postnote}{\mkcomprange[<<{>>\mkpageprefix[pagination]<<}>>]{#1}} \end{lstlisting} % -Note that \cmd{mkcomprange} is executed first, using \cmd{mkpageprefix} as post-processor. Also note that the \prm{postpro} argument is wrapped in an additional pair of braces. This is only required in this particular case to prevent \latex's optional argument scanner from getting confused by the nested brackets. +Note that \cmd{mkcomprange} is executed first, using \cmd{mkpageprefix} as post-processor. Also note that the \prm{postpro} argument is wrapped in an additional pair of braces. This is only required in this particular case to prevent \latex's optional argument scanner from getting confused by the nested brackets. The starred version of this command differs from the regular one in the way the \prm{postpro} argument is applied to a list of values. For example: + +\begin{lstlisting}[style=latex]{} +\mkcomprange[\mkpageprefix]{5, 123-129, 423-439} +\mkcomprange*[\mkpageprefix]{5, 123-129, 423-439} +\end{lstlisting} +% +will output: + +\begin{lstlisting}[style=latex]{} +pp. 5, 123-9, 423-39 +p. 5, pp. 123-9, pp. 423-39 +\end{lstlisting} \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 commas and/or semicolons 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{lstlisting}[style=latex]{} +\mkfirstpage[\mkpageprefix]{5, 123-129, 423-439} +\mkfirstpage*[\mkpageprefix]{5, 123-129, 423-439} +\end{lstlisting} +% +will output: + +\begin{lstlisting}[style=latex]{} +pp. 5, 123, 423 +p. 5, p. 123, p. 423 +\end{lstlisting} -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 commas and/or semicolons 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. \cmditem{DeclareNumChars}{characters} \cmditem*{DeclareNumChars*}{characters} @@ -6616,7 +6712,7 @@ This definition is restored automatically whenever the \opt{autopunct} package o \cmditem{DeclareCapitalPunctuation}{characters} -When \sty{biblatex} inserts localization strings, \ie key terms such as <edition> or <volume>, it automatically capitalizes them after terminal punctuation marks. This command defines the punctuation marks which will cause localization strings to be capitalized if one of them preceds a string. Note that \prm{characters} is an undelimited list of characters. Valid \prm{characters} are period, comma, semicolon, colon, exclamation and question mark. The package default is: +When \sty{biblatex} inserts localization strings, \ie key terms such as <edition> or <volume>, it automatically capitalizes them after terminal punctuation marks. This command defines the punctuation marks which will cause localization strings to be capitalized if one of them 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{lstlisting}[style=latex]{} \DeclareCapitalPunctuation{.!?} @@ -6896,7 +6992,7 @@ The following keys refer to roles which are expressed as a function (<editor>, < \paragraph{Concatenated Editor Roles, Expressed as Functions} \label{aut:lng:key:cef} -The following keys are similar in function to \texttt{editor}, \texttt{translator}, etc. They are used to indicate additional roles of the editor, \eg <editor and translator>, <editor and foreword>. +The following keys are similar in function to \texttt{editor}, \texttt{translator}, etc. They are used to indicate additional roles of the editor, \eg\ <editor and translator>, <editor and foreword>. \begin{keymarglist} \item[editortr] Used if \bibfield{editor}\slash \bibfield{translator} are identical. @@ -6975,7 +7071,7 @@ Keys for \bibfield{editor}\slash \bibfield{annotator}\slash \bibfield{commentato \paragraph{Concatenated Translator Roles, Expressed as Functions} \label{aut:lng:key:ctf} -The following keys are similar in function to \texttt{translator}. They are used to indicate additional roles of the translator, \eg <translator and commentator>, <translator and introduction>. +The following keys are similar in function to \texttt{translator}. They are used to indicate additional roles of the translator, \eg\ <translator and commentator>, <translator and introduction>. \begin{keymarglist} \item[translatorco] Used if \bibfield{translator}\slash \bibfield{commentator} are identical. @@ -7034,7 +7130,7 @@ The following keys refer to roles which are expressed as an action (<edited by>, \paragraph{Concatenated Editor Roles, Expressed as Actions} \label{aut:lng:key:cea} -The following keys are similar in function to \texttt{byeditor}, \texttt{bytranslator}, etc. They are used to indicate additional roles of the editor, \eg <edited and translated by>, <edited and furnished with an introduction by>, <edited, with a foreword, by>. +The following keys are similar in function to \texttt{byeditor}, \texttt{bytranslator}, etc. They are used to indicate additional roles of the editor, \eg\ <edited and translated by>, <edited and furnished with an introduction by>, <edited, with a foreword, by>. \begin{keymarglist} \item[byeditortr] Used if \bibfield{editor}\slash \bibfield{translator} are identical. @@ -7090,7 +7186,7 @@ Keys for \bibfield{editor}\slash \bibfield{translator}\slash \bibfield{annotator \paragraph{Concatenated Translator Roles, Expressed as Actions} \label{aut:lng:key:cta} -The following keys are similar in function to \texttt{bytranslator}. They are used to indicate additional roles of the translator, \eg <translated and commented by>, <translated and furnished with an introduction by>, <translated, with a foreword, by>. +The following keys are similar in function to \texttt{bytranslator}. They are used to indicate additional roles of the translator, \eg\ <translated and commented by>, <translated and furnished with an introduction by>, <translated, with a foreword, by>. \begin{keymarglist} \item[bytranslatorco] Used if \bibfield{translator}\slash \bibfield{commentator} are identical. @@ -7148,10 +7244,13 @@ Roles which are related to supplementary material may also be expressed as objec \item[volumes] The plural form of \texttt{volume}. \item[jourvol] The term <volume>, referring to a journal. \item[jourser] The term <series>, referring to a journal. +\item[book] The term <book>, referring to a document division. +\item[part] The term <part>, referring to a part of a book or a periodical. +\item[issue] The term <issue>, referring to a periodical. \item[newseries] The expression <new series>, referring to a journal. \item[oldseries] The expression <old series>, referring to a journal. \item[edition] The term <edition>. -\item[in] The term <in>, referring to the title of a work published as part of another one, \eg <\prm{title of article} in \prm{title of journal}>. +\item[in] The term <in>, referring to the title of a work published as part of another one, \eg\ <\prm{title of article} in \prm{title of journal}>. \item[inseries] The term <in>, as used in expressions like <volume \prm{number} in \prm{name of series}>. \item[ofseries] The term <of>, as used in expressions like <volume \prm{number} of \prm{name of series}>. \item[number] The term <number>, referring to an issue of a journal. @@ -7166,9 +7265,10 @@ Roles which are related to supplementary material may also be expressed as objec \label{aut:lng:key:pst} \begin{keymarglist} -\item[inpress] The expression <in press>. -\item[inpreparation] The expression <in preparation>, referring to manuscript being prepared for publication. -\item[submitted] The expression <submitted>, referring to an article or paper submitted to a journal or conference. +\item[inpreparation] The expression <in preparation> (the manuscript is being prepared for publication). +\item[submitted] The expression <submitted> (the manuscript has been submitted to a journal or conference). +\item[forthcoming] The expression <forthcoming> (the manuscript has been accepted by a press or journal). +\item[inpress] The expression <in press> (the manuscript is fully copyedited and out of the author's hands; it is in the final stages of the production process). \end{keymarglist} \paragraph{Pagination} @@ -7245,8 +7345,8 @@ Traditional scholarly expressions used in citations: \item[opcit] The term equivalent to the Latin term <opere citato> (<[in] the work [already] cited>). \item[loccit] The term equivalent to the Latin term <loco citato> (<[at] the place [already] cited>). \item[confer] The term equivalent to the Latin <confer> (<compare>). -\item[sequens] The term equivalent to the Latin <sequens> (<[and] the following [page]>), as used to indicate a range of two pages when only the starting page is provided (\eg <25\,sq.> or <25\,f.> instead of <25--26>). -\item[sequentes] The term equivalent to the Latin <sequentes> (<[and] the following [pages]>), as used to indicate an open"=ended range of pages when only the starting page is provided (\eg <25\,sqq.> or <25\,ff.>). +\item[sequens] The term equivalent to the Latin <sequens> (<[and] the following [page]>), as used to indicate a range of two pages when only the starting page is provided (\eg\ <25\,sq.> or <25\,f.> instead of <25--26>). +\item[sequentes] The term equivalent to the Latin <sequentes> (<[and] the following [pages]>), as used to indicate an open"=ended range of pages when only the starting page is provided (\eg\ <25\,sqq.> or <25\,ff.>). \item[passim] The term equivalent to the Latin <passim> (<throughout>, <here and there>, <scatteredly>). \end{keymarglist} % @@ -7287,9 +7387,11 @@ Other expressions frequently used in citations: \begin{keymarglist} \item[langamerican] The language <American> or <American English>. \item[langbrazilian] The language <Brazilian> or <Brazilian Portuguese>. +\item[langcroatian] The language <Croatian>. \item[langdanish] The language <Danish>. \item[langdutch] The language <Dutch>. \item[langenglish] The language <English>. +\item[langfinnish] The language <Finnish>. \item[langfrench] The language <French>. \item[langgerman] The language <German>. \item[langgreek] The language <Greek>. @@ -7297,6 +7399,7 @@ Other expressions frequently used in citations: \item[langlatin] The language <Latin>. \item[langnorwegian] The language <Norwegian>. \item[langportuguese] The language <Portuguese>. +\item[langrussian] The language <Russian>. \item[langspanish] The language <Spanish>. \item[langswedish] The language <Swedish>. \end{keymarglist} @@ -7306,9 +7409,11 @@ The following strings are intended for use in phrases like <translated from [the \begin{keymarglist} \item[fromamerican] The expression <from [the] American> or <from [the] American English>. \item[frombrazilian] The expression <from [the] Brazilian> or <from [the] Brazilian Portuguese>. +\item[fromcroatian] The expression <from [the] Croatian>. \item[fromdanish] The expression <from [the] Danish>. \item[fromdutch] The expression <from [the] Dutch>. \item[fromenglish] The expression <from [the] English>. +\item[fromfinnish] The expression <from [the] Finnish>. \item[fromfrench] The expression <from [the] French>. \item[fromgerman] The expression <from [the] German>. \item[fromgreek] The expression <from [the] Greek>. @@ -7316,6 +7421,7 @@ The following strings are intended for use in phrases like <translated from [the \item[fromlatin] The expression <from [the] Latin>. \item[fromnorwegian] The expression <from [the] Norwegian>. \item[fromportuguese] The expression <from [the] Portuguese>. +\item[fromrussian] The expression <from [the] Russian>. \item[fromspanish] The expression <from [the] Spanish>. \item[fromswedish] The expression <from [the] Swedish>. \end{keymarglist} @@ -7499,6 +7605,10 @@ The delimiter to be printed between the author\slash editor and the title. This 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{volcitedelim} + +The delimiter to be printed between the volume portion and the page/text portion of \cmd{volcite} and related commands (\secref{use:cit:spc}). + \csitem{prenotedelim} The delimiter to be printed after the \prm{prenote} argument of a citation command. @@ -7564,6 +7674,10 @@ Similar to \cmd{mkbibordinal}, but prints a masculine ordinal, if applicable in Similar to \cmd{mkbibordinal}, but prints a feminine ordinal, if applicable in the respective language. +\cmditem{mkbibneutord}{integer} + +Similar to \cmd{mkbibordinal}, but prints a neuter ordinal, if applicable in the respective language. + \cmditem{mkbibordedition}{integer} Similar to \cmd{mkbibordinal}, but intended for use with the term <edition>. @@ -7609,6 +7723,18 @@ The penalty used by \cmd{addlowpenspace} and \cmd{addlpthinspace}, see \secref{a The penalty used by \cmd{addhighpenspace} and \cmd{addhpthinspace}, see \secref{aut:pct:spc} for details. +\cntitem{biburlnumpenalty} + +If this counter is set to a value greater than zero, \sty{biblatex} will permit linebreaks after numbers in all strings formatted with the \cmd{url} command from the \sty{url} package. This will affect \acr{url}s and \acr{doi}s in the bibliography. The breakpoints will be penalized by the value of this counter. If \acr{url}s and/or \acr{doi}s in the bibliography run into the margin, try setting this counter to a value greater than zero but less than 10000 (you normally want to use a high value like 9000). Setting the counter to zero disables this feature. This is the default setting. + +\cntitem{biburlucpenalty} + +Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all uppercase letters. + +\cntitem{biburllcpenalty} + +Similar to \cnt{biburlnumpenalty}, except that it will add a breakpoint after all lowercase letters. + \end{ltxsyntax} \subsubsection{Auxiliary Commands and Hooks} @@ -7730,6 +7856,22 @@ A special formatting directive which controls the format of the page\slash text A special formatting directive which controls the format of the volume portion in the argument of citation commands like \cmd{volcite}. +\optitem{date} + +A special formatting directive which controls the format of \cmd{printdate} (\secref{aut:bib:dat}). Note that the date format (long/short etc.) is controlled by the package option \opt{date} from \secref{use:opt:pre:gen}. This formatting directive only controls additional formatting such as fonts etc. + +\optitem{urldate} + +Similar to \texttt{date} but controls the format of \cmd{printurldate}. + +\optitem{origdate} + +Similar to \texttt{date} but controls the format of \cmd{printorigdate}. + +\optitem{eventdate} + +Similar to \texttt{date} but controls the format of \cmd{printeventdate}. + \end{ltxsyntax} \subsubsection{Auxiliary Lengths, Counters, and Other Features} @@ -8723,7 +8865,7 @@ anyvt & presort\alt mm & \end{longtable} \endgroup -\subsection[Chronological ]{Chronological Schemes} +\subsection[Chronological]{Chronological Schemes} \label{apx:srt:chr} The following table shows the chronological sorting schemes defined by default. Please refer to \secref{use:srt} for explanation. @@ -8755,6 +8897,120 @@ ydnt & presort\alt mm & \end{longtable} \endgroup +\section{Option Scope} +\label{apx:opt} + +The following table provides an overview of the scope (global\slash per-type\slash per-entry) of various package options. + +\begingroup +\tablesetup +\let\+\tickmarkyes +\let\_\tickmarkno +\begin{longtable}[l]{@{}% + V{0.4\textwidth}@{}% + C{0.15\textwidth}@{}% + C{0.15\textwidth}@{}% + C{0.15\textwidth}@{}% + C{0.15\textwidth}@{}} +\toprule +\multicolumn{1}{@{}H}{Option} & +\multicolumn{4}{@{}H}{Scope} \\ +\cmidrule{2-5} +& \multicolumn{1}{@{}H}{Load-time} & +\multicolumn{1}{@{}H}{Global} & +\multicolumn{1}{@{}H}{Per-type} & +\multicolumn{1}{@{}H}{Per-entry} \\ +\cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule(r){4-4}\cmidrule{5-5} +\endhead +\bottomrule +\endfoot +abbreviate &\+&\+&\_&\_\\ +alldates &\+&\+&\_&\_\\ +arxiv &\+&\+&\_&\_\\ +autocite &\+&\+&\_&\_\\ +autopunct &\+&\+&\_&\_\\ +babel &\+&\+&\_&\_\\ +backend &\+&\+&\_&\_\\ +backref &\+&\+&\_&\_\\ +backrefsetstyle &\+&\+&\_&\_\\ +backrefstyle &\+&\+&\_&\_\\ +bibencoding &\+&\+&\_&\_\\ +bibstyle &\+&\_&\_&\_\\ +bibwarn &\+&\+&\_&\_\\ +block &\+&\+&\_&\_\\ +citecounter &\+&\+&\_&\_\\ +citereset &\+&\+&\_&\_\\ +citestyle &\+&\_&\_&\_\\ +citetracker &\+&\+&\_&\_\\ +clearlang &\+&\+&\_&\_\\ +dataonly &\_&\_&\+&\+\\ +date &\+&\+&\_&\_\\ +dateabbrev &\+&\+&\_&\_\\ +datezeros &\+&\+&\_&\_\\ +defernumbers &\+&\+&\_&\_\\ +doi &\+&\+&\_&\_\\ % style +eprint &\+&\+&\_&\_\\ % style +eventdate &\+&\+&\_&\_\\ +firstinits &\+&\+&\_&\_\\ +hyperref &\+&\+&\_&\_\\ +ibidtracker &\+&\+&\_&\_\\ +idemtracker &\+&\+&\_&\_\\ +indexing &\+&\+&\+&\+\\ +isbn &\+&\+&\_&\_\\ % style +labelalpha &\+&\+&\+&\_\\ +labelnumber &\+&\+&\+&\_\\ +labelyear &\+&\+&\+&\_\\ +language &\+&\+&\_&\_\\ +loadfiles &\+&\+&\_&\_\\ +loccittracker &\+&\+&\_&\_\\ +maxalphanames &\+&\+&\+&\+\\ +maxbibnames &\+&\+&\+&\+\\ +maxcitenames &\+&\+&\+&\+\\ +maxitems &\+&\+&\+&\+\\ +maxnames &\+&\+&\+&\+\\ +maxparens &\+&\+&\_&\_\\ +mcite &\+&\_&\_&\_\\ +minalphanames &\+&\+&\+&\+\\ +minbibnames &\+&\+&\+&\+\\ +mincitenames &\+&\+&\+&\+\\ +mincrossrefs &\+&\+&\_&\_\\ +minitems &\+&\+&\+&\+\\ +minnames &\+&\+&\+&\+\\ +natbib &\+&\_&\_&\_\\ +notetype &\+&\+&\_&\_\\ +opcittracker &\+&\+&\_&\_\\ +openbib &\+&\+&\_&\_\\ +origdate &\+&\+&\_&\_\\ +pagetracker &\+&\+&\_&\_\\ +parentracker &\+&\+&\_&\_\\ +punctfont &\+&\+&\_&\_\\ +refsection &\+&\+&\_&\_\\ +refsegment &\+&\+&\_&\_\\ +safeinputenc &\+&\+&\_&\_\\ +singletitle &\+&\+&\+&\_\\ +skipbib &\_&\_&\+&\+\\ +skiplab &\_&\_&\+&\+\\ +skiplos &\_&\_&\+&\+\\ +sortcase &\+&\+&\_&\_\\ +sortcites &\+&\+&\_&\_\\ +sorting &\+&\+&\_&\_\\ +sortlocale &\+&\+&\_&\_\\ +sortlos &\+&\+&\_&\_\\ +sortupper &\+&\+&\_&\_\\ +style &\+&\_&\_&\_\\ +terseinits &\+&\+&\_&\_\\ +texencoding &\+&\+&\_&\_\\ +uniquelist &\+&\+&\+&\+\\ +uniquename &\+&\+&\+&\+\\ +urldate &\+&\+&\_&\_\\ +url &\+&\+&\_&\_\\ % style +useauthor &\+&\+&\+&\+\\ +useeditor &\+&\+&\+&\+\\ +useprefix &\+&\+&\+&\+\\ +usetranslator &\+&\+&\+&\+\\ +\end{longtable} +\endgroup + \section{Revision History} \label{apx:log} @@ -8762,6 +9018,36 @@ This revision history is a list of changes relevant to users of this package. Ch \begin{changelog} +\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 \cmd{textcite} and \cmd{textcites} to all \texttt{verbose} citation styles\see{use:xbx:cbx} +\item Added special field formats \texttt{date}, \texttt{urldate}, \texttt{origdate}, \texttt{eventdate}\see{aut:fmt:ich} +\item Added \cmd{mkcomprange*}\see{aut:aux:msc} +\item Added \cmd{mkfirstpage*}\see{aut:aux:msc} +\item Added \cmd{volcitedelim}\see{aut:fmt:fmt} +\item Added missing documentation for \cmd{ifentrytype}\see{aut:aux:tst} +\item Added \cmd{mkbibneutord}\see{use:fmt:lng} +\item Added counter \cnt{biburlnumpenalty}\see{aut:fmt:len} +\item Added counter \cnt{biburlucpenalty}\see{aut:fmt:len} +\item Added counter \cnt{biburllcpenalty}\see{aut:fmt:len} +\item Added 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 Expanded documentation\see{apx:opt} +\item Added support for Russian (Oleg Domanov) +\item Updated support for Dutch (Pieter Belmans) +\item Fixed compatibility issue with \sty{textcase} package +\item Fixed some bugs +\end{release} + \begin{release}{1.6}{2011-07-29} \item Added special field \bibfield{sortshorthand}\see{bib:fld:spc}\BiberOnlyMark \item Revised options \opt{maxnames}/\opt{minnames}\see{use:opt:pre:gen} |