[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/jinx 187863e200 2/2: Update readme
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/jinx 187863e200 2/2: Update readme |
|
Date: |
Mon, 1 May 2023 13:02:44 -0400 (EDT) |
branch: externals/jinx
commit 187863e200bae23837b2509fa714f2e5ab8df2cf
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Update readme
---
README.org | 31 +++++++++++++++++++------------
1 file changed, 19 insertions(+), 12 deletions(-)
diff --git a/README.org b/README.org
index 894b085510..15963bee90 100644
--- a/README.org
+++ b/README.org
@@ -89,19 +89,22 @@ A sample configuration with the popular =use-package= macro
is shown here:
* Correcting misspellings
After invoking the command =jinx-correct=, suggested corrections are displayed
as
-a completion menu. You can press digit keys to quickly select a suggestion.
-Furthermore the menu offers options to save the word temporarily for the
current
-session, in the personal dictionary or in the file-local variables. Note that
-you can enter arbitrary input at the correction prompt in order to make the
-correction. The keys =M-n= (=M-p=) are bound to =jinx-next= and
=jinx-previous= and
-allow you to move the next (previous) misspelling from inside the
=jinx-correct=
-prompt.
+a completion menu. You can press the displayed digit keys to quickly select a
+suggestion. Furthermore the menu offers options to save the word temporarily
for
+the current session, in the personal dictionary or in the file-local variables.
+
+Note that you can enter arbitrary input at the correction prompt in order to
+make the correction or to store a modified word in the personal dictionary.
+For example if you typed =alotriomorpc=, the prompt offers you the option
+=@alotriomorpc= which would add this word to your personal dictionary upon
+selection. You can then correct the option to =@allotriomorphic= and add it to
the
+dictionary.
The completion menu is compatible with all popular completion UIs: Vertico,
Mct,
Icomplete, Ivy, Helm and of course default completion. In case you use Vertico
I
suggest that you tweak the completion display via =vertico-multiform-mode= for
the
completion category =jinx=. You can for example use the grid display such that
-more suggestions fit on the screen.
+more suggestions fit on the screen and enable annotations.
#+begin_src emacs-lisp
(add-to-list 'vertico-multiform-categories
@@ -109,6 +112,10 @@ more suggestions fit on the screen.
(vertico-multiform-mode 1)
#+end_src
+While inside the =jinx-correct= prompt, the keys =M-n= and =M-p= are bound to
+=jinx-next= and =jinx-previous= respectively and allow you to move the next and
+previous misspelled word.
+
* Navigating between misspellings
As mentioned before, when correcting a word with =jinx-correct=, the movement
@@ -117,10 +124,10 @@ navigate to the next and previous misspelling
respectively.
These commands can also be used outside the minibuffer context. While the
commands are not bound globally by default, they are available as =M-n= and
=M-p= if
-point is placed on top of a misspelled word overlay. If you want you can also
-bind them in the =jinx-mode-map=, such that they are always available
independent
-of point placement. If =repeat-mode= from Emacs 28 is enabled, the movement
can be
-repeated with the keys =n= and =p=.
+point is placed on top of a misspelled word overlay. If you want you can add
+them and other commands to the =jinx-mode-map=, such that they are always
+available independent of point placement. If =repeat-mode= from Emacs 28 is
+enabled, the movement can be repeated with the keys =n= and =p=.
* Enchant backends and personal dictionaries