Makefile.kmk@ 51331

Last change on this file since 51331 was 51331, checked in by vboxsync, 11 years ago
doc/manual: make more places in the make file aware of translations.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 37.1 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format