Makefile.kmk@ 49972

Last change on this file since 49972 was 46091, checked in by vboxsync, 12 years ago
doc/manual: only insert the change log if the tag is found, as translations do not need the split change log.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.9 KB

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

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

Download in other formats:

Original Format