Skip to content
Merged
14 changes: 7 additions & 7 deletions src/components/AuthorCardEditing.vue
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ export default defineComponent({
title: 'given-names',
url: [
{
text: 'Click here to see the documentation for name.',
text: 'Click here to see the documentation for given-names.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersongiven-names'
}
],
Expand All @@ -288,23 +288,23 @@ export default defineComponent({
title: 'name-particle, family-names, name-suffix',
url: [
{
text: 'Click here to see the documentation for name particle.',
text: 'Click here to see the documentation for name-particle.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonname-particle'
},
{
text: 'Click here to see the documentation for family name.',
text: 'Click here to see the documentation for family-name.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonfamily-names'
},
{
text: 'Click here to see the documentation for name suffix.',
text: 'Click here to see the documentation for name-suffix.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonname-suffix'
}
],
description: 'The person\'s last names, split into parts.',
examples: [
'name particle: von',
'family name: Doe',
'name suffix: Jr.'
'name-particle: von',
'family-name: Doe',
'name-suffix: Jr.'
]
},
email: {
Expand Down
35 changes: 30 additions & 5 deletions src/components/IdentifierCardEditing.vue
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,25 @@ export default defineComponent({
const helpData = {
doi: {
title: 'doi',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsdoi',
url: [
{
text: 'Click here to see the documentation for doi.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsdoi'
}
],
description: 'The DOI (https://en.wikipedia.org/wiki/Digital_object_identifier) of the work.',
examples: [
'10.5281/zenodo.1003150'
]
},
url: {
title: 'url',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsurl',
url: [
{
text: 'Click here to see the documentation for url.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsurl'
}
],
description: 'A URL.',
examples: [
'https://research-software-project.org',
Expand All @@ -157,23 +167,38 @@ export default defineComponent({
},
swh: {
title: 'swh',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsswh-identifier',
url: [
{
text: 'Click here to see the documentation for swh.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsswh-identifier'
}
],
description: 'The Software Heritage identifier (https://www.softwareheritage.org/).',
examples: [
'swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d'
]
},
other: {
title: 'other',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier',
url: [
{
text: 'Click here to see the documentation for other.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier'
}
],
description: 'An identifier that does not fit in the other categories.',
examples: [
'arXiv:2103.06681'
]
},
description: {
title: 'description',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier-description',
url: [
{
text: 'Click here to see the documentation for description.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier-description'
}
],
description: 'A description of the identifier.',
examples: [
'The concept DOI of the work.',
Expand Down
7 changes: 6 additions & 1 deletion src/components/ScreenAbstract.vue
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,12 @@ export default defineComponent({
const helpData = {
abstract: {
title: 'abstract',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#abstract',
url: [
{
text: 'Click here to see the documentation for abstract.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#abstract'
}
],
description: 'A description or summary of the work.'
}
}
Expand Down
7 changes: 6 additions & 1 deletion src/components/ScreenIdentifiers.vue
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,12 @@ export default defineComponent({
const helpData = {
identifiers: {
title: 'identifiers',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#identifiers',
url: [
{
text: 'Click here to see the documentation for identifiers.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#identifiers'
}
],
description: 'The identifiers of the work, such as DOIs, Software Heritage deposits, and URLs for relevant objects.',
examples: [
'DOI: 10.5281/zenodo.1003149 - The concept DOI of the work',
Expand Down
7 changes: 6 additions & 1 deletion src/components/ScreenKeywords.vue
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,12 @@ export default defineComponent({
const helpData = {
keywords: {
title: 'keywords',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#keywords',
url: [
{
text: 'Click here to see the documentation for keywords.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#keywords'
}
],
description: 'Keywords that describe the work.',
examples: [
'keyword',
Expand Down
7 changes: 6 additions & 1 deletion src/components/ScreenLicense.vue
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,12 @@ export default defineComponent({
const helpData = {
license: {
title: 'license',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#license',
url: [
{
text: 'Click here to see the documentation for license.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#license'
}
],
description: 'The SPDX license identifier for the license under which the work is available.',
examples: [
'Apache-2.0',
Expand Down
28 changes: 24 additions & 4 deletions src/components/ScreenRelatedResources.vue
Original file line number Diff line number Diff line change
Expand Up @@ -162,31 +162,51 @@ export default defineComponent({
const helpData = {
repository: {
title: 'repository',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository',
url: [
{
text: 'Click here to see the documentation for repository.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository'
}
],
description: 'URL of the work in a repository/archive that is neither a source code repository nor a build artifact repository',
examples: [
'https://ascl.net/2105.013'
]
},
repositoryArtifact: {
title: 'repository-artifact',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-artifact',
url: [
{
text: 'Click here to see the documentation for repository-artifact.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-artifact'
}
],
description: 'URL of the work in a build artifact/binary repository',
examples: [
'https://search.maven.org/artifact/org.corpus-tools/cff-maven-plugin/0.4.0/maven-plugin'
]
},
repositoryCode: {
title: 'repository-code',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-code',
url: [
{
text: 'Click here to see the documentation for repository-code.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-code'
}
],
description: 'URL of the work in a source code repository',
examples: [
'https://github.com/citation-file-format/citation-file-format'
]
},
url: {
title: 'url',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#url',
url: [
{
text: 'Click here to see the documentation for url.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#url'
}
],
description: 'URL of the landing page/website for the work',
examples: [
'https://citation-file-format.github.io/'
Expand Down
21 changes: 18 additions & 3 deletions src/components/ScreenStart.vue
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,22 @@ export default defineComponent({
const helpData = {
type: {
title: 'type',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#type',
url: [
{
text: 'Click here to see the documentation for type.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#type'
}
],
description: 'The type of the work that is being described by this CITATION.cff file.'
},
title: {
title: 'title',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#title',
url: [
{
text: 'Click here to see the documentation for title.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#title'
}
],
description: 'The name of the software or dataset.',
examples: [
'cffconvert',
Expand All @@ -137,7 +147,12 @@ export default defineComponent({
},
message: {
title: 'message',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#message',
url: [
{
text: 'Click here to see the documentation for message.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#message'
}
],
description: 'A message to the human reader of the CITATION.cff file to let them know what to do with the citation metadata.',
examples: [
'If you use this software, please cite it using the metadata from this file.',
Expand Down
21 changes: 18 additions & 3 deletions src/components/ScreenVersionSpecific.vue
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,12 @@ export default defineComponent({
const helpData = {
commit: {
title: 'commit',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#commit',
url: [
{
text: 'Click here to see the documentation for commit.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#commit'
}
],
description: 'The commit hash or revision number of the software version.',
examples: [
'1ff847d81f29c45a3a1a5ce73d38e45c2f319bba',
Expand All @@ -155,7 +160,12 @@ export default defineComponent({
},
version: {
title: 'version',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version',
url: [
{
text: 'Click here to see the documentation for version.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version'
}
],
description: 'The version of the software or dataset.',
examples: [
'1.2.0',
Expand All @@ -165,7 +175,12 @@ export default defineComponent({
},
dateReleased: {
title: 'date-released',
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#date-released',
url: [
{
text: 'Click here to see the documentation for date-released.',
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#date-released'
}
],
description: 'The date the work has been released.'
}
}
Expand Down