VirtualBox

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

Last change on this file since 32025 was 32025, checked in by vboxsync, 14 years ago

indent

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