Documentation

Composition QC

Check the following to confirm the quality of a composed Word document:

File Requirements

Track Changes and File Extension

Files must be .docx for use in the Digital Hub.

File Check

File Alerts

If working offline, does File Check from the SAI reveal any errors?

If the Digital Hub lists footnote or endnote mismatch that cannot be found in Word, does running “Clean note markers" from the SAI Cleanup window resolve the issue?

If the Digital Hub lists other warnings that cannot be found in Word, does converting the file to .sam clear out the issue?

File Stats

Cleanup

Leftover Tags

Example: <TX1>

Comments

Some comments may be kept if editorial tasks will follow.

Paragraphs

There should be none.

Titles and Heads

Scribe default: Use title case for titles and heads. This may be unnecessary if going straight to e-book.

Structure Indicators

Front Matter

An explanation of structure indicators is found here.

Unique Sets

Complex Structures

Paragraphs

Check for Non-ScML Styles

Hard Returns

Do not use soft returns to indicate line breaks.

Articulation

Apply style variations (f, l, s, or o) for spacing as needed.

Use the Digital Hub’s Refiner to apply spacing rules to a crude composition.

Notes

Characters

Check Character Styles

Unicode

Example: Combining unicode characters should not be used, and characters should not be rendered by legacy fonts. Individual unicode characters should be used in both of these cases.

Review the stats in the Digital Hub for a list of all characters used in the file.

Paragraph-Specific Styles

Examples: fighn; dispk; ennum

Figures and Images

Call-Outs

Heads and Captions

Tables and Tabs

Formatting

Tabs

Example: chapter number [tab] TOC listing [tab] page number.

E-book Check

Text Checks

Convert the .docx to .sam in the Digital Hub and run the following searches.

URLs

Scribe default: If a general site name is immediately followed by a more specific url, the general site does not require url tags.

The following search is inclusive and might find some abbreviations or file names in addition to URLs.

Examples: em dashes, en dashes, or spaces.

Missing Spaces around Tags

Hyphen Spacing

Spaces around Punctuation

The following search is inclusive and might find some abbreviations, file names, or URLs in addition to dropped spaces.

Opening and Closing Spaces

Duplicate Spaces

Incorrect Line Breaks

Do a “case sensitive” search using the following expression. It is inclusive and might find some lines that correctly begin with lowercase letters.

Incorrect Hyphenation

Do a “Find All” search using the following expression. Paste the results into a separate text file to review for potentially incorrect hyphenation.

Small Caps

Find all and paste into a new document to review results.

ISBNs

If necessary, the following expression can be used to replace en dashes or em dashes with hyphens: \1-\3-\5-\7-\9