summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex-publist
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-02-12 23:31:56 +0000
committerKarl Berry <karl@freefriends.org>2017-02-12 23:31:56 +0000
commit1b77359a5e97dbf40e82c6b0f4c5c70424dc2cba (patch)
tree100947680e34481fb16195475624bcc77aac06e2 /Master/texmf-dist/doc/latex/biblatex-publist
parent32cd0022ad89e183f0e64d18cc4794daea2ae542 (diff)
biblatex-publist (12feb17)
git-svn-id: svn://tug.org/texlive/trunk@43200 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/README12
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.pdfbin297438 -> 299905 bytes
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex106
3 files changed, 82 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-publist/README b/Master/texmf-dist/doc/latex/biblatex-publist/README
index 1340222fe1c..f7b48eabf87 100644
--- a/Master/texmf-dist/doc/latex/biblatex-publist/README
+++ b/Master/texmf-dist/doc/latex/biblatex-publist/README
@@ -45,6 +45,18 @@ instructions.
== CHANGES ==
+* V. 1.4 (2017-02-12):
+ - New option 'plauthorhandling' that defines how the publist author is
+ handled in the publication list (possible values: "omit" [= default],
+ "highlight").
+ - New command \plauthorhl that determines the aforementioned highlighting.
+ - Rename \omitname to \plauthorname (the old macro is still functional,
+ but marked as deprecated).
+ - Rename omit* options to plauthor* (the old options are still functional,
+ but marked as deprecated).
+ - Assure the margin text always starts uppercased (relevant for pubstates).
+ - Minor corrections to the manual.
+
* V. 1.3 (2016-08-06):
- It is now possible to change the base style that is used.
- Proper sorting of pubstates.
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 f02e87c21f8..a281c2231e5 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 823fa7ea9b0..9a5c5cfc600 100644
--- a/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex
+++ b/Master/texmf-dist/doc/latex/biblatex-publist/biblatex-publist.tex
@@ -79,7 +79,7 @@
\thanks{Please report issues via \protect\url{https://github.com/jspitz/biblatex-publist}.}%
}
-\date{Version 1.3, 2016/08/06}
+\date{Version 1.4, 2017/02/12}
\maketitle
\begin{abstract}
@@ -87,7 +87,8 @@
({*}.bbx) for publication lists, i.\,e.\ a bibliography containing one's own
publications. The style file draws on \bibltx's \emph{authoryear} style per default
(which can be changed), but provides some extra features needed for publication lists,
-such as the omission of the own name from author or editor data. The package requires at least version 3.4 of the \bibltx\ package\footnote{For \bibltx, see
+such as the omission or highlighting of the own name from\slash in author or editor data.
+The package requires at least version 3.4 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).
\end{abstract}
@@ -99,7 +100,8 @@ 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.
+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.
@@ -121,17 +123,19 @@ Markey's conceptual ideas. Bug reports, comments and ideas are welcome.\filbreak
The standard way of using the package is to load the style file via
\begin{quote}
-\begin{lstlisting}[language={[LaTeX]TeX},moretexcs={[1]{omitname}}]
+\begin{lstlisting}[language={[LaTeX]TeX},moretexcs={[1]{plauthorname}}]
\usepackage[bibstyle=publist]{biblatex}
-\omitname[first name][von-part]{surname}
+\plauthorname[first name][von-part]{surname}
\end{lstlisting}
\end{quote}
-The \jcsmacro*{omitname} macro (at least with the mandatory
-\emph{surname} argument) needs to be given once. It informs the style
-file which name it should suppress in the author\slash editor list
-(usually yours). That is to say: For all of your publications where
-you are the sole author or editor, the author\slash editor name
-will be omitted completely, as in:
+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
+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:
\begin{quote}
\textbf{2012.} Some recent trends in gardening. In: \emph{Gardening
Practice} 56, pp.~34--86.
@@ -142,6 +146,12 @@ out and the collaborators added in parentheses, as in:
\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
+will be printed in bold face instead, as in:
+\begin{quote}
+ John Doe, \textbf{Me Myself} and Mary Hall \textbf{1987}. Are there new trends
+ in gardening? In: \emph{Gardening Practice} 24, pp.~10--15.
+\end{quote}
\subsection{Additional options}
@@ -150,15 +160,22 @@ Currently, the following additional options are provided (next to the
options provided by the \bibltx\ package itself%
\footnote{Please refer to the \bibltx\ manual \cite{bibltx} for those.}):
\begin{description}
-\item [{\joption{omitname}=<surname>}]
-\item [{\joption{omitfirstname=<first name>}}]
-\item [{\joption{omitnameprefix=<von-part>}}] ~
+\item [{\joption{plauthorname=<surname>}}]
+\item [{\joption{plauthorfirstname=<first name>}}]
+\item [{\joption{plauthornameprefix=<von-part>}}] ~
-This is an alternative to the \jcsmacro{omitname} macro
-described in sec.~\ref{sec:standard-usage}. However, due to the
+This is an alternative to the \jcsmacro{plauthorname} macro
+described in sec.~\ref{sec:standard-usage}.\footnote{The options were called \jfoption{omitname}, \jfoption{omitfirstname} and \jfoption{omitnameprefix} until v.\,1.4
+of \bpl. The old options still work, but are marked as deprecated.} However, due to the
way bibliography options are implemented in \bibltx, this only works
if your name does not consist of non-ASCII characters. Hence, the
-\jcsmacro{omitname} macro is the recommended way.
+\jcsmacro{plauthorname} macro is the recommended way.
+
+\item [{\joption{plauthorhandling{[}=omit|highlight{]}}}] default: \emph{omit}.
+
+By default, the publist author (as defined with \jmacro{plauthor}) is omitted from
+the author or editor list. If you use the option \joption{plauthorhandling=highlight},
+it is highlighted instead (i.\,e., set in bold face by default; see sec.~\ref{sec:auxmacros} how to change that).
\item [{\joption{boldyear{[}=true|false{]}}}] default: \emph{true}.
@@ -189,6 +206,17 @@ The appearance of the \emph{marginyear} is controlled by the
If you want to change the appearance, just redefine this macro via
\jfcsmacro{renewcommand{*}}.
+The highlighting of the publication list author, if \joption{plauthorhandling=highlight} has been set,
+is controlled by the \jcsmacro*{plauthorhl} macro, which has the following default definition:
+\begin{quote}
+ \begin{lstlisting}[language={[LaTeX]TeX},
+ moretexcs={[2]{providecommand,plauthorhl,mkbibbold}}]
+\providecommand*\plauthorhl[1]{%
+ \mkbibbold{#1}%
+}
+\end{lstlisting}\end{quote}
+If you need another form of highlighting, redefine this macro via \jfcsmacro{renewcommand{*}}.
+
The indendation of the bibliographic entries (lines > 1) can be adjusted by setting the length
\jmacro*{extralabel\-numberwidth} via \jfcsmacro{setlength} (default is \texttt{0pt}).
This might be needed for long bibliographies (> 99 entries) in order to adjust to the extra
@@ -199,7 +227,7 @@ space the item number needs.
By default, \bpl\ loads \bibltx's \emph{authoryear} style, and it has been written
to work with that style. However, it is possible to try a diffent base style, if
-\emph{author\-year} does not fit your needs.
+\emph{author\-year} does not fit your needs.\condbreak{2\baselineskip}
In order to do so, enter the following \emph{before} loading \bibltx:
\begin{quote}
@@ -211,6 +239,7 @@ where <stylename> is the name of the biblatex bibliography style (\emph{bbx}) yo
Note, though, that there is (and can be) no guarantee that \bpl\ will work with all styles, although it has been successfully tested with several. Be prepared to bump into \LaTeX\ errors and carefully check the output for correctness if you try a different base style.
+
\section{Localization}
Since the package draws on \bibltx, it supports localization.
@@ -218,7 +247,7 @@ 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.
+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}).
@@ -270,14 +299,14 @@ Then a typical file would look like example~\ref{example} (p.~\pageref{example})
frame=single,
label={example},
language={[LaTeX]TeX},
- moretexcs={[4]{omitname,addbibresource,printbibliography,maketitle}}]
+ moretexcs={[4]{plauthorname,addbibresource,printbibliography,maketitle}}]
\documentclass{article}
\usepackage[T1]{fontenc}
\usepackage[latin9]{inputenc}
\usepackage{csquotes}% not required, but recommended
\usepackage[bibstyle=publist]{biblatex}
-\omitname[John]{Doe}
+\plauthorname[John]{Doe}
\addbibresource{%
mymonographs.bib,
@@ -392,12 +421,22 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{lstlisting}
\end{quote}
-\clearpage
-
\section{Revision Log}
\begin{description}
-\item [{V.~1.3 (2016-08-05):}]~
+\item [{V.~1.4 (2017-02-12):}]~
+ \begin{itemize}
+ \item New option \joption{plauthorhandling} that defines how the publist author is
+ handled in the publication list (possible values: \joption{omit} [=~default],
+ \joption{highlight}).
+ \item New command \jcsmacro{plauthorhl} that determines the aforementioned highlighting.
+ \item Rename \jcsmacro{omitname} to \jcsmacro{plauthorname} (the old macro is still functional, but marked as deprecated).
+ \item Rename \joption{omit*} options to \joption{plauthor*} (the old options are still functional, but marked as deprecated).
+ \item Assure the margin text always starts uppercased (relevant for pubstates).
+ \item Minor corrections to the manual.
+ \end{itemize}
+
+\item [{V.~1.3 (2016-08-06):}]~
\begin{itemize}
\item It is now possible to change the base style that is used by \bpl. See sec.~\ref{sec:basestyle}.
@@ -408,7 +447,6 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{itemize}
\item [{V.~1.2 (2016-05-12):}]~
-
\begin{itemize}
\item Accomodate to the backwards-incompatible changes of \bibltx~3.4\\
(\jfoption{prefixnumber} $\Rightarrow$ \jfoption{labelprefix},
@@ -417,7 +455,6 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{itemize}
\item [{V.~1.1 (2016-03-09):}]~
-
\begin{itemize}
\item Adapt to the \jfcsmacro{Declare*Name} changes of \bibltx~3.3.
Since \bibltx~3.3 introduced backwards-incompatible changes that
@@ -425,14 +462,12 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{itemize}
\item [{V.~1.0~(2015-01-04):}]~
-
\begin{itemize}
\item Add portmanteau *.cbx file to allow loading \bpl\ also via
the \jfoption{style} option (next to \jfoption{bibstyle}).
\end{itemize}
\item [{V.~0.9~(2014-03-13):}]~
-
\begin{itemize}
\item Fix problem with multi-token names.
\item Support name prefix in \jcsmacro{omitname}.
@@ -440,7 +475,6 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{itemize}
\item [{V.~0.8~(2013-08-16):}]~
-
\begin{itemize}
\item Add custom sorting schemes \jmacro{ddnt}, \jmacro{ydmdnt} and \jmacro{dnt}
(see sec.~\ref{sec:sorting}).
@@ -448,23 +482,22 @@ That is, to sort your talks in descending order by full date in your CV, use:
\end{itemize}\condbreak{2\baselineskip}
\item [{V.~0.7~(2013-07-25):}]~
-
\begin{itemize}
\item Support full dates.
\end{itemize}
-\item [{V.~0.6~(2013-07-21):}]~
+\item [{V.~0.6~(2013-07-21):}]~
\begin{itemize}
\item Fix numbering with recent \bibltx\ versions.
\end{itemize}
-\item [{V.~0.5~(2013-05-03):}]~
+\item [{V.~0.5~(2013-05-03):}]~
\begin{itemize}
\item Fix numbering if \jfcsmacro{printbibliography} is used
multiple times within the same or without any \jfmacro{refsection}.
\end{itemize}
-\item [{V.~0.4~(2012-10-30):}]~
+\item [{V.~0.4~(2012-10-30):}]~
\begin{itemize}
\item More robust name parsing (especially for names with non-ASCII characters
encoded with \LaTeX{} macros). The code was kindly suggested by Enrico
@@ -474,8 +507,8 @@ Gregorio.%
\item Add \jcsmacro{omitname} command (see sec.~\ref{sec:standard-usage}).
\item Support \joption{firstinits} option.
\end{itemize}
-\item [{V.~0.3~(2012-10-23):}]~
+\item [{V.~0.3~(2012-10-23):}]~
\begin{itemize}
\item Bug fix: Add missing ``and'' if omitted name was last minus one.
\item Bug fix: Fix output with ``et al.'' if omitted name is first and
@@ -485,6 +518,7 @@ Gregorio.%
\item Add French localization.
\item Some corrections to the manual.
\end{itemize}
+
\item [{V.~0.2~(2012-10-21):}] Initial release to CTAN.
\end{description}
@@ -500,11 +534,11 @@ course Philipp Lehman (not only) for \bibltx.
\bibitem{bibltx}Lehman, Philipp (with Audrey Boruvka, Philip Kime
and Joseph Wright): \emph{The biblatex Package. Programmable Bibliographies
and Citations}. March 3, 2016.
-\url{http://mirror.ctan.org/macros/latex/contrib/biblatex}.
+\url{http://www.ctan.org/pkg/biblatex}.
\bibitem{ttb}Markey, Nicolas: \emph{Tame the BeaST. The B to X of
BibTEX}. October 11, 2009.
-\url{http://mirror.ctan.org/info/bibtex/tamethebeast}.
+\url{http://www.ctan.org/pkg/tamethebeast}.
\end{thebibliography}
\end{document}