guile-lib: (texinfo nodal-tree)

Overview

This module exports a procedure to chunk a stexi doument into pieces, delimited by sectioning commands (@chapter, @appendixsec, etc.). Note that the sectioning commands must be preceded by a @node, a condition that the output of (sxml texinfo) respects.

The output is a nodal tree (see (container nodal-tree)), with the following fields defined for each node:

Usage

stexi->nodal-tree stexi max-depth

[Function]

Break stexi into a nodal tree. Only break until sectioning identifiers of depth max-depth. The following fields are defined for each node:

name: The name of the section.
value: The content of the section, as stexi. The containing element is texinfo.
parent: A reference to the parent node.
children: A list of subnodes, corresponding to the subsections of the current section.

wingosoft