JezK
Edit File: _0040documentdescription.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>@documentdescription (GNU Texinfo 6.8)</title> <meta name="description" content="@documentdescription (GNU Texinfo 6.8)"> <meta name="keywords" content="@documentdescription (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="Generating-HTML.html" rel="up" title="Generating HTML"> <link href="HTML-Xref.html" rel="prev" title="HTML Xref"> <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="g_t_0040documentdescription"> <div class="header"> <p> Previous: <a href="HTML-Xref.html" accesskey="p" rel="prev">HTML Cross-references</a>, Up: <a href="Generating-HTML.html" accesskey="u" rel="up">Generating HTML</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="g_t_0040documentdescription_003a-Summary-Text"></span><h3 class="section">21.5 <code>@documentdescription</code>: Summary Text</h3> <span id="documentdescription"></span> <span id="index-Document-description"></span> <span id="index-Description-of-document"></span> <span id="index-Summary-of-document"></span> <span id="index-Abstract-of-document"></span> <span id="index-_003cmeta_003e-HTML-tag_002c-and-document-description"></span> <span id="index-documentdescription"></span> <p>When producing HTML output for a document, <code>makeinfo</code> writes a ‘<samp><meta></samp>’ element in the ‘<samp><head></samp>’ to give some idea of the content of the document. By default, this <em>description</em> is the title of the document, taken from the <code>@settitle</code> command (see <a href="_0040settitle.html"><code>@settitle</code>: Set the Document Title</a>). To change this, use the <code>@documentdescription</code> environment, as in: </p> <div class="example"> <pre class="example">@documentdescription descriptive text. @end documentdescription </pre></div> <p>This will produce the following output in the ‘<samp><head></samp>’ of the HTML: </p> <div class="example"> <pre class="example"><meta name=description content="descriptive text."> </pre></div> <p><code>@documentdescription</code> must be specified before the first node of the document. </p> </div> </body> </html>