Documentation

About the SAI

The Scribe Add-In (SAI) is a plug-in developed for the Microsoft Word environment.

The SAI is designed to assist with the scribing and copyediting processes within the WFDW.

SAI Tools

See SAI Tools for more information on the features available through the Word ribbon and context (right-click) menu.

SAI Lite

The SAI Lite is a publicly available, limited version of the SAI. Authors and freelancers can install the SAI Lite to facilitate manuscript preparation in the WFDW and take advantage of some key features of the SAI.

  • Load ScML Styles
  • Style Galleries
  • Cleanup: Rendering and Scribe Index Fields (all other Cleanup tools are disabled)
  • Index Assistant
  • Insert Query
  • Insert Image
  • Report Styles
  • File Check

Any tools in the ribbon that are grayed out are only available in the full version.

Installation

SAI Software Requirements

The SAI works with the following versions of Word:

  • Word 2013 (PC)
  • Word 2016 (PC)
  • Word 2019 (PC)
  • Word 2021 (PC)
  • Word 2016 (Mac)
  • Word 2019 (Mac)
  • Word 2021 (Mac)

Scribe’s goal is to keep the SAI up to date with the latest edition of Word in Office 365.

Download the SAI

  1. For simple organization, create an “SAI” folder on your computer so all SAI-related files can be saved in one place.
  2. In order for the SAI to work correctly, first download two additional necessary files. They can both be found in the scml-word-templates package. Download this zip file and extract its contents.
    • scr-scmllist.txt Copy this file to your SAI folder.
    • scr-word-template.dot Copy this file to your SAI folder.
  3. To download and install the SAI, log in and go to Downloads. Download the SAI and save the zipped file in your SAI folder.

Install

  1. Unzip SAI-setup.zip, close Word if it is open, and then double-click SAI-setup.doc to open it in Word. If prompted to do so, close any open documents.
  2. Enable macros if prompted.
  3. Fill in the registration information and review the terms. Select I Agree and click OK to send the registration to Scribe (requires an internet connection; a web browser will open, and the registration information will be passed to Scribe’s site).
  4. Word will close automatically. The next time Word is opened, the SAI should be the second tab in the ribbon (after File). In Word 2011, the SAI will appear as a command bar at the top of the screen (and can be moved anywhere). If prompted to set the location of the scr-word-template.dot or scr-scmllist.txt, click OK and do so. Some features will work without one or the other of these resource files, but the SAI may be slower. Some features will not work at all if neither resource is present.

Installing Updates: New versions of the SAI may be installed in the same manner. The locations of the scr-word-template and scr-scmllist files will remain set from the initial installation.

Uninstall

The SAI is installed in the Word STARTUP folder as SAI.dotm. To uninstall, delete this file or move it into another folder. The SAI can be uninstalled in three steps:

  1. Find the SAI.dotm in the Word STARTUP folder.

    If on a PC, the STARTUP folder will likely be located at this address on the computer (replace [USERNAME] with the username): C:\Users[USERNAME]\AppData\Roaming\Microsoft\Word\STARTUP

    If on a Mac, the STARTUP folder will likely be located at this address (replace [USERNAME] with the username): /Users/[USERNAME]/Library/Group Containers/UBF8T346G9.Office/User Content.localized/Startup.localized/Word/

    (Note: “.localized” may not be seen when navigating to the folder in Finder.)

  2. Delete or move the SAI.dotm file.

  3. Restart Microsoft Word.

Error Reports and Support

If an Error Report pops up while using the SAI, click OK to view the Error Log, which can be copied. When contacting Scribe for technical support, please send an email message to support[at]scribenet.com with the following:

  • The Error Log
  • Computer operating system
  • The specific SAI feature(s) being used
  • The file in use (if the error involves a specific file)

The Scribe development team can also be contacted via the Send Feedback option within the SAI.

Troubleshooting

Follow these troubleshooting tips if en errors is encountered while installing or using the SAI.

SAI Settings

