branch: externals/orderless
commit ef9bff0020cddf036d984be78ee061a01847040b
Author: Omar Antolín <[email protected]>
Commit: Omar Antolín <[email protected]>
Modify readme for better texinfo export
---
README.org | 8 ++++++--
orderless.texi | 25 +++++++------------------
2 files changed, 13 insertions(+), 20 deletions(-)
diff --git a/README.org b/README.org
index ae34e24204..cfb509d1e3 100644
--- a/README.org
+++ b/README.org
@@ -1,10 +1,14 @@
+#+TITLE: Orderless
#+EXPORT_FILE_NAME: orderless.texi
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Orderless: (orderless).
#+TEXINFO_DIR_DESC: Completion style for matching regexps in any order
+#+OPTIONS: d:nil
+:BADGES:
[[https://melpa.org/#/orderless][file:https://melpa.org/packages/orderless-badge.svg]]
[[https://stable.melpa.org/#/orderless][file:https://stable.melpa.org/packages/orderless-badge.svg]]
+:END:
* Overview
:PROPERTIES:
@@ -78,7 +82,7 @@ Bug reports are highly welcome and appreciated!
- [[#restricting-to-current-matches-icicles-ido-and-ivy][Restricting to
current matches: Icicles, Ido and Ivy]]
:END:
-** Screenshot
+** Screenshot :noexport:
This is what it looks like to use =describe-function= (bound by default
to =C-h f=) to match =eis ff=. Notice that in this particular case =eis=
@@ -408,7 +412,7 @@ in the flex style (called "fuzzy" in prescient). In
addition to
matching, =prescient.el= also supports sorting of candidates (=orderless=
leaves that up to the candidate source and the completion UI).
-** Restricting to current matches: Icicles, Ido and Ivy
+** Restricting to current matches in Icicles, Ido and Ivy
An effect equivalent to matching multiple components in any order can
be achieved in completion frameworks that provide a way to restrict
diff --git a/orderless.texi b/orderless.texi
index eeed98a649..d5361c7ac3 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -1,7 +1,7 @@
\input texinfo @c -*- texinfo -*-
@c %**start of header
@setfilename orderless.info
-@settitle
+@settitle Orderless
@documentencoding UTF-8
@documentlanguage en
@c %**end of header
@@ -13,7 +13,7 @@
@finalout
@titlepage
-@title
+@title Orderless
@author Omar Antolín Camarena
@end titlepage
@@ -21,7 +21,7 @@
@ifnottex
@node Top
-@top
+@top Orderless
@end ifnottex
@menu
@@ -55,7 +55,7 @@ Related packages
* Ivy and Helm::
* Prescient::
-* Restricting to current matches: Icicles, Ido and Ivy: Restricting to current
matches Icicles Ido and Ivy.
+* Restricting to current matches in Icicles, Ido and Ivy: Restricting to
current matches in Icicles Ido and Ivy.
@end detailmenu
@end menu
@@ -111,8 +111,6 @@ the candidates displayed vertically, you can use
@uref{https://github.com/oantol
Bug reports are highly welcome and appreciated!
-See also the @uref{https://github.com/oantolin/orderless/, package webpage},
which includes a @uref{https://github.com/oantolin/orderless/#screenshot,
screenshot}.
-
@node Customization
@chapter Customization
@@ -193,15 +191,6 @@ the characters of the component should appear in
that order in the candidate, but not necessarily consecutively.
This maps @samp{abc} to @samp{a.*b.*c}.
-
-@item orderless-prefixes
-the component is split at word endings and
-each piece must match at a word boundary in the candidate, occurring
-in that order.
-
-This is similar to the built-in @samp{partial-completion} completion-style.
-For example, @samp{re-re} matches @samp{query-replace-regexp},
@samp{recode-region} and
-@samp{magit-remote-list-refs}; @samp{f-d.t} matches @samp{final-draft.txt}.
@end table
The variable @samp{orderless-matching-styles} can be set to a list of the
@@ -464,7 +453,7 @@ face with this configuration:
@menu
* Ivy and Helm::
* Prescient::
-* Restricting to current matches: Icicles, Ido and Ivy: Restricting to current
matches Icicles Ido and Ivy.
+* Restricting to current matches in Icicles, Ido and Ivy: Restricting to
current matches in Icicles Ido and Ivy.
@end menu
@node Ivy and Helm
@@ -506,8 +495,8 @@ in the flex style (called ``fuzzy'' in prescient). In
addition to
matching, @samp{prescient.el} also supports sorting of candidates
(@samp{orderless}
leaves that up to the candidate source and the completion UI).
-@node Restricting to current matches Icicles Ido and Ivy
-@section Restricting to current matches: Icicles, Ido and Ivy
+@node Restricting to current matches in Icicles Ido and Ivy
+@section Restricting to current matches in Icicles, Ido and Ivy
An effect equivalent to matching multiple components in any order can
be achieved in completion frameworks that provide a way to restrict