lyx2lyx: lyx2lyx: lyx_1_6.py, parser_tools.py:

   add some comments

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

diff --git a/lib/lyx2lyx/lyx_1_6.py b/lib/lyx2lyx/lyx_1_6.py
index 8b09eff90a1e06118b433a051d84178288c84a8b..0ee1e42ba281069add549e5478f2492fc9527a95 100644 (file)
--- a/lib/lyx2lyx/lyx_1_6.py
+++ b/lib/lyx2lyx/lyx_1_6.py
@@ -486,20 +486,22 @@ def revert_pdf_options(document):
 
         # write to the preamble when hyperref was used
         if hyperref == True:
-            #preamble write preparation
+            # preamble write preparations
+            # bookmark numbers are only output when they are turned on
             if bookmarksopen == ',\n bookmarksopen=true':
                 bookmarksopen = bookmarksopen + bookmarksopenlevel
             if bookmarks == ',\n bookmarks=true':
                 bookmarks = bookmarks + bookmarksnumbered + bookmarksopen
             else:
                 bookmarks = bookmarks
+            # hypersetup is only output when there are things to be set up
             setupstart = '\\hypersetup{%\n'
             setupend = ' }\n'
             if otheroptions == "" and title == "" and  author == ""\
                and  subject == "" and keywords == "":
                 setupstart = ""
                 setupend = ""
-            #write the preamble
+            # write the preamble
             add_to_preamble(document,
                                 ['% Commands inserted by lyx2lyx for PDF properties',
                                  '\\usepackage[unicode=true'

diff --git a/lib/lyx2lyx/parser_tools.py b/lib/lyx2lyx/parser_tools.py
index 7a6d56e09848b54f4ea5ecedb956f3764fb0b2f2..9b63e00fd1f30b1424edee359e61e4fa87563bd9 100644 (file)
--- a/lib/lyx2lyx/parser_tools.py
+++ b/lib/lyx2lyx/parser_tools.py
@@ -160,7 +160,8 @@ def get_value_string(lines, token, start, end = 0, trim = False, default = ""):
     """ get_value_string(lines, token, start[[, end], trim, default]) -> string
 
     Return tokens after token as string, in lines, where
-    token is the first element."""
+    token is the first element. When trim is used, the first and last character
+    of the string is trimmed."""
 
     i = find_token_exact(lines, token, start, end)
     if i == -1: