summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex')
-rw-r--r--macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex82
1 files changed, 68 insertions, 14 deletions
diff --git a/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex b/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
index bc0c53b5f6..3b04d6a83a 100644
--- a/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
+++ b/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
@@ -102,12 +102,12 @@
\thanks{Please report issues via \protect\url{https://github.com/jspitz/biblatex-publist}.}%
}
-\date{Version 1.20, 2020/09/15}
+\date{Version 1.21, 2020/09/21}
\maketitle
\begin{abstract}
\noindent The \bpl\ package provides a \bibltx\ style file
-for publication lists, i.\,e.\ a bibliography containing one's own
+for publication lists, i.\,e., a bibliography containing one's own
publications. It draws on \bibltx's \emph{authoryear} style by default
(which can be changed), but provides some extra features needed for publication lists,
such as the omission or highlighting of the own name from\slash in author or editor data.
@@ -119,8 +119,8 @@ The package requires at least version 3.8 of the \bibltx\ package\footnote{For \
\section{Aim of the package}
-The \bpl\ package ships a \emph{biblatex bibliography style file} ({*}.bbx)
-for a specific task: academic publication lists. Such lists, which are a central
+The \bpl\ package provides a \bibltx\ bibliography style for a specific task:
+academic publication lists. Such lists, which are a central
part of the academic CV, contain all or selected publications of a specific
author, usually sorted by genre and year. Even though publication lists are actually
nothing else than (specific) bibliographies, they diverge from those in some
@@ -133,13 +133,38 @@ produce the desired result.
Given the fact that maintaining a publication list is a routine task
in an academian's life, it is surprising how few specified solutions
exist to generate such lists (particularly from Bib\TeX\ data). For
-traditional Bib\TeX, Nicolas Markey provided a specific Bib\TeX\
-style file, \emph{publist.bst}%
-\footnote{\url{http://www.lsv.ens-cachan.fr/~markey/BibTeX/publist/?lang=en};
-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.
+classic Bib\TeX, Nicolas Markey provides (off CTAN) a Bib\TeX\ style file
+dedicated to that task, \emph{publist.bst}%
+\footnote{See \url{http://www.lsv.fr/~markey/BibTeX/publist/publist.bst}
+ for the style file, \url{http://www.lsv.fr/~markey/BibTeX/publist/doc.ps.gz}
+ for documentation; see also \cite{ttb}.}.
+The \bpl\ package started off as the attempt to emulate the features of
+\emph{publist.bst} with \bibltx's means; it thus partly draws on
+its conceptual ideas. Meanwhile, however, it has significantly exceeded
+that initial goal and provides many more features than \emph{publist.bst}.
+
+The list of features includes:
+
+\begin{itemize}
+ \setlength\itemsep{0pt}
+ \item Omit or hide selected author names, with a specific indication of co-authors in the former case
+ \item Filter publications of specific authors from heterogeneous bibliography databases
+ \item Date-centric sorting (as typical for publication lists)
+ \item Number items in ascending or descending order, globally or sectional
+ \item Highlight year of publication
+ \item Indicate year of publication (sets) in the margin
+ \item Clickable titles, linking to the URL, DOI, or a web catalog
+ \item List reviews of specific titles
+ \item Adjustable base bibliography style
+\end{itemize}
+%
+Many features have been suggested by users of the package.
+If you miss a specific feature, feel free to suggest it via
+\url{https://github.com/jspitz/biblatex-publist/issues}.
+
+Note that \bpl\ relies on rather advanced features of \bibltx\ for some of its own features.
+These are only available with the \texttt{biber} backend of \bibltx. Hence \bpl\ requires
+the use of \texttt{biber} as well -- the \texttt{bibtex} backend won't work!
\section{Usage}
@@ -181,6 +206,11 @@ Note that \jcsmacro{plauthorname} expects the name constituents as they are reco
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.
+If you want to refer to an item number, use \jcsmacro*{citeitem}\jmacro{\{<key>\}} within your publication list.
+This will print the item number in square brackets (like the \jfcsmacro{cite} command in numeric citation styles),
+but as opposed to normal \jfcsmacro{cite} it also considers all numbering tweaks you make via the \bpl\ options.
+
+\condbr{4}
\subsection{Additional options}\label{sec:addopts}
@@ -232,9 +262,15 @@ If you prefer the numbering to start from 1 at each section instead, set this op
If you do not want to have any numbers at all, set this option to \joption{false}.
+
+\item [{\joption{reversenumbering{[}=true|false{]}}}] default: \emph{false}.
+
+If this option is \joption{true}, the entries will be numbered in descending order, starting from the total
+number of entries back to 1. Also works with \joption{plnumbered=reset}.
+
\item [{\joption{plauthorfirstinit{[}=true|false{]}}}] default: \emph{false}.
-If you set this option to true, you can (and are supposed to) pass only an initial character as first name value of
+If you set this option to \joption{true}, you can (and are supposed to) pass only an initial character as first name value of
\jcsmacro{plauthorname} (e.\,g., \jcsmacro{plauthorname[J]\{Doe\}} or \jcsmacro{plauthorname[J][van]\{Doe\}}).
In consequence, \bpl\ will consider all entries of the specified given name (and prefix, if specified)
whose prename starts with the specified character. This allows you to deal with databases that record entries of your work
@@ -336,6 +372,8 @@ The omission indicator, \jcsmacro*{plnameomission}, can be redefined. The defaul
\newcommand*\plnameomission{\bibellipsis\addcomma\addspace}
\end{lstlisting}
+\condbr{4}
+
\section{Customization}
\subsection{Auxiliary macros and lengths}\label{sec:auxmacros}
@@ -364,6 +402,13 @@ The indendation of the bibliographic entries (lines > 1) can be adjusted by sett
This might be needed for long bibliographies (> 99 entries) in order to adjust to the extra
space the item number needs.
+If you need to adjust the numbering of items manually, you can do so with the macro \jcsmacro*{shiftbplnum}.
+It takes a positive or negative integer value that determines how much and in which direction it is shifted
+(e.\,g., \verb|\shiftpblnum{2}| or \verb|\shiftbplnum{-1}|). This can be used repeatedly, anywhere, and applies
+to all subsequent items.
+For the numbering output by \jfcsmacro{citeitem}, analogous shifting can be done by
+\jcsmacro*{shiftciteitem}.
+
\subsection{Using a different base style}\label{sec:basestyle}
@@ -502,8 +547,7 @@ Then a typical file would look like example~\ref{example} (p.~\pageref{example})
\end{document}
\end{lstlisting}
-
-
+%
If you want to add other people's reviews of your work, add a section
such as the following:
\begin{lstlisting}[caption={Adding foreign reviews},
@@ -617,6 +661,16 @@ or
\section{Revision Log}
\begin{description}
+
+ \item [{V. 1.21 (2020-09-21):}]~
+ \begin{itemize}
+ \item Add option \jfoption{reversenumbering}. See sec.~\ref{sec:addopts}.
+ \item Add \jcsmacro{citeitem} command. See sec.~\ref{sec:standard-usage}.
+ \item Add \jcsmacro{shiftbplnum} and \jcsmacro{shiftciteitem} helper macros
+ for manual adjustment of numbering.
+ See sec.~\ref{sec:auxmacros}.
+ \item Properly sort \jfoption{prepublished} pubstate type.
+ \end{itemize}
\item [{V. 1.20 (2020-09-15):}]~
\begin{itemize}