summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex-publist
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-02-22 23:11:46 +0000
committerKarl Berry <karl@freefriends.org>2019-02-22 23:11:46 +0000
commitb4568bc71e054f3d1fd6404b45d2322631778284 (patch)
treee10afb3b4b681fc68a193a8dfb07a81a6b5d6922 /Master/texmf-dist/doc/latex/biblatex-publist
parentddd7b1d08d0466b2b6b871fa121da39360689af2 (diff)
biblatex-publist (22feb19)
git-svn-id: svn://tug.org/texlive/trunk@50085 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex-publist')
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-publist/README10
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdfbin311050 -> 316645 bytes
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex110
3 files changed, 98 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-publist/README b/Master/texmf-dist/doc/latex/biblatex-publist/README
index cd816f0c81c..e04237f488e 100644
--- a/Master/texmf-dist/doc/latex/biblatex-publist/README
+++ b/Master/texmf-dist/doc/latex/biblatex-publist/README
@@ -45,6 +45,16 @@ instructions.
== CHANGES ==
+* V. 1.15 (2019-02-22):
+ - Add support for omitting multiple authors.
+ - Fix documentation issues.
+
+* V. 1.14 (2019-02-21):
+ - Add support for highlighting multiple authors.
+ - Fix handling of non-ASCII names.
+ - Use \DeclareStyleSourcemap rather that \DeclareSourcemap.
+ - Update sorting documentation in the wake of biblatex changes.
+
* V. 1.13 (2018-11-30):
- Introduce new sorting templates that ignore names.
- CHANGE OF OUTPUT! Use ydt tempate by default.
diff --git a/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdf b/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdf
index e1cc9d86323..c1a1a44c340 100644
--- a/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdf
+++ b/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex b/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex
index 02f0ce8d278..cf65eddbd59 100644
--- a/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex
+++ b/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex
@@ -54,6 +54,17 @@
citecolor=black
}
+% Tweak the TOC (make it more compact)
+\usepackage{tocloft}
+\setlength{\cftaftertoctitleskip}{6pt}
+\setlength{\cftbeforesecskip}{3pt}
+\setlength{\cftbeforesubsecskip}{0pt}
+\renewcommand{\cfttoctitlefont}{\normalsize\bfseries}
+\renewcommand{\cftsecfont}{\small\bfseries}
+\renewcommand{\cftsecpagefont}{\small\bfseries}
+\renewcommand{\cftsubsecfont}{\small}
+\renewcommand{\cftsubsecpagefont}{\small}
+
% Some semantic markup
\makeatletter
\def\jmacro{\@ifstar\@@jmacro\@jmacro}
@@ -89,7 +100,7 @@
\thanks{Please report issues via \protect\url{https://github.com/jspitz/biblatex-publist}.}%
}
-\date{Version 1.13, 2018/11/30}
+\date{Version 1.15, 2019/02/22}
\maketitle
\begin{abstract}
@@ -102,6 +113,8 @@ The package requires at least version 3.8 of the \bibltx\ package\footnote{For \
\url{http://www.ctan.org/pkg/biblatex}.} and \texttt{biber} (the respective version as required by \bibltx).
\end{abstract}
+\tableofcontents
+
\section{Aim of the package}
The \bpl\ package ships a \emph{biblatex bibliography style file} ({*}.bbx)
@@ -124,10 +137,10 @@ style file, \emph{publist.bst}%
see also \cite{ttb}.}, which helps a lot if you want to produce a publication
list with Bib\TeX. The \bpl\ package is the result of the aim of emulating
the features of \emph{publist.bst} with \bibltx's means. It partly draws on
-Markey's conceptual ideas. Bug reports, comments and ideas are welcome.\filbreak
+Markey's conceptual ideas. Bug reports, comments and ideas are welcome.
-\section{Loading the package}
+\section{Usage}
\subsection{Standard usage\label{sec:standard-usage}}
@@ -138,23 +151,24 @@ The standard way of using the package is to load the style file via
\end{lstlisting}
The \jcsmacro*{plauthorname} macro\footnote{The macro was named \jfcsmacro{omitname} until v.\,1.4
of the \bpl\ package. The old macro still works, but is marked as deprecated.}
-(at least with the mandatory \emph{surname} argument) needs to be given once.
-It informs the style file which name it should suppress or highlight in the
+(at least with the mandatory \emph{surname} argument) needs to be given (at least\footnote{See
+sec.~\ref{sec:multiauthors} for the case of handling multiple authors and name variants.}) once.
+It informs the style file which name(s) it should suppress or highlight in the
author\slash editor list (usually yours).
-With the default settings, the author\slash editor name will be omitted completely
-for all of your publications where you are the sole author or editor, as in:
+With the default settings, the author\slash editor name(s) will be omitted completely
+for all of publications which are authored or edited only by the specified person(s), as in:
\begin{quote}
\textbf{2012.} Some recent trends in gardening. In: \emph{Gardening
Practice} 56, pp.~34--86.
\end{quote}
-If there are co-authors\slash co-editors, your name will be filtered
+If there are co-authors\slash co-editors, your name(s) will be filtered
out and the collaborators added in parentheses, as in:
\begin{quote}
\textbf{1987} (with John Doe and Mary Hall). Are there new trends
in gardening? In: \emph{Gardening Practice} 24, pp.~10--15.
\end{quote}
-If \joption{plauthorhandling=highlight} is used (see next section), the plauthor
+If \joption{plauthorhandling=highlight} is used (see next section), the plauthor(s)
will be printed in bold face instead, as in:
\begin{quote}
Doe, John, \textbf{Myself, Me} and Hall, Mary, \textbf{1987}. Are there new trends
@@ -162,7 +176,7 @@ will be printed in bold face instead, as in:
\end{quote}
%
Note that \jcsmacro{plauthorname} expects the name constituents as they are recorded in the
-database (special characters expanded). The option \joption{plauthorfirstinit} (see next section),
+database (special characters will be expanded). The option \joption{plauthorfirstinit} (see next section),
however, allows you to pass only an initial character instead of a first name.
@@ -229,7 +243,41 @@ Of course, the solution does not help if there is an entry with same surname and
\end{description}
-\clearpage
+
+\subsection{Multiple authors and\slash or name variants}\label{sec:multiauthors}
+
+If multiple \jcsmacro{plauthorname} specifications have been entered (or a \jcsmacro{plauthorname} specification
+in addition to a specification via the options \joption{plauthorname}, \joption{plauthorname} and
+\joption{plauthornameprefix}), all of them will be considered.
+
+Thus it is possible to highlight multiple authors in the publication
+list (for instance to mark contributions of a research team):
+\begin{lstlisting}[moretexcs={[2]{plauthorname}}]
+\usepackage[style=publist,plauthorhandling=highlight]{biblatex}
+\plauthorname[John]{Doe}
+\plauthorname[Mary][van]{Smith}
+\plauthorname{Wittgenstein}
+\end{lstlisting}
+%
+Multiple specifications can also be used to deal with name variants:
+\begin{lstlisting}[moretexcs={[2]{plauthorname}}]
+\plauthorname[Bill]{Gates}
+\plauthorname[William]{Gates}
+\plauthorname[William Henry]{Gates}
+\plauthorname[William H.]{Gates}
+\end{lstlisting}
+%
+Since the latter is also useful with \joption{plauthorhandling=omit}, this mode also considers multiple specifications.
+By entering something such as the former, it is even possible to omit more than one and different authors from the entries
+(and \bpl\ will take care of the change in the author separation this involves; think of final \emph{and} vs. \emph{comma},
+which have to be adjusted accordingly if names are omitted). However, it does not strike me sensible to do so (in other words,
+if you need to deal with a \emph{team} of authors, you should really consider to use \joption{plauthorhandling=highlight}).
+
+Note that this also applies to filtering (see sec.~\ref{sec:filtering}), i.\,e., the \joption{mine} filter considers
+entries authored by \emph{any} of the specified persons.
+
+
+\section{Customization}
\subsection{Auxiliary macros and lengths}\label{sec:auxmacros}
@@ -277,7 +325,6 @@ Note, further, that the order of author's and editor's given and family names is
differ from what you expect with specific base styles. To change the order,
use the package option \joption{nameorder} (see sec.~\ref{sec:addopts}).
-\clearpage
\section{Localization}
@@ -334,7 +381,7 @@ The suggested procedure is to maintain separate bib files for each
category, say \emph{mymonographs.bib}, \emph{myarticles.bib}, \emph{myproceedings.bib}.%
\footnote{But see sec.~\ref{sec:filtering} for an alternative.}
Then a typical file would look like example~\ref{example} (p.~\pageref{example}).
-
+%
\begin{lstlisting}[caption={Typical document},
float,
frame=single,
@@ -403,6 +450,9 @@ which has to be passed to \jfcsmacro{printbibliography}, as in:
\nocite{*}
\printbibliography[heading=none,filter=mine]
\end{lstlisting}
+%
+This will effectively print only publications which have been authored or edited by the
+person(s) specified as via \jcsmacro{plauthorname} (or the corresponding option).
Of course, you can also use other filter possibilities provided by
\bibltx, such as filtering by type or by keyword. So if you want
@@ -469,15 +519,17 @@ The following templates, with and without author sorting, are provided:
In order to use any of these, or another sorting template provided by \bibltx\,
use \bibltx's \jfmacro{sorting} option, which can be passed either globally
(via \joption{sorting=<template>} as a \bibltx\ option) or locally
-(via \joption{sorting=<template>} as a \jfcsmacro{printbibliography} option).
+(by means of a \jfcsmacro{newrefcontext} macro with the option \joption{sorting=<template>}).
So, to sort your talks in descending order by full date in your CV, you would
use either
\begin{lstlisting}[moretexcs={[1]{printbibliography}}]
\usepackage[style=publist,sorting=ddt]{biblatex}
\end{lstlisting}
or
-\begin{lstlisting}[moretexcs={[1]{printbibliography}}]
-\printbibliography[heading=none,sorting=ddt]
+\begin{lstlisting}[moretexcs={[3]{printbibliography,newrefcontext,endrefcontext}}]
+\newrefcontext[sorting=ddt]
+\printbibliography[heading=none]
+\endrefcontext
\end{lstlisting}
\clearpage
@@ -485,6 +537,20 @@ or
\section{Revision Log}
\begin{description}
+ \item [{V. 1.15 (2019-02-22):}]~
+ \begin{itemize}
+ \item Add support for omitting multiple authors. See sec.~\ref{sec:multiauthors}.
+ \item Fix documentation issues.
+ \end{itemize}
+
+ \item [{V. 1.14 (2019-02-21):}]~
+ \begin{itemize}
+ \item Add support for highlighting multiple authors. See sec.~\ref{sec:multiauthors}.
+ \item Fix handling of non-ASCII names.
+ \item Use \jfcsmacro{DeclareStyleSourcemap} rather that \jfcsmacro{DeclareSourcemap}.
+ \item Update sorting documentation in the wake of \bibltx\ changes.
+ \end{itemize}
+
\item [{V. 1.13 (2018-11-30):}]~
\begin{itemize}
\item Introduce new sorting templates that ignore names. See sec.~\ref{sec:sorttemplates}.
@@ -515,14 +581,14 @@ or
\jcsmacro{refsection}s.
\item Documentation improvements.
\end{itemize}
-
+
\item [{V.~1.9 (2018-03-01):}]~
\begin{itemize}
\item New option \joption{plnumbered} that allows to omit the numbering
of the publication list items
\item Documentation improvements.
\end{itemize}
-
+\clearpage
\item [{V.~1.8 (2017-11-14):}]~
\begin{itemize}
\item Adapt to \bibltx\ 3.8. This version is now required.
@@ -536,7 +602,7 @@ or
\item \texttt{year+labelyear} $\Rightarrow$ \texttt{bpl:year+labelyear}
\end{itemize}
\end{itemize}
-\clearpage
+
\item [{V.~1.7 (2017-04-12):}]~
\begin{itemize}
\item Output marginyear before the author list. This prevents it from being vertically
@@ -566,10 +632,10 @@ or
\item Assure the margin text always starts uppercased (relevant for pubstates).
\item Minor corrections to the manual.
\end{itemize}
+\clearpage
+ \item [{V.~1.3 (2016-08-06):}]~
-\item [{V.~1.3 (2016-08-06):}]~
-
-\begin{itemize}
+ \begin{itemize}
\item It is now possible to change the base style that is used by \bpl. See sec.~\ref{sec:basestyle}.
\item Proper sorting of pubstates.
\item Add possibility to increase the indentation of items (by means of the length \jmacro{extralabelnumberwidth}). See sec.~\ref{sec:auxmacros}.