org.ten60.util.aspell

Home > Books > NetKernel API and Services Reference > Accessor Listing > ASpell Spell Checker > org.ten60.util.aspell

Module

The org.ten60.util.aspell accessor is exported by the urn:org:ten60:util:aspell module. Import this module to gain access to the accessor.

Syntax

URI

active:org.ten60.util.aspell

Argument	Rules	Description
operand	Mandatory	Document to be spell checked

Example Usage

DPML

<instr>
  <type>org.ten60.util.aspell</type>
  <operand>document.xml</operand>
  <target>this:response</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:org.ten60.util.aspell");
req.addArgument("operand", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The org.ten60.util..aspell accessor spell checks the text of an XML document. It only checks text contained within elements it does not check attribute text. Element and attribute names are not tested.

This accessor requires the GNU Aspell spell checker to be installed on your operating system and available in your application path. The language in which spellchecks will be performed is the default selection of your aspell installation.

Aspell returns an <aspell> root document with sp elements giving mispelled words and suggestions for alternative spellings.

GNU Aspell can be obtained here

Example

Suppose we have an XML document to spellcheck...

<root>
  <a>Helo Werld</a>
</root>

When checked this returns an Aspell result document with spelling errors, xpath location and alternative suggestions...

<aspell>
  <sp>
    <word xpath="/root/a">Helo</word>
    <alternatives>
      <alt>He</alt>
      <alt>lo</alt>
      <alt>He-lo</alt>
      <alt>Hello</alt>
      <alt>Helot</alt>
      <alt>Help</alt>
    </alternatives>
  </sp>
  <sp>
    <word xpath="/root/a">Werld</word>
    <alternatives>
      <alt>Weld</alt>
      <alt>World</alt>
      <alt>Wield</alt>
      <alt>Welled</alt>
      <alt>Wald</alt>
      <alt>Veld</alt>
    </alternatives>
  </sp>
</aspell>

To post-process the source document to replace mispelled words with alternative suggestions see active:org.ten60.util.aspell.substituteOptions