]> code.delx.au - gnu-emacs/blobdiff - lispref/help.texi
no @anchor in mid-paragraph
[gnu-emacs] / lispref / help.texi
index 0fe996dfd7ca62e747d2eae5c536f91c17000d16..70c7a48c9c49b0205a0d0b76fe5b32aed34fbb34 100644 (file)
@@ -1,7 +1,7 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
-@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002, 2003,
-@c   2004, 2005, 2006 Free Software Foundation, Inc.
+@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
+@c   2002, 2003, 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../info/help
 @node Documentation, Files, Modes, Top
@@ -22,6 +22,10 @@ of documentation strings is not sufficient as a manual because a good
 manual is not organized in that fashion; it is organized in terms of
 topics of discussion.
 
+  For commands to display documentation strings, see @ref{Help, ,
+Help, emacs, The GNU Emacs Manual}.  For the conventions for writing
+documentation strings, see @ref{Documentation Tips}.
+
 @menu
 * Documentation Basics::      Good style for doc strings.
                                 Where to put them.  How Emacs stores them.
@@ -63,6 +67,10 @@ documentation is displayed.  This allows documentation strings to refer
 to the keys for related commands and be accurate even when a user
 rearranges the key bindings.  (@xref{Keys in Documentation}.)
 
+@vindex emacs-lisp-docstring-fill-column
+  Emacs Lisp mode fills documentation strings to the width
+specified by @code{emacs-lisp-docstring-fill-column}.
+
   In Emacs Lisp, a documentation string is accessible through the
 function or variable that it describes:
 
@@ -83,9 +91,7 @@ list under the property name @code{variable-documentation}.  The
 function @code{documentation-property} knows how to retrieve it.
 @end itemize
 
-@cindex @file{DOC} (documentation) file
-@cindex @file{emacs/etc/DOC-@var{version}}
-@cindex @file{etc/DOC-@var{version}}
+@cindex @file{DOC-@var{version}} (documentation) file
 To save space, the documentation for preloaded functions and variables
 (including primitive functions and autoloaded functions) is stored in
 the file @file{emacs/etc/DOC-@var{version}}---not inside Emacs.  The
@@ -100,9 +106,6 @@ documentation string.  The functions @code{documentation} and
 documentation string from the appropriate file; this is transparent to
 the user.
 
-  For information on the uses of documentation strings, see @ref{Help, ,
-Help, emacs, The GNU Emacs Manual}.
-
 @c Wordy to prevent overfull hbox.  --rjc 15mar92
   The @file{emacs/lib-src} directory contains two utilities that you can
 use to print nice-looking hardcopy for the file
@@ -383,6 +386,7 @@ C-g             abort-recursive-edit
 
 @node Describing Characters
 @section Describing Characters for Help Messages
+@cindex describe characters and events
 
   These functions convert events, key sequences, or characters to
 textual descriptions.  These descriptions are useful for including
@@ -497,7 +501,7 @@ can also be used as a rough inverse for @code{key-description}.  You
 call it with a string containing key descriptions, separated by spaces;
 it returns a string or vector containing the corresponding events.
 (This may or may not be a single valid key sequence, depending on what
-events you use; @pxref{Keymap Terminology}.)  If @var{need-vector} is
+events you use; @pxref{Key Sequences}.)  If @var{need-vector} is
 non-@code{nil}, the return value is always a vector.
 @end defun