man: actually generate h2 headers for letters in index as we meant to

[elogind.git] / make-man-index.py

diff --git a/make-man-index.py b/make-man-index.py
index 1333521a589944a5526d4f13fc8a027ac28fb380..29e3578758d80601ea00b62aa85d339896248f0b 100755 (executable)
--- a/make-man-index.py
+++ b/make-man-index.py
@@ -1,19 +1,16 @@
 #!/usr/bin/env python
 
 from xml.etree.ElementTree import parse, Element, SubElement, tostring
-import sys
+from sys import argv, stdout
 
 index = {}
 
-for p in sys.argv[1:]:
+for p in argv[1:]:
         t = parse(p)
-        section = t.find('./refmeta/manvolnum').text;
+        section = t.find('./refmeta/manvolnum').text
+        purpose = t.find('./refnamediv/refpurpose').text
         for f in t.findall('./refnamediv/refname'):
-                index[f.text] = (p, section)
-
-k = index.keys()
-k.sort(key = str.lower)
-
+                index[f.text] = (p, section, purpose)
 
 html = Element('html')
 
@@ -26,9 +23,8 @@ h1 = SubElement(body, 'h1')
 h1.text = 'Manual Page Index'
 
 letter = None
-
-for n in k:
-        path, section = index[n]
+for n in sorted(index.keys(), key = str.lower):
+        path, section, purpose = index[n]
 
         if path.endswith('.xml'):
                 path = path[:-4] + ".html"
@@ -40,16 +36,25 @@ for n in k:
         if letter is None or n[0].upper() != letter:
                 letter = n[0].upper()
 
-                h2 = SubElement(body, 'h1')
+                h2 = SubElement(body, 'h2')
                 h2.text = letter
 
                 ul = SubElement(body, 'ul')
                 ul.set('style', 'list-style-type:none')
 
-        li = SubElement(ul, 'li');
+        li = SubElement(ul, 'li')
 
-        a = SubElement(li, 'a');
+        a = SubElement(li, 'a')
         a.set('href', path)
         a.text = n + '(' + section + ')'
+        a.tail = ' -- '
+
+        i = SubElement(li, 'i')
+        i.text = purpose
+
+hr = SubElement(body, 'hr')
+
+p = SubElement(body, 'p')
+p.text = "This index contains %s entries, referring to %i individual manual pages." % (len(index), len(argv)-1)
 
-print tostring(html)
+stdout.write(tostring(html))