From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Sat, 6 Dec 2008 13:34:14 +0000 (+0100)
Subject: MusicXML: Better TOC generation for unnumbered section headings
X-Git-Tag: release/2.12.0-1~13^2~37^2~4^2
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=502075cca1c1cc9da325457e84b06fbcd74035fb;p=lilypond.git

MusicXML: Better TOC generation for unnumbered section headings
---

diff --git a/lilypond-texi2html.init b/lilypond-texi2html.init
index 7f4c32a175..1f3bffb75b 100644
--- a/lilypond-texi2html.init
+++ b/lilypond-texi2html.init
@@ -539,46 +539,50 @@ my @default_toc = [];
 # recursively generate the TOC entries for the element and its children (which
 # are only shown up to maxlevel. All ancestors of the current element are also
 # shown with their immediate children, irrespective of their level.
-# Unnumbered entries are only printed out if they are at top-level or their
-# parent element is an ancestor of the currently viewed node.
-sub generate_ly_toc_entries($$$$)
+# Unnumbered entries are only printed out if they are at top-level or 2nd level 
+# or their parent element is an ancestor of the currently viewed node.
+# The conditions to call this method to print the entry for a child node is:
+# -) the parent is an ancestor of the current page node
+# -) the parent is a numbered element at top-level toplevel (i.e. show numbered 
+#    and unnumbered 2nd-level children of numbered nodes)
+# -) the child element is a numbered node below level maxlevel
+sub generate_ly_toc_entries($$$)
 {
   my $element = shift;
   my $element_path = shift;
   my $maxlevel = shift;
-  my $always_show_unnumbered_children = shift;
   # Skip undefined sections, plus all sections generated by index splitting
   return() if (not defined($element) or exists($element->{'index_page'}));
   my @result = ();
   my $level = $element->{'toc_level'};
   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
-  my $print_children = ( ($level < $maxlevel) or $is_parent_of_current );
   my $ind = '  ' x $level;
   my $this_css_class = $is_parent_of_current ? " class=\"toc_current\"" : "";
 
   my $entry = "$ind<li$this_css_class>" . &$anchor ($element->{'tocid'}, "$element->{'file'}#$element->{'target'}",$element->{'text'});
 
+  push (@result, $entry);
   my $children = $element->{'section_childs'};
-  # Don't add unnumbered entries, unless they are at top-level or a parent of the current!
-  if (not ($element->{'number'} or $always_show_unnumbered_children)) {
-    return @result;
-  }
-  if ( $print_children and defined($children) and (ref($children) eq "ARRAY") ) {
-    push (@result, $entry);
+  if (defined($children) and (ref($children) eq "ARRAY")) {
+    my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
     my @child_result = ();
-    foreach (@$children) {
-      push (@child_result, generate_ly_toc_entries($_, $element_path, $maxlevel, $is_parent_of_current));
+    foreach my $c (@$children) {
+      my $is_numbered_child = defined ($c->{'number'});
+      my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
+      if ($force_children or ($is_numbered_child and $below_maxlevel)) {
+        my @child_res = generate_ly_toc_entries($c, $element_path, $maxlevel);
+        push (@child_result, @child_res);
+      }
     }
     # if no child nodes were generated, e.g. for the index, where expanded pages
     # are ignored, don't generate a list at all...
     if (@child_result) {
       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
       push (@result, @child_result);
-      push (@result, "$ind</ul></li>\n");
+      push (@result, "$ind</ul>\n");
     }
-  } else {
-    push (@result, $entry . "</li>\n");
   }
+  push (@result, "$ind</li>\n");
   return @result;
 }
 
@@ -604,7 +608,7 @@ sub lilypond_generate_page_toc_body($)
     my @toc_entries = ("<div class=\"contents\">\n", "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
     my $children = $current_element->{'section_childs'};
     foreach ( @$children ) {
-      push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, False));
+      push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth));
     }
     push (@toc_entries, "</ul>\n");
     push (@toc_entries, "</div>\n");