JezK
Edit File: Include-Files-Requirements.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>Include Files Requirements (GNU Texinfo 6.8)</title> <meta name="description" content="Include Files Requirements (GNU Texinfo 6.8)"> <meta name="keywords" content="Include Files Requirements (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="Include-Files.html" rel="up" title="Include Files"> <link href="Sample-Include-File.html" rel="next" title="Sample Include File"> <link href="texinfo_002dmultiple_002dfiles_002dupdate.html" rel="prev" title="texinfo-multiple-files-update"> <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="Include-Files-Requirements"> <div class="header"> <p> Next: <a href="Sample-Include-File.html" accesskey="n" rel="next">Sample File with <code>@include</code></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> [<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">17.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 ‘Top’ node. It should <em>not</em> contain any nodes besides the single ‘Top’ node. The <code>texinfo-multiple-files-update</code> command will not process them. </p> </div> </body> </html>