VirtualBox

Changeset 99047 in vbox for trunk/doc/manual


Ignore:
Timestamp:
Mar 19, 2023 12:45:46 PM (22 months ago)
Author:
vboxsync
Message:

manual/Makefile.kmk: Move a few things around a bit, no actual changes. bugref:10302

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r99045 r99047  
    114114VBOX_DOC_XIDL_SRC      = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
    115115VBOX_DOC_XIDL_SRC_TMP  = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
     116
     117
     118##
     119# Copies DITA-OT to $1, runs the dost.jar with /ditadir given and nukes $1 when done.
     120#
     121# Additional options for dost.jar can be specified following the call to VBOX_DITA_RUN_DOST
     122#
     123# @param 1    Temporary+unique DITA-OT path.
     124# @param 2    Additional kmk_redirect options.
     125#
     126VBOX_DITA_RUN_DOST ?= $(REDIRECT) \
     127        -E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
     128        -E 'ANT_HOME=$1/tools/ant' \
     129        -E 'DITA_DIR=$1' \
     130        -E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
     131        -A 'PATH=$(HOST_PATH_SEP)$1/tools/ant/bin' \
     132        -E 'CLASSPATH=$1/lib/dost.jar' \
     133        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib' \
     134        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/commons-codec-1.4.jar' \
     135        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/resolver.jar' \
     136        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/icu4j.jar' \
     137        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xercesImpl.jar' \
     138        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xml-apis.jar' \
     139        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9.jar' \
     140        -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9-dom.jar' \
     141        $2 \
     142        -- $(ASH) $(VBOX_PATH_MANUAL_SRC)/dita-ot-copy-exec.sh "$(VBOX_DITA_ORIGINAL_PATH)" "$1" \
     143        -- $(VBOX_JAVA) -jar "$1/lib/dost.jar" "/ditadir:$1" # "/outercontrol:fail" ?
    116144
    117145
    … …  
    332360VBox-docs-usermanual-l10n_INST = $(INST_BIN)
    333361VBox-docs-usermanual-l10n_MODE = a+r,u+w
    334 VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
     362VBox-docs-usermanual-l10n_SOURCES = \
     363        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
    335364
    336365#
    … …  
    426455
    427456
    428  ##########################################################################################
    429  #
    430  #  UserManual.pdf
    431  #
    432  ##########################################################################################
    433 
    434  # Useful aliases
    435  usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
    436 
    437 
    438457 #
    439458 # SDKRef.pdf
    … …  
    596615        $(QUIET)$(RM) -f $@
    597616        $(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
    598 
    599 
    600  ##########################################################################################
    601  #
    602  #  UserManual.html
    603  #
    604  ##########################################################################################
    605 
    606  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
    607                 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
    608         $(call MSG_L1,Packing documentation $@)
    609         $(QUIET)$(RM) -f $@
    610         $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
    611                 -9 -r $@ html-chunks
    612 
    613  $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
    614                 $(VBOX_PATH_MANUAL_OUTBASE)/dita_common
    615         $(call MSG_L1,Building html chunks $@)
    616         $(QUIET)$(RM) -Rf -- "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks/"
    617         $(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks) \
    618                 "/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
    619                 "/transtype:xhtml" \
    620                 "/outdir:$(@D)" \
    621                 "/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml"
    622 
    623  # disable for now
    624  ## bird: Remove @chunk attrib from Glossary.dita topicref and add chunk="to-content" to bootmap for single html experiments.
    625  ##       See https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
    626  ##       and https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
    627  ##       for further clues.
    628  #html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
    629 
    630  html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
    631  qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
    632  html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
    633617
    634618
    … …  
    753737 ##########################################################################################
    754738 #
     739 #  UserManual.html
     740 #
     741 ##########################################################################################
     742
     743 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
     744                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
     745        $(call MSG_L1,Packing documentation $@)
     746        $(QUIET)$(RM) -f $@
     747        $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
     748                -9 -r $@ html-chunks
     749
     750 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
     751                $(VBOX_PATH_MANUAL_OUTBASE)/dita_common
     752        $(call MSG_L1,Building html chunks $@)
     753        $(QUIET)$(RM) -Rf -- "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks/"
     754        $(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks) \
     755                "/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
     756                "/transtype:xhtml" \
     757                "/outdir:$(@D)" \
     758                "/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml"
     759
     760 # disable for now
     761 ## bird: Remove @chunk attrib from Glossary.dita topicref and add chunk="to-content" to bootmap for single html experiments.
     762 ##       See https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
     763 ##       and https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
     764 ##       for further clues.
     765 #html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
     766
     767 html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
     768 qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
     769 html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
     770
     771
     772 ##########################################################################################
     773 #
    755774 #  Use DITA-OT to create pdf/hhp out of UserManual.ditamap. See usermanual.pdf under
    756775 #  DITA-OT-xxxxx/doc folder for details.
    757776 #
    758777 ##########################################################################################
    759  ## Copies DITA-OT to $1, runs the dost.jar with /ditadir given and nukes $1 when done.
    760  ##
    761  ## Additional options for dost.jar can be specified following the call to VBOX_DITA_RUN_DOST
    762  ##
    763  ## @param 1    Temporary+unique DITA-OT path.
    764  ## @param 2    Additional kmk_redirect options.
    765  VBOX_DITA_RUN_DOST ?= $(REDIRECT) \
    766         -E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
    767         -E 'ANT_HOME=$1/tools/ant' \
    768         -E 'DITA_DIR=$1' \
    769         -E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
    770         -A 'PATH=$(HOST_PATH_SEP)$1/tools/ant/bin' \
    771         -E 'CLASSPATH=$1/lib/dost.jar' \
    772         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib' \
    773         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/commons-codec-1.4.jar' \
    774         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/resolver.jar' \
    775         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/icu4j.jar' \
    776         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xercesImpl.jar' \
    777         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xml-apis.jar' \
    778         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9.jar' \
    779         -A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9-dom.jar' \
    780         $2 \
    781         -- $(ASH) $(VBOX_PATH_MANUAL_SRC)/dita-ot-copy-exec.sh "$(VBOX_DITA_ORIGINAL_PATH)" "$1" \
    782         -- $(VBOX_JAVA) -jar "$1/lib/dost.jar" "/ditadir:$1" # "/outercontrol:fail" ?
    783778
    784779
    … …  
    805800 endef
    806801 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
     802
     803 # Useful aliases
     804 usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
    807805
    808806 #
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette