summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/orcidlink/README.md
blob: 6b0100438a6f3f05ac740d4d9950a002e6877e72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# 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 contribution was wrapping it into a style file (and improving the fragility of the command a bit).

Installation
------------

If `orcidlink` is already provided in your TeX distribution, skip this
section.  You should be able to install `orcidlink` [from the CTAN](https://www.ctan.org/pkg/orcidlink) 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)
- [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).