StyleGuard FAQ

Table of Contents

Topics

1.
StyleGuard System Requirement

PC

1)
Operating System: Windows XP or hihger
2)
Word: Office 2007 or higher (except Office Starter edition,) or Word 2007 or higher
3)
Outlook: Office 2007 or higher (except Office Home and Student edition and Starter edition,) or Outlook 2007 or higher
4)
Note: StyleGuard does not support Office 2003

Mac

1)
Operating System: OS X 10.6.8 or above (Snow Leopard), 10.7 (Lion) or 10.8 (Mountain Lion)
2)
Office: Office for Mac 2011
2.
StyleGuard Prerequisites

Windows (Windows XP-Windows 8)

1)
Microsoft .Net Framework 4.0 (installed as part of the StyleGuard setup; click here to install directly from Microsoft)
2)
Microsoft Visual Studio 2010 Tools for Office Runtime (installed as part of the StyleGuard setup; click here to install directly from Microsoft)

Mac (OS X 10.6.8-10.8.3)

1)
Ensure VBA for Office for Mac is installed on your machine

To verify whether VBA is installed and working, start Microsoft Word, click Tools->Macros->Record New Macro. If the message "Cannot Record Macro" pops up, it means VBA is not working.

If you had done a custom install of Microsoft Office and uncheck Visual Basic for Applications, VBA will not be installed. To fix this, locate your Office CD, run the installer and do a custom install and choose to install only VBA. This method works most of the time. If this doesn't work, you will have to completely remove Office 2011 and then reinstall (and remember to ensure the VBA option is checked in your custom install).

2) 
Ensure your version of Safari is 5.17 or above

If you have update your system regularly, your version of Safari should already meet the minimal requirement to support StyleGuard. To update Safari immediately, choose System Preferences from the Apple Menu, choose Software Update from the view menu, and click Update Now. Select Safari and click Install.

3) 
You have failed to install the Mono runtime 2.10.9 (installed as Step 1 of the StyleGuard setup). Click here to download the Mono Framework and install it.
 
3.
StyleGuard Installation Instruction
4.
How To
 
4.1
How do I know what version of StyleGuard and style collections I am using?

Ribbon button to launch the StyleGuard about dialog

Select the StyleGuard tab in the Word Ribbon and click the small button under the Show Informational Entries to bring up the About dialog.

Mac StyleBuard Version Information

Click the StyleGuard and in the StyleGuard menu select About StyleGuard to bring up the version information.

4.2
How can I use StyleGuard to check my existing documents?
  • For the Windows version:

To check an existing document, open the document in Microsoft Word and click on the Full Scan button in the StyleGuard ribbon.

  • For the Mac version:

To check an existing document, open the document in Microsoft Word and start the StyleGuard application in the App Folder. StyleGuard by default checks all documents opened in Word.

4.3
For the Windows version, how do I have StyleGuard check only paragraphs that I have edited or are newly created in an existing document, especially if the existing document is large?

When StyleGuard opens an existing document, it doesn't automatically scan the entire document. It only scans newly created text and edited text. For example, if you are being asked to update a section of a large document, you will simply open that document and made the necessary changes. StyleGuard will be smart enough to only scan the paragraphs that changes have been made.

Hint: If you have other paragraphs in the document that you would like StyleGuard to check but you do not want to do a full scan, you can simply add a few characters at the end of those paragraphs to initiate a scan for those paragraphs. After the scan is done, undo those edit and fix the potential problems that StyleGuard found.

4.4
How do I speed up the checking of my document using StyleGuard?

StyleGuard checks many rules (more than 18,000 rules in the 2014 AP Stylebook). To reduce scanning time, disable style collections that are not appropriate for the current document and uncheck "Show Informational Entries."

4.5
Can I have StyleGuard check my document only when I ask it to?
  • For the Windows version:

StyleGuard ribbon display with enable auto scan selected

You can disable Enable Auto Scan, which will disable any automatic checking by StyleGuard. Perform a Full Scan when you would like the document to be checked.

  • For the Mac version:

StyleGuard toolbar for Mac showing enable auto scan button

You can disable the scanning of document by "stopping" StyleGuard.

4.6
After StyleGuard checks a document and finds style errors, is there a way to annotate those errors for later review by myself or my colleague?

After you position the cursor within a word that StyleGuard underlines with a purple squiggly line, you can either select the Insert Comment command in the StyleGuard pane or the right-click context menu. StyleGuard will insert relevant style information as a Word comment associated with that word.

4.7
For the Windows version, how to I ensure that documents I sent to my colleague contains no purple squiggly underlines created by StyleGuard?

