[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orderless 5b292ac136 118/204: Document custom splitter
From: |
ELPA Syncer |
Subject: |
[elpa] externals/orderless 5b292ac136 118/204: Document custom splitter option |
Date: |
Tue, 11 Jan 2022 12:58:22 -0500 (EST) |
branch: externals/orderless
commit 5b292ac136b891d574f0d9827904e6ad527a9c35
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Document custom splitter option
---
README.org | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index fd1c7816fc..7cf9677e52 100644
--- a/README.org
+++ b/README.org
@@ -188,11 +188,19 @@ initialism styles.
** Component separator regexp
The pattern components are space-separated by default: this is
-controlled by the variable =orderless-component-separator=, which should be
-set to a regexp that matches the desired component separator. The
-default value matches a sequence of spaces. It may be useful to add
-hyphens or slashes (or both), to match symbols or file paths,
-respectively.
+controlled by the variable =orderless-component-separator=, which should
+be set either to a regexp that matches the desired component
+separator, or to a function that takes a string and returns the list
+of components. The default value is a regexp matches a non-empty
+sequence of spaces. It may be useful to add hyphens or slashes (or
+both), to match symbols or file paths, respectively.
+
+ Even if you want to split on spaces you might want to be able to
+escape those spaces or to enclose space in double quotes (as in shell
+argument parsing). For backslash-escaped spaces set
+=orderless-component-separator= to the function
+=orderless-escapable-split-on-space=; for shell-like double-quotable
+space, set it to the standard Emacs function =split-string-and-unquote=.
If you are implementing a command for which you know you want a
different separator for the components, bind
- [elpa] externals/orderless 3b15b2f59d 059/204: Demote Icicles heading, (continued)
- [elpa] externals/orderless 3b15b2f59d 059/204: Demote Icicles heading, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 80b53ec38e 019/204: Rename lim to limit, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 48ec46518a 037/204: Fix typo in README (thanks Juanjo!), ELPA Syncer, 2022/01/11
- [elpa] externals/orderless a21ef6d985 070/204: If matching-styles is nil, assume regexp matching, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 3c4b4815f0 079/204: Refactor strict initialism functions, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless f30a3e912c 082/204: Initial implementation of style dispatchers, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 7e83e37870 086/204: Fine-tune dispatcher semantics, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 5897841be4 094/204: Rename default pattern compiler, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 830976770b 102/204: Put integration before related packages in README, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 68e592055c 113/204: The transient variables should not be customizable, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 5b292ac136 118/204: Document custom splitter option,
ELPA Syncer <=
- [elpa] externals/orderless 1d62307cce 125/204: Add badge., ELPA Syncer, 2022/01/11
- [elpa] externals/orderless cbc0109eac 136/204: Merge pull request #28 from b3n/patch-1, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless d1c0cbf87b 137/204: Add matching style and dispatcher per category overrides (fix #31), ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 5dcf4a6f2b 135/204: Corrected broken link, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless 701b6a07c8 156/204: orderless-try-completions: Remove _metadata argument, ELPA Syncer, 2022/01/11
- [elpa] externals/orderless a609004d5f 159/204: Document that orderless-regexp matches invalid regexps literally, ELPA Syncer, 2022/01/11
- [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