VirtualBox

source: vbox/trunk/doc/manual/Makefile.kmk@ 52034

Last change on this file since 52034 was 51387, checked in by vboxsync, 11 years ago

doc/manual and Config.kmk: move manual language selection to Config.kmk.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 36.8 KB
Line 
1# $Id: Makefile.kmk 51387 2014-05-26 09:04:17Z vboxsync $
2## @file
3# Sub-Makefile for the VBox User Manual.
4#
5
6#
7# Copyright (C) 2006-2012 Oracle Corporation
8#
9# This file is part of VirtualBox Open Source Edition (OSE), as
10# available from http://www.virtualbox.org. This file is free software;
11# you can redistribute it and/or modify it under the terms of the GNU
12# General Public License (GPL) as published by the Free Software
13# Foundation, in version 2 as it comes in the "COPYING" file of the
14# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16#
17
18#
19# This slightly messy makefile transforms the DocBook XML source for the
20# user manual into presentation output. We support two targets:
21#
22# -- UserManual.pdf, generated by LaTex
23#
24# -- VirtualBox.chm
25#
26# Both files end up in PATH_STAGE_BIN.
27#
28# Both targets indirectly depend on the XML files in this directory;
29# "indirectly" because we first copy them to PATH_TARGET and hack them
30# up a bit for variable substitution and such (see below).
31# The toolchains are roughly like this:
32#
33# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
34# then create a .FO file (another XML format for "formatted objects")
35# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
36#
37# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
38# run our custom "dblatex" perl script on UserManual.xml, which parses
39# the XML (using the Perl SAX parsers) and dumps a matching latex file
40# to UserManual.tex. This is then regularly processed by pdflatex to
41# generate PDF.
42#
43# -- CHM file: again, pre-process the XML files in PATH_TARGET, then use
44# xsltproc to create a .HHP file for the Microsoft Help Compiler, then
45# feed that file to it.
46#
47
48SUB_DEPTH = ../..
49include $(KBUILD_PATH)/subheader.kmk
50
51
52##########################################################################################
53#
54# Globals
55#
56##########################################################################################
57VBOX_PATH_MANUAL_SRC := $(PATH_SUB_CURRENT)
58VBOX_PATH_MANUAL_OUTBASE := $(PATH_TARGET)/manual
59BLDDIRS += $(VBOX_PATH_MANUAL_OUTBASE)
60
61
62##########################################################################################
63#
64# Main targets
65#
66##########################################################################################
67
68ifdef VBOX_WITH_DOCS
69 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF)
70 ## @todo make this an install target, drop the BLDDIRS.
71 OTHERS += \
72 $(VBOX_PATH_SDK)/docs/SDKRef.pdf
73 BLDDIRS += \
74 $(VBOX_PATH_SDK)/docs
75 endif
76
77 ifdef VBOX_WITH_DOCS_CHM
78 VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
79 else
80 VBOX_PATH_BIN_CHM =
81 # do not build
82 endif # !VBOX_WITH_DOCS_CHM
83
84 ifndef VBOX_ONLY_SDK
85 VBOX_MANUAL_PACK += \
86 $(PATH_STAGE_BIN)/UserManual.pdf \
87 $(VBOX_PATH_BIN_CHM)
88 OTHERS += \
89 $(PATH_STAGE_BIN)/UserManual.pdf
90 OTHERS.win += \
91 $(VBOX_PATH_BIN_CHM)
92 OTHERS.linux += \
93 $(VBOX_PATH_BIN_CHM)
94
95 ifdef VBOX_WITH_DOCS_TRANSLATIONS
96 OTHERS += \
97 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
98 ifdef VBOX_WITH_DOCS_CHM
99 OTHERS.win += \
100 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
101 OTHERS.linux += \
102 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
103 endif
104 endif
105 endif # !VBOX_ONLY_SDK
106 ifdef VBOX_ONLY_DOCS
107 PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
108 endif
109
110 ifdef VBOX_WITH_DOCS_TRANSLATIONS
111 VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
112 endif
113
114 VBOX_MANUAL_XML_CHANGELOG = \
115 user_ChangeLogImpl.xml
116
117 VBOX_MANUAL_XML_FILES = \
118 UserManual.xml \
119 user_AdvancedTopics.xml \
120 user_BasicConcepts.xml \
121 user_Glossary.xml \
122 user_Frontends.xml \
123 user_Installation.xml \
124 user_GuestAdditions.xml \
125 user_Introduction.xml \
126 user_KnownIssues.xml \
127 user_PrivacyPolicy.xml \
128 user_Security.xml \
129 user_Technical.xml \
130 user_ThirdParty.xml \
131 user_Troubleshooting.xml \
132 user_VBoxManage.xml \
133 user_VirtualBoxAPI.xml \
134 user_Storage.xml \
135 user_Networking.xml
136
137 VBOX_MANUAL_XML_FILES_INCL_CHANGELOG = $(VBOX_MANUAL_XML_FILES) \
138 user_ChangeLog.xml
139
140 VBOX_SDKREF_XML_FILES = \
141 SDKRef.xml
142
143 # Wildcard the images path for every supported language
144 $(foreach f,$(VBOX_MANUAL_LANGUAGES), \
145 $(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
146
147 VBOX_MANUAL_TEX_UNICODE_FILES = \
148 $(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
149
150 VBOX_MANUAL_LATEX_FILES_TARGET = \
151 $(addprefix UserManual.,aux log out toc tex)
152
153 VBOX_SDKREF_LATEX_FILES_TARGET = \
154 $(addprefix SDKRef.,aux log out toc tex)
155
156 BLDDIRS += \
157 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/,\
158 $(VBOX_MANUAL_LANGUAGES) \
159 $(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
160 $(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
161 $(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
162 $(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
163 $(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
164 )
165
166 ifdef VBOX_WITH_DOCS_CHM
167 VBOX_MANUAL_PACK += \
168 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf $(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
169 endif
170
171 OTHER_CLEAN += \
172 $(foreach f,$(VBOX_MANUAL_LANGUAGES), $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG))) \
173 $(foreach f,en_US, $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_SDKREF_XML_FILES))) \
174 $(foreach f,$(VBOX_MANUAL_LANGUAGES), $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_LATEX_FILES_TARGET))) \
175 $(foreach f,en_US, $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_SDKREF_LATEX_FILES_TARGET))) \
176 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
177 catalog docbook \
178 UserManual.fo) \
179 $(foreach f,$(VBOX_MANUAL_LANGUAGES), $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/, \
180 docbook-htmlhelp-formatcfg.xsl \
181 docbook-html-one-page-formatcfg.xsl \
182 docbook-html-chunks-formatcfg.xsl \
183 titlepage-htmlhelp.xsl )) \
184 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_PNG_FILES_$(f)))) \
185 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(f)))) \
186 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.pdf) \
187 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/VirtualBox.chm) \
188 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
189 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
190 $(PATH_STAGE_BIN)/UserManual.pdf \
191 $(PATH_STAGE_BIN)/VirtualBox.chm \
192 $(foreach f,en_US,$(VBOX_PATH_MANUAL_OUTBASE)/$f/SDKRef.pdf) \
193 $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
194 $(wildcard $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/*.h*)) \
195 $(foreach f,$(VBOX_MANUAL_LANGUAGES),\
196 $(patsubst $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/%,$(VBOX_PATH_MANUAL_OUTBASE)/$f/%, \
197 $(VBOX_MANUAL_TEX_UNICODE_FILES))) \
198 $(VBOX_PATH_MANUAL_OUTBASE)/$(VBOX_MANUAL_XML_CHANGELOG)
199
200endif # VBOX_WITH_DOCS
201
202
203
204##########################################################################################
205#
206# Options
207#
208##########################################################################################
209
210HTMLHELPOPTS =
211
212
213##########################################################################################
214#
215# Preparations
216#
217##########################################################################################
218
219# tool locations
220ifndef VBOX_OSE
221 # use docbook from our tools directory
222 DOCBOOKPATH ?= $(PATH_DEVTOOLS)/common/DocBook/v1.69.1
223 DOCBOOKDTDPATH ?= $(PATH_DEVTOOLS)/common/docbook-xml/v4.3
224 XML_CATALOG ?= $(VBOX_PATH_MANUAL_OUTBASE)/catalog
225 XML_CATALOG_DOCBOOK ?= $(VBOX_PATH_MANUAL_OUTBASE)/docbook
226else
227 # use docbook of the build host
228 DOCBOOKPATH ?= http://docbook.sourceforge.net/release/xsl/current/
229endif
230VBOXMANAGEPATH ?= $(PATH_STAGE_BIN)/VBoxManageHelp$(SUFF_EXE)
231
232 # PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
233 # without catting the log a million times.
234 PDFLATEX_INTERACTION ?= batchmode
235ifeq ($(KBUILD_HOST),win)
236 ifndef VBOX_PDFLATEX
237 VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(PATH_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
238 ifneq ($(VBOX_PDFLATEX),)
239 PDFLATEX = $(VBOX_PDFLATEX) -halt-on-error -interaction $(PDFLATEX_INTERACTION)
240 endif
241 endif
242 ifndef PDFLATEX
243 # Tell MiKTeX to automatically download packages if system wide install.
244 VBOX_PDFLATEX := pdflatex
245 PDFLATEX = $(VBOX_PDFLATEX) -halt-on-error -interaction $(PDFLATEX_INTERACTION) --enable-installer
246 endif
247else
248 PDFLATEX_HALT = $(shell \
249 ( pdflatex -version | head -1 | grep 141592 > /dev/null ) && echo -halt-on-error )
250 PDFLATEX = pdflatex $(PDFLATEX_HALT) -interaction $(PDFLATEX_INTERACTION)
251endif
252
253# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
254HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
255
256
257##########################################################################################
258#
259# Rules: Preprocess DocBook XML files
260# (preliminary step for both CHM and PDF generation)
261#
262##########################################################################################
263
264#
265# The following rules for $(VBOX_PATH_MANUAL_OUTBASE)/*.xml process the XML files
266# in doc/manual to allow for some magic variable replacements. The PDF and CHM
267# targets do not depend on the XML files in doc/manual, but those in
268# $(VBOX_PATH_MANUAL_OUTBASE) instead, which we copy there from here, after that magic
269# processing.
270#
271# So, before copying, the following steps are performed:
272#
273# -- $VBOX_VERSION_* strings are replaced with the actual current VBox version.
274# -- $VBOX_MANAGE_OUTPUT (in VBoxManage.xml) is replaced with the current
275# output of the actual VBoxManage program, to save us from having to
276# update the manual all the time.
277#
278
279# Only one changelog for all languages
280# $(VBOX_PATH_MANUAL_OUTBASE)/$(VBOX_MANUAL_XML_CHANGELOG): $(VBOX_PATH_MANUAL_SRC)/$(VBOX_MANUAL_XML_CHANGELOG) | $$(dir $$@)
281# $(QUIET)$(INSTALL) -m 0644 $< $@
282
283# intermediate step to do some variable replacement in the document
284$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(filter-out user_VBoxManage.xml,$(VBOX_MANUAL_XML_FILES)))): \
285 $(VBOX_PATH_MANUAL_OUTBASE)/% : $(VBOX_PATH_MANUAL_SRC)/% $(VBOX_VERSION_STAMP) | $$(dir $$@)
286 $(call MSG_L1,Pre-processing [1] $(@F) to $@)
287 $(QUIET)$(RM) -f $@ $@.tmp
288 $(QUIET)$(SED) -e 's/\$$VBOX_VERSION_MAJOR/$(VBOX_VERSION_MAJOR)/g' \
289 -e 's/\$$VBOX_VERSION_MINOR/$(VBOX_VERSION_MINOR)/g' \
290 -e 's/\$$VBOX_VERSION_BUILD/$(VBOX_VERSION_BUILD)/g' \
291 -e 's/\$$VBOX_VERSION_STRING/$(VBOX_VERSION_STRING)/g' \
292 -e 's/\$$VBOX_VENDOR/$(VBOX_VENDOR)/g' \
293 -e 's/\$$VBOX_PRODUCT/$(VBOX_PRODUCT)/g' \
294 -e 's/\$$VBOX_C_YEAR/$(VBOX_C_YEAR)/g' \
295 --output $@.tmp $<
296 $(QUIET)$(MV) -f $@.tmp $@
297
298$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_ChangeLog.xml): \
299 $(VBOX_PATH_MANUAL_OUTBASE)/% : \
300 $(VBOX_PATH_MANUAL_SRC)/% $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml | $$(dir $$@)
301 $(call MSG_L1,Pre-processing [3] $(@F) to $@)
302 $(QUIET)$(RM) -f $@ $@.tmp $@.tmp2
303 $(QUIET)$(SED) -e 's/\$$VBOX_VERSION_MAJOR/$(VBOX_VERSION_MAJOR)/g' \
304 -e 's/\$$VBOX_VERSION_MINOR/$(VBOX_VERSION_MINOR)/g' \
305 -e 's/\$$VBOX_VERSION_BUILD/$(VBOX_VERSION_BUILD)/g' \
306 -e 's/\$$VBOX_VERSION_STRING/$(VBOX_VERSION_STRING)/g' \
307 -e 's/\$$VBOX_VENDOR/$(VBOX_VENDOR)/g' \
308 -e 's/\$$VBOX_PRODUCT/$(VBOX_PRODUCT)/g' \
309 -e 's/\$$VBOX_C_YEAR/$(VBOX_C_YEAR)/g' \
310 --output $@.tmp $<
311 $(QUIET)$(SED) -e '1,/<!--\$$VIRTUALBOX_CHANGELOG_IMPL-->/!d' \
312 -e 's/<!--\$$VIRTUALBOX_CHANGELOG_IMPL-->//' \
313 --output $@ $@.tmp
314 var=`$(SED) -n '/!--\$$VIRTUALBOX_CHANGELOG_IMPL-->/p' $<`; \
315 test -n "$${var}" && \
316 $(SED) -e 's/<?xml version=\"1.0\" encoding=\"UTF-8\"?>//g' \
317 --append $@ $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml; \
318 true
319 $(QUIET)$(SED) -e '/<!--\$$VIRTUALBOX_CHANGELOG_IMPL-->/,$$!d' \
320 -e 's/<!--\$$VIRTUALBOX_CHANGELOG_IMPL-->//' --append $@ $@.tmp
321
322$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_VBoxManage.xml): \
323 $(VBOX_PATH_MANUAL_OUTBASE)/% : \
324 $(VBOX_PATH_MANUAL_SRC)/% \
325 $(VBOXMANAGEPATH) | $$(dir $$@)
326 $(call MSG_L1,Pre-processing [2] $(@F) to $@)
327 $(QUIET)$(RM) -f $@ $@.tmp $@.tmp2
328 $(QUIET)$(SED) -e 's/\$$VBOX_VERSION_MAJOR/$(VBOX_VERSION_MAJOR)/g' \
329 -e 's/\$$VBOX_VERSION_MINOR/$(VBOX_VERSION_MINOR)/g' \
330 -e 's/\$$VBOX_VERSION_BUILD/$(VBOX_VERSION_BUILD)/g' \
331 -e 's/\$$VBOX_VERSION_STRING/$(VBOX_VERSION_STRING)/g' \
332 -e 's/\$$VBOX_VENDOR/$(VBOX_VENDOR)/g' \
333 -e 's/\$$VBOX_PRODUCT/$(VBOX_PRODUCT)/g' \
334 -e 's/\$$VBOX_C_YEAR/$(VBOX_C_YEAR)/g' \
335 --output $@.tmp $<
336 $(QUIET)$(SED) -e '1,/\$$VBOX_MANAGE_OUTPUT/!d' \
337 -e 's/\$$VBOX_MANAGE_OUTPUT.*//' \
338 --output $@ $@.tmp
339 $(QUIET)$(REDIRECT) -wo $@.tmp2 -E 'VBOX_LOG_FLAGS=disabled' -E 'VBOX_LOG_DEST=nofile' \
340 $(if $(eq $(KBUILD_TARGET),darwin), -E 'DYLD_FALLBACK_LIBRARY_PATH=$(dir $(LIB_RUNTIME))') \
341 -- \
342 $(VBOXMANAGEPATH) --dumpopts
343 $(QUIET)$(SED) -e 's/</\&lt;/g' -e 's/>/\&gt;/g' --append $@ $@.tmp2
344 $(QUIET)$(SED) -e '/\$$VBOX_MANAGE_OUTPUT/,$$!d' \
345 -e 's/.*\$$VBOX_MANAGE_OUTPUT//' --append $@ $@.tmp
346 $(QUIET)$(RM) -f $@.tmp $@.tmp2
347
348VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
349VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
350VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
351
352$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) | $$(dir $$@)
353 $(call MSG_L1,Generating $@)
354 $(QUIET)$(SED) -e 's|@a \+\(\w\+\)|<tt>\1</tt>|g' \
355 -e 's|@c \+\(\w\+\)|<tt>\1</tt>|g' \
356 --output $@ $<
357
358# generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
359$(VBOX_MANUAL_APIREF_TMP): $(VBOX_DOC_XIDL_SRC_TMP) $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl
360 $(call MSG_L1,Generating $@)
361 $(QUIET)$(VBOX_XSLTPROC) --xinclude -o $@ $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
362
363$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.xml: \
364 $(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml $(VBOX_MANUAL_APIREF_TMP) \
365 | $$(dir $$@)
366 $(call MSG_L1,Pre-processing [2] $(@F) to $@)
367 $(QUIET)$(RM) -f $@ $@.tmp
368 $(QUIET)$(SED) -e 's/\$$VBOX_VERSION_MAJOR/$(VBOX_VERSION_MAJOR)/g' \
369 -e 's/\$$VBOX_VERSION_MINOR/$(VBOX_VERSION_MINOR)/g' \
370 -e 's/\$$VBOX_VERSION_BUILD/$(VBOX_VERSION_BUILD)/g' \
371 -e 's/\$$VBOX_VERSION_STRING/$(VBOX_VERSION_STRING)/g' \
372 -e 's/\$$VBOX_VENDOR/$(VBOX_VENDOR)/g' \
373 -e 's/\$$VBOX_PRODUCT/$(VBOX_PRODUCT)/g' \
374 -e 's/\$$VBOX_C_YEAR/$(VBOX_C_YEAR)/g' \
375 --output $@.tmp $<
376 $(QUIET)$(SED) -e '1,/<!--\$$VIRTUALBOX_MAIN_API_REFERENCE-->/!d' \
377 -e 's/<!--\$$VIRTUALBOX_MAIN_API_REFERENCE-->//' \
378 --output $@ $@.tmp
379 $(QUIET)$(SED) -e 's/<?xml version=\"1.0\" encoding=\"utf-8\"?>//g' --append $@ $(VBOX_MANUAL_APIREF_TMP)
380 $(QUIET)$(SED) -e '/<!--\$$VIRTUALBOX_MAIN_API_REFERENCE-->/,$$!d' \
381 -e 's/<!--\$$VIRTUALBOX_MAIN_API_REFERENCE-->//' --append $@ $@.tmp
382# $(QUIET)$(MV) -f $@.tmp $@
383
384
385##########################################################################################
386#
387# Rules: Create or preprocess files for xsltproc
388# (preliminary step for both CHM and PDF generation)
389#
390##########################################################################################
391
392# Create a catalog file for xsltproc that points to docbook catalog.
393ifneq ($(XML_CATALOG),)
394$(XML_CATALOG): $(MAKEFILE_CURRENT) | $$(dir $$@)
395 $(call MSG_L1,Creating catalog $@)
396 $(QUIET)$(RM) -f $@.tmp $@
397 $(QUIET)$(APPEND) $@.tmp '<?xml version="1.0"?>'
398 $(QUIET)$(APPEND) $@.tmp '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">'
399 $(QUIET)$(APPEND) $@.tmp '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">'
400 $(QUIET)$(APPEND) $@.tmp ' <delegatePublic publicIdStartString="-//OASIS/ENTITIES DocBook XML" catalog="file:///$(XML_CATALOG_DOCBOOK)"/>'
401 $(QUIET)$(APPEND) $@.tmp ' <delegatePublic publicIdStartString="-//OASIS/DTD DocBook XML" catalog="file:///$(XML_CATALOG_DOCBOOK)"/>'
402 $(QUIET)$(APPEND) $@.tmp ' <delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/" catalog="file:///$(XML_CATALOG_DOCBOOK)"/>'
403 $(QUIET)$(APPEND) $@.tmp ' <delegateURI uriStartString="http://www.oasis-open.org/docbook/" catalog="file:///$(XML_CATALOG_DOCBOOK)"/>'
404 $(QUIET)$(APPEND) $@.tmp '</catalog>'
405 $(QUIET)$(MV) -f $@.tmp $@
406
407# Create a docbook catalog file for xsltproc that points to the local docbook files.
408$(XML_CATALOG_DOCBOOK): $(MAKEFILE_CURRENT) | $$(dir $$@)
409 $(call MSG_L1,Creating catalog $@)
410 $(QUIET)$(RM) -f $@.tmp $@
411 $(QUIET)$(APPEND) $@.tmp '<?xml version="1.0"?>'
412 $(QUIET)$(APPEND) $@.tmp '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">'
413 $(QUIET)$(APPEND) $@.tmp '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">'
414 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//ELEMENTS DocBook XML Information Pool V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/dbpoolx.mod"/>'
415 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//DTD DocBook XML V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/docbookx.dtd"/>'
416 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//DTD DocBook XML V4.4//EN" uri="file:///$(DOCBOOKDTDPATH)/docbookx.dtd"/>'
417 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//ENTITIES DocBook XML Character Entities V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/dbcentx.mod"/>'
418 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//ENTITIES DocBook XML Notations V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/dbnotnx.mod"/>'
419 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//ENTITIES DocBook XML Additional General Entities V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/dbgenent.mod"/>'
420 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//ELEMENTS DocBook XML Document Hierarchy V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/dbhierx.mod"/>'
421 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" uri="file:///$(DOCBOOKDTDPATH)/soextblx.dtd"/>'
422 $(QUIET)$(APPEND) $@.tmp ' <public publicId="-//OASIS//DTD DocBook XML CALS Table Model V4.3//EN" uri="file:///$(DOCBOOKDTDPATH)/calstblx.dtd"/>'
423 $(QUIET)$(APPEND) $@.tmp ' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///$(DOCBOOKDTDPATH)"/>'
424 $(QUIET)$(APPEND) $@.tmp ' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///$(DOCBOOKDTDPATH)"/>'
425 $(QUIET)$(APPEND) $@.tmp ' <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///$(DOCBOOKDTDPATH)"/>'
426 $(QUIET)$(APPEND) $@.tmp ' <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///$(DOCBOOKDTDPATH)"/>'
427 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amsa.ent"/>'
428 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amsb.ent"/>'
429 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amsc.ent"/>'
430 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amsn.ent"/>'
431 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amso.ent"/>'
432 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-amsr.ent"/>'
433 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Box and Line Drawing//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-box.ent"/>'
434 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Russian Cyrillic//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-cyr1.ent"/>'
435 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-cyr2.ent"/>'
436 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Diacritical Marks//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-dia.ent"/>'
437 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Greek Letters//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-grk1.ent"/>'
438 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Monotoniko Greek//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-grk2.ent"/>'
439 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Greek Symbols//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-grk3.ent"/>'
440 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-grk4.ent"/>'
441 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 1//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-lat1.ent"/>'
442 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Added Latin 2//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-lat2.ent"/>'
443 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-num.ent"/>'
444 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES Publishing//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-pub.ent"/>'
445 $(QUIET)$(APPEND) $@.tmp ' <public publicId="ISO 8879:1986//ENTITIES General Technical//EN" uri="file:///$(DOCBOOKDTDPATH)/ent/iso-tech.ent"/>'
446 $(QUIET)$(APPEND) $@.tmp '</catalog>'
447 $(QUIET)$(MV) -f $@.tmp $@
448endif
449
450# intermediate step to do some variable replacement in the XSL configuration
451$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/docbook-htmlhelp-formatcfg.xsl): \
452 $(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl $(MAKEFILE_CURRENT) | $$(dir $$@)
453 $(call MSG_L1,Pre-processing $(@F) to $@)
454 $(QUIET)$(RM) -f $@.tmp $@
455 $(QUIET)$(SED) -e 's|\$$DOCBOOKPATH|$(DOCBOOKPATH)|g' \
456 -e 's|\$$CFGPATH|$(VBOX_PATH_MANUAL_SRC)|g' \
457 -e 's|\$$TARGETPATH|$(@D)|g' --output $@.tmp $<
458 $(QUIET)$(MV) -f $@.tmp $@
459
460# Prepare the XSL file for our title page, htmlhelp variant.
461$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/titlepage-htmlhelp.xsl): \
462 $(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) | $$(dir $$@)
463 $(call MSG_L1,xsltproc $<)
464 $(QUIET)$(RM) -f $@.tmp $@
465 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o $@.tmp $(DOCBOOKPATH)/template/titlepage.xsl $<
466 $(QUIET)$(MV) -f $@.tmp $@
467
468
469##########################################################################################
470#
471# Shared rules for PDF generation
472#
473##########################################################################################
474
475ifndef VBOX_OSE
476# copy ucs.sty and related files
477$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
478 $(call MSG_L1,Copying unicode support for LaTeX)
479 $(QUIET)$(CP) $(VBOX_MANUAL_TEX_UNICODE_FILES) $(@D)
480endif
481
482# copy the PNG files.
483# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
484define def_vbox_cp_images_pdf
485local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
486$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
487 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
488 $$(call MSG_L1,Copying temporary $$< => $$@)
489 $$(QUIET)$$(CP) -f $$< $$@
490endef
491
492$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_pdf)))
493
494
495##########################################################################################
496#
497# UserManual.pdf
498#
499##########################################################################################
500
501## @todo INSTALLS target for this!
502$(PATH_STAGE_BIN)/UserManual.pdf: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf | $$(dir $$@)
503 $(QUIET)$(CP) $< $@
504 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
505
506$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf): \
507 $(PATH_STAGE_BIN)/UserManual_%.pdf : $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf
508 $(QUIET)$(CP) $< $@
509 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
510
511$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.pdf): \
512 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf : \
513 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.tex \
514 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/%/ucs.sty) \
515 $(foreach f,$(VBOX_MANUAL_LANGUAGES),\
516 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_PNG_FILES_$(f)))) | $$(dir $$@)
517# PDF generation via Latex: generate the .tex file
518 $(call MSG_L1,pdflatex $< (four passes) -> $@)
519 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
520 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
521 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
522 $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
523 $(QUIET)$(SED) -n \
524 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
525 $(basename $@).log
526
527##@todo restore this when above has been converted to INSTALLS target. $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
528
529# generate temporary LaTeX source from processed XML
530$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.tex): \
531 $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.tex : \
532 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/%/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
533 $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
534 $(MAKEFILE_CURRENT)
535 $(call MSG_L1,Generating $@ from DocBook XML)
536 $(QUIET)$(RM) -f $(addprefix $(@D)/,$(VBOX_MANUAL_LATEX_FILES_TARGET))
537# generate TeX source from processed docbook and store it in UserManual.tex.tmp;
538# pass current language to xsltproc in TARGETLANG variable (extract it from the
539# current directory, should become "de_DE" or the like)
540 $(QUIET)$(VBOX_XSLTPROC) $(XSLTPROC_VERBOSE) --xinclude --nonet --stringparam TARGETLANG $(notdir $(@D)) -o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
541# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
542# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
543 $(QUIET)$(SED) \
544 -e 's|^\\QUOTE{}|\\OQ{}|g' \
545 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
546 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
547 --output $@ $@.tmp
548 $(QUIET)$(RM) -f $@.tmp
549
550
551##########################################################################################
552#
553# SDKRef.pdf
554#
555##########################################################################################
556
557$(VBOX_PATH_SDK)/docs/SDKRef.pdf: \
558 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
559 $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
560 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) | $$(dir $$@)
561# PDF generation via Latex: generate the .tex file
562 $(QUIET)$(MKDIR) -p $(VBOX_PATH_SDK)/docs
563 $(call MSG_L1,pdflatex $< (three passes))
564 $(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
565 $(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
566 $(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
567 $(QUIET)$(SED) -n \
568 -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
569 $(basename $<).log
570 $(QUIET)$(CP) $(<D)/SDKRef.pdf $@
571 $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
572
573# generate temporary LaTeX source from processed XML
574$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_SDKREF_XML_FILES)) $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $(MAKEFILE_CURRENT)
575 $(call MSG_L1,Generating $@ from DocBook XML)
576 $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
577# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
578 $(QUIET)$(VBOX_XSLTPROC) $(XSLTPROC_VERBOSE) --xinclude --nonet --stringparam TARGETLANG en_US -o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
579# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
580# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
581 $(QUIET)$(SED) \
582 -e 's|^\\QUOTE{}|\\OQ{}|g' \
583 -e 's|\(\W\)\\QUOTE{}|\1\\OQ{}|g' \
584 -e 's|\(\w\)\\QUOTE{}|\1\\CQ{}|g' \
585 --output $@ $@.tmp
586 $(QUIET)$(RM) -f $@.tmp
587
588
589##########################################################################################
590#
591# VirtualBox.chm
592#
593##########################################################################################
594
595#
596# Main rule for the .chm file (target of OTHERS at the top):
597# We first generate a .hhp help source file from the preprocessed
598# DocBook XML files, as defined above, then feed that into the
599# Microsoft Help Compiler.
600#
601
602ifdef VBOX_WITH_DOCS_CHM
603$(PATH_STAGE_BIN)/VirtualBox.chm: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
604 $(QUIET)$(CP) $< $@
605 $(call MSG_L1,Fresh CHM is now at $@)
606
607$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm): \
608 $(PATH_STAGE_BIN)/VirtualBox_%.chm : $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm
609 $(QUIET)$(CP) $< $@
610 $(call MSG_L1,Fresh CHM is now at $@)
611
612$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/VirtualBox.chm): \
613 $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm: \
614 $(VBOX_PATH_MANUAL_OUTBASE)/%/HTMLHelp/htmlhelp.hhp \
615 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(f))))
616 $(call MSG_L1,hhc $<,=> $@)
617 $(QUIET)$(RM) -f $@
618 $(QUIET)$(HHC) $(subst /,\\,$<)
619
620$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/HTMLHelp/htmlhelp.hhp): \
621 $(VBOX_PATH_MANUAL_OUTBASE)/%/HTMLHelp/htmlhelp.hhp: \
622 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/%/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
623 $(VBOX_PATH_MANUAL_OUTBASE)/%/docbook-htmlhelp-formatcfg.xsl \
624 $(VBOX_PATH_MANUAL_OUTBASE)/%/titlepage-htmlhelp.xsl \
625 $(XML_CATALOG) \
626 $(XML_CATALOG_DOCBOOK)
627 $(call MSG_L1,xsltproc $<,=> $@)
628 $(QUIET)$(RM) -f $@
629 $(QUIET)$(MKDIR) -p $(@D)
630 $(QUIET)$(if $(XML_CATALOG),XML_CATALOG_FILES=$(XML_CATALOG)) \
631 $(VBOX_XSLTPROC) --xinclude --nonet --output $(@D)/ \
632 --stringparam htmlhelp.chm \
633 $(subst /,\\,$(@D)/../VirtualBox.chm) \
634 $(HTMLHELPOPTS) $(@D)/../docbook-htmlhelp-formatcfg.xsl \
635 $<
636
637# copy the PNG files.
638# Note: out_dir needs to be referenced with an escaped $ so it doesn't expand as eval expands it input.
639define def_vbox_cp_images_html
640local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/HTMLHelp
641$$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
642 $$(out_dir)/%: $(VBOX_PATH_MANUAL_SRC)/$(lang)/% | $$$$(dir $$$$@)
643 $$(call MSG_L1,Copying temporary $$< => $$@)
644 $$(QUIET)$$(CP) -f $$< $$@
645endef
646
647$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_html)))
648
649# Packing the docs into a zip file
650$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
651 $(call MSG_L1,Packing documentation $@)
652 $(QUIET)$(RM) -f $@
653 $(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- zip$(HOSTSUFF_EXE) -9 $@ $(notdir $^)
654endif # VBOX_WITH_DOCS_CHM
655
656##########################################################################################
657#
658# UserManual.html
659#
660##########################################################################################
661
662# intermediate step to do some variable replacement in the XSL configuration
663$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl: \
664 $(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl $(MAKEFILE_CURRENT) | $$(dir $$@)
665 $(call MSG_L1,Pre-processing $(@F) to $@)
666 $(QUIET)$(RM) -f $@.tmp $@
667 $(QUIET)$(SED) -e 's|\$$DOCBOOKPATH|$(DOCBOOKPATH)|g' \
668 -e 's|\$$CFGPATH|$(VBOX_PATH_MANUAL_SRC)|g' \
669 -e 's|\$$TARGETPATH|$(@D)|g' --output $@.tmp $<
670 $(QUIET)$(MV) -f $@.tmp $@
671
672$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl: \
673 $(VBOX_PATH_MANUAL_SRC)/docbook-html-chunks-formatcfg.xsl $(MAKEFILE_CURRENT) | $$(dir $$@)
674 $(call MSG_L1,Pre-processing $(@F) to $@)
675 $(QUIET)$(RM) -f $@.tmp $@
676 $(QUIET)$(SED) -e 's|\$$DOCBOOKPATH|$(DOCBOOKPATH)|g' \
677 -e 's|\$$CFGPATH|$(VBOX_PATH_MANUAL_SRC)|g' \
678 -e 's|\$$TARGETPATH|$(@D)|g' --output $@.tmp $<
679 $(QUIET)$(MV) -f $@.tmp $@
680
681$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
682 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
683 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml \
684 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
685 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
686 $(call MSG_L1,xsltproc $<)
687 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet \
688 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
689 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
690 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml
691
692$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
693 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl \
694 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml \
695 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG)) \
696 $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
697 $(call MSG_L1,xsltproc $<)
698 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet \
699 --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
700 --stringparam chunk.section.depth 0 \
701 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-chunks-formatcfg.xsl \
702 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.xml
703
704$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
705 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
706 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
707 $(call MSG_L1,Packing documentation $@)
708 $(QUIET)$(RM) -f $@
709 $(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- zip$(HOSTSUFF_EXE) \
710 -9 -r $@ html-single html-chunks $(VBOX_MANUAL_PNG_FILES_en_US)
711
712html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
713
714html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
715
716html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
717
718##########################################################################################
719#
720# ChangeLog.html
721#
722##########################################################################################
723
724# intermediate step to do some variable replacement in the XSL configuration
725$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-changelog-formatcfg.xsl: \
726 $(VBOX_PATH_MANUAL_SRC)/docbook-changelog-formatcfg.xsl $(MAKEFILE_CURRENT) | $$(dir $$@)
727 $(call MSG_L1,Pre-processing $(@F) to $@)
728 $(QUIET)$(RM) -f $@.tmp $@
729 $(QUIET)$(SED) -e 's|\$$DOCBOOKPATH|$(DOCBOOKPATH)|g' \
730 -e 's|\$$CFGPATH|$(VBOX_PATH_MANUAL_SRC)|g' \
731 -e 's|\$$TARGETPATH|$(@D)|g' --output $@.tmp $<
732 $(QUIET)$(MV) -f $@.tmp $@
733
734# This XSLT rule depends on $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml, which is build by the complex rule
735# $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_ChangeLog.xml): ...
736# much further above. That rule takes en_US/user_ChangeLog.xml and replaces $VIRTUALBOX_CHANGELOG_IMPL
737# with the actual change log contained in user_ChangeLogImpl.xml
738$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
739 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-changelog-formatcfg.xsl \
740 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml
741 $(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html \
742 $(@D)/docbook-changelog-formatcfg.xsl \
743 $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml
744 $(call MSG_L1,Fresh ChangeLog.html is now at $@)
745
746cl-html: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
747
748include $(FILE_KBUILD_SUB_FOOTER)
749
Note: See TracBrowser for help on using the repository browser.

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