If you are using Word 2010, Word will automatically remove all StyleGuard related information upon saving the documents.
If you are using Word 2007 and the documents you save contain the purple squiggly underlines, then you have a version of Word 2007 that was released prior to January 2010, please apply the patch Update for Microsoft Office Word 2007 (KB974631):

http://www.microsoft.com/en-us/download/details.aspx?id=9

When saving a file with StyleGuard information in it, Word will display the following dialog:

Error message about missing XML support

Clicking OK will save the file without the squiggly underlines. You can also check Don't show this message again to avoid being prompted every time a file is saved.

Note: If you have Word 2007 and decide not to apply the patch for KB973631 mentioned above, you can avoid Word 2007 from saving the StyleGuard information that causes the purple squiggly underlines to be displayed in you saved document by first disabling StyleGuard before saving the document. When StyleGuard is disabled, it will remove all purple squiggly underlines from your document.

4.8
How can I disable seeing SGTag in my document like what is being shown below?

StyleGuard XML tag when show XML tags is on

SGTag is being created by StyleGuard to keep track of style information. Pressing Ctrl+Shift+X will toggle the display of the SGTag.

4.9
How can I install StyleGuard if my user account does not have administrator privilege?

During installation, StyleGuard sets up keys in the installing user's registry, which are not accessible by other users of the computer. This will prevent other users from using StyleGuard even though StyleGuard is installed.

Please follow these steps to install StyleGuard for users with non-administrator privileges:

a) Download the appropriate installer program at https://style-guard.com/download.aspx and save it on your computer.

On Windows 7:

1. Run the installer program.

2. Supply the username and password of the user who has administrator privileges when prompted. (Note: The prompt should appear twice.)

On Window XP:

1. Run the installer program using the "Run as" command and supply the username and password of the user who has administrator privileges.

2. After installing StyleGuard, download the tool: https://style-guard.com/download/SGRegTool.exe

3. Run SGRegTool.exe using the "Run as " command and supply the username and password of the user who has administrator privileges.

a. Click "Save Current User StyleGuard Setting"

StyleGuard debug panel dialog

b. Click OK, if necessary, until you see the "Registry keys saved to:" dialog:

StyleGuard debug dialog showing results of saving registry keys

4. Run SGRegTool.exe (as the current user, who will be using StyleGuard).

a. Click "Import Saved StyleGuard Setting"

StyleGuard debug dialog showing import settings option

b. Click Yes and OK, if necessary, until you see the "Registry keys imported from:"dialog:

Confirmation dialog

Note: For Windows XP, an alternative is to log in as the user with administrator privileges and run the steps that require "Run as ..."then log in as the user who will be using StyleGuard and run the last step to "Import Saved StyleGuard Settings."

b) Start Microsoft Word and activate "AP Stylebook" to start using StyleGuard.

4.10
How do I check for updates to my existing style collections?
Important Notice for All 2013 AP Stylebook Collection Users

** Note ** You must have an active subscription to download and activate the latest version of the AP Stylebook collection.

Apple Icon For Macintosh Version of StyleGuard
If you have a downloaded and installed a version of StyleGuard *before* Jan. 2014 you will need to uninstall and then download the latest version. If you choose this installation method the following steps will not be necessary as the download includes the latest AP Stylebook collection. Click here to go to the download page.

Follow the instructions below to check to see if you have the latest version of a Style Collection and how to get an update if it is available.

  • Start StyleGuard.
  • Click on the “Style Collections” button.

    StyleGuard Style Collections button

  • If your style collection is up-to-date, you should see the “Disable” button and not the “Update” button.

    Style Collections Update button

  • If a newer style collection is available, you will see the “Update” button.

    Style Collections Update button

  • Click on the “Update” button, and confirm that you want to overwrite the old version.

    Confirming style collection update

  • After the update completes, the “Update” button would be replaced by the “Disable” button.
Windows Icon For Windows Version of StyleGuard
If you have a downloaded and installed a version of StyleGuard *before* Jan. 2014 you will need to uninstall and then download the latest version. If you choose this installation method the following steps will not be necessary as the download includes the latest AP Stylebook collection. Click here to go to the download page.

