JezK
Edit File: Def-Cmd-Continuation-Lines.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>Def Cmd Continuation Lines (GNU Texinfo 6.8)</title> <meta name="description" content="Def Cmd Continuation Lines (GNU Texinfo 6.8)"> <meta name="keywords" content="Def Cmd Continuation Lines (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="Definition-Commands.html" rel="up" title="Definition Commands"> <link href="Optional-Arguments.html" rel="next" title="Optional Arguments"> <link href="Def-Cmd-Template.html" rel="prev" title="Def Cmd Template"> <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="section" id="Def-Cmd-Continuation-Lines"> <div class="header"> <p> Next: <a href="Optional-Arguments.html" accesskey="n" rel="next">Optional and Repeated Arguments</a>, Previous: <a href="Def-Cmd-Template.html" accesskey="p" rel="prev">The Template for a Definition</a>, Up: <a href="Definition-Commands.html" accesskey="u" rel="up">Definition Commands</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-Command-Continuation-Lines"></span><h3 class="section">13.2 Definition Command Continuation Lines</h3> <span id="index-Continuation-lines-in-definition-commands"></span> <span id="index-Definition-command-headings_002c-continuing"></span> <span id="index-_0040_0040-as-continuation-in-definition-commands"></span> <p>The heading line of a definition command can get very long. Therefore, Texinfo has a special syntax allowing them to be continued over multiple lines of the source file: a lone ‘<samp>@</samp>’ at the end of each line to be continued. Here’s an example: </p> <div class="example"> <pre class="example">@defun fn-name @ arg1 arg2 arg3 This is the basic continued defun. @end defun </pre></div> <p>produces: </p> <dl class="def"> <dt id="index-fn_002dname"><span class="category">Function: </span><span><strong>fn-name</strong> <em>arg1 arg2 arg3</em><a href='#index-fn_002dname' class='copiable-anchor'> ¶</a></span></dt> <dd><p>This is the basic continued defun. </p></dd></dl> <p>As you can see, the continued lines are combined, as if they had been typed on one source line. </p> <p>Although this example only shows a one-line continuation, continuations may extend over any number of lines, in the same way; put an <code>@</code> at the end of each line to be continued. </p> <span id="index-Whitespace_002c-collapsed-around-continuations"></span> <span id="index-Collapsing-whitespace-around-continuations"></span> <p>In general, any number of spaces or tabs before the <code>@</code> continuation character are collapsed into a single space. There is one exception: the Texinfo processors will not fully collapse whitespace around a continuation inside braces. For example: </p> <div class="example"> <pre class="example">@deffn {Category @ Name} … </pre></div> <p>The output (not shown) has excess space between ‘Category’ and ‘Name’. To avoid this, elide the unwanted whitespace in your input, or put the continuation <code>@</code> outside braces. </p> <p><code>@</code> does not function as a continuation character in <em>any</em> other context. Ordinarily, ‘<samp>@</samp>’ followed by a whitespace character (space, tab, newline) produces a normal interword space (see <a href="Multiple-Spaces.html">Multiple Spaces</a>). </p> </div> <hr> <div class="header"> <p> Next: <a href="Optional-Arguments.html">Optional and Repeated Arguments</a>, Previous: <a href="Def-Cmd-Template.html">The Template for a Definition</a>, Up: <a href="Definition-Commands.html">Definition Commands</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> </body> </html>