Skip to content

feat: add citeAs / citeWith properties#16

Open
alee wants to merge 1 commit into
SciCodes:target_codemeta_v4from
alee:add_citation_properties
Open

feat: add citeAs / citeWith properties#16
alee wants to merge 1 commit into
SciCodes:target_codemeta_v4from
alee:add_citation_properties

Conversation

@alee

@alee alee commented Jun 23, 2026

Copy link
Copy Markdown
Member

update example in codemeta-software.json to demonstrate usage as well as property descriptions

proposed semantics:

  • citeAs: permanent identifier URL resolving to a landing page / specific version of this software (primary reference for this software)
  • citeWith: List of permanent identifiers for companion works that the author(s) also want to be cited with this software (e.g., conceptual paper introducing the software, methods publications describing the algorithms or implementation)
  • referencePublication: permanent identifier to the "conceptual publication" about the software
  • citation: general related references and other citations as free Text (should deprecate?)

resolves codemeta#408
resolves codemeta#268
resolves codemeta#381

@alee alee force-pushed the add_citation_properties branch from fdfba8a to 42d70ce Compare June 23, 2026 16:46
@dgarijo

dgarijo commented Jun 23, 2026

Copy link
Copy Markdown

Then we don't use creditText? This is a schema.org property that was proposed in the discussion, no?
Overall, I like the difference, but citeAs and reference publication are perhaps too close in meaning. We need better examples.

update property descriptions and example codemeta-software.json to demonstrate usage

proposed semantics:

- citeAs: preferred citation target for a specific version of this software as a permanent identifier URL
- citeWith: companion works that should be cited as a list of permanent identifiers (e.g., conceptual paper introducing the software, methods publications describing the algorithms or implementation)
- referencePublication: publication describing the software as free Text
- citation: general related references and citations as free Text

resolves codemeta#408
resolves codemeta#268
resolves codemeta#381
@alee alee force-pushed the add_citation_properties branch from 42d70ce to 6cd7cdf Compare June 23, 2026 17:50
@alee

alee commented Jun 23, 2026

Copy link
Copy Markdown
Member Author

I think creditText as Text is the dealbreaker for me. Seems to be more of a displayable caption for creative works (photographs, music, videos, etc.). I'd prefer a PID that resolves to a landing page and exact version of the software.

citeWith should be a comprehensive list of all publications that the author requests to be cited in addition to the citeAs ref

referencePublication does overlap with citeWith but I interpret it as the initial concept paper about the software

@dgarijo

dgarijo commented Jun 24, 2026

Copy link
Copy Markdown

I will continue the discussion in the original discussion thread: codemeta#408 (comment)

I feel like we don't yet have sufficient agreement on this, since what you have proposed is different from what Rebecca had proposed, or even what I had proposed. I like the direction, but we need agreement before merging.

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.

2 participants