Merge pull request #791 from citation-file-format/756-701-text

abelsiqueira · web-flow · commit 315c2dfcd54c · 2022-11-22T17:19:53.000+01:00
diff --git a/cypress/e2e/errors.cy.ts b/cypress/e2e/errors.cy.ts
@@ -80,7 +80,7 @@ describe('From a fixed advanced app', () => {
             cy.checkThatStepperValidityIs(false, 'authors')
             cy.checkThatAppValidityIs(false)
             cy.dataCy('banner-error-messages')
-                .should('contain.text', 'Use the button to add an author')
+                .should('contain.text', 'Add at least one author')
             cy.dataCy('btn-add-author')
                 .click()
             cy.checkThatStepperValidityIs(true, 'authors')
diff --git a/src/components/Keyword.vue b/src/components/Keyword.vue
@@ -5,7 +5,6 @@
                 autofocus
                 dense
                 outlined
-                placeholder="Type a keyword"
                 v-bind:data-cy="'input-keyword' + index"
                 v-bind:label="'Keyword #' + (index + 1)"
                 v-bind:model-value="keyword"
diff --git a/src/components/LayoutLanding.vue b/src/components/LayoutLanding.vue
@@ -43,7 +43,7 @@
             <div class="row justify-center items-center q-pt-md q-mb-xl">
                 <div class="column items-center slide-up-animation">
                     <div style="font-size: 1.2rem">
-                        Generate your CITATION.cff now!
+                        Create your CITATION.cff now!
                     </div>
                     <q-btn
                         aria-label="Create your CITATION.cff file"
diff --git a/src/components/Preview.vue b/src/components/Preview.vue
@@ -40,27 +40,29 @@
             </q-btn>
         </template>
     </q-input>
-    <div class="q-pt-lg text-left">
-        <p
+    <q-card
+        class="transparent"
+        flat
+    >
+        <q-card-section
             data-cy="text-validation-msg"
+            horizontal
         >
-            <q-icon
-                v-bind:class="isValidCFF ? 'text-primary' : 'text-negative'"
-                v-bind:name="isValidCFF ? 'ion-checkmark-circle' : 'warning'"
-                size="40px"
-            />
-            <span
-                v-if="doesNotHaveRequiredFields"
-            >
-                Your CITATION.cff does not have the minimum fields
-            </span>
-            <span
-                v-else
-            >
+            <q-card-actions>
+                <q-icon
+                    v-bind:class="isValidCFF ? 'text-primary' : 'text-negative'"
+                    v-bind:name="isValidCFF ? 'ion-checkmark-circle' : 'warning'"
+                    size="40px"
+                />
+            </q-card-actions>
+            <q-card-section v-if="doesNotHaveRequiredFields">
+                Your CITATION.cff does not have the minimum fields. Make sure the title has been filled and that at least one author was added.
+            </q-card-section>
+            <q-card-section v-else>
                 Your CITATION.cff is {{ isValidCFF ? "valid" : "not valid" }}
-            </span>
-        </p>
-    </div>
+            </q-card-section>
+        </q-card-section>
+    </q-card>
 </template>
 
 <script lang="ts">
diff --git a/src/components/ScreenAbstract.vue b/src/components/ScreenAbstract.vue
@@ -5,6 +5,9 @@
     >
         Abstract
     </h1>
+    <p>
+        Adding an abstract (short description) helps possible users know at a glance if this work is what they are looking for.
+    </p>
 
     <q-input
         aria-label="Abstract/Description of the work. Press tab to reach help button."
diff --git a/src/components/ScreenAuthors.vue b/src/components/ScreenAuthors.vue
@@ -7,7 +7,7 @@
     </h1>
 
     <p>
-        Who are the author(s) of the work?
+        Add all authors of the work. At least one must be provided.
         <InfoDialog name="authors" />
     </p>
     <div>
diff --git a/src/components/ScreenIdentifiers.vue b/src/components/ScreenIdentifiers.vue
@@ -7,7 +7,7 @@
     </h1>
 
     <p>
-        What persistent identifiers are available for the work?
+        You can add persistent identifiers such as DOIs, Software Heritage numbers, or ArXiv URLs.
         <InfoDialog name="identifiers" />
     </p>
     <div>
diff --git a/src/components/ScreenKeywords.vue b/src/components/ScreenKeywords.vue
@@ -7,7 +7,7 @@
     </h1>
 
     <p>
-        What keywords describe the work?
+        You can add as many keywords as you want.
         <InfoDialog name="keywords" />
     </p>
     <div>
diff --git a/src/components/ScreenLicense.vue b/src/components/ScreenLicense.vue
@@ -5,6 +5,9 @@
     >
         License
     </h1>
+    <p>
+        Always add a license. Write in the input below to filter matching licenses.
+    </p>
 
     <q-select
         aria-label="License. Press tab to reach help button."
diff --git a/src/components/ScreenRelatedResources.vue b/src/components/ScreenRelatedResources.vue
@@ -5,6 +5,9 @@
     >
         Related resources
     </h1>
+    <p>
+        The URLs in this section are the main entry point to your work.
+    </p>
 
     <q-input
         aria-label="Code repository. Press tab to reach help button."
diff --git a/src/components/ScreenStart.vue b/src/components/ScreenStart.vue
@@ -3,8 +3,11 @@
         id="form-title"
         tabindex="-1"
     >
-        Start
+        Basic information
     </h1>
+    <p>
+        Indicate whether your work is a software or a dataset, give it a title, and optionally change the default message.
+    </p>
 
     <fieldset
         class="q-mb-md"
diff --git a/src/components/ScreenVersionSpecific.vue b/src/components/ScreenVersionSpecific.vue
@@ -5,81 +5,85 @@
     >
         Version specific
     </h1>
+    <p>
+        The values here identify a specific point in the work lifetime. Remember to update them, for instance, when making a new release.
+    </p>
 
-    <div class="q-gutter-md">
-        <q-input
-            aria-label="Commit identifier. Press tab to reach help button."
-            data-cy="input-commit"
-            label="Commit identifier"
-            outlined
-            standout
-            v-bind:model-value="commit"
-            v-on:update:modelValue="setCommit"
-        >
-            <template v-slot:after>
-                <InfoDialog name="commit" />
-            </template>
-        </q-input>
+    <q-input
+        aria-label="Commit identifier. Press tab to reach help button."
+        class="q-pb-md"
+        data-cy="input-commit"
+        label="Commit identifier"
+        outlined
+        standout
+        v-bind:model-value="commit"
+        v-on:update:modelValue="setCommit"
+    >
+        <template v-slot:after>
+            <InfoDialog name="commit" />
+        </template>
+    </q-input>
 
-        <q-input
-            aria-label="Version. Press tab to reach help button."
-            data-cy="input-version"
-            label="Version"
-            outlined
-            standout
-            v-bind:model-value="version"
-            v-on:update:modelValue="setVersion"
-        >
-            <template v-slot:after>
-                <InfoDialog name="version" />
-            </template>
-        </q-input>
+    <q-input
+        aria-label="Version. Press tab to reach help button."
+        class="q-pb-md"
+        data-cy="input-version"
+        label="Version"
+        outlined
+        standout
+        v-bind:model-value="version"
+        v-on:update:modelValue="setVersion"
+    >
+        <template v-slot:after>
+            <InfoDialog name="version" />
+        </template>
+    </q-input>
 
-        <q-input
-            aria-label="Release date. Press tab to reach help button."
-            hint="Format: YYYY-MM-DD"
-            data-cy="input-date-released"
-            label="Release date"
-            mask="####-##-##"
-            outlined
-            standout
-            today-btn="true"
-            v-bind:model-value="dateReleased"
-            v-bind:error="dateReleasedErrors.length > 0"
-            v-bind:error-message="dateReleasedErrors.join(', ')"
-            v-on:update:modelValue="setDateReleased"
-        >
-            <template v-slot:append>
-                <q-icon
-                    name="event"
-                    class="cursor-pointer"
+    <q-input
+        aria-label="Release date. Press tab to reach help button."
+        class="q-pb-md"
+        hint="Format: YYYY-MM-DD"
+        data-cy="input-date-released"
+        label="Release date"
+        mask="####-##-##"
+        outlined
+        standout
+        today-btn="true"
+        v-bind:model-value="dateReleased"
+        v-bind:error="dateReleasedErrors.length > 0"
+        v-bind:error-message="dateReleasedErrors.join(', ')"
+        v-on:update:modelValue="setDateReleased"
+    >
+        <template v-slot:append>
+            <q-icon
+                name="event"
+                class="cursor-pointer"
+            >
+                <q-popup-proxy
+                    transition-show="scale"
+                    transition-hide="scale"
                 >
-                    <q-popup-proxy
-                        transition-show="scale"
-                        transition-hide="scale"
+                    <q-date
+                        v-bind:model-value="dateReleased ? dateReleased : initializeDate()"
+                        v-on:update:modelValue="setDateReleased"
+                        mask="YYYY-MM-DD"
                     >
-                        <q-date
-                            v-bind:model-value="dateReleased ? dateReleased : initializeDate()"
-                            v-on:update:modelValue="setDateReleased"
-                            mask="YYYY-MM-DD"
-                        >
-                            <div class="row items-center justify-end">
-                                <q-btn
-                                    v-close-popup
-                                    label="Close"
-                                    color="primary"
-                                    flat
-                                />
-                            </div>
-                        </q-date>
-                    </q-popup-proxy>
-                </q-icon>
-            </template>
-            <template v-slot:after>
-                <InfoDialog name="dateReleased" />
-            </template>
-        </q-input>
-    </div>
+                        <div class="row items-center justify-end">
+                            <q-btn
+                                v-close-popup
+                                label="Close"
+                                color="primary"
+                                flat
+                            />
+                        </div>
+                    </q-date>
+                </q-popup-proxy>
+            </q-icon>
+        </template>
+        <template v-slot:after>
+            <InfoDialog name="dateReleased" />
+        </template>
+    </q-input>
 </template>
 
 <script lang="ts">
diff --git a/src/components/Stepper.vue b/src/components/Stepper.vue
@@ -50,6 +50,9 @@ export default {
         const { currentStepIndex, stepName, setStepName, stepNames } = useApp()
         const { errors } = useValidation()
         const toLabel = (name: string) => {
+            if (name === 'start') { // Exception
+                return 'Basic information'
+            }
             return name.split('-').map((s) => s.slice(0, 1).toUpperCase() + s.slice(1)).join(' ')
         }
         const errorStateScreenAuthors = computed(() => {
diff --git a/src/error-filtering.ts b/src/error-filtering.ts
diff --git a/src/store/help-data.ts b/src/store/help-data.ts

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`>`
`6`	`6`	`Abstract`
`7`	`7`	`</h1>`
	`8`	`+ <p>`
	`9`	`+ Adding an abstract (short description) helps possible users know at a glance if this work is what they are looking for.`
	`10`	`+ </p>`
`8`	`11`
`9`	`12`	`<q-input`
`10`	`13`	`aria-label="Abstract/Description of the work. Press tab to reach help button."`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`>`
`6`	`6`	`License`
`7`	`7`	`</h1>`
	`8`	`+ <p>`
	`9`	`+ Always add a license. Write in the input below to filter matching licenses.`
	`10`	`+ </p>`
`8`	`11`
`9`	`12`	`<q-select`
`10`	`13`	`aria-label="License. Press tab to reach help button."`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`>`
`6`	`6`	`Related resources`
`7`	`7`	`</h1>`
	`8`	`+ <p>`
	`9`	`+ The URLs in this section are the main entry point to your work.`
	`10`	`+ </p>`
`8`	`11`
`9`	`12`	`<q-input`
`10`	`13`	`aria-label="Code repository. Press tab to reach help button."`