Convert all python files to utf-8.

Add a documentation string to each module.

Add a documentation string to every function in the modules.

file is a python reserved word => s/file/document/g as variable

add a new property to modules, supported_versions that holds
 the versions supported by that module

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@14534 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/lib/lyx2lyx/LyX.py b/lib/lyx2lyx/LyX.py
index fc5b09501b23576e4e282d12150b892c348c7846..56ddd3c423a8df7adc8b50834901932aa20095e2 100644 (file)
--- a/lib/lyx2lyx/LyX.py
+++ b/lib/lyx2lyx/LyX.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2002-2004 Dekel Tsur <dekel@lyx.org>, José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2002-2004 Dekel Tsur <dekel@lyx.org>, 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -34,6 +34,7 @@ default_debug_level = 2
 # Private helper functions
 
 def find_end_of_inset(lines, i):
 # Private helper functions
 
 def find_end_of_inset(lines, i):

+    " Find beginning of inset, where lines[i] is included."

     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 # End of helper functions
     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 # End of helper functions


@@ -49,16 +50,16 @@ original_version = re.compile(r"\#LyX (\S*)")
 # file format information:
 #  file, supported formats, stable release versions
 format_relation = [("0_08",    [210], ["0.8.%d" % i for i in range(7)] + ["0.8"]),
 # file format information:
 #  file, supported formats, stable release versions
 format_relation = [("0_08",    [210], ["0.8.%d" % i for i in range(7)] + ["0.8"]),

-                   ("0_10",    [210], ["0.10.7","0.10"]),
-                   ("0_12",    [215], ["0.12","0.12.1","0.12"]),
+                   ("0_10",    [210], ["0.10.%d" % i for i in range(8)] + ["0.10"]),
+                   ("0_12",    [215], ["0.12.0","0.12.1","0.12"]),

                    ("1_0_0",   [215], ["1.0.0","1.0"]),
                    ("1_0_1",   [215], ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]),
                    ("1_1_4",   [215], ["1.1.4","1.1"]),
                    ("1_1_5",   [216], ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]),
                    ("1_1_6_0", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
                    ("1_1_6_3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),
                    ("1_0_0",   [215], ["1.0.0","1.0"]),
                    ("1_0_1",   [215], ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]),
                    ("1_1_4",   [215], ["1.1.4","1.1"]),
                    ("1_1_5",   [216], ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]),
                    ("1_1_6_0", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
                    ("1_1_6_3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),

-                   ("1_2",     [220], ["1.2.0","1.2.1","1.2.3","1.2.4","1.2"]),
-                   ("1_3",     [221], ["1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3.6","1.3.7","1.3"]),
+                   ("1_2",     [220], ["1.2.%d" % i for i in range(5)] + ["1.2"]),
+                   ("1_3",     [221], ["1.3.%d" % i for i in range(8)] + ["1.3"]),

                    ("1_4", range(222,246), ["1.4.0", "1.4.1", "1.4.2","1.4.3svn"]),
                    ("1_5", range(246,249), ["1.5.0svn","1.5"])]
 
                    ("1_4", range(222,246), ["1.4.0", "1.4.1", "1.4.2","1.4.3svn"]),
                    ("1_5", range(246,249), ["1.5.0svn","1.5"])]
 

diff --git a/lib/lyx2lyx/lyx2lyx_version.py.in b/lib/lyx2lyx/lyx2lyx_version.py.in
index 0bd7ea9d12517ba5106a002118d640410857ac3b..731ed0fb4cd7ba5e8e8c6e0a876f1e9399fa191c 100644 (file)
--- a/lib/lyx2lyx/lyx2lyx_version.py.in
+++ b/lib/lyx2lyx/lyx2lyx_version.py.in
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx -*- python -*-
 # This file is part of lyx2lyx -*- python -*-

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2006 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2006 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License

diff --git a/lib/lyx2lyx/lyx_0_08.py b/lib/lyx2lyx/lyx_0_08.py
index 7b39460ccb76f25ffde84143053d9a684c4939e4..62dce8377361c2f832699bc9bc045ac65d92239a 100644 (file)
--- a/lib/lyx2lyx/lyx_0_08.py
+++ b/lib/lyx2lyx/lyx_0_08.py
@@ -16,8 +16,9 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

-""" Convert files generated by lyx 0.8"""
+""" Convert files to the file format generated by lyx 0.8"""

 
 

