From 556e8db104b5a3c92c122563dfa74db36abc695c Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Fri, 16 Aug 2024 09:33:38 +0200 Subject: [PATCH 1/2] Add some text about spell checking to editor docs --- docs/source/usage_writing.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/source/usage_writing.rst b/docs/source/usage_writing.rst index a1b59c67..2a646e1e 100644 --- a/docs/source/usage_writing.rst +++ b/docs/source/usage_writing.rst @@ -40,6 +40,24 @@ Any :term:`references` 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. 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 check languages are collected from your operating system, but on Windows they + are not. See :ref:`a_custom_dict` for how to add spell check languages on Windows. + + Editor Auto-Completer --------------------- From 66986b88f8f829336493c23a7f44fa78366f6773 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 1 Sep 2024 21:41:26 +0200 Subject: [PATCH 2/2] Improve the spell checking info a little --- docs/source/usage_writing.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/usage_writing.rst b/docs/source/usage_writing.rst index 2a646e1e..b59ff19f 100644 --- a/docs/source/usage_writing.rst +++ b/docs/source/usage_writing.rst @@ -48,14 +48,14 @@ spell checking can be found in the **Tools** menu. You can also set spell checki **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. 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. +"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 check languages are collected from your operating system, but on Windows they - are not. See :ref:`a_custom_dict` for how to add spell check languages on Windows. + 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