Skip to content

Commit

Permalink
DOI: oadoi.org; ArXiv identifiers; URL display
Browse files Browse the repository at this point in the history 
This commit changes the DOI links in the references to open
access DOI oadoi.org for the link and displays the DOI identifier
in the text. Related changes: \sloppy option for references is
inserted, to avoid having text extending into the margin;
(most) URL texts are made copy/pastable by redefining \nolinkurl
to print text without alteration.

The text appearance of the eprint identifers was wrong because
it inserted a space into the identifier; see
https://arxiv.org/help/arxiv_identifier . This is fixed in
this commit.

The display of URLs is enabled in this commit. Linking to the URL
archives is good, but the original URLs should be shown too -
archives can themselves be sometimes unavailable, not only URLs.

TODO: A better version of the URL fix still needs to be considered.
(Examples where the text URL is unusable in Roukema 2020
ReScience C, 6, 1, ReScience#11 = https://zenodo.org/record/3956058 are
ref [12] with
`https : / / techcrunch . com / 2019 / 07 / 29 / github - ban -`
and ref [24] with `https : / / gcc . gnu . org /`.)

* modified:   rescience.cls

This commit was cherry-picked from the original d4cc1fc.
  • Loading branch information
@broukema
broukema committed Jul 28, 2020
1 parent 70c4a0d commit ee98e5d
Showing 1 changed file with 74 additions and 21 deletions.
95 changes: 74 additions & 21 deletions rescience.cls
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@
%% Released under a Creative Commons Attribution 4.0 International license.
%% ----------------------------------------------------------------------------
%% Dependencies:
%% * metadata.tex
%% * metadata.tex
%% * header.tex
%% * content.tex
%% ----------------------------------------------------------------------------
%% 2020-07-18 B. Roukema - Change DOI links in references to open access DOI oadoi.org;
%% - Insert \sloppy option for references;
%% - Make URL texts copy/pastable by redefining \nolinkurl;
%% - Remove space from eprint identifers.
%% ----------------------------------------------------------------------------

\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{rescience}[2019/04/12 Style for ReScience articles]
Expand Down Expand Up @@ -78,21 +83,21 @@
Path = ./roboto/RobotoCondensed-, Extension = .ttf,
UprightFont = Regular,
BoldFont = Bold
]
]

\newfontfamily\Roboto{Roboto}[
Path = ./roboto/Roboto-, Extension = .ttf,
UprightFont = Regular,
BoldFont = Black
]
]

\newfontfamily\SpaceRoboto{Roboto}[
Path = ./roboto/Roboto-, Extension = .ttf,
UprightFont = Regular,
BoldFont = Medium,
UprightFeatures={LetterSpace=35},
BoldFeatures={LetterSpace=35}
]
]


\RequirePackage{microtype}
Expand All @@ -115,12 +120,12 @@
%% {\Large\sffamily\bfseries}{\thesection}{0.25em}{}
%% \titleformat{\subsection}
%% {\large\sffamily\bfseries}{\thesection}{0.25em}{}

\titleformat{\section}{\Large\sffamily\bfseries}
{\llap{{\textcolor{lightgray}{\normalfont\sffamily\thesection}}\hskip 0.5em}}{0em}{}
\titleformat{\subsection}{\large\sffamily\bfseries}
{\llap{{\textcolor{lightgray}{\normalfont\sffamily\thesubsection}}\hskip 0.5em}}{0em}{}

