1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
From: Aymeric Agon-Rambosson <aymeric.agon@yandex.com>
Date: Thu, 18 Aug 2022 19:44:56 +0200
Subject: Drop references to external pages and debianise
Forwarded: not-needed
---
README.org | 39 ++++++++++++++++++++-------------------
1 file changed, 20 insertions(+), 19 deletions(-)
diff --git a/README.org b/README.org
index 2c7c4c4..75c4caf 100644
--- a/README.org
+++ b/README.org
@@ -22,16 +22,16 @@ 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), the icomplete-vertical variant from
-Emacs 28, or with minibuffer completion frameworks such as [[https://gitlab.com/protesilaos/mct][Mct]] or
-[[https://github.com/minad/vertico][Vertico]].
+Emacs 28, or with some third party minibuffer completion frameworks such
+as [[https://gitlab.com/protesilaos/mct][Mct]] or Vertico (~apt install elpa-vertico~).
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]], [[https://company-mode.github.io/][Company]] or the function =consult-completion-in-region=
-from [[https://github.com/minad/consult][Consult]].
+such as [[https://github.com/minad/corfu][Corfu]], Company (~apt install elpa-company~) or the function =consult-completion-in-region=
+from Consult (~apt install elpa-consult~).
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
@@ -45,13 +45,13 @@ exclusively, set both variables to =nil=, but be aware that
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]], as
-documented 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).
+Emacs completion styles. Currently there is support for Ivy (~apt install elpa-ivy~) (see
+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 ELPA or MELPA, the easiest way to install =orderless= is via
-=package-install=. If you use =use-package=, you can use:
+=package-install=. If you use =use-package= (~apt install elpa-use-package~), you can use:
#+begin_src emacs-lisp
(use-package orderless
@@ -305,11 +305,11 @@ the above configuration, you'd need to use commands whose metadata
indicates that the completion candidates are commands or symbols. In
Emacs 28, =execute-extended-command= has metadata indicating you are
selecting a command, but earlier versions of Emacs lack this metadata.
-Activating =marginalia-mode= from the [[https://github.com/minad/marginalia][Marginalia]] package provides this
-metadata automatically for many built-in commands and is recommended
-if you use the above example configuration, or other similarly
-fine-grained control of completion styles according to completion
-category.
+Activating =marginalia-mode= from the Marginalia (~apt install
+elpa-marginalia~) package provides this metadata automatically for many
+built-in commands and is recommended if you use the above example
+configuration, or other similarly fine-grained control of completion
+styles according to completion category.
** Faces for component matches
@@ -339,10 +339,10 @@ configuration on the fly while matching. There many possible user
interfaces for this: you could toggle between two chosen
configurations, cycle among several, have a keymap where each key sets
a different configurations, have a set of named configurations and be
-prompted (with completion) for one of them, popup a [[https://github.com/abo-abo/hydra][hydra]] to choose a
-configuration, etc. Since there are so many possible UIs and which to
-use is mostly a matter of taste, =orderless= does not provide any such
-commands. But it's easy to write your own!
+prompted (with completion) for one of them, popup a hydra (~apt install
+elpa-hydra~) to choose a configuration, etc. Since there are so many
+possible UIs and which to use is mostly a matter of taste, =orderless=
+does not provide any such commands. But it's easy to write your own!
For example, say you want to use the keybinding =C-l= to make all
components match literally. You could use the following code:
@@ -447,7 +447,8 @@ can add this to your configuration:
** Ivy and Helm
-The well-known and hugely powerful completion frameworks [[https://github.com/abo-abo/swiper][Ivy]] and [[https://github.com/emacs-helm/helm][Helm]]
+The well-known and hugely powerful completion frameworks Ivy (~apt
+install elpa-ivy~) and Helm (~apt install elpa-helm~)
also provide for matching space-separated component regexps in any
order. In Ivy, this is done with the =ivy--regex-ignore-order= matcher.
In Helm, it is the default, called "multi pattern matching".
|