diff options
author | Karl Berry <karl@freefriends.org> | 2010-09-22 23:35:08 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-09-22 23:35:08 +0000 |
commit | 7d3e52c3d1f706817bb17d8ce36fc9e2fdadc578 (patch) | |
tree | 51e3ca900fe7623ae05250535638e32d59095432 /Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex | |
parent | 4e4bb5b0b9eb71dbc88b140b9bfe43026324b79f (diff) |
biblatex-dw (22sep10)
git-svn-id: svn://tug.org/texlive/trunk@19846 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex | 170 |
1 files changed, 110 insertions, 60 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex b/Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex index 975abc9b163..af1152b9e39 100644 --- a/Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex +++ b/Master/texmf-dist/doc/latex/biblatex-dw/biblatex-dw.tex @@ -26,14 +26,15 @@ \section{Introduction} \subsection{Installation} -Extract the zip archive to the \texttt{\$LOCALTEXMF} directory of +\bldw{} is part of the distributions MiK\TeX{}\footnote{Website: \url{http://www.miktex.org}.} +and \TeX{}~Live\footnote{Website: \url{http://www.tug.org/texlive}.}~-- thus, you +can easily install it using the respective package manager. If you would like to +install \bldw{} manually, do the following: +Extract the archive \texttt{biblatex-dw.tds.zip} to the \texttt{\$LOCALTEXMF} directory of your system.\footnote{If you don't know what that is, have a look at \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds} or -\url{http://mirror.ctan.org/tds/tds.html}.} Refresh your filename database. In -MiKTeX, this is done in the \enquote{Settings} dialog, button \enquote{Refresh -FNDB}, or from the command line with the command \texttt{initexmf --{}-refresh-fndb}. For other LaTeX distributions, please see its documentation -for details. Here is some additional information from the UK \TeX\ FAQ: +\url{http://mirror.ctan.org/tds/tds.html}.} Refresh your filename database. +Here is some additional information from the UK \TeX\ FAQ: \begin{itemize} \item \href{% http://www.tex.ac.uk/cgi-bin/texfaq2html?label=install-where}{% @@ -256,6 +257,20 @@ Besides some changes in punctuation, there are the following differences: \addcomma\space\bibstring{volume}\addspace} \end{lstlisting} This would give \enquote{(Name of Series, vol. N)}. + \item Using\beschreibung{shorthandinbib} option \option{shorthandinbib=true}, + the shorthands are printed in the bibliography, enclosed by brackets, preceding + the respective entry. The appearance is controlled by the field format + \enquote{shorthandinbib} which can of course be redefined. If you want to get + rid of the default brackets, for instance, you should do the following: + \begin{lstlisting} +\DeclareFieldFormat{shorthandinbib}{#1} + \end{lstlisting} + In this case there will only be a space between shorthand and bibliography entry, + so that you should redefine the punctuation as well which is printed by the + command \cmd{shorthandinbibpunct}. You could alter it to print a colon, e.g.: + \begin{lstlisting} +\renewcommand*{\shorthandinbibpunct}{\addcolon\space} + \end{lstlisting} \item The\beschreibung{annotation} option \option{annotation} is introduced. If it is set to \wert{true}, the field \texttt{annotation} will be printed in \textit{\small small italic} typeface at the end of the entry. The @@ -344,28 +359,61 @@ Besides some changes in punctuation, there are the following differences: is \wert{true}. Note that this behaviour can also be overridden for each entry by using \texttt{options\,= \{citedas=true\}} or \texttt{options\,=\,\{citedas=false\}}, respectively. - \item If\beschreibung{herename} you specify pages to a \cmd{fullcite} (or the first citation with - the option \option{firstfull}) of an entry which has - the field \texttt{pages} defined, the pages of the citation will - be preluded by the term \enquote{here}. This behaviour can be - influenced by the option \option{herename}, which can take - the values \wert{true} or \wert{false}; the standard value - is \wert{true}. - The term can be redefined in the preamble by the following command, - e.g. in order to have a colon after \enquote{here}: + \item The\beschreibung{citepages} + option \option{citepages} allows you to suppress pages or page ranges + in full citations, if the field \texttt{pages} is given: + \option{citepages=permit} allows duplicates, i.e. the \texttt{pages} + field as well as the \texttt{postnote} are printed; + with \option{citepages=suppress} the \texttt{pages} field of the full citations + will be suppressed in any case, thus only the \texttt{postnote} is printed; + \option{citepages=omit} omits the \texttt{pages} only if the \texttt{postnote} + is a number; + \option{citepages=separate} always prints the \texttt{pages} field, but separates + the \texttt{postnote} by using the string \enquote{here}, if it is a number. + In this case, the \emph{bibliography string} \enquote{thiscite} is used. + The standard value for this option is \wert{separate}. + A small illustrating example which uses the following \cmd{cite} commands: \begin{lstlisting} -\DefineBibliographyStrings{german}{% - herename = {here\addcolon\space} -} +\cite{key} +\cite[a note]{key} +\cite[125]{key} \end{lstlisting} - \item With \option{herename=true}, the punctuation before the \enquote{herename} - is determined by the command \cmd{herenamepunct}. The default is - \wert{\cmd{add\-comma}\cmd{space}}. - \item If\beschreibung{omitpages} you set the option \option{omitpages} to \wert{true}, the page range - of \texttt{@article}, \texttt{@inbook}, \texttt{@incollection} and - \texttt{@inproceedings} entries will be suppressed in full citations. - With \option{herename=true}, the \enquote{herename} will be omitted as - well. The standard value for this option is \wert{false}. + % + \option{citepages=permit}: + \begin{quote} + Author: Title, in: Book, pp.\,100--150. + + Author: Title, in: Book, pp.\,100--150, a note. + + Author: Title, in: Book, pp.\,100--150, p.\,125. + \end{quote} + % + \option{citepages=suppress}: + \begin{quote} + Author: Title, in: Book. + + Author: Title, in: Book, a note. + + Author: Title, in: Book, p.\,125. + \end{quote} + % + \option{citepages=omit}: + \begin{quote} + Author: Title, in: Book, pp.\,100--150. + + Author: Title, in: Book, pp.\,100--150, a note. + + Author: Title, in: Book, p.\,125. + \end{quote} + % + \option{citepages=separate}: + \begin{quote} + Author: Title, in: Book, pp.\,100--150. + + Author: Title, in: Book, pp.\,100--150, a note. + + Author: Title, in: Book, pp.\,100--150, here p.\,125. + \end{quote} \item The\beschreibung{firstfullname} option \option{firstfullname=true} offers the possibility to have authors\slash editors printed with first name and last name for the first citation when using the commands \cmd{citeauthor} or @@ -436,8 +484,6 @@ Besides, there are the following differences between \xbx{footnote-dw} and are set to \wert{true}, the annotations and library information are only printed in the bibliography (if there is one), but not in the first citations and in the list of shorthands. - \item The option \option{herename} is valid for full citations - (\cmd{fullcite}) as well as for the first citation of an entry. \end{itemize} \section{Crossref functionality} @@ -544,6 +590,10 @@ The value in parentheses shows the default. The first citation (in \xbx{authortitle-dw} only if the option \option{firstfull} is used) is followed by the string \enquote{henceforth cited as} whenever a \texttt{shorthand} is given. + \optlist{citepages}{separate} + Specifies if the pages of a fullcite or of the first citation (\xbx{authortitle-dw}: + only with option \option{firstfull}) of an entry with \texttt{pages} field + will be printed or not. \optlist{edbyidem}{true} \enquote{ed. by idem} instead of \enquote{ed. by \emph{Editor}}. \optlist{editorstring}{parens} @@ -569,10 +619,6 @@ The value in parentheses shows the default. name prefixes. Possible values are \wert{smallcaps}, \wert{italic}, \wert{bold} and \wert{normal} (which is the default and means that the normal font shape is used). - \optlist{herename}{true} - Specifies if the term \enquote{here} should prelude the pages of a - fullcite or of the first citation (\xbx{authortitle-dw}: only with option - \option{firstfull}) of an entry which has a non-empty \texttt{pages}-field. \optlist{ibidemfont}{normal} Specifies the font shape of the \enquote{ibidem} string. Possible values are \wert{smallcaps}, \wert{italic}, \wert{bold} and @@ -614,10 +660,6 @@ The value in parentheses shows the default. If set to \wert{false}, the entry option \option{oldauthor} is ignored. \optlist{omiteditor}{false} If set to \wert{true}, the editor is omitted in citations. - \optlist{omitpages}{false} - Specifies if the pages of a fullcite or of the first citation (\xbx{authortitle-dw}: - only with option \option{firstfull}) of an \texttt{@article}, \texttt{@inbook}, - \texttt{@incollection} or \texttt{@inproceedings} entry will be printed or not. \optlist{origfields}{true} With \option{origfields=true}, the fields \texttt{origlocation} and \texttt{origdate} (as well as \texttt{origpublisher}, if @@ -640,6 +682,9 @@ The value in parentheses shows the default. \optlist{shorthandibid}{true} Immediately repeated citations of entries with \texttt{shorthand} are replaced by \enquote{ibid.} + \optlist{shorthandinbib}{false} + If set to \wert{true}, the shorthands will be printed ahead of the bibliography + entries. \optnur[no default]{shorthandwidth} Defines the width of the label in the list of shorthands. Additionally, after every label the length \cmd{shorthandsep} (the default is 3pt) and @@ -1046,9 +1091,6 @@ The following list shows additional commands introduced by \bldw{}, along with t first and second name in citations when the scheme \enquote{Surname, Firstname, Firstname Surname} is given. The comma is not meant! Compare \bl's \cmd{revsdnamedelim}.} - \befehl{herenamepunct}{\cmd{addcomma}\cmd{space}}{Punctuation before the - \enquote{herename} (before page indications in fullcites of dependent - works).} \befehl{journumstring}{\cmd{addcomma}\cmd{space}\cmd{bibstring\{number\}}% \cmd{addnbspace}}{Punctuation\slash string ahead of the journal number.} \befehl{jourvolnumsep}{\cmd{adddot}}{Punctuation between journal volume and @@ -1071,8 +1113,10 @@ The following list shows additional commands introduced by \bldw{}, along with t parentheses.} \befehl{sernumstring}{\cmd{addspace}}{Punctuation\slash string between the \texttt{series} and its \texttt{number}.} - \befehl{shorthandpunct}{\cmd{addcolon}}{Puncutation after a shorthand, if - \option{shorthandwidth} is used.} + \befehl{shorthandinbibpunct}{\cmd{addspace}}{Puncutation after a shorthand in the + bibliography, if \option{shorthandinbib} is used.} + \befehl{shorthandpunct}{\cmd{addcolon}}{Puncutation after a shorthand in the list + of shorthands, if \option{shorthandwidth} is used.} \befehl{shorthandsep}{3pt plus 0.5pt minus 0.5pt}{Length between the shorthand and its description, if \option{shorthandwidth} is used.} \befehl{titleaddonpunct}{\cmd{addperiod}\cmd{space}}{Punctuation ahead of @@ -1084,32 +1128,38 @@ The following list shows the additional bibliography strings introduced by \bldw There is always a long and a short version. It depends on the \bl{} option \option{abbreviate} which version is used. \begin{labeling}{mmmmmmm} - \biblstring{herename}{here}{here} - \biblstring{inrefstring}{article}{art\cmd{adddot}} + \biblstring{idemdat}{eidem}{eidem} + \biblstring{idemdatsf}{eidem}{eidem} + \biblstring{idemdatsm}{eidem}{eidem} + \biblstring{idemdatsn}{eidem}{eidem} + \biblstring{idemdatpf}{eisdem}{eisdem} + \biblstring{idemdatpm}{eisdem}{eisdem} + \biblstring{idemdatpn}{eisdem}{eisdem} + \biblstring{idemdatpp}{eisdem}{eisdem} + \biblstring{inrefstring}{article\cmd{addspace}}{art\cmd{adddotspace}} \end{labeling} The bibliography strings can be redefined as follows (but note that you cannot define a long and a short version): \begin{lstlisting} \DefineBibliographyStrings{english}{% - herename = {at}, + thiscite = {at}, inrefstring = {}} \end{lstlisting} -%\subsection{Redefined bibliography strings} -%The following list shows the bibliography strings which are defined by \bl{} -%and redefined by \bldw{}. There is always a long and a short version. -%It depends on the \bl{} option \option{abbreviate} which version is used. -%\begin{labeling}{mmmmmmm} -%% \biblstring{}{}{} - %\biblstring{idem}{idem}{idem} - %\biblstring{idemsm}{idem}{idem} - %\biblstring{idemsf}{eadem}{eadem} - %\biblstring{idemsn}{idem}{idem} - %\biblstring{idempm}{eidem}{eidem} - %\biblstring{idempf}{eaedem}{eaedem} - %\biblstring{idempn}{eadem}{eadem} - %\biblstring{idempp}{eidem}{eidem} -%\end{labeling} +\subsection{Redefined bibliography strings} +The following list shows the bibliography strings which are defined by \bl{} +and redefined by \bldw{}. There is always a long and a short version. +It depends on the \bl{} option \option{abbreviate} which version is used. +\begin{labeling}{mmmmmmm} +% \biblstring{}{}{} + \biblstring{thiscite}{here}{here} +\end{labeling} + +\subsection{Additional field formats} +The following list shows additional field formats defined by \bldw{}. + +\feldformat{shorthandinbib}{mkbibbrackets\{\#1\}}{Format of the shorthands + when using \option{shorthandinbib=true}.} \section{Further hints} The following hints are ideas for advanced users to further customize @@ -1126,7 +1176,7 @@ indicates the place for the \cmd{revsdnamedelim}). \bldw{}, however, has \cmd{bibmultinamedelim}, \cmd{bib\-final\-name\-delim} and \cmd{bibrevsdnamedelim} for the bibliography as well as \cmd{citemultinamedelim}, \cmd{citefinalnamedelim} and -\cmd{citerevsdnamedelim} for the citations. Furthermore, \cmd{multinamedelim}, +\cmd{citerevsdna\-medelim} for the citations. Furthermore, \cmd{multinamedelim}, \cmd{finalnamedelim} and \cmd{revsdnamedelim} are used in the list of shorthands. Thus, you can achieve different results. The standard definitions are as follows: |