4.1 Specifying where to split the generated document
The HTML manual resulting from the processing of the Texinfo source
may be split into files at different levels. This is specified with the
option
‘--split’ which takes an argument, namely the level of splitting
(variable:
$SPLIT). This level may be:
- ‘chapter’
The document is split at @chapter, @appendix, or @unnumbered.
- ‘section’
The document is split at the same places as it is using the ‘chapter’
argument, and also at @section, @appendixsec or
@unnumberedsec.
- ‘node’
The document is split at every sectioning command. It is not necessarily
split at each node, if the @node structure doesn't correspond with
the sectioning command structure (see below).
- ‘none’
The document isn't split. This is the default.
There are two kinds of commands which may be used to define sectioning
elements in Texinfo: @node and the structuring commands (@top,
@section, @appendixsubsec, and so on). A node just preceding
a structuring command is considered to be part of the same sectioning element
as that command. If the @node Top isn't associated with a structuring
command it also defines a sectioning element.
By default, nodes which aren't associated with a structuring command are not
considered to be sectioning commands. They are always considered to be part
of a sectioning element defined by a structuring command. It is possible to
change this behaviour via the
‘--use-nodes’ option (variable
$USE_NODES). In this case, nodes not associated with structuring
commands are also considered to be sectioning commands defining a sectioning
element.
This default behaviour mimics texi2dvi behaviour, which ignores
@node commands for the purprose of sectioning, while the second
looks like makeinfo behaviour (see (texinfo)Two Paths section `Two Paths' in GNU Texinfo).
As an illustration, the following table shows how a sample Texinfo document is
divided into sectioning elements when
‘--use-nodes’ is used and not:
Texinfo code
|
|
default case
|
|
with
‘--use-nodes’
|
| | @node node1
@chapter node 1
node1 text
@node node2
node2 text
@node node3
node3 text
@chapter node 3
chapter text
|
|
|
first element:
| | @node node1
@chapter node 1
node1 text
@node node2
node2 text
|
second element:
| | @node node3
node3 text
@chapter node 3
chapter text
|
|
|
first element:
| | @node node1
@chapter node 1
node1 text
|
second element:
third element:
| | @node node3
node3 text
@chapter node 3
chapter text
|
|
Doku-Base
This document was created by Netzdino using texi2html.
|