Changeset 99157 in vbox for trunk

Timestamp:

Mar 23, 2023 11:07:27 PM (22 months ago)

Author:

vboxsync

Message:

manual: Switched to the new refentry to dita converter. bugref:10302

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (8 diffs)
• docbook-refentry-to-manual-dita.xsl (modified) (1 diff)
• mark_external_urls.xsl (deleted)
• refsect2_to_refsect1.py (deleted)

trunk/doc/manual/Makefile.kmk

@@ -394 +394 @@
 
 
- ##
- # Create user_isomakercmd-man.xml
- #
- # @param    1  Language.
- # @param    2  the refentry xml base file name.
- # @param    3  the full refentry xml file path.
- define def_vbox_refentry_to_user_sect1
-  $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
-                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
-                $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
-                $$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
-        $$(call MSG_TOOL,xsltproc docbook-refentry-to-manual-sect1.xsl,,$3,$$@)
-        $$(QUIET)$$(RM) -f -- "$$@"
-        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
- endef
-
- $(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES) \
-        ,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
-
-
  #
  # Shared rules for LaTeX based PDF generation - Only used for SDK & Accessibility.
@@ -629 +609 @@
         $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/, \
         $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
-        $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) \
-        topics/reference.dtd)
+        $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) )
 
   ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)),)
@@ -645 +624 @@
         $$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
   endif
-
-  # Create and empty reference.dtd file as docbook2dita converter mentions it in xml declaration and
-  # xlst parsing complains when it cannot find it.
-  $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/topics/reference.dtd: | $$$$(dir $$$$@)
-        $$(QUIET)$$(TOUCH) -- "$$@"
 
  endef
@@ -693 +667 @@
         $$(QUIET)$$(VBOX_BLD_PYTHON) "$$<" --output "$$@" @"[email protected]"
 
-  # We must copy over the man_VBoxManage-dhcpserver-dhcpoptions.xml include
-  # file, so that xsltproc can easily find it when running docbook2dita.xsl.
-  $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml: \
-                $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/man_VBoxManage-dhcpserver-dhcpoptions.xml) \
-                        $$(VBOX_PATH_MANUAL_SRC)/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml) | $$$$(dir $$$$@)
-        $$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
-
   # Accumulated list of conversion output file names to be used as a
   # prerequisite in rules producing a version of the user manual.
-  VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 := \
-        $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/topics/user_isomakercmd-man.dita
-
-  # Unlike other refentry docbook files user_isomakercmd-man.xml is located
-  # in the output folder thus a special target for its conversion. Note that
-  # user_isomakercmd-man.xml does not have refsect hierarchy and hrefs to be pre/post
-  # processed. So we skip these steps for this file.
-  $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/topics/user_isomakercmd-man.dita: \
-                $$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
-                $$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml | $$$$(dir $$$$@)
-        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
-                --maxdepth 6000 \
-                --output "$$@" \
-                "$$<" \
-                $$(VBOX_PATH_MANUAL_OUTBASE)/$1/user_isomakercmd-man.xml
+  VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 :=
+
  endef # def_vbox_refentry_to_dita
 
@@ -722 +676 @@
  # @param 1    Language
  # @param 2    Filename w/o extension.
+ # @param 3    Alternative fallback filename (for isomakercmd-man.xml).
  define def_vbox_refentry_file_to_dita
   VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita
   $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita \
   + $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml: \
-                $$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
-                $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
-                $$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl \
+                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
+                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
                 $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
                 $$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1) \
-                $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml \
+                $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
                 $$(VBOX_XML_CATALOG) \
                 $$(VBOX_XML_CATALOG_DOCBOOK) \
@@ -738 +692 @@
                 $$(VBOX_VERSION_STAMP) \
                 | $$$$(dir $$$$@)
-        $$(call MSG_TOOL,xsltproc docbook2dita.xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
-        $$(QUIET)$$(RM) -f "$$@"
-        $$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/refsect2_to_refsect1.py \
-                -i $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
-                -o "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml"
-        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
-                "$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl" \
+        $$(call MSG_TOOL,xsltproc docbook-refentry-to-manual-dita[-pre].xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
+        $$(QUIET)$$(RM) -f -- "$$@" "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml"
+        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
+                --output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml" \
+                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
+                $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml)
+        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
+                --output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita" \
+                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
                 "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml"
-        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
-                "$$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl" "$$@"
         $$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
                 --mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1)" "$$@"
@@ -755 +709 @@
         ,$(evalcall2 def_vbox_refentry_to_dita,$(lang)) \
         $(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount man_VBoxHeadless) \
-                ,$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),$(file))))
+                ,$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),$(file))) \
+        $(evalcall2 def_vbox_refentry_file_to_dita,$(lang),user_isomakercmd-man, \
+                $(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
+
+ ## @todo Make use of docbook-refentry-to-manual-overview.xsl again (after dita conversion)?
 
 
@@ -811 +769 @@
                 "/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
                 "/transtype:xhtml" \
-        "/filter:$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
+                "/filter:$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
                 "/outdir:$(@D)" \
                 "/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \

trunk/doc/manual/docbook-refentry-to-manual-dita.xsl

@@ -567 +567 @@
     <xsl:attribute name="scope">external</xsl:attribute> <!-- Just assumes this is external. -->
     <xsl:attribute name="href"><xsl:value-of select="@url"/></xsl:attribute>
+    <xsl:attribute name="format">html</xsl:attribute>
+    <xsl:if test="not(starts-with(@url, 'http'))"><xsl:message terminate="yes">ulink url is not http: <xsl:value-of select="@url"/></xsl:message></xsl:if>
   </xsl:element>
 </xsl:template>