bssw-tutorial / presentations

Presentations for BSSw tutorial modules
Other
3 stars 2 forks source link

Style guide points: URLs should be clickable, and we have a strong preference for DOIs as links #181

Open bernhold opened 7 months ago

bernhold commented 7 months ago

We don't have a style guide, but if we did, one of the things I think it should include is:

URLs in the presentations should be clickable

This may take a bit of extra time for the authors, but it offers much greater usability for anyone looking at the presentation -- click and go rather than having to cut and paste the link.

Note that there are some cases where the URL is part of a code example (e.g., an argument to a command), and I would argue this should be an exception from the policy above.

The second point I would add to the style guide is that

DOIs are preferred over any other URL where they are available.

To the extent that for any paper or report, it is worth some effort to track down a DOI even if that's not what you were originally given. For example the majority of documents archived on the OSTI site have DOIs assigned to them. Next in order of preference would be any other persistent identifier. Not everything has a persistent identifier, but we should try to find one and use it if possible.