<page xmlns="http://projectmallard.org/1.0/"
  type="topic"
  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>
    <title>Enable the Spell Checker plugin</title>
    <p>
      First, you need to enable the plugin:
    </p>
    <steps>
      <item><p>
        Go to the
        <guiseq>
          <gui style="menu">Menu</gui>
          <gui style="menuitem">Preferences</gui>
          <gui style="tab">Plugins</gui>
        </guiseq>.
      </p></item>
      <item><p>
        Select <gui>Spell Checker</gui>.
      </p></item>
    </steps>
  </section>

  <section>
    <title>Configuring the default settings</title>
    <p>
      You can configure the default spell-checking settings for new documents by
      going to the
      <guiseq>
        <gui style="menu">Menu</gui>
        <gui style="menuitem">Preferences</gui>
        <gui style="tab">Plugins</gui>
        <gui>Spell Checker</gui>
        <gui style="button">Preferences</gui>
      </guiseq>.
    </p>
  </section>

  <section>
    <title>Using the spell-checker</title>
    <p>
      To use the spell-checker, go to the
      <guiseq>
        <gui style="menu">Menu</gui>
        <gui style="menuitem">Tools</gui>
      </guiseq>.
    </p>
    <p>
      If you activate the <gui style="menuitem">Highlight Misspelled Words</gui>
      option, the misspelled words will be underlined in red in the document.
      A right click on a misspelled word will show proposals.
    </p>
    <p>
      The settings are remembered on a file-by-file basis: when you reopen a
      document, the chosen language is restored, as well as whether the
      misspelled words are highlighted in the text area.
    </p>
  </section>

  <section>
    <title>Dictionaries</title>
    <p>
      <link href="https://gitlab.gnome.org/GNOME/gspell">gspell</link>
      is used for the spell-checking in <app>gedit</app>. gspell uses
      <link href="https://rrthomas.github.io/enchant/">Enchant</link>,
      which in turn supports several backends such as Hunspell or Aspell for the
      dictionaries. The Aspell backend doesn't work well with gspell, Hunspell
      is preferred. If dictionaries for both Aspell and Hunspell are installed
      for the same language, by default Enchant prefers the Hunspell one.
    </p>
    <p>
      If your language is not listed in <app>gedit</app>, install a dictionary
      for one of the supported Enchant backends (for most languages the best
      choice is to install an Hunspell dictionary).
    </p>
  </section>
</page>
