JezK
Edit File: Definition-Commands.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> <title>Definition Commands (GNU Texinfo 6.8)</title> <meta name="description" content="Definition Commands (GNU Texinfo 6.8)"> <meta name="keywords" content="Definition Commands (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html" rel="up" title="Top"> <link href="Internationalization.html" rel="next" title="Internationalization"> <link href="Breaks.html" rel="prev" title="Breaks"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="chapter" id="Definition-Commands"> <div class="header"> <p> Next: <a href="Internationalization.html" accesskey="n" rel="next">Internationalization</a>, Previous: <a href="Breaks.html" accesskey="p" rel="prev">Forcing and Preventing Breaks</a>, Up: <a href="index.html" accesskey="u" rel="up">Texinfo</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="Definition-Commands-1"></span><h2 class="chapter">13 Definition Commands</h2> <span id="index-Definition-commands"></span> <p>The <code>@deffn</code> command and the other <em>definition commands</em> enable you to describe functions, variables, macros, commands, user options, special forms and other such artifacts in a uniform format. </p> <p>In the Info file, a definition causes the entity category—‘Function’, ‘Variable’, or whatever—to appear at the beginning of the first line of the definition, followed by the entity’s name and arguments. In the printed manual, the command causes TeX to print the entity’s name and its arguments on the left margin and print the category next to the right margin. In both output formats, the body of the definition is indented. Also, the name of the entity is entered into the appropriate index: <code>@deffn</code> enters the name into the index of functions, <code>@defvr</code> enters it into the index of variables, and so on (see <a href="Predefined-Indices.html">Predefined Indices</a>). </p> <p>A manual need not and should not contain more than one definition for a given name. An appendix containing a summary should use <code>@table</code> rather than the definition commands. </p> <ul class="section-toc"> <li><a href="Def-Cmd-Template.html" accesskey="1">The Template for a Definition</a></li> <li><a href="Def-Cmd-Continuation-Lines.html" accesskey="2">Definition Command Continuation Lines</a></li> <li><a href="Optional-Arguments.html" accesskey="3">Optional and Repeated Arguments</a></li> <li><a href="_0040deffnx.html" accesskey="4"><code>@deffnx</code>, et al.: Two or More ‘First’ Lines</a></li> <li><a href="Def-Cmds-in-Detail.html" accesskey="5">The Definition Commands</a></li> <li><a href="Def-Cmd-Conventions.html" accesskey="6">Conventions for Writing Definitions</a></li> <li><a href="Sample-Function-Definition.html" accesskey="7">A Sample Function Definition</a></li> </ul> </div> </body> </html>