/linkToId

LaTeX class to create links to ORCID.org including to ORCID logo and using the recommended typesetting.

Primary LanguageTeX

linkToId for LaTeX Build Status

This LaTeX package provides a style file to create links to ID services for researchers. Currently, only ORCID(R) is supported.

Installation

If you encounter problems during installation, please have a look at a Dockerfile in the tests/Docker-* subdirectories to see what might be wrong.

Creation of the style file and the documentation

To (re-)generate the style file, run:

latex linkToId.ins

Then, to create the package documentation in a PDF file, run:

pdflatex linkToId.dtx

Installation alongside a document

Since this package is fairly new and not yet on CTAN, it is probably best to simply put the style file into the folder of your document or put the whole package directory as a subdirectory into the folder where you have the .tex-document which uses the package. You can easily tell usepackage that it can find the style file in a subdirectory:

\usepackage{linkToId-subdirectory/linkToId}

Usage

Tell LaTeX to use the package, then use the ID specific linking commands to create the links.

\usepackage{linkToId}

ORCID

ORCID.org including to ORCID logo and using the recommended typesetting. Note that use of the ORCID icon should follow ORCID's trademark and id display guidelines.

Create links to ORCID using names and IDs:

  • Name with an icon behind it:
\linkToOrcidNameIcon{Josiah Carberry}{https://orcid.org/0000-0002-1825-0097}
  • Icon with ID behind it:
\linkToOrcidIconId{https://orcid.org/0000-0002-1825-0097}
  • Name, icon and ID:
\linkToOrcidNameIconId{Josiah Carberry}{https://orcid.org/0000-0002-1825-0097}

Using linkToId with LyX

A sample file containing definitions of custom insets for usage with LyX can be found in the lyx subdirectory.

Known issues

  • The height of the icon does not always match the height of the font, even though it is scaled in units of ex.