Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for displaying ORCID iDs of authors #86

Closed
wants to merge 7 commits into from

Conversation

gerking
Copy link

@gerking gerking commented Jan 21, 2021

Fixes #91

Introduces a new \orcid{...} command that handles ORCID iDs. The command is context-sensitive: it can display the ORCID logo next to the author's name, but when used in the footnote it additionally prints the respective URL (as requested by the LNI author guidelines). Both logo and URL are hyperlinked to the respective ORCID record.

Usage: \orcid{<ORCID iD>}, e.g., \orcid{0000-0001-5531-9607}

lni.cls Outdated Show resolved Hide resolved
lni.cls Outdated
\ifstrempty{#1}{}{%
\href{https://orcid.org/#1}{
\begin{minipage}[t]{\baselineskip}
\includegraphics[width=\textwidth]{ORCIDiD_iconvector.pdf}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had issues with underscores (_) in file names.

Instead of adding a PDF, I would suggest to use academicicons (Source: https://tex.stackexchange.com/a/378333/9075). It is old enough to be available on overleaf and on older systems.

The alternative orcidlink is too new, even though it easier to use. (Source: https://tex.stackexchange.com/a/572014/9075)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of adding a PDF, I would suggest to use academicicons

However academicons might be restricted to Xe(La)TeX or Lua(La)TeX: https://tex.stackexchange.com/questions/545599/any-way-to-use-academicons-with-pdflatex

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then orcidlink? We can add a section to the guideline that users need to download https://github.com/duetosymmetry/orcidlink-LaTeX-command/blob/master/orcidlink.sty and place it in the current directory.

(You see I like micro libraries -- https://github.com/parro-it/awesome-micro-npm-packages ^^)

Copy link
Author

@gerking gerking Jan 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\orcidlink{...} doesn't seem to work in the footnote: Use of @xfootnotemark doesn't match its definition.

Also I wonder whether orcidlink can display the logo slightly higher than the preceding text, as it is done in the LNI author instructions. But I don't know how strict those instructions are.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for checking. What do you think about basing on the TikZ macro? 😅 (I am just try to avoid an external file. Users tend to copy files back and forth - even if they should not. Copying a PDF is a thing I would like to avoid)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will give it a try.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not to require TikZ to keep the external requirements low.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For link completeness, there is also a pic2e variant: https://tex.stackexchange.com/a/659104/9075

I think, orcidlink is now the way to move forward! (Isn't it?)

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>
@ccvca
Copy link

ccvca commented Mar 23, 2022

TIKZ-Version of the logo (CC0-License) is available here: https://gist.github.com/tarleb/eaa443e129d66acbc67bc6432836f466

@csware
Copy link
Contributor

csware commented May 15, 2023

THere seems to be a packet: https://ctan.org/pkg/orcidlink

@koppor
Copy link
Member

koppor commented May 15, 2023

THere seems to be a packet: ctan.org/pkg/orcidlink

Did you check the comments by @gerking:

\orcidlink{...} doesn't seem to work in the footnote: Use of @xfootnotemark doesn't match its definition.

Also I wonder whether orcidlink can display the logo slightly higher than the preceding text, as it is done in the LNI author instructions. But I don't know how strict those instructions are.

And you said:

I'd prefer not to require TikZ to keep the external requirements low.

Let's see how it goes...

@csware
Copy link
Contributor

csware commented May 15, 2023

When I try to use it, I get hyperref option clash...

@sieversMartin
Copy link
Member

I prefer using the academicons package. However, I kindly ask for some patience.

@gerking
Copy link
Author

gerking commented May 15, 2023

I prefer using the academicons package. However, I kindly ask for some patience.

Even though it is restricted to Xe(La)TeX or Lua(La)TeX? As far as I know, it doesn't work with pdflatex.

@sieversMartin
Copy link
Member

@gerking Thanks for the hint. You are right, that is not the best idea. However, as we only need one single glyph we could make a graphic file out of it.

@csware
Copy link
Contributor

csware commented Jul 11, 2023

Why not use a PDF as in the PR to get this closed, a cleaner version can still be implemented lateron?

@@ -305,19 +305,19 @@
\newcommand{\authorrunning}[1]{%
\fancyhead[LE]{\hspace{0.05cm}\oldsmall\thepage\hspace{5pt}#1}}
\newcommand*{\email}[1]{\href{mailto:#1}{\urlstyle{same}\protect\nolinkurl{#1}}}
\PassOptionsToPackage{bookmarks=false}{hyperref}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an intended change to disable the bookmarks?

Copy link
Author

@gerking gerking Jul 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, just a helpless attempt to prevent the hyperref option clash

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe open an issue in the orcidlink package

Copy link
Author

@gerking gerking Jul 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps bookmarks are already disabled anyhow, at least there is \RequirePackage[bookmarks=false]{hyperref} in lni.cls. Therefore I am not so sure if that's really an issue with orcidlink, or whether LNI (as user of orcidlink) should avoid the option clash using \PassOptionsToPackage{...}.

@gerking
Copy link
Author

gerking commented Jul 11, 2023

Why not use a PDF as in the PR to get this closed, a cleaner version can still be implemented lateron?

Well, the latest versions of orcidlink actually seem to work in footnotes. Tried in commit 3089ea3.

A remaining problem might be that orcidlink does not print the logo higher than the text, as it might be indicated by the LNI guidelines. Do you think it would be a violation of those guidelines?

@koppor
Copy link
Member

koppor commented Jul 12, 2023

A remaining problem might be that orcidlink does not print the logo higher than the text, as it might be indicated by the LNI guidelines. Do you think it would be a violation of those guidelines?

I would say: it's good enough. On the one hand, we could file a feature request at https://github.com/duetosymmetry/orcidlink-LaTeX-command/issues asking for a parameter. On the other hand, I would check how other publisher do it. Do you have examples at hand? Google Image Search did not find anything useful (just the tex.sx questions asking for how to ORCID ^^).

@koppor
Copy link
Member

koppor commented Jul 12, 2023

Regarding the interplay with hyperref: Loading hyperref at the right place is always difficult (see https://tex.stackexchange.com/questions/1863/which-packages-should-be-loaded-after-hyperref-instead-of-before).

Before this patch, hyperref is loaded, when requested by the author.

@sieversMartin and me started a discussion how to "properly" include hyperref at #116 (comment).

Option 1:

The most conservative option would be to add the orcidlink to the AtEndPreamble inside the hyperref part?

\ifusehyperref
   \AtEndPreamble{%

Then update the https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.tex accordingly.

Option 2:

Add another AtEndPreamble statement and a guard \@ifpackageloaded{orcidlink} for the fix for orcidlink.

Then also update the https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.tex accordingly.

This is #131

Option 3:

The other option would be to remove the user option for hyperref and always load hyperref.

I am very aware that this class is different from other classes, because it includes many other packages.

Always loading hyperref could cause issues there.


I lean towards Option 2 to keep things going. Maybe Option 3 could work, too. I did not hear any complaints that the class does not work at all.

@koppor koppor added this to the v1.8 milestone Nov 23, 2023
@sieversMartin
Copy link
Member

Should be fixed altogether. I close this. If there are any problems left in v1.8, please open a new ticket based on that version.

@koppor
Copy link
Member

koppor commented Nov 26, 2023

Integration mainly in commit eb01240.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for ORCiD
5 participants