#
Spelling Engine

###### Identifier:

org.eclipse.ui.workbench.texteditor.spellingEngine

###### Since:

3.1

###### Description:

Allows contributors to add spelling engines.

###### Configuration Markup:

<!ELEMENT extension (engine+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

- point - The fully qualified name of the extension point.
- id - The optional id of this extension.
- name - The optional name of this extension.

<!ELEMENT engine EMPTY>

<!ATTLIST engine

class CDATA #REQUIRED

label CDATA #IMPLIED

id CDATA #REQUIRED

default (true | false)

preferencesClass CDATA #IMPLIED>

The definition of a spelling engine.

- class - The class of the engine, which must implement `org.eclipse.ui.texteditor.spelling.ISpellingEngine`.
- label - The display label for the engine, which will show up in the menu that allows the user to choose the spelling engine.
- id - A string uniquely identifying this engine.
- default - If this flag is set to `true`, this spelling engine will be installed per default. If multiple engines are installed with the flag set are encountered, the first one is taken.
- preferencesClass - An implementation of org.eclipse.ui.texteditor.spelling.ISpellingPreferenceBlock

###### Examples:

The following is an example of a spelling engine definition.

      <extension point="org.eclipse.ui.workbench.texteditor.spellingEngine">
        <engine
            default="true"
            label="%defaultSpellingEngine.label"
            class="org.eclipse.jdt.internal.ui.text.spelling.DefaultSpellingEngine"
            id="org.eclipse.jdt.internal.ui.text.spelling.DefaultSpellingEngine">
        </engine>
      </extension>

###### Supplied Implementation:

The `org.eclipse.jdt.ui` plugin contributes `DefaultSpellingEngine`. See its implementation as an example.

Copyright (c) 2001, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html