Follow the instructions below to check to see if you have the latest version of a Style Collection and how to get an update if it is available.

  • Start Microsoft Word or Outlook, depending on your subscription.
  • Click on the StyleGuard tab in the Office Ribbon.

    Microsoft Office Ribbon

  • Click the “Browse Collections” button on the StyleGuard ribbon.

    StyleGuard Ribbon with Browse Collection button highlighted

  • In the “Browse Collection” window, view the current version of a collection by selecting the icon on the left side pane.

    Browse Collection dialog view

  • To check for an updated version of the specified collection, click on the “Download” tab and then click the “Collections” button again. This will make a request to the StyleGuard server to get updated information about your collections.

    View of tabs on Browse Collection dialog

  • If there is an updated version, the following screen will be displayed:

    Display for an updated version alert

  • To update the collection, simply click on the “Here” link
  • The collection will automatically be downloaded and installed on your machine. If the process is successful, the notice above will be replaced with information about the new collection as illustrated below:

    After an style collection has been successfully updated

  • Exit the “Browse Collection” dialog by clicking the “close” button in the upper right-hand corner.

Special Note for 2013 AP Stylebook Collection Users

To verify that you have successfully downloaded and installed the new “2014 AP Stylebook” collection, you should see the following occur before and after the update:

Verifying that a collection has been updated

5.
Troubleshooting

For Windows (Windows XP through Windows 8) and Office 2007 or 2010

5.1
If you receive the following message or similar message when installing StyleGuard (running apsetup.exe from https://style-guard.com/download

Setup has detected that the file 'C:\Users\...\VSTOR40\vstor40_x86.exe' has changed since it was initially published.

See the setup log file located at 'C:\Users\...\install.log' for more information.

Or

Downloading application files image

This is usually caused by security restriction or anti-virus software on your system that prevented the StyleGuard setup program from downloading the needed programs like the StyleGuard prerequisites from the Microsoft website.

Please click the links below to install StyleGuard manually following the steps:

1. http://go.microsoft.com/fwlink/?LinkId=178957

2. http://go.microsoft.com/fwlink/?LinkId=140384

3. Download and run the appropriate installer for your Office application(s):

5.2
StyleGuard tab is not shown in the Word or Outlook Ribbon after a successful installation and activation.

Please request the StyleGuard Add-In Enabling document by sending an email to
support@style-guard.com

5.3
StyleGuard doesn't seem to be doing any checking.
  • Ensure at least one style collection is active.
  • Ensure Enable Auto Scan is on.
  • Type "I sent and an e-mail." StyleGuard should put a purple squiggly line under e-mail.
    If you click within the word e-mail, information about the error should show up in the StyleGuard pane on the right.

Sample text within document with StyleGuard showing errors

  • StyleGuard checks for many issues but only report the errors that have a high degree of certainty. If you would like to see all available relevant style information, check the checkbox next to Show Informational Entries on the StyleGuard tab.

    Note: Enabling Show Informational Entries slows down the processing of a document. Show Informational Entries is most useful during content creation to provide relevant style information of the typed words.

5.4
StyleGuard pane on the right is not shown.
  • Double check to ensure StyleGuard is enabled:

StyleGuard ribbon with enable Auto-Scan active

If StyleGuard is not enabled, click the Enable Auto Scan button.

  • If you open a document and open another document before StyleGuard finished processing the first document, the StyleGuard pane may not show up in the second document. You may need to wait for the first document to finish processing and then click Show Summary to have StyleGuard pane show up. If the StyleGuard pane still fails to show up after the above steps, please restart Word.
  • If the StyleGuard pane doesn't show up for any documents, please restart Word.
5.5
Displaying "Show Summary" shows different information for the same document.
  • When StyleGuard is processing a document, click Show Summary will show the available information for the part of the document that has been processed. Information in Show Summary will not change after a document has been fully processed (scanned).

Note: When StyleGuard is scanning a document, a yellow sticker will pop up with relevant information:

Post-It note display for matched items


For Mac (OS X 10.6.8-10.8.3) with Microsoft Office 2011

5.6
When I run the StyleGuard application, I got the following error message:

Initialization failed error message

You have failed to install the Mono Framework 2.10.9 (Step 1 of the StyleGuard setup). Click here to download the Mono Framework and install it.

5.7
I double-click on StyleGuard in my Applications folder, and the icon bounces a couple of times in my dock, and then disappears and nothing opens.
1.
Start the Finder.
2.
Shift+Command+G
3.
Type ~/.config
a)
There should be a directory EquiomLabs under ~/.config.
  • Delete the directory.
b)
If the Finder failed to locate the ~/.config directory, which might happen if you have done an automatic operating system upgrade and a new user is created with settings (and applications) migrated from the old operating system.
  • Start the Terminal application in the Applications/Utilities folder.
  • Type:
    cd ~/
    mkdir .config
    The above commands should create the ~/.config directory that StyleGuard needs to store its data. You might be for your admin password when executing the mkdir command.
