Changeset 105199 in vbox for trunk/doc

Timestamp:

Jul 8, 2024 6:33:43 PM (7 months ago)

Author:

vboxsync

Message:

Docs: bugref:10705. Add ZIP containing generated DITA files for the DocBook changelog topics.

Location:

trunk/doc/manual

Files:

• Makefile.kmk (modified) (7 diffs)
• docbook-changelog-to-manual-dita.sh (modified) (5 diffs)

trunk/doc/manual/Makefile.kmk

@@ -264 +264 @@
         $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip \
         $(PATH_STAGE_BIN)/RefEntryDITA.zip \
+        $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip \
+        $(PATH_STAGE_BIN)/ChangeLogDITA.zip \
         $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip \
         $(PATH_STAGE_BIN)/UserManual-html.zip \
@@ -339 +341 @@
   ifdef VBOX_WITH_DOCS_USERMANUAL_REFENTRY_DITA
    #
-   # target for installing the chunked HTML docs
+   # target for installing the ZIP containing the manpages in DITA format
    #
    INSTALLS += VBox-docs-usermanual-refentry-dita
@@ -346 +348 @@
    VBox-docs-usermanual-refentry-dita_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
    VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/RefEntryDITA.zip
+  endif
+
+  ifdef VBOX_WITH_DOCS_USERMANUAL_CHANGELOG_DITA
+   #
+   # target for installing the ZIP containing the change log in DITA format
+   #
+   INSTALLS += VBox-docs-usermanual-changelog-dita
+   VBox-docs-usermanual-changelog-dita_INST = $(INST_BIN)
+   VBox-docs-usermanual-changelog-dita_MODE = a+r,u+w
+   VBox-docs-usermanual-changelog-dita_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip
+   VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/ChangeLogDITA.zip
   endif
 
@@ -760 +773 @@
 
  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip: \
-                $(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
+                $(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US) \
+                $(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US) \
+                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/vboxmanage-cmd-overview.dita
         $(call MSG_L1,Packing documentation $@)
         $(QUIET)$(RM) -f $@
         $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
                 -9 -r "$@" \
-                $(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)) \
-                $(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US))
+                $(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$^)
 
  refentry-dita-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
@@ -811 +825 @@
  define def_vbox_convert_changelog_to_dita
   VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap
-  $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap: \
+  $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap \
+  + $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap.kmk: \
                 $$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
                 $$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
@@ -824 +839 @@
                 $$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml \
                 $$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
+                $$(@).kmk \
+                VBOX_USER_MANUAL_CONVERTED_CHANGELOG_DITA_FILES_$(1) \
                 $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics \
                 -- \
@@ -829 +846 @@
  endef # def_vbox_convert_changelog_to_dita
  $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_convert_changelog_to_dita,$(lang)))
+
+ ifdef VBOX_ONLY_DOCS
+  include $(VBOX_PATH_MANUAL_OUTBASE)/changelog.kmk
+
+  $(VBOX_PATH_MANUAL_OUTBASE)/changelog.kmk: \
+                $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
+                        ,$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/changelog-versions.ditamap.kmk)
+        $(QUIET)$(RM) -f -- "$@"
+        $(APPEND) -tn "$@" '# changelog.kmk'
+        $(APPEND) -n "$@" $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),'include $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/changelog-versions.ditamap.kmk')
+        $(APPEND) -n "$@" '# done'
+
+ endif
+
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip: \
+                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/changelog-versions.ditamap \
+                $(VBOX_USER_MANUAL_CONVERTED_CHANGELOG_DITA_FILES_en_US)
+        $(call MSG_L1,Packing documentation $@)
+        $(QUIET)$(RM) -f $@
+        $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
+                -9 -r "$@" \
+                $(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$^)
+
+ changelog-dita-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip
 
 

trunk/doc/manual/docbook-changelog-to-manual-dita.sh

@@ -37 +37 @@
 #   1: user_ChangeLogImpl.xml to use as input.
 #   2: docbook-changelog-to-manual-dita.xsl
-#   3: The out directory.
-#   4: '--'
-#   5+: xsltproc invocation (sans output, input and xslt file).
+#   5: The out directory.
+#   6: '--'
+#   7+: xsltproc invocation (sans output, input and xslt file).
 #
-if test $# -lt 6; then
+if test $# -lt 8; then
     echo "syntax error: too few arguments" 1>&2;
     exit 2;
@@ -47 +47 @@
 MY_INPUT_FILE="$1"
 MY_XSLT="$2"
-MY_OUTPUT_DIR="$3"
-if test "$4" != "--"; then
-    echo "syntax error: Expected '--' as the 4th parameter, got: $4" 1>&2;
+MY_GENERATED_KMK="$3"
+MY_GENERATED_KMK_VARIABLE="$4"
+MY_OUTPUT_DIR="$5"
+if test "$6" != "--"; then
+    echo "syntax error: Expected '--' as the 6th parameter, got: $6" 1>&2;
     exit 2;
 fi
-shift 4
+shift 6
 
 if ! test -f "${MY_INPUT_FILE}"; then
@@ -76 +78 @@
 MY_TOPIC_IDS=$($* --stringparam g_sMode ids "${MY_XSLT}" "${MY_INPUT_FILE}" | ${MY_SED} -e 1d)
 
+echo "${MY_GENERATED_KMK_VARIABLE} += \\" > "${MY_GENERATED_KMK}"
+
 #
 # Extract each topic.
@@ -85 +89 @@
         --stringparam g_idTopic "${MY_ID}" \
         --output "${MY_OUTPUT_DIR}/${MY_ID}.dita" "${MY_XSLT}" "${MY_INPUT_FILE}"
+    echo "    ${MY_OUTPUT_DIR}/${MY_ID}.dita \\" >> "${MY_GENERATED_KMK}"
 done
 
@@ -91 +96 @@
 #
 $* --stringparam g_sMode map --output "${MY_OUTPUT_DIR}/changelog-versions.ditamap" "${MY_XSLT}" "${MY_INPUT_FILE}"
+echo "" >> "${MY_GENERATED_KMK}"
 exit 0