JezK
Edit File: Inserting-an-Ampersand.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>Inserting an Ampersand (GNU Texinfo 6.8)</title> <meta name="description" content="Inserting an Ampersand (GNU Texinfo 6.8)"> <meta name="keywords" content="Inserting an Ampersand (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="Special-Characters.html" rel="up" title="Special Characters"> <link href="Inserting-a-Hashsign.html" rel="prev" title="Inserting a Hashsign"> <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="subsection" id="Inserting-an-Ampersand"> <div class="header"> <p> Previous: <a href="Inserting-a-Hashsign.html" accesskey="p" rel="prev">Inserting ‘#’ with <code>@hashchar{}</code></a>, Up: <a href="Special-Characters.html" accesskey="u" rel="up">Special Characters: Inserting @ {} , \ # &</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="Inserting-_0060_0026_0027-with-_0040_0026-and-_0040ampchar_007b_007d"></span><h4 class="subsection">11.1.6 Inserting ‘&’ with <code>@&</code> and <code>@ampchar{}</code></h4> <span id="index-ampchar_007b_007d-_0028literal-_0026_0029"></span> <span id="index-Inserting-_0026"></span> <span id="index-Ampersand_002c-inserting"></span> <p>Ordinarily, an ampersand ‘&’ is a normal character in Texinfo that can be simply typed in your input where you need it. The result is to typeset the ampersand character. </p> <p>However, the ampersand character has a special meaning in Texinfo in just one restricted context. In the argument to a definition command (see <a href="Definition-Commands.html">Definition Commands</a>), Emacs Lisp keywords beginning with ampersands are recognized and typeset specially. See <a data-manual="elisp" href="../elisp/A-Sample-Function-Description.html#A-Sample-Function-Description">A Sample Function Description</a> in <cite>GNU Emacs Lisp Reference Manual</cite>. For example: </p> <div class="example"> <pre class="example">@defun foo integer1 &optional integer2 &rest integers @code{foo} described here. @end defun </pre></div> <p>leads to the output </p> <dl class="def"> <dt id="index-foo"><span class="category">Function: </span><span><strong>foo</strong> <em>integer1 &optional integer2 &rest integers</em><a href='#index-foo' class='copiable-anchor'> ¶</a></span></dt> <dd><p><code>foo</code> described here. </p></dd></dl> <p>So, in order to typeset an ampersand in such a context (for example, in documentation of a C++ function taking a reference as a parameter), it’s necessary to use <code>@&</code> or some other construct. Here’s an example: </p> <div class="example"> <pre class="example">@deftypefn Function int foo (@code{const std::vector<int>@&} bar) Documentation of @code{foo}. @end deftypefn </pre></div> <p>This gives the output </p> <dl class="def"> <dt id="index-foo-1"><span class="category">Function: </span><span><em>int</em> <strong>foo</strong> <em>(<code>const std::vector<int>&</code> bar)</em><a href='#index-foo-1' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Documentation of <code>foo</code>. </p></dd></dl> <p>Although ‘<samp>@&</samp>’ and ‘<samp>@ampchar{}</samp>’ can be used nearly anywhere, there is no need for them anywhere except this unusual case. </p> </div> </body> </html>