+supported_versions = ["0.8.%d" % i for i in range(7)] + ["0.8"]

 convert = [[210, []]]
 revert  = []
 
 convert = [[210, []]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_0_10.py b/lib/lyx2lyx/lyx_0_10.py
index 3bf4d33a76a5fdc4ecb1b3f1c849781e8bc9eaba..cc5187700422a6dc47d4394bd2e4420df2cf952e 100644 (file)
--- a/lib/lyx2lyx/lyx_0_10.py
+++ b/lib/lyx2lyx/lyx_0_10.py
@@ -16,10 +16,10 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

-""" Convert files generated by lyx 0.10"""
+""" Convert files to the file format generated by lyx 0.10"""

 
 def regularise_header(document):
 
 def regularise_header(document):

-    " Place tokens in their separate line. "
+    " Put each entry in header into a separate line. "

     i = 0
     while i < len(document.header):
         line = document.header[i]
     i = 0
     while i < len(document.header):
         line = document.header[i]


@@ -31,8 +31,9 @@ def regularise_header(document):
 
 
 def find_next_space(line, j):
 
 
 def find_next_space(line, j):

-    """ Return position of next space, starting from position k, if
-    not existing return last position in line."""
+    """ Return position of next space or backslash, which one comes
+    first, starting from position k, if not existing return last
+    position in line."""

     l = line.find(' ', j)
     if l == -1:
         l = len(line)
     l = line.find(' ', j)
     if l == -1:
         l = len(line)


@@ -46,6 +47,20 @@ def find_next_space(line, j):
 
 
 def regularise_body(document):
 
 
 def regularise_body(document):

+    """ Place tokens starting with a backslash into a separate line. """
+
+    getline_tokens = ["added_space_bottom", "added_space_top",
+                      "align", "layout", "fill_bottom", "fill_top",
+                      "labelwidthstring", "pagebreak_top",
+                      "pagebreak_bottom", "noindent"]
+
+    noargs_tokens = ["backslash", "begin_deeper", "end_deeper",
+                     "end_float", "end_inset", "hfill", "newline",
+                     "protected_separator"]
+
+    onearg_tokens = ["bar", "begin_float", "family", "latex", "shape",
+                     "size", "series", "cursor"]
+

     i = 0
     while i < len(document.body):
         line = document.body[i]
     i = 0
     while i < len(document.body):
         line = document.body[i]


@@ -66,18 +81,18 @@ def regularise_body(document):
 
             # These tokens take the rest of the line
             token = line[j+1:k]
 
             # These tokens take the rest of the line
             token = line[j+1:k]

-            if token in ["added_space_bottom", "added_space_top", "align", "layout", "fill_bottom", "fill_top", "labelwidthstring", "pagebreak_top", "pagebreak_bottom", "noindent"]:
+            if token in getline_tokens:

                 tmp += [line[j:]]
                 break
 
             # These tokens take no arguments
                 tmp += [line[j:]]
                 break
 
             # These tokens take no arguments

-            if token in ["backslash", "begin_deeper", "end_deeper", "end_float", "end_inset", "hfill", "newline", "protected_separator"]:
+            if token in noargs_tokens:

                 tmp += [line[j:k]]
                 j = k
                 continue
 
             # These tokens take one argument
                 tmp += [line[j:k]]
                 j = k
                 continue
 
             # These tokens take one argument

-            if token in ["bar", "begin_float", "family", "latex", "shape", "size", "series", "cursor"]:
+            if token in onearg_tokens:

                 k = find_next_space(line, k + 1)
                 tmp += [line[j:k]]
                 j = k
                 k = find_next_space(line, k + 1)
                 tmp += [line[j:k]]
                 j = k


@@ -113,10 +128,10 @@ def regularise_body(document):
         i += len(tmp)
 
 
         i += len(tmp)
 
 

+supported_versions = ["0.10.%d" % i for i in range(8)] + ["0.10"]

 convert = [[210, [regularise_header, regularise_body]]]
 revert  = []
 
 
 if __name__ == "__main__":
     pass
 convert = [[210, [regularise_header, regularise_body]]]
 revert  = []
 
 
 if __name__ == "__main__":
     pass

-

diff --git a/lib/lyx2lyx/lyx_0_12.py b/lib/lyx2lyx/lyx_0_12.py
index 8b07ac493d687535baa7b718c166baa470c0a35d..59a0b8cbeff7da31fc4ed6f0ebb28492d4013b32 100644 (file)
--- a/lib/lyx2lyx/lyx_0_12.py
+++ b/lib/lyx2lyx/lyx_0_12.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2003-2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2003-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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,41 +16,47 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 0.12"""
+

 import re
 import string
 from parser_tools import find_token, find_re, check_token
 
 
 import re
 import string
 from parser_tools import find_token, find_re, check_token
 
 

-def space_before_layout(file):
-    lines = file.body
+def space_before_layout(document):
+    " Remove empty line before \\layout. "
+    lines = document.body

     i = 2 # skip first layout
     while 1:
         i = find_token(lines, '\\layout', i)
         if i == -1:
             break
 
     i = 2 # skip first layout
     while 1:
         i = find_token(lines, '\\layout', i)
         if i == -1:
             break
 

-        if lines[i - 1] == '' and string.find(lines[i-2],'\\protected_separator') == -1:
+        prot_space = string.find(lines[i-2],'\\protected_separator')
+        if lines[i - 1] == '' and prot_space == -1:

             del lines[i-1]
         i = i + 1
 
 
             del lines[i-1]
         i = i + 1
 
 

-def formula_inset_space_eat(file):
-    lines = file.body
-    i=0
+def formula_inset_space_eat(document):
+    " Remove space after inset formula."
+    lines = document.body
+    i = 0

     while 1:
         i = find_token(lines, "\\begin_inset Formula", i)
     while 1:
         i = find_token(lines, "\\begin_inset Formula", i)

-        if i == -1: break
+        if i == -1:
+            break

 
         if len(lines[i]) > 22 and lines[i][21] == ' ':
             lines[i] = lines[i][:20] + lines[i][21:]
         i = i + 1
 
 
 
         if len(lines[i]) > 22 and lines[i][21] == ' ':
             lines[i] = lines[i][:20] + lines[i][21:]
         i = i + 1
 
 

-# Update from tabular format 1 or 2 to 4
-def update_tabular(file):
-    lines = file.body
+def update_tabular(document):
+    " Update from tabular format 1 or 2 to 4."
+    lines = document.body

     lyxtable_re = re.compile(r".*\\LyXTable$")
     lyxtable_re = re.compile(r".*\\LyXTable$")

-    i=0
+    i = 0

     while 1:
         i = find_re(lines, lyxtable_re, i)
         if i == -1:
     while 1:
         i = find_re(lines, lyxtable_re, i)
         if i == -1:


@@ -58,7 +64,7 @@ def update_tabular(file):
         i = i + 1
         format = lines[i][8:]
 
         i = i + 1
         format = lines[i][8:]
 

-        lines[i]='multicol4'
+        lines[i] = 'multicol4'

         i = i + 1
         rows = int(string.split(lines[i])[0])
         columns = int(string.split(lines[i])[1])
         i = i + 1
         rows = int(string.split(lines[i])[0])
         columns = int(string.split(lines[i])[1])


@@ -82,19 +88,26 @@ def update_tabular(file):
 
         lines[i] = string.strip(lines[i])
 
 
         lines[i] = string.strip(lines[i])
 

-def final_dot(file):
-    lines = file.body
+
+def final_dot(document):
+    " Merge lines if the dot is the final character."
+    lines = document.body

     i = 0
     while i < len(lines):
     i = 0
     while i < len(lines):

-        if lines[i][-1:] == '.' and lines[i+1][:1] != '\\' and  lines[i+1][:1] != ' ' and len(lines[i]) + len(lines[i+1])<= 72 and lines[i+1] != '':
+        
+        if lines[i][-1:] == '.' and lines[i+1][:1] != '\\' and \
+               lines[i+1][:1] != ' ' and len(lines[i]) + len(lines[i+1])<= 72 \
+               and lines[i+1] != '':
+

             lines[i] = lines[i] + lines[i+1]
             del lines[i+1]
         else:
             i = i + 1
 
 
             lines[i] = lines[i] + lines[i+1]
             del lines[i+1]
         else:
             i = i + 1
 
 

-def update_inset_label(file):
-    lines = file.body
+def update_inset_label(document):
+    " Update inset Label."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset Label', i)
     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset Label', i)


@@ -104,26 +117,35 @@ def update_inset_label(file):
         i = i + 1
 
 
         i = i + 1
 
 

-def update_latexdel(file):
-    lines = file.body
+def update_latexdel(document):
+    " Update inset LatexDel."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset LatexDel', i)
         if i == -1:
             return
     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset LatexDel', i)
         if i == -1:
             return

-        lines[i] = string.replace(lines[i],'\\begin_inset LatexDel', '\\begin_inset LatexCommand')
+        lines[i] = string.replace(lines[i],
+                                  '\\begin_inset LatexDel',
+                                  '\\begin_inset LatexCommand')

         i = i + 1
 
 
         i = i + 1
 
 

-def update_vfill(file):
-    lines = file.body
+def update_vfill(document):
+    " Update fill_top and fill_bottom."
+    lines = document.body

     for i in range(len(lines)):
     for i in range(len(lines)):

-        lines[i] = string.replace(lines[i],'\\fill_top','\\added_space_top vfill')
-        lines[i] = string.replace(lines[i],'\\fill_bottom','\\added_space_bottom vfill')
+        lines[i] = string.replace(lines[i],
+                                  '\\fill_top',
+                                  '\\added_space_top vfill')
+        lines[i] = string.replace(lines[i],
+                                  '\\fill_bottom',
+                                  '\\added_space_bottom vfill')

 
 
 
 

-def update_space_units(file):
-    lines = file.body
+def update_space_units(document):
+    " Update space units."
+    lines = document.body

     added_space_bottom = re.compile(r'\\added_space_bottom ([^ ]*)')
     added_space_top    = re.compile(r'\\added_space_top ([^ ]*)')
     for i in range(len(lines)):
     added_space_bottom = re.compile(r'\\added_space_bottom ([^ ]*)')
     added_space_top    = re.compile(r'\\added_space_top ([^ ]*)')
     for i in range(len(lines)):


@@ -140,8 +162,9 @@ def update_space_units(file):
             lines[i] = string.replace(lines[i], old, new)
 
 
             lines[i] = string.replace(lines[i], old, new)
 
 

-def remove_cursor(file):
-    lines = file.body
+def remove_cursor(document):
+    " Remove cursor, it is not saved on the file anymore."
+    lines = document.body

     i = 0
     cursor_re = re.compile(r'.*(\\cursor \d*)')
     while 1:
     i = 0
     cursor_re = re.compile(r'.*(\\cursor \d*)')
     while 1:


@@ -149,15 +172,16 @@ def remove_cursor(file):
         if i == -1:
             break
         cursor = cursor_re.search(lines[i]).group(1)
         if i == -1:
             break
         cursor = cursor_re.search(lines[i]).group(1)

-        lines[i]= string.replace(lines[i], cursor, '')
+        lines[i] = string.replace(lines[i], cursor, '')

         i = i + 1
 
 
         i = i + 1
 
 

-def remove_empty_insets(file):
-    lines = file.body
+def remove_empty_insets(document):
+    " Remove empty insets."
+    lines = document.body

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(lines, '\\begin_inset ',i)
+        i = find_token(lines, '\\begin_inset ', i)

         if i == -1:
             break
         if lines[i] == '\\begin_inset ' and lines[i+1] == '\\end_inset ':
         if i == -1:
             break
         if lines[i] == '\\begin_inset ' and lines[i+1] == '\\end_inset ':


@@ -166,8 +190,9 @@ def remove_empty_insets(file):
         i = i + 1
 
 
         i = i + 1
 
 

-def remove_formula_latex(file):
-    lines = file.body
+def remove_formula_latex(document):
+    " Remove formula latex."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, '\\latex formula_latex ', i)
     i = 0
     while 1:
         i = find_token(lines, '\\latex formula_latex ', i)


@@ -181,15 +206,17 @@ def remove_formula_latex(file):
         del lines[i]
 
 
         del lines[i]
 
 

-def add_end_document(file):
-    lines = file.body
+def add_end_document(document):
+    " Add \\the_end to the end of the document."
+    lines = document.body

     i = find_token(lines, '\\the_end', 0)
     if i == -1:
         lines.append('\\the_end')
 
 
     i = find_token(lines, '\\the_end', 0)
     if i == -1:
         lines.append('\\the_end')
 
 

-def header_update(file):
-    lines = file.header
+def header_update(document):
+    " Update document header."
+    lines = document.header

     i = 0
     l = len(lines)
     while i < l:
     i = 0
     l = len(lines)
     while i < l:


@@ -241,8 +268,9 @@ def header_update(file):
         i = i + 1
 
 
         i = i + 1
 
 

-def update_latexaccents(file):
-    body = file.body
+def update_latexaccents(document):
+    " Update latex accent insets."
+    body = document.body

     i = 1
     while 1:
         i = find_token(body, '\\i ', i)
     i = 1
     while 1:
         i = find_token(body, '\\i ', i)


@@ -269,8 +297,9 @@ def update_latexaccents(file):
         i = i + 1
 
 
         i = i + 1
 
 

-def obsolete_latex_title(file):
-    body = file.body
+def obsolete_latex_title(document):
+    " Replace layout Latex_Title with Title."
+    body = document.body

     i = 0
     while 1:
         i = find_token(body, '\\layout', i)
     i = 0
     while 1:
         i = find_token(body, '\\layout', i)


@@ -283,12 +312,14 @@ def obsolete_latex_title(file):
         i = i + 1
 
 
         i = i + 1
 
 

+supported_versions = ["0.12.0","0.12.1","0.12"]

 convert = [[215, [header_update, add_end_document, remove_cursor,
                   final_dot, update_inset_label, update_latexdel,
                   update_space_units, space_before_layout,
                   formula_inset_space_eat, update_tabular,
                   update_vfill, remove_empty_insets,
 convert = [[215, [header_update, add_end_document, remove_cursor,
                   final_dot, update_inset_label, update_latexdel,
                   update_space_units, space_before_layout,
                   formula_inset_space_eat, update_tabular,
                   update_vfill, remove_empty_insets,

-                  remove_formula_latex, update_latexaccents, obsolete_latex_title]]]
+                  remove_formula_latex, update_latexaccents,
+                  obsolete_latex_title]]]

 revert  = []
 
 
 revert  = []
 
 

diff --git a/lib/lyx2lyx/lyx_1_0_0.py b/lib/lyx2lyx/lyx_1_0_0.py
index 6ca27628b4a499d3388942e497b50f503c7be702..45889c138cf6ae6725126df4569c32aed37f3b38 100644 (file)
--- a/lib/lyx2lyx/lyx_1_0_0.py
+++ b/lib/lyx2lyx/lyx_1_0_0.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,12 +16,16 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.0"""
+

 import re
 import string
 from parser_tools import find_token, find_re
 
 import re
 import string
 from parser_tools import find_token, find_re
 

-def obsolete_latex_title(file):
-    body = file.body
+def obsolete_latex_title(document):
+    " Replace LatexTitle layout with Title. "
+
+    body = document.body

     i = 0
     while 1:
         i = find_token(body, '\\layout', i)
     i = 0
     while 1:
         i = find_token(body, '\\layout', i)


@@ -34,11 +38,12 @@ def obsolete_latex_title(file):
         i = i + 1
 
 
         i = i + 1
 
 

-# Update from tabular format 3 to 4 if necessary
-def update_tabular(file):
-    lines = file.body
+def update_tabular(document):
+    " Update from tabular format 3 to 4 if necessary."
+
+    lines = document.body

     lyxtable_re = re.compile(r".*\\LyXTable$")
     lyxtable_re = re.compile(r".*\\LyXTable$")

-    i=0
+    i = 0

     while 1:
         i = find_re(lines, lyxtable_re, i)
         if i == -1:
     while 1:
         i = find_re(lines, lyxtable_re, i)
         if i == -1:


@@ -49,7 +54,7 @@ def update_tabular(file):
         if format != '3':
             continue
 
         if format != '3':
             continue
 

-        lines[i]='multicol4'
+        lines[i] = 'multicol4'

         i = i + 1
         rows = int(string.split(lines[i])[0])
         columns = int(string.split(lines[i])[1])
         i = i + 1
         rows = int(string.split(lines[i])[0])
         columns = int(string.split(lines[i])[1])


@@ -72,6 +77,7 @@ def update_tabular(file):
         lines[i] = string.strip(lines[i])
 
 
         lines[i] = string.strip(lines[i])
 
 

+supported_versions = ["1.0.0","1.0"]

 convert = [[215, [obsolete_latex_title, update_tabular]]]
 revert  = []
 
 convert = [[215, [obsolete_latex_title, update_tabular]]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_0_1.py b/lib/lyx2lyx/lyx_1_0_1.py
index 199fb3022a2ae62f758b32fc84ba65fbd99ca49c..e5afac50468c505f838df4a2033f30b7370429f1 100644 (file)
--- a/lib/lyx2lyx/lyx_1_0_1.py
+++ b/lib/lyx2lyx/lyx_1_0_1.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,6 +16,9 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.0.1"""
+
+supported_versions = ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]

 convert = [[215, []]]
 revert  = []
 
 convert = [[215, []]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_1_4.py b/lib/lyx2lyx/lyx_1_1_4.py
index 199fb3022a2ae62f758b32fc84ba65fbd99ca49c..b5ad939324c4e54c2a2c638fda486f28824ba5f7 100644 (file)
--- a/lib/lyx2lyx/lyx_1_1_4.py
+++ b/lib/lyx2lyx/lyx_1_1_4.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,6 +16,9 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.1.4"""
+
+supported_versions = ["1.1.4","1.1"]

 convert = [[215, []]]
 revert  = []
 
 convert = [[215, []]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_1_5.py b/lib/lyx2lyx/lyx_1_1_5.py
index bb924dd16758904b900696f8c8252deb5cc82e40..fde89f5595c996960ced9d5467388700b29d6cd0 100644 (file)
--- a/lib/lyx2lyx/lyx_1_1_5.py
+++ b/lib/lyx2lyx/lyx_1_1_5.py
@@ -1,6 +1,6 @@
-# This file is part of lyx2lyx
-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>
+# This document is part of lyx2lyx
+# -*- coding: utf-8 -*-
+# Copyright (C) 2002-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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,6 +16,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.1.5"""
+

 import re
 import string
 from parser_tools import find_token, find_token_backwards, find_re
 import re
 import string
 from parser_tools import find_token, find_token_backwards, find_re


@@ -24,6 +26,7 @@ from parser_tools import find_token, find_token_backwards, find_re
 # Private helper functions
 
 def get_layout(line, default_layout):
 # Private helper functions
 
 def get_layout(line, default_layout):

+    " Get the line layout, beware of the empty layout."

     tokens = string.split(line)
     if len(tokens) > 1:
         return tokens[1]
     tokens = string.split(line)
     if len(tokens) > 1:
         return tokens[1]


@@ -34,8 +37,9 @@ def get_layout(line, default_layout):
 
 math_env = ["\\[","\\begin{eqnarray*}","\\begin{eqnarray}","\\begin{equation}"]
 
 
 math_env = ["\\[","\\begin{eqnarray*}","\\begin{eqnarray}","\\begin{equation}"]
 

-def replace_protected_separator(file):
-    lines = file.body
+def replace_protected_separator(document):
+    " Replace protected separator. "
+    lines = document.body

     i=0
     while 1:
         i = find_token(lines, "\\protected_separator", i)
     i=0
     while 1:
         i = find_token(lines, "\\protected_separator", i)


@@ -43,7 +47,7 @@ def replace_protected_separator(file):
             break
         j = find_token_backwards(lines, "\\layout", i)
         #if j == -1: print error
             break
         j = find_token_backwards(lines, "\\layout", i)
         #if j == -1: print error

-        layout = get_layout(lines[j], file.default_layout)
+        layout = get_layout(lines[j], document.default_layout)

 
         if layout == "LyX-Code":
             result = ""
 
         if layout == "LyX-Code":
             result = ""


@@ -58,8 +62,9 @@ def replace_protected_separator(file):
         del lines[i]
 
 
         del lines[i]
 
 

-def merge_formula_inset(file):
-    lines = file.body
+def merge_formula_inset(document):
+    " Merge formula insets. "
+    lines = document.body

     i=0
     while 1:
         i = find_token(lines, "\\begin_inset Formula", i)
     i=0
     while 1:
         i = find_token(lines, "\\begin_inset Formula", i)


@@ -70,9 +75,9 @@ def merge_formula_inset(file):
         i = i + 1
 
 
         i = i + 1
 
 

-# Update from tabular format 4 to 5 if necessary
-def update_tabular(file):
-    lines = file.body
+def update_tabular(document):
+    " Update from tabular format 4 to 5 if necessary. "
+    lines = document.body

     lyxtable_re = re.compile(r".*\\LyXTable$")
     i=0
     while 1:
     lyxtable_re = re.compile(r".*\\LyXTable$")
     i=0
     while 1:


@@ -103,26 +108,30 @@ def update_tabular(file):
             i = i + 1
 
 
             i = i + 1
 
 

-def update_toc(file):
-    lines = file.body
+def update_toc(document):
+    " Update table of contents. "
+    lines = document.body

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(lines, '\\begin_inset LatexCommand \\tableofcontents', i)
+        i = find_token(lines,
+                       '\\begin_inset LatexCommand \\tableofcontents', i)

         if i == -1:
             break
         lines[i] = lines[i] + '{}'
         i = i + 1
 
 
         if i == -1:
             break
         lines[i] = lines[i] + '{}'
         i = i + 1
 
 

-def remove_cursor(file):
-    lines = file.body
+def remove_cursor(document):
+    " Remove cursor. "
+    lines = document.body

     i = find_token(lines, '\\cursor', 0)
     if i != -1:
         del lines[i]
 
 
     i = find_token(lines, '\\cursor', 0)
     if i != -1:
         del lines[i]
 
 

-def remove_vcid(file):
-    lines = file.header
+def remove_vcid(document):
+    " Remove \\lyxvcid and \\lyxrcsid. "
+    lines = document.header

     i = find_token(lines, '\\lyxvcid', 0)
     if i != -1:
         del lines[i]
     i = find_token(lines, '\\lyxvcid', 0)
     if i != -1:
         del lines[i]


@@ -131,16 +140,18 @@ def remove_vcid(file):
         del lines[i]
 
 
         del lines[i]
 
 

-def first_layout(file):
-    lines = file.body
+def first_layout(document):
+    " Fix first layout, if empty use the default layout."
+    lines = document.body

     while (lines[0] == ""):
         del lines[0]
     if lines[0][:7] != "\\layout":
     while (lines[0] == ""):
         del lines[0]
     if lines[0][:7] != "\\layout":

-        lines[:0] = ['\\layout %s' % file.default_layout, '']
+        lines[:0] = ['\\layout %s' % document.default_layout, '']

 
 
 
 

-def remove_space_in_units(file):
-    lines = file.header
+def remove_space_in_units(document):
+    " Remove space in units. "
+    lines = document.header

     margins = ["\\topmargin","\\rightmargin",
                "\\leftmargin","\\bottommargin"]
 
     margins = ["\\topmargin","\\rightmargin",
                "\\leftmargin","\\bottommargin"]
 


@@ -159,8 +170,9 @@ def remove_space_in_units(file):
             i = i + 1
 
 
             i = i + 1
 
 

-def latexdel_getargs(file, i):
-    lines = file.body
+def latexdel_getargs(document, i):
+    " Get arguments from latexdel insets. "
+    lines = document.body

 
     # play safe, clean empty lines
     while 1:
 
     # play safe, clean empty lines
     while 1:


@@ -173,7 +185,7 @@ def latexdel_getargs(file, i):
     if i == j:
         del lines[i]
     else:
     if i == j:
         del lines[i]
     else:

-        file.warning("Unexpected end of inset.")
+        document.warning("Unexpected end of inset.")

     j = find_token(lines, '\\begin_inset LatexDel }{', i)
 
     ref = string.join(lines[i:j])
     j = find_token(lines, '\\begin_inset LatexDel }{', i)
 
     ref = string.join(lines[i:j])


@@ -189,7 +201,7 @@ def latexdel_getargs(file, i):
     if i == j:
         del lines[i]
     else:
     if i == j:
         del lines[i]
     else:

-        file.warning("Unexpected end of inset.")
+        document.warning("Unexpected end of inset.")

     j = find_token(lines, '\\begin_inset LatexDel }', i)
     label = string.join(lines[i:j])
     del lines[i:j + 1]
     j = find_token(lines, '\\begin_inset LatexDel }', i)
     label = string.join(lines[i:j])
     del lines[i:j + 1]


@@ -197,8 +209,9 @@ def latexdel_getargs(file, i):
     return ref, label
 
 
     return ref, label
 
 

-def update_ref(file):
-    lines = file.body
+def update_ref(document):
+    " Update reference inset. "
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset LatexCommand', i)
     i = 0
     while 1:
         i = find_token(lines, '\\begin_inset LatexCommand', i)


@@ -207,21 +220,24 @@ def update_ref(file):
 
         if string.split(lines[i])[-1] == "\\ref{":
             i = i + 1
 
         if string.split(lines[i])[-1] == "\\ref{":
             i = i + 1

-            ref, label = latexdel_getargs(file, i)
+            ref, label = latexdel_getargs(document, i)

             lines[i - 1] = "%s[%s]{%s}" % (lines[i - 1][:-1], ref, label)
 
         i = i + 1
 
 
             lines[i - 1] = "%s[%s]{%s}" % (lines[i - 1][:-1], ref, label)
 
         i = i + 1
 
 

-def update_latexdel(file):
-    lines = file.body
+def update_latexdel(document):
+    " Remove latexdel insets. "
+    lines = document.body

     i = 0
     latexdel_re = re.compile(r".*\\begin_inset LatexDel")
     while 1:
         i = find_re(lines, latexdel_re, i)
         if i == -1:
             return
     i = 0
     latexdel_re = re.compile(r".*\\begin_inset LatexDel")
     while 1:
         i = find_re(lines, latexdel_re, i)
         if i == -1:
             return

-        lines[i] = string.replace(lines[i],'\\begin_inset LatexDel', '\\begin_inset LatexCommand')
+        lines[i] = string.replace(lines[i],
+                                  '\\begin_inset LatexDel',
+                                  '\\begin_inset LatexCommand')

 
         j = string.find(lines[i],'\\begin_inset')
         lines.insert(i+1, lines[i][j:])
 
         j = string.find(lines[i],'\\begin_inset')
         lines.insert(i+1, lines[i][j:])


@@ -231,15 +247,19 @@ def update_latexdel(file):
         if string.split(lines[i])[-1] in ("\\url{", "\\htmlurl{"):
             i = i + 1
 
         if string.split(lines[i])[-1] in ("\\url{", "\\htmlurl{"):
             i = i + 1
 

-            ref, label = latexdel_getargs(file, i)
+            ref, label = latexdel_getargs(document, i)

             lines[i -1] = "%s[%s]{%s}" % (lines[i-1][:-1], label, ref)
 
         i = i + 1
 
 
             lines[i -1] = "%s[%s]{%s}" % (lines[i-1][:-1], label, ref)
 
         i = i + 1
 
 

-convert = [[216, [first_layout, remove_vcid, remove_cursor, update_toc,
-                  replace_protected_separator, merge_formula_inset,
-                  update_tabular, remove_space_in_units, update_ref, update_latexdel]]]
+supported_versions = ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]
+convert = [[216, [first_layout, remove_vcid, remove_cursor,
+                  update_toc, replace_protected_separator,
+                  merge_formula_inset, update_tabular,
+                  remove_space_in_units, update_ref,
+                  update_latexdel]]]
+

 revert  = []
 
 if __name__ == "__main__":
 revert  = []
 
 if __name__ == "__main__":

diff --git a/lib/lyx2lyx/lyx_1_1_6_0.py b/lib/lyx2lyx/lyx_1_1_6_0.py
index 8d9773235f6f02325c46816775103a25c96d7c43..77443c2364f0dd6ce84836453d9816f269d918bb 100644 (file)
--- a/lib/lyx2lyx/lyx_1_1_6_0.py
+++ b/lib/lyx2lyx/lyx_1_1_6_0.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2002-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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,14 +16,16 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.1.6"""
+

 import re
 import string
 from parser_tools import find_re, find_tokens, find_token, check_token
 
 import re
 import string
 from parser_tools import find_re, find_tokens, find_token, check_token
 

-

 lyxtable_re = re.compile(r".*\\LyXTable$")
 lyxtable_re = re.compile(r".*\\LyXTable$")

-def update_tabular(file):
-    lines = file.body
+def update_tabular(document):
+    " Update tabular to version 1 (xml like syntax). "
+    lines = document.body

     i=0
     while 1:
         i = find_re(lines, lyxtable_re, i)
     i=0
     while 1:
         i = find_re(lines, lyxtable_re, i)


@@ -100,13 +102,13 @@ def update_tabular(file):
                     continue
 
                 if l == ncells -1:
                     continue
 
                 if l == ncells -1:

-                    # the end variable refers to cell end, not to file end.
+                    # the end variable refers to cell end, not to document end.

                     end = find_tokens(lines, ['\\layout','\\the_end','\\end_deeper','\\end_float'], i)
                 else:
                     end = find_token(lines, '\\newline', i)
 
                 if end == -1:
                     end = find_tokens(lines, ['\\layout','\\the_end','\\end_deeper','\\end_float'], i)
                 else:
                     end = find_token(lines, '\\newline', i)
 
                 if end == -1:

-                    file.error("Malformed LyX file.")
+                    document.error("Malformed LyX file.")

 
                 end = end - i
                 while end > 0:
 
                 end = end - i
                 while end > 0:


@@ -146,7 +148,7 @@ def update_tabular(file):
                 tmp.append('<Cell multicolumn="%s" alignment="%s" valignment="0" topline="%s" bottomline="%s" leftline="%d" rightline="%d" rotate="%s" usebox="%s" width=%s special=%s>' % (cell_info[m][0],cell_info[m][1],cell_info[m][2],cell_info[m][3],leftline,rightline,cell_info[m][5],cell_info[m][6],cell_info[m][7],cell_info[m][8]))
                 tmp.append('\\begin_inset Text')
                 tmp.append('')
                 tmp.append('<Cell multicolumn="%s" alignment="%s" valignment="0" topline="%s" bottomline="%s" leftline="%d" rightline="%d" rotate="%s" usebox="%s" width=%s special=%s>' % (cell_info[m][0],cell_info[m][1],cell_info[m][2],cell_info[m][3],leftline,rightline,cell_info[m][5],cell_info[m][6],cell_info[m][7],cell_info[m][8]))
                 tmp.append('\\begin_inset Text')
                 tmp.append('')

-                tmp.append('\\layout %s' % file.default_layout)
+                tmp.append('\\layout %s' % document.default_layout)

                 tmp.append('')
 
                 if cell_info[m][0] != '2':
                 tmp.append('')
 
                 if cell_info[m][0] != '2':


@@ -179,8 +181,8 @@ def update_tabular(file):
 
 
 prop_exp = re.compile(r"\\(\S*)\s*(\S*)")
 
 
 prop_exp = re.compile(r"\\(\S*)\s*(\S*)")

-

 def set_paragraph_properties(lines, prop_dict):
 def set_paragraph_properties(lines, prop_dict):

+    " Set paragraph properties."

     # we need to preserve the order of options
     properties = ["family","series","shape","size",
                   "emph","bar","noun","latex","color"]
     # we need to preserve the order of options
     properties = ["family","series","shape","size",
                   "emph","bar","noun","latex","color"]


@@ -263,8 +265,10 @@ def set_paragraph_properties(lines, prop_dict):
     return result[:]
 
 
     return result[:]
 
 

-def update_language(file):
-    header = file.header
+def update_language(document):
+    " Update document language, if language is default convert it to
+    english."
+    header = document.header

     i = find_token(header, "\\language", 0)
     if i == -1:
         # no language, should emit a warning
     i = find_token(header, "\\language", 0)
     if i == -1:
         # no language, should emit a warning


@@ -276,6 +280,7 @@ def update_language(file):
     return
 
 
     return
 
 

+supported_versions = ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]

 convert = [[217, [update_tabular, update_language]]]
 revert  = []
 
 convert = [[217, [update_tabular, update_language]]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_1_6_3.py b/lib/lyx2lyx/lyx_1_1_6_3.py
index f7656d796adaf2cbbd1def62b2b6049729d8b1af..73383fae64c0b2b6084b8ee91a6e5102c244fa4f 100644 (file)
--- a/lib/lyx2lyx/lyx_1_1_6_3.py
+++ b/lib/lyx2lyx/lyx_1_1_6_3.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2002-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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,11 +16,14 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.1.6fix3"""
+

 import re
 import string
 from parser_tools import find_token, find_re
 
 def bool_table(item):
 import re
 import string
 from parser_tools import find_token, find_re
 
 def bool_table(item):

+    " Convert 0, 1 to false, true."

     if item == "0":
         return "false"
     # should emit a warning if item != "1"
     if item == "0":
         return "false"
     # should emit a warning if item != "1"


@@ -32,9 +35,10 @@ align_table = {"0": "top", "2": "left", "4": "right", "8": "center"}
 use_table = {"0": "none", "1": "parbox"}
 table_meta_re = re.compile(r'<LyXTabular version="?1"? rows="?(\d*)"? columns="?(\d*)"?>')
 
 use_table = {"0": "none", "1": "parbox"}
 table_meta_re = re.compile(r'<LyXTabular version="?1"? rows="?(\d*)"? columns="?(\d*)"?>')
 

-def update_tabular(file):
+def update_tabular(document):
+    " Update tabular format to version 2 (xml like syntax)."

     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     regexp = re.compile(r'^\\begin_inset\s+Tabular')

-    lines = file.body
+    lines = document.body

     i=0
     while 1:
         i = find_re(lines, regexp, i)
     i=0
     while 1:
         i = find_re(lines, regexp, i)


@@ -51,7 +55,7 @@ def update_tabular(file):
 
         j = find_token(lines, '</LyXTabular>', i) + 1
         if j == 0:
 
         j = find_token(lines, '</LyXTabular>', i) + 1
         if j == 0:

-            file.warning( "Error: Bad lyx format i=%d j=%d" % (i,j))
+            document.warning( "Error: Bad lyx format i=%d j=%d" % (i,j))

             break
 
         new_table = table_update(lines[i:j])
             break
 
         new_table = table_update(lines[i:j])


@@ -65,6 +69,7 @@ features_re = re.compile(r'<features rotate="?(\d)"? islongtable="?(\d)"? endhea
 row_re = re.compile(r'<row topline="?(\d)"? bottomline="?(\d)"? newpage="?(\d)"?>')
 
 def table_update(lines):
 row_re = re.compile(r'<row topline="?(\d)"? bottomline="?(\d)"? newpage="?(\d)"?>')
 
 def table_update(lines):

+    " Update table's internal content to format 2."

     lines[1] = string.replace(lines[1], '<Features', '<features')
     res = features_re.match( lines[1] )
     if res:
     lines[1] = string.replace(lines[1], '<Features', '<features')
     res = features_re.match( lines[1] )
     if res:


@@ -116,6 +121,7 @@ def table_update(lines):
     return lines[:2] + col_info + lines[2:]
 
 
     return lines[:2] + col_info + lines[2:]
 
 

+supported_versions = ["1.1.6fix3","1.1.6fix4","1.1"]

 convert = [[218, [update_tabular]]]
 revert  = []
 
 convert = [[218, [update_tabular]]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_2.py b/lib/lyx2lyx/lyx_1_2.py
index 3d9cd8b9121e81e382d3b04346698d00217f2ad9..755069bc7661021379942d5b6a191ca2bb23c115 100644 (file)
--- a/lib/lyx2lyx/lyx_1_2.py
+++ b/lib/lyx2lyx/lyx_1_2.py
@@ -1,7 +1,7 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-

 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>
 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>

-# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -17,11 +17,14 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.2"""
+

 import string
 import re
 
 from parser_tools import find_token, find_token_backwards, \
 import string
 import re
 
 from parser_tools import find_token, find_token_backwards, \

-                         find_tokens,  find_tokens_backwards, find_beginning_of, find_end_of, find_re, \
+                         find_tokens, find_tokens_backwards,
+                         find_beginning_of, find_end_of, find_re, \

                          is_nonempty_line, find_nonempty_line, \
                          get_value, check_token
 
                          is_nonempty_line, find_nonempty_line, \
                          get_value, check_token
 


@@ -29,14 +32,15 @@ from parser_tools import find_token, find_token_backwards, \
 # Private helper functions
 
 def get_layout(line, default_layout):
 # Private helper functions
 
 def get_layout(line, default_layout):

+    " Get layout, if empty return the default layout."

     tokens = string.split(line)
     if len(tokens) > 1:
         return tokens[1]
     return default_layout
 
 
     tokens = string.split(line)
     if len(tokens) > 1:
         return tokens[1]
     return default_layout
 
 

-# Finds the paragraph that contains line i.

 def get_paragraph(lines, i, format):
 def get_paragraph(lines, i, format):

+    " Finds the paragraph that contains line i."

     begin_layout = "\\layout"
 
     while i != -1:
     begin_layout = "\\layout"
 
     while i != -1:


@@ -48,8 +52,8 @@ def get_paragraph(lines, i, format):
     return -1
 
 
     return -1
 
 

-# Finds the paragraph after the paragraph that contains line i.

 def get_next_paragraph(lines, i, format):
 def get_next_paragraph(lines, i, format):

+    " Finds the paragraph after the paragraph that contains line i."

     tokens = ["\\begin_inset", "\\layout", "\\end_float", "\\the_end"]
 
     while i != -1:
     tokens = ["\\begin_inset", "\\layout", "\\end_float", "\\the_end"]
 
     while i != -1:


@@ -61,19 +65,22 @@ def get_next_paragraph(lines, i, format):
 
 
 def find_beginning_of_inset(lines, i):
 
 
 def find_beginning_of_inset(lines, i):

+    " Find beginning of inset, where lines[i] is included."

     return find_beginning_of(lines, i, "\\begin_inset", "\\end_inset")
 
 
     return find_beginning_of(lines, i, "\\begin_inset", "\\end_inset")
 
 

-# Finds the matching \end_inset

 def find_end_of_inset(lines, i):
 def find_end_of_inset(lines, i):

+    " Finds the matching \end_inset"

     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 
 def find_end_of_tabular(lines, i):
     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 
 def find_end_of_tabular(lines, i):

+    " Finds the matching end of tabular."

     return find_end_of(lines, i, "<lyxtabular", "</lyxtabular")
 
 
 def get_tabular_lines(lines, i):
     return find_end_of(lines, i, "<lyxtabular", "</lyxtabular")
 
 
 def get_tabular_lines(lines, i):

+    " Returns a lists of tabular lines."

     result = []
     i = i+1
     j = find_end_of_tabular(lines, i)
     result = []
     i = i+1
     j = find_end_of_tabular(lines, i)


@@ -126,6 +133,7 @@ pextra_rexp = re.compile(r"\\pextra_type\s+(\S+)"+\
 
 
 def get_width(mo):
 
 
 def get_width(mo):

+    " Get width from a regular expression. "

     if mo.group(10):
         if mo.group(9) == "\\pextra_widthp":
             return mo.group(10)+"col%"
     if mo.group(10):
         if mo.group(9) == "\\pextra_widthp":
             return mo.group(10)+"col%"


@@ -135,11 +143,9 @@ def get_width(mo):
         return "100col%"
 
 
         return "100col%"
 
 

-#
-# Change \begin_float .. \end_float into \begin_inset Float .. \end_inset
-#
-def remove_oldfloat(file):
-    lines = file.body
+def remove_oldfloat(document):
+    " Change \begin_float .. \end_float into \begin_inset Float .. \end_inset"
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_float", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_float", i)


@@ -150,7 +156,7 @@ def remove_oldfloat(file):
 
         floattype = string.split(lines[i])[1]
         if not floats.has_key(floattype):
 
         floattype = string.split(lines[i])[1]
         if not floats.has_key(floattype):

-            file.warning("Error! Unknown float type " + floattype)
+            document.warning("Error! Unknown float type " + floattype)

             floattype = "fig"
 
         # skip \end_deeper tokens
             floattype = "fig"
 
         # skip \end_deeper tokens


@@ -158,7 +164,7 @@ def remove_oldfloat(file):
         while check_token(lines[i2], "\\end_deeper"):
             i2 = i2+1
         if i2 > i+1:
         while check_token(lines[i2], "\\end_deeper"):
             i2 = i2+1
         if i2 > i+1:

-            j2 = get_next_paragraph(lines, j + 1, file.format + 1)
+            j2 = get_next_paragraph(lines, j + 1, document.format + 1)

             lines[j2:j2] = ["\\end_deeper "]*(i2-(i+1))
 
         new = floats[floattype]+[""]
             lines[j2:j2] = ["\\end_deeper "]*(i2-(i+1))
 
         new = floats[floattype]+[""]


@@ -183,7 +189,7 @@ def remove_oldfloat(file):
         # as extra '\foo default' commands are ignored.
         # In fact, it might be safer to output '\foo default' for all
         # font attributes.
         # as extra '\foo default' commands are ignored.
         # In fact, it might be safer to output '\foo default' for all
         # font attributes.

-        k = get_paragraph(lines, i, file.format + 1)
+        k = get_paragraph(lines, i, document.format + 1)

         flag = 0
         for token in font_tokens:
             if find_token(lines, token, k, i) != -1:
         flag = 0
         for token in font_tokens:
             if find_token(lines, token, k, i) != -1:


@@ -193,7 +199,7 @@ def remove_oldfloat(file):
                     flag = 1
                     new.append("")
                 if token == "\\lang":
                     flag = 1
                     new.append("")
                 if token == "\\lang":

-                    new.append(token+" "+ file.language)
+                    new.append(token+" "+ document.language)

                 else:
                     new.append(token+" default ")
 
                 else:
                     new.append(token+" default ")
 


@@ -205,8 +211,9 @@ pextra_type2_rexp = re.compile(r".*\\pextra_type\s+[12]")
 pextra_type2_rexp2 = re.compile(r".*(\\layout|\\pextra_type\s+2)")
 pextra_widthp = re.compile(r"\\pextra_widthp")
 
 pextra_type2_rexp2 = re.compile(r".*(\\layout|\\pextra_type\s+2)")
 pextra_widthp = re.compile(r"\\pextra_widthp")
 

-def remove_pextra(file):
-    lines = file.body
+def remove_pextra(document):
+    " Remove pextra token."
+    lines = document.body

     i = 0
     flag = 0
     while 1:
     i = 0
     flag = 0
     while 1:


@@ -246,10 +253,10 @@ def remove_pextra(file):
             if hfill:
                 start = ["","\hfill",""]+start
         else:
             if hfill:
                 start = ["","\hfill",""]+start
         else:

-            start = ['\\layout %s' % file.default_layout,''] + start
+            start = ['\\layout %s' % document.default_layout,''] + start

 
         j0 = find_token_backwards(lines,"\\layout", i-1)
 
         j0 = find_token_backwards(lines,"\\layout", i-1)

-        j = get_next_paragraph(lines, i, file.format + 1)
+        j = get_next_paragraph(lines, i, document.format + 1)

 
         count = 0
         while 1:
 
         count = 0
         while 1:


@@ -277,6 +284,7 @@ def remove_pextra(file):
 
 
 def is_empty(lines):
 
 
 def is_empty(lines):

+    " Are all the lines empty?"

     return filter(is_nonempty_line, lines) == []
 
 
     return filter(is_nonempty_line, lines) == []
 
 


@@ -285,13 +293,14 @@ ert_rexp = re.compile(r"\\begin_inset|\\hfill|.*\\SpecialChar")
 spchar_rexp = re.compile(r"(.*)(\\SpecialChar.*)")
 
 
 spchar_rexp = re.compile(r"(.*)(\\SpecialChar.*)")
 
 

-def remove_oldert(file):
+def remove_oldert(document):
+    " Remove old ERT inset."

     ert_begin = ["\\begin_inset ERT",
                  "status Collapsed",
                  "",
     ert_begin = ["\\begin_inset ERT",
                  "status Collapsed",
                  "",

-                 '\\layout %s' % file.default_layout,
+                 '\\layout %s' % document.default_layout,

                  ""]
                  ""]

-    lines = file.body
+    lines = document.body

     i = 0
     while 1:
         i = find_tokens(lines, ["\\latex latex", "\\layout LaTeX"], i)
     i = 0
     while 1:
         i = find_tokens(lines, ["\\latex latex", "\\layout LaTeX"], i)


@@ -316,7 +325,7 @@ def remove_oldert(file):
         new = []
         new2 = []
         if check_token(lines[i], "\\layout LaTeX"):
         new = []
         new2 = []
         if check_token(lines[i], "\\layout LaTeX"):

-            new = ['\layout %s' % file.default_layout, "", ""]
+            new = ['\layout %s' % document.default_layout, "", ""]

 
         k = i+1
         while 1:
 
         k = i+1
         while 1:


@@ -398,9 +407,9 @@ def remove_oldert(file):
         del lines[i]
 
 
         del lines[i]
 
 

-# ERT insert are hidden feature of lyx 1.1.6. This might be removed in the future.
-def remove_oldertinset(file):
-    lines = file.body
+def remove_oldertinset(document):
+    " ERT insert are hidden feature of lyx 1.1.6. This might be removed in the future."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset ERT", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset ERT", i)


@@ -408,7 +417,7 @@ def remove_oldertinset(file):
             break
         j = find_end_of_inset(lines, i)
         k = find_token(lines, "\\layout", i+1)
             break
         j = find_end_of_inset(lines, i)
         k = find_token(lines, "\\layout", i+1)

-        l = get_paragraph(lines, i, file.format + 1)
+        l = get_paragraph(lines, i, document.format + 1)

         if lines[k] == lines[l]: # same layout
             k = k+1
         new = lines[k:j]
         if lines[k] == lines[l]: # same layout
             k = k+1
         new = lines[k:j]


@@ -416,11 +425,12 @@ def remove_oldertinset(file):
         i = i+1
 
 
         i = i+1
 
 

-def is_ert_paragraph(file, i):
-    lines = file.body
+def is_ert_paragraph(document, i):
+    " Is this a ert paragraph? "
+    lines = document.body

     if not check_token(lines[i], "\\layout"):
         return 0
     if not check_token(lines[i], "\\layout"):
         return 0

-    if not file.is_default_layout(get_layout(lines[i], file.default_layout)):
+    if not document.is_default_layout(get_layout(lines[i], document.default_layout)):

         return 0
 
     i = find_nonempty_line(lines, i+1)
         return 0
 
     i = find_nonempty_line(lines, i+1)


@@ -432,17 +442,18 @@ def is_ert_paragraph(file, i):
     return check_token(lines[k], "\\layout")
 
 
     return check_token(lines[k], "\\layout")
 
 

-def combine_ert(file):
-    lines = file.body
+def combine_ert(document):
+    " Combine ERT paragraphs."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset ERT", i)
         if i == -1:
             break
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset ERT", i)
         if i == -1:
             break

-        j = get_paragraph(lines, i, file.format + 1)
+        j = get_paragraph(lines, i, document.format + 1)

         count = 0
         text = []
         count = 0
         text = []

-        while is_ert_paragraph(file, j):
+        while is_ert_paragraph(document, j):

 
             count = count+1
             i2 = find_token(lines, "\\layout", j+1)
 
             count = count+1
             i2 = find_token(lines, "\\layout", j+1)


@@ -462,6 +473,7 @@ def combine_ert(file):
 oldunits = ["pt", "cm", "in", "text%", "col%"]
 
 def get_length(lines, name, start, end):
 oldunits = ["pt", "cm", "in", "text%", "col%"]
 
 def get_length(lines, name, start, end):

+    " Get lenght."

     i = find_token(lines, name, start, end)
     if i == -1:
         return ""
     i = find_token(lines, name, start, end)
     if i == -1:
         return ""


@@ -470,12 +482,14 @@ def get_length(lines, name, start, end):
 
 
 def write_attribute(x, token, value):
 
 
 def write_attribute(x, token, value):

+    " Write attribute."

     if value != "":
         x.append("\t"+token+" "+value)
 
 
     if value != "":
         x.append("\t"+token+" "+value)
 
 

-def remove_figinset(file):
-    lines = file.body
+def remove_figinset(document):
+    " Remove figinset."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Figure", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Figure", i)


@@ -543,15 +557,13 @@ def remove_figinset(file):
         lines[i:j+1] = new
 
 
         lines[i:j+1] = new
 
 

-##
-# Convert tabular format 2 to 3
-#

 attr_re = re.compile(r' \w*="(false|0|)"')
 line_re = re.compile(r'<(features|column|row|cell)')
 
 attr_re = re.compile(r' \w*="(false|0|)"')
 line_re = re.compile(r'<(features|column|row|cell)')
 

-def update_tabular(file):
+def update_tabular(document):
+    " Convert tabular format 2 to 3."

     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     regexp = re.compile(r'^\\begin_inset\s+Tabular')

-    lines = file.body
+    lines = document.body

     i = 0
     while 1:
         i = find_re(lines, regexp, i)
     i = 0
     while 1:
         i = find_re(lines, regexp, i)


@@ -587,8 +599,8 @@ def update_tabular(file):
 false = 0
 true = 1
 
 false = 0
 true = 1
 

-# simple data structure to deal with long table info

 class row:
 class row:

+    " Simple data structure to deal with long table info."

     def __init__(self):
         self.endhead = false                # header row
         self.endfirsthead = false        # first header row
     def __init__(self):
         self.endhead = false                # header row
         self.endfirsthead = false        # first header row


@@ -597,6 +609,7 @@ class row:
 
 
 def haveLTFoot(row_info):
 
 
 def haveLTFoot(row_info):

+    " Does row has LTFoot?"

     for row_ in row_info:
         if row_.endfoot:
             return true
     for row_ in row_info:
         if row_.endfoot:
             return true


@@ -604,6 +617,7 @@ def haveLTFoot(row_info):
 
 
 def setHeaderFooterRows(hr, fhr, fr, lfr, rows_, row_info):
 
 
 def setHeaderFooterRows(hr, fhr, fr, lfr, rows_, row_info):

+    " Set Header/Footer rows."

     endfirsthead_empty = false
     endlastfoot_empty = false
     # set header info
     endfirsthead_empty = false
     endlastfoot_empty = false
     # set header info


@@ -670,6 +684,7 @@ def setHeaderFooterRows(hr, fhr, fr, lfr, rows_, row_info):
 
 
 def insert_attribute(lines, i, attribute):
 
 
 def insert_attribute(lines, i, attribute):

+    " Insert attribute in lines[i]."

     last = string.find(lines[i],'>')
     lines[i] = lines[i][:last] + ' ' + attribute + lines[i][last:]
 
     last = string.find(lines[i],'>')
     lines[i] = lines[i][:last] + ' ' + attribute + lines[i][last:]
 


@@ -678,9 +693,10 @@ rows_re = re.compile(r'rows="(\d*)"')
 longtable_re = re.compile(r'islongtable="(\w)"')
 ltvalues_re = re.compile(r'endhead="(-?\d*)" endfirsthead="(-?\d*)" endfoot="(-?\d*)" endlastfoot="(-?\d*)"')
 lt_features_re = re.compile(r'(endhead="-?\d*" endfirsthead="-?\d*" endfoot="-?\d*" endlastfoot="-?\d*")')
 longtable_re = re.compile(r'islongtable="(\w)"')
 ltvalues_re = re.compile(r'endhead="(-?\d*)" endfirsthead="(-?\d*)" endfoot="(-?\d*)" endlastfoot="(-?\d*)"')
 lt_features_re = re.compile(r'(endhead="-?\d*" endfirsthead="-?\d*" endfoot="-?\d*" endlastfoot="-?\d*")')

-def update_longtables(file):
+def update_longtables(document):
+    " Update longtables to new format."

     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     regexp = re.compile(r'^\\begin_inset\s+Tabular')

-    body = file.body
+    body = document.body

     i = 0
     while 1:
         i = find_re(body, regexp, i)
     i = 0
     while 1:
         i = find_re(body, regexp, i)


@@ -747,9 +763,9 @@ def update_longtables(file):
             i = i + 1
 
 
             i = i + 1
 
 

-# Figure insert are hidden feature of lyx 1.1.6. This might be removed in the future.
-def fix_oldfloatinset(file):
-    lines = file.body
+def fix_oldfloatinset(document):
+    " Figure insert are hidden feature of lyx 1.1.6. This might be removed in the future."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Float ", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Float ", i)


@@ -761,8 +777,9 @@ def fix_oldfloatinset(file):
         i = i+1
 
 
         i = i+1
 
 

-def change_listof(file):
-    lines = file.body
+def change_listof(document):
+    " Change listof insets."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset LatexCommand \\listof", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset LatexCommand \\listof", i)