The ScML Template and ScML List files must be set correctly for the SAI to function. To check them, open SAI User Settings and go to the SAI Settings tab. Confirm that the ScML Template is pointing to the location of scr-word-template.dot and the ScML List is pointing to the location of scr-scmllist.txt. If those files are incorrect, use the Browse button to navigate to their locations and select them.

If those files are not present, follow the instructions here to download the scml-word-templates zip file and extract its contents.

OneDrive

OneDrive interferes with how Microsoft Word and the SAI understand file paths. If an error occurs while installing the SAI, confirm that the SAI setup folder is not in a folder being synced by OneDrive. Similarly, if an error occurs while using SAI tools, confirm that the ScML Template and ScML List files in SAI Settings are not in folders being synced by OneDrive.

Disappearing SAI Button

When running the Restrict Editing tool to lock or unlock all files in a folder, the SAI button may disappear from the ribbon. This is more likely to occur on a Mac than on a PC. If this happens, close the document and reopen it. If that does not work, close Word, restart the program, and then reopen the file.

Common Installation Errors

When I try to run the installer, I receive an error message that the SAI template cannot be found and that the setup files must be unzipped with the SAI.dotm file in the same directory as the SAI-setup.doc file.

Check that the folder has been unzipped and that SAI-setup.doc is opened from the resulting folder (not from within the zip file). The SAI.dotm file must not be moved out of the folder before attempting to run the installer.

If the error message still appears, check that the SAI setup folder is not in a synced location. If you are syncing to OneDrive, for example, this can interfere with running the SAI-setup.doc file. To work around this, move the entire SAI setup folder to a folder that is not being synced and run the installer from there.

If that also does not solve the issue, the setup file may be blocked from running. Check these settings:

  1. Confirm that macros are enabled: In Word, go to File > Options > Trust Center > Trust Center Settings > Macro Settings. Select “Enable all macros.”
  2. Confirm that the SAI-setup.doc file is not blocked: In the unzipped folder, right-click on SAI-setup.doc and select “Properties.” At the bottom right of the General tab, there should be a checkbox for “Unblock.” Uncheck it if it is checked.
  3. Confirm that the setup file is in a location marked as “trusted” for Word: Go to File > Options > Trust Center > Trust Center Settings > Trusted Locations. If your unzipped setup files are not in one of the listed locations, click “Add new location” and add the folder that they are in.

Close and reopen Word, and then run SAI-setup.doc again.

I received a message on start-up regarding a prerequisite step for Microsoft Word Mac versions for 2016 or more recent indicating that I need to place the Applescript helper file manually.

  1. Navigate to /Users/[USERNAME]/Library in Finder. This can be done by holding the Alt key while accessing Finder’s Go menu. Library will appear in the list of destinations while the Alt Key is pressed.
  2. Look for the folder “Application Scripts.” If this appears as “Application_Scripts” (underscore in place of space), rename it to “Application Scripts.” If this folder does not exist at all, create it.
  3. Within “Application Scripts,” find or create a folder called “com.microsoft.Word” (note the capitalization of “Word”).
  4. Copy the file “scrHelperAS.scpt” from the unzipped setup folder into “com.microsoft.Word.”
  5. Restart Word if necessary.

This SCPT file is required for the SAI to function properly in Word 2016 for Mac.

The installer displayed an error message not listed here. / The installer still isn't working after trying other tips.

If the installer crashes, place the files manually:

  1. Move SAI.dotm into the following folder:

    PC: C:\Users[USERNAME]\AppData\Roaming\Microsoft\Word\STARTUP

    Mac: /Users/[USERNAME]/Library/Group Containers/UBF8T346G9.Office/User Content.localized/Startup.localized/Word/

    (Note: “.localized” may not be seen when navigating to the folder in Finder.)

  2. Mac-only: Move scrHelperAS.scpt into the following folder:

    /Users/[USERNAME]/Library/Application Scripts/com.microsoft.Word/

    If this appears as “Application_Scripts” (underscore in place of space), rename it to “Application Scripts.” If this folder does not exist at all, create it.

  3. Restart Microsoft Word. The SAI should load after a few seconds. (SAI-setup.doc will not need to be run again.)

