Documentation

Sublime Text Checks

Run the Sublime Text Checks packages in Sublime.

Sublime Text and the Scribe packages must be installed.

Check 1: Text Patterns

  • Open the .sam or .scml file on which to run the tool.
  • In Sublime, navigate to Scribe Inc. > Check > Check 1: Text Patterns.

This tool will run all of the regular expressions from the Regular Expressions Resource.

A new file will open with the results. Any search that yielded results will appear in the file along with the number of matches found.

Check 2: Titles, Phrases, Alt Text, and Indexes

  • Open the .sam or .scml file on which to run the tool.
  • In Sublime, navigate to Scribe Inc. > Check > Check 2: Titles, Phrases, Alt Text, and Indexes.

This tool will review several text patterns, comb through the results for important information, and report potential issues and inconsistencies in two results files.

-checks2report

This file will filter out potential mismatches in titles and phrases (both in italics and within quotation marks) as well as certain issues involving small caps.

It will also pull all the image callouts to identify if any are missing alt text or contain exact duplicates, which might indicate that the wrong alt text has been applied to an image.

It will pull indexes and indicate issues that may indicate improper formatting or require manual intervention to link when producing ePub files. Index checks can only be run on .scml files.

-checks2lists

This file will include the complete lists of italic, small caps, and phrases within quotation marks.

Check 3: OCR Review

  • Open the .sam or .scml file on which to run the tool.
  • In Sublime, navigate to Scribe Inc. > Check > Check 3: OCR Review.

This tool will run all of the regular expressions from the OCR Modification page.

A new file will open with the results. Any search that yielded results will appear in the file along with the number of matches found.

Text Patterns (Custom)

Configuring Text Patterns (Custom)

  • In Sublime, navigate to Preferences > Browse Packages.
  • Enter the subfolder User.
  • Create a folder under User called scribe-regex-results-custom.
  • In this folder, place any custom search text files.

Creating/Editing Custom Text Patterns

  • Create a .txt file. To add a search, start a line with **Find: ** (including a space after the colon), followed by the regular expression.
  • Other lines can appear in this file to help instruct the user, but only lines beginning with “Find: ” will be treated as a search.
  • Place the file in the scribe-regex-results-custom folder.

Example:

Find: <fig>(.*)
Find: <xref idref="in([^<]*)">([^<]*)</xref>

Running the Tool

This works similarly to Check 1: Text Patterns, but it reads the search expressions from the customized local file instead of the Regular Expressions Resource page.

  • Open the .sam or .scml file on which to run the tool.
  • In Sublime, navigate to Scribe Inc. > Check > Text Patterns (Custom).
  • A dropdown list will appear with all of the .txt files saved in the scribe-regex-results-custom folder. Select the file with the searches to be run.

A new file will open with the results. Any search that yielded results will appear in the file along with the number of matches found.