Check the following to confirm the quality of a .scml file:
Metadata and Validation
Digital Hub Project Information
All available information should be present in the Hub record‘s Project Information tab.
This includes the following: Title, Publisher, BISAC Subject Codes, Print and E-book ISBNs, Creators and Contributors, and Extended Metadata (Additional Descriptive Data and Additional Titles).
Validating the File
Online validation: The Digital Hub should report no errors.
Local validation: The DTD validation tool in Sublime should report no errors.
Distinctive Elements and Character Details
Examples: sidebars, tables, letters, special character styles, and special characters.
Do special characters match those in the source?
Except for ampersands and less-than and greater-than signs (which must be HTML entities rather than literal characters), do not use both literal special characters and (decimal or hex) HTML entities in the same .scml file.
Review the stats in the Digital Hub to obtain a list of special characters.
Check the file for combining Unicode characters. There should be no combining Unicode, and ligatures should be converted to the corresponding individual letters.
If necessary, find special characters locally and run the second Find All search, then copy and paste the selected characters into a new document. Permute the file to sort by unique characters, removing duplicates.
Examples: The impression line (10 9 8 7 6 5 4 3 2 1); statements about where or by whom the book was printed; any references to fonts or the physical layout (“the image on the top right”).
Except for projects where the index should be linked or where there are credits for specific pages, references to page numbers within the publication should be modified (so they still make sense when published in a form without fixed page numbers), linked, or commented out.
Examples: “opposite” or “facing page”
For “continued” index entries, have the page IDs been retained and paragraphs recombined?
For “continued” table entries, have all page IDs been retained, duplicate table heads and table column heads removed, and content recombined into a single table?
Each section (including the title page, dedication, copyright page, and table of contents) should be in its own <chapter id=""> division with a unique ID.
See ScML documentation for a complete list of structural elements.
Contiguous elements of the same kind, such as stacked epigraphs or sidebars, should each have their own set of structure indicators.
Check that the text used on the cover (title, author name) matches the text in the file. Compare with the half title page, title page, and copyright page in particular.
If the ISBNs include hyphens, are they in the correct positions?
Table of Contents
For an ePub, there must be a table of contents in the .scml file (even if the source does not have one).
Example: <img src="scr-example-fig0101.jpeg"/>
The figure structure indicators should enclose each group of figure elements (e.g., fig, figh, and figatr).
Figure file names should only use a file extension of a permitted type (.jpg, .jpeg, .png, or .svg).
Decorative Images and Logos
If a logo image is part of the title page, compose it as bkpub (or bkpub1, if necessary) rather than fig.
If a logo image is part of the copyright page, compose it as crtf (or a different crt style, if necessary) rather than fig.
Footnotes and Endnotes
If the footnote or endnote number is followed by a period, the period should be included inside the fnnum or ennum tags.
Check a selection of the following (or similar) terms, depending on the project: appendix, box, chapter, chart, example, exercise, figure, illustration, map, part, plate, page, section, see, and table.
Determine how extensively to link internal references based on the project requirements.
Scribe default: If a general site name is immediately followed by a more specific url, the general site does not require url tags.
Tabs, Ellipses, and Angle Brackets
There should be no tabs in a file intended for conversion to ePub.
Note: Some projects may require a consistent treatment of ellipses while others may require variations be maintained.
Three Periods: If three periods in a row must be kept together with no visible space, have zero width nonbreaking spaces been added between the periods?
Spaced Periods: If ellipses consist of spaced periods, have regular nonbreaking spaces been added between the periods?
Ellipsis Character: If required for a project, has the ellipsis character (…) been used consistently?
In most cases, a nonbreaking space should precede the ellipsis to connect it to the preceding text. In some cases, a nonbreaking space should appear after the ellipsis to connect it to the text that follows.
Bible File Checks
For Bible .scml files, perform the following additional checks.
Incorrect: 1 P<sm>eter</sm> <xbr t="1Pe 2:4">2:4</xbr>
Correct: <xbr t="1Pe 2:4">1 P<sm>eter</sm> 2:4</xbr>
The Meshach script often will miss book names and references in ancillary material that have a character style, and those will need to be linked using the Abednego script.
They should include a “1” in the chapter number position, so the verse number is not misinterpreted as a chapter number.
Example: It should result in <xref idref="v57001007">Philemon 7</xref> (rather than “idref="v57007001"”) for this verse.
In a duplicate of your .scml file, add chapter number to one-chapter books:
Find: (<xbr t=")(Ob|Phm|2Jn|3Jn|Jud|Pr Az|Bel|Sus|Pr Man|LJe)( )([0-9-]+")
Replace with: \1\2\31:\4