Changeset 99021 in vbox for trunk/doc/manual/Config.kmk

Timestamp:

Mar 17, 2023 5:04:47 PM (2 years ago)

Author:

vboxsync

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

156379

Message:

manual: Updated docs for xref-to-text.xsl rule and removed a temporary file it now uses. bugref:10302

File:

• trunk/doc/manual/Config.kmk (modified) (3 diffs)

trunk/doc/manual/Config.kmk

@@ -369 +369 @@
 
 
- ## Emit rules to produce stylesheet for translating cross references (xref)
+ ## Emit rules to produce a stylesheet for translating cross references (xref)
  # to user manual chapters and sections in the man pages and --help output.
  #
- # Note! This requires processing UserManual.xml as a single document in order
- #       to get the correct chapter and section numbering, so we use a catalog
- #       file to replace the generated XML documents it includes with a dummy
- #       one.  This reduces the dependencies and recipies we require to build
- #       VBoxManage and the RTIsoMaker (w/ derivatives).
+ # Note! This is a bit hackish, as it only processes the checked in .dita files
+ #       and not the processed result nor stuff we generated.  Seems like all
+ #       we generate is manpage related pages, so that's fine since these are
+ #       all currently at the tail of one chapter in the manual.
+ #
+ #       If it turns out we generate more stuff that this, we're in for lots of
+ #       dependency fun with VBoxManage and the RTIsoMaker (+ derivatives).
+ #
  # $(evalcall2 def_vbox_xref_to_text)
  # @param    1   Language code.
@@ -403 +406 @@
         $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
                 --output "[email protected]" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" $$(filter %.ditamap,$$^)
-  #     $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
-#               --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
-#               --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
-#               --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
-#               --output "[email protected]" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" "[email protected]"
+  if 0 # Enable to see the full combined document.
+        $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
+                --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
+                --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/bookmap/dtd" \
+                --path "$(VBOX_DITA_ORIGINAL_PATH)/dtd/technicalContent/dtd" \
+                --output "[email protected]" "$$(VBOX_PATH_MANUAL_SRC)/ditamap-to-single-xml.xsl" "[email protected]"
+  endif
         $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT,,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT).cat) \
                 --path "$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/topics" \
@@ -421 +426 @@
                         "$$<" "$$(VBOX_PATH_MANUAL_SRC)/en_US/$$(x)")
         $$(QUIET)$$(APPEND) -n "$$@" '' '</xsl:stylesheet>'
+        $$(QUIET)$$(RM) -f -- "[email protected]"
 
   BLDDIRS += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/