Merge commit 'a3dfd7ecf9c58898241c8d1145eb8e0c875f5448'

[gnu-emacs-elpa] / packages / nameless / README.org

diff --git a/packages/nameless/README.org b/packages/nameless/README.org
index 75f8835d1e1f1c14e79dde9e8187837f14887250..9d8b7eb5e906134b60b707729657ecc3d7f69426 100644 (file)
--- a/packages/nameless/README.org
+++ b/packages/nameless/README.org
@@ -22,13 +22,13 @@ You can configure a string to use instead of ~:~ by setting the
 You can even just hide the prefix completely by setting this variable
 to an empty string.
 
 You can even just hide the prefix completely by setting this variable
 to an empty string.
 

-While the mode is active, the <kbd>C-c C--</kbd> key inserts the
+While the mode is active, the =C-c C--= key inserts the

 package namespace if appropriate.
 
 * Configuration
 
 ** Quickly typing the namespace
 package namespace if appropriate.
 
 * Configuration
 
 ** Quickly typing the namespace

-~nameless-mode~ binds the <kbd>C-c C--</kbd> key to
+~nameless-mode~ binds the =C-c C--= key to

 ~nameless-insert-name~, which immediately inserts the current name for
 you, or even expands aliases to the names they point to.
 
 ~nameless-insert-name~, which immediately inserts the current name for
 you, or even expands aliases to the names they point to.
 


@@ -39,7 +39,7 @@ fl C-c C-- → font-lock-
 #+END_SRC
 
 There’s also a command called ~nameless-insert-name-or-self-insert~.
 #+END_SRC
 
 There’s also a command called ~nameless-insert-name-or-self-insert~.

-You can bind this to the <kbd>_</kbd> key and make it even faster to
+You can bind this to the =_= key and make it even faster to

 insert the name.
 ** Configuring the namespace name
 Nameless guesses the package name with the ~lm-get-package-name~
 insert the name.
 ** Configuring the namespace name
 Nameless guesses the package name with the ~lm-get-package-name~


@@ -53,6 +53,11 @@ M-x add-file-local-variable RET nameless-current-name RET "package-name"
 You can also set the same name for all lisp files in a project by
 setting dir-local variables with ~M-x add-file-local-variable~.
 
 You can also set the same name for all lisp files in a project by
 setting dir-local variables with ~M-x add-file-local-variable~.
 

+If you /don’t/ want Nameless to use a namespace name at all (neither
+manual nor automatic), you can set ~nameless-discover-current-name~ to
+~nil~. This will disable this functionality, so that Nameless will
+/only/ use aliases (see next item).
+

 ** Requiring other packages as aliases
 Nameless can also be used to “import” other packages as aliases. For
 instance, in the default behaviour, functions in the ~font-lock~
 ** Requiring other packages as aliases
 Nameless can also be used to “import” other packages as aliases. For
 instance, in the default behaviour, functions in the ~font-lock~


@@ -75,13 +80,31 @@ as a file-local variable.
 ;; nameless-aliases: (("c" . "cider"))
 ;; End:
 #+END_SRC
 ;; nameless-aliases: (("c" . "cider"))
 ;; End:
 #+END_SRC

-/Note that there’s no ~quote~ before ~((c~!/\\
+Note that there’s no ~quote~ before ~((c~!\\

 You can also configure it for a whole project, by setting it as a dir-local variable.
 
 You can also configure it for a whole project, by setting it as a dir-local variable.
 

+** Private symbols
+
+Private symbols in elisp are written with an extra dash after the
+prefix (e.g., ~foobar--indent-impl~). With Nameless, these are usually
+displayed as ~:-indent-impl~, but you can also make them be displayed
+as ~::indent-impl~ by setting
+
+#+BEGIN_SRC emacs-lisp
+(setq nameless-private-prefix t)
+#+END_SRC
+
+** Packages that don’t use ~-~ (hyphen) as a separator
+You can set ~nameless-separator~ file-locally to whatever separator
+you package uses. Most packages use hyphens, by some use ~/~, ~|~, or
+~:~.
+
+You can also set it to ~nil~ globally and the separator will never be
+hidden.

 ** Indentation and paragraph filling
 Hiding parts of symbols could affect the way Emacs indents your code
 and fills your paragraphs. Nameless lets you decide whether you want
 ** Indentation and paragraph filling
 Hiding parts of symbols could affect the way Emacs indents your code
 and fills your paragraphs. Nameless lets you decide whether you want

-that to happen or not. 
+that to happen or not.

 
 The default behavior is that code is indented according to what you
 see (i.e., according to short symbols), but text inside strings is
 
 The default behavior is that code is indented according to what you
 see (i.e., according to short symbols), but text inside strings is