branch: externals/pabbrev commit c54a59cf4bdda667a6a6a0db1cb9f512052eefdc Author: Arthur Miller <arthur.mil...@live.com> Commit: Arthur Miller <arthur.mil...@live.com>
New Readme file in Org-mode. --- README.org | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.org b/README.org new file mode 100644 index 0000000000..0bd8b13faf --- /dev/null +++ b/README.org @@ -0,0 +1,52 @@ +#+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://www.gnu.org/software/emacs/";><img alt="GNU Emacs" src="https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white"; +#+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://elpa.gnu.org/devel/pabbrev.html";><img alt="GNU-devel ELPA" src="https://elpa.gnu.org/devel/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. +It wors with any mode. + +Pabbrev is a small package, which analyzes buffer text in the buffer and +collects usage statistics to rank most used words highest. Pabbrev is +un-intrusive and out of the way. It does not provide any user interface on its +own other than TAB-based insertion on demand. Pabbrev can be used with Emacs +completion facilities and packages such as Companry or Corfu, for the user +interaction and user interface. + +For more details see pabbrev.el + +* Features + +- Timer-based auto-suggestions (does not block main user-interface) +- In-buffer color-coded display of best candidate +- Suggestions by usage frequency or shortest-prefix +- The current candidate is inserted with =TAB= +- List of all available suggestions + +* Installation and Configuration + +Pabbrev is available from [[https://elpa.gnu.org/packages/corfu.html][GNU ELPA]], and can be installed directly via +~package-install~. After installation, the global minor mode can be enabled with +=M-x global-pabbrev-mode=. In order to configure Pabbrev and other packages in +your init.el, you may want to use the built-in ~use-package~. + +* Key bindings + +Pabbrev bind keybindings in pabbrev-mode-map, and currently only binds +<TAB> key to pabbrev-exapnd-maybe function. + +* Contributions + +All non-significant contributions to this package require a copyright assignment +to the FSF. + + +