Repository navigation
Point depositors to LINDAT format recommendations in upload step and FAQ - #196
Merged
Merged
Conversation
Add a sentence to the upload step info alert (en, cs) linking the LINDAT centre page in the CLARIN Standards Information System, restoring the format hint the DSpace 5 upload step had. Repoint the static FAQ (en, cs) from the generic SIS recommended-formats list to the same centre page.
There was a problem hiding this comment.
🔵 Needs a closer look
Active locale catalogs other than English and Czech still lack the upload-step format recommendation.
No open issues 🎉
What changed in this PR
This pull request directs depositors to LINDAT’s recommended file formats during upload and from the English and Czech FAQ pages.
Changes:
- Adds English and Czech upload-step guidance linking to the LINDAT centre recommendations.
- Updates English and Czech FAQ links to the LINDAT centre page.
- Opens the upload link securely in a new tab.
| File | Description |
|---|---|
src/static-files/faq.html |
Updates the English FAQ format-recommendation link. |
src/static-files/cs/faq.html |
Updates the Czech FAQ format-recommendation link. |
src/assets/i18n/en.json5 |
Adds English upload-step guidance and the LINDAT format link. |
src/assets/i18n/cs.json5 |
Adds Czech upload-step guidance and the LINDAT format link. |
Review effort: Lite
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem description
The DSpace 7 submission gives depositors no pointer to our recommended file formats. The DSpace 5 upload step did: its file help text (
xmlui.Submission.submit.UploadStep.file_help) said "When uploading language resources, please try to use one of the recommended formats mentioned in LRT Standards", linking the old CLARIN "Standards for LRT" PDF.The static FAQ ("What submissions do we accept?") links the generic CLARIN SIS recommended-formats list, while our own curated recommendations are on the LINDAT centre page in the SIS, https://standards.clarin.eu/sis/views/view-centre.xq?id=LINDAT. The lindat.cz FAQ pages already link the centre page.
This matters for the CoreTrustSeal renewal, which states that depositors are pointed to our format recommendations during deposit and cites the centre page.
Analysis
submission.sections.upload.info(en, cs): a second sentence is appended to the existing upload step info alert, with the FAQ's wording and a link to the centre page. The alert already renders its content as HTML, so no template or code change is needed. Other language files are left unchanged.src/static-files/faq.htmlandsrc/static-files/cs/faq.html: only the link target changes, fromrecommended-formats-with-search.xqtoview-centre.xq?id=LINDAT.Checks: both json5 files parse and pass eslint;
section-upload.component.spec.tsandalert.component.spec.tspass.Manual Testing (if applicable)
/static/faqin English and Czech and check the link under "What submissions do we accept?".