5 Texinfo::ManipulateTree


5.1 Texinfo::ManipulateTree NAME

Texinfo::ManipulateTree - Texinfo modules common tree manipulation functions


5.2 Texinfo::ManipulateTree SYNOPSIS

  use Texinfo::ManipulateTree;

5.3 Texinfo::ManipulateTree NOTES

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.


5.4 Texinfo::ManipulateTree DESCRIPTION

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.


5.5 Texinfo::ManipulateTree METHODS

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.

move_index_entries_after_items_in_tree($tree)

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_in_tree($tree)
protect_node_after_label_in_tree($tree)

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_in_tree($tree)

Protect comma characters, replacing , with @comma{} in tree.

protect_first_parenthesis($element)

Modify $element contents by protecting the first parenthesis. If $element is undef a fatal error with a backtrace will be emitted.

relate_index_entries_to_table_items_in_tree($document)

In tables, relate index entries preceding and following an entry with said item. Reference one of them in the entry’s entry_associated_element.


5.6 Texinfo::ManipulateTree SEE ALSO

Texinfo::Document, Texinfo::Structuring, Texinfo::Transformations.


5.7 Texinfo::ManipulateTree AUTHOR

Patrice Dumas, <pertusus@free.fr>