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

Best practice: Use title case for titles and heads. Review per individual file requirements.

If a cover image is available, does the text in the file match the text used on the cover?

Check formatting, head level, spelling.

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

Review the stats in the Digital Hub for both .docx and .sam for a list of all characters used in the file.

Example: Characters should not be rendered by legacy fonts. Individual unicode characters should be used.

Example: If a combined equivalent exists, combining unicode characters will be resolved to individual unicode characters when converting to another file type in the Digital Hub, but they should be reviewed in the file to confirm they are not being misused.

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.

Note: Some searches will result in false positives.