Texinfo::ManipulateTree - Texinfo modules common tree manipulation functions
The Texinfo Perl module main purpose is to be used in texi2any
to convert
Texinfo to other formats. There is no promise of API stability.
Texinfo::ManipulateTree
contains methods for copying and modifying the
Texinfo tree used for default conversion to output formats.
For optional tree transformation, see Texinfo::Transformations.
The Texinfo tree and Texinfo tree elements used in argument of some functions
are documented in TEXINFO TREE. When customization
information is needed, an object that defines get_conf
is
expected, normally a Getting customization options values registered in document object.
In @enumerate
and @itemize
from the tree, move index entries
appearing just before @item
after the @item
. Comment lines
between index entries are moved too.
Protect colon with protect_colon_in_tree
and characters that
are special in node names after a label in menu entries (tab
dot and comma) with protect_node_after_label_in_tree
.
The protection is achieved by putting protected characters
in @asis{}
.
Protect comma characters, replacing ,
with @comma{} in tree.
Modify $element contents by protecting the first parenthesis. If $element is undef a fatal error with a backtrace will be emitted.
In tables, relate index entries preceding and following an
entry with said item. Reference one of them in the entry’s
entry_associated_element
.
Texinfo::Document, Texinfo::Structuring, Texinfo::Transformations.
Copyright 2010- Free Software Foundation, Inc. See the source file for all copyright years.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.