Documentation

SAI File Management

File management tasks within the SAI.

Load ScML Styles

Loads the ScML template into the active document.

New ScML Document

Creates a new document loaded with the ScML template. This feature relies on the template location provided under Set Preferences.

Restrict Editing

Lock or unlock current file for editing. Easily lock a file prior to sending it to the author to force the use of track changes. To lock a file without a password, leave the password field blank when prompted to set one.

Split Document

Splits the document at Word section breaks into one file per section.

Word section breaks can be added manually, or they can be placed automatically by the SAI at recognized chapter breaks.

  • To add section breaks manually, select the Page Layout tab in the Microsoft Word Ribbon. Select Breaks and chose one of the section break types.
  • To add section breaks at chapter breaks, run Add section breaks before ScML chapter styles, available in the Note Manager.

A number is appended to the end of each file name to indicate the order of the output files. The new documents are saved into the same folder where the source file is located.

A file with two section breaks called filename.docx will output three files in the same folder.

  • filename-01.docx
  • filename-02.docx
  • filename-03.docx

File Reports

Vet File

Reports the count of different punctuation patterns and Word elements that require special handling prior to upload to the Digital Hub (such as equations). Use the Report Styles tool or the Digital Hub for information about character and paragraph styles.

Report Styles

Reports subsets of styles in use in a document or documents. The main button will provide a report of any non-ScML styles found in the active document. This is a useful check to run on composed files. It is also useful to run at the beginning of your work to help determine mapping (associating styles) to ScML. If Selected Documents is chosen, styles are reported for each document as well as the aggregate. You can choose to generate lists of four possible subsets of styles in either the active document or multiple documents. A browse window will open if you want to report styles from multiple documents. Note: For long documents or documents with many styles, this feature may take a couple minutes to complete.

  • All Styles: Reports all styles used in the active or selected documents.
  • Built-In Styles: Reports any Word built-in styles used in the active or selected documents.
  • User-Defined Styles: Reports any non-built-in styles used in the active or selected documents.
  • Non-ScML Styles: Reports all non-ScML styles in the active or selected documents.

To view an entire report once it is generated (if it has a long list of styles), select the text (Ctrl/⌘ + A), copy it (Ctrl/⌘ + C) from its window, and paste it in a Word or text document. Mac users may use the Copy to Clipboard button if the keyboard shortcut doesn't work.

Find Rendering Overrides

Identifies potentially problematic text formatting at the character level in source documents that are unlikely to be captured during a typical composition process. Selects the first piece of text after the current cursor location where problematic conditions are found:

  • local formatting applied over non-ScML character styles
  • atypical text features of Microsoft Word used to capture structural meaning
  • font sizes that significantly differ from their paragraph and character styles

This tool is useful when vetting or composing files that have been OCRed, that have a large number of nondescript non-ScML character styles, or that have been modified extensively outside the rules of the WFDW. This tool may take a long time to run on large or complicated files and has limited compatibility with Word for Mac.

File Check

Checks file for common errors prior to upload to Scribe’s Digital Hub.

This feature will accept all changes, create a report of any non-ScML styles, compare the number of note references to notes (they should match), and list any image callouts. The File Check report will indicate success or failure via a green checkmark or a red warning symbol. If the File Check fails, check the report for items that require action (like mismatched endnotes or non-ScML styles).

To view the full text of the File Check output when the dialog box appears, select the text, copy it from its window, and paste it into a Word or text document.