code.delx.au - gnu-emacs-elpa/blob - packages/nameless/README.org

   1 #+OPTIONS: toc:nil num:nil
   2
   3 * Nameless
   4 Hide package namespace in your emacs-lisp code.
   5
   6 Simply put, turn on this minor mode, and you’ll see this
   7 [[file:example-nameless-on.png]]\\
   8 instead of this
   9 [[file:example-nameless-off.png]]
  10
  11 ** Usage
  12
  13 To use this package add the following configuration to your Emacs init file.
  14
  15 #+BEGIN_SRC emacs-lisp
  16 (add-hook 'emacs-lisp-mode-hook #'nameless-mode)
  17 #+END_SRC
  18
  19 You can configure a string to use instead of ~:~ by setting the
  20 ~nameless-prefix~, and the name of the face used is ~nameless-face~.
  21 You can even just hide the prefix completely by setting this variable
  22 to an empty string.
  23
  24 While the mode is active, the =_= key inserts the package namespace if
  25 appropriate.
  26
  27 * Configuration
  28
  29 Nameless can also be used to “import” other packages as aliases. For
  30 instance, in the default behaviour, functions in the ~font-lock~
  31 package (e.g., ~font-lock-add-keywords~) will be displayed with the
  32 ~fl:~ prefix (e.g., ~fl:add-keywords~).
  33
  34 You can configure your own aliases globally with
  35 ~nameless-global-aliases~, and on a file-local basis with
  36 ~nameless-aliases~.