texinfo/tp/Texinfo Structuring.pm

[Patrice Dumas]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Patrice Dumas <pertusus>        12/02/01 00:46:47

Modified files:
        tp/Texinfo     : Structuring.pm 

Log message:
        Document fill_gaps_in_sectioning.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Structuring.pm?cvsroot=texinfo&r1=1.111&r2=1.112

Patches:
Index: Structuring.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Structuring.pm,v
retrieving revision 1.111
retrieving revision 1.112
diff -u -b -r1.111 -r1.112
--- Structuring.pm      1 Feb 2012 00:41:10 -0000       1.111
+++ Structuring.pm      1 Feb 2012 00:46:47 -0000       1.112
@@ -1788,6 +1788,18 @@
 When simply sorting, the array of the sorted indes entries is associated
 with the index name.
 
+=item $root_content = fill_gaps_in_sectioning ($root)
+
+This function adds empty C<@unnumbered> and similar commands in a tree
+to fill gaps in sectioning.  This may be used, for example, when converting 
+from a format that can handle gaps in sectioning.  I<$root> is the tree
+root.  An array reference is returned, containing the root contents
+with added sectioning commands.
+
+If the sectioning commands are lowered or raised (with C<@raisesections>,
+C<@lowersection>) the tree may be modified with C<@raisesections> or
+C<@lowersection> added to some tree elements.
+
 =item menu_to_simple_menu ($menu)
 
 =item set_menus_to_simple_menu ($parser)