Link to NCBI documentation to resolves errors (Conversion workflow specific) on the Error tab UI
Context
How to resolve errors in files is dependant on the conversion workflow. Users should be provided with only the necessary in-app information and link to the NCBI-hosted detailed documentation to resolve errors.
Currently the text says the below, which was written at the stage of development for the Word WF
Bookshelf errors are automatically reported to NCBI to resolve. View the NCBI Bookshelf Author Guide for guidance on resolving submitter errors or select ‘Show help’ below.
Error Severity
- Error: must be fixed to successfully process submissions.
- Warning: should be reviewed for potential tagging issues.
- Query: should be addressed to ensure quality assurance.
Proposal
NCBI to check (and updated, if necessary) the text in the UI to ensure it makes sense for all workflows, and provide link to the relevant NCBI-hosted user documentation.
This is required on the following pages:
The errors tab of a:
- Collection TOC
- Chapter-processed Book TOC
- Wholebook
- Word Complete book
- Chapter
Design
No design changes should be necessary
Implementation (if applicable)
[A description of the steps to implement the feature.]
Alternative approaches (if applicable)
[Include any alternatives to meet this use case.]
Open issues (if applicable)
[Links to and a discussion of related issues, if applicable.]
Issue history: created 11 June, 2021
As discussed yesterday, currently the Error tab UI links to NCBI documentation relevant to the Word WF. Please provide the link that users should see for XML and PDF workflow and the text for the link.