search

citation-style-language / styles

Official repository for Citation Style Language (CSL) citation styles.
https://citationstyles.org/
3.33k stars 3.78k forks source link

Validation of CSL with custom variable #7294

Open shallcro opened 3 weeks ago

shallcro commented 3 weeks ago

Greetings; my organization is working to submit a CSL style. Our data repository includes instances where two institutions may collaborate on the publication of data and our local citation style reflects this by presenting both institutions as 'publishers.'

To avoid confusion around the standard variable 'original-publisher', we thought that we would use a custom variable ('second-distributor') to designate this second data publisher/distributor.

In our local texts, this approach works when using the 'cheater syntax' with citeproc-js (as noted in this forum post).

The drawback is that--unsurprisingly--our CSL file fails validation at https://validator.citationstyles.org/. Given that the CSL submission guidelines state that we should "correct any validation errors" prior to submission, would you have any guidance on whether we should (a) adapt standard variables to our local needs or (b) submit and explain the use of our custom variable via a 'documentation' link or (c) just keep our CSL style local?

Thanks in advance for your help/expertise and apologies if any of the above is unclear!

bwiernik commented 3 weeks ago

I would strongly recommend using standard CSL variables. We cannot accept styles that do not validate into the repository, and I would strongly advise against adopting a data model for your organization that renders your data incompatible with other CSL styles (which don't use your custom variable).

Could you describe your confusion about original-publisher? What's your intended use for "second-distributor"?

shallcro commented 3 weeks ago

Thank you; this is exactly the type of feedback I was hoping for. I really appreciate your prompt and helpful response!

Our confusion around 'original-publisher' stems from legacy practices around collaborative distribution of physical data collections (that have been since digitized). In those cases, the data collections were jointly published, not necessarily 'republished' as the definition for the variable states. This is probably a good time for us to revisit those MOUs and their applicability with digital collections where the DOI only resolves to our data repository.

Thanks again!

bwiernik commented 3 weeks ago

For joint publishers, the current CSL approach is to enter both into the same publisher field. There has been some discussion of converting publisher to a "name" variable (which would allow items to have multiple distinct publishers) in a future CSL variable, but I would not expect that to happen for several years.

shallcro commented 3 weeks ago

Thank you for taking the time to make this suggestion; we really appreciate it!