<page xmlns="http://projectmallard.org/1.0/"
  type="topic" style="task" 
  id="gedit-spellcheck">
  
  <info>
    <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins" /> 
    <desc>Check your files for spelling errors.</desc>
  </info>
  
  <title>Spell-check your document</title>
  <section id="enable-spell-check">
    <title>Enable the spell checker</title>
    <p>The Spell-check feature is provided as a plugin in <app>gedit</app> which
    can be enabled as required. To enable the plugin:</p>

    <steps>
      <item>
        <p>Select <guiseq><gui style="menu">gedit</gui>
        <gui style="menuitem">Preferences</gui>
        <gui style="tab">Plugins</gui></guiseq>.</p>
      </item>
      <item>
        <p>Select <gui style="menuitem">Spell Checker</gui> to enable the
        plugin.</p>
      </item>
    </steps>

  </section>

  <section id="spell-check">
    <title>Spell-check your document</title>

    <p>To check for misspelt words in your document:</p>

    <steps>
      <item>
        <p>Select <guiseq><gui style="menu">Tools</gui>
        <gui style="menuitem">Check Spelling</gui></guiseq>.</p>
      </item>
    </steps>

    <note style="tip">
      <p>To have <app>gedit</app> automatically highlight misspelt words in your
      document as you type, select <guiseq><gui style="menu">Tools</gui><gui
      style="menuitem">Highlight Misspelled Words</gui></guiseq>.</p>
    </note>
  </section>

  <section id="use-spell-check">
    <title>Using spell-check</title>

    <p>You can choose the right substitution for misspelt words using the Check
    Spelling dialog. The misspelt word being checked by the spell-checker is
    displayed in bold style next to <gui>Misspelled word:</gui>.
    You can choose from the following corrective actions:</p>

    <list>
      <item>
        <p><gui style="input">Change to:</gui> allows you to input a word and
        use <gui style="button">Check Word</gui> to check the validity of the
        spelling.</p>
      </item>
      <item>
        <p><gui style="menu">Suggestions:</gui> lists the available
        substitutions for the word.</p>
      </item>
      <item>
        <p><gui style="button">Ignore</gui> allows you to bypass spell check for
        <em>a</em> instance of current word.</p>
      </item>
      <item>
        <p><gui style="button">Ignore All</gui> allows you to bypass spell check
        for <em>all</em> instances of the current word.</p>
      </item>
      <item>
        <p><gui style="button">Change</gui> substitutes the misspelt or
        unrecognized word with <em>a</em> chosen substitute from the
        <gui style="menuitem">Suggestions:</gui> list.</p>
      </item>
      <item>
        <p><gui style="button">Change all</gui> substitutes <em>all</em>
        misspelt or unrecognized words with the chosen substitute from the
        <gui style="menuitem">Suggestions:</gui> list.</p>
      </item>
      <item>
        <p><gui style="button">Add word</gui> allows you to add the current word
        to the <app>gedit</app> <gui>User dictionary</gui>. Adding custom words
        to the <gui>User dictionary</gui> will allow <app>gedit</app> to
        recognize the word in documents and thus will not be highlighted as a
        misspelt word.</p>
      </item>
    </list>

  </section>

  <section id="define-spell-check-language">
    <title>Define the language to use for spell checking</title>
    <p>By default, <app>gedit</app> will use your current language to spell
    check your document. If you need to use another language, choose
    <guiseq><gui style="menu">Tools</gui><gui style="menuitem">Set
    Language…</gui></guiseq>, then choose the language you want to use.</p>
  </section>

  <section id="dict">
    <title>Dictionaries</title>

    <p><app>gedit</app> uses
    <link href="https://www.abisource.com/projects/enchant/">Enchant</link>,
    a small system utility, for spell checking. Enchant can use
    several different dictionaries to check your spelling. Two such
    dictionary back-ends are <em>Hunspell</em> and <em>Aspell</em>.</p>

    <p>If the language you want to use is not available in <app>gedit</app>,
    use your computer's software installer or package manager to install the
    dictionary back-end that you want.</p>
  </section>
</page>