@@ -773,8 +790,9 @@ def change_listof(file):
         i = i+1
 
 
         i = i+1
 
 

-def change_infoinset(file):
-    lines = file.body
+def change_infoinset(document):
+    " Change info inset."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Info", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Info", i)


@@ -791,7 +809,7 @@ def change_infoinset(file):
             note_lines = [txt]+note_lines
 
         for line in note_lines:
             note_lines = [txt]+note_lines
 
         for line in note_lines:

-            new = new + ['\layout %s' % file.default_layout, ""]
+            new = new + ['\layout %s' % document.default_layout, ""]

             tmp = string.split(line, '\\')
             new = new + [tmp[0]]
             for x in tmp[1:]:
             tmp = string.split(line, '\\')
             new = new + [tmp[0]]
             for x in tmp[1:]:


@@ -800,8 +818,9 @@ def change_infoinset(file):
         i = i+5
 
 
         i = i+5
 
 

-def change_header(file):
-    lines = file.header
+def change_header(document):
+    " Update header."
+    lines = document.header

     i = find_token(lines, "\\use_amsmath", 0)
     if i == -1:
         return
     i = find_token(lines, "\\use_amsmath", 0)
     if i == -1:
         return


@@ -809,6 +828,7 @@ def change_header(file):
                       "\use_numerical_citations 0"]
 
 
                       "\use_numerical_citations 0"]
 
 

