lib/doc/doc_toc.py

   1 #! /usr/bin/env python
   2 # -*- coding: iso-8859-1 -*-
   3 # This file is part of the LyX Documentation
   4 # Copyright (C) 2004 José Matos <jamatos@lyx.org>
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 # This script creates a "master table of contents" for a set of LyX docs.
  21 # It does so by going through the files and printing out all of the
  22 # chapter, section, and sub(sub)section headings out. (It numbers the
  23 # sections sequentially; hopefully noone's using Section* in the docs.)
  24
  25 import sys
  26 import os
  27
  28 srcdir = os.path.dirname(sys.argv[0])
  29 if srcdir == '':
  30     srcdir = '.'
  31 sys.path.insert(0, srcdir + "/../lyx2lyx")
  32
  33 import parser_tools
  34 import LyX
  35 import depend
  36
  37 # Specific language information
  38 # info["isoname"] = (language, language_quotes, enconding, TOC_translated)
  39 info = { 'cs' : ('czech', 'german', 'latin2', "Obsah dokumentace LyXu"),
  40          'da' : ('danish', 'german', 'latin1', "Indholdsfortegnelse over LyX's dokumentation"),
  41          'de' : ('german', 'german', 'latin1', "Inhaltsverzeichnis LyX Dokumentation"),
  42          'fr' : ('french', 'french', 'latin1', "Plan de la documentation"),
  43          'ru' : ('russian', 'english', 'koi8-r', "LyX Documentation Table of Contents"),
  44          'sl' : ('slovene', 'german', 'latin2', "Kazalo dokumentacije LyXa"),
  45          'en' : ('english', 'english', 'latin1', "LyX Documentation Table of Contents")}
  46
  47 def usage(pname):
  48     print """Usage: %s [lang]
  49
  50     lang is the language to build the TOC file, if not present use english.
  51 """ % pname
  52
  53
  54 transform_table = {'Title' : 'Section*', 'Chapter': 'Enumerate',
  55                    'Section':'Enumerate', 'Subsection': 'Enumerate',
  56                    'Subsubsection' : 'Enumerate'}
  57
  58 def build_from_toc(par_list):
  59     if not par_list:
  60         return []
  61
  62     if par_list[0].name == 'Title':
  63         par = par_list[0]
  64         par.name = transform_table[par.name]
  65
  66         if len(par_list) == 1:
  67             return par_list
  68
  69         for i in range(1, len(par_list)):
  70             if par_list[i].name == 'Title':
  71                 return [par] + \
  72                         build_from_toc(par_list[1:i]) + \
  73                         build_from_toc(par_list[i:])
  74
  75         return [par] + build_from_toc(par_list[1:])
  76
  77     if par_list[0].name in ('Chapter', 'Section', 'Subsection', 'Subsubsection'):
  78         return nest_struct(par_list[0].name, par_list)
  79
  80
  81 def nest_struct(name, par_list):
  82     if par_list[0].name == name:
  83         par = par_list[0]
  84         par.name = transform_table[par.name]
  85
  86         if len(par_list) == 1:
  87             return par_list
  88
  89         for i in range(1, len(par_list)):
  90             if par_list[i].name == name:
  91                 par.child = build_from_toc(par_list[1:i])
  92                 return [par] + build_from_toc(par_list[i:])
  93         par.child = build_from_toc(par_list[1:])
  94         return [ par ]
  95
  96
  97 def main(argv):
  98     if len(argv) > 2:
  99         usage()
 100         sys.exit(1)
 101
 102     # choose language and prefix for files
 103     if len(argv) == 1:
 104         lang = "en"
 105         pref = ""
 106     else:
 107         lang = argv[1]
 108         pref = lang + '_'
 109         # fallback
 110         if lang not in info:
 111             lang = 'en'
 112
 113     # Determine existing translated documents for that language.
 114     toc_general = []
 115     for file in depend.documents(srcdir, pref):
 116         file = LyX.File(input= file)
 117         file.convert()
 118         toc_general.extend(file.get_toc())
 119
 120     file = LyX.NewFile(output= pref + 'TOC.lyx')
 121     data = info[lang]
 122     file.set_header(language = data[0], language_quotes = data[1], inputencoding = data[2])
 123     file.language = data[0]
 124     file.encoding = data[2]
 125     body = [ LyX.Paragraph('Title', [data[3]])]
 126     body.extend(build_from_toc(toc_general))
 127     file.set_body(body)
 128     file.write()
 129
 130
 131 if __name__ == "__main__":
 132     main(sys.argv)