branch: externals/mct
commit 5c0e1384b9f05269411b40edd2dbedd387ea89c5
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Recompile texi/info manuald
---
mct.info | 72 +++++++++++++++++++++++++++++++++++-----------------------------
mct.texi | 46 +++++++++++++++++++++++++++--------------
2 files changed, 70 insertions(+), 48 deletions(-)
diff --git a/mct.info b/mct.info
index 2e275e0..53028c0 100644
--- a/mct.info
+++ b/mct.info
@@ -113,6 +113,11 @@ commands are on offer:
Completions’ buffer for the designated command without accounting
for the minimum input threshold.
+ To inhibit live completion in the first place, ‘mct-live-completion’
+can be set to nil. Given this customization, the Completions’ buffern
+is only displayed when requested manually. ‘mct-completion-passlist’
+takes precedence over this option.
+
Other customisations:
• ‘mct-hide-completion-mode-line’ to hide the mode line of the
@@ -245,7 +250,7 @@ There are several ways to select a completion candidate.
something else, so the behaviour does not work as expected. One
such case is ‘org-set-tags-command’ which uses ‘:’ as a separator.
- 6. Type ‘M-e’ (‘mct-edit-completion’) in the completions’ buffer to
+ 1. Type ‘M-e’ (‘mct-edit-completion’) in the completions’ buffer to
place the current candidate in the minibuffer, without exiting the
session. This allows you to edit the text before confirming it.
@@ -927,13 +932,13 @@ B.1 Function index
mpletion-list-mode-map: Keymaps. (line 6)
+* mct-completion-passlist: Overview of mctel. (line 34)
+* mct-hide-completion-mode-line: Overview of mctel. (line 45)
+* mct-live-completion: Overview of mctel. (line 38)
+* mct-live-update-delay: Overview of mctel. (line 26)
+* mct-minibuffer-local-completion-map: Keymaps. (line 6)
+* mct-minibuffer-local-filename-completion-map: Keymaps. (line 6)
+* mct-minimum-input: Overview of mctel. (line 26)
+* mct-remove-shadowed-file-name: Overview of mctel. (line 50)
+* mct-stripe: Overview of mctel. (line 64)
File: mct.info, Node: Concept index, Prev: Variable index, Up: Indices
@@ -979,20 +985,20 @@ B.3 Concept index
Tag Table:
Node: Top865
Node: Overview of mctel2457
-Node: Basic usage5726
-Node: Cyclic behaviour5906
-Node: Selecting candidates7637
-Node: Installation10343
-Node: Sample setup11431
-Node: Keymaps13532
-Node: Extensions14176
-Node: Alternatives14971
-Node: Acknowledgements15364
-Node: GNU Free Documentation License15989
-Node: Indices41344
-Node: Function index41514
-Node: Variable index42164
-Node: Concept index43128
+Node: Basic usage5985
+Node: Cyclic behaviour6165
+Node: Selecting candidates7896
+Node: Installation10602
+Node: Sample setup11690
+Node: Keymaps13791
+Node: Extensions14435
+Node: Alternatives15230
+Node: Acknowledgements15623
+Node: GNU Free Documentation License16248
+Node: Indices41603
+Node: Function index41773
+Node: Variable index42423
+Node: Concept index43460
End Tag Table
diff --git a/mct.texi b/mct.texi
index b9a3dad..0a8aee2 100644
--- a/mct.texi
+++ b/mct.texi
@@ -93,15 +93,6 @@ Indices
@chapter Overview of mct.el
@cindex Overview of features
-@findex mct-choose-completion-number
-@vindex mct-minimum-input
-@vindex mct-live-update-delay
-@vindex mct-completion-blocklist
-@vindex mct-completion-passlist
-@vindex mct-hide-completion-mode-line
-@vindex mct-remove-shadowed-file-name
-@vindex mct-apply-completion-stripes
-@vindex mct-stripe
Minibuffer and Completions in Tandem, also known as ``MCT'', ``Mct'',
@samp{mct},
or @samp{mct.el}, is a package that enhances the default minibuffer and
@@ -121,30 +112,46 @@ outright or only displaying them on demand, MCT
implements a minimum
input threshold as well as a slight delay before it pops up the
@samp{*Completions*} buffer and starts updating it to respond to user input.
+@vindex mct-minimum-input
+@vindex mct-live-update-delay
Customisation options control the input threshold (@code{mct-minimum-input})
and the delay between live updates (@code{mct-live-update-delay}). Similarly,
a blocklist and a passlist for commands are on offer:
+@vindex mct-completion-blocklist
@itemize
@item
The blocklist (@code{mct-completion-blocklist}) disables the live-updating
functionality for the commands specified therein.
+@end itemize
+@vindex mct-completion-passlist
+@itemize
@item
The passlist (@code{mct-completion-passlist}) always shows the Completions'
buffer for the designated command without accounting for the minimum
input threshold.
@end itemize
+@vindex mct-live-completion
+To inhibit live completion in the first place, @code{mct-live-completion}
+can be set to nil. Given this customization, the Completions' buffern
+is only displayed when requested manually. @code{mct-completion-passlist}
+takes precedence over this option.
+
Other customisations:
+@vindex mct-hide-completion-mode-line
@itemize
@item
@code{mct-hide-completion-mode-line} to hide the mode line of the
@samp{*Completions*} buffer. This removes the separation between it and the
minibuffer, further contributing to the idea of a unified space
between the two.
+@end itemize
+@vindex mct-remove-shadowed-file-name
+@itemize
@item
@code{mct-remove-shadowed-file-name} to clear shadowed file names when
@code{file-name-shadow-mode} is enabled. This means that in prompts that use
@@ -152,7 +159,10 @@ file paths (such as @code{find-file}) when you start in,
say, @samp{~/Git/mct.el
and type @samp{~/} the previous file path is removed and only the new one is
inserted. Whereas the default is to keep the original file name
visible yet ``shadowed'' by a different colour.
+@end itemize
+@findex mct-choose-completion-number
+@itemize
@item
@code{mct-show-completion-line-numbers} to always display line numbers in the
Completions' buffer. This can be helpful to get a sense of the length
@@ -160,7 +170,11 @@ of the completion candidates' list. Though note that line
numbers are
displayed ephemerally while using the @code{mct-choose-completion-number}
command, which is bound to @samp{M-g M-g} in either the minibuffer or the
@samp{*Completions*} buffer.
+@end itemize
+@vindex mct-apply-completion-stripes
+@vindex mct-stripe
+@itemize
@item
@code{mct-apply-completion-stripes} applies alternative background colours in
the Completions' buffer. This is only tested with the @samp{modus-themes}
@@ -181,11 +195,6 @@ or, at least, users must modify the @code{mct-stripe} face.
@section Cyclic behaviour
@cindex Cyclic behaviour
-@findex mct-switch-to-completions-top
-@findex mct-switch-to-completions-bottom
-@findex mct-previous-completion-or-mini
-@findex mct-next-completion-or-mini
-@findex mct-list-completions-toggle
When @code{mct-mode} is enabled, some new keymaps are activated which add
commands for cycling between the minibuffer and the completions.
@@ -211,6 +220,8 @@ Suppose the following standard layout:
-----------------
@end example
+@findex mct-switch-to-completions-top
+@findex mct-switch-to-completions-bottom
When inside the minibuffer, pressing @samp{C-n} (or down arrow) takes you to
the top of the completions, while @samp{C-p} (or up arrow) moves to the bottom.
The commands are @code{mct-switch-to-completions-top} for the former and
@@ -218,6 +229,8 @@ The commands are @code{mct-switch-to-completions-top} for
the former and
are not shown, then the buffer pops up automatically and point moves to
the given position.
+@findex mct-previous-completion-or-mini
+@findex mct-next-completion-or-mini
Similarly, while inside the @samp{*Completions*} buffer, @samp{C-p} (or up
arrow) at
the top of the buffer switches to the minibuffer, while @samp{C-n} (or down
arrow) at the bottom of the buffer also goes to the minibuffer. If
@@ -225,6 +238,7 @@ point is anywhere else inside the buffer, those key
bindings perform a
regular line motion. The commands are @code{mct-previous-completion-or-mini}
and @code{mct-next-completion-or-mini}.
+@findex mct-list-completions-toggle
The display of the @samp{*Completions*} can be toggled at any time from inside
the minibuffer with @samp{C-l} (mnemonic is ``[l]ist completions'' and the
command is @code{mct-list-completions-toggle}).
@@ -233,7 +247,6 @@ command is @code{mct-list-completions-toggle}).
@section Selecting candidates
@cindex Candidate selection
-@findex mct-edit-completion
There are several ways to select a completion candidate.
@@ -281,7 +294,10 @@ NOTE 2021-10-22: this assumes the @code{crm-separator} to
be constant (the
comma @samp{,} character) but some commands @code{let} bind it to something
else,
so the behaviour does not work as expected. One such case is
@code{org-set-tags-command} which uses @samp{:} as a separator.
+@end enumerate
+@findex mct-edit-completion
+@enumerate
@item
Type @samp{M-e} (@code{mct-edit-completion}) in the completions' buffer to
place
the current candidate in the minibuffer, without exiting the session.
