Changeset 99500 in vbox for trunk/doc/manual

Timestamp:

Apr 21, 2023 9:30:10 AM (22 months ago)

Author:

vboxsync

Message:

manual: Generate VBoxManage command overview topic from converted synopsis dita-files. bugref:10302

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (1 diff)
• en_US/dita/UserManual.ditamap (modified) (1 diff)
• en_US/vboxmanage-cmd-overview.xsl (added)
• vboxmanage-cmd-overview.xsl (added)

trunk/doc/manual/Makefile.kmk

@@ -726 +726 @@
                 "$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml"
 
-
- ## @todo Make use of docbook-refentry-to-manual-overview.xsl again (after dita conversion)?
+ #
+ # 2b. Generate the VBoxManage commands overview topic based upon the
+ #     command synopis dita files generated in the above step.
+ #
+
+ ## Convert a single refentry file to dita.
+ # @param 1    Language
+ define def_vbox_generate_vboxmanage_overview
+  VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita
+  $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita \
+  + $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita.files.xml: \
+                $$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
+                $$(VBOX_PATH_MANUAL_SRC)/vboxmanage-cmd-overview.xsl \
+                $$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1)) \
+                | $$$$(dir $$$$@)
+        $$(call MSG_TOOL,xsltproc vboxmanage-cmd-overview.dita.xsl,,,$$@)
+        $$(QUIET)$$(RM) -f -- "$$@" "[email protected]"
+        $$(APPEND) -tn "[email protected]" '<?xml version="1.0"?>' '<files>'
+        $$(SED) -n \
+                -e 's/^.*topicref .*topics\/man_VBoxManage-\([^.]*\)\.ditamap.*$$(DOLLAR)/<file>vboxmanage-\1-synopsis.dita<\/file>/p' \
+                --append "[email protected]" \
+                $(VBOX_PATH_MANUAL_SRC)/$(1)/dita/UserManual.ditamap
+        $$(APPEND) -n "[email protected]" '</files>'
+        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)" \
+                --output "$$@" \
+                $$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
+                "[email protected]"
+
+ endef # def_vbox_generate_vboxmanage_overview
+ $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_generate_vboxmanage_overview,$(lang)))
 
 

trunk/doc/manual/en_US/dita/UserManual.ditamap

@@ -375 +375 @@
       <topicref href="topics/vboxmanage-intro.dita"/>
       <!-- Commands Overview -->
-      <!--  <topicref href="topics/vboxmanage-cmd-overview.dita"/> -->
+      <topicref href="topics/vboxmanage-cmd-overview.dita"/>
       <topicref href="topics/vboxmanage-general.dita"/>
       <!-- The remainder of the topics in this chapter are generated from docbook XML files.-->
-      <topicref  format="ditamap" href="topics/man_VBoxManage-common.ditamap"/>
+      <topicref format="ditamap" href="topics/man_VBoxManage-common.ditamap"/>
       <!-- Note! We sort these alphabetical unless someone can define a
                  maintainable ordering (previously it seemed to be total