UserGuide.lyx updates: - revise descriptions of Branches and Nomenclature

[lyx.git] / lib / doc / doc_toc.py

diff --git a/lib/doc/doc_toc.py b/lib/doc/doc_toc.py
index d1cce9da24ea0ad9bc32e906061aa70bcc9bde11..aa83b494075d554ec8a6874ee467f7abe8a0068b 100755 (executable)
--- a/lib/doc/doc_toc.py
+++ b/lib/doc/doc_toc.py
@@ -1,7 +1,7 @@
 #! /usr/bin/env python
-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-
 # This file is part of the LyX Documentation
-# Copyright (C) 2004 José Matos <jamatos@lyx.org>
+# Copyright (C) 2004 José Matos <jamatos@lyx.org>
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -17,19 +17,25 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-# This script creates a "master table of contents" for a set of LyX docs.
+# This script is called by the script depend.py to create a "master table of contents"
+# for a set of LyX docs.
 # It does so by going through the files and printing out all of the
 # chapter, section, and sub(sub)section headings out. (It numbers the
 # sections sequentially; hopefully noone's using Section* in the docs.)
+# It is called using this syntax:
+# depend.py doc_toc.py SetOfDocuments
+# where SetOfDocuments is a set of documents
 
 import sys
 import os
 
-srcdir = os.path.dirname(sys.argv[0])
-if srcdir == '':
-    srcdir = '.'
-sys.path.insert(0, srcdir + "/../lyx2lyx")
+if __name__ == "__main__":
+    srcdir = os.path.dirname(sys.argv[0])
+    if srcdir == '':
+        srcdir = '.'
+    sys.path.insert(0, srcdir + "/../lyx2lyx")
 
+# when doc_toc is imported by scons, sys.path is set over there
 import parser_tools
 import LyX
 import depend
@@ -45,9 +51,9 @@ info = { 'cs' : ('czech', 'german', 'latin2', "Obsah dokumentace LyXu"),
          'en' : ('english', 'english', 'latin1', "LyX Documentation Table of Contents")}
 
 def usage(pname):
-    print """Usage: %s [lang]
+    print """Usage: %s lang output
 
-    lang is the language to build the TOC file, if not present use english.
+    lang is the language to build the TOC file,
 """ % pname
 
 
@@ -94,32 +100,24 @@ def nest_struct(name, par_list):
         return [ par ]
 
 
-def main(argv):
-    if len(argv) > 2:
-        usage()
-        sys.exit(1)
-
-    # choose language and prefix for files
-    if len(argv) == 1:
-        lang = "en"
-        pref = ""
-    else:
-        lang = argv[1]
-        pref = lang + '_'
-        # fallback
-        if lang not in info:
-            lang = 'en'
-
+def build_toc(output, documents, lang=None):
     # Determine existing translated documents for that language.
     toc_general = []
-    for file in depend.documents(srcdir, pref):
+    for file in documents:
         file = LyX.File(input= file)
         file.convert()
         toc_general.extend(file.get_toc())
 
-    file = LyX.NewFile(output= pref + 'TOC.lyx')
+    # if lang is not given, guess from document names. (Used in scons build)
+    if lang is None:
+        lang = 'en'
+        for file in documents:
+            dir = file.split(os.sep)[-2]
+            if dir in info.keys():
+                lang = dir
+    file = LyX.NewFile(output = output)
     data = info[lang]
-    file.set_header(language = data[0], language_quotes = data[1], inputencoding = "utf-8")
+    file.set_header(language = data[0], language_quotes = data[1], inputencoding = "auto")
     file.language = data[0]
     file.encoding = "utf-8"
     body = [ LyX.Paragraph('Title', [data[3]])]
@@ -127,6 +125,28 @@ def main(argv):
     file.set_body(body)
     file.write()
 
+    
+def main(argv):
+    if len(argv) != 3:
+        usage()
+        sys.exit(1)
+
+    lang = argv[1]
+    if not os.path.isdir(os.path.join(argv[2], lang)):
+        # need to create lang dir if build dir != src dir
+        os.mkdir(os.path.join(argv[2], lang))
+
+    # choose language files
+    if lang == 'en':
+        output = os.path.join(argv[2], 'TOC.lyx')
+    else:
+        output = os.path.join(argv[2], lang, 'TOC.lyx')
+        # fallback
+        if lang not in info:
+            lang = 'en'
+
+    build_toc(output, depend.documents(srcdir, lang), lang)
+
 
 if __name__ == "__main__":
     main(sys.argv)