make-man-index.py

   1 #  -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
   2 #
   3 #  This file is part of systemd.
   4 #
   5 #  Copyright 2012 Lennart Poettering
   6 #  Copyright 2013 Zbigniew Jędrzejewski-Szmek
   7 #
   8 #  systemd is free software; you can redistribute it and/or modify it
   9 #  under the terms of the GNU Lesser General Public License as published by
  10 #  the Free Software Foundation; either version 2.1 of the License, or
  11 #  (at your option) any later version.
  12 #
  13 #  systemd is distributed in the hope that it will be useful, but
  14 #  WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 #  Lesser General Public License for more details.
  17 #
  18 #  You should have received a copy of the GNU Lesser General Public License
  19 #  along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20
  21 import collections
  22 import xml.etree.ElementTree as tree
  23 import sys
  24
  25 TEMPLATE = '''\
  26 <refentry id="systemd.index">
  27
  28   <refentryinfo>
  29     <title>systemd.index</title>
  30     <productname>systemd</productname>
  31
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Lennart</firstname>
  36         <surname>Poettering</surname>
  37         <email>lennart@poettering.net</email>
  38       </author>
  39     </authorgroup>
  40   </refentryinfo>
  41
  42   <refmeta>
  43     <refentrytitle>systemd.index</refentrytitle>
  44     <manvolnum>7</manvolnum>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>systemd.index</refname>
  49     <refpurpose>List all manpages from the systemd project</refpurpose>
  50   </refnamediv>
  51 </refentry>
  52 '''
  53
  54 SUMMARY = '''\
  55   <refsect1>
  56     <title>See Also</title>
  57     <para>
  58       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  59     </para>
  60
  61     <para id='counts' />
  62   </refsect1>
  63 '''
  64
  65 COUNTS = '\
  66 This index contains {count} entries, referring to {pages} individual manual pages.'
  67
  68 def make_index(pages):
  69     index = collections.defaultdict(list)
  70     for p in pages:
  71         t = tree.parse(p)
  72         section = t.find('./refmeta/manvolnum').text
  73         refname = t.find('./refnamediv/refname').text
  74         purpose = ' '.join(t.find('./refnamediv/refpurpose').text.split())
  75         for f in t.findall('./refnamediv/refname'):
  76             infos = (f.text, section, purpose, refname)
  77             index[f.text[0].upper()].append(infos)
  78     return index
  79
  80 def add_letter(template, letter, pages):
  81     refsect1 = tree.SubElement(template, 'refsect1')
  82     title = tree.SubElement(refsect1, 'title')
  83     title.text = letter
  84     para = tree.SubElement(refsect1, 'para')
  85     for info in sorted(pages, key=lambda info: str.lower(info[0])):
  86         refname, section, purpose, realname = info
  87
  88         b = tree.SubElement(para, 'citerefentry')
  89         c = tree.SubElement(b, 'refentrytitle')
  90         c.text = refname
  91         d = tree.SubElement(b, 'manvolnum')
  92         d.text = section
  93
  94         b.tail = ' — ' + purpose # + ' (' + p + ')'
  95
  96         tree.SubElement(para, 'sbr')
  97
  98 def add_summary(template, indexpages):
  99     count = 0
 100     pages = set()
 101     for group in indexpages:
 102         count += len(group)
 103         for info in group:
 104             refname, section, purpose, realname = info
 105             pages.add((realname, section))
 106
 107     refsect1 = tree.fromstring(SUMMARY)
 108     template.append(refsect1)
 109
 110     para = template.find(".//para[@id='counts']")
 111     para.text = COUNTS.format(count=count, pages=len(pages))
 112
 113 def make_page(xml_files):
 114     template = tree.fromstring(TEMPLATE)
 115     index = make_index(xml_files)
 116
 117     for letter in sorted(index):
 118         add_letter(template, letter, index[letter])
 119
 120     add_summary(template, index.values())
 121
 122     return template
 123
 124 if __name__ == '__main__':
 125     tree.dump(make_page(sys.argv[1:]))