[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orderless 43896f3e10 140/204: Accidentally omitted the
From: |
ELPA Syncer |
Subject: |
[elpa] externals/orderless 43896f3e10 140/204: Accidentally omitted the overview! Bring it back |
Date: |
Tue, 11 Jan 2022 12:58:24 -0500 (EST) |
branch: externals/orderless
commit 43896f3e1063929435616cede89228278ff491cb
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Accidentally omitted the overview! Bring it back
---
README.org | 2 +-
orderless.texi | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 60 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index a8102fe49f..01da6b5138 100644
--- a/README.org
+++ b/README.org
@@ -10,7 +10,7 @@
[[https://stable.melpa.org/#/orderless][file:https://stable.melpa.org/packages/orderless-badge.svg]]
:END:
-* COMMENT Overview
+* Overview
:PROPERTIES:
:TOC: :include all :ignore this
:END:
diff --git a/orderless.texi b/orderless.texi
index c1dc217516..60ba6b6b4e 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -25,6 +25,7 @@
@end ifnottex
@menu
+* Overview::
* Customization::
* Integration with other completion UIs::
* Related packages::
@@ -59,6 +60,64 @@ Related packages
@end detailmenu
@end menu
+@node Overview
+@chapter Overview
+
+This package provides an @samp{orderless} @emph{completion style} that divides
the
+pattern into space-separated components, and matches candidates that
+match all of the components in any order. Each component can match in
+any one of several ways: literally, as a regexp, as an initialism, in
+the flex style, or as multiple word prefixes. By default, regexp and
+initialism matches are enabled.
+
+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) or with the built-in Icomplete package (which is
+similar to the more well-known Ido Mode). To use a completion style in
+this fashion simply add it as an entry in the variables
+@samp{completion-styles} or @samp{completion-category-overrides} (see their
+documentation). Note that there is also the variable
+@samp{completion-category-defaults} which configures some completion styles
+for special kinds of completion by default. If you want to use @emph{only}
+orderless, set that variable to nil.
+
+With a bit of effort, it might still be possible to use @samp{orderless} with
+other completion UIs, even if those UIs don't support the standard
+Emacs completion styles. Currently there is support for
@uref{https://github.com/raxod502/selectrum, Selectrum} and
+@uref{https://github.com/abo-abo/swiper, Ivy} (see below).
+
+@lisp
+(use-package orderless
+ :ensure t
+ :init (icomplete-mode) ; optional but recommended
+ :custom
+ (completion-styles '(orderless))
+ (completion-category-defaults nil)) ; optional
+@end lisp
+
+Alternatively, put @samp{orderless.el} somewhere on your @samp{load-path}, and
use
+the following configuration:
+
+If you use MELPA, the easiest way to install @samp{orderless} is via
+@samp{package-install}. If you use both MELPA and @samp{use-package}, you can
use:
+
+@lisp
+(require 'orderless)
+(setq completion-styles '(orderless)
+ completion-category-defaults nil) ; optional
+(icomplete-mode) ; optional but recommended
+@end lisp
+
+(And of course, if you use another completion framework such as Ivy or
+Helm, disable it.)
+
+If you like the experience of using @samp{orderless} with Icomplete, but wish
+the candidates displayed vertically, you can use
@uref{https://github.com/oantolin/icomplete-vertical, icomplete-vertical},
+@uref{https://github.com/raxod502/selectrum, Selectrum} or
@uref{https://github.com/abo-abo/swiper, Ivy}.
+
+Bug reports are highly welcome and appreciated!
+
@node Customization
@chapter Customization
- [elpa] externals/orderless f2af44bf2e 057/204: Mention Icicles's progressive matching, (continued)
- [elpa] externals/orderless f2af44bf2e 057/204: Mention Icicles's progressive matching, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 1631eb1733 073/204: Fix autoload for ivy, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 862eed345c 075/204: Add more orderless initialism styles, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless e3644defcd 088/204: Add orderless-pattern-compiler variable for maximum flexibility, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 436ef98b16 089/204: Add optional argument for dispatches: total number of components, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless ed37c22902 097/204: Prefer descriptive argument over "mystery t's", ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 9cebf2fc8c 106/204: Escape parenthesis in first column of docstrings, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 93f4bccea1 112/204: Go back to split-string until empty components issue is resolved, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 2d1f68b914 114/204: Fix tiny bug in customization type, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 5c2f44d901 115/204: Allow component separator to be a function, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 43896f3e10 140/204: Accidentally omitted the overview! Bring it back,
ELPA Syncer <=
- [elpa] externals/orderless b059c15911 052/204: Make orderless-prefixes more like partial-completion, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless dc3f8da022 076/204: Avoid other cl-pushnes in an autoload, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless a11302737e 018/204: Keep split-string from modifying global match data, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless c9ae65ea16 023/204: Highlight component matches in one of four faces, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 044fac0859 029/204: Revert "Better match face defaults (kindly contributed by Protesilaos)", ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 2813ffb2b1 039/204: Optimization: check if first component is string literal, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 25266dfc60 033/204: Update README.org, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 39202177e1 040/204: Undo previous optimization as it is invalid in general :(, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless ecddc3da2e 045/204: Un-nest definition of orderless--highlight-matches, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 582b3a9fa8 031/204: Make all `defface' syntax more efficient+readable, ELPA Syncer, 2022/01/11