Changeset 98895 in vbox for trunk/doc

Timestamp:

Mar 9, 2023 5:08:20 PM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

156231

Message:

Docs: bugref:10302. Some refactoring.

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (4 diffs)
• correct_references.py (modified) (3 diffs)

trunk/doc/manual/Makefile.kmk

@@ -857 +857 @@
  #    using refsect2_to_refsect1.py.
  #  - convert man_VBox???.xml files into dita files
+ #  - mark external link in the man_VBox????.dita files
  #  - correct all reference targets by calling correct_references.py.
  #
  ##########################################################################################
+
+ VBOX_USER_MANUAL_DITA_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)
+ VBOX_USER_MANUAL_DITA_IMAGES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)
+
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap:
+        $(QUIET)$(MKDIR) -p  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
+        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/dita/UserManual.ditamap "$(@D)"
+        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_FILES) "$(@D)/topics"
+        $(QUIET)touch -- "$(@D)/topics/reference.dtd"
+        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_IMAGES) "$(@D)/topics/images"
+
+correct_reference_targets: \
+                $$(VBOX_PATH_MANUAL_SRC)/correct_references.py \
+                $$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/ \
+                $$(VBOX_REFENTRY_DITA_FILES)
+                $(call MSG_L1,correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics)
+                $(QUIET)$(VBOX_BLD_PYTHON) $(VBOX_PATH_MANUAL_SRC)/correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics
+
+dita_common: \
+                $$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
+                $$(VBOX_DITA_PATH) \
+        correct_reference_targets
+                $(call MSG_L1, Running common dita steps)
 
  ##########################################################################################
@@ -918 +942 @@
         --
 
- VBOX_USER_MANUAL_DITA_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)
- VBOX_USER_MANUAL_DITA_IMAGES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)
-
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap:
-        $(QUIET)$(MKDIR) -p  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
-        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_PATH_MANUAL_SRC)/en_US/dita/UserManual.ditamap "$(@D)"
-        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_FILES) "$(@D)/topics"
-        $(QUIET)touch -- "$(@D)/topics/reference.dtd"
-        $(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_USER_MANUAL_DITA_IMAGES) "$(@D)/topics/images"
-
  define def_ditamap_to_pdf
   ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
@@ -934 +948 @@
                 $$(VBOX_MANUAL_XML_FILES_COMMON) \
                 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
-                $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
-                $(VBOX_DITA_PATH) \
-                $(VBOX_REFENTRY_DITA_FILES) \
-                $$(VBOX_PATH_MANUAL_SRC)/correct_references.py
-                $$(call MSG_L1,correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics)
-                $$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics
+                dita_common
                 $(QUIET)$(call VBOX_DITA_ENV_SETUP) \
                 $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
@@ -1051 +1060 @@
   ditamap-to-htmlhelp: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp
   $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp: \
-                $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
-                $(VBOX_DITA_PATH) \
-                $(VBOX_REFENTRY_DITA_FILES) \
-                $$(VBOX_PATH_MANUAL_SRC)/correct_references.py
-                $$(call MSG_L1,correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics)
-                $$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/correct_references.py -d $(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics
+                dita_common
                 $(QUIET)$(call VBOX_DITA_ENV_SETUP) \
                 $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \

trunk/doc/manual/correct_references.py

@@ -100 +100 @@
                             if id not in xref_dictionary:
                                 xref_dictionary[id] = os.path.basename(file)
+                                print("%s %s" % (id, os.path.basename(file)))
                             else:
                                 logging.warning('Non unique topic/section id %s in file %s. This is already found in %s'
@@ -128 +129 @@
     vboxmanage_dita_files = glob.glob(ditafolder + "/man_V*dita")
     for file in vboxmanage_dita_files:
+        print(file)
         file_handle = open(file, 'r', encoding="utf-8")
         file_content = file_handle.readlines()
@@ -135 +137 @@
         file_handle.write("".join(file_content))
         file_handle.close()
-
 if __name__ == "__main__":
     main()