Service specification
What a delivery includes exactly
This page describes the standard package an editorial manager receives when closing an XML production or remediation project with EditorialXML. It is not a portfolio — it is the operational spec for comparing vendors.
Details can be customized in the proposal (HTML, platform naming, extra rounds). What follows is the baseline unless we agree otherwise.
The signed proposal and Service Agreement prevail over this text. Folder and naming examples illustrate the EditorialXML standard.
Package contents
Per article (or per batch, depending on the contract) the standard delivery includes:
- JATS XML in the agreed Tag Set and version (e.g. Journal Publishing + SciELO SPS rules, or a PMC profile)
- Normalized metadata in the XML (authors, affiliations, DOI, ORCID when available)
- Associated assets: figures, exported tables when applicable, and other files linked from the XML
- Validation report(s) for the contracted profile
- Brief handoff note (what to check on receipt / how to resubmit to the platform)
Folder structure (standard)
We organize the handoff so an editorial team can archive and resubmit without blind renaming. Typical issue layout:
issue-2026-01/
00-manifest.txt
articles/
e012345/
e012345.xml
figures/
e012345-f01.tif
e012345-f02.tif
tables/ (when applicable)
reports/
validation.txt
html/ (only if in the contract)
e012345.es.html
e012345.en.htmlNaming convention
- Stable article identifier (DOI suffix, elocation-id, or journal internal ID — agreed at kickoff)
- XML: `{id}.xml` (or the pattern SciELO/PMC / the journal’s OJS requires)
- Figures: `{id}-f{nn}.{ext}` matching the ids in the XML
- Reports: `validation.txt` or `validation-{profile}.txt` beside the article
- If the platform imposes another scheme, we document it in the proposal and apply it consistently
Validation reports
We deliver quality-control evidence aligned to the destination, not only generic “valid XML”:
- Schema validation for the contracted JATS Tag Set
- When SciELO is the destination: SPS-oriented checks in addition to Publishing
- When PMC is the destination: the profile agreed with the publisher
- Residual findings (if any) prioritized with recommended action
HTML and other derivatives
Per-article or per-language HTML is not in the baseline unless stated in the proposal. When contracted:
- HTML derived from the agreed XML (not a redesign of the journal site)
- One file per language when the bilingual policy requires it
- Asset paths consistent with the delivered XML
Included corrections and timelines
- Baseline: one correction round on findings attributable to our production (markup errors, broken links to assets we delivered, inconsistencies vs the approved source)
- Author content changes or a new PDF after source freeze are usually quoted separately
- Batch timelines are set in the proposal (articles/week or issue date); partial handoff is possible on large projects
Customization
You can request your SciELO/OJS naming, a CSV manifest, or a different ZIP layout. We write it into the proposal so the RFP and the delivery match.
For confidentiality, retention, and submission channels, see Security and confidentiality.
FAQ
Do you always deliver HTML?
No. HTML is optional and quoted when the journal workflow needs it. The baseline is XML + assets + reports.
Is “valid JATS” enough for SciELO?
Not necessarily. SciELO combines Journal Publishing with SPS rules. On SciELO projects we validate with that lens; a generic XSD pass does not guarantee acceptance.
How many correction rounds are included?
The standard is one round on errors from our production. Extra rounds or source changes are agreed in the proposal.
Can you sign an NDA or change the delivery channel?
Yes, on contracted projects. See Security and confidentiality and the project agreement.
Related
Compare against your RFP
If you are evaluating vendors, send your delivery checklist or a sample issue. We will align the package to your workflow and quote clearly.
Request a quote