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

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