summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-02-08 22:54:50 +0000
committerKarl Berry <karl@freefriends.org>2019-02-08 22:54:50 +0000
commit6aec567aac27c67a7124b7e5ebc39220997229e9 (patch)
tree67493ad01fbbdc955dd7e07255780f6353386dd0 /Master/texmf-dist/doc
parent828b53f81144c4f0f622ce4106cba2851693bdfb (diff)
biblatex-ext (8feb19)
git-svn-id: svn://tug.org/texlive/trunk@49973 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-ext/CHANGES.md189
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-ext/README.md4
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.pdfbin625723 -> 693036 bytes
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.tex1002
4 files changed, 778 insertions, 417 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-ext/CHANGES.md b/Master/texmf-dist/doc/latex/biblatex-ext/CHANGES.md
index cb21c0498bd..0e5fb06db12 100644
--- a/Master/texmf-dist/doc/latex/biblatex-ext/CHANGES.md
+++ b/Master/texmf-dist/doc/latex/biblatex-ext/CHANGES.md
@@ -1,56 +1,120 @@
-# Version 0.6b (2019-01-11)
-See https://github.com/moewew/biblatex-ext/compare/v0.6a...v0.6b
-- Fixed issue loading socket.url
- (https://github.com/moewew/biblatex-ext/issues/17)
-- Changed `blxextdoiapi.lua` so that it returns the module.
-
-# Version 0.6a (2019-01-04)
-See https://github.com/moewew/biblatex-ext/compare/v0.6...v0.6a
+# Changelog
+
+
+## Version 0.7 (2019-02-08)
+See <https://github.com/moewew/biblatex-ext/compare/v0.6b...v0.7>
+
+### Added
+- Outer citation delimiters for `\supercite`.
+- `biblatex-ext-oasymb-pict2e` for open access symbols drawn in `pict2e`.
+ The package can be used via the `symbolpackage=pict2e` option to
+ `biblatex-ext-oa` and provides a light-weight alternative to the the symbols
+ drawn with TikZ or the experimental `l3draw` (of LaTeX3 fame).
+- `biblatex-ext-oasymb-l3draw` for open access symbols drawn in `l3draw`.
+ The package can be used via the `symbolpackage=l3draw` option to
+ `biblatex-ext-oa` and provides a LaTeX3 alternative to the the symbols drawn
+ with TikZ or `pict2e`.
+- `\LoadOASymbolPackage`, `\DeclareOASymbol` to load an open access symbol
+ package and set the symbol.
+- `symbolpackage` and `symbol` options for `biblatex-ext-oa` corresponding to
+ `\LoadOASymbolPackage` and `\DeclareOASymbol`, respectively.
+
+### Changed
+- **Incompatible change** Renamed `biblatex-ext-oa-tikzsymbols` to
+ `biblatex-ext-oasymb-tikz` for consistency.
+ No serious impact for end users is expected since the package should normally
+ not be used as a stand-alone package.
+ It should be loaded via `biblatex-ext-oa`.
+
+### Deprecated
+- Deprecate `\DefineTikZOASymbol` in favour of the more universal
+ `\DeclareOASymbol`.
+- Deprecate `\LoadTikZOASymbol` in favour of the more universal
+ `\LoadOASymbolPackage`.
+- Deprecate the `biblatex-ext-oa` option `tikzsymbol` in favour of the new
+ options `symbolpackage` and `symbol`.
+
+
+## Version 0.6b (2019-01-11)
+See <https://github.com/moewew/biblatex-ext/compare/v0.6a...v0.6b>
+
+### Changed
+- `blxextdoiapi.lua` now returns the module as a table.
+
+### Fixed
+- Issue loading `socket.url` with LuaLaTeX 1.07 (TeX Live 2018)
+ (<https://github.com/moewew/biblatex-ext/issues/17>)
+
+
+## Version 0.6a (2019-01-04)
+See <https://github.com/moewew/biblatex-ext/compare/v0.6...v0.6a>
+
+### Changed
- Only patch bibmacros in `biblatex-ext-oa`. This avoids redefinitions,
which could clear out custom definitions.
- Use socket.url's URL escape/encode function in blxextdoiapi.lua.
-- Fixed bug in deprecation handling.
-# Version 0.6 (2018-11-23)
-See https://github.com/moewew/biblatex-ext/compare/v0.5a...v0.6
-- Synced `mergedate` code with `biblatex` 3.12
- (https://github.com/plk/biblatex/pull/810
- https://github.com/plk/biblatex/issues/752).
+### Fixed
+- A bug in deprecation handling.
+
+
+## Version 0.6 (2018-11-23)
+See <https://github.com/moewew/biblatex-ext/compare/v0.5a...v0.6>
+
+### Added
+- `\titleaddonpunct`
+- The package `biblatex-ext-oa` for open access symbols and open access
+ 'detection'.
+ See <https://tex.stackexchange.com/q/459449/>.
+ - The default detection relies on explicit configuration for all URL,
+ DOI and eprint-like and data in the `.bib` file.
+ - There is a Lua module that queries Unpaywall.org by DOI to find
+ open access info.
+ - A support package provides two open access symbols drawn with TikZ.
+
+### Changed
- `biblatex` 3.12 is now recommended.
-- Added `\titleaddonpunct`.
+- Synced `mergedate` code with `biblatex` 3.12
+ (<https://github.com/plk/biblatex/pull/810>,
+ <https://github.com/plk/biblatex/issues/752>).
- Made `introcite` and `dashed` option available on per-entry and
- per-type basis. (https://github.com/moewew/biblatex-ext/issues/13)
+ per-type basis. (<https://github.com/moewew/biblatex-ext/issues/13>)
- `introcite=label` needs support of the bibliography environment,
so it is not officially supported if its is not set globally.
- Simplify code to set options at all three levels at the same time.
-- Added package for open access symbols and open access 'detection'.
- See https://tex.stackexchange.com/q/459449/.
- - The default detection relies on explicit configuration for all url,
- doi and eprint-like and data in the `.bib` file.
- - There is a Lua module that queries Unpaywall.org by DOI to find
- open access info.
- - A support package provides two open access symbols drawn with TikZ.
-# Version 0.5a (2018-10-09)
-See https://github.com/moewew/biblatex-ext/compare/v0.5...v0.5a
-- Fixed a bug with `\footcites` and `\footcitetexts` in `ext-authoryear.cbx`
- (https://github.com/moewew/biblatex-ext/issues/12)
-# Version v0.5 (2018-10-02)
-See https://github.com/moewew/biblatex-ext/compare/v0.4...v0.5
-- Added the `ecomp` style family. The styles of that family compress lists of
+## Version 0.5a (2018-10-09)
+See <https://github.com/moewew/biblatex-ext/compare/v0.5...v0.5a>
+
+### Fixed
+- Bug with `\footcites` and `\footcitetexts` in `ext-authoryear.cbx`
+ (<https://github.com/moewew/biblatex-ext/issues/12>)
+
+
+## Version 0.5 (2018-10-02)
+See <https://github.com/moewew/biblatex-ext/compare/v0.4...v0.5>
+
+### Added
+- New `ecomp` style family. The styles of that family compress lists of
extradate fields.
-- Added outer cite delimiters for `\footcite`.
-- Added `version` and `pagetotal` bibmacros.
- First implementation of a tabular bibliography based on Audrey's answer to
- https://tex.stackexchange.com/q/71088/35864
+ <https://tex.stackexchange.com/q/71088/35864>
+- Outer cite delimiters for `\footcite`.
+- `version` and `pagetotal` bibmacros.
-# Version 0.4 (2018-06-10)
-See https://github.com/moewew/biblatex-ext/compare/v0.3...v0.4
+### Changed
+- Use `version` and `pagetotal` macros instead of `\printfield`.
+
+
+## Version 0.4 (2018-06-10)
+See <https://github.com/moewew/biblatex-ext/compare/v0.3...v0.4>
+
+### Changed
- Renamed `\DeclareOuterCiteDelim` and friends to `\DeclareOuterCiteDelims`,
backwards compatibility for most of this change should be available.
-- **Incompatible change** Renamed the cite command `\bbx@cite@inxref` to
- `\bbx@xrefcite` for consistency with other citation commands.
+- **Incompatible change** Renamed `\bbx@cite@inxref` to `\bbx@xrefcite`
+ for consistency with other citation commands.
There are is no compatibility code set up for this change.
- **Incompatible change** The "virtual" citation command `\bbx:introcite`
is now called `\bbx@introcite`. ("Virtual" because the appearance of the
@@ -67,22 +131,33 @@ See https://github.com/moewew/biblatex-ext/compare/v0.3...v0.4
- Renamed option `citeinxref` to `citexref`. Please use the new name.
Backwards compatibility is in place.
-# Version 0.3 (2018-06-04)
-See https://github.com/moewew/biblatex-ext/compare/v0.2...v0.3
-- Added `titlecase:<titletype>` field formats for finer control over the title
+
+## Version 0.3 (2018-06-04)
+See <https://github.com/moewew/biblatex-ext/compare/v0.2...v0.3>
+
+### Added
+- `titlecase:<titletype>` field formats for finer control over the title
casing. The standard styles have the catch-all format `titlecase`. This
bundle now has `titlecase:title`, `titlecase:booktitle`,
`titlecase:maintitle`, `titlecase:issuetitle` and `titlecase:journaltitle`.
-- Various documentation improvements.
-- Added toggle `bbx:introcite:plain:keeprelated` to choose not to suppress the
+- Toggle `bbx:introcite:plain:keeprelated` to choose not to suppress the
`introcite=plain` cite label for default related entries (other
`relatedtype`s may already suppress the cite label without chance of getting
it back).
-- Added `\jourvoldelim`, `\jourserdelim` and `\servoldelim`.
+- `\jourvoldelim`, `\jourserdelim` and `\servoldelim`.
+
+### Changed
+- Turned `extradateonlycompcitedelim` into a context-sensitive delimiter.
+- Various documentation improvements.
+
+
+## Version 0.2 (2018-03-28)
+See <https://github.com/moewew/biblatex-ext/compare/v0.1a...v0.2>
-# Version 0.2 (2018-03-28)
-See https://github.com/moewew/biblatex-ext/compare/v0.1a...v0.2
-- Fixed indentation with `introcite=label`.
+### Added
+- `\voltitledelim`
+
+### Changed
- **Incompatible change** The lengths for `introcite=label` now work like
`\labelwidth` and `\labelsep` in all other lists.
`\introcitewidth` controls the maximum length of the label, while
@@ -93,13 +168,25 @@ See https://github.com/moewew/biblatex-ext/compare/v0.1a...v0.2
- **Incompatible change** `\maintitletitledelim` is now truly the punctuation
between the `maintitle` and `(book)title` field.
What was formerly `\maintitledelim` is now `\voltitledelim`.
+- Renamed `bbx:cite:intro` to `bbx:introcite`.
+- Sync with upstream `biblatex` to add `type` and `event+venue+date` to
+ `@unpublished`
+
+### Fixed
+- Indentation with `introcite=label`.
+- Bug in `@online` printing `organization+location+date`.
+
-# Version 0.1a (2018-03-20)
-See https://github.com/moewew/biblatex-ext/compare/v0.1...v0.1a
-- Fixed inner cite delims for authoryear/authortitle and their ibid versions.
-- Fixed delimiters for `\smartcite`.
+## Version 0.1a (2018-03-20)
+See <https://github.com/moewew/biblatex-ext/compare/v0.1...v0.1a>
+
+### Fixed
+- Inner cite delims for `authoryear`/`authortitle` and their `-ibid`
+ versions.
+- Delimiters for `\smartcite`.
`\smartcite` really behaves like `\parencite` and `\footcite` now.
This needed some trickery to get the delimiter context right.
-# Version 0.1 (2018-03-18)
+
+## Version 0.1 (2018-03-18)
- First public release.
diff --git a/Master/texmf-dist/doc/latex/biblatex-ext/README.md b/Master/texmf-dist/doc/latex/biblatex-ext/README.md
index 91373089650..f03d437bf19 100644
--- a/Master/texmf-dist/doc/latex/biblatex-ext/README.md
+++ b/Master/texmf-dist/doc/latex/biblatex-ext/README.md
@@ -69,7 +69,9 @@ standard styles. The bundle consists of the following files
- The package `biblatex-ext-oa.sty`
- The support package `biblatex-ext-oa-doiapi.sty`
- The Lua module `blxextdoiapi.lua`
- - The symbol package `biblatex-ext-oa-tikzsymbols.sty`
+ - The `pict2e` symbol package `biblatex-ext-oasymb-pict2e.sty`
+ - The TikZ symbol package `biblatex-ext-oasymb-tikz.sty`
+ - The `l3draw` symbol package `biblatex-ext-oasymb-l3draw.sty`
All of these files (including `blxextdoiapi.lua`) are runtime files that
need to be installed where LaTeX can find them.
diff --git a/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.pdf b/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.pdf
index c9f2a60ba74..d42303f530a 100644
--- a/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.pdf
+++ b/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.tex b/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.tex
index 26362b47c20..9e735f65246 100644
--- a/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.tex
+++ b/Master/texmf-dist/doc/latex/biblatex-ext/biblatex-ext.tex
@@ -43,11 +43,24 @@
>{\raggedright\let\newline\\\arraybackslash\hspace{0pt}}p{#1}}
\usepackage[listings, breakable, skins]{tcolorbox}%
\usetikzlibrary{arrows.meta}
+\usetikzlibrary{shapes.geometric}
\usepackage[style=ext-authoryear-iecomp, backend=biber]{biblatex}
\addbibresource{biblatex-examples.bib}
\addbibresource{biblatex-ext-examples.bib}
\usepackage{biblatex-ext-tabular}
-\usepackage[tikzsymbol=plos]{biblatex-ext-oa}
+\usepackage{biblatex-ext-oa}
+% Normally, the following packages should not be loaded explicitly.
+% Instead, one of them (and *only* one) should be loaded via
+% biblatex-ext-oa's options.
+\usepackage{biblatex-ext-oasymb-tikz}
+% We need to undefine \oasymbol to be able to load the other packages as well.
+\undef\oasymbol
+\undef\DefineOASymbol
+\usepackage{biblatex-ext-oasymb-l3draw}
+% We need to undefine \oasymbol to be able to load the other packages as well.
+\undef\oasymbol
+\undef\DefineOASymbol
+\usepackage{biblatex-ext-oasymb-pict2e}
\makeatletter
\defbibcheck{examplebib}{%
@@ -177,7 +190,24 @@
listing style = extblxstylebibtex,
#1}
-\makeatletter
+\newtcolorbox{warnbox}[1][]{%
+ enhanced,
+ colframe=red, colback=red!5!white,
+ underlay={%
+ \path[draw=none] (interior.south east)
+ rectangle node{\warnsymbol}
+ ([xshift=15mm,yshift=.1cm]interior.north east);},
+ #1}
+
+\newtcolorbox{remindbox}[1][]{%
+ enhanced,
+ colframe=yellow, colback=yellow!5!white,
+ underlay={%
+ \path[draw=none] (interior.south east)
+ rectangle node{\dbendsymbol}
+ ([xshift=15mm,yshift=.1cm]interior.north east);},
+ #1}
+
\AtUsedriver*{%
\let\newblock\relax
\let\abx@macro@bibindex\@empty
@@ -340,23 +370,18 @@
\par\endgroup
\nobreak\vspace{\itemsep}}
-\def\ltd@item@ii#1#2{%
- \ltd@itemsave
- \ifhmode
- \itemsep\z@
- \else
- \ltd@itembreak
- \fi
- \item[#1]%
- \ifblank{#2}
- {}
- {\phantomsection\label{exltd@itm@#2}}%
- \ltd@itemrest
- \ifblank{#2}{}{\ltd@pdfbookmark{#2}{#1}}}
+% inject a label additional to the bookmark so we can link stuff
+\let\exltd@pdfbookmark\ltd@pdfbookmark
+\def\ltd@pdfbookmark#1#2{%
+ \phantomsection\label{exltd@itm@#1}%
+ \exltd@pdfbookmark{#1}{#2}}
\blx@inputonce{ext-biblatex-aux.def}{auxiliary code for ext-biblatex}{}{}{}{}
\newcommand*{\biblatexversion}{\extblx@requiredbiblatexversion}
+\def\exltd@isofydate#1/#2/#3{#1-#2-#3}
\newcommand*{\biblatexdate}{\extblx@requiredbiblatexdate}
+\expandafter\def\expandafter\biblatexdate\expandafter{%
+ \expandafter\exltd@isofydate\extblx@requiredbiblatexdate}
\AtEndPreamble{%
\deflength{\marglistwidth}{(\oddsidemargin+2cm)*85/100}}
@@ -392,7 +417,6 @@
node[anchor=\punctarrow@nodeanchor,text = black]
{\punctarrow@hyperref{#1}{\punctarrow@cmdfont\cmd{#1}}};%
}
-\makeatother
% By Stefan Kottwitz, see https://tex.stackexchange.com/a/799/35864
\newcommand*\justify{%
@@ -405,17 +429,39 @@
% no \mbox here, we may have to break things
\renewrobustcmd*{\sty}[1]{{\verbatimfont\justify #1}}
+\newrobustcmd*{\blxstyle}[1]{{\verbatimfont\justify #1}}
+\newrobustcmd*{\filename}[1]{{\verbatimfont\justify #1}}
\renewrobustcmd*{\bibfield}[1]{\sty{#1}}
\renewrobustcmd*{\opt}[1]{\sty{#1}}
+\newrobustcmd*{\optval}[1]{\sty{#1}}
\newrobustcmd*{\bibmacro}[1]{\sty{#1}}
\renewrobustcmd*{\bibtype}[1]{\sty{@#1}}
\renewrobustcmd*{\cmd}[1]{\sty{\textbackslash #1}}
\let\cs\cmd
\newrobustcmd*{\bibfieldformat}[1]{{\bibfieldformatfont #1}}
+\newrobustcmd*{\gencode}[1]{{\verbatimfont\justify #1}}
+
+\def\exltd@buildhypercmd@i#1{%
+ \expandafter\newrobustcmd\expandafter*\expandafter
+ {\csname hyper#1@i\endcsname}[2][]{%
+ \hyperref[exltd@itm@##1]{\csname #1\endcsname{##2}}}
+ \csdef{hyper#1}{\@dblarg{\csname hyper#1@i\endcsname}}}
+
+\def\exltd@buildhypercmd{\forcsvlist{\exltd@buildhypercmd@i}}
+
+\exltd@buildhypercmd{cmd,opt,bibmacro,len,blxstyle,sty,bibfield,bibfieldformat,
+ filename}
+
+\newrobustcmd*{\hyperkvopt}[2]{{%
+ \verbatimfont\hyperref[exltd@itm@#1]{#1}\penalty\@M
+ \hskip 0em plus 0.15em\relax
+ =\penalty\hyphenpenalty
+ \hskip 0em plus 0.15em\relax #2}}
+
\newcommand*{\ctan}{\mkbibacro{CTAN}}
\newcommand*{\gitbaseurl}{https://github.com/moewew/biblatex-ext}
-\newcommand*{\extblxversion}{0.6b}
+\newcommand*{\extblxversion}{0.7}
\newcommand*{\biber}{Biber}
\newcommand*{\gitissuelink}[1]{%
\href{\gitbaseurl/issues/#1}{issue \##1 on github}}
@@ -436,7 +482,6 @@
\newcommand*{\hmpdr}{$\bm{\rangle}$}
\fi
-\makeatletter
\iffontspec
\def\textvisiblespace{%
\raisebox{-2.2pt}{%
@@ -445,15 +490,36 @@
\hbox{\vrule \@height.5ex \@width.12ex}%
\kern.04em}}
\fi
-\makeatother
+
+% Bourbaki dangerous bend symbol by Heiko Oberdiek
+% https://tex.stackexchange.com/users/16967/heiko-oberdiek
+% https://tex.stackexchange.com/a/262510/35864
+\newcommand*{\dbendsymbol@tikz}{%
+ \begin{tikzpicture}[
+ line cap=but,
+ line join=round,
+ x=1.2em,
+ line width=2pt,
+ y=2*(height("Z")-\pgflinewidth)*(1-sin(10)),
+ rotate=-10,
+ rounded corners=1.5pt,]
+ \draw (.5,.5) node[scale=2,draw,diamond,fill=yellow,color=yellow] {};
+ \draw (1, 0) -- (0, 0) -- (1, 1) -- (0, 1);
+ \end{tikzpicture}}
+
+\newsavebox{\dbendsymbol@box}
+\sbox{\dbendsymbol@box}{\dbendsymbol@tikz}
+\newcommand*{\dbendsymbol}{\usebox{\dbendsymbol@box}}
\newcommand{\warnsymbol}{%
\makebox[2em][c]{%
\makebox[0pt][c]{\raisebox{.26em}{\LARGE\bfseries!}}%
- \makebox[0pt][c]{\fontsize{40}{40}\selectfont\color{red}$\bigtriangleup$}}}
+ \makebox[0pt][c]{%
+ \fontsize{40}{40}\selectfont\color{red}$\bigtriangleup$}}}
\newcommand*{\marginwarn}{%
\leavevmode\marginpar{\raisebox{-1.5em}{\warnsymbol}}}
+
\makeatother
\titlepage{%
@@ -463,7 +529,7 @@
author = {Moritz Wemheuer},
link = {mwemheu@gmail.com},%
revision = {\extblxversion},
- date = {\DTMDate{2019-01-11}},
+ date = {\DTMDate{2019-02-08}},
}
\hypersetup{%
@@ -484,6 +550,9 @@
bib-close-bracket
main-title-after-title
jour-vol-delim
+ in-name-before-title
+ tikz-picture
+ Define-OA-Symbol
}
@@ -497,9 +566,9 @@
The \sty{biblatex-ext} bundle provides an extended version of the standard
styles that come with \sty{biblatex}.
For each standard style this bundle provides a style with the same name
-prefixed with \texttt{ext-} which can be used as a drop-in replacement for the
-standard style~-- for example, the replacement for \sty{authoryear-icomp}
-is called \sty{ext-authoryear-icomp}.
+prefixed with \blxstyle{ext-} which can be used as a drop-in replacement for the
+standard style~-- for example, the replacement for \blxstyle{authoryear-icomp}
+is called \hyperblxstyle{ext-authoryear-icomp}.
The aim of the styles of this bundle is to offer a simple interface to change
some of the stylistic decisions made for the standard styles that would
@@ -515,7 +584,7 @@ followed at all times and the occasional solution for things that already are
\enquote{simple enough} pop up here and there.}
The initial motivation for this bundle was what has now become the option
-\opt{in\-name\-before\-title}.
+\hyperopt{innamebeforetitle}.
It is fairly straighforward to print the name of the editor of an
\bibtype{incollection} before the \bibfield{booktitle}.
But if one does not want to resort to clever tricks,%
@@ -546,15 +615,15 @@ maybe you are lucky and the style you are looking for has already been
implemented by someone else.
As was the intention, most methods to modify the standard styles are also
applicable to the styles of this bundle, but you may break some of their
-features if you happen to modify something that the \sty{ext-} styles redefine
-themselves.
+features if you happen to modify something that the \blxstyle{ext-} styles
+redefine themselves.
While many contributed \sty{biblatex} styles are examples of good \sty{biblatex}
style coding, this can not be said of all of the files included in this bundle.
Especially the citation styles for compact citations have to work harder
to implement the citation delimiter feature properly.
So if you want to get inspired for your \sty{biblatex} coding, be warned that
-terrible things lurk in the \sty{.cbx} files.
-The standard \sty{.cbx} files will give you a much better impression of how
+terrible things lurk in the \filename{.cbx} files.
+The standard \filename{.cbx} files will give you a much better impression of how
things should be done.
@@ -596,7 +665,7 @@ But at times not even that is possible, so it is always a good idea to consult
the change history after an update and to examine the output with extra
scrutiny.
Higher-level changes are found in the revision history in \cref{sec:log},
-more technical changes and commentary can be found in \sty{CHANGES.md},
+more technical changes and commentary can be found in \filename{CHANGES.md},
the full set of changes can be investigated by comparing the tagged and
publicly available source code.
@@ -607,10 +676,11 @@ The current release is also available in \miktex{} and \texlive{} 2018 or
newer.
If at all possible you should install this bundle via your \tex{} distribution
(using \miktex{} Console\fnurl{https://miktex.org/howto/miktex-console} or
-\sty{tlmgr} for \texlive\fnurl{https://www.tug.org/texlive/pkginstall.html}).
+\gencode{tlmgr} for \texlive
+\fnurl{https://www.tug.org/texlive/pkginstall.html}).
If you must install this package manually, get the files from \ctan{}
-and install the \sty{.bbx}, \sty{.cbx}, \sty{.def}, \sty{.sty} and \sty{.lua}
-files preferably to
+and install the \filename{.bbx}, \filename{.cbx}, \filename{.def},
+\filename{.sty} and \filename{.lua} files preferably to
\path{tex/latex/biblatex-ext} of your local or home \TeX{} tree%
\fnurl{https://texfaq.org/FAQ-inst-wlcf}, the other
files (\path{CHANGES.md}, \path{README.md}, \path{biblatex-ext.tex},
@@ -647,9 +717,9 @@ You can load the styles exactly as you would load the standard styles:
\usepackage[style=(*@\prm{style}@*)]{biblatex}
\end{biblatexcode}
The naming of the styles follows the scheme
-\mbox{\texttt{ext-}\prm{standard style}}, e.g.,
-the style corresponding to \sty{authoryear-icomp} is called
-\sty{ext-authoryear-icomp}.
+\mbox{\blxstyle{ext-}\prm{standard style}}, e.g.,
+the style corresponding to \blxstyle{authoryear-icomp} is called
+\hyperblxstyle{ext-authoryear-icomp}.
This manual assumes familiarity with the concepts of \sty{biblatex} and does
not attempt to explain any of the standard \sty{biblatex} features, so you may
@@ -689,57 +759,57 @@ and the style examples%
\fnurl{http://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/examples/}
for a more detailed description of each standard style.
The relations between the styles are exactly as in their standard counterparts.
-The \texttt{ext-} styles only build on top of the standard files.
+The \blxstyle{ext-} styles only build on top of the standard files.
\begin{stylelist}
\styleitem{ext-numeric}
-An extended version of the standard \sty{numeric} style for citations with
+An extended version of the standard \blxstyle{numeric} style for citations with
numeric labels.
\begin{bibexample}[]
[1, 2, 5, 6, 7]
\end{bibexample}
\styleitem{ext-numeric-comp}
-An extended version of the standard \sty{numeric-comp} style.
-Similar to \sty{ext-numeric}, but citation labels are
+An extended version of the standard \blxstyle{numeric-comp} style.
+Similar to \blxstyle{ext-numeric}, but citation labels are
compressed to give \enquote{[1--3]} instead of \enquote{[1, 2, 3]}.
\begin{bibexample}[]
[1, 2, 5--7]
\end{bibexample}
\styleitem{ext-numeric-verb}
-An extended version of the standard \sty{numeric-verb} style.
-This style is similar to the \sty{numeric} style, but each citation label
+An extended version of the standard \blxstyle{numeric-verb} style.
+This style is similar to the \blxstyle{numeric} style, but each citation label
is in its own set of brackets: \enquote{[1], [2], [3]}.
\begin{bibexample}[]
[1], [3], [5], [6], [7]
\end{bibexample}
\styleitem{ext-alphabetic}
-An extended version of the standard \sty{alphabetic} style for citations with
-alphabetic labels derived from author name and year.
+An extended version of the standard \blxstyle{alphabetic} style for citations
+with alphabetic labels derived from author name and year.
\begin{bibexample}[]
[SR98, Knu86c]
\end{bibexample}
\styleitem{ext-alphabetic-verb}
-An extended version of the standard \sty{alphabetic-verb} style.
-This style is based on \sty{ext-alphabetic}, but like
-\sty{ext-numeric-verb} places each citation label in its own pair of
+An extended version of the standard \blxstyle{alphabetic-verb} style.
+This style is based on \blxstyle{ext-alphabetic}, but like
+\blxstyle{ext-numeric-verb} places each citation label in its own pair of
brackets: \enquote{[SR98], [Knu86c]}.
\begin{bibexample}[]
[SR98], [Knu86c]
\end{bibexample}
\styleitem{ext-authoryear}
-An extended version of the standard \sty{authoryear} style for citations
+An extended version of the standard \blxstyle{authoryear} style for citations
using author name and year.
\begin{bibexample}
Sigfridsson and Ryde 1998
\end{bibexample}
\styleitem{ext-authoryear-comp}
-An extended version of the standard \sty{authoryear-comp} style.
-The style is based on the author-year citations of \sty{ext-authoryear},
+An extended version of the standard \blxstyle{authoryear-comp} style.
+The style is based on the author-year citations of \blxstyle{ext-authoryear},
but several works by the same author are compressed by not displaying the
author multiple times: \enquote{Knuth 1984, 1986} instead of
\enquote{Knuth 1984; Knuth 1986}.
@@ -748,32 +818,32 @@ Knuth 1984, 1986
\end{bibexample}
\styleitem{ext-authoryear-ibid}
-An extended version of the standard \sty{authoryear-ibid} style.
-This style is similar to \sty{ext-authoryear}, but repeated citations are
+An extended version of the standard \blxstyle{authoryear-ibid} style.
+This style is similar to \blxstyle{ext-authoryear}, but repeated citations are
replaced with \enquote{ibidem}.
\begin{bibexample}
Knuth 1984\quad ibid.
\end{bibexample}
\styleitem{ext-authoryear-icomp}
-An extended version of the standard \sty{authoryear-icomp} style.
-This style combines the two styles \sty{ext-authoryear-comp} and
-\sty{ext-authoryear-ibid}.
+An extended version of the standard \blxstyle{authoryear-icomp} style.
+This style combines the two styles \blxstyle{ext-authoryear-comp} and
+\blxstyle{ext-authoryear-ibid}.
\begin{bibexample}
Knuth 1984, 1986 \quad Sigfridsson and Ryde 1998 \quad ibid.
\end{bibexample}
\styleitem{ext-authortitle}
-An extended version of the standard \sty{authortitle} style for citations
+An extended version of the standard \blxstyle{authortitle} style for citations
by author and title.
\begin{bibexample}
Maron, \emph{Animal Triste}
\end{bibexample}
\styleitem{ext-authortitle-comp}
-An extended version of the standard \sty{authortitle-comp} style.
-This style is based on \sty{ext-authortitle} and compresses several citations
-by the same author just like \sty{ext-author\-year-comp}:
+An extended version of the standard \blxstyle{authortitle-comp} style.
+This style is based on \blxstyle{ext-authortitle} and compresses several
+citations by the same author just like \blxstyle{ext-author\-year-comp}:
\enquote{Aristotle, \emph{Physics}, \emph{Poetics}} instead of
\enquote{Aristotle, \emph{Physics}; Aristotle, \emph{Poetics}}.
\begin{bibexample}
@@ -781,79 +851,79 @@ Aristotle, \emph{Physics}, \emph{Poetics}
\end{bibexample}
\styleitem{ext-authortitle-ibid}
-An extended version of the standard \sty{authortitle-ibid} style.
-This style is similar to \sty{ext-authortitle}, but replaces repeated
+An extended version of the standard \blxstyle{authortitle-ibid} style.
+This style is similar to \blxstyle{ext-authortitle}, but replaces repeated
citations of the same work with \enquote{ibidem}.
\begin{bibexample}
Maron, \emph{Animal Triste}\quad ibid.
\end{bibexample}
\styleitem{ext-authortitle-icomp}
-An extended version of the standard \sty{authortitle-icomp} style.
-This style combines \sty{ext-authortitle-comp} and
-\sty{ext-authortitle-ibid}.
+An extended version of the standard \blxstyle{authortitle-icomp} style.
+This style combines \blxstyle{ext-authortitle-comp} and
+\blxstyle{ext-authortitle-ibid}.
\begin{bibexample}
Aristotle, \emph{Physics}, \emph{Poetics}\quad Maron, \emph{Animal Triste}\quad
ibid.
\end{bibexample}
\styleitem{ext-authortitle-terse}
-An extended version of the standard \sty{authortitle-terse} style.
-This style is similar to \sty{ext-authortitle}, but the title is omitted in
-citations if there is only one work by the relevant author.
+An extended version of the standard \blxstyle{authortitle-terse} style.
+This style is similar to \blxstyle{ext-authortitle}, but the title is omitted
+in citations if there is only one work by the relevant author.
\begin{bibexample}
Sigfridsson and Ryde \quad Aristotle, \emph{Physics}; Aristotle, \emph{Poetics}
\end{bibexample}
\styleitem{ext-authortitle-tcomp}
-An extended version of the standard \sty{authortitle-tcomp} style.
-This style combines \sty{ext-authortitle-terse} and
-\sty{ext-authortitle-comp}.
+An extended version of the standard \blxstyle{authortitle-tcomp} style.
+This style combines \blxstyle{ext-authortitle-terse} and
+\blxstyle{ext-authortitle-comp}.
\begin{bibexample}
Sigfridsson and Ryde \quad Aristotle, \emph{Physics}, \emph{Poetics}
\end{bibexample}
\styleitem{ext-authortitle-ticomp}
-An extended version of the standard \sty{authortitle-ticomp} style.
-This style combines \sty{ext-authortitle-terse},
-\sty{ext-authortitle-comp} and \sty{ext-authortitle-ibid}.
+An extended version of the standard \blxstyle{authortitle-ticomp} style.
+This style combines \blxstyle{ext-authortitle-terse},
+\blxstyle{ext-authortitle-comp} and \blxstyle{ext-authortitle-ibid}.
\begin{bibexample}
Aristotle, \emph{Physics}, \emph{Poetics} \quad Sigfridsson and Ryde \quad ibid.
\end{bibexample}
\styleitem{ext-verbose}
-An extended version of the standard \sty{verbose} style.
+An extended version of the standard \blxstyle{verbose} style.
This style shows the full bibliographic reference the first time a work is
cited.
\styleitem{ext-verbose-ibid}
-An extended version of the standard \sty{verbose-ibid} style.
-Based on \sty{ext-verbose}, repeated citations to the same work are replaced
-with \enquote{ibidem}.
+An extended version of the standard \blxstyle{verbose-ibid} style.
+Based on \blxstyle{ext-verbose}, repeated citations to the same work are
+replaced with \enquote{ibidem}.
\styleitem{ext-verbose-note}
-An extended version of the standard \sty{verbose-note} style.
-Based on \sty{ext-verbose} and intended for use in footnotes, subsequent
+An extended version of the standard \blxstyle{verbose-note} style.
+Based on \blxstyle{ext-verbose} and intended for use in footnotes, subsequent
citations link back to the footnote the entry was cited at first and in full.
\styleitem{ext-verbose-inote}
-An extended version of the standard \sty{verbose-inote} style.
-Similar to \sty{verbose-note}, but repeated citations to the same work are
+An extended version of the standard \blxstyle{verbose-inote} style.
+Similar to \blxstyle{verbose-note}, but repeated citations to the same work are
replaced with \enquote{ibidem}.
\styleitem{ext-verbose-trad1}
-An extended version of the standard \sty{verbose-trad1} style.
+An extended version of the standard \blxstyle{verbose-trad1} style.
This style makes extensive use of scholarly abbreviations and is otherwise
-similar to \sty{ext-verbose}.
+similar to \blxstyle{ext-verbose}.
\styleitem{ext-verbose-trad2}
-An extended version of the standard \sty{verbose-trad2} style.
-The style is similar to \sty{ext-verbose-inote} and
+An extended version of the standard \blxstyle{verbose-trad2} style.
+The style is similar to \blxstyle{ext-verbose-inote} and
uses scholarly abbreviations to shorten citations.
\styleitem{ext-verbose-trad3}
-An extended version of the standard \sty{verbose-trad3} style.
-This style is similar to \sty{ext-verbose-trad2}.
+An extended version of the standard \blxstyle{verbose-trad3} style.
+This style is similar to \blxstyle{ext-verbose-trad2}.
\end{stylelist}
\subsection{New styles}\label{sec:styles:new}
@@ -863,16 +933,16 @@ in the standard styles.
\begin{stylelist}
\styleitem{ext-authoryear-ecomp}
An author-year citation that is even more compact than
-\sty{ext-authoryear-comp}, it compresses lists of \bibfield{extradate} letters
-from \enquote{Knuth 1986a,b,c} to \enquote{Knuth 1986a\bibrangedash c}.
+\blxstyle{ext-authoryear-comp}, it compresses lists of \bibfield{extradate}
+letters from \enquote{Knuth 1986a,b,c} to \enquote{Knuth 1986a\bibrangedash c}.
\begin{bibexample}
Sigfridsson and Ryde 1998 \quad Knuth 1986a\bibrangedash c
\end{bibexample}
\styleitem{ext-authoryear-iecomp}
An author-year citation that is even more compact than
-\sty{ext-authoryear-icomp}, it compresses lists of \bibfield{extradate} letters
-from \enquote{Knuth 1986a,b,c} to \enquote{Knuth 1986a\bibrangedash c}.
+\blxstyle{ext-authoryear-icomp}, it compresses lists of \bibfield{extradate}
+letters from \enquote{Knuth 1986a,b,c} to \enquote{Knuth 1986a\bibrangedash c}.
\begin{bibexample}
Sigfridsson and Ryde 1998 \quad ibid.\quad Knuth 1986a\bibrangedash c
\end{bibexample}
@@ -880,8 +950,8 @@ Sigfridsson and Ryde 1998 \quad ibid.\quad Knuth 1986a\bibrangedash c
\styleitem{ext-authoryear-terse}
An author-year citation style that suppresses years for author lists with only
one work in the bibliography.
-This style is like \sty{ext-authortitle-terse}, but it is based on
-\sty{ext-authoryear} and not on \sty{ext-authortitle}.
+This style is like \blxstyle{ext-authortitle-terse}, but it is based on
+\blxstyle{ext-authoryear} and not on \blxstyle{ext-authortitle}.
\begin{bibexample}
Sigfridsson and Ryde \quad Knuth 1984 \quad Knuth 1986
\end{bibexample}
@@ -889,15 +959,15 @@ Sigfridsson and Ryde \quad Knuth 1984 \quad Knuth 1986
\styleitem{ext-authoryear-tcomp}
A compact author-year citation style that suppresses years for author lists
with only one work in the bibliography.
-This style is like \sty{ext-authortitle-tcomp}, but it is based on
-\sty{ext-authoryear} and not on \sty{ext-authortitle}.
+This style is like \blxstyle{ext-authortitle-tcomp}, but it is based on
+\blxstyle{ext-authoryear} and not on \blxstyle{ext-authortitle}.
\begin{bibexample}
Sigfridsson and Ryde \quad Knuth 1984, 1986
\end{bibexample}
\styleitem{ext-authoryear-tecomp}
-A compact author-year citation style that combines \sty{ext-authoryear-tcomp}
-and \sty{ext-authoryear-ecomp}.
+A compact author-year citation style that combines
+\blxstyle{ext-authoryear-tcomp} and \blxstyle{ext-authoryear-ecomp}.
\begin{bibexample}
Sigfridsson and Ryde \quad Knuth 1984, 1986a\bibrangedash c
\end{bibexample}
@@ -905,15 +975,15 @@ Sigfridsson and Ryde \quad Knuth 1984, 1986a\bibrangedash c
\styleitem{ext-authoryear-ticomp}
A compact author-year citation style with \enquote{ibidem} function that
suppresses years for author lists with only one work in the bibliography.
-This style is like \sty{ext-authortitle-ticomp}, but it is based on
-\sty{ext-authoryear} and not on \sty{ext-authortitle}.
+This style is like \blxstyle{ext-authortitle-ticomp}, but it is based on
+\blxstyle{ext-authoryear} and not on \blxstyle{ext-authortitle}.
\begin{bibexample}
Sigfridsson and Ryde \quad ibid. \quad Knuth 1984, 1986
\end{bibexample}
\styleitem{ext-authoryear-teicomp}
-A compact author-year citation style that combines \sty{ext-authoryear-ticomp}
-and \sty{ext-authoryear-iecomp}.
+A compact author-year citation style that combines
+\blxstyle{ext-authoryear-ticomp} and \blxstyle{ext-authoryear-iecomp}.
\begin{bibexample}
Sigfridsson and Ryde \quad ibid. \quad Knuth 1984, 1986a\bibrangedash c
\end{bibexample}
@@ -971,7 +1041,7 @@ This option controls if \bibtype{inbook}, \bibtype{incollection} and
bibliography if the parent is listed in the bibliography as a separate entry.
With the default setting \kvopt{citexref}{false} the parent is not cited, the
entry is shown as in the standard styles. If the option is set to
-\opt{true}, the block following the \enquote{in:} is replaced by a citation
+\optval{true}, the block following the \enquote{in:} is replaced by a citation
to the parent entry.
The option itself does \emph{not} cause the parent entry to be added to the
bibliography, this needs to happen either explicitly by citing the parent
@@ -1058,7 +1128,8 @@ Whether or not the \bibfield{editor} of the \bibfield{booktitle}
for the entry types \bibtype{inbook}, \bibtype{incollection} and
\bibtype{inproceedings} is replaced by \enquote{idem} in case the
\bibfield{editor} and \bibfield{author} name lists coincide.
-This option only has an effect if \opt{innamebeforetitle} is set to \opt{true}.
+This option only has an effect if \hyperopt{innamebeforetitle} is set to
+\optval{true}.
\begin{bibexample}[title={\kvopt{innameidem}{true}}]
\togglefalse{bbx:isbn}
@@ -1108,8 +1179,8 @@ This option only has an effect if \opt{innamebeforetitle} is set to \opt{true}.
\boolitem[false]{maintitleaftertitle}
Whether or not the \bibfield{maintitle} is printed after the
\bibfield{title} or \bibfield{booktitle} of the work.
-If \opt{maintitleaftertitle} is \opt{true}, the \bibfield{volume} field will be
-printed with the \bibfield{volumeof} format.
+If \opt{maintitleaftertitle} is \optval{true}, the \bibfield{volume} field will
+be printed with the \hyperbibfieldformat{volumeof} format.
\begingroup
\makeatletter
@@ -1170,24 +1241,24 @@ printed with the \bibfield{volumeof} format.
\subsection{Style-specific options}\label{sec:opt:style}
\begin{optionlist}
-\optitem[true]{dashed}{\opt{true}, \opt{false}, \opt{fullhash},
- \opt{bibnamehash}}
+\optitem[true]{dashed}{\optval{true}, \optval{false}, \optval{fullhash},
+ \optval{bibnamehash}}
-The \opt{dashed} option of the \sty{authoryear}- and \sty{authortitle}-like
-bibliography styles allows for finer control over the dashes than in the
-standard styles.
+The \opt{dashed} option of the \hyperblxstyle[ext-authoryear]{authoryear}- and
+\hyperblxstyle[ext-authortitle]{authortitle}-like bibliography styles allows for
+finer control over the dashes than in the standard styles.
The option is available globally and additionally on a per-type and per-entry
level.
This option controls whether or not recurring lists of authors/editors in the
bibliography are replaced with a dash.
-The standard values \opt{true} and \opt{false} are still valid and give the
-exact same output as in the standard styles.
+The standard values \optval{true} and \optval{false} are still valid and give
+the exact same output as in the standard styles.
This means that the output is fully compatible with the standard styles.
-The new values \opt{fullhash} and \opt{bibnamehash} differ in how exactly they
-determine if a list of authors/editors is the same as the previous.
+The new values \optval{fullhash} and \optval{bibnamehash} differ in how exactly
+they determine if a list of authors/editors is the same as the previous.
\begin{valuelist}
-\item[true] An alias for \opt{fullhash}.
+\item[true] An alias for \optval{fullhash}.
\item[false] Disable this feature.
\item[bibnamehash] Replace recurring name lists with a dash.
Compare name lists using \bibfield{bib\-name\-hash}, taking
@@ -1261,13 +1332,18 @@ lists are only replaced if they are indistinguishable in the data source.
-\optitem[false]{introcite}{\opt{false}, \opt{plain}, \opt{label}}
+\optitem[false]{introcite}{\optval{false}, \optval{plain}, \optval{label}}
+
+\begin{warnbox}
The \opt{introcite} option is available for the bibliography styles of the
-\sty{authoryear} and \sty{authortitle} family.
-It can not be used with citation styles of the \sty{verbose} family and may
-produce undesired output or errors.
+\hyperblxstyle[ext-authoryear]{authoryear} and
+\hyperblxstyle[ext-authortitle]{authortitle} family.
+It can not be used with citation styles of the
+\hyperblxstyle[ext-verbose]{verbose} family, where
+it may produce undesired output or errors.
The option is available globally and on a per-type and per-entry level, where
-only the values \opt{plain} (and the default \opt{false}) are supported.
+only the values \optval{plain} (and the default \optval{false}) are supported.
+\end{warnbox}
This option controls whether or not the citation label is repeated in the
bibliography.
@@ -1276,13 +1352,14 @@ There are two possible output formats.
\item[false] Do not show the citation label in the bibliography.
\item[plain] Show the citation label at the beginning of an entry.
\item[label] Show the citation label as the label of a list similar to the
- \sty{numeric} or \sty{alphabetic} styles.
+ \hyperblxstyle[ext-numeric]{numeric} or
+ \hyperblxstyle[ext-alphabetic]{alphabetic} styles.
\end{valuelist}
-The difference between \opt{plain} and \opt{label} is that the former simply
-prints the citation label at the beginning of the entry, while the latter
+The difference between \optval{plain} and \optval{label} is that the former
+simply prints the citation label at the beginning of the entry, while the latter
prints the citation label similar to the item labels in a list or the numeric
-labels in a \sty{numeric} bibliography.
+labels in a \hyperblxstyle[ext-numeric]{numeric} bibliography.
\begingroup
\togglefalse{bbx:doi}
@@ -1310,7 +1387,7 @@ labels in a \sty{numeric} bibliography.
\makeatother
\endgroup
-The label produced by the \opt{plain} option can be customised as follows.
+The label produced by the \optval{plain} option can be customised as follows.
\begin{ltxsyntax}
\csitem{introcitepunct}
@@ -1329,14 +1406,14 @@ The punctuation insterted between the label and the
\begin{keymarglistbook}
\keyitem[bbx:introcite:plain:keeprelated] This toggle controls whether or
not the citation label is also repeated for default related entries.
- The default value \opt{false} suppresses the label for related entries.
-\begin{bibexample}[title={\texttt{\string\togglefalse\{%
+ The default value \optval{false} suppresses the label for related entries.
+\begin{bibexample}[title={\gencode{\string\togglefalse\{%
bbx:introcite:plain:keeprelated\}} (default)}]
\togglefalse{bbx:doi}
\csletcs{extblx@introcite}{extblx@opt@introcite@plain}
\exampleprintbib{vizedom:related}
\end{bibexample}
-\begin{bibexample}[title={\texttt{\string\toggletrue\{%
+\begin{bibexample}[title={\gencode{\string\toggletrue\{%
bbx:introcite:plain:keeprelated\}}}]
\toggletrue{bbx:introcite:plain:keeprelated}
\renewbibmacro*{related:init}{%
@@ -1352,10 +1429,10 @@ The punctuation insterted between the label and the
Note that the implementation of some related types automatically suppresses
the introcite label~-- or rather, does not add the label in the first place.
That means that the resulting bibliography should be checked for consistency
-if the toggle is set to \opt{true}.
+if the toggle is set to \optval{true}.
\end{keymarglistbook}
-The \opt{label} option can be configured to not allow the label to run into
+The \optval{label} option can be configured to not allow the label to run into
the remaining bibliography entry thus creating the appearance of a tabular-like
bibliography.
The citation label is not broken across lines, instead it moves the entry text
@@ -1417,10 +1494,10 @@ overlay={%
The appearance of the citation label can be customised mostly as if it were
produced by a true citation command called \cmd{bbx@introcite}.
-The delimiter context is \sty{bbx@introcite}, the inner citation delimiters
-can be accessed as \sty{bbx@introcite} as well.
+The delimiter context is \gencode{bbx@introcite}, the inner citation delimiters
+can be accessed as \gencode{bbx@introcite} as well.
The label does not have outer citation delimiters, you can use the wrapper
-field format \sty{bbx@introcite} instead. In fact this approach is more
+field format \gencode{bbx@introcite} instead. In fact this approach is more
versatile than the outer citation delimiter feature (see the discussion in
\cref{sec:opt:citedelims}).
The default settings for \cmd{bbx@introcite} emulate the output of \cmd{cite}.
@@ -1504,8 +1581,8 @@ The citation delimiter interface is a novel feature of \sty{biblatex-ext},
but for the other subsections familiarity with the underlying \sty{biblatex}
concepts is assumed.
Some of this is easier understood by looking at the source code directly,
-so it might not be a bad idea to have \sty{ext-standard.bbx} open when perusing
-this section of the manual.
+so it might not be a bad idea to have \filename{ext-standard.bbx} open when
+perusing this section of the manual.
\subsection{Field formats}\label{sec:opt:field}
In a few places where the standard styles employ hard-coded formatting
@@ -1514,8 +1591,8 @@ Field formats can be modified with \cmd{DeclareFieldFormat}.
\begin{bibfieldformatlist}
\bibfieldformatitem{biblabeldate} The format for the labeldate in the
- bibliography for \sty{authoryear}-like styles. The default is to wrap
- the date in round brackets.
+ bibliography for \hyperblxstyle[ext-authoryear]{authoryear}-like styles.
+ The default is to wrap the date in round brackets.
\begin{bibexample}
\togglefalse{bbx:doi}
\DeclareFieldFormat{biblabeldate}{\highlight{\bibopenparen}\highlight[2]{#1}%
@@ -1525,7 +1602,7 @@ Field formats can be modified with \cmd{DeclareFieldFormat}.
\bibfieldformatitem{biblistlabeldate} Like \bibfieldformat{biblabeldate},
but for bibliography lists created by \cmd{printbiblist}.
- The default is to use the same format as \bibfieldformat{biblabeldate}.
+ The default is to use the same format as \hyperbibfieldformat{biblabeldate}.
\bibfieldformatitem{issuedate} The format of the \bibfield{issue} and
\bibfield{date} information for \bibtype{article}s. By default this block is
@@ -1539,7 +1616,7 @@ Field formats can be modified with \cmd{DeclareFieldFormat}.
\end{bibexample}
\bibfieldformatitem{volumeof} The format for the \bibfield{volume} of a
- \bibfield{maintitle} used when \kvopt{maintitleaftertitle}{true}.
+ \bibfield{maintitle} used when \hyperkvopt{maintitleaftertitle}{true}.
\begin{bibexample}
\togglefalse{bbx:isbn}\toggletrue{bbx:maintitleaftertitle}
\DeclareFieldFormat{volumeof}{\highlight{\bibstring{volume}}~%
@@ -1557,21 +1634,21 @@ Field formats can be modified with \cmd{DeclareFieldFormat}.
\bibfield{title} and \bibfield{subtitle}.
By default this field format is an alias for \bibfieldformat{titlecase}.
-\bibfieldformatitem{titlecase:booktitle} Like \bibfieldformat{titlecase:title},
- but controls the title casing of the \bibfield{booktitle} and
- \bibfield{booksubtitle} fields.
+\bibfieldformatitem{titlecase:booktitle}
+ Like \hyperbibfieldformat{titlecase:title}, but controls the title casing
+ of the \bibfield{booktitle} and \bibfield{booksubtitle} fields.
-\bibfieldformatitem{titlecase:maintitle} Like \bibfieldformat{titlecase:title},
- but controls the title casing of the \bibfield{maintitle} and
- \bibfield{mainsubtitle} fields.
+\bibfieldformatitem{titlecase:maintitle}
+ Like \hyperbibfieldformat{titlecase:title}, but controls the title casing
+ of the \bibfield{maintitle} and \bibfield{mainsubtitle} fields.
-\bibfieldformatitem{titlecase:journaltitle} Like
- \bibfieldformat{titlecase:title}, but controls the title casing of the
- \bibfield{journaltitle} and \bibfield{journalsubtitle} fields.
+\bibfieldformatitem{titlecase:journaltitle}
+ Like \hyperbibfieldformat{titlecase:title}, but controls the title casing
+ of the \bibfield{journaltitle} and \bibfield{journalsubtitle} fields.
-\bibfieldformatitem{titlecase:issuetitle} Like \bibfieldformat{titlecase:title},
- but controls the title casing of the \bibfield{issuetitle} and
- \bibfield{issuesubtitle} fields.
+\bibfieldformatitem{titlecase:issuetitle}
+ Like \hyperbibfieldformat{titlecase:title}, but controls the title casing
+ of the \bibfield{issuetitle} and \bibfield{issuesubtitle} fields.
The \bibfieldformat{citetitle} field format can be used to change the title
case in author-title citations, so there is no
@@ -1611,12 +1688,12 @@ can be found in \cref{sec:punctinuse}.
\begin{ltxsyntax}
\csitem{innametitledelim}\CSdelimMark
Similar to \cmd{nametitledelim}, but for names after the \enquote{in:} if
-\opt{innamebeforetitle} is \opt{true}.
+\hyperopt{innamebeforetitle} is \optval{true}.
The default value is that of \cmd{nametitledelim} for all contexts.
Since the definition of \cmd{nametitledelim} is different for the delimiter
-contexts \opt{bib} and \opt{biblist}, you may have to use the optional argument
-to redefine the delimiter.\footnote{The author admits that it is somewhat
-pointless to make \cmd{innametitledelim} context sensitive.
+contexts \optval{bib} and \optval{biblist}, you may have to use the optional
+argument to redefine the delimiter.\footnote{The author admits that it is
+somewhat pointless to make \cmd{innametitledelim} context sensitive.
But the obvious parallels with \cmd{nametitledelim} were too tempting.
It is probably too late now.}
\begin{bibexample}
@@ -1649,7 +1726,8 @@ values that would otherwise not be redefined.
\csitem{maintitletitledelim}
The punctuation between the \bibfield{maintitle} and \bibfield{title} or
-\bibfield{booktitle} of a work if \opt{maintitleaftertitle} is \opt{false}.
+\bibfield{booktitle} of a work if \hyperopt{maintitleaftertitle} is
+\optval{false}.
The default is \cs{newunitpunct}.
\begin{bibexample}
\togglefalse{bbx:isbn}
@@ -1660,7 +1738,8 @@ The default is \cs{newunitpunct}.
\csitem{voltitledelim}
The punctuation between the \bibfield{volume} and \bibfield{title} or
-\bibfield{booktitle} of a work if \opt{maintitleaftertitle} is \opt{false}.
+\bibfield{booktitle} of a work if \hyperopt{maintitleaftertitle} is
+\optval{false}.
The default is a colon followed by a space.
\begin{bibexample}
\togglefalse{bbx:isbn}
@@ -1671,7 +1750,8 @@ The default is a colon followed by a space.
\csitem{titlemaintitledelim}
The punctuation between the \bibfield{title} or \bibfield{booktitle} and
-\bibfield{maintitle} of a work if \opt{maintitleaftertitle} is \opt{true}.
+\bibfield{maintitle} of a work if \hyperopt{maintitleaftertitle} is
+\optval{true}.
The default is \cmd{newunitpunct}.
\begin{bibexample}
\togglefalse{bbx:isbn}
@@ -1718,7 +1798,7 @@ The default is \cmd{newunitpunct}.
\csitem{servoldelim}
The delimiter between the \bibfield{series} and \bibfield{volume} fields
for \bibtype{article}.
-The default is \cmd{jourvoldelim}.
+The default is \hypercmd{jourvoldelim}.
\begin{bibexample}
\togglefalse{bbx:doi}
\renewcommand*{\servoldelim}{\highlight{\textvisiblespace}}% <- hard-coded!
@@ -1784,7 +1864,7 @@ The default is a comma followed by a space.
This delimiter is not used by the default style, since the standard order of
fields is \bibfield{location}, \bibfield{publisher}\slash
\bibfield{organization}\slash\bibfield{institution}, \bibfield{date}.
-You could use \cs{publocdelim} if you changed the order of these fields to
+You could use \cmd{publocdelim} if you changed the order of these fields to
\bibfield{publisher}\slash\bibfield{organization}\slash\bibfield{institution},
\bibfield{location} \bibfield{date} with
\begin{biblatexcode}
@@ -1834,8 +1914,8 @@ The default is a comma (\emph{not} followed by a space).
\csitem{extradateonlycompciterangedelim}\CSdelimMark
-Similar to \cmd{extradateonlycompcitedelim}, but indended for use in a
-compressed list of \bibfield{extradate}s in the \sty{-ecomp} styles.
+Similar to \hypercmd{extradateonlycompcitedelim}, but indended for use in a
+compressed list of \bibfield{extradate}s in the \blxstyle{-ecomp} styles.
The default is \cmd{bibrangedash}.
\begin{bibexample}
\DeclareDelimFormat{extradateonlycompciterangedelim}{%
@@ -1853,24 +1933,30 @@ two sets of delimiters: A pair of \emph{outer delimiters} wrapped around the
resulting citation in its entirety and a pair of \emph{inner delimiters} that
sets off certains bits of the citation label from other information.
An example for outer delimiters would be the round brackets of \cmd{parencite}
-for \sty{authoryear}-like styles or the square brackets of \cmd{cite} for
-\sty{numeric}- or \sty{alphabetic}-like styles.
+for \hyperblxstyle[ext-authoryear]{authoryear}-like styles or the
+square brackets of \cmd{cite} for \hyperblxstyle[ext-numeric]{numeric}- or
+\hyperblxstyle[ext-alphabetic]{alphabetic}-like styles.
Inner delimiters would be the round brackets in \cmd{textcite} around
-the year for \sty{authoryear} or around the title for \sty{authortitle}.
+the year for \hyperblxstyle[ext-authoryear]{authoryear} or around the title for
+\hyperblxstyle[ext-authortitle]{authortitle}.
See \cref{tab:citationdelims} for more details.
The delimiters are set up to work as paired delimiters, but you are free to
use non-matching pairs or to leave the opening or closing delimiter empty.
If you want to add punctuation, the context-sensitive delimiters
-\sty{nameyeardelim}, \sty{nametitledelim} and friends as well as
+\gencode{nameyeardelim}, \gencode{nametitledelim} and friends as well as
the context-insensitive \cmd{postnotedelim} and friends are more approriate.
+
+\begin{remindbox}
Although the outer delimiters can be set up using \cmd{DeclareCiteCommand}'s
optional \prm{wrapper} argument for most styles, this is not possible for all
-styles. Inner delimiters can be set up with \cmd{DeclareFieldFormat} in some
+styles.
+Similarly, inner delimiters can be set up with \cmd{DeclareFieldFormat} in some
styles, but other styles need more intricate implementations.
This means that the commands discussed here can be used to place the citations
between delimiters, but not natively to pass the result of a citation to a
wrapper command as an argument.
+\end{remindbox}
\begin{table}[btph]
\centering
@@ -1885,19 +1971,19 @@ appropriate place.}
\cmidrule(lr){2-4}
Style family & \cmd{cite} & \cmd{parencite} & \cmd{textcite}\\
\midrule
-\sty{alphabetic} & \highlightbf[1]{[}Knu84\highlightbf[1]{]} &
+\blxstyle{alphabetic} & \highlightbf[1]{[}Knu84\highlightbf[1]{]} &
\highlightbf[1]{[}Knu84\highlightbf[1]{]} & \highlightbf[1]{\hmpdl}Knuth
\highlightbf[2]{[}2\highlightbf[2]{]}\highlightbf[1]{\hmpdr}\\
-\sty{numeric} & \highlightbf[1]{[}2\highlightbf[1]{]} &
+\blxstyle{numeric} & \highlightbf[1]{[}2\highlightbf[1]{]} &
\highlightbf[1]{[}2\highlightbf[1]{]} & \highlightbf[1]{\hmpdl}Knuth
\highlightbf[2]{[}2\highlightbf[2]{]}\highlightbf[1]{\hmpdr}\\
-\sty{authortitle} & \highlightbf[1]{\hmpdl}Knuth,
+\blxstyle{authortitle} & \highlightbf[1]{\hmpdl}Knuth,
\highlightbf[2]{\hmpdl}\emph{\TeX book}\highlightbf[2]{\hmpdr}%
\highlightbf[1]{\hmpdr} & \highlightbf[1]{(}Knuth,
\highlightbf[2]{\hmpdl}\emph{\TeX book}\highlightbf[2]{\hmpdr}%
\highlightbf[1]{)} & \highlightbf[1]{\hmpdl}Knuth \highlightbf[2]{(}%
\emph{\TeX book}\highlightbf[2]{)}\highlightbf[1]{\hmpdr}\\
-\sty{authoryear} & \highlightbf[1]{\hmpdl}Knuth
+\blxstyle{authoryear} & \highlightbf[1]{\hmpdl}Knuth
\highlightbf[2]{\hmpdl}1984\highlightbf[2]{\hmpdr}%
\highlightbf[1]{\hmpdr} & \highlightbf[1]{(}Knuth
\highlightbf[2]{\hmpdl}1984\highlightbf[2]{\hmpdr}%
@@ -1908,7 +1994,7 @@ Style family & \cmd{cite} & \cmd{parencite} & \cmd{textcite}\\
\end{table}
\begin{ltxsyntax}
-\cmditem{DeclareOuterCiteDelim}{cite command}{opening delimiter}
+\cmditem{DeclareOuterCiteDelims}{cite command}{opening delimiter}
{closing delimiter}
Sets up the outer delimiters for the citation command
@@ -1917,7 +2003,7 @@ is given without leading backslash in the argument, it normally corresponds to
the delimiter context.
Note that outer citation delimiters are often hard-coded so they usually do not
-respond to delimiter context alises.
+respond to delimiter context aliases.
Inner citation delimiters, on the other hand, usually follow delimiter context
aliases.
This may lead to initially surprising results if aliases are used.
@@ -1937,13 +2023,13 @@ As mentioned above, this approach is not suitable to wrap the citation up in a
wrapper command, i.e.\ to pass the entire output of the citation command as
argument to a macro.
-Instead of hard-coded \texttt{(}, \texttt{)}, \texttt{[} and \texttt{]} their
-\sty{biblatex} counterparts \cmd{bibopenparen}, \cmd{bibcloseparen},
+Instead of hard-coded \gencode{(}, \gencode{)}, \gencode{[} and \gencode{]}
+their \sty{biblatex} counterparts \cmd{bibopenparen}, \cmd{bibcloseparen},
\cmd{bibopenbracket} and \cmd{bibclosebracket} are preferable, since these
commands respond to nesting and check if opening brackets are always closed.
-\cmditem{DeclareOuterCiteDelimAlias}{cite alias}{cite command}
-\cmditem*{DeclareOuterCiteDelimAlias*}{cite alias}{cite command}
+\cmditem{DeclareOuterCiteDelimsAlias}{cite alias}{cite command}
+\cmditem*{DeclareOuterCiteDelimsAlias*}{cite alias}{cite command}
Use the outer delimiters of \cmd{\prm{cite command}} for
\cmd{\prm{cite alias}} as well.
@@ -1958,13 +2044,13 @@ delimiters whenever the citation command is called.
Completely remove the definitions of the outer delimiters for
\cmd{\prm{cite command}}.
-\cmditem{DeclareInnerCiteDelim}{cite command}{opening delimiter}
+\cmditem{DeclareInnerCiteDelims}{cite command}{opening delimiter}
{closing delimiter}
Sets up the inner delimiters for the citation command
\cmd{\prm{cite command}}.
-This command is similar to \cmd{DeclareOuterCiteDelim} and the same
+This command is similar to \hypercmd{DeclareOuterCiteDelims} and the same
restrictions for the arguments apply.
Note that inner citation delimiters usually follow context delimiter aliases.
@@ -1972,8 +2058,8 @@ Outer citation delimiters, on the other hand, do not respond to context
delimiter aliases.
This may lead to initially surprising results if aliases are used.
-\cmditem{DeclareInnerCiteDelimAlias}{cite alias}{cite command}
-\cmditem*{DeclareInnerCiteDelimAlias*}{cite alias}{cite command}
+\cmditem{DeclareInnerCiteDelimsAlias}{cite alias}{cite command}
+\cmditem*{DeclareInnerCiteDelimsAlias*}{cite alias}{cite command}
Use the inner delimiters of \cmd{\prm{cite command}} for
\cmd{\prm{cite alias}} as well.
@@ -2004,11 +2090,11 @@ No error will be raised if the opening or closing delimiters are not defined,
but an error will be raised if \cmd{mk\prm{modifier}\prm{cite command}s} is
already defined.
-The styles of this bundle only use the values \opt{outer} and \opt{inner} for
-\prm{modifier}, but other values are possible. With \opt{outer} and \opt{inner}
-you can use \cmd{DeclareOuterCiteDelim} or \cmd{DeclareInnerCiteDelim} and
-friends to define the opening and closing delimiters, otherwise you need to
-define them manually.
+The styles of this bundle only use the values \optval{outer} and \optval{inner}
+for \prm{modifier}, but other values are possible. With \optval{outer} and
+\optval{inner} you can use \hypercmd{DeclareOuterCiteDelims} or
+\hypercmd{DeclareInnerCiteDelims} and friends to define the opening and closing
+delimiters, otherwise you need to define them manually.
All styles of \sty{biblatex-ext} define the wrapper commands listed in
\cref{tab:delimwrappers}.
@@ -2029,18 +2115,21 @@ Citation command & Outer & Inner\\
\cmd{parencite} & \cmd{mkouterparencitedelims} & \cmd{mkinnerparencitedelims}\\
\cmd{textcite} & \cmd{mkoutertextcitedelims} & \cmd{mkinnertextcitedelims}\\
\cmd{footcite} & \cmd{mkouterfootcitedelims} & \cmd{mkinnerfootcitedelims}\\
+\cmd{supercite}\footnote{If defined by the citation style.}
+ & \cmd{mkoutersupercitedelims} & ---\\
\cmd{bbx@xrefcite} & \cmd{mkouterbbx@xrefcitedelims} &
\cmd{mkinnerbbx@xrefcitedelims}\\
\enquote{\cmd{bbx@introcite}} & ---%
- \footnote{Use the field format \sty{bbx@introcite} instead,
- see \secref{sec:opt:style}.} & \cmd{mkinnerbbx@introcitedelims}\\
+ \footnote{Use the field format \bibfieldformat{bbx@introcite} instead,
+ see \cref{sec:opt:style}.} & \cmd{mkinnerbbx@introcitedelims}\\
\bottomrule
\end{tabular}
\end{minipage}
\end{table}
-The \sty{authoryear} and \sty{authortitle} styles have \cmd{parencite},
+The \hyperblxstyle[ext-authoryear]{authoryear} and
+\hyperblxstyle[ext-authortitle]{authortitle} styles have \cmd{parencite},
e.g.\ \parencite{knuth:ct:a}, \parencite{sigfridsson}, set up with
\begin{biblatexcode}
\DeclareOuterCiteDelims{parencite}{\bibopenparen}{\bibcloseparen}
@@ -2051,8 +2140,8 @@ and \cmd{textcite}, e.g.\ \textcite{knuth:ct:a}, \textcite{sigfridsson}, with
\DeclareOuterCiteDelims{textcite}{}{}
\DeclareInnerCiteDelims{textcite}{\bibopenparen}{\bibcloseparen}
\end{biblatexcode}
-If you wanted \cmd{parencite} of \sty{authoryear} to look like
-\enquote{[Sigfridsson and Worman (1998)]} you would use
+If you wanted \cmd{parencite} of \hyperblxstyle[ext-authoryear]{authoryear}
+to look like \enquote{[Sigfridsson and Worman (1998)]} you would use
\begin{biblatexcode}
\DeclareOuterCiteDelims{parencite}{|1\bibopenbracket1|}{|1\bibclosebracket1|}
\DeclareInnerCiteDelims{parencite}{|2\bibopenparen2|}{|2\bibcloseparen2|}
@@ -2069,7 +2158,7 @@ If you wanted \cmd{parencite} of \sty{authoryear} to look like
\end{ltxsyntax}
\subsection{Selected bibliography macros}\label{sec:opt:bibmacros}
-The following macros are defined in \texttt{ext-standard.bbx} and may make
+The following macros are defined in \filename{ext-standard.bbx} and may make
certain things easier to customise.
Many of these macros are replacements for bare \cmd{printfield} or
\cmd{printlist} in the bibliography drivers, or pack a frequently-used
@@ -2101,19 +2190,20 @@ A bibliography macro to print the \bibfield{edition} field, this avoids a direct
\lstinline|\printfield{edition}| in the bibliography drivers.
\keyitem[version]
-Similar to the \bibmacro{edition} bibliography macro, \bibmacro{version}
+Similar to the \hyperbibmacro{edition} bibliography macro, \bibmacro{version}
prints the \bibfield{version} field, this avoids a direct
\lstinline|\printfield{version}| in the bibliography drivers.
\keyitem[pagetotal]
-Similar to the \bibmacro{edition} bibliograohy macro, \bibmacro{pagetotal}
+Similar to the \hyperbibmacro{edition} bibliography macro, \bibmacro{pagetotal}
prints the \bibfield{pagetotal} field, this avoids a direct
\lstinline|\printfield{pagetotal}| in the bibliography drivers.
\keyitem[in:editor(+others)]
The bibliography macro to print the \bibfield{editor} before the
\bibfield{booktitle} for \bibtype{inbook}, \bibtype{incollection} and
-\bibtype{inproceedings} when \opt{innamebeforetitle} is set to \opt{true}.
+\bibtype{inproceedings} when \hyperopt{innamebeforetitle} is set to
+\optval{true}.
The \cmd{printname} uses the name format \bibfield{ineditor}.
\keyitem[language]
@@ -2159,6 +2249,7 @@ A bibliography macro to print the \bibfield{type} and \bibfield{number} fields.
\clearpage
\section{Tabular Bibliographies}\label{sec:tabularbib}
+\label{exltd@itm@biblatex-ext-tabular}
An experimental addition to this bundle is the package
\sty{biblatex-ext-tabular} which allows you to typeset tabular
(two-column) bibliographies.
@@ -2188,30 +2279,34 @@ on \tex{}~--~\latex{} Stack Exchange.
The code has been modernised to keep in sync with changes to internal macros
and modified to allow for slightly more flexible setups, so any bugs you find
are mine and not Audrey's. Please report them via the channels mentioned above
-in~\secref{sec:feedback}.
+in~\cref{sec:feedback}.
-\marginwarn Before tabular bibliographies can be used, a suitable definition
-must be supplied with \cmd{defbibtabular}.
+Before tabular bibliographies can be used, a suitable definition
+must be supplied with \hypercmd{defbibtabular}.
\begin{ltxsyntax}
\cmditem{printbibtabular}[key=value, \dots]
This commands prints a tabular bibliography.
It accepts the same options as \cmd{printbibliography}, but note that
-\opt{env} must be a tabular bibliography declared with \cmd{defbibtabular}.
-The default value for \opt{env} is \opt{bibtabular}.
-
-\marginwarn\emph{Note that there is no default definition for the
-\opt{bibtabular} environment, so you must define it with \cmd{defbibtabular}
-before use. An error will be issued if you fail to provide a definition
-for \opt{bibtabular} before you use \cmd{printbibtabular} with the default
-\opt{env} value, no bibliography will be printed.}
+\optval{env} must be a tabular bibliography declared with
+\hypercmd{defbibtabular}.
+The default value for \optval{env} is \optval{bibtabular}.
+
+\begin{warnbox}
+Note that there is no default definition for the
+\opt{bibtabular} environment, so you must define it with
+\hypercmd{defbibtabular} before use.
+An error will be issued if you fail to provide a definition
+for \optval{bibtabular} before you use \cmd{printbibtabular} with the default
+\optval{env} value and no bibliography will be printed.
+\end{warnbox}
\cmditem{defbibtabular}{name}{begin code}{end code}{row code}
This command defines a tabular bibliography.
-The \prm{name} is an identifier passed to the \opt{env} option of
-\cmd{printbibtabular} when selecting the environment.
+The \prm{name} is an identifier passed to the \optval{env} option of
+\hypercmd{printbibtabular} when selecting the environment.
The \prm{begin code} is \latex{} code to be executed at the beginning of the
environment, usually it will begin a tabular environment.
The \prm{end code} is executed at the end of the environment and would
@@ -2220,8 +2315,10 @@ The \prm{row code} holds the code for one row in the tabular bibliography,
it should have no more columns than ordered in \prm{begin code} and should
end with \lstinline|\\|.
+\begin{remindbox}
Please keep in mind that the tabular bibliography is subject to all limitations
of the particular tabular environment you decide to use.
+\end{remindbox}
Within the \prm{row code} argument the following macros are defined and can be
used to typeset the result of bibliography macros.
@@ -2242,14 +2339,14 @@ item if the language switching options are enabled.
Like \cmd{plain}, but additionally sets a link anchor for the current entry.
That link anchor is used when a citation links to the bibliography entry.
-There should only be one \cmd{anchor} or \cmd{anchorlang} per entry (and
+There should only be one \cmd{anchor} or \hypercmd{anchorlang} per entry (and
hence per row),
and for proper linking there should be at least one.
-Usually \cmd{anchor} or \cmd{anchorlang} is the first cell in a row.
+Usually \cmd{anchor} or \hypercmd{anchorlang} is the first cell in a row.
\cmditem{anchorlang}{code}
-Like \cmd{anchor}, but in the entry language like \cmd{plainlang}.
+Like \hypercmd{anchor}, but in the entry language like \hypercmd{plainlang}.
\cmditem{driver}{precode}
@@ -2262,10 +2359,10 @@ duplicate information can be cleaned up with help of the \prm{precode} argument.
Recall that standard \env{tabular} can't break across pages, so you may want
to give \env{longtable} a try.
-Additionally, the standard column specifiers \sty{l}, \sty{r} and \sty{c}
-define flexible-sized columns which might not be appropriate here;
-\sty{p} defines fixed-width columns but imposes justification, which does not
-look good if the columns are too narrow.
+Additionally, the standard column specifiers \gencode{l}, \gencode{r} and
+\gencode{c} define flexible-sized columns which might not be appropriate here;
+\gencode{p} defines fixed-width columns but imposes justification, which does
+not look good if the columns are too narrow.
You may want to look into fixed-width flush-left or flush-right columns%
\fnurl{https://tex.stackexchange.com/q/12703/35864}.
\end{ltxsyntax}
@@ -2322,15 +2419,15 @@ if a link to the entry is followed.
\end{bibexample}
For the common case of two-column tabular bibliographies there is a thin
-wrapper around \cmd{defbibtabular} that might turn out a bit easier to use.
+wrapper around \hypercmd{defbibtabular} that might turn out a bit easier to use.
\begin{ltxsyntax}
\cmditem{defbibtabulartwocolumn}{name}{begin code}{end code}%
{anchor code}{driver precode}
This defines a two-column tabular bibliography environment with \prm{name},
- \prm{begin code} and \prm{end code} as for \cmd{defbibtabular}.
+ \prm{begin code} and \prm{end code} as for \hypercmd{defbibtabular}.
- The first column is an \cmd{anchorlang} column that executes
+ The first column is an \hypercmd{anchorlang} column that executes
\prm{anchor code}, the second column executes a pre-code and
the bibliography driver.
@@ -2369,7 +2466,8 @@ Using \cmd{defbibtabulartwocolumn} the example from above could be written as
\end{ltxsyntax}
\clearpage
-\section{Open Access Symbols}\label{sec:oasymb}
+\section{Open Access Symbols}\label{sec:oa}
+\label{exltd@itm@biblatex-ext-oa}
The package \sty{biblatex-ext-oa} was inspired by a question%
\fnurl{https://tex.stackexchange.com/q/459449/35864}
by pluton\fnurl{https://tex.stackexchange.com/users/371/pluton} on TeX.SX
@@ -2383,102 +2481,149 @@ The package works as expected with the standard styles and
should work with most contributed styles at least to some extent.
For the actual typesetting of the symbol \sty{biblatex-ext-oa}
patches the bibliography macro \bibmacro{begentry} to include a call to the
-bibliography macro \bibmacro{oamark}.
-That means that you have to keep in mind this behaviour should you want to
-redefine \bibmacro{begentry} yourself.
+bibliography macro \hyperbibmacro{oamark}.
\begin{biblatexcode}
\usepackage[(*@\prm{\sty{biblatex} options}@*)]{biblatex}
(*@\dots @*)
\usepackage[(*@\prm{\sty{biblatex-ext-oa} options}@*)]{biblatex-ext-oa}
\end{biblatexcode}
-The package may load the support packages \sty{biblatex-ext-oa-doiapi} and
-\sty{biblatex-ext-oa-tikzsymbols}.
-The preferred way to load these packages is with \sty{biblatex-ext-oa}'s
+The package may load the support packages \hypersty{biblatex-ext-oa-doiapi},
+\hypersty{biblatex-ext-oasymb-pict2e}, \hypersty{biblatex-ext-oasymb-l3draw}
+ and \hypersty{biblatex-ext-oasymb-tikz}.
+The preferred way to load these packages is via \sty{biblatex-ext-oa}'s
package options.
-It should usually not be necessary to load these two packages directly with
-\cmd{usepackage}, but it is possible to use them as stand-alone packages
-should the need arise in other situations.
+It should usually not be necessary to load any of these support packages
+directly with \cmd{usepackage}, but it is possible to use them as stand-alone
+packages should the need arise in other situations.
+
+\begin{warnbox}
+Note that the macro \hypercmd{oasymbol} must be defined and should contain an
+open access symbol that can be printed in the margin for the package
+\sty{biblatex-ext-oa} to work properly.
+The package \sty{biblatex-ext-oa} itself does not provide a defintion for
+\hypercmd{oasymbol} if the option \hyperopt{symbolpackage} is not used.
+So you should either set that option or define command \hypercmd{oasymbol}
+yourself.
+\end{warnbox}
The package \sty{biblatex-ext-oa} provides the following load-time options.
\begin{optionlist}
\boolitem[true]{enable}
-This option controls whether the package is only loaded (\opt{false}) or
-loaded and active (\opt{true}).
+This option controls whether the package is only loaded (\optval{false}) or
+loaded and active (\optval{true}).
\enquote{Active} means that the initial state of the global bibliography option
-\opt{openaccess} is \opt{auto} and that useful default settings are applied for
-semi-automatic open access detection.
-These useful defaults include redefinitions of the bibmacro \bibmacro{begentry}
-and, if \opt{doiapi} is enabled, also \bibmacro{doi+eprint+url}.
-
-If the package is loaded with \opt{enable} set to \opt{false} the global
-bibliography option \opt{openaccess} will be set to \opt{false} and no sensible
-defaults are defined for the semi-automatic open access detection.
-
-\optitem[false]{tikzsymbol}{\opt{true}, \opt{false}, \prm{symbol identifier}}
-
-Load the support package \sty{biblatex-ext-oa-tikzsymbols} with its load-time
-option \opt{symbol} set to \prm{symbol identifier}.
-The values \opt{true} and \opt{false} are provided for convenience.
-\opt{false} does not load the package at all, \opt{true} is like giving the
-value \opt{plos}.
-
-See \cref{sec:oa-symbol} for a thorough discussion of the available symbols
-as well as a short note on their respective licenses.
-
-\marginwarn Note that \sty{biblatex-ext-oa-tikzsymbols} will load \pgftikz
-\fnurl{https://ctan.org/pkg/pgf} to draw the open access symbols.
-If you prefer a more light-weight solution, you can define a symbol yourself
-with an external graphics file.
-
-\marginwarn
-Note further that for the package \sty{biblatex-ext-oa} to work properly
-the macro \cmd{oasymbol} must be defined and should contain an open access
-symbol that can be printed in the margin.
-The package \sty{biblatex-ext-oa} itself does not provide a defintion for
-\cmd{oasymbol} if the option \opt{tikzsymbol} is not used.
+\hyperopt{openaccess} is \optval{auto} and that useful default settings are
+applied for semi-automatic open access detection.
+These useful defaults include patches of the bibmacro \bibmacro{begentry}
+and, if \hyperopt{doiapi} is enabled, also \bibmacro{doi+eprint+url}.
+
+If the package is loaded with \opt{enable} set to \optval{false} the global
+bibliography option \hyperopt{openaccess} will be set to \optval{false} and no
+sensible defaults are defined for the semi-automatic open access detection.
+
+\optitem[false]{symbolpackage}{\optval{false}, \optval{pict2e}, \optval{l3draw},
+ \optval{tikz}}
+
+Load one of the available open access symbol support packages.
+\begin{valuelist}
+ \item[false] Don't load any symbol package.
+ \begin{warnbox}
+ Since \sty{biblatex-ext-oa} does not provide a default definition for
+ \hypercmd{oasymbol}, you will have to make sure to define that command
+ yourself if you don't load any of the symbol packages.
+ \end{warnbox}
+ \item[pict2e] Load \hypersty{biblatex-ext-oasymb-pict2e} to provide a
+ definition for \hypercmd{oasymbol}.
+ See \cref{sec:oa:symbol,sec:oa:symbol-pict2e}.
+ \item[l3draw] Load \hypersty{biblatex-ext-oasymb-l3draw} to provide a
+ definition for \hypercmd{oasymbol}.
+ See \cref{sec:oa:symbol,sec:oa:symbol-l3draw}.
+ \begin{remindbox}
+ The package \hypersty{biblatex-ext-oasymb-l3draw} will load the entire
+ \LaTeX3 core.
+ Furthermore, \sty{l3draw} is still considered experimental.
+ \end{remindbox}
+ \item[tikz] Load \hypersty{biblatex-ext-oasymb-tikz} to provide a
+ definition for \hypercmd{oasymbol}.
+ See \cref{sec:oa:symbol,sec:oa:symbol-tikz}.
+ \begin{remindbox}
+ The package \hypersty{biblatex-ext-oasymb-tikz} will load \pgftikz.
+ \end{remindbox}
+\end{valuelist}
+
+\begingroup
+\makeatletter
+% Avoid a multiply defined label.
+% I know this is terrible, ...
+\def\ltd@pdfbookmark#1#2{%
+ \exltd@pdfbookmark{#1}{#2}}
+\makeatother
+\optitem{symbol}{\prm{symbol}}
+\endgroup
+
+Set \hypercmd{oasymbol} to output the symbol identified as \prm{symbol}.
+The available options can be found in \cref{sec:oa:symbol}.
+
+\begin{warnbox}
+Note that this option is only available if \hypercmd{symbolpackage} has been
+set to a valid value different from \optval{false} or one of the open access
+symbol packages has been loaded manually (the latter is usually not recommended,
+the option \hypercmd{symbolpackage} is the preferred way to load those
+packages).
+\end{warnbox}
\boolitem[false]{doiapi}
-Whether or not to the support package \sty{biblatex-ext-oa-doiapi},
-which provides a Lua module that can be used to query open access information
+Whether or not to load the support package \hypersty{biblatex-ext-oa-doiapi}
+that provides a Lua module to query open access information
from Unpaywall\fnurl{https://unpaywall.org/} via the DOI of an entry.
-\marginwarn The package \sty{biblatex-ext-oa-doiapi} and hence this option can
-only be used with \lualatex.
+\begin{warnbox}
+The package \hypersty{biblatex-ext-oa-doiapi} and thus this option
+can only be used with \lualatex.
+\end{warnbox}
\end{optionlist}
+\clearpage
The following macros in \sty{biblatex-ext-oa} are also of interest.
\begin{ltxsyntax}
-\cmditem{LoadTikZOASymbol}[symbol]
-This command provides an alternative way of loading the
-\sty{biblatex-ext-oa-tikzsymbols} package.
+
+\cmditem{LoadOASymbolPackage}[symbol]{package}
+
+This command provides an alternative to \hyperopt{symbolpackage} for loading
+a symbol package.
+The mandatory argument \prm{package} can take the same values as the
+\hyperopt{symbolpackage} option.
The optional argument \prm{symbol} has the same meaning as the possible values
-for the \opt{tikzsymbol} package option.
+for the \hyperopt{symbol} package option.
The command can only be used in the preamble.
-It may only be used once.
+It may only be used once and only if none of the symbol packages have been
+loaded either explicitly or via the \hyperopt{symbolpackage} option.
+
+This command is related to \hypercmd{DefineOASymbol} (see \cref{sec:oa:symbol}).
\cmditem{oasymbol}
This commands holds the little symbol that is going to be printed in the margin
to mark open access publications.
-\marginwarn The command is initially undefined and must be defined for the
+This command is initially undefined and must be defined for the
package to work.
-One way of giving this command a useful definition is via the \opt{tikzsymbol}
-option of \sty{biblatex-ext-oa}.
+One way of giving this command a useful definition is via the
+\hyperopt{symbolpackage} option of \sty{biblatex-ext-oa}.
\end{ltxsyntax}
An entry will be marked as open access if it has a \enquote{best open access
URL}.
This best open access URL will be determined according to the rules set out by
-the \opt{openaccess} bibliography option (see \cref{sec:oa:detect}) in the
+the \hyperopt{openaccess} bibliography option (see \cref{sec:oa:detect}) in the
\cmd{AtDataInput} hook,
-it is stored in the newly defined field \bibfield{bestoaurl}.
+it is stored in the newly defined field \hyperbibfield{bestoaurl}.
\begin{fieldlist}
\fielditem{bestoaurl}{literal}
This field holds the \enquote{best open access URL} as determined by the open
@@ -2493,46 +2638,49 @@ bibliography macros.
\keyitem[oamark]
Prints the open access symbol if a best open access URL is available.
-This bibliography macro is available if the package is loaded with \opt{enable}
-set to \opt{true}
+This bibliography macro is available if the package is loaded with
+\hyperopt{enable} set to \optval{true}
\keyitem[api:bestoaurl]
Display the best open access URL according to the Unpaywall API.
The URL is not shown if it coincides with the DOI, the check for that is
-performed by \cmd{OpenaccessURLisDOI} (see \cref{sec:oa:doiapi}).
-This macro is only available if both the \opt{enable} and the \opt{doiapi}
-options are set to \opt{true}.
+performed by \hypercmd{OpenaccessURLisDOI} (see \cref{sec:oa:doiapi}).
+This macro is only available if both the \hyperopt{enable} and the
+\hyperopt{doiapi} options are set to \optval{true}.
This macro is useful in connection with the Unpaywall API since the best
open access URL may not be amongst the fields that are already displayed
in the entry.
\end{keymarglistbook}
-\marginwarn
-With \opt{enable} set to \opt{true} the package will furtermore patch
+\begin{remindbox}
+With \opt{enable} set to \optval{true} the package will furthermore patch
the bibliography macro \bibmacro{begentry} to execute the bibliography macro
-\bibmacro{oamark}.
-If additionally \opt{doiapi} is \opt{true}, the bibliography macro
+\hyperbibmacro{oamark}.
+If additionally \hyperopt{doiapi} is \optval{true}, the bibliography macro
\bibmacro{doi+eprint+url} will be patched to include a call to
-\bibmacro{api:bestoaurl}.
+\hyperbibmacro{api:bestoaurl}.
Please keep that in mind should you need to redefine \bibmacro{begentry}
or \bibmacro{doi+eprint+url}.
+\end{remindbox}
\subsection{Open access detection}\label{sec:oa:detect}
The heart of the package \sty{biblatex-ext-oa} is the bibliography option
-\opt{openaccess}, which can be set globally, per type or per entry.
+\hyperopt{openaccess}, which can be set globally, per type or per entry.
A short example document can be found at
\url{https://github.com/moewew/biblatex-ext/blob/master/oaslinks.tex}.
\begin{optionlist}
-\optitem[auto/none]{openaccess}{\opt{auto}, \opt{doiapi}, \opt{forcedoiapi},
- \opt{true}, \opt{false}, \opt{none}, \prm{open access field}}
+\optitem[auto {\normalfont(\optval{none})}]{openaccess}{\optval{auto},
+ \optval{doiapi}, \optval{forcedoiapi}, \optval{true}, \optval{false},
+ \optval{none}, \prm{open access field}}
This option controls how the best open access URL is detected.
-The initial value is \opt{none} when the package is loaded with the \opt{enable}
-option set to \opt{false}, otherwise~-- and by default~-- it is \opt{auto}.
+The initial value is \optval{auto} unless the package is loaded with the
+\hyperopt{enable} option set to \optval{false} in which case the initial
+value changes to \optval{none}.
All following values are valid at all three levels (global, per-type and
per-entry), but it may not be useful to use a particular option at all levels.
@@ -2548,49 +2696,52 @@ per-entry), but it may not be useful to use a particular option at all levels.
\item[none] Assume that no known \enquote{open access field} contains an open
access URL.
- The value \opt{none} may be used to disable the \opt{openaccess} feature.
+ The value \optval{none} may be used to disable the \opt{openaccess} feature.
\item[doiapi] Use API queries from the \sty{biblatex-ext-oa-doiapi} package
to determine the best open access link from the DOI.
- \marginwarn This option requires that the \opt{doiapi} package option be set
- to \opt{true} and only works with \lualatex.
+ \begin{warnbox}
+ This option requires that the \hyperopt{doiapi} package option be
+ set to \optval{true} and only works with \lualatex.
Furthermore it needs a DOI in the \bibfield{doi} field.
- If the \bibfield{doi} field is empty, this option falls back to \opt{auto}.
+ If the \bibfield{doi} field is empty, this option falls back to \optval{auto}.
+ \end{warnbox}
-\item[onlydoiapi] Like \opt{doiapi}, but does not fall back to \opt{auto}
+\item[onlydoiapi] Like \optval{doiapi}, but does not fall back to \optval{auto}
in case no DOI is present.
-\item[forcedoiapi] Like \opt{doiapi}, but overrides more specific option levels
- that would say otherwise.
+\item[forcedoiapi] Like \optval{doiapi}, but overrides more specific option
+ levels that would say otherwise.
By default more specific options take precedence over more general options,
that means that a per-entry option trumps a per-type option, which in turn
overrides the global setting.
- If \opt{forcedoiapi} is set it will prevail over more specific options that
+ If \optval{forcedoiapi} is set it will prevail over more specific options that
would say otherwise. A common use case is to override per-entry options with
- a global \opt{forcedoiapi}.
+ a global \optval{forcedoiapi}.
-\item[forceonlydoiapi] A combination of \opt{onlydoiapi} and \opt{forcedoiapi}.
+\item[forceonlydoiapi] A combination of \optval{onlydoiapi} and
+ \optval{forcedoiapi}.
This options overrides all more specific values and does not fall back to
- \opt{auto} in case the DOI is not given.
+ \optval{auto} in case the DOI is not given.
-\item[true] An alias for \opt{all}.
-\item[false] An alias for \opt{none}.
+\item[true] An alias for \optval{all}.
+\item[false] An alias for \optval{none}.
\item[\prm{open access field}] Specifies that the open access version is given
by \prm{open access field}.
This value would normally be used only on a per-enry level.
- Any field for which \cmd{DeclareOpenAccessFieldUrl} has declared a URL
+ Any field for which \hypercmd{DeclareOpenAccessFieldUrl} has declared a URL
specification is a valid \enquote{open access field}.
\end{valuelist}
\end{optionlist}
The heuristics to find the best open access link are governed
-by the following commands and rely on information present in the \sty{.bib} file
-(ideally in field annotations).
+by the following commands and rely on information present in the \filename{.bib}
+file (ideally in field annotations).
\begin{ltxsyntax}
\cmditem{DeclareOpenAccessFieldUrl}[openness]{field}{url spec}
@@ -2603,7 +2754,7 @@ open access (\texttt{always}) or whether it is only open access under certain
conditions (\texttt{conditional});
if it is not present \texttt{conditional} is assumed.
-If the package is loaded with \opt{enable} set to \opt{true},
+If the package is loaded with \opt{enable} set to \optval{true},
the following declarations are active.
\begin{biblatexcode}
\DeclareOpenAccessFieldUrl{url}{\thefield{url}}
@@ -2632,7 +2783,7 @@ giving the field annotation \texttt{closedaccess}.
If a field has openness \texttt{conditional} it is only considered for a
particular entry if the field annotation \texttt{openaccess} is set.
-If the package is loaded with \opt{enable} set to \opt{true},
+If the package is loaded with \opt{enable} set to \optval{true},
the following declarations are active.
\begin{biblatexcode}
\DeclareOpenAccessEprintUrl{jstor}{%
@@ -2652,7 +2803,7 @@ articles on the arXiv are always open access.
Handle the open access URL detection for \prm{alias} exactly as that for
\prm{eprinttype}.
-If the package is loaded with \opt{enable} set to \opt{true},
+If the package is loaded with \opt{enable} set to \optval{true},
the following declarations are active.
\begin{biblatexcode}
\DeclareOpenAccessEprintAlias{JSTOR}{jstor}
@@ -2681,11 +2832,12 @@ which means that the DOI is given preference over eprints, which in turn
prevail over the \bibfield{url} field.
\end{ltxsyntax}
-The \opt{auto} detection works as follows.
+The \optval{auto} detection works as follows.
\begin{itemize}
\item The best known open access URL is cleared.
-\item For each non-empty field listed in \cmd{DeclareOpenAccessUrlFieldPriority}
- the URL specification is obtained.
+\item For each non-empty field listed in
+ \hypercmd{DeclareOpenAccessUrlFieldPriority} the URL specification is
+ obtained.
\begin{itemize}
\item If the field has \prm{openness} \texttt{always}, the best known open
access URL is updated with the new value, unless the field has been
@@ -2697,7 +2849,7 @@ The \opt{auto} detection works as follows.
\end{itemize}
\end{itemize}
-For \opt{auto}-detection, an open access article with DOI would ideally
+For \optval{auto}-detection, an open access article with DOI would ideally
look like this.
% cipriani
\inputexamplebibfile[listing options={linerange={27-38},
@@ -2736,21 +2888,24 @@ In particular the \prm{openness} of each field does not play a role.
\subsection{Open access detection with the Unpaywall API}\label{sec:oa:doiapi}
+\label{exltd@itm@biblatex-ext-oa-doiapi}
Inspired by Eric Marsden's%
\fnurl{https://tex.stackexchange.com/users/29621/eric-marsden}
answer to the open access symbol question on TeX.SX, the package
-\sty{biblatex-oa-doiapi}, which can be loaded via the \opt{doiapi} option
-of \sty{biblatex-oa}, provides means to automatically find the best open
-access link to a given article via its DOI by querying the Unpaywall API%
-\fnurl{https://unpaywall.org/}.
+\sty{biblatex-ext-oa-doiapi}, which can be loaded via the \hyperopt{doiapi}
+option of \sty{biblatex-ext-oa}, provides means to automatically find the
+best open access link to a given article via its DOI by querying the
+Unpaywall API\fnurl{https://unpaywall.org/}.
-\marginwarn This package can only be used with \lualatex{} and needs online
+\begin{warnbox}
+This package can only be used with \lualatex{} and needs online
access.
Furthermore the Unpaywall API requires an email address and asks to limit
calls to 100000 per day\fnurl{https://unpaywall.org/products/api}.
+\end{warnbox}
To avoid too many calls to the API, the package caches its information in the
-temporary \sty{.oai} file.
+temporary \filename{.oai} file.
It is safe to delete that file at any point, but if you do so the next
\lualatex{} run may take a while, because all information has to be retrieved
from the APIs.
@@ -2763,13 +2918,14 @@ expiration period.
Define the email address that is going to be used for API queries that require
an email.
-\marginwarn
+\begin{warnbox}
There is no predefined default email address.
If the package is loaded and no email was provided until the
beginning of the document (as tested in an \cmd{AtBeginDocument} hook)
you will recieve a warning.
A fatal error will be thrown if you try to query the Unpaywall database
without an email address.
+\end{warnbox}
\cmditem{SetDOIAPICacheExpiration}{days}
@@ -2790,29 +2946,41 @@ the \cmd{url} macro.
\cmditem{OpenaccessURLisDOI}{DOI}{true}{false}
-Expands to \prm{true} if the best open access URL as resturned by the Unpaywall
+Expands to \prm{true} if the best open access URL as returned by the Unpaywall
API is the DOI and to \prm{false} otherwise.
\end{ltxsyntax}
+\subsection{Open access symbols}\label{sec:oa:symbol}
+Currently, this bundle offers three options to provide the open access
+symbols.
+The package \hypersty{biblatex-ext-oasymb-pict2e} draws the symbols using
+\sty{pict2e}'s \env{picture} environment.
+The package \hypersty{biblatex-ext-oasymb-tikz}
+uses \pgftikz's \env{tikzpicture}.
+The package \hypersty{biblatex-ext-oasymb-l3draw} finally
+uses \LaTeX3's \sty{l3draw} package.
+The main purpose of these packages is to define the macro \cmd{oasymbol} for
+use with \sty{biblatex-ext-oa}.
-\subsection{Open access symbols with Ti\emph{k}Z}\label{sec:oa-symbol}
-The main purpose of the package \sty{biblatex-ext-oa-tikzsymbols}
-is to define the command \cmd{oasymbol}.
-As mentioned above, usually this package is not going to be loaded as a
-stand-alone package, instead it is loaded via \sty{biblatex-ext-oa}.
+The packages should usually not have to be loaded explicitly, instead
+they are loaded via the \hyperopt{symbolpackage} option of
+\hypersty{biblatex-ext-oa}.
+
+All packages define a similar set of macros, so they can not be loaded
+together.
+If used as stand-alone packages, all packages only have one option.
-If used as a stand-alone package, \sty{biblatex-ext-oa-tikzsymbols} has one
-load-time option.
\begin{optionlist}
-\optitem{symbol}{\opt{plos}, \opt{oanet}}
+\optitem[plos]{symbol}{\optval{plos}, \optval{oanet}}
This options determines which of the two provided symbols is going to be used
-for \cmd{oasymbol}.
+for \hypercmd{oasymbol}.
+The possible values are
\begin{valuelist}
\item[plos] Use the open access symbol by PLOS | Public Library of Science%
- \fnurl{https://www.plos.org/} \csuse{extblx@oasymbol@plos}.
+ \fnurl{https://www.plos.org/} \csuse{extblx@oasymb@pict@plos}.
The drawing is based on a CC0%
\fnurl{https://creativecommons.org/publicdomain/zero/1.0/deed.en}
@@ -2822,7 +2990,7 @@ for \cmd{oasymbol}.
\item[oanet] Use the open access symbol by open-access.net%
\fnurl{https://open-access.net/}
- \csuse{extblx@oasymbol@oanet}.
+ \csuse{extblx@oasymb@pict@oanet}.
The drawing is based on the logo uploaded to Wikimedia%
\fnurl{https://commons.wikimedia.org/wiki/File:Open_access.svg}
@@ -2864,74 +3032,178 @@ for \cmd{oasymbol}.
\end{valuelist}
\end{optionlist}
-Apart from \cmd{oasymbol} the package only defines one other user-level command.
+Apart from \hypercmd{oasymbol} the packages only define one other user-level
+command.
\begin{ltxsyntax}
-\cmditem{DefineTikZOASymbol}[symbol]
+\cmditem{DefineOASymbol}[symbol]
-This command redefines \cmd{oasymbol} to point to either the PLOS version or
-the open-access.net version of the logo.
+This command redefines \hypercmd{oasymbol} to point to a different version
+of the symbol.
+The possible values for the \prm{symbol} argument are the values of the
+\hyperopt{symbol} option.
\end{ltxsyntax}
+\subsubsection[\sty{pict2e}]{Open access symbols with \sty{pict2e}}
+\label{sec:oa:symbol-pict2e}
+\label{exltd@itm@biblatex-ext-oasymb-pict2e}
+The main purpose of the package \sty{biblatex-ext-oasymb-pict2e}
+is to define the command \hypercmd{oasymbol}.
+As mentioned above, usually this package is not going to be loaded as a
+stand-alone package, instead it is loaded via
+\hypersty[symbolpackage]{biblatex-ext-oa}.
+
+The package requires and loads the packages
+\sty{pict2e}\fnurl{https://ctan.org/pkg/pict2e} by Hubert Gäßlein,
+Rolf Nie\-praschk and Josef Tkadlec
+as well as
+\sty{xcolor}\fnurl{https://ctan.org/pkg/xcolor} by Uwe Kern.
+
+If used as a stand-alone package, \sty{biblatex-ext-oasymb-pict2e} has one
+load-time option, namely \hyperopt{symbol}, and defines one command besides
+\hypercmd{oasymbol}, namely \hypercmd{DefineOASymbol}.
+The option determines whether \cmd{oasymbol} is defined to display
+the PLOS symbol~(\csuse{extblx@oasymb@pict@plos})
+or the open-access.net symbol~(\csuse{extblx@oasymb@pict@oanet}).
+The command \hypercmd{DefineOASymbol} can be used to change the definition
+of \cmd{oasymbol} on the fly.
+
+
+\subsubsection[Ti\emph{k}Z]{Open access symbols with Ti\emph{k}Z}
+\label{sec:oa:symbol-tikz}
+\label{exltd@itm@biblatex-ext-oasymb-tikz}
+The main purpose of the package \sty{biblatex-ext-oasymb-tikz}
+is to define the command \hypercmd{oasymbol}.
+As mentioned above, usually this package is not going to be loaded as a
+stand-alone package, instead it is loaded via
+\hypersty[symbolpackage]{biblatex-ext-oa}.
+
+This package requires and loads the package
+\sty{tikz}\fnurl{https://ctan.org/pkg/pgf} by Till Tantau as well as all
+its dependencies.
+
+If used as a stand-alone package, \sty{biblatex-ext-oasymb-tikz} has one
+load-time option, namely \hyperopt{symbol}, and defines one command besides
+\hypercmd{oasymbol}, namely \hypercmd{DefineOASymbol}.
+The option determines whether \cmd{oasymbol} is defined to display
+the PLOS symbol~(\csuse{extblx@oasymb@tikz@plos})
+or the open-access.net symbol~(\csuse{extblx@oasymb@tikz@oanet}).
+The command \hypercmd{DefineOASymbol} can be used to change the definition
+of \cmd{oasymbol} on the fly.
+
+This package used to be called \sty{biblatex-ext-oa-tikzsymbols},
+for consistency reasons it has been renamed to \sty{biblatex-ext-oasymb-tikz}.
+
+The command \cmd{DefineTikZOASymbol} has been renamed to the more generic
+\hypercmd{DefineOASymbol}.
+Backwards compatibility code for that change is in place.
+
+
+\subsubsection[\sty{l3draw}]{Open access symbols with \sty{l3draw}}
+\label{sec:oa:symbol-l3draw}
+\label{exltd@itm@biblatex-ext-oasymb-l3draw}
+The main purpose of the package \sty{biblatex-ext-oasymb-l3draw}
+is to define the command \hypercmd{oasymbol}.
+As mentioned above, usually this package is not going to be loaded as a
+stand-alone package, instead it is loaded via
+\hypersty[symbolpackage]{biblatex-ext-oa}.
+
+This package requires and loads the full force of \LaTeX3.
+Aside from the main package \sty{expl3}\fnurl{https://ctan.org/pkg/expl3} it
+loads \sty{xparse}\fnurl{https://ctan.org/pkg/xparse},
+and \sty{l3keys2e}\fnurl{https://ctan.org/pkg/l3keys2e}.
+Drawing is performed with the (still experimental)
+\sty{l3draw}\fnurl{https://ctan.org/pkg/l3experimental} and
+\sty{l3color}\fnurl{https://ctan.org/pkg/l3experimental} packages.
+
+If used as a stand-alone package, \sty{biblatex-ext-oasymb-l3draw} has one
+load-time option, namely \hyperopt{symbol}, and defines one command besides
+\hypercmd{oasymbol}, namely \hypercmd{DefineOASymbol}.
+The option determines whether \cmd{oasymbol} is defined to display
+the PLOS symbol~(\csuse{extblx@oasymb@draw@plos})
+or the open-access.net symbol~(\csuse{extblx@oasymb@draw@oanet}).
+The command \hypercmd{DefineOASymbol} can be used to change the definition
+of \cmd{oasymbol} on the fly.
+
+
+
+
\clearpage
\section{Revision History}\label{sec:log}
The GitHub repository of this project uses release tags, so you can compare
the changes in source code there.\footnote{\url{\gitbaseurl/compare/}}
-See also \sty{CHANGES.md}.
+See also \filename{CHANGES.md}.
The numbers on the right indicate the relevant section of the manual.
\begin{changelog}
+\begin{release}{0.7}{2019-02-08}
+ \item Added outer citation delimiters for \cmd{supercite}%
+ \see{sec:opt:citedelims}
+ \item Added \hypersty{biblatex-ext-oasymb-pict2e}\see{sec:oa:symbol-pict2e}
+ \item Added \hypersty{biblatex-ext-oasymb-l3draw}\see{sec:oa:symbol-l3draw}
+ \item Renamed \sty{biblatex-ext-oa-tikzsymbols} to
+ \hypersty{biblatex-ext-oasymb-tikz}\see{sec:oa:symbol-tikz}
+ \item Deprecated option \opt{tikzsymbol} of \hypersty{biblatex-ext-oa} in
+ favour of \hyperopt{symbolpackage} and \hyperopt{symbol}\see{sec:oa}
+ \item Renamed and generalised \cmd{DefineTikZOASymbol} to
+ \hypercmd{DefineOASymbol}\see{sec:oa:symbol}
+ \item Renamed and generalised \cmd{LoadTikZOASymbol} to
+ \hypercmd{LoadOASymbolPackage}\see{sec:oa}
+\end{release}
\begin{release}{0.6b}{2019-01-11}
\item Fixed issue loading \texttt{socket.url} module in
- \sty{biblatex-ext-oa-doiapi}\see{sec:oasymb}
+ \hypersty{biblatex-ext-oa-doiapi}\see{sec:oa:doiapi}
\end{release}
\begin{release}{0.6a}{2019-01-04}
- \item Minor improvements for \sty{biblatex-ext-oa}\see{sec:oasymb}
+ \item Minor improvements for \hypersty{biblatex-ext-oa}\see{sec:oa}
\end{release}
\begin{release}{0.6}{2018-11-23}
\item Require \sty{biblatex} 3.12
- \item Made \opt{dashed} and \opt{introcite} options available on a per-entry
- and per-type basis\see{sec:opt:style}
- \item Added \cs{titleaddonpunct}\see{sec:opt:punct}
- \item Added \sty{biblatex-ext-oa} package for open access symbols%
- \see{sec:oasymb}
+ \item Made \hyperopt{dashed} and \hyperopt{introcite} options available on a
+ per-entry and per-type basis\see{sec:opt:style}
+ \item Added \hypercmd{titleaddonpunct}\see{sec:opt:punct}
+ \item Added \hypersty{biblatex-ext-oa} package for open access detection and
+ symbols\see{sec:oa}
\end{release}
\begin{release}{0.5a}{2018-10-09}
\item Fixed a bug with \cmd{footcites} and \cmd{footcitetexts} in
- \sty{ext-authoryear}
+ \blxstyle{ext-authoryear}
\end{release}
\begin{release}{0.5}{2018-10-02}
- \item New \sty{ext-authoryear-*ecomp} style subfamily\see{sec:styles:new}
+ \item New \hyperblxstyle[ext-authoryear-ecomp]{ext-authoryear-*ecomp} style
+ subfamily\see{sec:styles:new}
\item Added outer cite delimiters for \cmd{footcite}\see{sec:opt:citedelims}
\item Added experimental tabular bibliography\see{sec:tabularbib}
\end{release}
\begin{release}{0.4}{2018-06-10}
-\item Renamed \cmd{DeclareOuterCiteDelim} and friends to
- \cmd{DeclareOuterCiteDelims}\see{sec:opt:citedelims}
-\item Added \cmd{RegisterCiteDelims}\see{sec:opt:citedelims}
-\item Renamed \enquote{virtual} cite command \cmd{bbx:introcite} to
- \cmd{bbx@introcite}\see{sec:opt:style}
+ \item Renamed \cmd{DeclareOuterCiteDelim} and friends to
+ \hypercmd{DeclareOuterCiteDelims}\see{sec:opt:citedelims}
+ \item Added \hypercmd{RegisterCiteDelims}\see{sec:opt:citedelims}
+ \item Renamed \enquote{virtual} cite command \cmd{bbx:introcite} to
+ \cmd{bbx@introcite}\see{sec:opt:style}
+ \item Renamed \opt{citeinxref} to \hyperopt{citexref}\see{sec:opt}
\end{release}
\begin{release}{0.3}{2018-06-04}
-\item Added \bibfieldformat{titlecase:\dots title} field formats%
- \see{sec:opt:field}
-\item Added \sty{bbx:introcite:plain:keeprelated} toggle%
- \see{sec:opt:style}
-\item Added \cs{jourvoldelim}, \cs{jourserdelim} and \cs{servoldelim}%
- \see{sec:opt:punct}
-\item Improve documentation
+ \item Added \hyperbibfieldformat[titlecase:title]{titlecase:\dots title}
+ field formats\see{sec:opt:field}
+ \item Added \hypersty{bbx:introcite:plain:keeprelated} toggle%
+ \see{sec:opt:style}
+ \item Added \hypercmd{jourvoldelim}, \hypercmd{jourserdelim} and
+ \hypercmd{servoldelim}\see{sec:opt:punct}
+ \item Improve documentation
\end{release}
\begin{release}{0.2}{2018-03-28}
-\item Rework lengths for \kvopt{introcite}{label}\see{sec:opt:style}
-\item Fixed meaning of \cs{maintitletitledelim}\see{sec:opt:punct}
-\item Added \cs{voltitledelim}\see{sec:opt:punct}
+ \item Rework lengths for \hyperkvopt{introcite}{label}\see{sec:opt:style}
+ \item Fixed meaning of \hypercmd{maintitletitledelim}\see{sec:opt:punct}
+ \item Added \hypercmd{voltitledelim}\see{sec:opt:punct}
\end{release}
\begin{release}{0.1a}{2018-03-20}
-\item Fixed inner citation delimiters for \sty{ext-authoryear},
- \sty{ext-authortitle} and their \sty{-ibid} versions\see{sec:opt:citedelims}
-\item Fixed \cmd{smartcite} delimiters\see{sec:opt:citedelims}
+ \item Fixed inner citation delimiters for \hyperblxstyle{ext-authoryear},
+ \hyperblxstyle{ext-authortitle} and their \blxstyle{-ibid} versions%
+ \see{sec:opt:citedelims}
+ \item Fixed \cmd{smartcite} delimiters\see{sec:opt:citedelims}
\end{release}
\begin{release}{0.1}{2018-03-18}
-\item First public release
+ \item First public release
\end{release}
\end{changelog}
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-19 09:36:46 +0000