\titleformat{\subsubsection}[runin]
{\normalfont\sffamily\bfseries}{}{0em}{}[\mbox{ --- }]
\titlespacing{\subsubsection}
Expand Down Expand Up @@ -230,33 +235,33 @@
% --- Various convenient macros -----------------------------------------------
\RequirePackage[many]{tcolorbox}
\newtcbox{\iconbox}[1][]{%
enhanced,nobeforeafter,tcbox raise base,
enhanced,nobeforeafter,tcbox raise base,
boxrule=0.4pt, top=0pt, bottom=-1pt,
right=.1pt, left=.1pt, arc=1pt, boxsep=1pt,
fontupper={\tiny \sffamily}, before upper={\vphantom{dlg}},
colframe=white, colback=black!10!white, coltext=black}
\newcommand{\orcid}[1]{\href{https://orcid.org/#1}{\iconbox{ID}}}
\newcommand{\doi}[1]{\href{http://doi.org/#1}{#1}}
\newcommand{\doi}[1]{\href{http://oadoi.org/#1}{#1}}
\newcommand{\github}[1]{\href{https://github.com/#1}{github.com/#1}}

% See https://tex.stackexchange.com/questions/99316/symbol-for-external-links
\newcommand{\ExternalLink}{%
\tikz[x=1.2ex, y=1.2ex, baseline=-0.05ex]{%
\tikz[x=1.2ex, y=1.2ex, baseline=-0.05ex]{%
\begin{scope}[x=1ex, y=1ex]
\clip (-0.1,-0.1)
--++ (-0, 1.2)
--++ (0.6, 0)
--++ (0, -0.6)
--++ (0.6, 0)
\clip (-0.1,-0.1)
--++ (-0, 1.2)
--++ (0.6, 0)
--++ (0, -0.6)
--++ (0.6, 0)
--++ (0, -1);
\path[draw,
line width = 0.5,
rounded corners=0.5]
\path[draw,
line width = 0.5,
rounded corners=0.5]
(0,0) rectangle (1,1);
\end{scope}
\path[draw, line width = 0.5] (0.5, 0.5)
\path[draw, line width = 0.5] (0.5, 0.5)
-- (1, 1);
\path[draw, line width = 0.5] (0.6, 1)
\path[draw, line width = 0.5] (0.6, 1)
-- (1, 1) -- (1, 0.6);
}
}
Expand Down Expand Up @@ -301,8 +306,8 @@
mincitenames=1,
maxbibnames=10,
isbn = false,
url = false,
doi = false,
url = true,
doi = true,
autocite = superscript,
natbib = true]{biblatex}
\RequirePackage{bibentry}
Expand All @@ -311,6 +316,54 @@
\addbibresource{\articleBIBLIOGRAPHY}
\renewcommand{\citet}[1]{\citeauthor{#1}\supercite{#1}}

%Example for clickable title:
%\newbibmacro{string+doi}[1]{%
% \iffieldundef{doi}{#1}{\href{https://oadoi.org/\thefield{doi}}{#1}}}
%\DeclareFieldFormat{title}{\usebibmacro{string+doi}{\mkbibemph{#1}}}
%\DeclareFieldFormat[article]{title}{\usebibmacro{string+doi}{\mkbibquote{#1}}}

%% The https://oadoi.org domain chooses open-access versions of an
%% article, preferring publisher versions (gold open access) if
%% possible, otherwise preprints (green open access), and only falls
%% back to the paywalled version if nothing open-access (gold or
%% green) is available. We print the DOI as text to make sure that
%% it's accessible in printed version and to robots that only analyse
%% the printed text.
\DeclareFieldFormat{doi}{%
\mkbibacro{DOI}\addcolon\space
\ifhyperref
{\href{https://oadoi.org/#1}{\nolinkurl{#1}}}
{\nolinkurl{#1}}}

%% Add \sloppy because DOIs are quite often long.
\appto{\bibsetup}{\sloppy}

%% We want URLs to be copy/pastable; the default version of \nolinkurl
%% seems to not just make the URLs unlinked, but also inserts spaces
%% inside the URL, making any copy/pasted version unusable without
%% human intervention.
\renewcommand\nolinkurl[1]{#1}


%% Redefine ArXiv eprint format without a space. This is required
%% for ArXiv identifiers so that robots analysing the rendered pdf
%% text will correctly link to the identifiers. See
%% https://arxiv.org/help/arxiv_identifier . This is from biblatex.def,
%% but with \space removed.
\DeclareFieldFormat{eprint:arxiv}{%
arXiv\addcolon
\ifhyperref
{\href{http://arxiv.org/abs/#1}{%
\nolinkurl{#1}%
\iffieldundef{eprintclass}
{}
{\addspace\texttt{\mkbibbrackets{\thefield{eprintclass}}}}}}
{\nolinkurl{#1}
\iffieldundef{eprintclass}
{}
{\addspace\texttt{\mkbibbrackets{\thefield{eprintclass}}}}}}
\DeclareFieldAlias{eprint:arXiv}{eprint:arxiv}


% --- Copyright statement -----------------------------------------------------
\RequirePackage{float}
Expand Down

0 comments on commit ee98e5d

Please sign in to comment.