Mercurial > hg > xemacs-beta

comparison man/lispref/help.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents 755ae5b97edb
children 916b48abd1c6
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
30 non-printing characters and key sequences. 30 non-printing characters and key sequences.
31 * Help Functions:: Subroutines used by XEmacs help facilities. 31 * Help Functions:: Subroutines used by XEmacs help facilities.
32 * Obsoleteness:: Upgrading Lisp functionality over time. 32 * Obsoleteness:: Upgrading Lisp functionality over time.
33 @end menu 33 @end menu
34 34
35 @node Documentation Basics 35 @node Documentation Basics, Accessing Documentation, Documentation, Documentation
36 @section Documentation Basics 36 @section Documentation Basics
37 @cindex documentation conventions 37 @cindex documentation conventions
38 @cindex writing a documentation string 38 @cindex writing a documentation string
39 @cindex string, writing a doc string 39 @cindex string, writing a doc string
40 40
100 The @file{emacs/lib-src} directory contains two utilities that you can 100 The @file{emacs/lib-src} directory contains two utilities that you can
101 use to print nice-looking hardcopy for the file 101 use to print nice-looking hardcopy for the file
102 @file{emacs/etc/DOC-@var{version}}. These are @file{sorted-doc.c} and 102 @file{emacs/etc/DOC-@var{version}}. These are @file{sorted-doc.c} and
103 @file{digest-doc.c}. 103 @file{digest-doc.c}.
104 104
105 @node Accessing Documentation 105 @node Accessing Documentation, Keys in Documentation, Documentation Basics, Documentation
106 @section Access to Documentation Strings 106 @section Access to Documentation Strings
107 107
108 @defun documentation-property symbol property &optional verbatim 108 @defun documentation-property symbol property &optional verbatim
109 This function returns the documentation string that is recorded in 109 This function returns the documentation string that is recorded in
110 @var{symbol}'s property list under property @var{property}. It 110 @var{symbol}'s property list under property @var{property}. It
279 certain system independent documentation and text files that come 279 certain system independent documentation and text files that come
280 with XEmacs. In older Emacs versions, @code{exec-directory} was used for 280 with XEmacs. In older Emacs versions, @code{exec-directory} was used for
281 this. 281 this.
282 @end defvar 282 @end defvar
283 283
284 @node Keys in Documentation 284 @node Keys in Documentation, Describing Characters, Accessing Documentation, Documentation
285 @section Substituting Key Bindings in Documentation 285 @section Substituting Key Bindings in Documentation
286 @cindex documentation, keys in 286 @cindex documentation, keys in
287 @cindex keys in documentation strings 287 @cindex keys in documentation strings
288 @cindex substituting keys in documentation 288 @cindex substituting keys in documentation
289 289
373 thus, \=\= puts \= into the output, 373 thus, \=\= puts \= into the output,
374 and \=\[ puts \[ into the output." 374 and \=\[ puts \[ into the output."
375 @end group 375 @end group
376 @end smallexample 376 @end smallexample
377 377
378 @node Describing Characters 378 @node Describing Characters, Help Functions, Keys in Documentation, Documentation
379 @section Describing Characters for Help Messages 379 @section Describing Characters for Help Messages
380 380
381 These functions convert events, key sequences or characters to textual 381 These functions convert events, key sequences or characters to textual
382 descriptions. These descriptions are useful for including arbitrary 382 descriptions. These descriptions are useful for including arbitrary
383 text characters or key sequences in messages, because they convert 383 text characters or key sequences in messages, because they convert
448 @result{} "M-^M" 448 @result{} "M-^M"
449 @end group 449 @end group
450 @end smallexample 450 @end smallexample
451 @end defun 451 @end defun
452 452
453 @node Help Functions 453 @node Help Functions, Obsoleteness, Describing Characters, Documentation
454 @section Help Functions 454 @section Help Functions
455 455
456 XEmacs provides a variety of on-line help functions, all accessible to 456 XEmacs provides a variety of on-line help functions, all accessible to
457 the user as subcommands of the prefix @kbd{C-h}, or on some keyboards, 457 the user as subcommands of the prefix @kbd{C-h}, or on some keyboards,
458 @kbd{help}. For more information about them, see @ref{Help, , Help, 458 @kbd{help}. For more information about them, see @ref{Help, , Help,
664 echo area at first, and display the longer @var{help-text} strings only 664 echo area at first, and display the longer @var{help-text} strings only
665 if the user types the help character again. 665 if the user types the help character again.
666 @end defopt 666 @end defopt
667 @end ignore 667 @end ignore
668 668
669 @node Obsoleteness 669 @node Obsoleteness, , Help Functions, Documentation
670 @section Obsoleteness 670 @section Obsoleteness
671 671
672 As you add functionality to a package, you may at times want to 672 As you add functionality to a package, you may at times want to
673 replace an older function with a new one. To preserve compatibility 673 replace an older function with a new one. To preserve compatibility
674 with existing code, the older function needs to still exist; but 674 with existing code, the older function needs to still exist; but