summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/orcidlink
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-11-21 03:01:06 +0000
committerNorbert Preining <norbert@preining.info>2020-11-21 03:01:06 +0000
commita66b0031e302fc53a3e94a2c80485bbbd923a299 (patch)
tree8eb50e9638a8589ad16f7dec1bd997a5d277a159 /macros/latex/contrib/orcidlink
parent9fd41d05ec3aeb960a242af4f054e5c2d21de4e1 (diff)
CTAN sync 202011210301
Diffstat (limited to 'macros/latex/contrib/orcidlink')
-rw-r--r--macros/latex/contrib/orcidlink/README.md51
-rw-r--r--macros/latex/contrib/orcidlink/orcidlink.dtx162
-rw-r--r--macros/latex/contrib/orcidlink/orcidlink.ins57
-rw-r--r--macros/latex/contrib/orcidlink/orcidlink.pdfbin0 -> 136645 bytes
4 files changed, 270 insertions, 0 deletions
diff --git a/macros/latex/contrib/orcidlink/README.md b/macros/latex/contrib/orcidlink/README.md
new file mode 100644
index 0000000000..a5523276a7
--- /dev/null
+++ b/macros/latex/contrib/orcidlink/README.md
@@ -0,0 +1,51 @@
+# orcidlink-LaTeX-command
+LaTeX style file to add a macro for inserting a linked ORCiD logo
+
+This LaTeX style file just defines a single macro, `\orcidlink`. The code is from [this TeX.SE answer](https://tex.stackexchange.com/a/445583/34063). My only contribution was wrapping it into a style file.
+
+Installation
+------------
+
+If `orcidlink` is already provided in your TeX distribution, skip this
+section. You should be able to install `orcidlink` from the CTAN via
+your distribution's utility (e.g. the TeX Live Utility).
+Alternatively, you can get the package from the [source repository on
+GitHub](https://github.com/duetosymmetry/orcidlink-LaTeX-command). If
+you do not want to do a "full" installation, just copy
+[orcidlink.sty](orcidlink.sty) into the same directory as your LaTeX
+source.
+
+Usage
+-----
+
+In your preamble, add:
+```latex
+\usepackage{orcidlink}
+```
+When you want to insert the hyperlinked ORCiD logo, use `\orcidlink{0000-0000-0000-0000}`, replacing the digits with your ORCiD (just the digits, not your whole URL). This is most common in the author list. For example, in a revtex article, you would write e.g.
+```latex
+\author{Emmy Noether\,\orcidlink{0000-0000-0000-0000}}
+...
+```
+This will appear as a clickable hyperlink, and will look like this:
+![Author LaTeX render preview image](https://raw.githubusercontent.com/duetosymmetry/orcidlink-LaTeX-command/f03c85cd9fe3e40bec5f51b1319b0e9ab30c2e09/preview.png)
+
+Dependancies
+------------
+
+This package relies on the following packages:
+- [hyperref](https://www.ctan.org/pkg/hyperref)
+- [scalerel](https://www.ctan.org/pkg/scalerel)
+- [tikz](https://www.ctan.org/pkg/pgf)
+
+All of these packages are included in the popular [TeX Live](https://www.tug.org/texlive/) distribution, so most users should not have to install anything new.
+
+Credits
+-------
+
+The original TikZ icon code was created by user [Milo on
+TeX.SE](https://tex.stackexchange.com/users/128068/milo).
+This package was created and is maintained by [Leo
+C. Stein](http://duetosymmetry.com/), (c) 2019.
+This material is subject to the [LaTeX Project Public License
+1.3c](https://www.ctan.org/license/lppl1.3).
diff --git a/macros/latex/contrib/orcidlink/orcidlink.dtx b/macros/latex/contrib/orcidlink/orcidlink.dtx
new file mode 100644
index 0000000000..2d6a65fbd8
--- /dev/null
+++ b/macros/latex/contrib/orcidlink/orcidlink.dtx
@@ -0,0 +1,162 @@
+% \iffalse meta-comment
+%
+% Copyright (C) 2020 by Leo C. Stein <leo.stein@gmail.com>
+% ---------------------------------------------------------------------------
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+%
+% The Current Maintainer of this work is Leo C. Stein.
+%
+% This work consists of the files orcidlink.dtx and orcidlink.ins
+% and the derived filebase orcidlink.sty.
+%
+% \fi
+%
+% \iffalse
+%<*driver>
+\ProvidesFile{orcidlink.dtx}
+%</driver>
+%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
+%<package>\ProvidesPackage{orcidlink}
+%<*package>
+ [2020/11/19 v1.0.0 Linked ORCiD logo macro package]
+%</package>
+%
+%<*driver>
+\documentclass{ltxdoc}
+\usepackage[dvipsnames]{xcolor}
+\usepackage{orcidlink}[2020/11/19]
+\hypersetup{colorlinks,urlcolor=NavyBlue,citecolor=NavyBlue,linkcolor=NavyBlue,pdfusetitle}
+\usepackage{graphicx}
+\EnableCrossrefs
+\CodelineIndex
+\RecordChanges
+\begin{document}
+ \DocInput{orcidlink.dtx}
+ \PrintChanges
+\end{document}
+%</driver>
+% \fi
+%
+% \CheckSum{21}
+%
+% \CharacterTable
+% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
+% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
+% Digits \0\1\2\3\4\5\6\7\8\9
+% Exclamation \! Double quote \" Hash (number) \#
+% Dollar \$ Percent \% Ampersand \&
+% Acute accent \' Left paren \( Right paren \)
+% Asterisk \* Plus \+ Comma \,
+% Minus \- Point \. Solidus \/
+% Colon \: Semicolon \; Less than \<
+% Equals \= Greater than \> Question mark \?
+% Commercial at \@ Left bracket \[ Backslash \\
+% Right bracket \] Circumflex \^ Underscore \_
+% Grave accent \` Left brace \{ Vertical bar \|
+% Right brace \} Tilde \~}
+%
+%
+% \changes{v1.0.0}{2020/11/19}{Converted to DTX file}
+%
+% \DoNotIndex{\newcommand,\newenvironment}
+%
+% \GetFileInfo{orcidlink.dtx}
+% \title{The \textsf{orcidlink} package}
+% \author{Leo C.\ Stein\,\orcidlink{0000-0001-7559-9597} \\ \href{mailto:leo.stein@gmail.com}{leo.stein@gmail.com}}
+% \date{\fileversion~from \filedate}
+%
+% \maketitle
+%
+% \noindent Source repo:
+% \url{https://github.com/duetosymmetry/orcidlink-LaTeX-command}.
+%
+% \section{Introduction}
+%
+% This is a LaTeX style file to add a macro for inserting a linked
+% ORCiD logo. The package provides exactly one command, |\orcidlink|.
+%
+% \section{Usage}
+%
+% To use this package, in the preamble include
+% \begin{macrocode}
+\usepackage{orcidlink}
+% \end{macrocode}
+% \DescribeMacro{\orcidlink}
+% Insert the ORCiD logo (\orcidlink{}), which is hyperlinked to the URL
+% of the researcher whose iD was specified. Usage:
+%
+|\orcidlink| \marg{orcid}\newline
+% Replace the mandatory argument \meta{orcid} with your
+% ORCiD --- just the digits, not your whole URL.
+% For example, the command
+% |\orcidlink{0000-0001-7559-9597}| will hyperlink to the URL
+% \url{https://orcid.org/0000-0001-7559-9597}.
+% This is most common in
+% the author list. For example, in the preamble of a RevTeX article,
+% if you write
+% \begin{macrocode}
+\author{Emmy Noether\,\orcidlink{0000-0000-0000-0000}}
+% \end{macrocode}
+% then the article byline will look something like this:
+%
+% \includegraphics[width=0.5\textwidth]{preview}\newline{}
+% The macro is used in the author line of this documentation as well.
+%
+% \StopEventually{}
+%
+% \section{Implementation}
+%
+% \iffalse
+%<*package>
+% \fi
+%
+% \begin{macrocode}
+\NeedsTeXFormat{LaTeX2e}[1994/06/01]
+\ProvidesPackage{orcidlink}[2019/12/12 Linked ORCiD logo macro package]
+% \end{macrocode}
+% All I did was package up Milo's code on TeX.SE,
+% see https://tex.stackexchange.com/a/445583/34063
+% \begin{macrocode}
+\RequirePackage{hyperref}
+\RequirePackage{scalerel}
+\RequirePackage{tikz}
+\ProcessOptions\relax
+\usetikzlibrary{svg.path}
+\definecolor{orcidlogocol}{HTML}{A6CE39}
+\tikzset{
+ orcidlogo/.pic={
+ \fill[orcidlogocol] svg{M256,128c0,70.7-57.3,128-128,128C57.3,256,0,198.7,0,128C0,57.3,57.3,0,128,0C198.7,0,256,57.3,256,128z};
+ \fill[white] svg{M86.3,186.2H70.9V79.1h15.4v48.4V186.2z}
+ svg{M108.9,79.1h41.6c39.6,0,57,28.3,57,53.6c0,27.5-21.5,53.6-56.8,53.6h-41.8V79.1z M124.3,172.4h24.5c34.9,0,42.9-26.5,42.9-39.7c0-21.5-13.7-39.7-43.7-39.7h-23.7V172.4z}
+ svg{M88.7,56.8c0,5.5-4.5,10.1-10.1,10.1c-5.6,0-10.1-4.6-10.1-10.1c0-5.6,4.5-10.1,10.1-10.1C84.2,46.7,88.7,51.3,88.7,56.8z};
+ }
+}
+% \end{macrocode}
+%
+% \begin{macro}{\orcidlink}
+% \begin{macrocode}
+\newcommand\orcidlink[1]{\href{https://orcid.org/#1}{\mbox{\scalerel*{
+\begin{tikzpicture}[yscale=-1,transform shape]
+\pic{orcidlogo};
+\end{tikzpicture}
+}{|}}}}
+\endinput
+% \end{macrocode}
+% \end{macro}
+%
+
+%
+% \iffalse
+%</package>
+% \fi
+%
+% \Finale
+\endinput
diff --git a/macros/latex/contrib/orcidlink/orcidlink.ins b/macros/latex/contrib/orcidlink/orcidlink.ins
new file mode 100644
index 0000000000..dcdd43c005
--- /dev/null
+++ b/macros/latex/contrib/orcidlink/orcidlink.ins
@@ -0,0 +1,57 @@
+%% Copyright (C) 2020 by Leo C. Stein <leo.stein@gmail.com>
+%% --------------------------------------------------------------------------
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% of this license or (at your option) any later version.
+%% The latest version of this license is in
+%% http://www.latex-project.org/lppl.txt
+%% and version 1.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Leo C. Stein.
+%%
+%% This work consists of the files orcidlink.dtx and orcidlink.ins
+%% and the derived filebase orcidlink.sty.
+%%
+
+\input docstrip.tex
+\keepsilent
+
+\usedir{tex/latex/orcidlink}
+
+\preamble
+
+This is a generated file.
+
+Copyright (C) 2020 by Leo C. Stein <leo.stein@gmail.com>
+--------------------------------------------------------------------------
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+\endpreamble
+
+\generate{\file{orcidlink.sty}{\from{orcidlink.dtx}{package}}}
+
+\obeyspaces
+\Msg{*************************************************************}
+\Msg{* *}
+\Msg{* To finish the installation you have to move the following *}
+\Msg{* file into a directory searched by TeX: *}
+\Msg{* *}
+\Msg{* orcidlink.sty *}
+\Msg{* *}
+\Msg{* To produce the documentation run the file orcidlink.dtx *}
+\Msg{* through LaTeX. *}
+\Msg{* *}
+\Msg{* Happy TeXing! *}
+\Msg{* *}
+\Msg{*************************************************************}
+
+\endbatchfile
diff --git a/macros/latex/contrib/orcidlink/orcidlink.pdf b/macros/latex/contrib/orcidlink/orcidlink.pdf
new file mode 100644
index 0000000000..63cfe12b7e
--- /dev/null
+++ b/macros/latex/contrib/orcidlink/orcidlink.pdf
Binary files differ