Changeset 99168 in vbox for trunk/doc

Timestamp:

Mar 24, 2023 9:21:19 AM (21 months ago)

Author:

vboxsync

Message:

Docs: bugref:10302. Some more comment fixes.

File:

• trunk/doc/manual/Makefile.kmk (modified) (1 diff)

trunk/doc/manual/Makefile.kmk

@@ -27 +27 @@
 
 #
-# This slightly messy makefile transforms the DocBook XML source for the
-# user manual into presentation output. We support two targets:
+# This makefile produces our user manual (among a few other things) in
+# 3 formats: qHelp, pdf, and html (chunked and single page). User manual
+# files are kept in dita format. VBoxManage commands are documented using docbook
+# refentry elements and integrated into VBoxManage binary after converting those
+# to .cpp and .h files (not here). Additionally, we add these refentry's into the
+# user manual as a chapter after converting them into dita files. Both the user manual
+# and converted VBoxManage commands files are referenced with a single ditamap.
+# This ditamap is then transformed into html, htmlhelp (for qHelp), and pdf.
 #
-#   -- UserManual.pdf, generated by LaTex
-#
-#
-#   Both files end up in PATH_STAGE_BIN.
-#
-#   Both targets indirectly depend on the XML files in this directory;
-#   "indirectly" because we first copy them to PATH_TARGET and hack them
-#   up a bit for variable substitution and such (see below).
-#   The toolchains are roughly like this:
-#
-#   -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
-#      then create a .FO file (another XML format for "formatted objects")
-#      via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
-#
-#   -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
-#      run our custom "dblatex" perl script on UserManual.xml, which parses
-#      the XML (using the Perl SAX parsers) and dumps a matching LaTeX file
-#      to UserManual.tex. This is then regularly processed by pdflatex to
-#      generate PDF.
-#
-#
+
 
 SUB_DEPTH = ../..