changeset 67491:e5693a64f4ea

(Common Keywords): State caveats for use of :tag.
author Richard M. Stallman <rms@gnu.org>
date Sun, 11 Dec 2005 04:42:52 +0000
parents 76e4d7c8d043
children 359dd650750d
files lispref/customize.texi
diffstat 1 files changed, 10 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/customize.texi	Sun Dec 11 01:06:48 2005 +0000
+++ b/lispref/customize.texi	Sun Dec 11 04:42:52 2005 +0000
@@ -34,8 +34,16 @@
 
 @table @code
 @item :tag @var{label}
-Use @var{label}, a string, instead of the item's name, to label the item
-in customization menus and buffers.
+Use @var{label}, a string, instead of the item's name, to label the
+item in customization menus and buffers.  @strong{Don't use a tag
+which is substantially different from the item's real name; that would
+cause confusion.}  One legitimate case for use of @code{:tag} is to
+specify a dash where normally a hyphen would be converted to a space:
+
+@example
+(defcustom cursor-in-non-selected-windows @dots{}
+  :tag "Cursor In Non-selected Windows"
+@end example
 
 @item :group @var{group}
 Put this customization item in group @var{group}.  When you use