branch: externals/marginalia
commit 3f33b38b7c1ecd7086942e1bd8284c54a6fd30a3
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Prepare submission to ELPA
---
marginalia.el | 4 +-
marginalia.texi | 137 --------------------------------------------------------
2 files changed, 3 insertions(+), 138 deletions(-)
diff --git a/marginalia.el b/marginalia.el
index ffa7155..0f6f98f 100644
--- a/marginalia.el
+++ b/marginalia.el
@@ -1,5 +1,7 @@
;;; marginalia.el --- Enrich existing commands with completion annotations -*-
lexical-binding: t -*-
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
;; Author: Omar Antolín Camarena <o...@matem.unam.mx>, Daniel Mendler
<m...@daniel-mendler.de>
;; Maintainer: Omar Antolín Camarena <o...@matem.unam.mx>, Daniel Mendler
<m...@daniel-mendler.de>
;; Created: 2020
@@ -8,7 +10,7 @@
;; Package-Requires: ((emacs "26.1"))
;; Homepage: https://github.com/minad/marginalia
-;; This file is not part of GNU Emacs.
+;; This file is part of GNU Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
diff --git a/marginalia.texi b/marginalia.texi
deleted file mode 100644
index 2db3767..0000000
--- a/marginalia.texi
+++ /dev/null
@@ -1,137 +0,0 @@
-\input texinfo @c -*- texinfo -*-
-@c %**start of header
-@setfilename marginalia.info
-@settitle marginalia.el - Marginalia in the minibuffer
-@documentencoding UTF-8
-@documentlanguage en
-@c %**end of header
-
-@dircategory Emacs
-@direntry
-* Marginalia: (marginalia). Marginalia in the minibuffer.
-@end direntry
-
-@finalout
-@titlepage
-@title marginalia.el - Marginalia in the minibuffer
-@author Omar Antolín Camarena, Daniel Mendler
-@end titlepage
-
-@contents
-
-@ifnottex
-@node Top
-@top marginalia.el - Marginalia in the minibuffer
-@end ifnottex
-
-@menu
-* Introduction::
-* Configuration::
-* Using builtin or lightweight annotators::
-* Contributions::
-@end menu
-
-@node Introduction
-@chapter Introduction
-
-This package provides @samp{marginalia-mode} which adds marginalia to the
-minibuffer completions.
-@uref{https://en.wikipedia.org/wiki/Marginalia, Marginalia} are marks or
-annotations placed at the margin of the page of a book or in this case
-helpful colorful annotations placed at the margin of the minibuffer for
-your completion candidates. Marginalia can only add annotations to be
-displayed with the completion candidates. It cannot modify the
-appearance of the candidates themselves, which are shown as supplied by
-the original commands.
-
-The annotations are added based on the completion category. For example
-@samp{find-file} reports the @samp{file} category and @samp{M-x} reports the
@samp{command}
-category. You can cycle between more or less detailed annotators with the
-command @samp{marginalia-cycle}.
-
-Since many commands do not report a completion category themselves,
-Marginalia provides a classifier system, which tries to guess the
-correct category based for example on the prompt (see the variable
-@samp{marginalia-prompt-categories}). Usually these heuristic classifiers
-work well, but if they do not there is always the possibility to
-overwrite categories by command name. This way you can associate a fixed
-category with the completion initiated by the command (see the variable
-@samp{marginalia-command-categories}). The list of available classifiers is
-specified by the variable @samp{marginalia-classifiers}.
-
-@node Configuration
-@chapter Configuration
-
-It is recommended to use Marginalia together with either the
@uref{https://github.com/raxod502/selectrum, Selectrum},
@uref{https://github.com/minad/vertico, Vertico}
-or the @uref{https://github.com/oantolin/icomplete-vertical,
Icomplete-vertical} completion system. Furthermore Marginalia can be
-combined with @uref{https://github.com/oantolin/embark, Embark} for action
support and @uref{https://github.com/minad/consult, Consult}, which provides
many useful
-commands.
-
-@lisp
-;; Enable richer annotations using the Marginalia package
-(use-package marginalia
- ;; Either bind `marginalia-cycle` globally or only in the minibuffer
- :bind (("M-A" . marginalia-cycle)
- :map minibuffer-local-map
- ("M-A" . marginalia-cycle))
-
- ;; The :init configuration is always executed (Not lazy!)
- :init
-
- ;; Must be in the :init section of use-package such that the mode gets
- ;; enabled right away. Note that this forces loading the package.
- (marginalia-mode))
-@end lisp
-
-@node Using builtin or lightweight annotators
-@chapter Using builtin or lightweight annotators
-
-Marginalia activates rich annotators by default. Depending on your preference
-you may want to use the builtin annotators or even no annotators by default and
-only activate the annotators on demand by invoking @code{marginalia-cycle}.
-
-In order to use the builtin annotators by default, you can use the following
-command. Replace @samp{builtin} by @samp{none} to disable annotators by
default.
-
-@lisp
-(defun marginalia-use-builtin ()
- (interactive)
- (mapc
- (lambda (x)
- (setcdr x (cons 'builtin (delq 'builtin (cdr x)))))
- marginalia-annotator-registry))
-@end lisp
-
-If a completion category supports two annotators, you can toggle between
-those using this command.
-
-@lisp
-(defun marginalia-toggle ()
- (interactive)
- (mapc
- (lambda (x)
- (setcdr x (append (nreverse (delq 'none
- (delq 'builtin (cdr x))))
- '(builtin none))))
- marginalia-annotator-registry))
-@end lisp
-
-After cycling the annotators you may want to automatically save the
-configuration. This can be achieved using an advice which calls
-@code{customize-save-variable}.
-
-@lisp
-(advice-add #'marginalia-cycle :after
- (lambda ()
- (let ((inhibit-message t))
- (customize-save-variable 'marginalia-annotator-registry
- marginalia-annotator-registry))))
-@end lisp
-
-@node Contributions
-@chapter Contributions
-
-Since it is planned to submit this package to GNU ELPA, contributions require a
-copyright assignment to the FSF@.
-
-@bye
\ No newline at end of file
