Spelling and Grammar Checker Plug-in

Creating an SVRL file

To create an SVRL file with the spell-checker plug-in use the text-rules transform with the --args.validate.mode=report parameter.

• From a terminal prompt move to the directory holding the document to validate
• SVRL file creation can be run like any other DITA-OT transform:

dita --format text-rules \
    --output out \
    --input document.ditamap \
    --args.validate.mode=report

Once the command has run, an SVRL file is created:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<svrl:schematron-output>
  <active-pattern role="dita" name="/incorrect-spelling.dita"/>
  <fired-rule context="common" role="grammar"/>
  <fired-rule context="default-lang" role="spelling"/>
  <failed-assert role="error" location="/topic/body[1]/section[2]/p[1]">
    <diagnostic-reference diagnostic="incorrect-spelling">
      Line 17: p - [incorrect-spelling]
      The word 'separate' is spelt incorrectly ('seperate') in the following text:

      Seperate accommodation can be found within the main building...
    </diagnostic-reference>
  </failed-assert>
  <fired-rule context="default-lang" role="grammar"/>
  <fired-rule context="english" role="grammar"/>
</svrl:schematron-output>

Echoing results to the command line

To echo results to the command line with the spell-checker plug-in use the text-rules transform without specifying a report.

• Spell-checking (text-rules) can be run like any other DITA-OT transform:

dita --format text-rules \
    --input document.ditamap

Once the command has run, all errors and warnings are echoed to the command line:

[ERROR]  [/topics/incorrect-spelling.dita]
 Line 17: p - [incorrect-spelling]
The word 'separate' is spelt incorrectly ('seperate') in the following text:
Seperate accommodation can be found within the main building.

Additionally, if an error occurs, the command will fail:

[ERROR]  [/topics/incorrect-spelling.dita]
 Line 17: p - [incorrect-spelling]
The word 'separate' is spelt incorrectly ('seperate') in the following text:
Seperate accommodation can be found within the main building.
Found 1 Errors 0 Warnings
Error: [SVRL001F][FATAL] Error: Errors detected during validation

Auto-correction from the command line

To auto-correct spelling mistakes with the spell-checker plug-in use the auto-correct transform.

• Auto-correction (auto-correct) can be run like any other DITA-OT transform:

dita --format auto-correct \
    --input document.ditamap

Once the command has run spelling mistakes will have been removed from the document.

Parameter Reference

• args.validate.ignore.rules - Comma separated list of rule IDs to be ignored
• args.validate.blacklist - Comma separated list of words that should not be present in the running text
• args.validate.cachefile - Specifies the location of cache file to be used. Validation will only run across altered files if this parameter is present
• args.validate.check.case - Comma separated list of words which have a specified capitalization
• args.validate.color - When set, errors and warnings are Output highlighted using ANSI color codes
• args.validate.mode - Validation reporting mode. The following values are supported:
  • strict - Outputs both warnings and errors. Fails on errors and warnings.
  • default - Outputs both warnings and errors. Fails on errors only
  • lax - Ignores all warnings and outputs errors only. Fails on Errors only
  • report - Creates an SVRL file
• svrl.customization.dir - Specifies the customization directory
• svrl.filter.file - Specifies the location of the XSL file used to filter the echo output. If this parameter is not present, the default echo output format will be used.
• text-rules.ruleset.file - Specifies severity of the rules to apply. If this parameter is not present, default severity levels will be used.

Removing a rule globally

Rules can be made inactive by altering the severity (see above). Alternatively a rule can be commented out in the XSL configuration file.

Ignoring a rule throughout a document

Individual rules can be ignored by passing the args.validate.ignore.rules parameter to the command line. The value of the parameter should be a comma-delimited list of each rule-id to ignore.

For example to ignore the latin-abbreviation validation rule within a document you would run:

dita -f text-rules-echo --input document.ditamap \
    --args.validate.ignore.rules=latin-abbreviation

Ignoring a specific instance of a rule

Specific instances of a rule can be ignored by adding a comment within the *.dita file. The comment should start with ignore-rule and needs to be added at the location where the error is flagged.

<!--
    This is an example of a spelling mistake
-->
<p>
    <!-- ignore-rule:incorrect-spelling -->
    I have deliberately misspelt the word accidentaly (sic) - it should be written with a double l.
</p>

Ignoring all warnings/errors within a block of text

• A block of DITA can be excluded from firing all rules at WARNING level by adding the comment ignore-all-warnings to the block.

• A block of DITA can be excluded from firing all rules at ERROR level by adding the comment ignore-all-errors to the block.

• Rules set at FATAL level cannot be ignored.