branch: externals/pabbrev commit ded62c9c21c1be390495a94426ea627997c744cc Merge: 7bdb74afcd b1ba1dae89 Author: Arthur Miller <arthur.mil...@live.com> Commit: Arthur Miller <arthur.mil...@live.com>
Merge branch 'pabbrev-new-readme' --- README.md | 16 ---------------- README.org | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md deleted file mode 100644 index 58e442a3c4..0000000000 --- a/README.md +++ /dev/null @@ -1,16 +0,0 @@ -Predictive Abbreviation Expansion for Emacs -=========================================== - -Provides predictive abbreviation expansion with no configuration, working with -any mode. For more details see pabbrev.el - - - - -## Releases - -### 4.0 - -This release provides better key handling, meaning expansion is configurable. - -The code base is now in its own repository, so that I can tag it. diff --git a/README.org b/README.org new file mode 100644 index 0000000000..86b89add32 --- /dev/null +++ b/README.org @@ -0,0 +1,53 @@ +#+title: Pabbrev - Predictive Abbreviation Expansions for Emacs +#+author: Phillip Lord +#+language: en +#+export_file_name: pabbrev.texi +#+texinfo_dir_category: Emacs convenience features +#+texinfo_dir_title: Pabbrev: (pabbrev). +#+texinfo_dir_desc: Predictive Abbreviations + +#+html: <a href="https://elpa.gnu.org/packages/pabbrev.html";><img alt="GNU ELPA" src="https://elpa.gnu.org/packages/pabbrev.svg"/></a> +#+html: <a href="https://melpa.org/packages/pabbrev";><img alt="MELPA" src="https://melpa.org/packages/pabbrev-badge.svg"/></a> + +Pabbrev provides predictive abbreviation expansion with no configuration needed +and works with any mode. + +Pabbrev is another abbreviation expansion mode somewhat like +dabbrev-expand, in that it looks through the current buffer for +symbols that can complete the current symbol. Unlike dabbrev-expand, +it does this by discovering the words during the Emacs idle time, and +places the results into data structures which enable very rapid +extraction of expansions. The upshot of this is that it can offer +suggestions as you type, without causing an unacceptable slow down. + +Pabbrev is a small package, un-intrusive and out of the way. Pabbrev +can be used with Emacs completion facilities and packages such as Company +or Corfu, for the user interaction and user interface. + +* Features + +- Timer-based auto-suggestions (does not block main user-interface) +- In-buffer color-coded display of best candidate +- Suggestions ranked by usage frequency or shortest-prefix +- The best suggestion is inserted with TAB, on demand +- List of all available suggestions + +* Installation and Configuration + +Pabbrev is available from [[https://elpa.gnu.org/packages/corfu.html][GNU ELPA]]. You can install it directly via +~package-install~. + +To enable pabbrev in your Emacs, run =M-x global-pabbrev-mode=. + +* Key bindings + +Pabbrev bind keybindings in pabbrev-mode-map, and currently only binds +<TAB> key to pabbrev-expand-maybe function. + +* Contributions + +All non-significant contributions to this package require a copyright assignment +to the FSF. + + +