File Manager

Editing File: /usr/share/doc/texinfo/html/Include-Files-Requirements.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". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Include Files Requirements (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<span id="Include-Files-Requirements"></span><div class="header">
<p>
Next: <a href="Sample-Include-File.html" accesskey="n" rel="next">Sample Include File</a>, Previous: <a href="texinfo_002dmultiple_002dfiles_002dupdate.html" accesskey="p" rel="prev"><code>texinfo-multiple-files-update</code></a>, Up: <a href="Include-Files.html" accesskey="u" rel="up">Include Files</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="Include-Files-Requirements-1"></span><h3 class="section">18.3 Include Files Requirements</h3>
<span id="index-Include-files-requirements"></span>
<span id="index-Requirements-for-include-files"></span>

<p>If you plan to use the <code>texinfo-multiple-files-update</code> command,
the outer Texinfo file that lists included files within it should
contain nothing but the beginning and end parts of a Texinfo file, and
a number of <code>@include</code> commands listing the included files.  It
should not even include indices, which should be listed in an included
file of their own.
</p>
<p>Moreover, each of the included files must contain exactly one highest
level node (conventionally, <code>@chapter</code> or equivalent),
and this node must be the first node in the included file.
Furthermore, each of these highest level nodes in each included file
must be at the same hierarchical level in the file structure.
Usually, each is a <code>@chapter</code>, an <code>@appendix</code>, or an
<code>@unnumbered</code> node.  Thus, normally, each included file contains
one, and only one, chapter or equivalent-level node.
</p>
<p>The outer file should contain only <em>one</em> node, the &lsquo;Top&rsquo; node.  It
should <em>not</em> contain any nodes besides the single &lsquo;Top&rsquo; node.  The
<code>texinfo-multiple-files-update</code> command will not process
them.
</p>

</body>
</html>

Back to Directory File Manager