diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/biblatex/README | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/biblatex/RELEASE | 89 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/biblatex/biblatex.pdf | bin | 854887 -> 861637 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/biblatex/biblatex.tex | 183 |
4 files changed, 217 insertions, 57 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex/README b/Master/texmf-dist/doc/latex/biblatex/README index 9328f044651..f54904fb4a6 100644 --- a/Master/texmf-dist/doc/latex/biblatex/README +++ b/Master/texmf-dist/doc/latex/biblatex/README @@ -1,4 +1,4 @@ -$Id: README,v 1.5 2011/06/08 18:45:46 lehman stable $ +$Id: README,v 1.6 2011/07/29 19:21:28 lehman stable $ ABOUT diff --git a/Master/texmf-dist/doc/latex/biblatex/RELEASE b/Master/texmf-dist/doc/latex/biblatex/RELEASE index 5db802a3067..120b203a565 100644 --- a/Master/texmf-dist/doc/latex/biblatex/RELEASE +++ b/Master/texmf-dist/doc/latex/biblatex/RELEASE @@ -1,11 +1,94 @@ -$Id: RELEASE,v 1.5 2011/06/08 18:45:46 lehman stable $ +$Id: RELEASE,v 1.6 2011/07/29 19:21:28 lehman stable $ + +RELEASE NOTES FOR VERSION 1.6 + +* Biber update, new mapping feature + + Biblatex 1.6 requires Biber 0.9.4. It will not work with any + previous release. Biber now supports user-space field mapping. + This means that you can set up mapping rules in the Biber + configuration file to deal with non-standard field names in .bib + files by mapping them to known field names. + +* Revised maxnames/minnames options + + Biber now supports max/mincitenames and max/minbibnames as + separate values. This improvement has prompted a refactoring of + the corresponding package options. In previous versions, there + were three sets of values: + + max/minnames -> backend+frontend default + max/mincitenames -> frontend only + max/minbibnames -> frontend only + + The backend would get max/minnames, the other values were only + used on the LaTeX end, defaulting to max/minnames. Depending on + the citation style, this could lead to ambiguous citations if + max/minnames was out of sync with max/mincitenames. (This wasn't + really obvious from reading the manual.) + + This can no longer happen. The new solution is simpler and + error-proof in this respect. The max/mincitenames and + max/minbibnames options do what their name indicates and are fully + supported by Biber. The max/minnames options now serve as master + options which set both max/minbibnames and max/mincitenames: + + max/minnames -> max/mincitenames + -> max/minbibnames + max/mincitenames -> frontend+backend + max/minbibnames -> frontend+backend + + We didn't bother to update the BibTeX backend as it is due to be + discontinued this fall anyway. The BibTeX backend will get the + max/mincitenames values only. + +* [CAVEAT] Removed local max/minnames and max/minitems options + + As part of the above change, I've removed the local max/minnames + and max/minitems options from \printbibliography and friends to + enforce consistency. Please use the global options instead. + +* Added maxalphanames/minalphanames [Biber only] + + With Biber, the 'labelalpha' field may now be configured + independently of max/mincitenames with the newly introduced + package options max/minalphanames. + +* MD5 hashes, per-name hashes [Biber only] + + With Biber, the hashes provided in the namehash/fullhash fields + are now standard MD5 hashes. This means that they are stable + across multiple runs, multiple refsections, and multiple + documents. + + We've also added per-name hashes. Every name in every name list + gets an MD5 hash, which is available in the 'hash' field. Note + that this field is only available locally in name formatting + directives. + +* Range compression/truncation + + This release features a new command for range compression (i.e., + format "123-128" as "123-8"). The command is configurable, can + handle lists of ranges separated by commas and/or semicolons, and + also normalizes the dashes. Note that combining this with + \mkpageprefix requires the field format to be set up in a specific + way. See \mkcomprange in the manual for details. + + I've also overhauled the command which truncates ranges by only + printing the starting page of the range. The original + \mkpagefirst has been removed because of its awkward syntax. It is + superseded by \mkfirstpage. Note that this change is not + backwards-compatible because the syntax of the new command is + slightly different. You may need to update some format + definitions. RELEASE NOTES FOR VERSION 1.5 * Biber update - Biblatex 1.5 requires Biber 0.9.3 or higher. It will not work with - any previous release. + Biblatex 1.5 requires Biber 0.9.3. It will not work with any + previous release. * More name disambiguation modes [Biber only] diff --git a/Master/texmf-dist/doc/latex/biblatex/biblatex.pdf b/Master/texmf-dist/doc/latex/biblatex/biblatex.pdf Binary files differindex fd5bf642852..2e1f9c64133 100644 --- a/Master/texmf-dist/doc/latex/biblatex/biblatex.pdf +++ b/Master/texmf-dist/doc/latex/biblatex/biblatex.pdf diff --git a/Master/texmf-dist/doc/latex/biblatex/biblatex.tex b/Master/texmf-dist/doc/latex/biblatex/biblatex.tex index a2620276361..9b4df45b42c 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.5 2011/06/08 18:45:46 lehman stable $ +% $Id: biblatex.tex,v 1.6 2011/07/29 19:21:28 lehman stable $ \documentclass{ltxdockit}[2011/03/25] \usepackage{btxdockit} \usepackage[latin9]{inputenc} @@ -12,7 +12,7 @@ \MakeAutoQuote*{<}{>} \MakeShortVerb{\|} -\rcsid{$Id: biblatex.tex,v 1.5 2011/06/08 18:45:46 lehman stable $} +\rcsid{$Id: biblatex.tex,v 1.6 2011/07/29 19:21:28 lehman stable $} \newcommand*{\biber}{Biber\xspace} \newcommand*{\biblatex}{Biblatex\xspace} @@ -48,6 +48,9 @@ \def\alt{\par\makebox[1.25em][r]{\ensuremath\hookrightarrow}\,}% \def\note##1{\textrm{##1}}} +\providecommand*{\textln}[1]{#1} +\providecommand*{\lnstyle}{} + % markup and misc \setcounter{secnumdepth}{4} @@ -1083,6 +1086,10 @@ 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. It is only used internally during sorting. Please refer to \secref{use:srt} for further details. +\fielditem{sortshorthand}{literal\BiberOnlyMark} + +Similar to \bibfield{sortkey} but used in the list of shorthands. If present, \sty{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 only used internally during sorting. + \fielditem{sorttitle}{literal} A field used to modify the sorting order of the bibliography. If present, this field is used instead of the \bibfield{title} field when sorting the bibliography. It is only used internally during sorting. The \bibfield{sorttitle} field may come in handy if you have an entry with a title like «An Introduction to\dots» and want that alphabetized under <I> rather than <A>. In this case, you could put «Introduction to\dots» in the \bibfield{sorttitle} field. Please refer to \secref{use:srt} for further details. @@ -1559,7 +1566,7 @@ These warning messages could indeed indicate that the entry \texttt{Jones1995} i \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 +\tablesetup\lnstyle \begin{tabularx}{\textwidth}{@{}>{\raggedright\ttfamily}X% @{}>{\raggedright\ttfamily}X% rR{50pt}R{50pt}R{50pt}@{}} @@ -1874,27 +1881,27 @@ Whether or not to sort citations if multiple entry keys are passed to a citation \intitem[3]{maxnames} -A threshold affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list exceeds this threshold, \ie if it contains more than \prm{integer} names, it is automatically truncated according to the setting of the \opt{minnames} option. +A threshold affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list exceeds this threshold, \ie if it holds more than \prm{integer} names, it is automatically truncated according to the setting of the \opt{minnames} option. \opt{maxnames} is the master option which sets both \opt{maxbibnames} and \opt{maxcitenames}. \intitem[1]{minnames} -A limit affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list contains more than \prm{maxnames} names, it is automatically truncated to \prm{minnames} names in citations and in the bibliography. This also affects the sorting of the bibliography and the generation of labels. The \prm{minnames} value must be smaller than or equal to \prm{maxnames}. +A limit affecting all lists of names (\bibfield{author}, \bibfield{editor}, etc.). If a list holds more than \prm{maxnames} names, it is automatically truncated to \prm{minnames} names. The \prm{minnames} value must be smaller than or equal to \prm{maxnames}. \opt{minnames} is the master option which sets both \opt{minbibnames} and \opt{mincitenames}. \intitem[\prm{maxnames}]{maxbibnames} -The \opt{maxnames} and \opt{minnames} options may also be used locally in the optional arguments of \cmd{printbibliography} and \cmd{printshorthands} (see \secref{use:bib:bib,use:bib:los}). The \opt{maxbibnames} and \opt{minbibnames} options have precisely the same effect, except that they are settable in the preamble. Note that \prm{maxbibnames} should normally not be less then \prm{maxnames} because the latter affects the generation of labels. +Similar to \opt{maxnames} but affects only the bibliography. \intitem[\prm{minnames}]{minbibnames} -Similar to \opt{maxbibnames} but defining the lower limit. This value must must be smaller than or equal to \prm{maxbibnames}. Note that \prm{minbibnames} should normally not be less then \prm{minnames} because the latter affects the generation of labels. +Similar to \opt{minnames} but affects only the bibliography. \intitem[\prm{maxnames}]{maxcitenames} -The number of names printed in citations normally corresponds to the \prm{maxnames} and \prm{minnames} values. The \opt{maxcitenames} and \opt{mincitenames} options define different values for use in all citations. Note that \prm{maxcitenames} should normally not be less then \prm{maxnames} because the latter affects the generation of labels. +Similar to \opt{maxnames} but affects only the citations in the document body. \intitem[\prm{minnames}]{mincitenames} -Similar to \opt{maxcitenames} but defining the lower limit. This value must be smaller than or equal to \prm{maxcitenames}. Note that \prm{mincitenames} should normally not be less then \prm{minnames} because the latter affects the generation of labels. +Similar to \opt{minnames} but affects only the citations in the document body. \intitem[3]{maxitems} @@ -2074,7 +2081,7 @@ This option controls whether external files requested by way of the \cmd{printfi \optitem[none]{refsection}{\opt{none}, \opt{part}, \opt{chapter}, \opt{section}, \opt{subsection}} -This option automatically starts a new reference section at a document division such as a chapter or a section. This is equivalent to a \cmd{newrefsection} command, see \secref{use:bib:sec} for details. The following choice of document divisions is available: +This option automatically starts a new reference section at a document division such as a chapter or a section. This is equivalent to the \cmd{newrefsection} command, see \secref{use:bib:sec} for details. The following choice of document divisions is available: \begin{valuelist} \item[none] Disable this feature. @@ -2083,10 +2090,12 @@ This option automatically starts a new reference section at a document division \item[section] Start a reference section at every \cmd{section} command. \item[subsection] Start a reference section at every \cmd{subsection} command. \end{valuelist} +% +The starred versions if these commands will not start a new reference section. \optitem[none]{refsegment}{\opt{none}, \opt{part}, \opt{chapter}, \opt{section}, \opt{subsection}} -Similar to the \opt{refsection} option but starts a new reference segment. This is equivalent to a \cmd{newrefsegment} command, see \secref{use:bib:seg} for details. When using both options, note that you can only apply this option to a lower"=level document division than the one \opt{refsection} is applied to and that nested reference segments will be local to the enclosing reference section. +Similar to the \opt{refsection} option but starts a new reference segment. This is equivalent to the \cmd{newrefsegment} command, see \secref{use:bib:seg} for details. When using both options, note that you can only apply this option to a lower"=level document division than the one \opt{refsection} is applied to and that nested reference segments will be local to the enclosing reference section. \optitem[none]{citereset}{\opt{none}, \opt{part}, \opt{chapter}, \opt{section}, \opt{subsection}} @@ -2099,6 +2108,8 @@ This option automatically executes the \cmd{citereset} command from \secref{use: \item[section] Perform a reset at every \cmd{section} command. \item[subsection] Perform a reset at every \cmd{subsection} command. \end{valuelist} +% +The starred versions if these commands will not trigger a reset. \boolitem[true]{abbreviate} @@ -2379,7 +2390,15 @@ This option controls the format of initials generated by \sty{biblatex}. If enab \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. +\BiberOnlyMark With Biber, this option is also settable on a per-type basis. See also \opt{maxalphanames} and \opt{minalphanames}. + +\intitem[3]{maxalphanames}[\BiberOnly] + +Similar to the \opt{maxnames} option but customizes the format of the \bibfield{labelalpha} field. + +\intitem[1]{minalphanames}[\BiberOnly] + +Similar to the \opt{minnames} option but customizes the format of the \bibfield{labelalpha} field. \boolitem[false]{labelnumber} @@ -2680,7 +2699,7 @@ This style prints all bibliographic data in tabular format. It is intended for d This package supports various sorting schemes for the bibliography. The sorting scheme is selected with the \opt{sorting} package option from \secref{use:opt:pre:gen}. Apart from the regular data fields there are also some special fields which may be used to optimize the sorting of the bibliography. \Apxref{apx:srt:a1, apx:srt:a2} give an outline of the alphabetic sorting schemes supported by \sty{biblatex}. Chronological sorting schemes are listed in \apxref{apx:srt:chr}. A few explanations concerning these schemes are in order. -The first item considered in the sorting process is always the \bibfield{presort} field of the entry. If this field is undefined, \sty{biblatex} will use the default value <\texttt{mm}> as a presort string. The next item considered is the \bibfield{sortkey} field. If this field is defined, it serves as the master sort key. Apart from the \bibfield{presort} field, no further data is considered in this case. If the \bibfield{sortkey} field is undefined, sorting continues with the name. The package will try using the \bibfield{sortname}, \bibfield{author}, \bibfield{editor}, and \bibfield{translator} fields, in this order. Which fields are considered also depends on the setting of the \opt{useauthor}, \opt{useeditor}, and \opt{usetranslator} options. If all three of them are disabled, the \bibfield{sortname} field is ignored as well. Note that all name fields are responsive to the setting of the global \opt{maxnames} and \opt{minnames} options. If no name field is available, either because all of them are undefined or because \opt{useauthor}, \opt{useeditor}, and \opt{usetranslator} are disabled, \sty{biblatex} will fall back to the \bibfield{sorttitle} and \bibfield{title} fields as a last resort. The remaining items are, in various order: the \bibfield{sortyear} field, if defined, or the first four digits of the \bibfield{year} field otherwise; the \bibfield{sorttitle} field, if defined, or the \bibfield{title} field otherwise; the \bibfield{volume} field, which is padded to four digits with leading zeros, or the string \texttt{0000} otherwise. Note that the sorting schemes shown in \apxref{apx:srt:a2} include an additional item: \bibfield{labelalpha} is the label used by <alphabetic> bibliography styles. Strictly speaking, the string used for sorting is \bibfield{labelalpha}~+ \bibfield{extraalpha}. The sorting schemes in \apxref{apx:srt:a2} are intended to be used in conjunction with alphabetic styles only. +The first item considered in the sorting process is always the \bibfield{presort} field of the entry. If this field is undefined, \sty{biblatex} will use the default value <\texttt{mm}> as a presort string. The next item considered is the \bibfield{sortkey} field. If this field is defined, it serves as the master sort key. Apart from the \bibfield{presort} field, no further data is considered in this case. If the \bibfield{sortkey} field is undefined, sorting continues with the name. The package will try using the \bibfield{sortname}, \bibfield{author}, \bibfield{editor}, and \bibfield{translator} fields, in this order. Which fields are considered also depends on the setting of the \opt{useauthor}, \opt{useeditor}, and \opt{usetranslator} options. If all three of them are disabled, the \bibfield{sortname} field is ignored as well. Note that all name fields are responsive to \opt{maxnames} and \opt{minnames}. If no name field is available, either because all of them are undefined or because \opt{useauthor}, \opt{useeditor}, and \opt{usetranslator} are disabled, \sty{biblatex} will fall back to the \bibfield{sorttitle} and \bibfield{title} fields as a last resort. The remaining items are, in various order: the \bibfield{sortyear} field, if defined, or the first four digits of the \bibfield{year} field otherwise; the \bibfield{sorttitle} field, if defined, or the \bibfield{title} field otherwise; the \bibfield{volume} field, which is padded to four digits with leading zeros, or the string \texttt{0000} otherwise. Note that the sorting schemes shown in \apxref{apx:srt:a2} include an additional item: \bibfield{labelalpha} is the label used by <alphabetic> bibliography styles. Strictly speaking, the string used for sorting is \bibfield{labelalpha}~+ \bibfield{extraalpha}. The sorting schemes in \apxref{apx:srt:a2} are intended to be used in conjunction with alphabetic styles only. The chronological sorting schemes presented in \apxref{apx:srt:chr} also make use of the \bibfield{presort} and \bibfield{sortkey} fields, if defined. The next item considered is the \bibfield{sortyear} or the \bibfield{year} field, depending on availability. The \opt{ynt} scheme extracts the first four Arabic figures from the field. If both fields are undefined, the string \texttt{9999} is used as a fallback value. This means that all entries without a year will be moved to the end of the list. The \opt{ydnt} scheme is similar in concept but sorts the year in descending order. As with the \opt{ynt} scheme, the string \texttt{9999} is used as a fallback value. The remaining items are similar to the alphabetic sorting schemes discussed above. Note that the \opt{ydnt} sorting scheme will only sort the date in descending order. All other items are sorted in ascending order as usual. @@ -2782,22 +2801,6 @@ The prenote is an arbitrary piece of text to be printed after the heading but be The postnote is an arbitrary piece of text to be printed after the list of references. This option selects the postnote \prm{name}, as defined with \cmd{defbibnote}. By default, no postnote is printed. The note is printed in the standard text font. It is not affected by \cmd{bibsetup} and \cmd{bibfont} but it may contain its own font declarations. See \secref{use:bib:nts} for details. -\intitem{maxnames} - -The threshold for all lists of names. This option overrides the \opt{maxnames} package option locally. The value may not be smaller than the global setting. - -\intitem{minnames} - -The name limit affecting all lists of names. This option overrides the \opt{minnames} package option locally. The value may not be smaller than the global setting. - -\intitem{maxitems} - -The threshold for all literal lists. This option overrides the \opt{maxitems} package option locally. - -\intitem{minitems} - -The item limit affecting all literal lists. This option overrides the \opt{minitems} package option locally. - \intitem[0]{section} Print only entries cited in reference section \prm{integer}. The reference sections are numbered starting at~1. All citations given outside a \env{refsection} environment are assigned to section~0. See \secref{use:bib:sec} for details and \secref{use:use:mlt} for usage examples. When giving a chain of multiple filters, the \texttt{section} filter must always be given first. @@ -2864,15 +2867,15 @@ This option applies to numerical citation\slash bibliography styles only and req \cmditem{bibbysection}[key=value, \dots] -This command automatically loops over all reference sections. This is equivalent to giving one \cmd{printbibliography} command for every section but has the additional benefit of automatically skipping sections without references. Note that \cmd{bibbysection} starts looking for references in section \texttt{1}. It will ignore references given outside of \env{refsection} environments since they are assigned to section~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}, \opt{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}. +This command automatically loops over all reference sections. This is equivalent to giving one \cmd{printbibliography} command for every section but has the additional benefit of automatically skipping sections without references. Note that \cmd{bibbysection} starts looking for references in section \texttt{1}. It will ignore references given outside of \env{refsection} environments since they are assigned to section~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}. \cmditem{bibbysegment}[key=value, \dots] -This command automatically loops over all reference segments. This is equivalent to giving one \cmd{printbibliography} command for every segment but has the additional benefit of automatically skipping segments without references. Note that \cmd{bibbysegment} starts looking for references in segment \texttt{1}. It will ignore references given outside of \env{refsegment} environments since they are assigned to segment~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}, \opt{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}, and \opt{section}. +This command automatically loops over all reference segments. This is equivalent to giving one \cmd{printbibliography} command for every segment but has the additional benefit of automatically skipping segments without references. Note that \cmd{bibbysegment} starts looking for references in segment \texttt{1}. It will ignore references given outside of \env{refsegment} environments since they are assigned to segment~0. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{heading}, \opt{prenote}, \opt{postnote}. \cmditem{bibbycategory}[key=value, \dots] -This command loops over all bibliography categories. This is equivalent to giving one \cmd{printbibliography} command for every category but has the additional benefit of automatically skipping empty categories. The categories are processed in the order in which they were declared. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{prenote}, \opt{postnote}, \opt{maxnames}, \opt{minnames}, \opt{maxitems}, \opt{minitems}, and \opt{section}. Note that \opt{heading} is not available with this command. The name of the current category is automatically used as the heading name. This is equivalent to passing \texttt{heading=\prm{category}} to \cmd{printbibliography} and implies that there must be a matching heading definition for every category. +This command loops over all bibliography categories. This is equivalent to giving one \cmd{printbibliography} command for every category but has the additional benefit of automatically skipping empty categories. The categories are processed in the order in which they were declared. See \secref{use:use:mlt} for usage examples. The options are a subset of those supported by \cmd{printbibliography}. Valid options are \opt{env}, \opt{prenote}, \opt{postnote}, \opt{section}. Note that \opt{heading} is not available with this command. The name of the current category is automatically used as the heading name. This is equivalent to passing \texttt{heading=\prm{category}} to \cmd{printbibliography} and implies that there must be a matching heading definition for every category. \cmditem{printbibheading}[key=value, \dots] @@ -3350,7 +3353,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. +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}. \cmditem{pvolcite}[prenote]{volume}[page]{key} \cmditem{Pvolcite}[prenote]{volume}[page]{key} @@ -3783,7 +3786,7 @@ The delimiter printed between the author\slash editor and the year by author-yea \csitem{labelalphaothers} -A string to be appended to the non"=numeric portion of the \bibfield{labelalpha} field (\ie the field holding the citation label used by alphabetic citation styles) if the number of authors\slash editors exceeds the \opt{maxnames} threshold or the \bibfield{author}\slash \bibfield{editor} list was truncated in the \file{bib} file with the keyword <\texttt{and others}>. This will typically be a single character such as a plus sign or an asterisk. The default is a plus sign. This command may also be redefined to an empty string to disable this feature. In any case, it must be redefined in the preamble. +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} @@ -4998,25 +5001,17 @@ When citing a subentry of an entry set, \sty{biblatex} provides the data of the 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} + +This field is special in that it is only available locally in name formatting directives. It holds a hash string which uniquely identifies individual names in a name list. This information is available for all names in all name lists. See also \bibfield{namehash} and \bibfield{fullhash}. + \fielditem{namehash}{string} -A unique hash string derived from the \bibfield{labelname} list. This is intended for recurrence checks. For example, a citation style wich replaces recurrent authors or editors with a string like <idem> could save the \bibfield{namehash} field with \cmd{savefield} and use it in a comparison with \cmd{iffieldequals} later (see \secref{aut:aux:dat, aut:aux:tst}). The \bibfield{namehash} is derived from the truncated \bibfield{labelname} list, \ie it is responsive to the global \opt{maxnames} and \opt{minnames} options. It is automatically sanitized such that the hash may safely be used in the formation of control sequence names. It is not intended for printing. See also \bibfield{fullhash}. +A hash string which uniquely identifies the \bibfield{labelname} list. This is useful for recurrence checks. For example, a citation style wich replaces recurrent authors or editors with a string like <idem> could save the \bibfield{namehash} field with \cmd{savefield} and use it in a comparison with \cmd{iffieldequals} later (see \secref{aut:aux:dat, aut:aux:tst}). The \bibfield{namehash} is derived from the truncated \bibfield{labelname} list, \ie it is responsive to \opt{maxnames} and \opt{minnames}. See also \bibfield{hash} and \bibfield{fullhash}. \fielditem{fullhash}{string} -Like \bibfield{namehash}, this field is a unique hash string referring to the primary name of the entry. It differs from \bibfield{namehash} in two respects: 1) The \bibfield{shortauthor} and \bibfield{shorteditor} lists are ignored when generating the hash. 2) It is always derived from the full list, ignoring the \opt{maxnames} and \opt{minnames} options. For example, with \kvopt{maxnames}{1}, the following two entries will have the same \bibfield{namehash} but different \bibfield{fullhash} values: - -\begin{lstlisting}[style=bibtex]{} -@Article{..., - author = {Doe, John and Jones, Edward}, - ... - -@Article{..., - author = {Doe, John and Williams, Joe}, - ... -\end{lstlisting} -% -The \bibfield{fullhash} field is automatically sanitized such that the hash may safely be used in the formation of control sequence names. It is not intended for printing. See also \bibfield{namehash}. +A hash string which uniquely identifies the \bibfield{labelname} list. This fields differs from \bibfield{namehash} in two details: 1) The \bibfield{shortauthor} and \bibfield{shorteditor} lists are ignored when generating the hash. 2) The hash always refers to the full list, ignoring \opt{maxnames} and \opt{minnames}. See also \bibfield{hash} and \bibfield{namehash}. \listitem{pageref}{literal} @@ -6285,7 +6280,7 @@ The problem with this convention is that the braces will suppress the kerning on \cmditem{mkpageprefix}[pagination][postpro]{text} -This command is intended for use in field formatting directives which format the page numbers in the \prm{postnote} argument of citation commands and the \bibfield{pages} field of bibliography entries. It will parse its \prm{text} argument and prefix it with <p.> or <pp.> by default. The optional \prm{pagination} argument holds the name of a field indicating the pagination type. This may be either \bibfield{pagination} or \bibfield{bookpagination}, with \bibfield{pagination} being the default. The spacing between the prefix and the \prm{text} may be modified by redefining \cmd{ppspace}. The default is an unbreakable interword space. See \secref{bib:use:pag, use:cav:pag} for further details. See also \cmd{DeclareNumChars}, \cmd{DeclareRangeChars}, \cmd{DeclareRangeCommands}, and \cmd{NumCheckSetup}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This must be a macro taking one mandatory argument. If only one optional argument is given, it is taken as \prm{pagination}. Here are two typical examples: +This command is intended for use in field formatting directives which format the page numbers in the \prm{postnote} argument of citation commands and the \bibfield{pages} field of bibliography entries. It will parse its \prm{text} argument and prefix it with <p.> or <pp.> by default. The optional \prm{pagination} argument holds the name of a field indicating the pagination type. This may be either \bibfield{pagination} or \bibfield{bookpagination}, with \bibfield{pagination} being the default. The spacing between the prefix and the \prm{text} may be modified by redefining \cmd{ppspace}. The default is an unbreakable interword space. See \secref{bib:use:pag, use:cav:pag} for further details. See also \cmd{DeclareNumChars}, \cmd{DeclareRangeChars}, \cmd{DeclareRangeCommands}, and \cmd{NumCheckSetup}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. If only one optional argument is given, it is taken as \prm{pagination}. Here are two typical examples: \begin{lstlisting}[style=latex]{} \DeclareFieldFormat{postnote}{<<\mkpageprefix[pagination]{#1}>>} @@ -6296,7 +6291,7 @@ The optional argument \bibfield{pagination} in the first example is omissible. \cmditem{mkpagetotal}[pagination][postpro]{text} -This command is similar to \cmd{mkpageprefix} except that it is intended for the \bibfield{pagetotal} field of bibliography entries, \ie it will print «123 pages» rather than «page 123». The optional \prm{pagination} argument defaults to \bibfield{bookpagination}. The spacing inserted between the pagination suffix and the \prm{text} may be modified by redefining the macro \cmd{ppspace}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This must be a macro taking one mandatory argument. If only one optional argument is given, it is taken as \prm{pagination}. Here is a typical example: +This command is similar to \cmd{mkpageprefix} except that it is intended for the \bibfield{pagetotal} field of bibliography entries, \ie it will print «123 pages» rather than «page 123». The optional \prm{pagination} argument defaults to \bibfield{bookpagination}. The spacing inserted between the pagination suffix and the \prm{text} may be modified by redefining the macro \cmd{ppspace}. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. If only one optional argument is given, it is taken as \prm{pagination}. Here is a typical example: \begin{lstlisting}[style=latex]{} \DeclareFieldFormat{pagetotal}{<<\mkpagetotal[bookpagination]{#1}>>} @@ -6304,10 +6299,55 @@ This command is similar to \cmd{mkpageprefix} except that it is intended for the % The optional argument \bibfield{bookpagination} is omissible in this case. -\cmditem{mkpagefirst}[pagination][postpro]{text} -\cmditem*{mkpagefirst*}[postpro]{text} +\begin{table} +\tablesetup\lnstyle +\begin{tabularx}{\textwidth}{@{}>{\ttfamily}X@{}p{0.25\textwidth}@{}p{0.25\textwidth}@{}p{0.25\textwidth}@{}} +\toprule +\multicolumn{1}{@{}H}{Input} & +\multicolumn{3}{@{}H}{Output} \\ +\cmidrule(r){1-1}\cmidrule{2-4} +& \multicolumn{1}{@{}H}{\ttfamily mincomprange=10} +& \multicolumn{1}{@{}H}{\ttfamily mincomprange=100} +& \multicolumn{1}{@{}H}{\ttfamily mincomprange=1000} \\ +\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4} +11--15 & 11--5 & 11--15 & 11--15 \\ +111--115 & 111--5 & 111--5 & 111--115 \\ +1111--1115 & 1111--5 & 1111--5 & 1111--5 \\ +\cmidrule{2-4} +& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=1000} +& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=100} +& \multicolumn{1}{@{}H}{\ttfamily maxcomprange=10} \\ +\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4} +1111--1115 & 1111--5 & 1111--5 & 1111--5 \\ +1111--1155 & 1111--55 & 1111--55 & 1111--1155 \\ +1111--1555 & 1111--555 & 1111--1555 & 1111--1555 \\ +\cmidrule{2-4} +& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=1} +& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=10} +& \multicolumn{1}{@{}H}{\ttfamily mincompwidth=100} \\ +\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4} +1111--1115 & 1111--5 & 1111--15 & 1111--115 \\ +1111--1155 & 1111--55 & 1111--55 & 1111--155 \\ +1111--1555 & 1111--555 & 1111--555 & 1111--555 \\ +\bottomrule +\end{tabularx} +\caption{\cmd{mkcomprange} setup} +\label{aut:aux:tab1} +\end{table} + +\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: + +\begin{lstlisting}[style=latex]{} +\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. + +\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. The regular version uses \cmd{mkpageprefix} to format the \prm{text} after truncation, passing the \prm{pagination} and/or \prm{postpro} arguments to \cmd{mkpageprefix}. The starred version prints the truncated \prm{text} as is. The optional \prm{postpro} argument specifies a macro to be used for post-processing the \prm{text}. This must be a macro taking one mandatory argument. +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} @@ -7682,6 +7722,14 @@ A special formatting directive for use with \cmd{printfield} and \cmd{printtext} A special formatting directive for use with \cmd{printfield} and \cmd{printtext}. It wraps its argument in a \cmd{bibhypertarget} command, see \secref{aut:aux:msc} for details. The \prm{name} argument passed to \cmd{bibhypertarget} is the value of the \bibfield{entrykey} field. +\optitem{volcitepages} + +A special formatting directive which controls the format of the page\slash text portion in the argument of citation commands like \cmd{volcite}. + +\optitem{volcitevolume} + +A special formatting directive which controls the format of the volume portion in the argument of citation commands like \cmd{volcite}. + \end{ltxsyntax} \subsubsection{Auxiliary Lengths, Counters, and Other Features} @@ -8714,6 +8762,35 @@ This revision history is a list of changes relevant to users of this package. Ch \begin{changelog} +\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} +\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 Removed local options \opt{maxnames}/\opt{minnames} from \cmd{printbibliography}\see{use:bib:bib} +\item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printbibliography}\see{use:bib:bib} +\item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbysection}\see{use:bib:bib} +\item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbysection}\see{use:bib:bib} +\item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbysegment}\see{use:bib:bib} +\item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbysegment}\see{use:bib:bib} +\item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{bibbycategory}\see{use:bib:bib} +\item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{bibbycategory}\see{use:bib:bib} +\item Removed local options \opt{maxnames}/\opt{minnames} from \cmd{printshorthands}\see{use:bib:los} +\item Removed local options \opt{maxitems}/\opt{minitems} from \cmd{printshorthands}\see{use:bib:los} +\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 \cmd{mkcomprange}\see{aut:aux:msc} +\item Added \cmd{mkfirstpage}\see{aut:aux:msc} +\item Removed \cmd{mkpagefirst}\see{aut:aux:msc} +\item Fixed some bugs +\end{release} + +\begin{release}{1.5a}{2011-06-17} +\item Fixed some bugs +\end{release} + \begin{release}{1.5}{2011-06-08} \item Added option \kvopt{uniquename}{mininit/minfull}\see{use:opt:pre:int}\BiberOnlyMark \item Added option \kvopt{uniquelist}{minyear}\see{use:opt:pre:int}\BiberOnlyMark |