The installer says that it completed successfully, but the SAI doesn’t appear in my ribbon.

If the SAI does not appear in the ribbon at all, do the following to ensure that there isn’t a local setting in place disabling add-ins:

PC: Go to the File tab and select Options. Select Add-Ins and find the Manage drop-down menu. Select Word Add-Ins and click Go. In the dialog box that appears, select the Templates tab and look for SAI.dotm in the list of Global templates. If it is not checked, check it and click OK.

Mac: Go to the Tools menu and select Templates and Add-Ins. In the dialog box that appears, select the Templates tab and look for SAI.dotm in the list of Global templates. If it is not checked, check it and click OK.

User Settings

SAI Settings

Displays and allows for navigation to the file locations of the ScML Template and the ScML List. Use this to update the file locations of the ScML Word template and ScML list and if their location has changed.

Tip: For PCs, to view the Styles pane automatically when Word opens, check the “View style pane at start-up” option.

Editorial Preferences

Use this to specify style guide and page range format preferences, as well as capitalization dictionaries.

  • Style Guide in Use: Select a style guide: CMOS, APA, or MLA. The Title Case option will use this to determine correct capitalization for the selected style guide. The style guide will also determine the length of quotations checked under the SAI Cleanup: Mark for Editing long inline and short block options when that feature is used.
  • Page Range in Use: Select a page range format: abbreviated or full. This will determine how the SAI Cleanup: Mark for Editing will check potentially incorrect page ranges.

  • Capitalization Dictionaries: If there are uniquely capitalized words that are not covered by a style guide (e.g., iPad, ePub), enter them as a list separated by commas, then click Save Capitalization Dictionary. Name it, when prompted.

    To edit or delete a dictionary, select it from the drop-down and alter the text as desired or click Delete Capitalization Dictionary.

    To implement a dictionary, select it from the drop-down and click Load Dictionary. Multiple dictionaries can be loaded at once. To unload one or more dictionaries, select it/them (Ctrl/⌘ + [click]) from the Loaded Capitalization Dictionaries list and click Unload Dictionary.

Use ‘Fast’ Style Lookup

Speeds up File Check and Report Styles on most files and operating systems. This option is deselected by default. It can occasionally report styles that aren’t in the main document. The Hub should always be consulted during scribing to confirm all styles have been handled.

Config File Locations

This tab shows the location of files that the SAI and Microsoft Word use to store settings and user data. These are not configurable within the SAI but are determined by the computer’s operating system and the version of Word.

These locations can be used as part of a troubleshooting process that may require checking or replacing files.

On Windows: Click on the location to open a folder explorer to the location of the selected file.

On Mac: Navigate to this location manually.

User data files on Macs are located within the Library folder. To access these file locations:

  1. Navigate to /Users/[USERNAME]/Library in Finder. To do this, hold the Alt key while accessing Finder’s Go menu. Library will appear in the list of destinations while the Alt Key is pressed.

  2. Navigate through the folders until the location indicated by the SAI is reached.

  3. If the file location mentioned by the SAI includes a folder that starts with a period, it means that the folder is hidden. To toggle the visibility of hidden folders on a Mac, press Shift + Command + Period.

Set Keyboard Shortcuts

Allows for setting keyboard shortcuts.

To set a keyboard shortcut to any of the SAI’s features, choose the category Macros. Then, in Commands, scroll to any of the commands that begin with SAI and assign a shortcut key code. To set a keyboard shortcut to a particular ScML style, check that the ScML template has been applied to the active document, then choose the Styles category. Then select the style from the styles list and assign a shortcut key code.

Keyboard shortcuts for other Word features can be added from this menu.

Send Feedback

Opens an internet browser window with a form for sending feedback and receiving support; requires an active internet connection. Use this form to report bugs or to make feature requests.

Fields marked with a red * are required. Some information will be filled in automatically if it can be determined. Provide a title and description for the issue being reported. If desired, specify a Scribe contact person who should be notified of the issue report in addition to the development team.

View Readme

Opens the SAI’s ReadMe file; this can be helpful for some basic troubleshooting.