VirtualBox

Changeset 98932 in vbox for trunk/doc


Ignore:
Timestamp:
Mar 13, 2023 1:04:22 PM (2 years ago)
Author:
vboxsync
Message:

Docs: Removing CHM related bits.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/Makefile.kmk

    r98901 r98932  
    3232#   -- UserManual.pdf, generated by LaTex
    3333#
    34 #   -- VirtualBox.chm
    3534#
    3635#   Both files end up in PATH_STAGE_BIN.
     
    5150#      generate PDF.
    5251#
    53 #   -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
    54 #      xsltproc to create a .HHP file for the Microsoft Help Compiler, then
    55 #      feed that file to it.
    5652#
    5753
     
    155151 endif
    156152
    157  ifdef VBOX_WITH_DOCS_CHM
    158   INSTALLS += VBox-docs-usermanual-chm
    159   VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
    160  else  # Do not build chm.
    161   VBOX_PATH_BIN_CHM =
    162  endif
    163 
    164153 ifdef VBOX_WITH_DOCS_QHELP
    165154  INSTALLS += VBox-docs-usermanual-qhc
     
    198187   VBOX_MANUAL_PACK += \
    199188        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
    200    ifdef VBOX_WITH_DOCS_CHM
    201     INSTALLS += VBox-docs-usermanual-l10n-chm
    202     VBOX_MANUAL_PACK += \
    203         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    204    endif
    205189  endif
    206190 endif # !VBOX_ONLY_SDK
     
    723707        $(QUIET)$(MV) -f [email protected] $@
    724708
    725 
    726  ifdef VBOX_WITH_DOCS_CHM
    727   #
    728   # VirtualBox.chm
    729   #
    730   # We first generate a .hhp help source file from the preprocessed
    731   # DocBook XML files, as defined above, then feed that into the
    732   # Microsoft Help Compiler.
    733 
    734   # Generate CHM from HHP
    735   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    736   define def_vbox_usermanual_hhp_to_chm
    737    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
    738    $$(out_dir)/VirtualBox.chm: \
    739                 $$(out_dir)/HTMLHelp/htmlhelp.hhp \
    740                 $$(addprefix $$(out_dir)/HTMLHelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
    741                 | $$$$(dir $$$$@)
    742         $$(call MSG_L1,hhc $$<,=> $$@)
    743         $$(QUIET)$$(RM) -f $$@
    744         $$(QUIET)$$(VBOX_HHC) $$(subst /,\\,$$<)
    745         $$(call MSG_L1,Fresh CHM is now at $$@)
    746   endef
    747   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_to_chm))
    748 
    749   # Generate HHP from XML
    750   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    751   define def_vbox_usermanual_xml_to_hhp
    752    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
    753    $$(out_dir)/HTMLHelp/htmlhelp.hhp: \
    754                 $$(addprefix $$(VBOX_PATH_MANUAL_SRC)/$(lang)/,$$(VBOX_MANUAL_XML_FILES)) \
    755                 $$(VBOX_MANUAL_XML_FILES_COMMON) \
    756                 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
    757                 $$(VBOX_DOCBOOK_HTMLHELP_FORMATCFG) \
    758                 $$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
    759                 $$(if $$(VBOX_HAVE_XMLLINT),$$(out_dir)/validatemanual.run,) \
    760                 $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
    761                 $$(VBOX_XML_ENTITIES) | $$$$(dir $$$$@)
    762         $$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
    763         $$(QUIET)$$(RM) -f $$@
    764         $$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$(@D)/ \
    765                 --stringparam htmlhelp.chm \
    766                 $$(subst /,\\,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/VirtualBox.chm) \
    767                 $$(HTMLHELPOPTS) $$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
    768                 $$<
    769   endef
    770   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_xml_to_hhp))
    771 
    772   # copy the PNG files.
    773   # Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
    774   define def_vbox_cp_images_htmlhelp
    775    local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
    776    $(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
    777                 $$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
    778         $$(call MSG_L1,Copying temporary $$< => $$@)
    779         $$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
    780   endef
    781   $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_htmlhelp)))
    782 
    783  endif # VBOX_WITH_DOCS_CHM
    784 
    785 
    786709 # Packing the docs into a zip file
    787710 $(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
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