+supported_versions = ["1.2.%d" % i for i in range(5)] + ["1.2"]

 convert = [[220, [change_header, change_listof, fix_oldfloatinset,
                   update_tabular, update_longtables, remove_pextra,
                   remove_oldfloat, remove_figinset, remove_oldertinset,
 convert = [[220, [change_header, change_listof, fix_oldfloatinset,
                   update_tabular, update_longtables, remove_pextra,
                   remove_oldfloat, remove_figinset, remove_oldertinset,

diff --git a/lib/lyx2lyx/lyx_1_3.py b/lib/lyx2lyx/lyx_1_3.py
index 0439f72ded59ca4604fc1d1f78a7acc73bf57a24..9a9a9d6bba5c79fee6307a17b5e8f953b47d409b 100644 (file)
--- a/lib/lyx2lyx/lyx_1_3.py
+++ b/lib/lyx2lyx/lyx_1_3.py
@@ -1,7 +1,7 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-

 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>
 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>

-# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -17,6 +17,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.3"""
+

 import string
 import re
 from parser_tools import find_token, find_end_of, get_value,\
 import string
 import re
 from parser_tools import find_token, find_end_of, get_value,\


@@ -33,8 +35,9 @@ def find_end_of_inset(lines, i):
 ####################################################################
 
 
 ####################################################################
 
 

-def change_insetgraphics(file):
-    lines = file.body
+def change_insetgraphics(document):
+    " Change inset Graphics."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Graphics", i)
     i = 0
     while 1:
         i = find_token(lines, "\\begin_inset Graphics", i)


@@ -91,8 +94,9 @@ def change_insetgraphics(file):
         i = i+1
 
 
         i = i+1
 
 

-def change_tabular(file):
-    lines = file.body
+def change_tabular(document):
+    " Change tabular."
+    lines = document.body

     i = 0
     while 1:
         i = find_token(lines, "<column", i)
     i = 0
     while 1:
         i = find_token(lines, "<column", i)


@@ -103,6 +107,7 @@ def change_tabular(file):
         i = i+1
 
 
         i = i+1
 
 

+supported_versions = ["1.3.%d" % i for i in range(8)] + ["1.3"]

 convert = [[221, [change_insetgraphics, change_tabular]]]
 revert  = []
 
 convert = [[221, [change_insetgraphics, change_tabular]]]
 revert  = []
 

diff --git a/lib/lyx2lyx/lyx_1_4.py b/lib/lyx2lyx/lyx_1_4.py
index 4a9cf720d456b9507b1453e18342e8f5964fc6ed..af0d025ca7f1ba51a6cfb3fe35fdaa6462062a35 100644 (file)
--- a/lib/lyx2lyx/lyx_1_4.py
+++ b/lib/lyx2lyx/lyx_1_4.py
@@ -1,7 +1,7 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-

 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>
 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>

-# Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>
+# Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>

 # Copyright (C) 2004-2005 Georg Baum <Georg.Baum@post.rwth-aachen.de>
 #
 # This program is free software; you can redistribute it and/or
 # Copyright (C) 2004-2005 Georg Baum <Georg.Baum@post.rwth-aachen.de>
 #
 # This program is free software; you can redistribute it and/or


@@ -18,6 +18,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.4"""
+

 import re
 from os import access, F_OK
 import os.path
 import re
 from os import access, F_OK
 import os.path


@@ -34,6 +36,7 @@ from lyx_0_12 import update_latexaccents
 # Private helper functions
 
 def get_layout(line, default_layout):
 # Private helper functions
 
 def get_layout(line, default_layout):

+    " Get layout, if empty return the default layout."

     tokens = split(line)
     if len(tokens) > 1:
         return tokens[1]
     tokens = split(line)
     if len(tokens) > 1:
         return tokens[1]


@@ -57,6 +60,7 @@ def get_paragraph(lines, i, format):
 
 
 def find_beginning_of_inset(lines, i):
 
 
 def find_beginning_of_inset(lines, i):

+    " Find beginning of inset, where lines[i] is included."

     return find_beginning_of(lines, i, "\\begin_inset", "\\end_inset")
 
 
     return find_beginning_of(lines, i, "\\begin_inset", "\\end_inset")
 
 


@@ -84,42 +88,39 @@ def find_end_of_inset(lines, i):
 # End of helper functions
 ####################################################################
 
 # End of helper functions
 ####################################################################
 

-
-##
-# Remove \color default
-#
-def remove_color_default(file):
+def remove_color_default(document):
+    " Remove \color default"

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\color default", i)
+        i = find_token(document.body, "\\color default", i)

         if i == -1:
             return
         if i == -1:
             return

-        file.body[i] = replace(file.body[i], "\\color default",
+        document.body[i] = replace(document.body[i], "\\color default",

                            "\\color inherit")
 
 
                            "\\color inherit")
 
 

-##
-# Add \end_header
-#
-def add_end_header(file):
-    file.header.append("\\end_header");
+def add_end_header(document):
+    " Add \end_header"
+    document.header.append("\\end_header");

 
 
 
 

-def rm_end_header(file):
-    i = find_token(file.header, "\\end_header", 0)
+def rm_end_header(document):
+    " Remove \end_header"
+    i = find_token(document.header, "\\end_header", 0)

     if i == -1:
         return
     if i == -1:
         return

-    del file.header[i]
+    del document.header[i]

 
 
 
 

-def convert_amsmath(file):
-    i = find_token(file.header, "\\use_amsmath", 0)
+def convert_amsmath(document):
+    " Convert \\use_amsmath"
+    i = find_token(document.header, "\\use_amsmath", 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing '\\use_amsmath'.")
+        document.warning("Malformed LyX document: Missing '\\use_amsmath'.")

         return
         return

-    tokens = split(file.header[i])
+    tokens = split(document.header[i])

     if len(tokens) != 2:
     if len(tokens) != 2:

-        file.warning("Malformed LyX file: Could not parse line '%s'." % file.header[i])
+        document.warning("Malformed LyX document: Could not parse line '%s'." % document.header[i])

         use_amsmath = '0'
     else:
         use_amsmath = tokens[1]
         use_amsmath = '0'
     else:
         use_amsmath = tokens[1]


@@ -127,19 +128,20 @@ def convert_amsmath(file):
     # new: 0 == off, 1 == auto, 2 == on
     # translate off -> auto, since old format 'off' means auto in reality
     if use_amsmath == '0':
     # new: 0 == off, 1 == auto, 2 == on
     # translate off -> auto, since old format 'off' means auto in reality
     if use_amsmath == '0':

-        file.header[i] = "\\use_amsmath 1"
+        document.header[i] = "\\use_amsmath 1"

     else:
     else:

-        file.header[i] = "\\use_amsmath 2"
+        document.header[i] = "\\use_amsmath 2"

 
 
 
 

-def revert_amsmath(file):
-    i = find_token(file.header, "\\use_amsmath", 0)
+def revert_amsmath(document):
+    " Revert \\use_amsmath"
+    i = find_token(document.header, "\\use_amsmath", 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing '\\use_amsmath'.")
+        document.warning("Malformed LyX document: Missing '\\use_amsmath'.")

         return
         return

-    tokens = split(file.header[i])
+    tokens = split(document.header[i])

     if len(tokens) != 2:
     if len(tokens) != 2:

-        file.warning("Malformed LyX file: Could not parse line '%s'." % file.header[i])
+        document.warning("Malformed LyX document: Could not parse line '%s'." % document.header[i])

         use_amsmath = '0'
     else:
         use_amsmath = tokens[1]
         use_amsmath = '0'
     else:
         use_amsmath = tokens[1]


@@ -147,58 +149,56 @@ def revert_amsmath(file):
     # new: 0 == off, 1 == auto, 2 == on
     # translate auto -> off, since old format 'off' means auto in reality
     if use_amsmath == '2':
     # new: 0 == off, 1 == auto, 2 == on
     # translate auto -> off, since old format 'off' means auto in reality
     if use_amsmath == '2':

-        file.header[i] = "\\use_amsmath 1"
+        document.header[i] = "\\use_amsmath 1"

     else:
     else:

-        file.header[i] = "\\use_amsmath 0"
+        document.header[i] = "\\use_amsmath 0"

 
 
 
 

-##
-# \SpecialChar ~ -> \InsetSpace ~
-#
-def convert_spaces(file):
-    for i in range(len(file.body)):
-        file.body[i] = replace(file.body[i],"\\SpecialChar ~","\\InsetSpace ~")
+def convert_spaces(document):
+    " \SpecialChar ~ -> \InsetSpace ~"
+    for i in range(len(document.body)):
+        document.body[i] = replace(document.body[i],"\\SpecialChar ~","\\InsetSpace ~")

 
 
 
 

-def revert_spaces(file):
+def revert_spaces(document):
+    " \InsetSpace ~ -> \SpecialChar ~"

     regexp = re.compile(r'(.*)(\\InsetSpace\s+)(\S+)')
     i = 0
     while 1:
     regexp = re.compile(r'(.*)(\\InsetSpace\s+)(\S+)')
     i = 0
     while 1:

-        i = find_re(file.body, regexp, i)
+        i = find_re(document.body, regexp, i)

         if i == -1:
             break
         if i == -1:
             break

-        space = regexp.match(file.body[i]).group(3)
-        prepend = regexp.match(file.body[i]).group(1)
+        space = regexp.match(document.body[i]).group(3)
+        prepend = regexp.match(document.body[i]).group(1)

         if space == '~':
         if space == '~':

-            file.body[i] = regexp.sub(prepend + '\\SpecialChar ~', file.body[i])
+            document.body[i] = regexp.sub(prepend + '\\SpecialChar ~', document.body[i])

             i = i + 1
         else:
             i = i + 1
         else:

-            file.body[i] = regexp.sub(prepend, file.body[i])
-            file.body[i+1:i+1] = ''
+            document.body[i] = regexp.sub(prepend, document.body[i])
+            document.body[i+1:i+1] = ''

             if space == "\\space":
                 space = "\\ "
             if space == "\\space":
                 space = "\\ "

-            i = insert_ert(file.body, i+1, 'Collapsed', space, file.format - 1, file.default_layout)
+            i = insert_ert(document.body, i+1, 'Collapsed', space, document.format - 1, document.default_layout)

 
 

-##
-# \InsetSpace \, -> \InsetSpace \thinspace{}
-# \InsetSpace \space -> \InsetSpace \space{}
-#
-def rename_spaces(file):
-    for i in range(len(file.body)):
-        file.body[i] = replace(file.body[i],"\\InsetSpace \\space","\\InsetSpace \\space{}")
-        file.body[i] = replace(file.body[i],"\\InsetSpace \,","\\InsetSpace \\thinspace{}")

 
 

+def rename_spaces(document):
+    """ \InsetSpace \, -> \InsetSpace \thinspace{}
+        \InsetSpace \space -> \InsetSpace \space{}"""
+    for i in range(len(document.body)):
+        document.body[i] = replace(document.body[i],"\\InsetSpace \\space","\\InsetSpace \\space{}")
+        document.body[i] = replace(document.body[i],"\\InsetSpace \,","\\InsetSpace \\thinspace{}")

 
 

-def revert_space_names(file):
-    for i in range(len(file.body)):
-        file.body[i] = replace(file.body[i],"\\InsetSpace \\space{}","\\InsetSpace \\space")
-        file.body[i] = replace(file.body[i],"\\InsetSpace \\thinspace{}","\\InsetSpace \\,")
+
+def revert_space_names(document):
+    """ \InsetSpace \thinspace{} -> \InsetSpace \,
+         \InsetSpace \space{} -> \InsetSpace \space"""
+    for i in range(len(document.body)):
+        document.body[i] = replace(document.body[i],"\\InsetSpace \\space{}","\\InsetSpace \\space")
+        document.body[i] = replace(document.body[i],"\\InsetSpace \\thinspace{}","\\InsetSpace \\,")

 
 
 
 

-##
-# equivalent to lyx::support::escape()
-#

 def lyx_support_escape(lab):
 def lyx_support_escape(lab):

+    " Equivalent to lyx::support::escape()"

     hexdigit = ['0', '1', '2', '3', '4', '5', '6', '7',
                 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F']
     enc = ""
     hexdigit = ['0', '1', '2', '3', '4', '5', '6', '7',
                 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F']
     enc = ""


@@ -213,62 +213,55 @@ def lyx_support_escape(lab):
     return enc;
 
 
     return enc;
 
 

-##
-# \begin_inset LatexCommand \eqref -> ERT
-#
-def revert_eqref(file):
+def revert_eqref(document):
+    "\\begin_inset LatexCommand \\eqref -> ERT"

     regexp = re.compile(r'^\\begin_inset\s+LatexCommand\s+\\eqref')
     i = 0
     while 1:
     regexp = re.compile(r'^\\begin_inset\s+LatexCommand\s+\\eqref')
     i = 0
     while 1:

-        i = find_re(file.body, regexp, i)
+        i = find_re(document.body, regexp, i)

         if i == -1:
             break
         if i == -1:
             break

-        eqref = lyx_support_escape(regexp.sub("", file.body[i]))
-        file.body[i:i+1] = ["\\begin_inset ERT", "status Collapsed", "",
-                            '\\layout %s' % file.default_layout, "", "\\backslash ",
+        eqref = lyx_support_escape(regexp.sub("", document.body[i]))
+        document.body[i:i+1] = ["\\begin_inset ERT", "status Collapsed", "",
+                            '\\layout %s' % document.default_layout, "", "\\backslash ",

                             "eqref" + eqref]
         i = i + 7
 
 
                             "eqref" + eqref]
         i = i + 7
 
 

-##
-# BibTeX changes
-#
-def convert_bibtex(file):
-    for i in range(len(file.body)):
-        file.body[i] = replace(file.body[i],"\\begin_inset LatexCommand \\BibTeX",
+def convert_bibtex(document):
+    " Convert BibTeX changes."
+    for i in range(len(document.body)):
+        document.body[i] = replace(document.body[i],"\\begin_inset LatexCommand \\BibTeX",

                                   "\\begin_inset LatexCommand \\bibtex")
 
 
                                   "\\begin_inset LatexCommand \\bibtex")
 
 

-def revert_bibtex(file):
-    for i in range(len(file.body)):
-        file.body[i] = replace(file.body[i], "\\begin_inset LatexCommand \\bibtex",
+def revert_bibtex(document):
+    " Revert BibTeX changes."
+    for i in range(len(document.body)):
+        document.body[i] = replace(document.body[i], "\\begin_inset LatexCommand \\bibtex",

                                   "\\begin_inset LatexCommand \\BibTeX")
 
 
                                   "\\begin_inset LatexCommand \\BibTeX")
 
 

-##
-# Remove \lyxparent
-#
-def remove_insetparent(file):
+def remove_insetparent(document):
+    " Remove \lyxparent"

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset LatexCommand \\lyxparent", i)
+        i = find_token(document.body, "\\begin_inset LatexCommand \\lyxparent", i)

         if i == -1:
             break
         if i == -1:
             break

-        del file.body[i:i+3]
+        del document.body[i:i+3]

 
 
 
 

-##
-#  Inset External
-#
-def convert_external(file):
+def convert_external(document):
+    " Convert inset External."

     external_rexp = re.compile(r'\\begin_inset External ([^,]*),"([^"]*)",')
     external_header = "\\begin_inset External"
     i = 0
     while 1:
     external_rexp = re.compile(r'\\begin_inset External ([^,]*),"([^"]*)",')
     external_header = "\\begin_inset External"
     i = 0
     while 1:

-        i = find_token(file.body, external_header, i)
+        i = find_token(document.body, external_header, i)

         if i == -1:
             break
         if i == -1:
             break

-        look = external_rexp.search(file.body[i])
+        look = external_rexp.search(document.body[i])

         args = ['','']
         if look:
             args[0] = look.group(1)
         args = ['','']
         if look:
             args[0] = look.group(1)


@@ -280,7 +273,7 @@ def convert_external(file):
             top = "\\begin_inset Graphics"
             if args[1]:
                 filename = "\tfilename " + args[1]
             top = "\\begin_inset Graphics"
             if args[1]:
                 filename = "\tfilename " + args[1]

-            file.body[i:i+1] = [top, filename]
+            document.body[i:i+1] = [top, filename]

             i = i + 1
         else:
             # Convert the old External Inset format to the new.
             i = i + 1
         else:
             # Convert the old External Inset format to the new.


@@ -288,137 +281,136 @@ def convert_external(file):
             template = "\ttemplate " + args[0]
             if args[1]:
                 filename = "\tfilename " + args[1]
             template = "\ttemplate " + args[0]
             if args[1]:
                 filename = "\tfilename " + args[1]

-                file.body[i:i+1] = [top, template, filename]
+                document.body[i:i+1] = [top, template, filename]

                 i = i + 2
             else:
                 i = i + 2
             else:

-                file.body[i:i+1] = [top, template]
+                document.body[i:i+1] = [top, template]

                 i = i + 1
 
 
                 i = i + 1
 
 

-def revert_external_1(file):
+def revert_external_1(document):
+    " Revert inset External."

     external_header = "\\begin_inset External"
     i = 0
     while 1:
     external_header = "\\begin_inset External"
     i = 0
     while 1:

-        i = find_token(file.body, external_header, i)
+        i = find_token(document.body, external_header, i)

         if i == -1:
             break
 
         if i == -1:
             break
 

-        template = split(file.body[i+1])
+        template = split(document.body[i+1])

         template.reverse()
         template.reverse()

-        del file.body[i+1]
+        del document.body[i+1]

 
 

-        filename = split(file.body[i+1])
+        filename = split(document.body[i+1])

         filename.reverse()
         filename.reverse()

-        del file.body[i+1]
+        del document.body[i+1]

 
 

-        params = split(file.body[i+1])
+        params = split(document.body[i+1])

         params.reverse()
         params.reverse()

-        if file.body[i+1]: del file.body[i+1]
+        if document.body[i+1]: del document.body[i+1]

 
 

-        file.body[i] = file.body[i] + " " + template[0]+ ', "' + filename[0] + '", " '+ join(params[1:]) + '"'
+        document.body[i] = document.body[i] + " " + template[0]+ ', "' + filename[0] + '", " '+ join(params[1:]) + '"'

         i = i + 1
 
 
         i = i + 1
 
 

-def revert_external_2(file):
+def revert_external_2(document):
+    " Revert inset External. (part II)"

     draft_token = '\tdraft'
     i = 0
     while 1:
     draft_token = '\tdraft'
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_inset External', i)
+        i = find_token(document.body, '\\begin_inset External', i)

         if i == -1:
             break
         if i == -1:
             break

-        j = find_end_of_inset(file.body, i + 1)
+        j = find_end_of_inset(document.body, i + 1)

         if j == -1:
             #this should not happen
             break
         if j == -1:
             #this should not happen
             break

-        k = find_token(file.body, draft_token, i+1, j-1)
-        if (k != -1 and len(draft_token) == len(file.body[k])):
-            del file.body[k]
+        k = find_token(document.body, draft_token, i+1, j-1)
+        if (k != -1 and len(draft_token) == len(document.body[k])):
+            del document.body[k]

         i = j + 1
 
 
         i = j + 1
 
 

-##
-# Comment
-#
-def convert_comment(file):
+def convert_comment(document):
+    " Convert \\layout comment"

     i = 0
     comment = "\\layout Comment"
     while 1:
     i = 0
     comment = "\\layout Comment"
     while 1:

-        i = find_token(file.body, comment, i)
+        i = find_token(document.body, comment, i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        file.body[i:i+1] = ['\\layout %s' % file.default_layout,"","",
+        document.body[i:i+1] = ['\\layout %s' % document.default_layout,"","",

                         "\\begin_inset Comment",
                         "collapsed true","",
                         "\\begin_inset Comment",
                         "collapsed true","",

-                        '\\layout %s' % file.default_layout]
+                        '\\layout %s' % document.default_layout]

         i = i + 7
 
         while 1:
                 old_i = i
         i = i + 7
 
         while 1:
                 old_i = i

-                i = find_token(file.body, "\\layout", i)
+                i = find_token(document.body, "\\layout", i)

                 if i == -1:
                 if i == -1:

-                    i = len(file.body) - 1
-                    file.body[i:i] = ["\\end_inset","",""]
+                    i = len(document.body) - 1
+                    document.body[i:i] = ["\\end_inset","",""]

                     return
 
                     return
 

-                j = find_token(file.body, '\\begin_deeper', old_i, i)
+                j = find_token(document.body, '\\begin_deeper', old_i, i)

                 if j == -1: j = i + 1
                 if j == -1: j = i + 1

-                k = find_token(file.body, '\\begin_inset', old_i, i)
+                k = find_token(document.body, '\\begin_inset', old_i, i)

                 if k == -1: k = i + 1
 
                 if j < i and j < k:
                     i = j
                 if k == -1: k = i + 1
 
                 if j < i and j < k:
                     i = j

-                    del file.body[i]
-                    i = find_end_of( file.body, i, "\\begin_deeper","\\end_deeper")
+                    del document.body[i]
+                    i = find_end_of( document.body, i, "\\begin_deeper","\\end_deeper")

                     if i == -1:
                         #This case should not happen
                         #but if this happens deal with it greacefully adding
                         #the missing \end_deeper.
                     if i == -1:
                         #This case should not happen
                         #but if this happens deal with it greacefully adding
                         #the missing \end_deeper.

-                        i = len(file.body) - 1
-                        file.body[i:i] = ["\end_deeper",""]
+                        i = len(document.body) - 1
+                        document.body[i:i] = ["\end_deeper",""]

                         return
                     else:
                         return
                     else:

-                        del file.body[i]
+                        del document.body[i]

                         continue
 
                 if k < i:
                     i = k
                         continue
 
                 if k < i:
                     i = k

-                    i = find_end_of( file.body, i, "\\begin_inset","\\end_inset")
+                    i = find_end_of( document.body, i, "\\begin_inset","\\end_inset")

                     if i == -1:
                         #This case should not happen
                         #but if this happens deal with it greacefully adding
                         #the missing \end_inset.
                     if i == -1:
                         #This case should not happen
                         #but if this happens deal with it greacefully adding
                         #the missing \end_inset.

-                        i = len(file.body) - 1
-                        file.body[i:i] = ["\\end_inset","","","\\end_inset","",""]
+                        i = len(document.body) - 1
+                        document.body[i:i] = ["\\end_inset","","","\\end_inset","",""]

                         return
                     else:
                         i = i + 1
                         continue
 
                         return
                     else:
                         i = i + 1
                         continue
 

-                if find(file.body[i], comment) == -1:
-                    file.body[i:i] = ["\\end_inset"]
+                if find(document.body[i], comment) == -1:
+                    document.body[i:i] = ["\\end_inset"]

                     i = i + 1
                     break
                     i = i + 1
                     break

-                file.body[i:i+1] = ['\\layout %s' % file.default_layout]
+                document.body[i:i+1] = ['\\layout %s' % document.default_layout]

                 i = i + 1
 
 
                 i = i + 1
 
 

-def revert_comment(file):
+def revert_comment(document):
+    " Revert comments"

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens(file.body, ["\\begin_inset Comment", "\\begin_inset Greyedout"], i)
+        i = find_tokens(document.body, ["\\begin_inset Comment", "\\begin_inset Greyedout"], i)

 
         if i == -1:
             return
 
         if i == -1:
             return

-        file.body[i] = "\\begin_inset Note"
+        document.body[i] = "\\begin_inset Note"

         i = i + 1
 
 
         i = i + 1
 
 

-##
-# Add \end_layout
-#
-def add_end_layout(file):
-    i = find_token(file.body, '\\layout', 0)
+def add_end_layout(document):
+    " Add \end_layout"
+    i = find_token(document.body, '\\layout', 0)

 
     if i == -1:
         return
 
     if i == -1:
         return


@@ -427,15 +419,15 @@ def add_end_layout(file):
     struct_stack = ["\\layout"]
 
     while 1:
     struct_stack = ["\\layout"]
 
     while 1:

-        i = find_tokens(file.body, ["\\begin_inset", "\\end_inset", "\\layout",
+        i = find_tokens(document.body, ["\\begin_inset", "\\end_inset", "\\layout",

                                 "\\begin_deeper", "\\end_deeper", "\\the_end"], i)
 
         if i != -1:
                                 "\\begin_deeper", "\\end_deeper", "\\the_end"], i)
 
         if i != -1:

-            token = split(file.body[i])[0]
+            token = split(document.body[i])[0]

         else:
         else:

-            file.warning("Truncated file.")
-            i = len(file.body)
-            file.body.insert(i, '\\the_end')
+            document.warning("Truncated document.")
+            i = len(document.body)
+            document.body.insert(i, '\\the_end')

             token = ""
 
         if token == "\\begin_inset":
             token = ""
 
         if token == "\\begin_inset":


@@ -446,8 +438,8 @@ def add_end_layout(file):
         if token == "\\end_inset":
             tail = struct_stack.pop()
             if tail == "\\layout":
         if token == "\\end_inset":
             tail = struct_stack.pop()
             if tail == "\\layout":

-                file.body.insert(i,"")
-                file.body.insert(i,"\\end_layout")
+                document.body.insert(i,"")
+                document.body.insert(i,"\\end_layout")

                 i = i + 2
                 #Check if it is the correct tag
                 struct_stack.pop()
                 i = i + 2
                 #Check if it is the correct tag
                 struct_stack.pop()


@@ -457,8 +449,8 @@ def add_end_layout(file):
         if token == "\\layout":
             tail = struct_stack.pop()
             if tail == token:
         if token == "\\layout":
             tail = struct_stack.pop()
             if tail == token:

-                file.body.insert(i,"")
-                file.body.insert(i,"\\end_layout")
+                document.body.insert(i,"")
+                document.body.insert(i,"\\end_layout")

                 i = i + 3
             else:
                 struct_stack.append(tail)
                 i = i + 3
             else:
                 struct_stack.append(tail)


@@ -467,192 +459,193 @@ def add_end_layout(file):
             continue
 
         if token == "\\begin_deeper":
             continue
 
         if token == "\\begin_deeper":

-            file.body.insert(i,"")
-            file.body.insert(i,"\\end_layout")
+            document.body.insert(i,"")
+            document.body.insert(i,"\\end_layout")

             i = i + 3
             struct_stack.append(token)
             continue
 
         if token == "\\end_deeper":
             if struct_stack[-1] == '\\layout':
             i = i + 3
             struct_stack.append(token)
             continue
 
         if token == "\\end_deeper":
             if struct_stack[-1] == '\\layout':

-                file.body.insert(i, '\\end_layout')
+                document.body.insert(i, '\\end_layout')

                 i = i + 1
                 struct_stack.pop()
             i = i + 1
             continue
 
         #case \end_document
                 i = i + 1
                 struct_stack.pop()
             i = i + 1
             continue
 
         #case \end_document

-        file.body.insert(i, "")
-        file.body.insert(i, "\\end_layout")
+        document.body.insert(i, "")
+        document.body.insert(i, "\\end_layout")

         return
 
 
         return
 
 

-def rm_end_layout(file):
+def rm_end_layout(document):
+    " Remove \end_layout"

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, '\\end_layout', i)
+        i = find_token(document.body, '\\end_layout', i)

 
         if i == -1:
             return
 
 
         if i == -1:
             return
 

-        del file.body[i]
+        del document.body[i]

 
 
 
 

-##
-# Handle change tracking keywords
-#
-def insert_tracking_changes(file):
-    i = find_token(file.header, "\\tracking_changes", 0)
+def insert_tracking_changes(document):
+    " Handle change tracking keywords."
+    i = find_token(document.header, "\\tracking_changes", 0)

     if i == -1:
     if i == -1:

-        file.header.append("\\tracking_changes 0")
+        document.header.append("\\tracking_changes 0")

 
 
 
 

-def rm_tracking_changes(file):
-    i = find_token(file.header, "\\author", 0)
+def rm_tracking_changes(document):
+    " Remove change tracking keywords."
+    i = find_token(document.header, "\\author", 0)

     if i != -1:
     if i != -1:

-        del file.header[i]
+        del document.header[i]

 
 

-    i = find_token(file.header, "\\tracking_changes", 0)
+    i = find_token(document.header, "\\tracking_changes", 0)

     if i == -1:
         return
     if i == -1:
         return

-    del file.header[i]
+    del document.header[i]

 
 
 
 

-def rm_body_changes(file):
+def rm_body_changes(document):
+    " Remove body changes."

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\change_", i)
+        i = find_token(document.body, "\\change_", i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        del file.body[i]
+        del document.body[i]

 
 
 
 

-##
-# \layout -> \begin_layout
-#
-def layout2begin_layout(file):
+def layout2begin_layout(document):
+    " \layout -> \begin_layout "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, '\\layout', i)
+        i = find_token(document.body, '\\layout', i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        file.body[i] = replace(file.body[i], '\\layout', '\\begin_layout')
+        document.body[i] = replace(document.body[i], '\\layout', '\\begin_layout')

         i = i + 1
 
 
         i = i + 1
 
 

-def begin_layout2layout(file):
+def begin_layout2layout(document):
+    " \begin_layout -> \layout "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_layout', i)
+        i = find_token(document.body, '\\begin_layout', i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        file.body[i] = replace(file.body[i], '\\begin_layout', '\\layout')
+        document.body[i] = replace(document.body[i], '\\begin_layout', '\\layout')

         i = i + 1
 
 
         i = i + 1
 
 

-##
-# valignment="center" -> valignment="middle"
-#

 def convert_valignment_middle(body, start, end):
 def convert_valignment_middle(body, start, end):

+    'valignment="center" -> valignment="middle"'

     for i in range(start, end):
         if re.search('^<(column|cell) .*valignment="center".*>$', body[i]):
             body[i] = replace(body[i], 'valignment="center"', 'valignment="middle"')
 
 
     for i in range(start, end):
         if re.search('^<(column|cell) .*valignment="center".*>$', body[i]):
             body[i] = replace(body[i], 'valignment="center"', 'valignment="middle"')
 
 

-def convert_table_valignment_middle(file):
+def convert_table_valignment_middle(document):
+    " Convert table  valignment, center -> middle"

     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     i = 0
     while 1:
     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     i = 0
     while 1:

-        i = find_re(file.body, regexp, i)
+        i = find_re(document.body, regexp, i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i + 1)
+        j = find_end_of_inset(document.body, i + 1)

         if j == -1:
             #this should not happen
         if j == -1:
             #this should not happen

-            convert_valignment_middle(file.body, i + 1, len(file.body))
+            convert_valignment_middle(document.body, i + 1, len(document.body))

             return
             return

-        convert_valignment_middle(file.body, i + 1, j)
+        convert_valignment_middle(document.body, i + 1, j)

         i = j + 1
 
 
 def revert_table_valignment_middle(body, start, end):
         i = j + 1
 
 
 def revert_table_valignment_middle(body, start, end):

+    " valignment, middle -> center"

     for i in range(start, end):
         if re.search('^<(column|cell) .*valignment="middle".*>$', body[i]):
             body[i] = replace(body[i], 'valignment="middle"', 'valignment="center"')
 
 
     for i in range(start, end):
         if re.search('^<(column|cell) .*valignment="middle".*>$', body[i]):
             body[i] = replace(body[i], 'valignment="middle"', 'valignment="center"')
 
 

-def revert_valignment_middle(file):
+def revert_valignment_middle(document):
+    " Convert table  valignment, middle -> center"

     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     i = 0
     while 1:
     regexp = re.compile(r'^\\begin_inset\s+Tabular')
     i = 0
     while 1:

-        i = find_re(file.body, regexp, i)
+        i = find_re(document.body, regexp, i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i + 1)
+        j = find_end_of_inset(document.body, i + 1)

         if j == -1:
             #this should not happen
         if j == -1:
             #this should not happen

-            revert_table_valignment_middle(file.body, i + 1, len(file.body))
+            revert_table_valignment_middle(document.body, i + 1, len(document.body))

             return
             return

-        revert_table_valignment_middle(file.body, i + 1, j)
+        revert_table_valignment_middle(document.body, i + 1, j)

         i = j + 1
 
 
         i = j + 1
 
 

-##
-#  \the_end -> \end_document
-#
-def convert_end_document(file):
-    i = find_token(file.body, "\\the_end", 0)
+def convert_end_document(document):
+    "\\the_end -> \\end_document"
+    i = find_token(document.body, "\\the_end", 0)

     if i == -1:
     if i == -1:

-        file.body.append("\\end_document")
+        document.body.append("\\end_document")

         return
         return

-    file.body[i] = "\\end_document"
+    document.body[i] = "\\end_document"

 
 
 
 

-def revert_end_document(file):
-    i = find_token(file.body, "\\end_document", 0)
+def revert_end_document(document):
+    "\\end_document -> \\the_end"
+    i = find_token(document.body, "\\end_document", 0)

     if i == -1:
     if i == -1:

-        file.body.append("\\the_end")
+        document.body.append("\\the_end")

         return
         return

-    file.body[i] = "\\the_end"
+    document.body[i] = "\\the_end"

 
 
 
 

-##
-# Convert line and page breaks
-# Old:
-#\layout Standard
-#\line_top \line_bottom \pagebreak_top \pagebreak_bottom \added_space_top xxx \added_space_bottom yyy
-#0
-#
-# New:
-#\begin layout Standard
-#
-#\newpage
-#
-#\lyxline
-#\begin_inset ERT
-#\begin layout Standard
-#\backslash
-#vspace{-1\backslash
-#parskip}
-#\end_layout
-#\end_inset
-#
-#\begin_inset VSpace xxx
-#\end_inset
-#
-#0
-#
-#\begin_inset VSpace xxx
-#\end_inset
-#\lyxline
-#
-#\newpage
-#
-#\end_layout
-def convert_breaks(file):
+def convert_breaks(document):
+    r"""
+Convert line and page breaks
+ Old:
+\layout Standard
+\line_top \line_bottom \pagebreak_top \pagebreak_bottom \added_space_top xxx \added_space_bottom yyy
+0
+
+ New:
+\begin layout Standard
+
+\newpage
+
+\lyxline
+\begin_inset ERT
+\begin layout Standard
+\backslash
+vspace{-1\backslash
+parskip}
+\end_layout
+\end_inset
+
+\begin_inset VSpace xxx
+\end_inset
+
+0
+
+\begin_inset VSpace xxx
+\end_inset
+\lyxline
+
+\newpage
+
+\end_layout
+    """

     par_params = ('added_space_bottom', 'added_space_top', 'align',
                  'labelwidthstring', 'line_bottom', 'line_top', 'noindent',
                  'pagebreak_bottom', 'pagebreak_top', 'paragraph_spacing',
     par_params = ('added_space_bottom', 'added_space_top', 'align',
                  'labelwidthstring', 'line_bottom', 'line_top', 'noindent',
                  'pagebreak_bottom', 'pagebreak_top', 'paragraph_spacing',


@@ -660,28 +653,28 @@ def convert_breaks(file):
     font_attributes = ['\\family', '\\series', '\\shape', '\\emph',
                        '\\numeric', '\\bar', '\\noun', '\\color', '\\lang']
     attribute_values = ['default', 'default', 'default', 'default',
     font_attributes = ['\\family', '\\series', '\\shape', '\\emph',
                        '\\numeric', '\\bar', '\\noun', '\\color', '\\lang']
     attribute_values = ['default', 'default', 'default', 'default',

-                        'default', 'default', 'default', 'none', file.language]
+                        'default', 'default', 'default', 'none', document.language]

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_layout", i)
+        i = find_token(document.body, "\\begin_layout", i)

         if i == -1:
             return
         if i == -1:
             return

-        layout = get_layout(file.body[i], file.default_layout)
+        layout = get_layout(document.body[i], document.default_layout)

         i = i + 1
 
         # Merge all paragraph parameters into a single line
         # We cannot check for '\\' only because paragraphs may start e.g.
         # with '\\backslash'
         i = i + 1
 
         # Merge all paragraph parameters into a single line
         # We cannot check for '\\' only because paragraphs may start e.g.
         # with '\\backslash'

-        while file.body[i + 1][:1] == '\\' and split(file.body[i + 1][1:])[0] in par_params:
-            file.body[i] = file.body[i + 1] + ' ' + file.body[i]
-            del file.body[i+1]
+        while document.body[i + 1][:1] == '\\' and split(document.body[i + 1][1:])[0] in par_params:
+            document.body[i] = document.body[i + 1] + ' ' + document.body[i]
+            del document.body[i+1]

 
 

-        line_top   = find(file.body[i],"\\line_top")
-        line_bot   = find(file.body[i],"\\line_bottom")
-        pb_top     = find(file.body[i],"\\pagebreak_top")
-        pb_bot     = find(file.body[i],"\\pagebreak_bottom")
-        vspace_top = find(file.body[i],"\\added_space_top")
-        vspace_bot = find(file.body[i],"\\added_space_bottom")
+        line_top   = find(document.body[i],"\\line_top")
+        line_bot   = find(document.body[i],"\\line_bottom")
+        pb_top     = find(document.body[i],"\\pagebreak_top")
+        pb_bot     = find(document.body[i],"\\pagebreak_bottom")
+        vspace_top = find(document.body[i],"\\added_space_top")
+        vspace_bot = find(document.body[i],"\\added_space_bottom")

 
         if line_top == -1 and line_bot == -1 and pb_bot == -1 and pb_top == -1 and vspace_top == -1 and vspace_bot == -1:
             continue
 
         if line_top == -1 and line_bot == -1 and pb_bot == -1 and pb_top == -1 and vspace_top == -1 and vspace_bot == -1:
             continue


@@ -693,41 +686,41 @@ def convert_breaks(file):
         # We want to avoid new paragraphs if possible becauase we want to
         # inherit font sizes.
         nonstandard = 0
         # We want to avoid new paragraphs if possible becauase we want to
         # inherit font sizes.
         nonstandard = 0

-        if (not file.is_default_layout(layout) or
-            find(file.body[i],"\\align") != -1 or
-            find(file.body[i],"\\labelwidthstring") != -1 or
-            find(file.body[i],"\\noindent") != -1):
+        if (not document.is_default_layout(layout) or
+            find(document.body[i],"\\align") != -1 or
+            find(document.body[i],"\\labelwidthstring") != -1 or
+            find(document.body[i],"\\noindent") != -1):

             nonstandard = 1
 
         # get the font size of the beginning of this paragraph, since we need
         # it for the lyxline inset
         j = i + 1
             nonstandard = 1
 
         # get the font size of the beginning of this paragraph, since we need
         # it for the lyxline inset
         j = i + 1

-        while not is_nonempty_line(file.body[j]):
+        while not is_nonempty_line(document.body[j]):

             j = j + 1
         size_top = ""
             j = j + 1
         size_top = ""

-        if find(file.body[j], "\\size") != -1:
-            size_top = split(file.body[j])[1]
+        if find(document.body[j], "\\size") != -1:
+            size_top = split(document.body[j])[1]

 
         for tag in "\\line_top", "\\line_bottom", "\\pagebreak_top", "\\pagebreak_bottom":
 
         for tag in "\\line_top", "\\line_bottom", "\\pagebreak_top", "\\pagebreak_bottom":

-            file.body[i] = replace(file.body[i], tag, "")
+            document.body[i] = replace(document.body[i], tag, "")

 
         if vspace_top != -1:
             # the position could be change because of the removal of other
             # paragraph properties above
 
         if vspace_top != -1:
             # the position could be change because of the removal of other
             # paragraph properties above

-            vspace_top = find(file.body[i],"\\added_space_top")
-            tmp_list = split(file.body[i][vspace_top:])
+            vspace_top = find(document.body[i],"\\added_space_top")
+            tmp_list = split(document.body[i][vspace_top:])

             vspace_top_value = tmp_list[1]
             vspace_top_value = tmp_list[1]

-            file.body[i] = file.body[i][:vspace_top] + join(tmp_list[2:])
+            document.body[i] = document.body[i][:vspace_top] + join(tmp_list[2:])

 
         if vspace_bot != -1:
             # the position could be change because of the removal of other
             # paragraph properties above
 
         if vspace_bot != -1:
             # the position could be change because of the removal of other
             # paragraph properties above

-            vspace_bot = find(file.body[i],"\\added_space_bottom")
-            tmp_list = split(file.body[i][vspace_bot:])
+            vspace_bot = find(document.body[i],"\\added_space_bottom")
+            tmp_list = split(document.body[i][vspace_bot:])

             vspace_bot_value = tmp_list[1]
             vspace_bot_value = tmp_list[1]

-            file.body[i] = file.body[i][:vspace_bot] + join(tmp_list[2:])
+            document.body[i] = document.body[i][:vspace_bot] + join(tmp_list[2:])

 
 

-        file.body[i] = strip(file.body[i])
+        document.body[i] = strip(document.body[i])

         i = i + 1
 
         # Create an empty paragraph or paragraph fragment for line and
         i = i + 1
 
         # Create an empty paragraph or paragraph fragment for line and


@@ -737,7 +730,7 @@ def convert_breaks(file):
             paragraph_above = list()
             if nonstandard:
                 # We need to create an extra paragraph for nonstandard environments
             paragraph_above = list()
             if nonstandard:
                 # We need to create an extra paragraph for nonstandard environments

-                paragraph_above = ['\\begin_layout %s' % file.default_layout, '']
+                paragraph_above = ['\\begin_layout %s' % document.default_layout, '']

 
             if pb_top != -1:
                 paragraph_above.extend(['\\newpage ',''])
 
             if pb_top != -1:
                 paragraph_above.extend(['\\newpage ',''])


@@ -752,21 +745,21 @@ def convert_breaks(file):
                 # We can't use the vspace inset because it does not know \parskip.
                 paragraph_above.extend(['\\lyxline ', '', ''])
                 insert_ert(paragraph_above, len(paragraph_above) - 1, 'Collapsed',
                 # We can't use the vspace inset because it does not know \parskip.
                 paragraph_above.extend(['\\lyxline ', '', ''])
                 insert_ert(paragraph_above, len(paragraph_above) - 1, 'Collapsed',

-                           '\\vspace{-1\\parskip}\n', file.format + 1, file.default_layout)
+                           '\\vspace{-1\\parskip}\n', document.format + 1, document.default_layout)

                 paragraph_above.extend([''])
 
             if nonstandard:
                 paragraph_above.extend(['\\end_layout ',''])
                 # insert new paragraph above the current paragraph
                 paragraph_above.extend([''])
 
             if nonstandard:
                 paragraph_above.extend(['\\end_layout ',''])
                 # insert new paragraph above the current paragraph

-                file.body[i-2:i-2] = paragraph_above
+                document.body[i-2:i-2] = paragraph_above

             else:
                 # insert new lines at the beginning of the current paragraph
             else:
                 # insert new lines at the beginning of the current paragraph

-                file.body[i:i] = paragraph_above
+                document.body[i:i] = paragraph_above

 
             i = i + len(paragraph_above)
 
         # Ensure that nested style are converted later.
 
             i = i + len(paragraph_above)
 
         # Ensure that nested style are converted later.

-        k = find_end_of(file.body, i, "\\begin_layout", "\\end_layout")
+        k = find_end_of(document.body, i, "\\begin_layout", "\\end_layout")

 
         if k == -1:
             return
 
         if k == -1:
             return


@@ -777,22 +770,22 @@ def convert_breaks(file):
             size_bot = size_top
             j = i + 1
             while j < k:
             size_bot = size_top
             j = i + 1
             while j < k:

-                if find(file.body[j], "\\size") != -1:
-                    size_bot = split(file.body[j])[1]
+                if find(document.body[j], "\\size") != -1:
+                    size_bot = split(document.body[j])[1]

                     j = j + 1
                     j = j + 1

-                elif find(file.body[j], "\\begin_inset") != -1:
+                elif find(document.body[j], "\\begin_inset") != -1:

                     # skip insets
                     # skip insets

-                    j = find_end_of_inset(file.body, j)
+                    j = find_end_of_inset(document.body, j)

                 else:
                     j = j + 1
 
             paragraph_below = list()
             if nonstandard:
                 # We need to create an extra paragraph for nonstandard environments
                 else:
                     j = j + 1
 
             paragraph_below = list()
             if nonstandard:
                 # We need to create an extra paragraph for nonstandard environments

-                paragraph_below = ['', '\\begin_layout %s' % file.default_layout, '']
+                paragraph_below = ['', '\\begin_layout %s' % document.default_layout, '']

             else:
                 for a in range(len(font_attributes)):
             else:
                 for a in range(len(font_attributes)):

-                    if find_token(file.body, font_attributes[a], i, k) != -1:
+                    if find_token(document.body, font_attributes[a], i, k) != -1:

                         paragraph_below.extend([font_attributes[a] + ' ' + attribute_values[a]])
 
             if line_bot != -1:
                         paragraph_below.extend([font_attributes[a] + ' ' + attribute_values[a]])
 
             if line_bot != -1:


@@ -811,47 +804,44 @@ def convert_breaks(file):
             if nonstandard:
                 paragraph_below.extend(['\\end_layout '])
                 # insert new paragraph below the current paragraph
             if nonstandard:
                 paragraph_below.extend(['\\end_layout '])
                 # insert new paragraph below the current paragraph

-                file.body[k+1:k+1] = paragraph_below
+                document.body[k+1:k+1] = paragraph_below

             else:
                 # insert new lines at the end of the current paragraph
             else:
                 # insert new lines at the end of the current paragraph

-                file.body[k:k] = paragraph_below
+                document.body[k:k] = paragraph_below

 
 
 
 

-##
-#  Notes
-#
-def convert_note(file):
+def convert_note(document):
+    " Convert Notes. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens(file.body, ["\\begin_inset Note",
+        i = find_tokens(document.body, ["\\begin_inset Note",

                                 "\\begin_inset Comment",
                                 "\\begin_inset Greyedout"], i)
         if i == -1:
             break
 
                                 "\\begin_inset Comment",
                                 "\\begin_inset Greyedout"], i)
         if i == -1:
             break
 

-        file.body[i] = file.body[i][0:13] + 'Note ' + file.body[i][13:]
+        document.body[i] = document.body[i][0:13] + 'Note ' + document.body[i][13:]

         i = i + 1
 
 
         i = i + 1
 
 

-def revert_note(file):
+def revert_note(document):
+    " Revert Notes. "

     note_header = "\\begin_inset Note "
     i = 0
     while 1:
     note_header = "\\begin_inset Note "
     i = 0
     while 1:

-        i = find_token(file.body, note_header, i)
+        i = find_token(document.body, note_header, i)

         if i == -1:
             break
 
         if i == -1:
             break
 

-        file.body[i] = "\\begin_inset " + file.body[i][len(note_header):]
+        document.body[i] = "\\begin_inset " + document.body[i][len(note_header):]

         i = i + 1
 
 
         i = i + 1
 
 

-##
-# Box
-#
-def convert_box(file):
+def convert_box(document):
+    " Convert Boxes. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens(file.body, ["\\begin_inset Boxed",
+        i = find_tokens(document.body, ["\\begin_inset Boxed",

                                 "\\begin_inset Doublebox",
                                 "\\begin_inset Frameless",
                                 "\\begin_inset ovalbox",
                                 "\\begin_inset Doublebox",
                                 "\\begin_inset Frameless",
                                 "\\begin_inset ovalbox",


@@ -860,29 +850,28 @@ def convert_box(file):
         if i == -1:
             break
 
         if i == -1:
             break
 

-        file.body[i] = file.body[i][0:13] + 'Box ' + file.body[i][13:]
+        document.body[i] = document.body[i][0:13] + 'Box ' + document.body[i][13:]

         i = i + 1
 
 
         i = i + 1
 
 

-def revert_box(file):
+def revert_box(document):
+    " Revert Boxes."

     box_header = "\\begin_inset Box "
     i = 0
     while 1:
     box_header = "\\begin_inset Box "
     i = 0
     while 1:

-        i = find_token(file.body, box_header, i)
+        i = find_token(document.body, box_header, i)

         if i == -1:
             break
 
         if i == -1:
             break
 

-        file.body[i] = "\\begin_inset " + file.body[i][len(box_header):]
+        document.body[i] = "\\begin_inset " + document.body[i][len(box_header):]

         i = i + 1
 
 
         i = i + 1
 
 

-##
-# Collapse
-#
-def convert_collapsable(file):
+def convert_collapsable(document):
+    " Convert collapsed insets. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens_exact(file.body, ["\\begin_inset Box",
+        i = find_tokens_exact(document.body, ["\\begin_inset Box",

                                 "\\begin_inset Branch",
                                 "\\begin_inset CharStyle",
                                 "\\begin_inset Float",
                                 "\\begin_inset Branch",
                                 "\\begin_inset CharStyle",
                                 "\\begin_inset Float",


@@ -899,24 +888,25 @@ def convert_collapsable(file):
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:

-            if (file.body[i] == "collapsed false"):
-                file.body[i] = "status open"
+            if (document.body[i] == "collapsed false"):
+                document.body[i] = "status open"

                 break
                 break

-            elif (file.body[i] == "collapsed true"):
-                file.body[i] = "status collapsed"
+            elif (document.body[i] == "collapsed true"):
+                document.body[i] = "status collapsed"

                 break
                 break

-            elif (file.body[i][:13] == "\\begin_layout"):
-                file.warning("Malformed LyX file: Missing 'collapsed'.")
+            elif (document.body[i][:13] == "\\begin_layout"):
+                document.warning("Malformed LyX document: Missing 'collapsed'.")

                 break
             i = i + 1
 
         i = i + 1
 
 
                 break
             i = i + 1
 
         i = i + 1
 
 

-def revert_collapsable(file):
+def revert_collapsable(document):
+    " Revert collapsed insets. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens_exact(file.body, ["\\begin_inset Box",
+        i = find_tokens_exact(document.body, ["\\begin_inset Box",

                                 "\\begin_inset Branch",
                                 "\\begin_inset CharStyle",
                                 "\\begin_inset Float",
                                 "\\begin_inset Branch",
                                 "\\begin_inset CharStyle",
                                 "\\begin_inset Float",


@@ -933,28 +923,26 @@ def revert_collapsable(file):
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:

-            if (file.body[i] == "status open"):
-                file.body[i] = "collapsed false"
+            if (document.body[i] == "status open"):
+                document.body[i] = "collapsed false"

                 break
                 break

-            elif (file.body[i] == "status collapsed" or
-                  file.body[i] == "status inlined"):
-                file.body[i] = "collapsed true"
+            elif (document.body[i] == "status collapsed" or
+                  document.body[i] == "status inlined"):
+                document.body[i] = "collapsed true"

                 break
                 break

-            elif (file.body[i][:13] == "\\begin_layout"):
-                file.warning("Malformed LyX file: Missing 'status'.")
+            elif (document.body[i][:13] == "\\begin_layout"):
+                document.warning("Malformed LyX document: Missing 'status'.")

                 break
             i = i + 1
 
         i = i + 1
 
 
                 break
             i = i + 1
 
         i = i + 1
 
 

-##
-#  ERT
-#
-def convert_ert(file):
+def convert_ert(document):
+    " Convert ERT. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset ERT", i)
+        i = find_token(document.body, "\\begin_inset ERT", i)

         if i == -1:
             break
 
         if i == -1:
             break
 


@@ -963,27 +951,28 @@ def convert_ert(file):
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:

-            if (file.body[i] == "status Open"):
-                file.body[i] = "status open"
+            if (document.body[i] == "status Open"):
+                document.body[i] = "status open"

                 break
                 break

-            elif (file.body[i] == "status Collapsed"):
-                file.body[i] = "status collapsed"
+            elif (document.body[i] == "status Collapsed"):
+                document.body[i] = "status collapsed"

                 break
                 break

-            elif (file.body[i] == "status Inlined"):
-                file.body[i] = "status inlined"
+            elif (document.body[i] == "status Inlined"):
+                document.body[i] = "status inlined"

                 break
                 break

-            elif (file.body[i][:13] == "\\begin_layout"):
-                file.warning("Malformed LyX file: Missing 'status'.")
+            elif (document.body[i][:13] == "\\begin_layout"):
+                document.warning("Malformed LyX document: Missing 'status'.")

                 break
             i = i + 1
 
         i = i + 1
 
 
                 break
             i = i + 1
 
         i = i + 1
 
 

-def revert_ert(file):
+def revert_ert(document):
+    " Revert ERT. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset ERT", i)
+        i = find_token(document.body, "\\begin_inset ERT", i)

         if i == -1:
             break
 
         if i == -1:
             break
 


@@ -992,27 +981,24 @@ def revert_ert(file):
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:

-            if (file.body[i] == "status open"):
-                file.body[i] = "status Open"
+            if (document.body[i] == "status open"):
+                document.body[i] = "status Open"

                 break
                 break

-            elif (file.body[i] == "status collapsed"):
-                file.body[i] = "status Collapsed"
+            elif (document.body[i] == "status collapsed"):
+                document.body[i] = "status Collapsed"

                 break
                 break

-            elif (file.body[i] == "status inlined"):
-                file.body[i] = "status Inlined"
+            elif (document.body[i] == "status inlined"):
+                document.body[i] = "status Inlined"

                 break
                 break

-            elif (file.body[i][:13] == "\\begin_layout"):
-                file.warning("Malformed LyX file : Missing 'status'.")
+            elif (document.body[i][:13] == "\\begin_layout"):
+                document.warning("Malformed LyX document : Missing 'status'.")

                 break
             i = i + 1
 
         i = i + 1
 
 
                 break
             i = i + 1
 
         i = i + 1
 
 

-##
-# Minipages
-#
-def convert_minipage(file):
+def convert_minipage(document):

     """ Convert minipages to the box inset.
     We try to use the same order of arguments as lyx does.
     """
     """ Convert minipages to the box inset.
     We try to use the same order of arguments as lyx does.
     """


@@ -1021,55 +1007,55 @@ def convert_minipage(file):
 
     i = 0
     while 1:
 
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset Minipage", i)
+        i = find_token(document.body, "\\begin_inset Minipage", i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        file.body[i] = "\\begin_inset Box Frameless"
+        document.body[i] = "\\begin_inset Box Frameless"

         i = i + 1
 
         # convert old to new position using the pos list
         i = i + 1
 
         # convert old to new position using the pos list

-        if file.body[i][:8] == "position":
-            file.body[i] = 'position "%s"' % pos[int(file.body[i][9])]
+        if document.body[i][:8] == "position":
+            document.body[i] = 'position "%s"' % pos[int(document.body[i][9])]

         else:
         else:

-            file.body.insert(i, 'position "%s"' % pos[0])
+            document.body.insert(i, 'position "%s"' % pos[0])

         i = i + 1
 
         i = i + 1
 

-        file.body.insert(i, 'hor_pos "c"')
+        document.body.insert(i, 'hor_pos "c"')

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'has_inner_box 1')
+        document.body.insert(i, 'has_inner_box 1')

         i = i + 1
 
         # convert the inner_position
         i = i + 1
 
         # convert the inner_position

-        if file.body[i][:14] == "inner_position":
-            innerpos = inner_pos[int(file.body[i][15])]
-            del file.body[i]    
+        if document.body[i][:14] == "inner_position":
+            innerpos = inner_pos[int(document.body[i][15])]
+            del document.body[i]    

         else:
             innerpos = inner_pos[0]
 
         # We need this since the new file format has a height and width
         # in a different order.
         else:
             innerpos = inner_pos[0]
 
         # We need this since the new file format has a height and width
         # in a different order.

-        if file.body[i][:6] == "height":
-            height = file.body[i][6:]
+        if document.body[i][:6] == "height":
+            height = document.body[i][6:]

             # test for default value of 221 and convert it accordingly
             if height == ' "0pt"' or height == ' "0"':
                 height = ' "1pt"'
             # test for default value of 221 and convert it accordingly
             if height == ' "0pt"' or height == ' "0"':
                 height = ' "1pt"'

-            del file.body[i]
+            del document.body[i]

         else:
             height = ' "1pt"'
 
         else:
             height = ' "1pt"'
 

-        if file.body[i][:5] == "width":
-            width = file.body[i][5:]
-            del file.body[i]
+        if document.body[i][:5] == "width":
+            width = document.body[i][5:]
+            del document.body[i]

         else:
             width = ' "0"'
 
         else:
             width = ' "0"'
 

-        if file.body[i][:9] == "collapsed":
-            if file.body[i][9:] == "true":
+        if document.body[i][:9] == "collapsed":
+            if document.body[i][9:] == "true":

                 status = "collapsed"
             else:
                 status = "open"
                 status = "collapsed"
             else:
                 status = "open"

-            del file.body[i]
+            del document.body[i]

         else:
             status = "collapsed"
 
         else:
             status = "collapsed"
 


@@ -1077,26 +1063,27 @@ def convert_minipage(file):
         if height == ' "1pt"' and innerpos == 'c':
             innerpos = 't'
 
         if height == ' "1pt"' and innerpos == 'c':
             innerpos = 't'
 

-        file.body.insert(i, 'inner_pos "' + innerpos + '"')
+        document.body.insert(i, 'inner_pos "' + innerpos + '"')

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'use_parbox 0')
+        document.body.insert(i, 'use_parbox 0')

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'width' + width)
+        document.body.insert(i, 'width' + width)

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'special "none"')
+        document.body.insert(i, 'special "none"')

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'height' + height)
+        document.body.insert(i, 'height' + height)

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'height_special "totalheight"')
+        document.body.insert(i, 'height_special "totalheight"')

         i = i + 1
         i = i + 1

-        file.body.insert(i, 'status ' + status)
+        document.body.insert(i, 'status ' + status)

         i = i + 1
 
 
         i = i + 1
 
 

-# -------------------------------------------------------------------------------------------
-# Convert backslashes and '\n' into valid ERT code, append the converted
-# text to body[i] and return the (maybe incremented) line index i

 def convert_ertbackslash(body, i, ert, format, default_layout):
 def convert_ertbackslash(body, i, ert, format, default_layout):

+    r""" -------------------------------------------------------------------------------------------
+    Convert backslashes and '\n' into valid ERT code, append the converted
+    text to body[i] and return the (maybe incremented) line index i"""
+

     for c in ert:
         if c == '\\':
             body[i] = body[i] + '\\backslash '
     for c in ert:
         if c == '\\':
             body[i] = body[i] + '\\backslash '


@@ -1114,9 +1101,10 @@ def convert_ertbackslash(body, i, ert, format, default_layout):
     return i
 
 
     return i
 
 

-# Converts lines in ERT code to LaTeX
-# The surrounding \begin_layout ... \end_layout pair must not be included

 def ert2latex(lines, format):
 def ert2latex(lines, format):

+    r""" Converts lines in ERT code to LaTeX
+    The surrounding \begin_layout ... \end_layout pair must not be included"""
+

     backslash = re.compile(r'\\backslash\s*$')
     newline = re.compile(r'\\newline\s*$')
     if format <= 224:
     backslash = re.compile(r'\\backslash\s*$')
     newline = re.compile(r'\\newline\s*$')
     if format <= 224:


@@ -1141,9 +1129,9 @@ def ert2latex(lines, format):
     return ert
 
 
     return ert
 
 

-# get all paragraph parameters. They can be all on one line or on several lines.
-# lines[i] must be the first parameter line

 def get_par_params(lines, i):
 def get_par_params(lines, i):

+    """ get all paragraph parameters. They can be all on one line or on several lines.
+    lines[i] must be the first parameter line"""

     par_params = ('added_space_bottom', 'added_space_top', 'align',
                  'labelwidthstring', 'line_bottom', 'line_top', 'noindent',
                  'pagebreak_bottom', 'pagebreak_top', 'paragraph_spacing',
     par_params = ('added_space_bottom', 'added_space_top', 'align',
                  'labelwidthstring', 'line_bottom', 'line_top', 'noindent',
                  'pagebreak_bottom', 'pagebreak_top', 'paragraph_spacing',


@@ -1157,8 +1145,8 @@ def get_par_params(lines, i):
     return strip(params)
 
 
     return strip(params)
 
 

-# convert LyX font size to LaTeX fontsize

 def lyxsize2latexsize(lyxsize):
 def lyxsize2latexsize(lyxsize):

+    " Convert LyX font size to LaTeX fontsize. "

     sizes = {"tiny" : "tiny", "scriptsize" : "scriptsize",
              "footnotesize" : "footnotesize", "small" : "small",
              "normal" : "normalsize", "large" : "large", "larger" : "Large",
     sizes = {"tiny" : "tiny", "scriptsize" : "scriptsize",
              "footnotesize" : "footnotesize", "small" : "small",
              "normal" : "normalsize", "large" : "large", "larger" : "Large",


@@ -1168,16 +1156,16 @@ def lyxsize2latexsize(lyxsize):
     return ''
 
 
     return ''
 
 

-# Change vspace insets, page breaks and lyxlines to paragraph options
-# (if possible) or ERT
-def revert_breaks(file):
+def revert_breaks(document):
+    """ Change vspace insets, page breaks and lyxlines to paragraph options
+    (if possible) or ERT"""

 
     # Get default spaceamount
 
     # Get default spaceamount

-    i = find_token(file.header, '\\defskip', 0)
+    i = find_token(document.header, '\\defskip', 0)

     if i == -1:
         defskipamount = 'medskip'
     else:
     if i == -1:
         defskipamount = 'medskip'
     else:

-        defskipamount = split(file.header[i])[1]
+        defskipamount = split(document.header[i])[1]

 
     keys = {"\\begin_inset" : "vspace", "\\lyxline" : "lyxline",
             "\\newpage" : "newpage"}
 
     keys = {"\\begin_inset" : "vspace", "\\lyxline" : "lyxline",
             "\\newpage" : "newpage"}


@@ -1190,31 +1178,31 @@ def revert_breaks(file):
     # Convert the insets
     i = 0
     while 1:
     # Convert the insets
     i = 0
     while 1:

-        i = find_tokens(file.body, tokens, i)
+        i = find_tokens(document.body, tokens, i)

         if i == -1:
             return
 
         # Are we at the beginning of a paragraph?
         paragraph_start = 1
         if i == -1:
             return
 
         # Are we at the beginning of a paragraph?
         paragraph_start = 1

-        this_par = get_paragraph(file.body, i, file.format - 1)
+        this_par = get_paragraph(document.body, i, document.format - 1)

         start = this_par + 1
         start = this_par + 1

-        params = get_par_params(file.body, start)
+        params = get_par_params(document.body, start)

         size = "normal"
         # Paragraph parameters may be on one or more lines.
         # Find the start of the real paragraph text.
         size = "normal"
         # Paragraph parameters may be on one or more lines.
         # Find the start of the real paragraph text.

-        while file.body[start][:1] == '\\' and split(file.body[start])[0] in params:
+        while document.body[start][:1] == '\\' and split(document.body[start])[0] in params:

             start = start + 1
         for k in range(start, i):
             start = start + 1
         for k in range(start, i):

-            if find(file.body[k], "\\size") != -1:
+            if find(document.body[k], "\\size") != -1:

                 # store font size
                 # store font size

-                size = split(file.body[k])[1]
-            elif is_nonempty_line(file.body[k]):
+                size = split(document.body[k])[1]
+            elif is_nonempty_line(document.body[k]):

                 paragraph_start = 0
                 break
         # Find the end of the real paragraph text.
                 paragraph_start = 0
                 break
         # Find the end of the real paragraph text.

-        next_par = get_next_paragraph(file.body, i, file.format - 1)
+        next_par = get_next_paragraph(document.body, i, document.format - 1)

         if next_par == -1:
         if next_par == -1:

-            file.warning("Malformed LyX file: Missing next paragraph.")
+            document.warning("Malformed LyX document: Missing next paragraph.")

             i = i + 1
             continue
 
             i = i + 1
             continue
 


@@ -1239,28 +1227,28 @@ def revert_breaks(file):
         n = 0
         k = inset_start
         while k < next_par:
         n = 0
         k = inset_start
         while k < next_par:

-            if find_tokens(file.body, tokens, k) == k:
+            if find_tokens(document.body, tokens, k) == k:

                 # inset to convert
                 # inset to convert

-                lines.append(split(file.body[k]))
+                lines.append(split(document.body[k]))

                 insets.append(keys[lines[n][0]])
                 del_lines.append([k, k])
                 top.append(0)
                 sizes.append(size)
                 n = n + 1
                 inset_end = k
                 insets.append(keys[lines[n][0]])
                 del_lines.append([k, k])
                 top.append(0)
                 sizes.append(size)
                 n = n + 1
                 inset_end = k

-            elif find(file.body[k], "\\size") != -1:
+            elif find(document.body[k], "\\size") != -1:

                 # store font size
                 # store font size

-                size = split(file.body[k])[1]
-            elif find_token(file.body, "\\begin_inset ERT", k) == k:
-                ert_begin = find_token(file.body, "\\layout", k) + 1
+                size = split(document.body[k])[1]
+            elif find_token(document.body, "\\begin_inset ERT", k) == k:
+                ert_begin = find_token(document.body, "\\layout", k) + 1

                 if ert_begin == 0:
                 if ert_begin == 0:

-                    file.warning("Malformed LyX file: Missing '\\layout'.")
+                    document.warning("Malformed LyX document: Missing '\\layout'.")

                     continue
                     continue

-                ert_end = find_end_of_inset(file.body, k)
+                ert_end = find_end_of_inset(document.body, k)

                 if ert_end == -1:
                 if ert_end == -1:

-                    file.warning("Malformed LyX file: Missing '\\end_inset'.")
+                    document.warning("Malformed LyX document: Missing '\\end_inset'.")

                     continue
                     continue

-                ert = ert2latex(file.body[ert_begin:ert_end], file.format - 1)
+                ert = ert2latex(document.body[ert_begin:ert_end], document.format - 1)

                 if (n > 0 and insets[n - 1] == "lyxline" and
                     ert == '\\vspace{-1\\parskip}\n'):
                     # vspace ERT created by convert_breaks() for top lyxline
                 if (n > 0 and insets[n - 1] == "lyxline" and
                     ert == '\\vspace{-1\\parskip}\n'):
                     # vspace ERT created by convert_breaks() for top lyxline


@@ -1272,11 +1260,11 @@ def revert_breaks(file):
                     paragraph_end = 0
                     break
             elif (n > 0 and insets[n - 1] == "vspace" and
                     paragraph_end = 0
                     break
             elif (n > 0 and insets[n - 1] == "vspace" and

-                  find_token(file.body, "\\end_inset", k) == k):
+                  find_token(document.body, "\\end_inset", k) == k):

                 # ignore end of vspace inset
                 del_lines[n - 1][1] = k
                 inset_end = k
                 # ignore end of vspace inset
                 del_lines[n - 1][1] = k
                 inset_end = k

-            elif is_nonempty_line(file.body[k]):
+            elif is_nonempty_line(document.body[k]):

                 paragraph_end = 0
                 break
             k = k + 1
                 paragraph_end = 0
                 break
             k = k + 1


@@ -1325,23 +1313,23 @@ def revert_breaks(file):
                 # First try to merge with the previous paragraph.
                 # We try the previous paragraph first because we would
                 # otherwise need ERT for two subsequent vspaces.
                 # First try to merge with the previous paragraph.
                 # We try the previous paragraph first because we would
                 # otherwise need ERT for two subsequent vspaces.

-                prev_par = get_paragraph(file.body, this_par - 1, file.format - 1) + 1
+                prev_par = get_paragraph(document.body, this_par - 1, document.format - 1) + 1

                 if prev_par > 0 and not before:
                 if prev_par > 0 and not before:

-                    prev_params = get_par_params(file.body, prev_par + 1)
+                    prev_params = get_par_params(document.body, prev_par + 1)

                     ert = 0
                     # determine font size
                     prev_size = "normal"
                     k = prev_par + 1
                     ert = 0
                     # determine font size
                     prev_size = "normal"
                     k = prev_par + 1

-                    while file.body[k][:1] == '\\' and split(file.body[k])[0] in prev_params:
+                    while document.body[k][:1] == '\\' and split(document.body[k])[0] in prev_params:

                         k = k + 1
                     while k < this_par:
                         k = k + 1
                     while k < this_par:

-                        if find(file.body[k], "\\size") != -1:
-                            prev_size = split(file.body[k])[1]
+                        if find(document.body[k], "\\size") != -1:
+                            prev_size = split(document.body[k])[1]

                             break
                             break

-                        elif find(file.body[k], "\\begin_inset") != -1:
+                        elif find(document.body[k], "\\begin_inset") != -1:

                             # skip insets
                             # skip insets

-                            k = find_end_of_inset(file.body, k)
-                        elif is_nonempty_line(file.body[k]):
+                            k = find_end_of_inset(document.body, k)
+                        elif is_nonempty_line(document.body[k]):

                             break
                         k = k + 1
                     for k in range(n):
                             break
                         k = k + 1
                     for k in range(n):


@@ -1351,25 +1339,25 @@ def revert_breaks(file):
                             break
                     if not ert:
                         for k in range(n):
                             break
                     if not ert:
                         for k in range(n):

-                            file.body.insert(prev_par + 1,
+                            document.body.insert(prev_par + 1,

                                              keywords_bot[insets[k]] + arguments[k])
                                              keywords_bot[insets[k]] + arguments[k])

-                        del file.body[this_par+n:next_par-1+n]
+                        del document.body[this_par+n:next_par-1+n]

                         i = this_par + n
                         continue
                 # Then try next paragraph
                 if next_par > 0 and not after:
                         i = this_par + n
                         continue
                 # Then try next paragraph
                 if next_par > 0 and not after:

-                    next_params = get_par_params(file.body, next_par + 1)
+                    next_params = get_par_params(document.body, next_par + 1)

                     ert = 0
                     ert = 0

-                    while file.body[k][:1] == '\\' and split(file.body[k])[0] in next_params:
+                    while document.body[k][:1] == '\\' and split(document.body[k])[0] in next_params:

                         k = k + 1
                     # determine font size
                     next_size = "normal"
                     k = next_par + 1
                     while k < this_par:
                         k = k + 1
                     # determine font size
                     next_size = "normal"
                     k = next_par + 1
                     while k < this_par:

-                        if find(file.body[k], "\\size") != -1:
-                            next_size = split(file.body[k])[1]
+                        if find(document.body[k], "\\size") != -1:
+                            next_size = split(document.body[k])[1]

                             break
                             break

-                        elif is_nonempty_line(file.body[k]):
+                        elif is_nonempty_line(document.body[k]):

                             break
                         k = k + 1
                     for k in range(n):
                             break
                         k = k + 1
                     for k in range(n):


@@ -1379,9 +1367,9 @@ def revert_breaks(file):
                             break
                     if not ert:
                         for k in range(n):
                             break
                     if not ert:
                         for k in range(n):

-                            file.body.insert(next_par + 1,
+                            document.body.insert(next_par + 1,

                                              keywords_top[insets[k]] + arguments[k])
                                              keywords_top[insets[k]] + arguments[k])

-                        del file.body[this_par:next_par-1]
+                        del document.body[this_par:next_par-1]

                         i = this_par
                         continue
         elif paragraph_start or paragraph_end:
                         i = this_par
                         continue
         elif paragraph_start or paragraph_end:


@@ -1399,12 +1387,12 @@ def revert_breaks(file):
                     break
             if not ert:
                 for k in range(n):
                     break
             if not ert:
                 for k in range(n):

-                    file.body.insert(this_par + 1,
+                    document.body.insert(this_par + 1,

                                      keywords[insets[k]] + arguments[k])
                     for j in range(k, n):
                         del_lines[j][0] = del_lines[j][0] + 1
                         del_lines[j][1] = del_lines[j][1] + 1
                                      keywords[insets[k]] + arguments[k])
                     for j in range(k, n):
                         del_lines[j][0] = del_lines[j][0] + 1
                         del_lines[j][1] = del_lines[j][1] + 1

-                    del file.body[del_lines[k][0]:del_lines[k][1]+1]
+                    del document.body[del_lines[k][0]:del_lines[k][1]+1]

                     deleted = del_lines[k][1] - del_lines[k][0] + 1
                     for j in range(k + 1, n):
                         del_lines[j][0] = del_lines[j][0] - deleted
                     deleted = del_lines[k][1] - del_lines[k][0] + 1
                     for j in range(k + 1, n):
                         del_lines[j][0] = del_lines[j][0] - deleted


@@ -1415,8 +1403,8 @@ def revert_breaks(file):
         # Convert the first inset to ERT.
         # The others are converted in the next loop runs (if they exist)
         if insets[0] == "vspace":
         # Convert the first inset to ERT.
         # The others are converted in the next loop runs (if they exist)
         if insets[0] == "vspace":

-            file.body[i:i+1] = ['\\begin_inset ERT', 'status Collapsed', '',
-                                '\\layout %s' % file.default_layout, '', '\\backslash ']
+            document.body[i:i+1] = ['\\begin_inset ERT', 'status Collapsed', '',
+                                '\\layout %s' % document.default_layout, '', '\\backslash ']

             i = i + 6
             if spaceamount[0][-1] == '*':
                 spaceamount[0] = spaceamount[0][:-1]
             i = i + 6
             if spaceamount[0][-1] == '*':
                 spaceamount[0] = spaceamount[0][:-1]


@@ -1442,36 +1430,36 @@ def revert_breaks(file):
             # Finally output the LaTeX code
             if (spaceamount[0] == 'smallskip' or spaceamount[0] == 'medskip' or
                 spaceamount[0] == 'bigskip'   or spaceamount[0] == 'vfill'):
             # Finally output the LaTeX code
             if (spaceamount[0] == 'smallskip' or spaceamount[0] == 'medskip' or
                 spaceamount[0] == 'bigskip'   or spaceamount[0] == 'vfill'):

-                file.body.insert(i, spaceamount[0] + '{}')
+                document.body.insert(i, spaceamount[0] + '{}')

             else :
                 if keep:
             else :
                 if keep:

-                    file.body.insert(i, 'vspace*{')
+                    document.body.insert(i, 'vspace*{')

                 else:
                 else:

-                    file.body.insert(i, 'vspace{')
-                i = convert_ertbackslash(file.body, i, spaceamount[0], file.format - 1, file.default_layout)
-                file.body[i] = file.body[i] + '}'
+                    document.body.insert(i, 'vspace{')
+                i = convert_ertbackslash(document.body, i, spaceamount[0], document.format - 1, document.default_layout)
+                document.body[i] = document.body[i] + '}'

             i = i + 1
         elif insets[0] == "lyxline":
             i = i + 1
         elif insets[0] == "lyxline":

-            file.body[i] = ''
+            document.body[i] = ''

             latexsize = lyxsize2latexsize(size)
             if latexsize == '':
             latexsize = lyxsize2latexsize(size)
             if latexsize == '':

-                file.warning("Could not convert LyX fontsize '%s' to LaTeX font size." % size)
+                document.warning("Could not convert LyX fontsize '%s' to LaTeX font size." % size)

                 latexsize = '\\normalsize'
                 latexsize = '\\normalsize'

-            i = insert_ert(file.body, i, 'Collapsed',
+            i = insert_ert(document.body, i, 'Collapsed',

                            '\\lyxline{%s}' % latexsize,
                            '\\lyxline{%s}' % latexsize,

-                           file.format - 1, file.default_layout)
+                           document.format - 1, document.default_layout)

             # We use \providecommand so that we don't get an error if native
             # lyxlines are used (LyX writes first its own preamble and then
             # the user specified one)
             # We use \providecommand so that we don't get an error if native
             # lyxlines are used (LyX writes first its own preamble and then
             # the user specified one)

-            add_to_preamble(file,
+            add_to_preamble(document,

                             ['% Commands inserted by lyx2lyx for lyxlines',
                              '\\providecommand{\\lyxline}[1]{',
                              '  {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}'
                              '}'])
         elif insets[0] == "newpage":
                             ['% Commands inserted by lyx2lyx for lyxlines',
                              '\\providecommand{\\lyxline}[1]{',
                              '  {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}'
                              '}'])
         elif insets[0] == "newpage":

-            file.body[i] = ''
-            i = insert_ert(file.body, i, 'Collapsed', '\\newpage{}',
-                           file.format - 1, file.default_layout)
+            document.body[i] = ''
+            i = insert_ert(document.body, i, 'Collapsed', '\\newpage{}',
+                           document.format - 1, document.default_layout)

 
 
 # Convert a LyX length into a LaTeX length
 
 
 # Convert a LyX length into a LaTeX length


@@ -1493,15 +1481,15 @@ def convert_len(len, special):
     return len
 
 
     return len
 
 

-# Convert a LyX length into valid ERT code and append it to body[i]
-# Return the (maybe incremented) line index i

 def convert_ertlen(body, i, len, special, format, default_layout):
 def convert_ertlen(body, i, len, special, format, default_layout):

-    # Convert backslashes and insert the converted length into body
+    """ Convert a LyX length into valid ERT code and append it to body[i]
+    Return the (maybe incremented) line index i
+    Convert backslashes and insert the converted length into body. """

     return convert_ertbackslash(body, i, convert_len(len, special), format, default_layout)
 
 
     return convert_ertbackslash(body, i, convert_len(len, special), format, default_layout)
 
 

-# Return the value of len without the unit in numerical form

 def len2value(len):
 def len2value(len):

+    " Return the value of len without the unit in numerical form. "

     result = re.search('([+-]?[0-9.]+)', len)
     if result:
         return float(result.group(1))
     result = re.search('([+-]?[0-9.]+)', len)
     if result:
         return float(result.group(1))


@@ -1509,9 +1497,10 @@ def len2value(len):
     return 1.0
 
 
     return 1.0
 
 

-# Convert text to ERT and insert it at body[i]
-# Return the index of the line after the inserted ERT

 def insert_ert(body, i, status, text, format, default_layout):
 def insert_ert(body, i, status, text, format, default_layout):

+    """ Convert text to ERT and insert it at body[i]
+    Return the index of the line after the inserted ERT"""
+

     body[i:i] = ['\\begin_inset ERT', 'status ' + status, '']
     i = i + 3
     if format <= 224:
     body[i:i] = ['\\begin_inset ERT', 'status ' + status, '']
     i = i + 3
     if format <= 224:


@@ -1528,29 +1517,31 @@ def insert_ert(body, i, status, text, format, default_layout):
     return i
 
 
     return i
 
 

-# Add text to the preamble if it is not already there.
-# Only the first line is checked!
-def add_to_preamble(file, text):
-    if find_token(file.preamble, text[0], 0) != -1:
+def add_to_preamble(document, text):
+    """ Add text to the preamble if it is not already there.
+    Only the first line is checked!"""
+
+    if find_token(document.preamble, text[0], 0) != -1:

         return
 
         return
 

-    file.preamble.extend(text)
+    document.preamble.extend(text)

 
 
 
 

-def convert_frameless_box(file):
+def convert_frameless_box(document):
+    " Convert frameless box."

     pos = ['t', 'c', 'b']
     inner_pos = ['c', 't', 'b', 's']
     i = 0
     while 1:
     pos = ['t', 'c', 'b']
     inner_pos = ['c', 't', 'b', 's']
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_inset Frameless', i)
+        i = find_token(document.body, '\\begin_inset Frameless', i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i)
+        j = find_end_of_inset(document.body, i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed LyX file: Missing '\\end_inset'.")
+            document.warning("Malformed LyX document: Missing '\\end_inset'.")

             i = i + 1
             continue
             i = i + 1
             continue

-        del file.body[i]
+        del document.body[i]

         j = j - 1
 
         # Gather parameters
         j = j - 1
 
         # Gather parameters


@@ -1559,7 +1550,7 @@ def convert_frameless_box(file):
                   'special':'none', 'height':'1in',
                   'height_special':'totalheight', 'collapsed':'false'}
         for key in params.keys():
                   'special':'none', 'height':'1in',
                   'height_special':'totalheight', 'collapsed':'false'}
         for key in params.keys():

-            value = replace(get_value(file.body, key, i, j), '"', '')
+            value = replace(get_value(document.body, key, i, j), '"', '')

             if value != "":
                 if key == 'position':
                     # convert new to old position: 'position "t"' -> 0
             if value != "":
                 if key == 'position':
                     # convert new to old position: 'position "t"' -> 0


@@ -1573,7 +1564,7 @@ def convert_frameless_box(file):
                         params[key] = value
                 else:
                     params[key] = value
                         params[key] = value
                 else:
                     params[key] = value

-                j = del_token(file.body, key, i, j)
+                j = del_token(document.body, key, i, j)

         i = i + 1
 
         # Convert to minipage or ERT?
         i = i + 1
 
         # Convert to minipage or ERT?


@@ -1614,7 +1605,7 @@ def convert_frameless_box(file):
             # Otherwise we will get LaTeX errors if this document is
             # converted to format 225 or above again (LyX 1.4 uses all
             # optional arguments).
             # Otherwise we will get LaTeX errors if this document is
             # converted to format 225 or above again (LyX 1.4 uses all
             # optional arguments).

-            add_to_preamble(file,
+            add_to_preamble(document,

                 ['% Commands inserted by lyx2lyx for frameless boxes',
                  '% Save the original minipage environment',
                  '\\let\\lyxtolyxrealminipage\\minipage',
                 ['% Commands inserted by lyx2lyx for frameless boxes',
                  '% Save the original minipage environment',
                  '\\let\\lyxtolyxrealminipage\\minipage',


@@ -1660,10 +1651,10 @@ def convert_frameless_box(file):
             ert = ert + '\\let\\endminipage\\endlyxtolyxminipage%\n'
 
             old_i = i
             ert = ert + '\\let\\endminipage\\endlyxtolyxminipage%\n'
 
             old_i = i

-            i = insert_ert(file.body, i, 'Collapsed', ert, file.format - 1, file.default_layout)
+            i = insert_ert(document.body, i, 'Collapsed', ert, document.format - 1, document.default_layout)

             j = j + i - old_i - 1
 
             j = j + i - old_i - 1
 

-            file.body[i:i] = ['\\begin_inset Minipage',
+            document.body[i:i] = ['\\begin_inset Minipage',

                               'position %d' % params['position'],
                               'inner_position 1',
                               'height "1in"',
                               'position %d' % params['position'],
                               'inner_position 1',
                               'height "1in"',


@@ -1675,23 +1666,23 @@ def convert_frameless_box(file):
             # Restore the original minipage environment since we may have
             # minipages inside this box.
             # Start a new paragraph because the following may be nonstandard
             # Restore the original minipage environment since we may have
             # minipages inside this box.
             # Start a new paragraph because the following may be nonstandard

-            file.body[i:i] = ['\\layout %s' % file.default_layout, '', '']
+            document.body[i:i] = ['\\layout %s' % document.default_layout, '', '']

             i = i + 2
             j = j + 3
             ert = '\\let\\minipage\\lyxtolyxrealminipage%\n'
             ert = ert + '\\let\\endminipage\\lyxtolyxrealendminipage%'
             old_i = i
             i = i + 2
             j = j + 3
             ert = '\\let\\minipage\\lyxtolyxrealminipage%\n'
             ert = ert + '\\let\\endminipage\\lyxtolyxrealendminipage%'
             old_i = i

-            i = insert_ert(file.body, i, 'Collapsed', ert, file.format - 1, file.default_layout)
+            i = insert_ert(document.body, i, 'Collapsed', ert, document.format - 1, document.default_layout)

             j = j + i - old_i - 1
 
             # Redefine the minipage end before the inset end.
             # Start a new paragraph because the previous may be nonstandard
             j = j + i - old_i - 1
 
             # Redefine the minipage end before the inset end.
             # Start a new paragraph because the previous may be nonstandard

-            file.body[j:j] = ['\\layout %s' % file.default_layout, '', '']
+            document.body[j:j] = ['\\layout %s' % document.default_layout, '', '']

             j = j + 2
             ert = '\\let\\endminipage\\endlyxtolyxminipage'
             j = j + 2
             ert = '\\let\\endminipage\\endlyxtolyxminipage'

-            j = insert_ert(file.body, j, 'Collapsed', ert, file.format - 1, file.default_layout)
+            j = insert_ert(document.body, j, 'Collapsed', ert, document.format - 1, document.default_layout)

             j = j + 1
             j = j + 1

-            file.body.insert(j, '')
+            document.body.insert(j, '')

             j = j + 1
 
             # LyX writes '%\n' after each box. Therefore we need to end our
             j = j + 1
 
             # LyX writes '%\n' after each box. Therefore we need to end our


@@ -1700,7 +1691,7 @@ def convert_frameless_box(file):
                 ert = '}%\n'
             else:
                 ert = '\\end{lyxtolyxrealminipage}%\n'
                 ert = '}%\n'
             else:
                 ert = '\\end{lyxtolyxrealminipage}%\n'

-            j = insert_ert(file.body, j, 'Collapsed', ert, file.format - 1, file.default_layout)
+            j = insert_ert(document.body, j, 'Collapsed', ert, document.format - 1, document.default_layout)

 
             # We don't need to restore the original minipage after the inset
             # end because the scope of the redefinition is the original box.
 
             # We don't need to restore the original minipage after the inset
             # end because the scope of the redefinition is the original box.


@@ -1708,7 +1699,7 @@ def convert_frameless_box(file):
         else:
 
             # Convert to minipage
         else:
 
             # Convert to minipage

-            file.body[i:i] = ['\\begin_inset Minipage',
+            document.body[i:i] = ['\\begin_inset Minipage',

                               'position %d' % params['position'],
                               'inner_position %d' % params['inner_pos'],
                               'height "' + params['height'] + '"',
                               'position %d' % params['position'],
                               'inner_position %d' % params['inner_pos'],
                               'height "' + params['height'] + '"',


@@ -1717,103 +1708,99 @@ def convert_frameless_box(file):
             i = i + 6
 
 
             i = i + 6
 
 

-def remove_branches(file):
+def remove_branches(document):
+    " Remove branches. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.header, "\\branch", i)
+        i = find_token(document.header, "\\branch", i)

         if i == -1:
             break
         if i == -1:
             break

-        file.warning("Removing branch %s." % split(file.header[i])[1])
-        j = find_token(file.header, "\\end_branch", i)
+        document.warning("Removing branch %s." % split(document.header[i])[1])
+        j = find_token(document.header, "\\end_branch", i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed LyX file: Missing '\\end_branch'.")
+            document.warning("Malformed LyX document: Missing '\\end_branch'.")

             break
             break

-        del file.header[i:j+1]
+        del document.header[i:j+1]

 
     i = 0
     while 1:
 
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset Branch", i)
+        i = find_token(document.body, "\\begin_inset Branch", i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i)
+        j = find_end_of_inset(document.body, i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed LyX file: Missing '\\end_inset'.")
+            document.warning("Malformed LyX document: Missing '\\end_inset'.")

             i = i + 1
             continue
             i = i + 1
             continue

-        del file.body[i]
-        del file.body[j - 1]
+        del document.body[i]
+        del document.body[j - 1]

         # Seach for a line starting 'collapsed'
         # If, however, we find a line starting '\layout'
         # (_always_ present) then break with a warning message
         collapsed_found = 0
         while 1:
         # Seach for a line starting 'collapsed'
         # If, however, we find a line starting '\layout'
         # (_always_ present) then break with a warning message
         collapsed_found = 0
         while 1:

-            if (file.body[i][:9] == "collapsed"):
-                del file.body[i]
+            if (document.body[i][:9] == "collapsed"):
+                del document.body[i]

                 collapsed_found = 1
                 continue
                 collapsed_found = 1
                 continue

-            elif (file.body[i][:7] == "\\layout"):
+            elif (document.body[i][:7] == "\\layout"):

                 if collapsed_found == 0:
                 if collapsed_found == 0:

-                    file.warning("Malformed LyX file: Missing 'collapsed'.")
+                    document.warning("Malformed LyX document: Missing 'collapsed'.")

                 # Delete this new paragraph, since it would not appear in
                 # .tex output. This avoids also empty paragraphs.
                 # Delete this new paragraph, since it would not appear in
                 # .tex output. This avoids also empty paragraphs.

-                del file.body[i]
+                del document.body[i]

                 break
             i = i + 1
 
 
                 break
             i = i + 1
 
 

-##
-# Convert jurabib
-#
-
-def convert_jurabib(file):
-    i = find_token(file.header, '\\use_numerical_citations', 0)
+def convert_jurabib(document):
+    " Convert jurabib. "
+    i = find_token(document.header, '\\use_numerical_citations', 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
+        document.warning("Malformed lyx document: Missing '\\use_numerical_citations'.")

         return
         return

-    file.header.insert(i + 1, '\\use_jurabib 0')
+    document.header.insert(i + 1, '\\use_jurabib 0')

 
 
 
 

-def revert_jurabib(file):
-    i = find_token(file.header, '\\use_jurabib', 0)
+def revert_jurabib(document):
+    " Revert jurabib. "
+    i = find_token(document.header, '\\use_jurabib', 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
+        document.warning("Malformed lyx document: Missing '\\use_jurabib'.")

         return
         return

-    if get_value(file.header, '\\use_jurabib', 0) != "0":
-        file.warning("Conversion of '\\use_jurabib = 1' not yet implemented.")
+    if get_value(document.header, '\\use_jurabib', 0) != "0":
+        document.warning("Conversion of '\\use_jurabib = 1' not yet implemented.")

         # Don't remove '\\use_jurabib' so that people will get warnings by lyx
         return
         # Don't remove '\\use_jurabib' so that people will get warnings by lyx
         return

-    del file.header[i]
+    del document.header[i]

 
 

-##
-# Convert bibtopic
-#

 
 

-def convert_bibtopic(file):
-    i = find_token(file.header, '\\use_jurabib', 0)
+def convert_bibtopic(document):
+    " Convert bibtopic. "
+    i = find_token(document.header, '\\use_jurabib', 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
+        document.warning("Malformed lyx document: Missing '\\use_jurabib'.")

         return
         return

-    file.header.insert(i + 1, '\\use_bibtopic 0')
+    document.header.insert(i + 1, '\\use_bibtopic 0')

 
 
 
 

-def revert_bibtopic(file):
-    i = find_token(file.header, '\\use_bibtopic', 0)
+def revert_bibtopic(document):
+    " Revert bibtopic. "
+    i = find_token(document.header, '\\use_bibtopic', 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\use_bibtopic'.")
+        document.warning("Malformed lyx document: Missing '\\use_bibtopic'.")

         return
         return

-    if get_value(file.header, '\\use_bibtopic', 0) != "0":
-        file.warning("Conversion of '\\use_bibtopic = 1' not yet implemented.")
+    if get_value(document.header, '\\use_bibtopic', 0) != "0":
+        document.warning("Conversion of '\\use_bibtopic = 1' not yet implemented.")

         # Don't remove '\\use_jurabib' so that people will get warnings by lyx
         # Don't remove '\\use_jurabib' so that people will get warnings by lyx

-    del file.header[i]
+    del document.header[i]

 
 

-##
-# Sideway Floats
-#

 
 

-def convert_float(file):
+def convert_float(document):
+    " Convert sideway floats. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token_exact(file.body, '\\begin_inset Float', i)
+        i = find_token_exact(document.body, '\\begin_inset Float', i)

         if i == -1:
             return
         # Seach for a line starting 'wide'
         if i == -1:
             return
         # Seach for a line starting 'wide'


@@ -1821,107 +1808,105 @@ def convert_float(file):
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:
         # (_always_ present) then break with a warning message
         i = i + 1
         while 1:

-            if (file.body[i][:4] == "wide"):
-                file.body.insert(i + 1, 'sideways false')
+            if (document.body[i][:4] == "wide"):
+                document.body.insert(i + 1, 'sideways false')

                 break
                 break

-            elif (file.body[i][:13] == "\\begin_layout"):
-                file.warning("Malformed lyx file: Missing 'wide'.")
+            elif (document.body[i][:13] == "\\begin_layout"):
+                document.warning("Malformed lyx document: Missing 'wide'.")

                 break
             i = i + 1
         i = i + 1
 
 
                 break
             i = i + 1
         i = i + 1
 
 

-def revert_float(file):
+def revert_float(document):
+    " Revert sideway floats. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token_exact(file.body, '\\begin_inset Float', i)
+        i = find_token_exact(document.body, '\\begin_inset Float', i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i)
+        j = find_end_of_inset(document.body, i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed lyx file: Missing '\\end_inset'.")
+            document.warning("Malformed lyx document: Missing '\\end_inset'.")

             i = i + 1
             continue
             i = i + 1
             continue

-        if get_value(file.body, 'sideways', i, j) != "false":
-            file.warning("Conversion of 'sideways true' not yet implemented.")
+        if get_value(document.body, 'sideways', i, j) != "false":
+            document.warning("Conversion of 'sideways true' not yet implemented.")

             # Don't remove 'sideways' so that people will get warnings by lyx
             i = i + 1
             continue
             # Don't remove 'sideways' so that people will get warnings by lyx
             i = i + 1
             continue

-        del_token(file.body, 'sideways', i, j)
+        del_token(document.body, 'sideways', i, j)

         i = i + 1
 
 
         i = i + 1
 
 

-def convert_graphics(file):
-    """ Add extension to filenames of insetgraphics if necessary.
+def convert_graphics(document):
+    """ Add extension to documentnames of insetgraphics if necessary.

     """
     i = 0
     while 1:
     """
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset Graphics", i)
+        i = find_token(document.body, "\\begin_inset Graphics", i)

         if i == -1:
             return
 
         if i == -1:
             return
 

-        j = find_token_exact(file.body, "filename", i)
+        j = find_token_exact(document.body, "documentname", i)

         if j == -1:
             return
         i = i + 1
         if j == -1:
             return
         i = i + 1

-        filename = split(file.body[j])[1]
-        absname = os.path.normpath(os.path.join(file.dir, filename))
-        if file.input == stdin and not os.path.isabs(filename):
-            # We don't know the directory and cannot check the file.
+        filename = split(document.body[j])[1]
+        absname = os.path.normpath(os.path.join(document.dir, filename))
+        if document.input == stdin and not os.path.isabs(filename):
+            # We don't know the directory and cannot check the document.

             # We could use a heuristic and take the current directory,
             # We could use a heuristic and take the current directory,

-            # and we could try to find out if filename has an extension,
+            # and we could try to find out if documentname has an extension,

             # but that would be just guesses and could be wrong.
             # but that would be just guesses and could be wrong.

-            file.warning("""Warning: Can not determine whether file
+            document.warning("""Warning: Can not determine whether document

          %s
          needs an extension when reading from standard input.
          %s
          needs an extension when reading from standard input.

-         You may need to correct the file manually or run
-         lyx2lyx again with the .lyx file as commandline argument.""" % filename)
+         You may need to correct the document manually or run
+         lyx2lyx again with the .lyx document as commandline argument.""" % filename)

             continue
         # This needs to be the same algorithm as in pre 233 insetgraphics
         if access(absname, F_OK):
             continue
         if access(absname + ".ps", F_OK):
             continue
         # This needs to be the same algorithm as in pre 233 insetgraphics
         if access(absname, F_OK):
             continue
         if access(absname + ".ps", F_OK):

-            file.body[j] = replace(file.body[j], filename, filename + ".ps")
+            document.body[j] = replace(document.body[j], filename, filename + ".ps")

             continue
         if access(absname + ".eps", F_OK):
             continue
         if access(absname + ".eps", F_OK):

-            file.body[j] = replace(file.body[j], filename, filename + ".eps")
+            document.body[j] = replace(document.body[j], filename, filename + ".eps")

 
 
 
 

-##
-# Convert firstname and surname from styles -> char styles
-#
-def convert_names(file):
+def convert_names(document):

     """ Convert in the docbook backend from firstname and surname style
     to charstyles.
     """
     """ Convert in the docbook backend from firstname and surname style
     to charstyles.
     """

-    if file.backend != "docbook":
+    if document.backend != "docbook":

         return
 
     i = 0
 
     while 1:
         return
 
     i = 0
 
     while 1:

-        i = find_token(file.body, "\\begin_layout Author", i)
+        i = find_token(document.body, "\\begin_layout Author", i)

         if i == -1:
             return
 
         i = i + 1
         if i == -1:
             return
 
         i = i + 1

-        while file.body[i] == "":
+        while document.body[i] == "":

             i = i + 1
 
             i = i + 1
 

-        if file.body[i][:11] != "\\end_layout" or file.body[i+2][:13] != "\\begin_deeper":
+        if document.body[i][:11] != "\\end_layout" or document.body[i+2][:13] != "\\begin_deeper":

             i = i + 1
             continue
 
         k = i
             i = i + 1
             continue
 
         k = i

-        i = find_end_of( file.body, i+3, "\\begin_deeper","\\end_deeper")
+        i = find_end_of( document.body, i+3, "\\begin_deeper","\\end_deeper")

         if i == -1:
             # something is really wrong, abort
         if i == -1:
             # something is really wrong, abort

-            file.warning("Missing \\end_deeper, after style Author.")
-            file.warning("Aborted attempt to parse FirstName and Surname.")
+            document.warning("Missing \\end_deeper, after style Author.")
+            document.warning("Aborted attempt to parse FirstName and Surname.")

             return
         firstname, surname = "", ""
 
             return
         firstname, surname = "", ""
 

-        name = file.body[k:i]
+        name = document.body[k:i]

 
         j = find_token(name, "\\begin_layout FirstName", 0)
         if j != -1:
 
         j = find_token(name, "\\begin_layout FirstName", 0)
         if j != -1:


@@ -1938,13 +1923,13 @@ def convert_names(file):
                 j = j + 1
 
         # delete name
                 j = j + 1
 
         # delete name

-        del file.body[k+2:i+1]
+        del document.body[k+2:i+1]

 
 

-        file.body[k-1:k-1] = ["", "",
+        document.body[k-1:k-1] = ["", "",

                           "\\begin_inset CharStyle Firstname",
                           "status inlined",
                           "",
                           "\\begin_inset CharStyle Firstname",
                           "status inlined",
                           "",

-                          '\\begin_layout %s' % file.default_layout,
+                          '\\begin_layout %s' % document.default_layout,

                           "",
                           "%s" % firstname,
                           "\end_layout",
                           "",
                           "%s" % firstname,
                           "\end_layout",


@@ -1955,7 +1940,7 @@ def convert_names(file):
                           "\\begin_inset CharStyle Surname",
                           "status inlined",
                           "",
                           "\\begin_inset CharStyle Surname",
                           "status inlined",
                           "",

-                          '\\begin_layout %s' % file.default_layout,
+                          '\\begin_layout %s' % document.default_layout,

                           "",
                           "%s" % surname,
                           "\\end_layout",
                           "",
                           "%s" % surname,
                           "\\end_layout",


@@ -1964,38 +1949,37 @@ def convert_names(file):
                           ""]
 
 
                           ""]
 
 

-def revert_names(file):
+def revert_names(document):

     """ Revert in the docbook backend from firstname and surname char style
     to styles.
     """
     """ Revert in the docbook backend from firstname and surname char style
     to styles.
     """

-    if file.backend != "docbook":
+    if document.backend != "docbook":

         return
 
 
         return
 
 

-##
-#    \use_natbib 1                       \cite_engine <style>
-#    \use_numerical_citations 0     ->   where <style> is one of
-#    \use_jurabib 0                      "basic", "natbib_authoryear",
-#                                        "natbib_numerical" or "jurabib"
-def convert_cite_engine(file):
-    a = find_token(file.header, "\\use_natbib", 0)
+def convert_cite_engine(document):
+    r""" \use_natbib 1                       \cite_engine <style>
+         \use_numerical_citations 0     ->   where <style> is one of
+         \use_jurabib 0                      "basic", "natbib_authoryear","""
+
+    a = find_token(document.header, "\\use_natbib", 0)

     if a == -1:
     if a == -1:

-        file.warning("Malformed lyx file: Missing '\\use_natbib'.")
+        document.warning("Malformed lyx document: Missing '\\use_natbib'.")

         return
 
         return
 

-    b = find_token(file.header, "\\use_numerical_citations", 0)
+    b = find_token(document.header, "\\use_numerical_citations", 0)

     if b == -1 or b != a+1:
     if b == -1 or b != a+1:

-        file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
+        document.warning("Malformed lyx document: Missing '\\use_numerical_citations'.")

         return
 
         return
 

-    c = find_token(file.header, "\\use_jurabib", 0)
+    c = find_token(document.header, "\\use_jurabib", 0)

     if c == -1 or c != b+1:
     if c == -1 or c != b+1:

-        file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
+        document.warning("Malformed lyx document: Missing '\\use_jurabib'.")

         return
 
         return
 

-    use_natbib = int(split(file.header[a])[1])
-    use_numerical_citations = int(split(file.header[b])[1])
-    use_jurabib = int(split(file.header[c])[1])
+    use_natbib = int(split(document.header[a])[1])
+    use_numerical_citations = int(split(document.header[b])[1])
+    use_jurabib = int(split(document.header[c])[1])

 
     cite_engine = "basic"
     if use_natbib:
 
     cite_engine = "basic"
     if use_natbib:


@@ -2006,17 +1990,18 @@ def convert_cite_engine(file):
     elif use_jurabib:
         cite_engine = "jurabib"
 
     elif use_jurabib:
         cite_engine = "jurabib"
 

-    del file.header[a:c+1]
-    file.header.insert(a, "\\cite_engine " + cite_engine)
+    del document.header[a:c+1]
+    document.header.insert(a, "\\cite_engine " + cite_engine)

 
 
 
 

-def revert_cite_engine(file):
-    i = find_token(file.header, "\\cite_engine", 0)
+def revert_cite_engine(document):
+    " Revert the cite engine. "
+    i = find_token(document.header, "\\cite_engine", 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\cite_engine'.")
+        document.warning("Malformed lyx document: Missing '\\cite_engine'.")

         return
 
         return
 

-    cite_engine = split(file.header[i])[1]
+    cite_engine = split(document.header[i])[1]

 
     use_natbib = '0'
     use_numerical = '0'
 
     use_natbib = '0'
     use_numerical = '0'


@@ -2029,83 +2014,81 @@ def revert_cite_engine(file):
     elif cite_engine == "jurabib":
         use_jurabib = '1'
 
     elif cite_engine == "jurabib":
         use_jurabib = '1'
 

-    del file.header[i]
-    file.header.insert(i, "\\use_jurabib " + use_jurabib)
-    file.header.insert(i, "\\use_numerical_citations " + use_numerical)
-    file.header.insert(i, "\\use_natbib " + use_natbib)
+    del document.header[i]
+    document.header.insert(i, "\\use_jurabib " + use_jurabib)
+    document.header.insert(i, "\\use_numerical_citations " + use_numerical)
+    document.header.insert(i, "\\use_natbib " + use_natbib)

 
 
 
 

-##
-# Paper package
-#
-def convert_paperpackage(file):
-    i = find_token(file.header, "\\paperpackage", 0)
+def convert_paperpackage(document):
+    " Convert paper package. "
+    i = find_token(document.header, "\\paperpackage", 0)

     if i == -1:
         return
 
     packages = {'default':'none','a4':'none', 'a4wide':'a4', 'widemarginsa4':'a4wide'}
     if i == -1:
         return
 
     packages = {'default':'none','a4':'none', 'a4wide':'a4', 'widemarginsa4':'a4wide'}

-    if len(split(file.header[i])) > 1:
-        paperpackage = split(file.header[i])[1]
-        file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
+    if len(split(document.header[i])) > 1:
+        paperpackage = split(document.header[i])[1]
+        document.header[i] = replace(document.header[i], paperpackage, packages[paperpackage])

     else:
     else:

-        file.header[i] = file.header[i] + ' widemarginsa4'
+        document.header[i] = document.header[i] + ' widemarginsa4'

 
 
 
 

-def revert_paperpackage(file):
-    i = find_token(file.header, "\\paperpackage", 0)
+def revert_paperpackage(document):
+    " Revert paper package. "
+    i = find_token(document.header, "\\paperpackage", 0)

     if i == -1:
         return
 
     packages = {'none':'a4', 'a4':'a4wide', 'a4wide':'widemarginsa4',
                 'widemarginsa4':'', 'default': 'default'}
     if i == -1:
         return
 
     packages = {'none':'a4', 'a4':'a4wide', 'a4wide':'widemarginsa4',
                 'widemarginsa4':'', 'default': 'default'}

-    if len(split(file.header[i])) > 1:
-        paperpackage = split(file.header[i])[1]
+    if len(split(document.header[i])) > 1:
+        paperpackage = split(document.header[i])[1]

     else:
         paperpackage = 'default'
     else:
         paperpackage = 'default'

-    file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
+    document.header[i] = replace(document.header[i], paperpackage, packages[paperpackage])

 
 
 
 

-##
-# Bullets
-#
-def convert_bullets(file):
+def convert_bullets(document):
+    " Convert bullets. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.header, "\\bullet", i)
+        i = find_token(document.header, "\\bullet", i)

         if i == -1:
             return
         if i == -1:
             return

-        if file.header[i][:12] == '\\bulletLaTeX':
-            file.header[i] = file.header[i] + ' ' + strip(file.header[i+1])
+        if document.header[i][:12] == '\\bulletLaTeX':
+            document.header[i] = document.header[i] + ' ' + strip(document.header[i+1])

             n = 3
         else:
             n = 3
         else:

-            file.header[i] = file.header[i] + ' ' + strip(file.header[i+1]) +\
-                        ' ' + strip(file.header[i+2]) + ' ' + strip(file.header[i+3])
+            document.header[i] = document.header[i] + ' ' + strip(document.header[i+1]) +\
+                        ' ' + strip(document.header[i+2]) + ' ' + strip(document.header[i+3])

             n = 5
             n = 5

-        del file.header[i+1:i + n]
+        del document.header[i+1:i + n]

         i = i + 1
 
 
         i = i + 1
 
 

-def revert_bullets(file):
+def revert_bullets(document):
+    " Revert bullets. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.header, "\\bullet", i)
+        i = find_token(document.header, "\\bullet", i)

         if i == -1:
             return
         if i == -1:
             return

-        if file.header[i][:12] == '\\bulletLaTeX':
-            n = find(file.header[i], '"')
+        if document.header[i][:12] == '\\bulletLaTeX':
+            n = find(document.header[i], '"')

             if n == -1:
             if n == -1:

-                file.warning("Malformed header.")
+                document.warning("Malformed header.")

                 return
             else:
                 return
             else:

-                file.header[i:i+1] = [file.header[i][:n-1],'\t' + file.header[i][n:], '\\end_bullet']
+                document.header[i:i+1] = [document.header[i][:n-1],'\t' + document.header[i][n:], '\\end_bullet']

             i = i + 3
         else:
             i = i + 3
         else:

-            frag = split(file.header[i])
+            frag = split(document.header[i])

             if len(frag) != 5:
             if len(frag) != 5:

-                file.warning("Malformed header.")
+                document.warning("Malformed header.")

                 return
             else:
                 return
             else:

-                file.header[i:i+1] = [frag[0] + ' ' + frag[1],
+                document.header[i:i+1] = [frag[0] + ' ' + frag[1],

                                  '\t' + frag[2],
                                  '\t' + frag[3],
                                  '\t' + frag[4],
                                  '\t' + frag[2],
                                  '\t' + frag[3],
                                  '\t' + frag[4],


@@ -2113,111 +2096,107 @@ def revert_bullets(file):
                 i = i + 5
 
 
                 i = i + 5
 
 

-##
-# \begin_header and \begin_document
-#
-def add_begin_header(file):
-    i = find_token(file.header, '\\lyxformat', 0)
-    file.header.insert(i+1, '\\begin_header')
-    file.header.insert(i+1, '\\begin_document')
+def add_begin_header(document):
+    r" Add \begin_header and \begin_document. "
+    i = find_token(document.header, '\\lyxformat', 0)
+    document.header.insert(i+1, '\\begin_header')
+    document.header.insert(i+1, '\\begin_document')

 
 
 
 

-def remove_begin_header(file):
-    i = find_token(file.header, "\\begin_document", 0)
+def remove_begin_header(document):
+    r" Remove \begin_header and \begin_document. "
+    i = find_token(document.header, "\\begin_document", 0)

     if i != -1:
     if i != -1:

-        del file.header[i]
-    i = find_token(file.header, "\\begin_header", 0)
+        del document.header[i]
+    i = find_token(document.header, "\\begin_header", 0)

     if i != -1:
     if i != -1:

-        del file.header[i]
+        del document.header[i]

 
 
 
 

-##
-# \begin_file.body and \end_file.body
-#
-def add_begin_body(file):
-    file.body.insert(0, '\\begin_body')
-    file.body.insert(1, '')
-    i = find_token(file.body, "\\end_document", 0)
-    file.body.insert(i, '\\end_body')
-
-def remove_begin_body(file):
-    i = find_token(file.body, "\\begin_body", 0)
+def add_begin_body(document):
+    r" Add and \begin_document and \end_document"
+    document.body.insert(0, '\\begin_body')
+    document.body.insert(1, '')
+    i = find_token(document.body, "\\end_document", 0)
+    document.body.insert(i, '\\end_body')
+
+def remove_begin_body(document):
+    r" Remove \begin_body and \end_body"
+    i = find_token(document.body, "\\begin_body", 0)

     if i != -1:
     if i != -1:

-        del file.body[i]
-        if not file.body[i]:
-            del file.body[i]
-    i = find_token(file.body, "\\end_body", 0)
+        del document.body[i]
+        if not document.body[i]:
+            del document.body[i]
+    i = find_token(document.body, "\\end_body", 0)

     if i != -1:
     if i != -1:

-        del file.body[i]
+        del document.body[i]

 
 
 
 

-##
-# \papersize
-#
-def normalize_papersize(file):
-    i = find_token(file.header, '\\papersize', 0)
+def normalize_papersize(document):
+    r" Normalize \papersize"
+    i = find_token(document.header, '\\papersize', 0)

     if i == -1:
         return
 
     if i == -1:
         return
 

-    tmp = split(file.header[i])
+    tmp = split(document.header[i])

     if tmp[1] == "Default":
     if tmp[1] == "Default":

-        file.header[i] = '\\papersize default'
+        document.header[i] = '\\papersize default'

         return
     if tmp[1] == "Custom":
         return
     if tmp[1] == "Custom":

-        file.header[i] = '\\papersize custom'
+        document.header[i] = '\\papersize custom'

 
 
 
 

-def denormalize_papersize(file):
-    i = find_token(file.header, '\\papersize', 0)
+def denormalize_papersize(document):
+    r" Revert \papersize"
+    i = find_token(document.header, '\\papersize', 0)

     if i == -1:
         return
 
     if i == -1:
         return
 

-    tmp = split(file.header[i])
+    tmp = split(document.header[i])

     if tmp[1] == "custom":
     if tmp[1] == "custom":

-        file.header[i] = '\\papersize Custom'
+        document.header[i] = '\\papersize Custom'

 
 
 
 

-##
-# Strip spaces at end of command line
-#
-def strip_end_space(file):
-    for i in range(len(file.body)):
-        if file.body[i][:1] == '\\':
-            file.body[i] = strip(file.body[i])
+def strip_end_space(document):
+    " Strip spaces at end of command line. "
+    for i in range(len(document.body)):
+        if document.body[i][:1] == '\\':
+            document.body[i] = strip(document.body[i])

 
 
 
 

-##
-# Use boolean values for \use_geometry, \use_bibtopic and \tracking_changes
-#
-def use_x_boolean(file):
+def use_x_boolean(document):
+    r" Use boolean values for \use_geometry, \use_bibtopic and \tracking_changes"

     bin2bool = {'0': 'false', '1': 'true'}
     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
     bin2bool = {'0': 'false', '1': 'true'}
     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':

-        i = find_token(file.header, use, 0)
+        i = find_token(document.header, use, 0)

         if i == -1:
             continue
         if i == -1:
             continue

-        decompose = split(file.header[i])
-        file.header[i] = decompose[0] + ' ' + bin2bool[decompose[1]]
+        decompose = split(document.header[i])
+        document.header[i] = decompose[0] + ' ' + bin2bool[decompose[1]]

 
 
 
 

-def use_x_binary(file):
+def use_x_binary(document):
+    r" Use digit values for \use_geometry, \use_bibtopic and \tracking_changes"

     bool2bin = {'false': '0', 'true': '1'}
     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
     bool2bin = {'false': '0', 'true': '1'}
     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':

-        i = find_token(file.header, use, 0)
+        i = find_token(document.header, use, 0)

         if i == -1:
             continue
         if i == -1:
             continue

-        decompose = split(file.header[i])
-        file.header[i] = decompose[0] + ' ' + bool2bin[decompose[1]]
+        decompose = split(document.header[i])
+        document.header[i] = decompose[0] + ' ' + bool2bin[decompose[1]]

 
 

-##
-# Place all the paragraph parameters in their own line
-#
-def normalize_paragraph_params(file):
-    body = file.body
-    allowed_parameters = '\\paragraph_spacing', '\\noindent', '\\align', '\\labelwidthstring', "\\start_of_appendix", "\\leftindent"
+
+def normalize_paragraph_params(document):
+    " Place all the paragraph parameters in their own line. "
+    body = document.body
+    
+    allowed_parameters = '\\paragraph_spacing', '\\noindent', \
+                         '\\align', '\\labelwidthstring', "\\start_of_appendix", \
+                         "\\leftindent"

 
     i = 0
     while 1:
 
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_layout', i)
+        i = find_token(document.body, '\\begin_layout', i)

         if i == -1:
             return
 
         if i == -1:
             return
 


@@ -2234,28 +2213,25 @@ def normalize_paragraph_params(file):
             i = i + 1
 
 
             i = i + 1
 
 

-##
-# Add/remove output_changes parameter
-#
-def convert_output_changes (file):
-    i = find_token(file.header, '\\tracking_changes', 0)
+def convert_output_changes (document):
+    " Add output_changes parameter. "
+    i = find_token(document.header, '\\tracking_changes', 0)

     if i == -1:
     if i == -1:

-        file.warning("Malformed lyx file: Missing '\\tracking_changes'.")
+        document.warning("Malformed lyx document: Missing '\\tracking_changes'.")

         return
         return

-    file.header.insert(i+1, '\\output_changes true')
+    document.header.insert(i+1, '\\output_changes true')

 
 
 
 

-def revert_output_changes (file):
-    i = find_token(file.header, '\\output_changes', 0)
+def revert_output_changes (document):
+    " Remove output_changes parameter. "
+    i = find_token(document.header, '\\output_changes', 0)

     if i == -1:
         return
     if i == -1:
         return

-    del file.header[i]
+    del document.header[i]

 
 
 
 

-##
-# Convert paragraph breaks and sanitize paragraphs
-#
-def convert_ert_paragraphs(file):
+def convert_ert_paragraphs(document):
+    " Convert paragraph breaks and sanitize paragraphs. "

     forbidden_settings = [
                           # paragraph parameters
                           '\\paragraph_spacing', '\\labelwidthstring',
     forbidden_settings = [
                           # paragraph parameters
                           '\\paragraph_spacing', '\\labelwidthstring',


@@ -2267,30 +2243,30 @@ def convert_ert_paragraphs(file):
                           '\\color', '\\lang']
     i = 0
     while 1:
                           '\\color', '\\lang']
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_inset ERT', i)
+        i = find_token(document.body, '\\begin_inset ERT', i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i)
+        j = find_end_of_inset(document.body, i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed lyx file: Missing '\\end_inset'.")
+            document.warning("Malformed lyx document: Missing '\\end_inset'.")

             i = i + 1
             continue
 
         # convert non-standard paragraphs to standard
         k = i
         while 1:
             i = i + 1
             continue
 
         # convert non-standard paragraphs to standard
         k = i
         while 1:

-            k = find_token(file.body, "\\begin_layout", k, j)
+            k = find_token(document.body, "\\begin_layout", k, j)

             if k == -1:
                 break
             if k == -1:
                 break

-            file.body[k] = '\\begin_layout %s' % file.default_layout
+            document.body[k] = '\\begin_layout %s' % document.default_layout

             k = k + 1
 
         # remove all paragraph parameters and font settings
         k = i
         while k < j:
             k = k + 1
 
         # remove all paragraph parameters and font settings
         k = i
         while k < j:

-            if (strip(file.body[k]) and
-                split(file.body[k])[0] in forbidden_settings):
-                del file.body[k]
+            if (strip(document.body[k]) and
+                split(document.body[k])[0] in forbidden_settings):
+                del document.body[k]

                 j = j - 1
             else:
                 k = k + 1
                 j = j - 1
             else:
                 k = k + 1


@@ -2299,14 +2275,14 @@ def convert_ert_paragraphs(file):
         k = i
         first_pagraph = 1
         while 1:
         k = i
         first_pagraph = 1
         while 1:

-            k = find_token(file.body, "\\begin_layout", k, j)
+            k = find_token(document.body, "\\begin_layout", k, j)

             if k == -1:
                 break
             if first_pagraph:
                 first_pagraph = 0
                 k = k + 1
                 continue
             if k == -1:
                 break
             if first_pagraph:
                 first_pagraph = 0
                 k = k + 1
                 continue

-            file.body[k:k] = ['\\begin_layout %s' % file.default_layout, "",
+            document.body[k:k] = ['\\begin_layout %s' % document.default_layout, "",

                               "\\end_layout", ""]
             k = k + 5
             j = j + 4
                               "\\end_layout", ""]
             k = k + 5
             j = j + 4


@@ -2314,63 +2290,61 @@ def convert_ert_paragraphs(file):
         # convert \\newline to new paragraph
         k = i
         while 1:
         # convert \\newline to new paragraph
         k = i
         while 1:

-            k = find_token(file.body, "\\newline", k, j)
+            k = find_token(document.body, "\\newline", k, j)

             if k == -1:
                 break
             if k == -1:
                 break

-            file.body[k:k+1] = ["\\end_layout", "", '\\begin_layout %s' % file.default_layout]
+            document.body[k:k+1] = ["\\end_layout", "", '\\begin_layout %s' % document.default_layout]

             k = k + 4
             j = j + 3
             k = k + 4
             j = j + 3

-            # We need an empty line if file.default_layout == ''
-            if file.body[k-1] != '':
-                file.body.insert(k-1, '')
+            # We need an empty line if document.default_layout == ''
+            if document.body[k-1] != '':
+                document.body.insert(k-1, '')

                 k = k + 1
                 j = j + 1
         i = i + 1
 
 
                 k = k + 1
                 j = j + 1
         i = i + 1
 
 

-##
-# Remove double paragraph breaks
-#
-def revert_ert_paragraphs(file):
+def revert_ert_paragraphs(document):
+    " Remove double paragraph breaks. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_token(file.body, '\\begin_inset ERT', i)
+        i = find_token(document.body, '\\begin_inset ERT', i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i)
+        j = find_end_of_inset(document.body, i)

         if j == -1:
         if j == -1:

-            file.warning("Malformed lyx file: Missing '\\end_inset'.")
+            document.warning("Malformed lyx document: Missing '\\end_inset'.")

             i = i + 1
             continue
 
         # replace paragraph breaks with \newline
         k = i
         while 1:
             i = i + 1
             continue
 
         # replace paragraph breaks with \newline
         k = i
         while 1:

-            k = find_token(file.body, "\\end_layout", k, j)
-            l = find_token(file.body, "\\begin_layout", k, j)
+            k = find_token(document.body, "\\end_layout", k, j)
+            l = find_token(document.body, "\\begin_layout", k, j)

             if k == -1 or l == -1:
                 break
             if k == -1 or l == -1:
                 break

-            file.body[k:l+1] = ["\\newline"]
+            document.body[k:l+1] = ["\\newline"]

             j = j - l + k
             k = k + 1
 
         # replace double \newlines with paragraph breaks
         k = i
         while 1:
             j = j - l + k
             k = k + 1
 
         # replace double \newlines with paragraph breaks
         k = i
         while 1:

-            k = find_token(file.body, "\\newline", k, j)
+            k = find_token(document.body, "\\newline", k, j)

             if k == -1:
                 break
             l = k + 1
             if k == -1:
                 break
             l = k + 1

-            while file.body[l] == "":
+            while document.body[l] == "":

                 l = l + 1
                 l = l + 1

-            if strip(file.body[l]) and split(file.body[l])[0] == "\\newline":
-                file.body[k:l+1] = ["\\end_layout", "",
-                                    '\\begin_layout %s' % file.default_layout]
+            if strip(document.body[l]) and split(document.body[l])[0] == "\\newline":
+                document.body[k:l+1] = ["\\end_layout", "",
+                                    '\\begin_layout %s' % document.default_layout]

                 j = j - l + k + 2
                 k = k + 3
                 j = j - l + k + 2
                 k = k + 3

-                # We need an empty line if file.default_layout == ''
-                if file.body[l+1] != '':
-                    file.body.insert(l+1, '')
+                # We need an empty line if document.default_layout == ''
+                if document.body[l+1] != '':
+                    document.body.insert(l+1, '')

                     k = k + 1
                     j = j + 1
             else:
                     k = k + 1
                     j = j + 1
             else:


@@ -2378,32 +2352,34 @@ def revert_ert_paragraphs(file):
         i = i + 1
 
 
         i = i + 1
 
 

-def convert_french(file):
+def convert_french(document):
+    " Convert frenchb. "

     regexp = re.compile(r'^\\language\s+frenchb')
     regexp = re.compile(r'^\\language\s+frenchb')

-    i = find_re(file.header, regexp, 0)
+    i = find_re(document.header, regexp, 0)

     if i != -1:
     if i != -1:

-        file.header[i] = "\\language french"
+        document.header[i] = "\\language french"

 
     # Change language in the document body
     regexp = re.compile(r'^\\lang\s+frenchb')
     i = 0
     while 1:
 
     # Change language in the document body
     regexp = re.compile(r'^\\lang\s+frenchb')
     i = 0
     while 1:

-        i = find_re(file.body, regexp, i)
+        i = find_re(document.body, regexp, i)

         if i == -1:
             break
         if i == -1:
             break

-        file.body[i] = "\\lang french"
+        document.body[i] = "\\lang french"

         i = i + 1
 
 
         i = i + 1
 
 

-def remove_paperpackage(file):
-    i = find_token(file.header, '\\paperpackage', 0)
+def remove_paperpackage(document):
+    " Remove paper package. "
+    i = find_token(document.header, '\\paperpackage', 0)

 
     if i == -1:
         return
 
 
     if i == -1:
         return
 

-    paperpackage = split(file.header[i])[1]
+    paperpackage = split(document.header[i])[1]

 
 

-    del file.header[i]
+    del document.header[i]

 
     if paperpackage not in ("a4", "a4wide", "widemarginsa4"):
         return
 
     if paperpackage not in ("a4", "a4wide", "widemarginsa4"):
         return


@@ -2411,45 +2387,46 @@ def remove_paperpackage(file):
     conv = {"a4":"\\usepackage{a4}","a4wide": "\\usepackage{a4wide}",
             "widemarginsa4": "\\usepackage[widemargins]{a4}"}
     # for compatibility we ensure it is the first entry in preamble
     conv = {"a4":"\\usepackage{a4}","a4wide": "\\usepackage{a4wide}",
             "widemarginsa4": "\\usepackage[widemargins]{a4}"}
     # for compatibility we ensure it is the first entry in preamble

-    file.preamble[0:0] = [conv[paperpackage]]
+    document.preamble[0:0] = [conv[paperpackage]]

 
 

-    i = find_token(file.header, '\\papersize', 0)
+    i = find_token(document.header, '\\papersize', 0)

     if i != -1:
     if i != -1:

-        file.header[i] = "\\papersize default"
+        document.header[i] = "\\papersize default"

 
 
 
 

-def remove_quotestimes(file):
-    i = find_token(file.header, '\\quotes_times', 0)
+def remove_quotestimes(document):
+    " Remove quotestimes. "
+    i = find_token(document.header, '\\quotes_times', 0)

     if i == -1:
         return
     if i == -1:
         return

-    del file.header[i]
+    del document.header[i]

 
 
 
 

-##
-# Convert SGML paragraphs
-#
-def convert_sgml_paragraphs(file):
-    if file.backend != "docbook":
+def convert_sgml_paragraphs(document):
+    " Convert SGML paragraphs. "
+    if document.backend != "docbook":

         return
 
     i = 0
     while 1:
         return
 
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_layout SGML", i)
+        i = find_token(document.body, "\\begin_layout SGML", i)

 
         if i == -1:
             return
 
 
         if i == -1:
             return
 

-        file.body[i] = "\\begin_layout Standard"
-        j = find_token(file.body, "\\end_layout", i)
+        document.body[i] = "\\begin_layout Standard"
+        j = find_token(document.body, "\\end_layout", i)

 
 

-        file.body[j+1:j+1] = ['','\\end_inset','','','\\end_layout']
-        file.body[i+1:i+1] = ['\\begin_inset ERT','status inlined','','\\begin_layout Standard','']
+        document.body[j+1:j+1] = ['','\\end_inset','','','\\end_layout']
+        document.body[i+1:i+1] = ['\\begin_inset ERT','status inlined','','\\begin_layout Standard','']

 
         i = i + 10
 
         i = i + 10

+

 ##
 # Convertion hub
 #
 
 ##
 # Convertion hub
 #
 

+supported_versions = ["1.4.%d" % i for i in range(3)] + ["1.4"]

 convert = [[222, [insert_tracking_changes, add_end_header, convert_amsmath]],
            [223, [remove_color_default, convert_spaces, convert_bibtex, remove_insetparent]],
            [224, [convert_external, convert_comment]],
 convert = [[222, [insert_tracking_changes, add_end_header, convert_amsmath]],
            [223, [remove_color_default, convert_spaces, convert_bibtex, remove_insetparent]],
            [224, [convert_external, convert_comment]],

diff --git a/lib/lyx2lyx/lyx_1_5.py b/lib/lyx2lyx/lyx_1_5.py
index b2ed93ab47ae07770af3c73f183a451576527f3d..1f2f02d14463a14940bf983b38d08b01fd38e6ed 100644 (file)
--- a/lib/lyx2lyx/lyx_1_5.py
+++ b/lib/lyx2lyx/lyx_1_5.py
@@ -1,6 +1,6 @@
 # This file is part of lyx2lyx
 # This file is part of lyx2lyx

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2006 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# Copyright (C) 2006 José Matos <jamatos@lyx.org>

 # Copyright (C) 2004-2006 Georg Baum <Georg.Baum@post.rwth-aachen.de>
 #
 # This program is free software; you can redistribute it and/or
 # Copyright (C) 2004-2006 Georg Baum <Georg.Baum@post.rwth-aachen.de>
 #
 # This program is free software; you can redistribute it and/or


@@ -17,6 +17,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 

+""" Convert files to the file format generated by lyx 1.5"""
+

 import re
 from parser_tools import find_token, find_token_exact, find_tokens, find_end_of, get_value
 from string import replace
 import re
 from parser_tools import find_token, find_token_exact, find_tokens, find_end_of, get_value
 from string import replace


@@ -26,6 +28,7 @@ from string import replace
 # Private helper functions
 
 def find_end_of_inset(lines, i):
 # Private helper functions
 
 def find_end_of_inset(lines, i):

+    " Find beginning of inset, where lines[i] is included."

     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 # End of helper functions
     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
 
 # End of helper functions


@@ -36,14 +39,15 @@ def find_end_of_inset(lines, i):
 #  Notes: Framed/Shaded
 #
 
 #  Notes: Framed/Shaded
 #
 

-def revert_framed(file):
+def revert_framed(document):
+    "Revert framed notes. "

     i = 0
     while 1:
     i = 0
     while 1:

-        i = find_tokens(file.body, ["\\begin_inset Note Framed", "\\begin_inset Note Shaded"], i)
+        i = find_tokens(document.body, ["\\begin_inset Note Framed", "\\begin_inset Note Shaded"], i)

 
         if i == -1:
             return
 
         if i == -1:
             return

-        file.body[i] = "\\begin_inset Note"
+        document.body[i] = "\\begin_inset Note"

         i = i + 1
 
 
         i = i + 1
 
 


@@ -67,20 +71,21 @@ typewriter_fonts = {'default' : 'default', 'ae'       : 'default',
                     'newcent' : 'default', 'bookman'  : 'default',
                     'pslatex' : 'courier'}
 
                     'newcent' : 'default', 'bookman'  : 'default',
                     'pslatex' : 'courier'}
 

-def convert_font_settings(file):
+def convert_font_settings(document):
+    " Convert font settings. "

     i = 0
     i = 0

-    i = find_token_exact(file.header, "\\fontscheme", i)
+    i = find_token_exact(document.header, "\\fontscheme", i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\fontscheme'.")
+        document.warning("Malformed LyX document: Missing `\\fontscheme'.")

         return
         return

-    font_scheme = get_value(file.header, "\\fontscheme", i, i + 1)
+    font_scheme = get_value(document.header, "\\fontscheme", i, i + 1)

     if font_scheme == '':
     if font_scheme == '':

-        file.warning("Malformed LyX file: Empty `\\fontscheme'.")
+        document.warning("Malformed LyX document: Empty `\\fontscheme'.")

         font_scheme = 'default'
     if not font_scheme in roman_fonts.keys():
         font_scheme = 'default'
     if not font_scheme in roman_fonts.keys():

-        file.warning("Malformed LyX file: Unknown `\\fontscheme' `%s'." % font_scheme)
+        document.warning("Malformed LyX document: Unknown `\\fontscheme' `%s'." % font_scheme)

         font_scheme = 'default'
         font_scheme = 'default'

-    file.header[i:i+1] = ['\\font_roman %s' % roman_fonts[font_scheme],
+    document.header[i:i+1] = ['\\font_roman %s' % roman_fonts[font_scheme],

                           '\\font_sans %s' % sans_fonts[font_scheme],
                           '\\font_typewriter %s' % typewriter_fonts[font_scheme],
                           '\\font_default_family default',
                           '\\font_sans %s' % sans_fonts[font_scheme],
                           '\\font_typewriter %s' % typewriter_fonts[font_scheme],
                           '\\font_default_family default',


@@ -90,124 +95,125 @@ def convert_font_settings(file):
                           '\\font_tt_scale 100']
 
 
                           '\\font_tt_scale 100']
 
 

-def revert_font_settings(file):
+def revert_font_settings(document):
+    " Revert font settings. "

     i = 0
     insert_line = -1
     fonts = {'roman' : 'default', 'sans' : 'default', 'typewriter' : 'default'}
     for family in 'roman', 'sans', 'typewriter':
         name = '\\font_%s' % family
     i = 0
     insert_line = -1
     fonts = {'roman' : 'default', 'sans' : 'default', 'typewriter' : 'default'}
     for family in 'roman', 'sans', 'typewriter':
         name = '\\font_%s' % family

-        i = find_token_exact(file.header, name, i)
+        i = find_token_exact(document.header, name, i)

         if i == -1:
         if i == -1:

-            file.warning("Malformed LyX file: Missing `%s'." % name)
+            document.warning("Malformed LyX document: Missing `%s'." % name)

             i = 0
         else:
             if (insert_line < 0):
                 insert_line = i
             i = 0
         else:
             if (insert_line < 0):
                 insert_line = i

-            fonts[family] = get_value(file.header, name, i, i + 1)
-            del file.header[i]
-    i = find_token_exact(file.header, '\\font_default_family', i)
+            fonts[family] = get_value(document.header, name, i, i + 1)
+            del document.header[i]
+    i = find_token_exact(document.header, '\\font_default_family', i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\font_default_family'.")
+        document.warning("Malformed LyX document: Missing `\\font_default_family'.")

         font_default_family = 'default'
     else:
         font_default_family = 'default'
     else:

-        font_default_family = get_value(file.header, "\\font_default_family", i, i + 1)
-        del file.header[i]
-    i = find_token_exact(file.header, '\\font_sc', i)
+        font_default_family = get_value(document.header, "\\font_default_family", i, i + 1)
+        del document.header[i]
+    i = find_token_exact(document.header, '\\font_sc', i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\font_sc'.")
+        document.warning("Malformed LyX document: Missing `\\font_sc'.")

         font_sc = 'false'
     else:
         font_sc = 'false'
     else:

-        font_sc = get_value(file.header, '\\font_sc', i, i + 1)
-        del file.header[i]
+        font_sc = get_value(document.header, '\\font_sc', i, i + 1)
+        del document.header[i]

     if font_sc != 'false':
     if font_sc != 'false':

-        file.warning("Conversion of '\\font_sc' not yet implemented.")
-    i = find_token_exact(file.header, '\\font_osf', i)
+        document.warning("Conversion of '\\font_sc' not yet implemented.")
+    i = find_token_exact(document.header, '\\font_osf', i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\font_osf'.")
+        document.warning("Malformed LyX document: Missing `\\font_osf'.")

         font_osf = 'false'
     else:
         font_osf = 'false'
     else:

-        font_osf = get_value(file.header, '\\font_osf', i, i + 1)
-        del file.header[i]
-    i = find_token_exact(file.header, '\\font_sf_scale', i)
+        font_osf = get_value(document.header, '\\font_osf', i, i + 1)
+        del document.header[i]
+    i = find_token_exact(document.header, '\\font_sf_scale', i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\font_sf_scale'.")
+        document.warning("Malformed LyX document: Missing `\\font_sf_scale'.")

         font_sf_scale = '100'
     else:
         font_sf_scale = '100'
     else:

-        font_sf_scale = get_value(file.header, '\\font_sf_scale', i, i + 1)
-        del file.header[i]
+        font_sf_scale = get_value(document.header, '\\font_sf_scale', i, i + 1)
+        del document.header[i]

     if font_sf_scale != '100':
     if font_sf_scale != '100':

-        file.warning("Conversion of '\\font_sf_scale' not yet implemented.")
-    i = find_token_exact(file.header, '\\font_tt_scale', i)
+        document.warning("Conversion of '\\font_sf_scale' not yet implemented.")
+    i = find_token_exact(document.header, '\\font_tt_scale', i)

     if i == -1:
     if i == -1:

-        file.warning("Malformed LyX file: Missing `\\font_tt_scale'.")
+        document.warning("Malformed LyX document: Missing `\\font_tt_scale'.")

         font_tt_scale = '100'
     else:
         font_tt_scale = '100'
     else:

-        font_tt_scale = get_value(file.header, '\\font_tt_scale', i, i + 1)
-        del file.header[i]
+        font_tt_scale = get_value(document.header, '\\font_tt_scale', i, i + 1)
+        del document.header[i]

     if font_tt_scale != '100':
     if font_tt_scale != '100':

-        file.warning("Conversion of '\\font_tt_scale' not yet implemented.")
+        document.warning("Conversion of '\\font_tt_scale' not yet implemented.")

     for font_scheme in roman_fonts.keys():
         if (roman_fonts[font_scheme] == fonts['roman'] and
             sans_fonts[font_scheme] == fonts['sans'] and
             typewriter_fonts[font_scheme] == fonts['typewriter']):
     for font_scheme in roman_fonts.keys():
         if (roman_fonts[font_scheme] == fonts['roman'] and
             sans_fonts[font_scheme] == fonts['sans'] and
             typewriter_fonts[font_scheme] == fonts['typewriter']):

-            file.header.insert(insert_line, '\\fontscheme %s' % font_scheme)
+            document.header.insert(insert_line, '\\fontscheme %s' % font_scheme)

             if font_default_family != 'default':
             if font_default_family != 'default':

-                file.preamble.append('\\renewcommand{\\familydefault}{\\%s}' % font_default_family)
+                document.preamble.append('\\renewcommand{\\familydefault}{\\%s}' % font_default_family)

             if font_osf == 'true':
             if font_osf == 'true':

-                file.warning("Ignoring `\\font_osf = true'")
+                document.warning("Ignoring `\\font_osf = true'")

             return
     font_scheme = 'default'
             return
     font_scheme = 'default'

-    file.header.insert(insert_line, '\\fontscheme %s' % font_scheme)
+    document.header.insert(insert_line, '\\fontscheme %s' % font_scheme)

     if fonts['roman'] == 'cmr':
     if fonts['roman'] == 'cmr':

-        file.preamble.append('\\renewcommand{\\rmdefault}{cmr}')
+        document.preamble.append('\\renewcommand{\\rmdefault}{cmr}')

         if font_osf == 'true':
         if font_osf == 'true':

-            file.preamble.append('\\usepackage{eco}')
+            document.preamble.append('\\usepackage{eco}')

             font_osf = 'false'
     for font in 'lmodern', 'charter', 'utopia', 'beraserif', 'ccfonts', 'chancery':
         if fonts['roman'] == font:
             font_osf = 'false'
     for font in 'lmodern', 'charter', 'utopia', 'beraserif', 'ccfonts', 'chancery':
         if fonts['roman'] == font:

-            file.preamble.append('\\usepackage{%s}' % font)
+            document.preamble.append('\\usepackage{%s}' % font)

     for font in 'cmss', 'lmss', 'cmbr':
         if fonts['sans'] == font:
     for font in 'cmss', 'lmss', 'cmbr':
         if fonts['sans'] == font:

-            file.preamble.append('\\renewcommand{\\sfdefault}{%s}' % font)
+            document.preamble.append('\\renewcommand{\\sfdefault}{%s}' % font)

     for font in 'berasans':
         if fonts['sans'] == font:
     for font in 'berasans':
         if fonts['sans'] == font:

-            file.preamble.append('\\usepackage{%s}' % font)
+            document.preamble.append('\\usepackage{%s}' % font)

     for font in 'cmtt', 'lmtt', 'cmtl':
         if fonts['typewriter'] == font:
     for font in 'cmtt', 'lmtt', 'cmtl':
         if fonts['typewriter'] == font:

-            file.preamble.append('\\renewcommand{\\ttdefault}{%s}' % font)
+            document.preamble.append('\\renewcommand{\\ttdefault}{%s}' % font)

     for font in 'courier', 'beramono', 'luximono':
         if fonts['typewriter'] == font:
     for font in 'courier', 'beramono', 'luximono':
         if fonts['typewriter'] == font:

-            file.preamble.append('\\usepackage{%s}' % font)
+            document.preamble.append('\\usepackage{%s}' % font)

     if font_default_family != 'default':
     if font_default_family != 'default':

-        file.preamble.append('\\renewcommand{\\familydefault}{\\%s}' % font_default_family)
+        document.preamble.append('\\renewcommand{\\familydefault}{\\%s}' % font_default_family)

     if font_osf == 'true':
     if font_osf == 'true':

-        file.warning("Ignoring `\\font_osf = true'")
+        document.warning("Ignoring `\\font_osf = true'")

 
 
 
 

-def revert_booktabs(file):
-# we just remove the booktabs flag, everything else will become a mess.
+def revert_booktabs(document):
+    " We remove the booktabs flag or everything else will become a mess. "

     re_row = re.compile(r'^<row.*space="[^"]+".*>$')
     re_tspace = re.compile(r'\s+topspace="[^"]+"')
     re_bspace = re.compile(r'\s+bottomspace="[^"]+"')
     re_ispace = re.compile(r'\s+interlinespace="[^"]+"')
     i = 0
     while 1:
     re_row = re.compile(r'^<row.*space="[^"]+".*>$')
     re_tspace = re.compile(r'\s+topspace="[^"]+"')
     re_bspace = re.compile(r'\s+bottomspace="[^"]+"')
     re_ispace = re.compile(r'\s+interlinespace="[^"]+"')
     i = 0
     while 1:

-        i = find_token(file.body, "\\begin_inset Tabular", i)
+        i = find_token(document.body, "\\begin_inset Tabular", i)

         if i == -1:
             return
         if i == -1:
             return

-        j = find_end_of_inset(file.body, i + 1)
+        j = find_end_of_inset(document.body, i + 1)

         if j == -1:
         if j == -1:

-            file.warning("Malformed LyX file: Could not find end of tabular.")
+            document.warning("Malformed LyX document: Could not find end of tabular.")

             continue
         for k in range(i, j):
             continue
         for k in range(i, j):

-            if re.search('^<features.* booktabs="true".*>$', file.body[k]):
-                file.warning("Converting 'booktabs' table to normal table.")
-                file.body[k] = replace(file.body[k], ' booktabs="true"', '')
-            if re.search(re_row, file.body[k]):
-                file.warning("Removing extra row space.")
-                file.body[k] = re_tspace.sub('', file.body[k])
-                file.body[k] = re_bspace.sub('', file.body[k])
-                file.body[k] = re_ispace.sub('', file.body[k])
+            if re.search('^<features.* booktabs="true".*>$', document.body[k]):
+                document.warning("Converting 'booktabs' table to normal table.")
+                document.body[k] = replace(document.body[k], ' booktabs="true"', '')
+            if re.search(re_row, document.body[k]):
+                document.warning("Removing extra row space.")
+                document.body[k] = re_tspace.sub('', document.body[k])
+                document.body[k] = re_bspace.sub('', document.body[k])
+                document.body[k] = re_ispace.sub('', document.body[k])

         i = i + 1
 
 
         i = i + 1
 
 


@@ -215,6 +221,7 @@ def revert_booktabs(file):
 # Conversion hub
 #
 
 # Conversion hub
 #
 

+supported_versions = ["1.5.0svn","1.5"]

 convert = [[246, []],
            [247, [convert_font_settings]],
            [248, []]]
 convert = [[246, []],
            [247, [convert_font_settings]],
            [248, []]]

diff --git a/lib/lyx2lyx/profiling.py b/lib/lyx2lyx/profiling.py
index d249675a146b047626ec23e481fba46ce536f264..b97bc22d1b5cf9bdc163099a3d2fb984ca040467 100755 (executable)
--- a/lib/lyx2lyx/profiling.py
+++ b/lib/lyx2lyx/profiling.py
@@ -1,6 +1,6 @@
 #! /usr/bin/env python
 #! /usr/bin/env python

-# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2004 José Matos <jamatos@lyx.org>
+# -*- coding: utf-8 -*-
+# 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
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License