lib/doc/depend.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 import re
  29
  30 possible_documents = ("Intro", "FAQ", "Tutorial", "UserGuide", "EmbeddedObjects", "Extended", "Customization")
  31
  32 def documents(srcdir, lang):
  33     '''Return documents for specified language. Translated files are in lang
  34        directory.
  35     '''
  36     result = []
  37     for file in possible_documents:
  38         fname = os.path.join(srcdir, lang, file + '.lyx')
  39         if os.access(fname, os.F_OK):
  40             result.append(fname)
  41         else:
  42             result.append(os.path.join(srcdir, file + '.lyx'))
  43     return result
  44
  45
  46 def all_documents(srcdir):
  47     '''Return available languages and its documents'''
  48     languages = {}
  49     for dir in os.listdir(srcdir):
  50         if os.path.isdir(os.path.join(srcdir, dir)) and len(dir) == 2:
  51             languages[dir] = documents(srcdir, dir)
  52     # general, English language
  53     if 'en' not in languages.keys():
  54         languages['en'] = documents(srcdir, 'en')
  55     return languages
  56
  57
  58 def main(argv):
  59     print """# This is a Makefile for the TOC.lyx files.
  60 # It was automatically generated by %s
  61 #
  62 # First come the rules for each xx/TOC.lyx file. Then comes the
  63 # TOCs target, which prints all the TOC files.
  64 """ % os.path.basename(argv[0])
  65
  66     # What are the languages available? And its documents?
  67     languages = all_documents(os.path.dirname(argv[0]))
  68
  69     # sort languages alphabetically
  70     langs = languages.keys()
  71     langs.sort()
  72
  73     tocs = []
  74
  75     # Write rules for other languages
  76     for lang in langs:
  77         if os.path.isdir(lang):
  78             toc_name = os.path.join(lang, 'TOC.lyx')
  79         else:
  80             # for English, because there is no 'en' directory
  81             toc_name = 'TOC.lyx'
  82         tocs.append(toc_name)
  83
  84         if toc_name in languages[lang]:
  85             languages[lang].remove(toc_name)
  86         languages[lang].sort()
  87
  88         print toc_name + ': $(srcdir)/' + ' $(srcdir)/'.join(languages[lang])
  89         print '\tPYTHONPATH=$(top_builddir)/lib/lyx2lyx python -tt $(srcdir)/doc_toc.py %s .' % lang
  90         print
  91
  92     # Write meta-rule to call all the other rules
  93     print 'tocfiles =', ' '.join(tocs)
  94
  95
  96 if __name__ == "__main__":
  97     main(sys.argv)