Skip to content

Commit

Permalink
Improve documentation (#2015)
Browse files Browse the repository at this point in the history
  • Loading branch information
vkbo committed Sep 9, 2024
2 parents 095c005 + 66986b8 commit 5ac0017
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/usage_writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,24 @@ Any :term:`references<reference>` in the editor can be opened in the viewer by m
the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.


Spell Checking
--------------

A third party library called Enchant is used for spell checking in the editor. The controls for
spell checking can be found in the **Tools** menu. You can also set spell checking language in
**Project Settings**.

This spell checking library comes with support for custom words that you can add by selecting
"Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as
misspelled. The custom words are managed on a per-project basis, and can the list of words can be
edited from the **Project Word List** tool available from the **Tools** menu.

.. note::

Generally, spell checking dictionaries are collected from your operating system, but on Windows
they are not. See :ref:`a_custom_dict` for how to add spell checking dictionaries on Windows.


Editor Auto-Completer
---------------------

Expand Down

0 comments on commit 5ac0017

Please sign in to comment.