VirtualBox

Changeset 68360 in vbox


Ignore:
Timestamp:
Aug 10, 2017 8:09:43 AM (8 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
117489
Message:

Manual/Makefile.kmk: add accessibility documentation, move cleaning back to OTHER_CLEAN since that's not depending on the many conditionals controlling building of docs, and put the targets for installing in one place

Location:
trunk/doc/manual
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r68352 r68360  
    205205if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
    206206 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF)
    207   INSTALLS += VBox-sdkref-docs
    208   VBox-sdkref-docs_INST = $(INST_SDK)docs/
    209   VBox-sdkref-docs_MODE = a+r,u+w
    210   VBox-sdkref-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
    211   VBox-sdkref-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
     207  INSTALLS += VBox-docs-sdkref
    212208 endif
    213209
    214210 ifdef VBOX_WITH_DOCS_CHM
    215   INSTALLS += VBox-usermanual-chm-docs
    216   VBox-usermanual-chm-docs_INST = $(INST_BIN)
    217   VBox-usermanual-chm-docs_MODE = a+r,u+w
    218   VBox-usermanual-chm-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
    219   VBox-usermanual-chm-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
    220 
     211  INSTALLS += VBox-docs-usermanual-chm
    221212  VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
    222213 else  # Do not build chm.
    … …  
    228219                $(PATH_STAGE_BIN)/UserManual.pdf \
    229220                $(VBOX_PATH_BIN_CHM)
    230   INSTALLS += VBox-usermanual-docs
    231   VBox-usermanual-docs_INST = $(INST_BIN)
    232   VBox-usermanual-docs_MODE = a+r,u+w
    233   VBox-usermanual-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
    234   VBox-usermanual-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
     221  INSTALLS += VBox-docs-usermanual
    235222
    236223  ifdef VBOX_WITH_DOCS_TRANSLATIONS
    237    INSTALLS += VBox-usermanual-add-docs
    238    VBox-usermanual-add-docs_INST = $(INST_BIN)
    239    VBox-usermanual-add-docs_MODE = a+r,u+w
    240    VBox-usermanual-add-docs_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
    241    VBox-usermanual-add-docs_CLEAN = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf)
     224   INSTALLS += VBox-docs-usermanual-l10n
    242225   VBOX_MANUAL_PACK += \
    243226        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
    244227   ifdef VBOX_WITH_DOCS_CHM
    245     INSTALLS += VBox-usermanual-add-chm-docs
    246    VBox-usermanual-add-chm-docs_INST = $(INST_BIN)
    247    VBox-usermanual-add-chm-docs_MODE = a+r,u+w
    248    VBox-usermanual-add-chm-docs_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
    249    VBox-usermanual-add-chm-docs_CLEAN = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm)
     228    INSTALLS += VBox-docs-usermanual-l10n-chm
    250229    VBOX_MANUAL_PACK += \
    251230        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    … …  
    253232  endif
    254233 endif # !VBOX_ONLY_SDK
     234
     235 ifdef VBOX_WITH_DOCS_ACCESSIBILITY
     236  INSTALLS += VBox-docs-accessibility
     237  INSTALLS += VBox-docs-accessibility-html
     238 endif
     239
    255240 ifdef VBOX_ONLY_DOCS
    256241  PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
    … …  
    290275        SDKRef.xml
    291276
     277 VBOX_ACCESSIBILITY_XML_FILES = \
     278        Accessibility.xml
     279
    292280 # Wildcard the images path for every supported language
    293281 $(foreach f,$(VBOX_MANUAL_LANGUAGES), \
    … …  
    302290 VBOX_SDKREF_LATEX_FILES_TARGET = \
    303291        $(addprefix SDKRef.,aux log out toc tex)
     292
     293 VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
     294        $(addprefix Accessibility.,aux log out toc tex)
    304295
    305296 BLDDIRS += \
    … …  
    312303        )
    313304
     305 # Explicit cleaning has some overlap with default cleaning rules, since this
     306 # Makefile is using very complex conditionals for selectively creating
     307 # specific files, and not everyone remembers to use the same with "kmk clean".
    314308 OTHER_CLEAN += \
    315309        $(VBOX_XML_CATALOG) \
    … …  
    340334               HTMLHelp/htmlhelp.hhp \
    341335                titlepage-htmlhelp.xsl \
     336                UserManual.pdf \
     337                VirtualBox.chm \
    342338                ChangeLog.html \
    343339                validatemanual.run \
    … …  
    346342        $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
    347343        $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
    348        \
     344        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
     345        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
     346        $(PATH_STAGE_BIN)/UserManual.pdf \
     347        $(PATH_STAGE_BIN)/VirtualBox.chm \
     348        \
    349349        $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
    350350                $(VBOX_SDKREF_XML_FILES) \
    351351                $(VBOX_SDKREF_LATEX_FILES_TARGET) \
     352                SDKRef.pdf \
    352353                ) \
     354    $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
     355        \
     356        $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
     357                $(VBOX_ACCESSIBILITY_XML_FILES) \
     358                $(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
     359                html-single/Accessibility.html \
     360                Accessibility.pdf \
     361                ) \
     362        $(PATH_STAGE_BIN)/Accessibility.html \
     363        $(PATH_STAGE_BIN)/Accessibility.pdf \
     364        \
    353365        $(VBOX_DOC_XIDL_SRC_TMP) \
    354366        $(VBOX_MANUAL_APIREF_TMP)
    … …  
    356368endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
    357369
     370#
     371# target for installing UserManual.pdf
     372#
     373VBox-docs-usermanual_INST = $(INST_BIN)
     374VBox-docs-usermanual_MODE = a+r,u+w
     375VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
     376
     377#
     378# target for installing translated UserManual_*.pdf
     379#
     380VBox-docs-usermanual-l10n_INST = $(INST_BIN)
     381VBox-docs-usermanual-l10n_MODE = a+r,u+w
     382VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
     383
     384#
     385# target for installing VirtualBox.chm
     386#
     387VBox-docs-usermanual-chm_INST = $(INST_BIN)
     388VBox-docs-usermanual-chm_MODE = a+r,u+w
     389VBox-docs-usermanual-chm_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
     390
     391#
     392# target for installing translated VirtualBox_*.chm
     393#
     394VBox-docs-usermanual-l10n-chm_INST = $(INST_BIN)
     395VBox-docs-usermanual-l10n-chm_MODE = a+r,u+w
     396VBox-docs-usermanual-l10n-chm_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
     397
     398#
     399# target for installing SDKRef.pdf
     400#
     401VBox-docs-sdkref_INST = $(INST_SDK)docs/
     402VBox-docs-sdkref_MODE = a+r,u+w
     403VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
     404
     405#
     406# target for installing Accessibility.pdf
     407#
     408VBox-docs-accessibility_INST = $(INST_BIN)
     409VBox-docs-accessibility_MODE = a+r,u+w
     410VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
     411
     412#
     413# target for installing Accessibility.html
     414#
     415VBox-docs-accessibility-html_INST = $(INST_BIN)
     416VBox-docs-accessibility-html_MODE = a+r,u+w
     417VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
    358418
    359419
    … …  
    672732                $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
    673733                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
    674         $(QUIET)$(MKDIR) -p $(VBOX_PATH_SDK)/docs
    675734        $(call MSG_L1,pdflatex $< (three passes))
    676735        $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
    … …  
    687746validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.xml
    688747sdkref:: $(VBOX_PATH_SDK)/docs/SDKRef.pdf
     748
     749
     750
     751#
     752# Accessibility.pdf
     753#
     754
     755$(evalcall2 def_vbox_replace_stuff_in_xml,/en_US/Accessibility.xml,/en_US)
     756
     757# Turn Accessibility.xml into latex.
     758$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
     759                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
     760                $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
     761                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT) | $$(dir $$@)
     762        $(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
     763        $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
     764#       check it for validity first.
     765ifdef VBOX_HAVE_XMLLINT
     766        $(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
     767endif
     768#       generate TeX source from processed docbook and store it in Accessibility.tex.tmp
     769        $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
     770                -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
     771#       for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
     772#   the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
     773        $(QUIET)$(SED) \
     774                -e 's|^\\QUOTE{}|\\OQ{}|g' \
     775                -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
     776                -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
     777                --output $@ [email protected]
     778        $(QUIET)$(RM) -f [email protected]
     779
     780# Turn Accessibility.tex into a PDF.
     781$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
     782                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
     783                $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
     784                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
     785        $(call MSG_L1,pdflatex $< (three passes))
     786        $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
     787        $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
     788        $(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
     789        $(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
     790        $(QUIET)$(SED) -n \
     791                -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
     792                $(basename $<).log
     793        $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
     794
     795$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
     796                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
     797                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
     798                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
     799                | $$(dir $$@)
     800        $(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
     801        $(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
     802                --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
     803                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
     804                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.xml
     805
     806# Handy aliases.
     807validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.xml
     808accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
     809accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
    689810
    690811
    … …  
    838959
    839960#
    840 # VBoxManage man pages (parts also required by VBoxManage build-in help).
     961# VBoxManage man pages (parts also required by VBoxManage built-in help).
    841962#
    842963$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-manpage.xsl,)
Note: See TracChangeset for help on using the changeset viewer.

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