Makefile.kmk@ 99038

Last change on this file since 99038 was 99038, checked in by vboxsync, 2 years ago
manual: Got rid of the correct_reference_targets Makefile-file rule, the new tactic is to scan the checked in .dita-files and .xml-files, store the id->filename mappings in file, and apply them as part of the refentry->dita conversion recipe for each individual Docbook-file. Use pattern rules for copying files to the staging area. bugref:10302
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 41.3 KB

Line
1	# $Id: Makefile.kmk 99038 2023-03-18 05:03:58Z vboxsync $
2	## @file
3	# Sub-Makefile for the VirtualBox User Manual, SDK reference and other manuals.
4	#
5
6	#
7	# Copyright (C) 2006-2023 Oracle and/or its affiliates.
8	#
9	# This file is part of VirtualBox base platform packages, as
10	# available from https://www.virtualbox.org.
11	#
12	# This program is free software; you can redistribute it and/or
13	# modify it under the terms of the GNU General Public License
14	# as published by the Free Software Foundation, in version 3 of the
15	# License.
16	#
17	# This program is distributed in the hope that it will be useful, but
18	# WITHOUT ANY WARRANTY; without even the implied warranty of
19	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	# General Public License for more details.
21	#
22	# You should have received a copy of the GNU General Public License
23	# along with this program; if not, see <https://www.gnu.org/licenses>.
24	#
25	# SPDX-License-Identifier: GPL-3.0-only
26	#
27
28	#
29	# This slightly messy makefile transforms the DocBook XML source for the
30	# user manual into presentation output. We support two targets:
31	#
32	# -- UserManual.pdf, generated by LaTex
33	#
34	#
35	# Both files end up in PATH_STAGE_BIN.
36	#
37	# Both targets indirectly depend on the XML files in this directory;
38	# "indirectly" because we first copy them to PATH_TARGET and hack them
39	# up a bit for variable substitution and such (see below).
40	# The toolchains are roughly like this:
41	#
42	# -- PDF file via Apache FOP: pre-process the XML files in PATH_TARGET,
43	# then create a .FO file (another XML format for "formatted objects")
44	# via xsltproc, then feed the .FO file to Apache FOP to create the PDF.
45	#
46	# -- PDF file via LaTeX: pre-process the XML files in PATH_TARGET, then
47	# run our custom "dblatex" perl script on UserManual.xml, which parses
48	# the XML (using the Perl SAX parsers) and dumps a matching LaTeX file
49	# to UserManual.tex. This is then regularly processed by pdflatex to
50	# generate PDF.
51	#
52	#
53
54	SUB_DEPTH = ../..
55	include $(KBUILD_PATH)/subheader.kmk
56
57	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
58	include $(PATH_SUB_CURRENT)/Config.kmk
59	endif
60
61
62
63	#
64	# Globals
65	#
66
67	# Error out if someone tries to override old globals.
68	ifdef HTMLHELPOPTS
69	$(error HTMLHELPOPTS was renamed to VBOX_HTMLHELP_OPTS!)
70	endif
71	ifdef DOCBOOKPATH
72	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
73	endif
74	ifdef DOCBOOKPATH
75	$(error DOCBOOKPATH was renamed to VBOX_PATH_DOCBOOK!)
76	endif
77	ifdef XML_CATALOG
78	$(error XML_CATALOG was renamed to VBOX_XML_CATALOG!)
79	endif
80	ifdef XML_CATALOG_DOCBOOK
81	$(error XML_CATALOG_DOCBOOK was renamed to VBOX_XML_CATALOG_DOCBOOK!)
82	endif
83	ifdef PDFLATEX_INTERACTION
84	$(error PDFLATEX_INTERACTION was renamed to VBOX_PDFLATEX_INTERACTION!)
85	endif
86	ifdef PDFLATEX
87	$(error PDFLATEX was renamed to VBOX_PDFLATEX_CMD!)
88	endif
89	ifdef HHC
90	$(error HHC was renamed to VBOX_HHC!)
91	endif
92
93	VBOX_DITA_PATH = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-1.8.5
94
95	VBOX_QHELP_OUTPUT_FILES = \
96	UserManual.qch \
97	UserManual.qhc
98
99	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
100	# without catting the log a million times.
101	VBOX_PDFLATEX_INTERACTION ?= batchmode
102	ifeq ($(KBUILD_HOST),win)
103	ifndef VBOX_PDFLATEX
104	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
105	ifneq ($(VBOX_PDFLATEX),)
106	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
107	endif
108	endif
109	ifndef VBOX_PDFLATEX
110	# Tell MiKTeX to automatically download packages if system wide install.
111	VBOX_PDFLATEX := pdflatex
112	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
113	endif
114	else
115	VBOX_PDFLATEX ?= pdflatex
116	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
117	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
118	endif
119
120	# Windows HTML Help Workshop compiler (stupid thing always returns an error!)
121	VBOX_HHC = -$(EXEC_X86_WIN32) $(VBOX_PATH_HTML_HELP_WORKSHOP)/hhc.exe
122
123
124	# Additional xsltproc options when generating
125	VBOX_HTMLHELP_OPTS ?=
126
127	# SDK related globals.
128	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
129	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
130	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
131
132
133	#
134	# Targets
135	#
136
137	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_LANGUAGES))
138
139	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
140	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
141	INSTALLS += VBox-docs-sdkref
142	endif
143
144	ifdef VBOX_WITH_DOCS_HTML
145	INSTALLS += VBox-docs-usermanual-html
146	VBOX_PATH_BIN_HTML = $(PATH_STAGE_BIN)/UserManual-html.zip
147	else # Do not build html.
148	VBOX_PATH_BIN_HTML =
149	endif
150
151	ifdef VBOX_WITH_DOCS_QHELP
152	INSTALLS += VBox-docs-usermanual-qhelp
153	ifdef VBOX_WITH_QT6
154	USES += qt6
155	QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
156	else # Qt5
157	USES += qt5
158	QHELPGENERATOR_VERSION_MINOR = $(shell $(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$(PATH_SDK_QT5)/plugins -- $(PATH_TOOL_QT5_BIN)/qhelpgenerator -v 2>/dev/null \| $(SED) -ne 's/.(Qt [1-9][0-9]\.$[1-9][0-9]$\.[1-9][0-9]).*$$/\1/p')
159	QHELPGENERATOR = $(PATH_TOOL_QT5_BIN)/$(if-expr $(QHELPGENERATOR_VERSION_MINOR) >= 12,qhelpgenerator,qcollectiongenerator)
160	endif
161	endif
162	ifdef VBOX_WITH_DOCS_QHELP_PACKING
163	VBOX_PATH_BIN_QHELP = \
164	$(PATH_STAGE_BIN)/UserManual.qch \
165	$(PATH_STAGE_BIN)/UserManual.qhc
166	else # Do not install/pack qhelp.
167	VBOX_PATH_BIN_QHELP :=
168	endif
169
170	## @todo r=bird: Explanations for all of this is required!
171	.NOTPARALLEL: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch \
172	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.qhc \
173	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf \
174	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
175
176	ifndef VBOX_ONLY_SDK
177	VBOX_MANUAL_PACK += \
178	$(PATH_STAGE_BIN)/UserManual.pdf \
179	$(VBOX_PATH_BIN_HTML) \
180	$(VBOX_PATH_BIN_QHELP)
181	INSTALLS += VBox-docs-usermanual
182
183	ifdef VBOX_WITH_DOCS_TRANSLATIONS
184	INSTALLS += VBox-docs-usermanual-l10n
185	VBOX_MANUAL_PACK += \
186	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
187	endif
188	endif # !VBOX_ONLY_SDK
189
190	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
191	INSTALLS += \
192	VBox-docs-accessibility
193	VBox-docs-accessibility-html
194	endif
195
196	ifdef VBOX_ONLY_DOCS
197	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
198	endif
199
200	ifdef VBOX_WITH_DOCS_TRANSLATIONS
201	VBOX_MANUAL_LANGUAGES += $(VBOX_MANUAL_ADD_LANGUAGES)
202	endif
203
204	$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
205	$(eval VBOX_MANUAL_XML_FILES_GENERATED_$$(lang) := \
206	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
207	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
208	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_VBoxHeadless.xml \
209	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_man_vboximg-mount.xml \
210	$$(VBOX_PATH_MANUAL_OUTBASE)/$$(lang)/user_isomakercmd-man.xml))
211
212	VBOX_SDKREF_XML_FILES = \
213	SDKRef.xml
214
215	VBOX_ACCESSIBILITY_XML_FILES = \
216	Accessibility.xml
217
218
219	# Wildcard the images path for every supported language
220	$(foreach f,$(VBOX_MANUAL_LANGUAGES), \
221	$(eval VBOX_MANUAL_PNG_FILES_$$(f) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(f)/%,%,$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(f)/images/*.png))))
222
223	VBOX_MANUAL_TEX_UNICODE_FILES = \
224	$(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
225
226	VBOX_MANUAL_LATEX_FILES_TARGET = \
227	$(addprefix UserManual.,aux log out toc tex)
228
229	VBOX_SDKREF_LATEX_FILES_TARGET = \
230	$(addprefix SDKRef.,aux log out toc tex)
231
232	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET = \
233	$(addprefix Accessibility.,aux log out toc tex)
234
235	BLDDIRS += \
236	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
237	$(addsuffix /images, $(VBOX_MANUAL_LANGUAGES)) \
238	$(addsuffix /html-single, $(VBOX_MANUAL_LANGUAGES)) \
239	$(addsuffix /html-chunks, $(VBOX_MANUAL_LANGUAGES)) \
240	$(addsuffix /qhelp, $(VBOX_MANUAL_LANGUAGES)) \
241	$(addsuffix /qhelp/images, $(VBOX_MANUAL_LANGUAGES)) \
242	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_LANGUAGES)) \
243	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
244	)
245
246	# Explicit cleaning has some overlap with default cleaning rules, since this
247	# Makefile is using very complex conditionals for selectively creating
248	# specific files, and not everyone remembers to use the same with "kmk clean".
249	OTHER_CLEAN += \
250	$(VBOX_XML_CATALOG) \
251	$(VBOX_XML_CATALOG_DOCBOOK) \
252	$(VBOX_XML_CATALOG_MANUAL) \
253	$(VBOX_XML_ENTITIES) \
254	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
255	$(VBOX_XML_XREF_TO_TEXT) \
256	$(VBOX_XML_XREF_TO_TEXT).cat \
257	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
258	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
259	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
260	man_VBoxHeadless.xml \
261	user_man_VBoxHeadless.xml \
262	man_vboximg-mount.xml \
263	user_man_vboximg-mount.xml \
264	isomakercmd-man.xml \
265	user_isomakercmd-man.xml \
266	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
267	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
268	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
269	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
270	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
271	html-single/UserManual.html \
272	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
273	$(addprefix HTMLHelp/, index.html go01.html) \
274	$(addprefix qhelp/, index.html go01.html) \
275	$(addprefix html-chunks/, index.html go01.html) \
276	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
277	,html-chunks/ch$(n).html \
278	html-chunks/re$(n).html \
279	HTMLHelp/ch$(n).html \
280	HTMLHelp/re$(n).html \
281	$(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,HTMLHelp/ch$(n)s$(d2)$(d1).html)) \
282	qhelp/ch$(n).html \
283	qhelp/re$(n).html \
284	$(foreach d2,0 1 2 3 4 5 6 7 8 9,$(foreach d1,0 1 2 3 4 5 6 7 8 9,qhelp/ch$(n)s$(d2)$(d1).html)) ) \
285	$(foreach n,a b c \
286	,html-chunks/ap$(n).html \
287	HTMLHelp/ap$(n).html \
288	$(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,HTMLHelp/ap$(n)s$(s).html) \
289	qhelp/ap$(n).html \
290	$(foreach s,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20,qhelp/ap$(n)s$(s).html) ) \
291	$(foreach n,01 02 03 04 05 \
292	,html-chunks/pr$(n).html \
293	HTMLHelp/pr$(n).html \
294	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
295	qhelp/pr$(n).html \
296	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
297	HTMLHelp/toc.hhc \
298	HTMLHelp/htmlhelp.hhp \
299	qhelp/toc.hhc \
300	qhelp/htmlhelp.hhp \
301	UserManual.pdf \
302	VirtualBox.chm \
303	$(VBOX_QHELP_OUTPUT_FILES) \
304	ChangeLog.html \
305	validatemanual.run \
306	validateaccessibility.run \
307	validatesdkref.run \
308	)) \
309	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
310	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
311	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
312	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
313	$(PATH_STAGE_BIN)/UserManual.pdf \
314	$(PATH_STAGE_BIN)/VirtualBox.chm \
315	\
316	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
317	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
318	SDKRef.pdf \
319	) \
320	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
321	\
322	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
323	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
324	html-single/Accessibility.html \
325	Accessibility.pdf \
326	) \
327	$(PATH_STAGE_BIN)/Accessibility.html \
328	$(PATH_STAGE_BIN)/Accessibility.pdf \
329	\
330	$(VBOX_DOC_XIDL_SRC_TMP) \
331	$(VBOX_MANUAL_APIREF_TMP)
332
333	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
334
335	#
336	# target for installing UserManual.pdf
337	#
338	VBox-docs-usermanual_INST = $(INST_BIN)
339	VBox-docs-usermanual_MODE = a+r,u+w
340	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
341
342	VBox-docs-usermanual-qhelp_INST = $(INST_BIN)
343	VBox-docs-usermanual-qhelp_MODE = a+r,u+w
344	VBox-docs-usermanual-qhelp_SOURCES = \
345	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc \
346	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
347
348	#
349	# target for installing translated UserManual_*.pdf
350	#
351	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
352	VBox-docs-usermanual-l10n_MODE = a+r,u+w
353	VBox-docs-usermanual-l10n_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
354
355	#
356	# target for installing the chunked HTML docs
357	#
358	VBox-docs-usermanual-html_INST = $(INST_BIN)
359	VBox-docs-usermanual-html_MODE = a+r,u+w
360	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
361
362	#
363	# target for installing SDKRef.pdf
364	#
365	VBox-docs-sdkref_INST = $(INST_SDK)docs/
366	VBox-docs-sdkref_MODE = a+r,u+w
367	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
368
369	#
370	# target for installing Accessibility.pdf
371	#
372	VBox-docs-accessibility_INST = $(INST_BIN)
373	VBox-docs-accessibility_MODE = a+r,u+w
374	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
375
376	#
377	# target for installing Accessibility.html
378	#
379	VBox-docs-accessibility-html_INST = $(INST_BIN)
380	VBox-docs-accessibility-html_MODE = a+r,u+w
381	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
382
383	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
384
385	##
386	# Morph man pages into manual sections.
387	# $(evalcall2 def_vbox_refentry_to_user_sect1)
388	# @param 1 Language.
389	# @param 2 the refentry xml base file name.
390	# @param 3 the full refentry xml file path.
391	define def_vbox_refentry_to_user_sect1
392	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): $(3) \
393	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
394	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
395	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
396	$$(call MSG_TOOL,xsltproc $$(notdir $$(filter %.xsl,$$^)),,$$(filter %.xml,$$^),$$@)
397	$$(QUIET)$$(RM) -f "$$@"
398	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
399	endef
400	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
401	man_VBoxHeadless.xml \
402	man_vboximg-mount.xml \
403	, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file),$(VBOX_PATH_MANUAL_SRC)/$(lang)/$(file))))
404	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
405	,$(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),isomakercmd-man.xml,$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
406
407
408	# Generates the VBoxManage command overview include file (shared between
409	# languages) from the refsynopsisdiv section of the man pages.
410	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)): \
411	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-overview.xsl \
412	$$(patsubst overview_%,$$(VBOX_PATH_MANUAL_SRC)/en_US/%,$$(notdir $$@)) \
413	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
414	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
415	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
416	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
417
418
419
420
421
422	##########################################################################################
423	#
424	# Shared rules for PDF generation
425	#
426	##########################################################################################
427
428	ifndef VBOX_OSE
429	# copy ucs.sty and related files
430	$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/ucs.sty):
431	$(call MSG_L1,Copying unicode support for LaTeX)
432	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
433	endif
434
435	# copy the PNG files.
436	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
437	define def_vbox_cp_images_pdf
438	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
439	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
440	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
441	$$(call MSG_L1,Copying temporary $$< => $$@)
442	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
443	endef
444	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
445
446
447	##########################################################################################
448	#
449	# UserManual.pdf
450	#
451	##########################################################################################
452
453	# Useful aliases
454	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
455
456
457	#
458	# SDKRef.pdf
459	#
460
461	# Replace <tt> tags in VirtualBox.xidl.
462	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
463	$(call MSG_L1,Generating $@)
464	$(QUIET)$(SED) -e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
465	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
466	--output $@ $<
467
468	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
469	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
470	$(call MSG_L1,Generating $@)
471	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
472
473	# Turn SDKRef.xml into LaTeX.
474	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
475	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
476	$(VBOX_MANUAL_APIREF_TMP) \
477	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
478	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
479	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
480	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
481	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
482	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
483	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
484	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
485	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
486	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
487	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
488	$(QUIET)$(SED) \
489	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
490	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
491	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
492	--output $@ $@.tmp
493	$(QUIET)$(RM) -f $@.tmp
494
495	# Turn SDKRef.tex into a PDF.
496	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
497	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
498	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
499	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
500	$(call MSG_L1,pdflatex $< (three passes))
501	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
502	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
503	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
504	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
505	$(QUIET)$(SED) -n \
506	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
507	$(basename $<).log
508	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
509
510	# Validating SDKRef.xml. It is invoked automatically at build time,
511	# but can also be manually invoked via the 'validate-sdkref' alias.
512	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
513	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
514	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
515	$(VBOX_MANUAL_APIREF_TMP) \
516	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
517	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
518	$(call MSG_L1,Validating $<)
519	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
520	$(QUIET)$(APPEND) -t "$@" "done"
521
522
523	# Handy aliases.
524	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
525	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
526
527
528
529	#
530	# Accessibility.pdf
531	#
532
533	# Turn Accessibility.xml into LaTeX.
534	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
535	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
536	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
537	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
538	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
539	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
540	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
541	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
542	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
543	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
544	-o $@.tmp $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
545	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
546	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
547	$(QUIET)$(SED) \
548	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
549	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
550	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
551	--output $@ $@.tmp
552	$(QUIET)$(RM) -f $@.tmp
553
554	# Turn Accessibility.tex into a PDF.
555	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
556	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
557	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
558	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \| $$(dir $$@)
559	$(call MSG_L1,pdflatex $< (three passes))
560	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
561	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
562	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
563	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
564	$(QUIET)$(SED) -n \
565	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
566	$(basename $<).log
567	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
568
569	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
570	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
571	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
572	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
573	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
574	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
575	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
576	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
577	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
578	$<
579
580	# Validating Accessibility.xml. It is invoked automatically at build time,
581	# but can also be manually invoked via the 'validate-accessibility' alias.
582	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
583	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
584	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
585	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
586	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
587	$(call MSG_L1,Validating $<)
588	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
589	$(QUIET)$(APPEND) -t "$@" "done"
590
591
592	# Handy aliases.
593	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
594	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
595	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
596
597
598	# A few things which are shared between htmlhelp and qhelp docs.
599	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
600	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
601	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
602	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
603
604	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
605	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
606	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
607	$(call MSG_L1,xsltproc $<)
608	$(QUIET)$(RM) -f $@.tmp $@
609	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o $@.tmp $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
610	$(QUIET)$(MV) -f $@.tmp $@
611
612	# Packing the docs into a zip file
613	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
614	$(call MSG_L1,Packing documentation $@)
615	$(QUIET)$(RM) -f $@
616	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
617
618
619	##########################################################################################
620	#
621	# UserManual.html
622	#
623	##########################################################################################
624
625	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
626	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
627	$(call MSG_L1,Packing documentation $@)
628	$(QUIET)$(RM) -f $@
629	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
630	-9 -r $@ html-chunks
631
632	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
633	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
634	$(call MSG_L1,Building html chunks $@)
635	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
636	/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
637	/transtype:xhtml \
638	/ditadir:$(VBOX_DITA_PATH) \
639	/outdir:$(@D) \
640	/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml
641
642	# disable for now
643	#html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
644	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
645	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
646	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
647
648
649	##########################################################################################
650	#
651	# DITA stuff common to pdf, qhelp, and html outputs.
652	# - copy DITA-OT library (binaries etc) since at each run several run-time config
653	# files are updated.
654	# - create dita/topic folder and copy all user manual dita files under that.
655	# - copy all images under dita/topics/images and UserManual.ditamap under dita folder
656	# - copy all man_V*.xml docbook files under dita/topic folder.
657	# - flatten refsect1/refsect2 hierarchy in man_V*.xml docbook files by
658	# using refsect2_to_refsect1.py.
659	# - convert man_V*.xml files into dita files
660	# - mark external link in the man_V*.dita files
661	# - correct all reference targets by calling correct_references.py.
662	#
663	# Note! INSTALL_STAGING is likely to hardlink the files, thus we must use +\| below
664	# when copying files as much won't change timestamp. It would in fact be a _lot_
665	# better to copy the files individually.
666	#
667	##########################################################################################
668
669	BLDDIRS += \
670	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita \
671	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics \
672	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
673
674	VBOX_USER_MANUAL_STAGED_DITA_FILES := $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/, \
675	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita)))
676	VBOX_USER_MANUAL_STAGED_IMAGE_FILES := $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images/, \
677	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*)))
678
679	$(VBOX_USER_MANUAL_STAGED_DITA_FILES) \
680	$(VBOX_USER_MANUAL_STAGED_IMAGE_FILES) \
681	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap: \
682	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/% : \
683	$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% \| $$(dir $$@)
684	$(INSTALL_STAGING) -v -m 0644 -- "$<" "$(@D)/"
685
686	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/reference.dtd: \| $$(dir $$@)
687	$(QUIET)$(TOUCH) -- "$@"
688
689	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml: \
690	$(VBOX_PATH_MANUAL_SRC)/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml \| $$(dir $$@)
691	$(QUIET)$(INSTALL_STAGING) -m 0644 -- "$<" "$(@D)/"
692
693	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common: \
694	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap \
695	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/reference.dtd \
696	$(VBOX_USER_MANUAL_STAGED_DITA_FILES) \
697	$(VBOX_USER_MANUAL_STAGED_IMAGE_FILES) \
698	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES) \
699	$(VBOX_DITA_PATH)
700	$(call MSG_L1, Ran common dita steps)
701	$(QUIET)$(TOUCH) -- "$@"
702
703
704	##########################################################################################
705	#
706	# Docbook to Dita conversion of our refentry files
707	#
708	##########################################################################################
709
710	# Generate a ID to FILE mapping database that def_vbox_refentry_to_dita can apply below.
711	VBOX_USER_MANUAL_ID_MAPPING_FILE := $(VBOX_PATH_MANUAL_OUTBASE)/en_US/id-mapping-file.db
712	OTHER_CLEAN += $(VBOX_USER_MANUAL_ID_MAPPING_FILE)
713	$(VBOX_USER_MANUAL_ID_MAPPING_FILE): \
714	$(VBOX_PATH_MANUAL_SRC)/build_id_to_file_mapping.py \
715	$(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/.xml $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/.dita) \
716	\| $(dir $@)
717	$(call MSG_L1, $<)
718	$(QUIET)$(VBOX_BLD_PYTHON) "$<" --output "$@" \
719	"$(VBOX_PATH_MANUAL_SRC)/en_US/*.xml" \
720	"$(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*.dita"
721
722	# Accumulated list of conversion output file names used by dita_common above.
723	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES := $(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita
724
725	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/user_isomakercmd-man.dita: \
726	$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
727	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml \| $$(dir $$@)
728	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
729	--maxdepth 6000 \
730	--output "$@" \
731	"$<" \
732	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_isomakercmd-man.xml
733
734	define def_vbox_refentry_to_dita
735	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(basename $(2)).dita
736	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(basename $(2)).dita \
737	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2): \
738	$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl \
739	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2)) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2)) \
740	$$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl \
741	$$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
742	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE) \
743	$$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/man_VBoxManage-dhcpserver-dhcpoptions.xml \
744	$$(VBOX_XML_CATALOG) \
745	$$(VBOX_XML_CATALOG_DOCBOOK) \
746	$$(VBOX_XML_CATALOG_MANUAL) \
747	$$(VBOX_XML_ENTITIES) \
748	$$(VBOX_VERSION_STAMP) \
749	\| $$$$(dir $$$$@)
750	$$(call MSG_TOOL,xsltproc docbook2dita.xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
751	$$(QUIET)$$(RM) -f "$$@"
752	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/refsect2_to_refsect1.py \
753	-i $$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2)) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2)) \
754	-o "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)"
755	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
756	"$$(VBOX_DITA_CONVERTER_PATH)/db2dita/docbook2dita.xsl" \
757	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2)"
758	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output "$$@" \
759	"$$(VBOX_PATH_MANUAL_SRC)/mark_external_urls.xsl" "$$@"
760	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py -v \
761	--mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE)" "$$@"
762	endef
763	$(foreach lang,$(VBOX_MANUAL_LANGUAGES) \
764	,$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount.xml man_VBoxHeadless.xml \
765	,$(evalcall2 def_vbox_refentry_to_dita,$(lang),$(file))))
766
767
768	##########################################################################################
769	#
770	# Use DITA-OT to create pdf/hhp out of UserManual.ditamap. See usermanual.pdf under
771	# DITA-OT-xxxxx/doc folder for details.
772	#
773	##########################################################################################
774	# Copy the dita library under out folder since at each use the library modifies some
775	# run-time configuation files and there seems to be no way to override this.
776	## @todo r=bird: This is _incredibly_ crude. But then, the tool is the worst with its inane
777	## desire to modify build.xml, catalog-dita.xml and lib/org.dita.dost.platform/plugin.properties
778	## with a fresh plugin setup (the differences seems to be down to hashing/map
779	## ordering difference). Wonder if we can get away with a single copy
780	## as long as we do the plugin update right after duplicating it here...
781	## Also, I would _really_ like to symlink/hardlink as much as possible
782	## of it to save time and storage space.
783	$(VBOX_DITA_PATH):
784	$(MKDIR) -p $(VBOX_DITA_PATH)
785	$(CP) -vR -- "$(VBOX_DITA_ORIGINAL_PATH)/" "$(VBOX_DITA_PATH)/"
786
787	VBOX_DITA_PATH_LIB ?= $(VBOX_DITA_PATH)/lib
788	VBOX_DITA_ENV_SETUP ?= $(REDIRECT) \
789	-E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
790	-E 'ANT_HOME=$(VBOX_DITA_PATH)/tools/ant' \
791	-E 'DITA_DIR=$(VBOX_DITA_PATH)' \
792	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
793	-A 'PATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH)/tools/ant/bin' \
794	-E 'CLASSPATH=$(VBOX_DITA_PATH_LIB)/dost.jar' \
795	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)' \
796	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/commons-codec-1.4.jar' \
797	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/resolver.jar' \
798	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/icu4j.jar' \
799	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xercesImpl.jar' \
800	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/xml-apis.jar' \
801	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9.jar' \
802	-A 'CLASSPATH=$(HOST_PATH_SEP)$(VBOX_DITA_PATH_LIB)/saxon/saxon9-dom.jar' \
803	--
804
805	# Note! The /tempdir is deleted, recreated, used and deleted again for each run. So, be careful where you point it.
806	# Note! This crappy utility may fail to find files (or fail to parse the
807	# command line) and still return a successfully (0) exit code.
808	define def_ditamap_to_pdf
809	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf \
810	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log \
811	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.list \
812	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.xml.properties: \
813	$$(VBOX_MANUAL_XML_FILES_COMMON) \
814	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
815	$$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
816	$(QUIET)$(RM) -f -- "$$@"
817	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
818	/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
819	/transtype:pdf \
820	/ditadir:$(VBOX_DITA_PATH) \
821	/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1) \
822	/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf
823
824	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
825	endef
826	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
827
828	#
829	# ChangeLog.html
830	#
831	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
832	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
833	#
834	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
835	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
836	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
837	$(VBOX_XML_CATALOG) \
838	$(VBOX_XML_CATALOG_DOCBOOK) \
839	$(VBOX_XML_CATALOG_MANUAL) \
840	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
841	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
842	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
843	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
844
845	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
846
847
848
849	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
850
851
852	#
853	# VBoxManage man pages (parts also required by VBoxManage built-in help).
854	#
855
856	##
857	# Emits rules for preprocessing refentry sources (applying remarks element),
858	# and for producing the actual man pages.
859	# $(evalcall2 def_vbox_refentry_to_manpage)
860	# @param 1 The language
861	# @param 2 The file name (no path).
862	define def_vbox_refentry_to_manpage
863	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
864	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
865	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
866	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
867	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
868	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
869	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
870	$$(QUIET)$$(RM) -f "$$@"
871	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
872	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
873	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@.tmp $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
874	$$(QUIET)$$(MV) -f -- "$$@.tmp" "$$@"
875	if defined(VBOX_HAVE_XMLLINT)
876	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
877	endif
878
879	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
880	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
881	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
882	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
883	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
884	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
885	$$(QUIET)$$(RM) -f "$$@"
886	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
887	endef
888	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
889	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
890
891	ifdef VBOX_WITH_DOCS_QHELP
892	#
893	# VirtualBox.qch/VirtualBox.qhc
894	#
895	# We first generate a .hhp help source file from the preprocessed
896	# DocBook XML files, as defined above, then feed that into a converter
897	# creating the suitable input for creating a QHelp collection file.
898
899	# Generate QCH from QHelp source
900	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
901	define def_vbox_usermanual_qhp_to_qch
902	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
903	$$(out_dir)/qhelp/UserManual.qch \
904	+ $$(out_dir)/qhelp/UserManual.qhc: \
905	$$(out_dir)/qhelp/UserManual.qhcp \
906	$$(out_dir)/qhelp/UserManual.qhp \
907	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
908	\| $$$$(dir $$$$@)
909	$$(call MSG_L1,$$(notdir $$(QHELPGENERATOR)) $$<,=> $$@)
910	$$(QUIET)$$(RM) -f $$@
911	$$(QUIET)$$(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT5)/plugins -- $$(QHELPGENERATOR) $$<
912	$$(call MSG_L1,Fresh QCH is now at $$@)
913	endef
914	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_qhp_to_qch))
915
916	# Generate QHP from HHP for QHelp
917	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
918	define def_vbox_usermanual_hhp_qhelp_to_qhp
919	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)
920	$$(out_dir)/qhelp/UserManual.qhp: \
921	$$(out_dir)/qhelp/UserManual.hhp \
922	$$(addprefix $$(out_dir)/qhelp/,$$(VBOX_MANUAL_PNG_FILES_$(lang))) \
923	\| $$$$(dir $$$$@)
924	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
925	$$(QUIET)$$(RM) -f $$@
926	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py -d $$(<D) -o $$@ -f UserManual.hhp -t UserManual.hhc
927	endef
928	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_vbox_usermanual_hhp_qhelp_to_qhp))
929
930
931	define def_ditamap_to_htmlhelp
932	ditamap-to-htmlhelp: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp
933	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp/UserManual.hhp: \
934	$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
935	$(QUIET)$(call VBOX_DITA_ENV_SETUP) $(VBOX_JAVA) -jar $(VBOX_DITA_PATH_LIB)/dost.jar \
936	/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap \
937	/transtype:htmlhelp \
938	/ditadir:$(VBOX_DITA_PATH) \
939	/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/qhelp \
940	/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_htmlhelp
941
942	endef
943	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(evalcall2 def_ditamap_to_htmlhelp,$(lang)))
944
945	# copy the qhcp file.
946	define def_vbox_cp_qhcp
947	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
948	$$(out_dir)/UserManual.qhcp: \
949	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/% \| $$$$(dir $$$$@)
950	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
951	endef
952	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_qhcp)))
953
954	# copy the PNG files.
955	# Note: out_dir referenced with double $$ to delay expansion to the eval step when out_dir has been defined.
956	define def_vbox_cp_images_qhelp
957	local out_dir := $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp
958	$(addprefix $$(out_dir)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
959	$$(out_dir)/% : $(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
960	$$(call MSG_L1,Copying temporary $$< => $$@)
961	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
962	endef
963	$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(eval $(def_vbox_cp_images_qhelp)))
964
965	endif # VBOX_WITH_DOCS_QHELP
966
967	# Handy aliases.
968	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
969	man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
970	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
971
972	#
973	# Manually updating the DHCP option list taken from VirtualBox.xidl
974	#
975	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
976	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
977	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
978
979
980	include $(FILE_KBUILD_SUB_FOOTER)
981

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

Download in other formats:

Original Format