Skip to content

Commit 2beb089

Browse files
fdiblenfdiblen
authored
Merge pull request #705 from citation-file-format/703-update-urls-format-for-dialog-links
703 update urls format for dialog links
2 parents 9683164 + cb610a4 commit 2beb089

9 files changed

Lines changed: 121 additions & 26 deletions

‎src/components/AuthorCardEditing.vue‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ export default defineComponent({
274274
title: 'given-names',
275275
url: [
276276
{
277-
text: 'Click here to see the documentation for name.',
277+
text: 'Click here to see the documentation for given-names.',
278278
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersongiven-names'
279279
}
280280
],
@@ -288,23 +288,23 @@ export default defineComponent({
288288
title: 'name-particle, family-names, name-suffix',
289289
url: [
290290
{
291-
text: 'Click here to see the documentation for name particle.',
291+
text: 'Click here to see the documentation for name-particle.',
292292
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonname-particle'
293293
},
294294
{
295-
text: 'Click here to see the documentation for family name.',
295+
text: 'Click here to see the documentation for family-name.',
296296
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonfamily-names'
297297
},
298298
{
299-
text: 'Click here to see the documentation for name suffix.',
299+
text: 'Click here to see the documentation for name-suffix.',
300300
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionspersonname-suffix'
301301
}
302302
],
303303
description: 'The person\'s last names, split into parts.',
304304
examples: [
305-
'name particle: von',
306-
'family name: Doe',
307-
'name suffix: Jr.'
305+
'name-particle: von',
306+
'family-name: Doe',
307+
'name-suffix: Jr.'
308308
]
309309
},
310310
email: {

‎src/components/IdentifierCardEditing.vue‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,15 +138,25 @@ export default defineComponent({
138138
const helpData = {
139139
doi: {
140140
title: 'doi',
141-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsdoi',
141+
url: [
142+
{
143+
text: 'Click here to see the documentation for doi.',
144+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsdoi'
145+
}
146+
],
142147
description: 'The DOI (https://en.wikipedia.org/wiki/Digital_object_identifier) of the work.',
143148
examples: [
144149
'10.5281/zenodo.1003150'
145150
]
146151
},
147152
url: {
148153
title: 'url',
149-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsurl',
154+
url: [
155+
{
156+
text: 'Click here to see the documentation for url.',
157+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsurl'
158+
}
159+
],
150160
description: 'A URL.',
151161
examples: [
152162
'https://research-software-project.org',
@@ -157,23 +167,38 @@ export default defineComponent({
157167
},
158168
swh: {
159169
title: 'swh',
160-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsswh-identifier',
170+
url: [
171+
{
172+
text: 'Click here to see the documentation for swh.',
173+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsswh-identifier'
174+
}
175+
],
161176
description: 'The Software Heritage identifier (https://www.softwareheritage.org/).',
162177
examples: [
163178
'swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d'
164179
]
165180
},
166181
other: {
167182
title: 'other',
168-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier',
183+
url: [
184+
{
185+
text: 'Click here to see the documentation for other.',
186+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier'
187+
}
188+
],
169189
description: 'An identifier that does not fit in the other categories.',
170190
examples: [
171191
'arXiv:2103.06681'
172192
]
173193
},
174194
description: {
175195
title: 'description',
176-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier-description',
196+
url: [
197+
{
198+
text: 'Click here to see the documentation for description.',
199+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsidentifier-description'
200+
}
201+
],
177202
description: 'A description of the identifier.',
178203
examples: [
179204
'The concept DOI of the work.',

‎src/components/ScreenAbstract.vue‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,12 @@ export default defineComponent({
4949
const helpData = {
5050
abstract: {
5151
title: 'abstract',
52-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#abstract',
52+
url: [
53+
{
54+
text: 'Click here to see the documentation for abstract.',
55+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#abstract'
56+
}
57+
],
5358
description: 'A description or summary of the work.'
5459
}
5560
}

‎src/components/ScreenIdentifiers.vue‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,12 @@ export default defineComponent({
185185
const helpData = {
186186
identifiers: {
187187
title: 'identifiers',
188-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#identifiers',
188+
url: [
189+
{
190+
text: 'Click here to see the documentation for identifiers.',
191+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#identifiers'
192+
}
193+
],
189194
description: 'The identifiers of the work, such as DOIs, Software Heritage deposits, and URLs for relevant objects.',
190195
examples: [
191196
'DOI: 10.5281/zenodo.1003149 - The concept DOI of the work',

‎src/components/ScreenKeywords.vue‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,12 @@ export default defineComponent({
123123
const helpData = {
124124
keywords: {
125125
title: 'keywords',
126-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#keywords',
126+
url: [
127+
{
128+
text: 'Click here to see the documentation for keywords.',
129+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#keywords'
130+
}
131+
],
127132
description: 'Keywords that describe the work.',
128133
examples: [
129134
'keyword',

‎src/components/ScreenLicense.vue‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,12 @@ export default defineComponent({
6565
const helpData = {
6666
license: {
6767
title: 'license',
68-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#license',
68+
url: [
69+
{
70+
text: 'Click here to see the documentation for license.',
71+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#license'
72+
}
73+
],
6974
description: 'The SPDX license identifier for the license under which the work is available.',
7075
examples: [
7176
'Apache-2.0',

‎src/components/ScreenRelatedResources.vue‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,31 +162,51 @@ export default defineComponent({
162162
const helpData = {
163163
repository: {
164164
title: 'repository',
165-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository',
165+
url: [
166+
{
167+
text: 'Click here to see the documentation for repository.',
168+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository'
169+
}
170+
],
166171
description: 'URL of the work in a repository/archive that is neither a source code repository nor a build artifact repository',
167172
examples: [
168173
'https://ascl.net/2105.013'
169174
]
170175
},
171176
repositoryArtifact: {
172177
title: 'repository-artifact',
173-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-artifact',
178+
url: [
179+
{
180+
text: 'Click here to see the documentation for repository-artifact.',
181+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-artifact'
182+
}
183+
],
174184
description: 'URL of the work in a build artifact/binary repository',
175185
examples: [
176186
'https://search.maven.org/artifact/org.corpus-tools/cff-maven-plugin/0.4.0/maven-plugin'
177187
]
178188
},
179189
repositoryCode: {
180190
title: 'repository-code',
181-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-code',
191+
url: [
192+
{
193+
text: 'Click here to see the documentation for repository-code.',
194+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#repository-code'
195+
}
196+
],
182197
description: 'URL of the work in a source code repository',
183198
examples: [
184199
'https://github.com/citation-file-format/citation-file-format'
185200
]
186201
},
187202
url: {
188203
title: 'url',
189-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#url',
204+
url: [
205+
{
206+
text: 'Click here to see the documentation for url.',
207+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#url'
208+
}
209+
],
190210
description: 'URL of the landing page/website for the work',
191211
examples: [
192212
'https://citation-file-format.github.io/'

‎src/components/ScreenStart.vue‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,22 @@ export default defineComponent({
122122
const helpData = {
123123
type: {
124124
title: 'type',
125-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#type',
125+
url: [
126+
{
127+
text: 'Click here to see the documentation for type.',
128+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#type'
129+
}
130+
],
126131
description: 'The type of the work that is being described by this CITATION.cff file.'
127132
},
128133
title: {
129134
title: 'title',
130-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#title',
135+
url: [
136+
{
137+
text: 'Click here to see the documentation for title.',
138+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#title'
139+
}
140+
],
131141
description: 'The name of the software or dataset.',
132142
examples: [
133143
'cffconvert',
@@ -137,7 +147,12 @@ export default defineComponent({
137147
},
138148
message: {
139149
title: 'message',
140-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#message',
150+
url: [
151+
{
152+
text: 'Click here to see the documentation for message.',
153+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#message'
154+
}
155+
],
141156
description: 'A message to the human reader of the CITATION.cff file to let them know what to do with the citation metadata.',
142157
examples: [
143158
'If you use this software, please cite it using the metadata from this file.',

‎src/components/ScreenVersionSpecific.vue‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,12 @@ export default defineComponent({
146146
const helpData = {
147147
commit: {
148148
title: 'commit',
149-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#commit',
149+
url: [
150+
{
151+
text: 'Click here to see the documentation for commit.',
152+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#commit'
153+
}
154+
],
150155
description: 'The commit hash or revision number of the software version.',
151156
examples: [
152157
'1ff847d81f29c45a3a1a5ce73d38e45c2f319bba',
@@ -155,7 +160,12 @@ export default defineComponent({
155160
},
156161
version: {
157162
title: 'version',
158-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version',
163+
url: [
164+
{
165+
text: 'Click here to see the documentation for version.',
166+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#version'
167+
}
168+
],
159169
description: 'The version of the software or dataset.',
160170
examples: [
161171
'1.2.0',
@@ -165,7 +175,12 @@ export default defineComponent({
165175
},
166176
dateReleased: {
167177
title: 'date-released',
168-
url: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#date-released',
178+
url: [
179+
{
180+
text: 'Click here to see the documentation for date-released.',
181+
link: 'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#date-released'
182+
}
183+
],
169184
description: 'The date the work has been released.'
170185
}
171186
}

0 commit comments

Comments
 (0)