Changeset 98897 in vbox

Timestamp:

Mar 9, 2023 5:39:48 PM (21 months ago)

Author:

vboxsync

Message:

Docs: bugref:10302. First take on migrating html creation to dita. missing some parts.

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (5 diffs)
• correct_references.py (modified) (2 diffs)

trunk/doc/manual/Makefile.kmk

@@ -479 +479 @@
  ##########################################################################################
 
- ifdef PDF_FROM_LATEX
+ ifdef TO_BE_REMOVED
   # Generate PDF from LaTeX
   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
@@ -501 +501 @@
   endef
   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_tex_to_pdf))
- endif
+ endif # TO_BE_REMOVED
 
  # Generate LaTeX from XML
@@ -791 +791 @@
  #
  ##########################################################################################
- VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
-        $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
-        $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
-        $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
-
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
-                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
-                $(VBOX_MANUAL_XML_FILES_COMMON) \
-                $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
-                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
-                $(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
-                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
-                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
-                $(VBOX_XML_ENTITIES) | $$(dir $$@)
+
+ ifdef TO_BE_REMOVED
+  VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG = \
+        $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
+        $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
+        $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
+
+  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
+                $(VBOX_MANUAL_XML_FILES_COMMON) \
+                $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
+                $(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
+                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
+                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
+                $(VBOX_XML_ENTITIES) | $$(dir $$@)
         $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
@@ -811 +813 @@
                 $<
 
- VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
-        $(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
-        $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
-        $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
-
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
-                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
-                $(VBOX_MANUAL_XML_FILES_COMMON) \
-                $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
-                $(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
-                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
-                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
-                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
-                $(VBOX_XML_ENTITIES) | $$(dir $$@)
+  VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG = \
+        $(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl \
+        $(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
+        $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
+
+  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_FILES)) \
+                $(VBOX_MANUAL_XML_FILES_COMMON) \
+                $(VBOX_MANUAL_XML_FILES_GENERATED_en_US) \
+                $(VBOX_DOCBOOK_HTML_CHUNKS_FORMATCFG) \
+                $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
+                $(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatemanual.run,) \
+                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
+                $(VBOX_XML_ENTITIES) | $$(dir $$@)
         $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
         $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
@@ -832 +834 @@
                 $<
 
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
-                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
-                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
-                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
+  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
+                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
+                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
+                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
         $(call MSG_L1,Packing documentation $@)
         $(QUIET)$(RM) -f $@
         $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
                 -9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
-
- html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
+ endif # TO_BE_REMOVED
+
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
+                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
+        $(call MSG_L1,Packing documentation $@)
+        $(QUIET)$(RM) -f $@
+        $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
+                -9 -r $@ html-single html-chunks
+
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
+                $$(VBOX_MANUAL_XML_FILES_COMMON) \
+                dita_common
+                $(QUIET)$(call VBOX_DITA_ENV_SETUP) \
+                $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar /i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
+                        /transtype:xhtml /ditadir:$(VBOX_DITA_PATH) /outdir:$(@D) /tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp
+
+ # disable for now
+ #html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
  html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
  qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))

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'
@@ -136 +135 @@
         file_handle.write("".join(file_content))
         file_handle.close()
+
 if __name__ == "__main__":
     main()