Changeset 98678 in vbox for trunk/doc/manual/htmlhelp-qthelp.py

Timestamp:

Feb 21, 2023 3:39:02 PM (22 months ago)

Author:

vboxsync

Message:

Docs: bugref:10302. A small modification in htmlhelp-qthelp script to get TOC and list file names as command line arguments.

File:

• trunk/doc/manual/htmlhelp-qthelp.py (modified) (8 diffs)

trunk/doc/manual/htmlhelp-qthelp.py

@@ -17 +17 @@
 else:
     from HTMLParser import HTMLParser
+
 
 
@@ -91 +92 @@
     return image_files_list
 
-# open htmlhelp.hhp files and read the list of html files from there
-def create_html_list(folder):
+# open files list and read the list of html files from there
+def create_html_list(folder, list_file):
     global html_files
-    file_name = 'htmlhelp.hhp'
     html_file_lines = []
-    if not file_name in os.listdir(folder):
-        logging.error('Could not find the file "%s" in "%s"', file_name, folder)
+    if not list_file in os.listdir(folder):
+        logging.error('Could not find the file "%s" in "%s"', list_file, folder)
         return html_file_lines
-    full_path = os.path.join(folder, 'htmlhelp.hhp')
+    full_path = os.path.join(folder, list_file)
     file = codecs.open(full_path, encoding='iso-8859-1')
 
@@ -118 +118 @@
 
 
-def create_files_section(folder):
+def create_files_section(folder, list_file):
     files_section_lines = ['<files>']
     files_section_lines += create_image_list(folder)
-    files_section_lines += create_html_list(folder)
+    files_section_lines += create_html_list(folder, list_file)
     files_section_lines.append('</files>')
     return files_section_lines
@@ -188 +188 @@
     return result
 
-# parse toc.hhc file. assuming all the relevant information
+# parse TOC file. assuming all the relevant information
 # is stored in tags and attributes. whatever is outside of
 # <... > pairs is filtered out. we also assume < ..> are not nested
 # and each < matches to a >
-def create_toc(folder):
-    toc_file = 'toc.hhc'
+def create_toc(folder, toc_file):
+    toc_string_list = []
     content = [x[2] for x in os.walk(folder)]
     if toc_file not in content[0]:
@@ -219 +219 @@
     # content = re.sub(r'>.*?<', r'>\n<', content)
     # lines = content.split('\n')
-    toc_string_list = ['<toc>']
+    toc_string_list.append('<toc>')
     index = 0
     for tag in tag_list:
@@ -238 +238 @@
     helphtmlfolder = ''
     output_filename = ''
+    list_file = ''
+    toc_file = ''
     try:
-        opts, args = getopt.getopt(sys.argv[1:],"hd:o:")
+        opts, args = getopt.getopt(sys.argv[1:],"hd:o:f:t:")
     except getopt.GetoptError as err:
         print(err)
@@ -248 +250 @@
         elif opt in ("-d"):
             helphtmlfolder = arg
+            print(helphtmlfolder)
+        elif opt in ("-f"):
+            list_file = arg
+        elif opt in ("-t"):
+            toc_file = arg
+            print(toc_file)
         elif opt in ("-o"):
              output_filename = arg
@@ -270 +278 @@
                      '<virtualFolder>doc</virtualFolder>', \
                      '<filterSection>']
-    out_xml_lines += create_toc(helphtmlfolder) + create_files_section(helphtmlfolder)
+    out_xml_lines += create_toc(helphtmlfolder, toc_file) + create_files_section(helphtmlfolder, list_file)
     out_xml_lines += create_keywords_section(helphtmlfolder)
     out_xml_lines += ['</filterSection>', '</QtHelpProject>']