Skip to content

Commit

Permalink
refactor(metadata): rename CodeMeta softwareVersion to codeVersion IQ…
Browse files Browse the repository at this point in the history
…SS#7844

As the citation block already contains a compound field "software"
with both "softwareName" and "softwareVersion", meant to describe software
used to create the dataset, this name conflict must be resolved.

By renaming to "codeVersion", the semantic is not changed, as this metadata
block is about describing software deposits. As the termURI is explicitly
set to "schema.org/softwareVersion" it remains compatible with OAI-ORE and
other linked data usages. A future exporter for CodeMeta might require
special attention for this field.
  • Loading branch information
poikilotherm committed Nov 10, 2022
1 parent 79b3092 commit c4e5028
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion scripts/api/data/metadatablocks/codemeta.tsv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#metadataBlock name dataverseAlias displayName blockURI
codeMeta20 Software Metadata (CodeMeta v2.0) https://codemeta.github.io/terms/
#datasetField name title description watermark fieldType displayOrder displayFormat advancedSearchField allowControlledVocabulary allowmultiples facetable displayoncreate required parent metadatablock_id termURI
softwareVersion Software Version Version of the software instance, usually following some convention like SemVer etc. e.g. 0.2.1 or 1.3 or 2021.1 etc text 0 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE codeMeta20 https://schema.org/softwareVersion
codeVersion Software Version Version of the software instance, usually following some convention like SemVer etc. e.g. 0.2.1 or 1.3 or 2021.1 etc text 0 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE codeMeta20 https://schema.org/softwareVersion
developmentStatus Development Status Description of development status, e.g. work in progress (wip), active, etc. See repostatus.org for more information. text 1 <a href='https://www.repostatus.org/##VALUE'><img src='https://www.repostatus.org/badges/latest/#VALUE.svg' alt='#VALUE '/></a> TRUE TRUE FALSE TRUE FALSE FALSE codeMeta20 https://www.repostatus.org
codeRepository Code Repository Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, Gitea, etc.). e.g. https://github.com/user/project url 2 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> TRUE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/codeRepository
applicationCategory Application Category Type of software application, e.g. Simulation, Analysis, Visualisation. text 3 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/applicationCategory
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/propertyFiles/codeMeta20.properties
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
metadatablock.name=codeMeta20
metadatablock.displayName=Software Metadata (CodeMeta 2.0)
datasetfieldtype.softwareVersion.title=Software Version
datasetfieldtype.softwareVersion.description=Version of the software instance, usually following some convention like SemVer etc.
datasetfieldtype.softwareVersion.watermark=e.g. 0.2.1 or 1.3 or 2021.1 etc
datasetfieldtype.codeVersion.title=Software Version
datasetfieldtype.codeVersion.description=Version of the software instance, usually following some convention like SemVer etc.
datasetfieldtype.codeVersion.watermark=e.g. 0.2.1 or 1.3 or 2021.1 etc
datasetfieldtype.developmentStatus.title=Development Status
datasetfieldtype.developmentStatus.description=Description of development status, e.g. work in progress (wip), active, etc. See repostatus.org for more information.
datasetfieldtype.developmentStatus.watermark= Development Status
Expand Down

0 comments on commit c4e5028

Please sign in to comment.