Executing Inspections

This article explains what inspections are and how to run an inspection module, group, or set in OnStyle. It also outlines the differences between Global and Custom Inspection Sets.

What is an Inspection, an Inspection Group, and an Inspection Set?

The Inspection Module is the basic unit of validation designed to detect a specific type of formatting or style issue. Inspections can be grouped (Inspection Group), and groups can be organized into sets (Inspection Set).

Inspection Groups are predefined lists of Inspection Modules. Each group is designed to check for a particular set of issues, such as formatting errors or problems in document elements like headings and hyperlinks.

An Inspection Set is a collection of Inspection Groups .

There are two types of Inspection Sets:

• Global Inspection Set: A predefined, built-in, and not editable by users (read-only).
• Custom Inspection Set: Configurable by users

With one click, you can run a single inspection, an inspection group (all active inspections within that group), or an inspection set (all active groups within that set).

How to Execute a Single Inspection

1. Locate the ‘Validation’ tool group on the OnStyle tab.
2. Click the down arrow of any inspection group to open its drop-down menu. If you click the group name instead, all items of the group will run.
3. From the drop-down, choose ‘Inspection Group Modules’, then select the desired inspection (e.g., ‘Page Number Missing’) to begin validation.
4. OnStyle will then validate your document using the selected inspection. The selected inspection module can be executed even in an inactive state.

Click to enlarge

How to Execute an Inspection Group

1. Navigate to Validation tool group on the OnStyle menu.
2. Click the name of the Inspection Group
3. OnStyle will validate the document using all active Inspection Modules of the Inspection Group.

Click to enlarge

How to Execute an Inspection Set

To execute a set of inspections:

1. Open your document in Word.
2. On the OnStyle ribbon, locate ‘Validation’ tool group.
3. Choose Global or Custom Inspection Set. (Custom Inspection Set is available in Professional version only).
4. Click Execute Set.
5. OnStyle will then validate your document using the selected set of inspection modules.
6. Review the findings displayed on the Inspection Results pane.

Important

Validation can be executed without a DocConfig. Some inspection modules and authoring tools depend on configuration; results may vary.

Warning

Do not close Microsoft Word while an Inspection Set is executing to avoid incomplete results.

Tip

Use Edit Selected Set to include or exclude specific Inspection Groups and tailor validation to your workflow. Editing is only available when Custom Inspection Set is selected.

Best Practice

Save the document before running extensive validations. Commit fixes in logical batches before re-executing validations.