6.12 Customizing the file names

It is possible to specify the file names with more control than with the command line options (see section Setting output file and directory names). First the extension may be overrided by the variable $EXTENSION value. Two function references enable further customization. One is usefull in case $NODE_FILES is true and it is used to customize the node file name.

Function Reference: $node_file node_file_name $node

$node is a hash reference with the following interesting keys (there are much more keys):

texi

The texinfo node name.

with_section

True if associated with a section.

The result is the node file name $node_file.

The other is used to customize the file names associated with each element, and the name of the file associated with the special elements.

Function Reference: $file element_file_name $element $type $docu_name

$element is undefined for the special elements (about, overview, table of contents, footnotes). Otherwise it is a hash reference with the following interesting keys (there are much more keys):

texi

The texinfo element name.

number

The number associated with a section.

doc_nr

A number incremented whenever a new file should begin, based on how the document is split (see section Specifying where to split the generated document).

text

The element text.

name

The element text without section number.

$type is empty for normal elements. For the top element it is ‘top’, for the table of contents it is ‘toc’, for the overview it is ‘stoc’, for the footnotes it is ‘foot’ and for about is ‘about’. $docu_name is the basename of the texinfo manual. The result is the element or special element file name.

Doku-Base