4.
If you have a version of StyleGuard before Jan. 1, 2014, Please download and reinstall a newer version of StyleGuard.
5.
Restart StyleGuard.
6.
You will need to reactivate the AP style collection again.
5.8
After restarting Word and opening a document, StyleGuard asks me to "Choose a folder."

Please refer to the solution for the question above.

5.9
I installed StyleGuard, activated the AP Stylebook style collection and was happily using it. Today, StyleGuard is telling me that my copy of the AP Stylebook style collection is no longer active. When I try to reactivate, StyleGuard indicates that I have exceeded the number of activations the current key is allowed.

Your computer might be changing its name every time it is connected to a different computer network. A different computer name will cause StyleGuard to disable the style collection.

To resolve the problem:

Bring up the Terminal (a system application). To open the Terminal, navigate to your Applications folder, open Utilities and double click on Terminal. You will be greeted with a message similar to this:

Last login: Tue Mar 6 17:21:36 on console
Styleguard-Support-MacBook-Pro:~ StyleGuard$

The last line you see is called the prompt. This will appear after every command you enter and this is where you type your commands. It consists of your computer name, your current directory and your short username. When you first start Terminal, your current directory will be "~" which is short for your home directory (/Users/Your username).

Here's how to change your Mac hostname with the command line and make it permanent:

scutil --set HostName new_hostname

Simply replace new_hostname with whatever you want your hostname to be changed to, for example I want to change my Mac's hostname to SGMacBookPro, I will use this command:

scutil --set HostName SGMacBookPro

(Note the -- before set is two dashes next to each other, --set)

You will be asked for your admin password since you're using the sudo command. After the command is executed you can verify that the changes took place by typing:

5.10
I started StyleGuard but it stated that "No Microsoft Word document is currently active" even though I have more than one Word documents opened.
  • Ensure you have at least one document opened in Microsoft Word.
  • Ensure VBA for Office for Mac is installed on your machine

To verify whether VBA is installed and working, start Microsoft Word, click Tools->Macros->Record New Macro. If the message "Cannot Record Macro" pops up, it means VBA is not working.
If you had done a custom install of Microsoft Office and uncheck Visual Basic for Applications, VBA will not be installed. To fix this, locate your Office CD, run the installer and do a custom install and choose to install only VBA. This method works most of the time. If this doesn't work, you will have to completely remove Office 2011 and then reinstall (and remember to ensure the VBA option is checked in your custom install).

5.11
StyleGuard is not checking my documents.

Ensure StyleGuard is "running" like what is shown below:

Checking document panel display

If not, click the Enable Button to "run" StyleGuard

5.12
Nothing happens when you click on "apsetup.dmg"

Symptom: Nothing happens when you click on apsetup.dmg

Things to check:

  1. Mono runtime (see prerequisites) is installed.
  2. You have permission to create folders under .config.

If your Mac doesn't know how to mount a dmg file you won't be able to install the StyleGuard application.

Steps to manually mount apsetup.dmg using the disk utility application in Mac.

  1. Copy the apsetup.dmg file to your desktop.
  2. Click the apsetupXXXX.dmg file then go to file -> open with -> disk utility

    Opening apsetup.dmg with disk utility

  3. Click on the apsetup_XXXXX.dmg file to expand the file.
  4. Hold down the CTRL key and click on the StyleGuard disk and select "Open StyleGuard."

    Open apsetup.dmg using option menu and selecting StyleGuard.

  5. Follow Step 2 by dragging the StyleGuard icon into the applications folder.

    Instructions on installing StyleGuard.

5.13
StyleGuard tab no longer is diplayed on the Word or Outlook toolbar.
  1. Start Microsoft Word or Outlook, depending on your subscription.
  2. Follow the steps for your application to open the "Options" dialogs. (Steps 1 and 2 in diagrams)

    Access to the Word 2010 options

    Access to the Outlook 2010 options

  3. Click on "Add-Ins" menu option. (Step 3 in diagrams)
  4. In the "Manage" dropdown select "Disabled Items" and then click the "Go..." button. (Steps 4 and 5 in diagrams)

    Manage Add-Ins panel and selection options

    Manage Add-Ins panel and selection options

  5. Select the "StyleGuard Addin for Microsoft Word" or "StyleGuard Addin for Microsoft Outlook" and click the "Enable" button.

    Enable disabled Add-Ins dialog

  6. At this point the StyleGuard tab should be displayed in Word or Outlook.
  7. Restart Word or Outlook to verify that the StyleGuard tab is available on the toolbar.
If you continue to have StyleGuard related issues, please visit: Contact StyleGuard Support
Copyright © 2011-2014 Equiom Linguistic Labs, Inc. All rights reserved. • Terms of Service