summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-01-06 03:00:48 +0000
committerNorbert Preining <norbert@preining.info>2022-01-06 03:00:48 +0000
commit55032f1ad7128dcf6493e798424f4ade02c923a7 (patch)
tree10ba73ec0f911b4bcf9947f34fda4efc3a9791b5 /macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
parentc03c0d515f1bfbd111d40e78805db4696e080fb8 (diff)
CTAN sync 202201060300
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.tex88
1 files changed, 70 insertions, 18 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 a925e0c0ae..d36ea6480b 100644
--- a/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
+++ b/macros/latex/contrib/biblatex-contrib/biblatex-publist/biblatex-publist.tex
@@ -102,31 +102,30 @@
\thanks{Please report issues via \protect\url{https://github.com/jspitz/biblatex-publist}.}%
}
-\date{Version 1.25, 2021/12/14}
+\date{Version 1.26 2022/01/05}
\maketitle
\begin{abstract}
-\noindent The \bpl\ package provides a \bibltx\ style file
+\noindent The \bpl\ package provides a \bibltx\ \cite{bibltx} style file
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.
-The package requires at least version 3.8 of the \bibltx\ package\footnote{For \bibltx, see
-\url{http://www.ctan.org/pkg/biblatex}.} and \texttt{biber} (the respective version as required by \bibltx).
+The package requires at least version 3.8 of \bibltx\ and \texttt{biber}
+(the respective version as required by \bibltx).
\end{abstract}
\tableofcontents
\section{Aim of the package}
-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
-respects. Most notably, it is widespread practice to omit your own name in
-your publication list and only list your co-authors, if there are any, or to
-highlight your own name (e.\,g., with bold face letters).
+The \bpl\ package provides a \bibltx\ bibliography style specifically for 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 respects. Most notably, it is widespread practice
+to omit your own name in your publication list and only list your co-authors,
+if there are any, or to highlight your own name (e.\,g., with bold face letters).
If you want to follow this practice, a normal bibliography style does not
produce the desired result.
@@ -154,6 +153,7 @@ The list of features includes:
\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 Indicate if/how a title has been peer-reviewed
\item List reviews of specific titles
\item Adjustable base bibliography style
\end{itemize}
@@ -162,10 +162,18 @@ 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}.
+\subsection*{Caveats}
+
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!
+Also note that the aim of \bpl\ is to generate publication lists, so it is not suitable
+for normal bibliographies. Specifically, while basic citing works, more advanced
+forms of citing may break or not produce the expected result. The reason is that
+\bpl\ needs to perform internal tweaks (e.\,g., to \textsf{shortauthor} and
+\textsf{labelname}) which might bite you with customized cite formats.
+
\section{Usage}
@@ -267,7 +275,6 @@ 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
@@ -283,6 +290,12 @@ with abbreviated and full first name (\textsc{J. Doe} and well as \textsc{John D
works of colleagues with the same surname (maybe your family members), which you will not want to mark as your own's.
Of course, the solution does not help if there is an entry with same surname and same first name initial (such as \textsc{Jane Doe}).
+
+\item [{\joption{prinfo{[}=true|false{]}}}] default: \emph{true}.
+
+If this option is \joption{true}, peer review information, as specified via the \texttt{peerreview} field
+(see section~\ref{sec:peerreview}), will be appended to the entries.
+
\end{description}
%
The following options are available if \textsf{hyperref} is loaded:
@@ -377,7 +390,28 @@ The omission indicator, \jcsmacro*{plnameomission}, can be redefined. The defaul
\newcommand*\plnameomission{\bibellipsis\addcomma\addspace}
\end{lstlisting}
-\condbr{4}
+\subsection{Adding Peer Review Information}\label{sec:peerreview}
+
+It is common, and sometimes mandatory, to add information to publication list entries indicating if
+and how listed work has been subject to peer review.
+To this end, \bpl\ provides a specific database field, \texttt{peerreview}, in which you can use
+the following shorthands:
+
+\begin{itemize}\setlength{\itemsep}{0pt}
+ \item{\texttt{sb}} (=~single blind peer review)
+ \item{\texttt{db}} (=~double blind peer review)
+ \item{\texttt{op}} (=~open peer review)
+ \item{\texttt{co}} (=~collaborative peer review)
+ \item{\texttt{cc}} (=~cascading peer review)
+ \item{\texttt{tp}} (=~third-party peer review)
+ \item{\texttt{pp}} (=~post-publication peer review)
+ \item{\texttt{no}} (=~no peer review)
+\end{itemize}
+%
+If the option \joption{prinfo} is true, then \bpl\ will append the respective information to the entries.
+A specific localizable bibkey is used for this purpose (see section~\ref{sec:localization}). Instead of
+the shorthands, you can also enter arbitrary text to the \texttt{peerreview} field, which is then output
+as is (and not localized).
\section{Customization}
@@ -456,17 +490,25 @@ Note that the output of URLs, DOIs, ISBNs and ISSNs is not affected by the \jopt
so you might get redundant output. To control (e.\,g., omit) them, use the \joption{url}, \joption{doi}
and \joption{isbn} biblatex options.
-\section{Localization}
+\section{Localization}\label{sec:localization}
Since the package draws on \bibltx, it supports localization.
The following additional localization keys (\jfcsmacro{bibstrings})
are added by the package:
\begin{itemize}
\item \emph{with}: the preposition ``with'' that precedes the list of
-co-authors by default (i.\,e., with \joption{plauthorhandling=omit}).
+ co-authors by default (i.\,e., with \joption{plauthorhandling=omit}).
\item \emph{parttranslationof}: the expression ``partial translation of''
-for entries referring to partially translated work via \bibltx's
-``related entries'' feature (see sec.~\ref{sec:partial-translations}).
+ for entries referring to partially translated work via \bibltx's
+ ``related entries'' feature (see sec.~\ref{sec:partial-translations}).
+\item \emph{peerreview:sb}: the phrase ``single blind peer review''.
+\item \emph{peerreview:db}: the phrase ``double blind peer review''.
+\item \emph{peerreview:op}: the phrase ``open peer review''.
+\item \emph{peerreview:co}: the phrase ``collaborative peer review''.
+\item \emph{peerreview:cc}: the phrase ``cascading peer review''.
+\item \emph{peerreview:tp}: the phrase ``third-party peer review''.
+\item \emph{peerreview:pp}: the phrase ``post-publication peer review''.
+\item \emph{peerreview:no}: the phrase ``no peer review''.
\end{itemize}
Currently, these additional localization keys are available in the following
languages: English, French and German.%
@@ -667,6 +709,16 @@ or
\begin{description}
+ \item [{V. 1.26 (2022-01-05):}]~
+ \begin{itemize}
+ \item Provide means to add peer review information (see section~\ref{sec:peerreview}).
+ \item Add a data model (\texttt{*.dbx}) file.
+ \item Fix \jcsmacro{textcite} output at least for the standard cases.
+ \item Do not highlight/omit author/editor names in related entries.
+ \item Rename \texttt{bpl:review:*} macros to \texttt{bpl:plain:*} and
+ add \texttt{bpl:plain:editor}.
+ \end{itemize}
+
\item [{V. 1.25 (2021-12-14):}]~
\begin{itemize}
\item More robustification with names consisting of non-ASCII chars.