[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orderless 855255eb01 198/204: Mention Corfu and consult
From: |
ELPA Syncer |
Subject: |
[elpa] externals/orderless 855255eb01 198/204: Mention Corfu and consult-completion-in-region (fix #99) |
Date: |
Tue, 11 Jan 2022 12:58:31 -0500 (EST) |
branch: externals/orderless
commit 855255eb010327a219d8a516cec850fc43f31852
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Mention Corfu and consult-completion-in-region (fix #99)
---
README.org | 30 +++++++++++++++++++++---------
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
index a6dc2146ad..e3a05f35e1 100644
--- a/README.org
+++ b/README.org
@@ -26,14 +26,24 @@ A completion style is a back-end for completion and is used
from a
front-end that provides a completion UI. Any completion style can be
used with the default Emacs completion UI (sometimes called minibuffer
tab completion), with the built-in Icomplete package (which is similar
-to the more well-known Ido Mode), or with some third party completion
-frameworks such as [[https://github.com/minad/vertico][Vertico]],
[[https://github.com/raxod502/selectrum][Selectrum]] (in its default
configuration),
-or [[https://github.com/oantolin/icomplete-vertical][icomplete-vertical]]
(note there is also a /built-in/ package named
-icomplete-vertical in the unreleased version 28 of Emacs, which will
-eventually make the third party icomplete-vertical obsolete
----orderless works equally well with both icomplete-vertical
-packages). To use a completion style with any of these completion UIs
-simply add it as an entry in the variables =completion-styles= and
+to the more well-known Ido Mode), or with some third party minibuffer
+completion frameworks such as [[https://github.com/minad/vertico][Vertico]],
[[https://github.com/raxod502/selectrum][Selectrum]] (in its default
+configuration), or
[[https://github.com/oantolin/icomplete-vertical][icomplete-vertical]] (note
there is also a /built-in/
+package named icomplete-vertical in the unreleased version 28 of
+Emacs, which will eventually make the third party icomplete-vertical
+obsolete ---orderless works equally well with both icomplete-vertical
+packages).
+
+All the completion UIs just mentioned are for minibuffer completion,
+used when Emacs commands prompt the user in the minibuffer for some
+input, but there is also completion at point in normal buffers,
+typically used for identifiers in programming languages. Completion
+styles can also be used for that purpose by completion at point UIs
+such as [[https://github.com/minad/corfu][Corfu]], the function
=consult-completion-in-region= from
[[https://github.com/minad/consult][Consult]]
+or [[https://company-mode.github.io/][Company]].
+
+To use a completion style with any of the above mentioned completion
+UIs simply add it as an entry in the variables =completion-styles= and
=completion-category-overrides= (see their documentation). You may also
want to modify the =completion-category-defaults= variable, which serves
as a default value for =completion-category-overrides=: if you want to
@@ -42,7 +52,9 @@ use =orderless= exclusively, set both variables to =nil=.
With a bit of effort, it might still be possible to use =orderless= with
other completion UIs, even if those UIs don't support the standard
Emacs completion styles. Currently there is support for
[[https://github.com/abo-abo/swiper][Ivy]] (see
-below).
+below). Also, while Company does support completion styles directly,
+pressing =SPC= takes you out of completion, so comfortably using
+=orderless= with it takes a bit of configuration (see below).
If you use MELPA, the easiest way to install =orderless= is via
=package-install=. If you use both MELPA and =use-package=, you can use:
- [elpa] externals/orderless d6eb575714 165/204: Merge pull request #44 from minad/invalid-regexp, (continued)
- [elpa] externals/orderless d6eb575714 165/204: Merge pull request #44 from minad/invalid-regexp, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 87ab7e47e3 168/204: Merge pull request #46 from minad/remove-pattern-compiler-variable, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless d2891b807b 174/204: orderless+initialism example requires Marginalia (see #54), ELPA Syncer, 2022/01/11
- [elpa] externals/orderless e4c38efcd6 176/204: README: Add variable category to orderless+initialism sample, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 871eb1d0f0 178/204: Use add-face-text-property, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless df4f29a4f4 183/204: Use minibuffer customization group, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 62f71c34ba 191/204: Extend prefix optimization to anchored quoted regexps (fix #81), ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 75d3398056 192/204: Have orderless-try-completion return t for exact match (fix #95), ELPA Syncer, 2022/01/11
- [elpa] externals/orderless c8731aacfa 197/204: Merge pull request #98 from minad/fix-try, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless f22789f358 202/204: Merge pull request #94 from minad/strict-initialism, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 855255eb01 198/204: Mention Corfu and consult-completion-in-region (fix #99),
ELPA Syncer <=
- [elpa] externals/orderless 269d7388ab 034/204: Merge pull request #6 from raxod502/patch-1, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless ae466bc4f4 054/204: Rename orderless-regexp-separator to orderless-component-separator, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless aad0aa8a8d 017/204: Copy candidates to avoid permanently changing their face, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 9218343171 043/204: Add command to temporarily change separator, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 2750e15c74 065/204: Add ivy integration, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless fb6ad592b7 067/204: List more helpful functions for integration, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 50c83f2752 074/204: Avoid using cl-lib in autoloads, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 274c8cbadc 078/204: Declare other ivy variable used, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless b63019aea3 090/204: Add missing (oops!) "forgiving funcall" function, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 74947d0862 092/204: Update dispatchers documentation, and documents pattern compiler, ELPA Syncer, 2022/01/11