BCMS runs ALL XML it WRITES against PMC style checker BEFORE uploading files to BCMS and sending them to PMC ingest
Context
A lot of XML written by BCMS is not valid against the BITS DTD or compliant against the PMC Style Checker. This is minimal acceptance criteria for ALL XML written by the BCMS. Thus, the BCMS should run ALL XML it WRITES against the PMC style checker BEFORE uploading files to BCMS and sending them to PMC ingest because this will report validation and style checker errors that prevent loading.
Proposal
The BCMS should run ALL XML it WRITES against the PMC style checker BEFORE uploading files to BCMS and sending them to PMC ingest because this will report validation and style checker errors that prevent loading. The NCBI supported PMC style checker is available here: https://www.ncbi.nlm.nih.gov/pmc/tools/stylechecker/
The Online PMC Style Checker is an interactive tool which provides a detailed report of all items in a document tagged using the NLM Book DTDs that do not comply with the Bookshelf Tagging Guidelines. The report will list items as either warnings or errors. Errors are required fixes, and warnings are suggested fixes. BCMS only needs to log immediate bug issues for maintenance for errors.
A downloadable XSL is available at: https://www.ncbi.nlm.nih.gov/pmc/pub/stylechecker-info/
Any errors running these tools will be reported immediately as Loading errors assigned to PMC with notifications to Coko project management / developer to address and prioritize as part of maintenance.
Design
Acceptance criteria
-
XML that the BCMS writes will be valid against BITS DTD and compliant against PMC style checker
Definition of ready
-
BCMS User Story / Context has been well defined -
The priority of the user story is specified and agreed -
Digital assets added (design, database scheme, mockups etc if relevant) -
Coko Technical Proposal approved by NCBI -
Testable Acceptance Criteria approved by NCBI -
Estimate of effort to complete (time or points) -
The issue has been broken down into development tasks (if necessary) -
Requirements Clarified -
The product owner and development team agree that the user story is ready for development -
NCBI adds “Dev_Ready”
Definition of done
-
All coding tasks are finished and implemented -
QA approved -
Deployed and tested on “ncbidev” (by Coko team) -
Deployed and tested on “ncbi” (by NCBI team) -
Acceptance Criteria Met
Implementation
Alternative approaches (if applicable)
Scheduling
-
Milestone is linked -
Iteration is linked -
Dependencies: ("None" or list issue numbers if relevant) -
Development estimate is added to issue time tracking