..aspell.substituteOptions

Home > Books > NetKernel API and Services Reference > Accessor Listing > ASpell Spell Checker > ..aspell.substituteOptions

Module

urn:org:ten60:util:aspell

The org.ten60.util.aspell.substituteOptions 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.substituteOptions

Argument	Rules	Description
operand	Mandatory	Document in to which spelling options are to be substituted
operator	Mandatory	An Aspell generated XML spellcheck result

Example Usage

DPML

<instr>
  <type>org.ten60.util.aspell.substituteOptions</type>
  <operator>document.xml</operator>
  <operator>var:aspell-results</operator>
  <target>this:response</target>
</instr>

NetKernel Foundation API

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

Purpose

The org.ten60.util.aspell.substituteOptions accessor replaces misspelled words in an XML document with a spelling option <sp> fragment containing a list of suggested spellings. The list of mispelled words can first be generated by the aspell accessor.

The result of this accessor is an XML document which may be styled to provide drop-down lists of alternate spellings.

Example

Suppose we have a document to be spell checked with Aspell...

<root>
  <a>This is a Helo World example</a>
</root>

Which produces an Aspell result document...

<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>
</aspell>

If we run substituteOptions using the suggestions of the aspell result against the original document we get...

<root>
  <a>This is a 
    <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> World example
  </a>
</root>

This can very easily be process to XHTML with a drop-down list for interactive editing.

See active:org.ten60.util.aspell