Add a route for validation of a manuscript against template requirements
ManuscriptTemplate objects have various properties which contain the ids of requirements objects, each of which have an
evaluatedObject property which contains the id of the
Given a .manuproj file and a manuscript ID, read the manuscript data from
index.manuscript-json and construct a ProseMirror document from the models.
Given a template ID, read the template data from the
templates-v2.json data published in
Each requirement has a
severity property that determines whether to treat it as a warning or an error.
Use the template data plus additional built-in rules to validate the manuscript according to the following requirements:
Validate min/max word/character counts for the manuscript title (
Validate min/max word/character counts for the whole document (including or excluding references, equations, etc) (
Validate total figure count (
Validate total table count (
Validate total figure + table count (
ManuscriptTemplate objects have a
requirementIDs property, which contains an array of
MandatorySubsectionsRequirement ids (and some other requirement IDs).
MandatorySubsectionsRequirement objects have an
embeddedSectionDescriptions property containing an array of
SectionDescription objects, which have a
subsections property containing an array of subsection descriptions.
SectionDescription requirements can be matched to sections using using the
sectionCategory property of the
SectionDescription object and the
category property of the section.
Validate required sections (use the
requiredproperty on the
Validate section order (use the
priorityproperty on the
SectionCategoryobject linked from the
Validate extra sections that aren't in the template?
Validate min/max word/character limits for each section (
Validate min/max word/character limits for each section title (
- Validate that each section has content in its title.
- Validate that each section has content in its body.
Validate the total number of references (
- Validate bibliography items: detect missing or malformed metadata fields (e.g. DOI, author name components, dates).
Detect figure images in unexpected format / media type (
Detect figure images in too low/high resolution (