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
96
97
98
99
|
From: Aymeric Agon-Rambosson <aymeric.agon@yandex.com>
Date: Tue, 09 Aug 2022 12:57:24 +0200
Subject: Drop references to external pages and debianise
Forwarded: not-needed
--- a/README.org
+++ b/README.org
@@ -6,6 +6,8 @@
#+texinfo_dir_title: Vertico: (vertico).
#+texinfo_dir_desc: VERTical Interactive COmpletion.
+#+macro: version 0.26
+
Vertico provides a performant and minimalistic vertical completion UI based on
the default completion system. The focus of Vertico is to provide a UI which
behaves /correctly/ under all circumstances. By reusing the built-in facilities
@@ -52,10 +54,9 @@ binding of =TAB= to ~vertico-insert~ and
* Configuration
-Vertico is available from [[https://elpa.gnu.org/packages/vertico.html][GNU ELPA]]. You can install it directly via
-~package-install~. After installation, you can activate the global minor mode with
+After installation, you can activate the global minor mode with
=M-x vertico-mode=. In order to configure Vertico and other packages in your
-init.el, you may want to take advantage of ~use-package~. Here is an example
+init.el, you may want to take advantage of ~use-package~ (~apt install elpa-use-package~). Here is an example
configuration:
#+begin_src emacs-lisp
@@ -135,9 +136,9 @@ files can be opened at once with =find-f
give the =initials= completion style a try.
See also the [[https://github.com/minad/vertico/wiki][Vertico Wiki]] for additional configuration tips. For more general
-documentation read the chapter about completion in the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Completion.html][Emacs manual]]. If you want
+documentation read the chapter about completion in the [[info:emacs#Completion][Emacs manual]]. If you want
to create your own completion commands, you can find documentation about
-completion in the [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion.html][Elisp manual]].
+completion in the [[info:elisp#Completion][Elisp manual]].
** Completion styles and TAB completion
@@ -217,24 +218,24 @@ a narrowly focused package and developed
:custom_id: extensions
:end:
-We maintain small extension packages to Vertico in this repository in the
-subdirectory [[https://github.com/minad/vertico/tree/main/extensions][extensions/]]. The extensions are installed together with Vertico if
-you pull the package from ELPA. The extensions are inactive by default and can
-be enabled manually if desired. Furthermore it is possible to install all of the
-files separately, both ~vertico.el~ and the ~vertico-*.el~ extensions. Currently the
-following extensions come with the Vertico ELPA package:
-
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-buffer.el][vertico-buffer]]: =vertico-buffer-mode= to display Vertico in a separate buffer.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-directory.el][vertico-directory]]: Commands for Ido-like directory navigation.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-flat.el][vertico-flat]]: =vertico-flat-mode= to enable a flat, horizontal display.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-grid.el][vertico-grid]]: =vertico-grid-mode= to enable a grid display.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-indexed.el][vertico-indexed]]: =vertico-indexed-mode= to select indexed candidates with prefix arguments.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-mouse.el][vertico-mouse]]: =vertico-mouse-mode= to support for scrolling and candidate selection.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-multiform.el][vertico-multiform]]: Configure Vertico modes per command or completion category.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-quick.el][vertico-quick]]: Commands to select using Avy-style quick keys.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-repeat.el][vertico-repeat]]: The command =vertico-repeat= repeats the last completion session.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-reverse.el][vertico-reverse]]: =vertico-reverse-mode= to reverse the display.
-- [[https://github.com/minad/vertico/blob/main/extensions/vertico-unobtrusive.el][vertico-unobtrusive]]: =vertico-unobtrusive-mode= displays only the topmost candidate.
+We maintain small extension packages to Vertico in this repository. The
+extensions are installed together with Vertico. The extensions are inactive by
+default and can be enabled manually if desired. Furthermore it is possible to
+install all of the files separately, both ~vertico.el~ and the ~vertico-*.el~
+extensions. Currently the following extensions come with the ~elpa-vertico~
+package in the ~/usr/share/emacs/site-lisp/vertico-{{{version}}}~ directory:
+
+- vertico-buffer: =vertico-buffer-mode= to display Vertico in a separate buffer.
+- vertico-directory: Commands for Ido-like directory navigation.
+- vertico-flat: =vertico-flat-mode= to enable a flat, horizontal display.
+- vertico-grid: =vertico-grid-mode= to enable a grid display.
+- vertico-indexed: =vertico-indexed-mode= to select indexed candidates with prefix arguments.
+- vertico-mouse: =vertico-mouse-mode= to support for scrolling and candidate selection.
+- vertico-multiform: Configure Vertico modes per command or completion category.
+- vertico-quick: Commands to select using Avy-style quick keys.
+- vertico-repeat: The command =vertico-repeat= repeats the last completion session.
+- vertico-reverse: =vertico-reverse-mode= to reverse the display.
+- vertico-unobtrusive: =vertico-unobtrusive-mode= displays only the topmost candidate.
See the Commentary of those files for configuration details. With these
extensions it is possible to adapt Vertico such that it matches your preference
@@ -368,10 +369,10 @@ candidates from disappearing when they s
Vertico integrates well with complementary packages, which enrich the completion
UI. These packages are fully supported:
-- [[https://github.com/minad/marginalia][Marginalia]]: Rich annotations in the minibuffer
-- [[https://github.com/minad/consult][Consult]]: Useful search and navigation commands
-- [[https://github.com/oantolin/embark][Embark]]: Minibuffer actions and context menu
-- [[https://github.com/oantolin/orderless][Orderless]]: Advanced completion style
+- Marginalia (~apt install elpa-marginalia~): Rich annotations in the minibuffer
+- Consult (~apt install elpa-consult~): Useful search and navigation commands
+- Embark (~apt install elpa-embark~): Minibuffer actions and context menu
+- Orderless (~apt install elpa-orderless~): Advanced completion style
In order to get accustomed with the package ecosystem, I recommend the following
quick start approach:
|
