diff options
Diffstat (limited to 'devdocs/elisp/documentation.html')
| -rw-r--r-- | devdocs/elisp/documentation.html | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/devdocs/elisp/documentation.html b/devdocs/elisp/documentation.html new file mode 100644 index 00000000..932416ea --- /dev/null +++ b/devdocs/elisp/documentation.html @@ -0,0 +1,41 @@ + <h2 class="chapter">Documentation</h2> <p>GNU Emacs has convenient built-in help facilities, most of which derive their information from documentation strings associated with functions and variables. This chapter describes how to access documentation strings in Lisp programs. </p> <p>The contents of a documentation string should follow certain conventions. In particular, its first line should be a complete sentence (or two complete sentences) that briefly describes what the function or variable does. See <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html">Documentation Tips</a>, for how to write good documentation strings. </p> <p>Note that the documentation strings for Emacs are not the same thing as the Emacs manual. Manuals have their own source files, written in the Texinfo language; documentation strings are specified in the definitions of the functions and variables they apply to. A collection 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. </p> <p>For commands to display documentation strings, see <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Help.html#Help">Help</a> in <cite>The GNU Emacs Manual</cite>. </p> <table class="menu" border="0" cellspacing="0"> <tr> +<td align="left" valign="top">• <a href="documentation-basics" accesskey="1">Documentation Basics</a> +</td> +<td> </td> +<td align="left" valign="top">Where doc strings are defined and stored. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="accessing-documentation" accesskey="2">Accessing Documentation</a> +</td> +<td> </td> +<td align="left" valign="top">How Lisp programs can access doc strings. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="keys-in-documentation" accesskey="3">Keys in Documentation</a> +</td> +<td> </td> +<td align="left" valign="top">Substituting current key bindings. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="text-quoting-style" accesskey="4">Text Quoting Style</a> +</td> +<td> </td> +<td align="left" valign="top">Quotation marks in doc strings and messages. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="describing-characters" accesskey="5">Describing Characters</a> +</td> +<td> </td> +<td align="left" valign="top">Making printable descriptions of non-printing characters and key sequences. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="help-functions" accesskey="6">Help Functions</a> +</td> +<td> </td> +<td align="left" valign="top">Subroutines used by Emacs help facilities. </td> +</tr> <tr> +<td align="left" valign="top">• <a href="documentation-groups" accesskey="7">Documentation Groups</a> +</td> +<td> </td> +<td align="left" valign="top">Listing functions by groups. </td> +</tr> </table><div class="_attribution"> + <p class="_attribution-p"> + Copyright © 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br> + <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation.html</a> + </p> +</div> |