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

referencePublication and usageCitation recommendations and use cases are not well-defined #92

Open
gremau opened this issue Dec 17, 2024 · 1 comment
Labels
EML Best Practices Applies to "EML Best Practices" document needs review

Comments

@gremau
Copy link
Collaborator

gremau commented Dec 17, 2024

Seemingly anyways. Should we actually be recommending against using them? Review here.

@gremau gremau added EML Best Practices Applies to "EML Best Practices" document needs review labels Dec 17, 2024
@twhiteaker
Copy link
Collaborator

I don't think we should recommend against using them. No need for an endorsement either, though. The "cart before the horse" paragraph explains why it may be difficult to use them. If you can do it, it's fine to do so. Otherwise, if you have alternate means of associating pubs with data, such as repository tools, then that's fine.

There's this sentence, "If the resource is available with a DOIs at the time of EML creation, then they are fine to include, but alternative methods of linking these types of resources to a published EML dataset are typically preferred." Preferred sounds like a recommendation to me, which I don't think we should be making here. There's also an extra "s" in "DOIs". I suggest this:

<referencePublication> and <usageCitation> elements may be difficult to use in EML documents because the resource to be described is usually published after the EML document is created. If the resource is available with a DOI at the time of EML creation, then those elements are fine to include, but alternative methods of linking these types of resources to a published EML dataset may also be employed.

There was also a sentence saying referencePublication is a CitationType. It is actually a CitationListType.

I suggest removing example 8.3. Sometimes people just skim examples and mimic them, and that example shows the not-recommended way.

Since referencePublication and usageCitation are just CitationType elements, I think having the two existing citation element examples (8.1 and 8.2) is fine to show the structure. However, the caption for the examples says this is for a reference publication, in which case referencePublication should be used instead of citation. So, either change the example to be for something that would go as a child in literatureCited, or actually use referencePublication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EML Best Practices Applies to "EML Best Practices" document needs review
Projects
None yet
Development

No branches or pull requests

2 participants