Viewing File: /usr/share/doc/texinfo/html/_0040documentdescription.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>@documentdescription (GNU Texinfo 6.7)</title>

<meta name="description" content="@documentdescription (GNU Texinfo 6.7)">
<meta name="keywords" content="@documentdescription (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<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="Global-Document-Commands.html" rel="up" title="Global Document Commands">
<link href="_0040setchapternewpage.html" rel="next" title="@setchapternewpage">
<link href="Global-Document-Commands.html" rel="prev" title="Global Document Commands">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="g_t_0040documentdescription"></span><div class="header">
<p>
Next: <a href="_0040setchapternewpage.html" accesskey="n" rel="next"><code>@setchapternewpage</code></a>, Up: <a href="Global-Document-Commands.html" accesskey="u" rel="up">Global Document Commands</a> &nbsp; [<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><h4 class="subsection">3.7.1 <code>@documentdescription</code>: Summary Text</h4>
<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
&lsquo;<samp>&lt;meta&gt;</samp>&rsquo; element in the &lsquo;<samp>&lt;head&gt;</samp>&rsquo; 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></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 &lsquo;<samp>&lt;head&gt;</samp>&rsquo; of the HTML:
</p>
<div class="example">
<pre class="example">&lt;meta name=description content=&quot;descriptive text.&quot;&gt;
</pre></div>

<p><code>@documentdescription</code> must be specified before the first node of
the document.
</p>




</body>
</html>
Back to Directory File Manager