Makefile.kmk@ 99197

Last change on this file since 99197 was 99175, checked in by vboxsync, 23 months ago
Docs: bugref:9831. Removing some of the remaining chm bits.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 43.1 KB

Line
1	# $Id: Makefile.kmk 99175 2023-03-24 13:19:02Z 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 makefile produces our user manual (among a few other things) in
30	# 3 formats: qHelp, pdf, and html (chunked and single page). User manual
31	# files are kept in dita format. VBoxManage commands are documented using docbook
32	# refentry elements and integrated into VBoxManage binary after converting those
33	# to .cpp and .h files (not here). Additionally, we add these refentry's into the
34	# user manual as a chapter after converting them into dita files. Both the user manual
35	# and converted VBoxManage commands files are referenced with a single ditamap.
36	# This ditamap is then transformed into html, htmlhelp (for qHelp), and pdf.
37	#
38
39
40	SUB_DEPTH = ../..
41	include $(KBUILD_PATH)/subheader.kmk
42
43	ifndef VBOX_DOC_MANUAL_CONFIG_KMK_INCLUDED
44	include $(PATH_SUB_CURRENT)/Config.kmk
45	endif
46
47	if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK)) # Whole file.
48
49	#
50	# Globals
51	#
52
53	## Combines the VBOX_MANUAL_LANGUAGES and VBOX_MANUAL_ADD_LANGUAGES lists from
54	# /Config.kmk, as per the VBOX_WITH_DOCS_TRANSLATIONS setting.
55	ifdef VBOX_WITH_DOCS_TRANSLATIONS
56	VBOX_MANUAL_ALL_LANGUAGES := $(VBOX_MANUAL_LANGUAGES) $(VBOX_MANUAL_ADD_LANGUAGES)
57	else
58	VBOX_MANUAL_ALL_LANGUAGES := $(VBOX_MANUAL_LANGUAGES)
59	endif
60
61	## The files that should go into VBoxDocumentation.zip (must be immediately under PATH_STAGE_BIN).
62	VBOX_MANUAL_PACK =
63
64	# Various file lists (mainly needed for OTHER_CLEAN).
65	VBOX_QHELP_OUTPUT_FILES := UserManual.qch UserManual.qhc
66	VBOX_ACCESSIBILITY_XML_FILES := Accessibility.xml
67	VBOX_MANUAL_LATEX_FILES_TARGET := $(addprefix UserManual.,aux log out toc tex)
68	VBOX_SDKREF_LATEX_FILES_TARGET := $(addprefix SDKRef.,aux log out toc tex)
69	VBOX_ACCESSIBILITY_LATEX_FILES_TARGET := $(addprefix Accessibility.,aux log out toc tex)
70
71	VBOX_MANUAL_TEX_UNICODE_FILES = $(wildcard $(VBOX_PATH_MANUAL_SRC)/texfiles/unicode/*)
72
73	# Wildcard the images path for every supported language
74	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
75	,$(eval VBOX_MANUAL_PNG_FILES_$$(lang) := $$(patsubst $$(VBOX_PATH_MANUAL_SRC)/$$(lang)/%,%, \
76	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$$(lang)/images/*.png))))
77
78	# SDK related globals.
79	VBOX_MANUAL_APIREF_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml
80	VBOX_DOC_XIDL_SRC = $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
81	VBOX_DOC_XIDL_SRC_TMP = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.xidl.tmp
82
83
84	#
85	# PDF LaTeX related globals.
86	#
87
88	VBOX_PDFLATEX_INTERACTION ?= batchmode
89	# VBOX_PDFLATEX_INTERACTION = errorstopmode - Use this when you wants to figure out build failures
90	# without catting the log a million times.
91	ifeq ($(KBUILD_HOST),win)
92	ifndef VBOX_PDFLATEX
93	VBOX_PDFLATEX := $(firstword $(rsort $(wildcard $(KBUILD_DEVTOOLS)/win.x86/miktex-portable/*/miktex/bin/pdflatex.exe)))
94	ifneq ($(VBOX_PDFLATEX),)
95	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION)
96	endif
97	endif
98	ifndef VBOX_PDFLATEX
99	# Tell MiKTeX to automatically download packages if system wide install.
100	VBOX_PDFLATEX := pdflatex
101	VBOX_PDFLATEX_CMD = $(VBOX_PDFLATEX) -halt-on-error -interaction $(VBOX_PDFLATEX_INTERACTION) --enable-installer
102	endif
103	else
104	VBOX_PDFLATEX ?= pdflatex
105	VBOX_PDFLATEX_HALT = $(shell ( $(VBOX_PDFLATEX) -version \| head -1 \| grep 141592 > /dev/null ) && echo -halt-on-error )
106	VBOX_PDFLATEX_CMD = pdflatex $(VBOX_PDFLATEX_HALT) -interaction $(VBOX_PDFLATEX_INTERACTION)
107	endif
108
109
110	#
111	# DITA-OT related globals.
112	#
113
114	##
115	# Copies DITA-OT to $1, runs the dost.jar with /ditadir given and nukes $1 when done.
116	#
117	# Additional options for dost.jar can be specified following the call to VBOX_DITA_RUN_DOST
118	#
119	# @param 1 Temporary+unique DITA-OT path.
120	# @param 2 Additional kmk_redirect options.
121	# @param 3 Parameters for the invoker.
122	# @param 4 Parameters only for 1.8.5.
123	# @param 5 Parameters only for 4.0.2.
124	#
125	VBOX_DITA_RUN_DOST ?= $(REDIRECT) \
126	-E 'ANT_OPTS=-Xmx512m -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl' \
127	-E 'ANT_HOME=$1/tools/ant' \
128	-E 'DITA_DIR=$1' \
129	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
130	-A 'PATH=$(HOST_PATH_SEP)$1/tools/ant/bin' \
131	-E 'CLASSPATH=$1/lib/dost.jar' \
132	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib' \
133	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/commons-codec-1.4.jar' \
134	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/resolver.jar' \
135	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/icu4j.jar' \
136	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xercesImpl.jar' \
137	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/xml-apis.jar' \
138	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9.jar' \
139	-A 'CLASSPATH=$(HOST_PATH_SEP)$1/lib/saxon/saxon9-dom.jar' \
140	$2 \
141	-- $(ASH) $(VBOX_PATH_MANUAL_SRC)/dita-ot-copy-exec.sh "$(VBOX_DITA_ORIGINAL_PATH)" "$1" \
142	-- $(VBOX_JAVA) -jar "$1/lib/dost.jar" "/ditadir:$1" $3 $4 # "/outercontrol:fail" ?
143
144	if 0 # Experiments with dita-ot v4.0.2. Requires java 17.
145	VBOX_JAVA_HOME := C:/Program Files/Java/jdk-17/
146	VBOX_DITA_ORIGINAL_PATH := D:/Tmp/dita/dita-ot-4.0.2
147	VBOX_DITA_CLASSPATH = \
148	$(subst $(SP),;,$(strip \
149	$(VBOX_DITA_ORIGINAL_PATH)/lib/ant-launcher.jar \
150	$(VBOX_DITA_ORIGINAL_PATH)/config \
151	$(VBOX_DITA_ORIGINAL_PATH)/lib \
152	$(wildcard \
153	$(VBOX_DITA_ORIGINAL_PATH)/lib/*.jar \
154	$(VBOX_DITA_ORIGINAL_PATH)/plugins//lib/.jar)))
155	VBOX_DITA_RUN_DOST = $(REDIRECT) \
156	-E 'ANT_HOME=$(VBOX_DITA_ORIGINAL_PATH)' \
157	-E 'DITA_DIR=$(VBOX_DITA_ORIGINAL_PATH)' \
158	-E 'JAVA_HOME=$(VBOX_JAVA_HOME)' \
159	-E 'CLASSPATH=$(VBOX_DITA_CLASSPATH)' \
160	$2 \
161	-- \
162	$(VBOX_JAVA) \
163	"-Djava.awt.headless=true" \
164	"-Dsun.io.useCanonCaches=true" \
165	"-Dant.home=$(VBOX_DITA_ORIGINAL_PATH)" \
166	"-Ddita.dir=$(VBOX_DITA_ORIGINAL_PATH)" \
167	org.apache.tools.ant.launch.Launcher \
168	-cp "$(VBOX_DITA_CLASSPATH)" \
169	-buildfile "$(VBOX_DITA_ORIGINAL_PATH)/build.xml" \
170	-main "org.dita.dost.invoker.Main" \
171	$(patsubst "/i:%,"--input=%, \
172	$(patsubst "/transtype:%,"--format=%, \
173	$(patsubst "/outdir:%,"--output=%, \
174	$(patsubst "/tempdir:%,"--temp=%, \
175	$(patsubst "/filter:%,"--filter=%, \
176	$(patsubst "/debug","--debug",$3)))))) \
177	$5 --verbose --debug
178	endif
179
180
181	#
182	# Targets
183	#
184
185	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_ALL_LANGUAGES))
186
187	ifdef VBOX_ONLY_DOCS
188	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
189	endif
190
191	BLDDIRS += \
192	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita \
193	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics \
194	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images
195
196	BLDDIRS += \
197	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
198	$(addsuffix /images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
199	$(addsuffix /html-single, $(VBOX_MANUAL_ALL_LANGUAGES)) \
200	$(addsuffix /html-chunks, $(VBOX_MANUAL_ALL_LANGUAGES)) \
201	$(addsuffix /qhelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
202	$(addsuffix /qhelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
203	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
204	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
205	)
206
207	# Explicit cleaning has some overlap with default cleaning rules, since this
208	# Makefile is using very complex conditionals for selectively creating
209	# specific files, and not everyone remembers to use the same with "kmk clean".
210	OTHER_CLEAN += \
211	$(VBOX_XML_CATALOG) \
212	$(VBOX_XML_CATALOG_DOCBOOK) \
213	$(VBOX_XML_CATALOG_MANUAL) \
214	$(VBOX_XML_ENTITIES) \
215	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES) \
216	,$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
217	$(VBOX_XML_XREF_TO_TEXT) \
218	$(VBOX_XML_XREF_TO_TEXT).cat \
219	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
220	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
221	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
222	man_VBoxHeadless.xml \
223	user_man_VBoxHeadless.xml \
224	man_vboximg-mount.xml \
225	user_man_vboximg-mount.xml \
226	isomakercmd-man.xml \
227	user_isomakercmd-man.xml \
228	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
229	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
230	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
231	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
232	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
233	html-single/UserManual.html \
234	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
235	$(addprefix HTMLHelp/, index.html go01.html) \
236	$(addprefix qhelp/, index.html go01.html) \
237	$(addprefix html-chunks/, index.html go01.html) \
238	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
239	,html-chunks/ch$(n).html \
240	html-chunks/re$(n).html \
241	HTMLHelp/ch$(n).html \
242	HTMLHelp/re$(n).html \
243	$(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)) \
244	qhelp/ch$(n).html \
245	qhelp/re$(n).html \
246	$(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)) ) \
247	$(foreach n,a b c \
248	,html-chunks/ap$(n).html \
249	HTMLHelp/ap$(n).html \
250	$(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) \
251	qhelp/ap$(n).html \
252	$(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) ) \
253	$(foreach n,01 02 03 04 05 \
254	,html-chunks/pr$(n).html \
255	HTMLHelp/pr$(n).html \
256	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
257	qhelp/pr$(n).html \
258	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
259	HTMLHelp/toc.hhc \
260	HTMLHelp/htmlhelp.hhp \
261	qhelp/toc.hhc \
262	qhelp/htmlhelp.hhp \
263	UserManual.pdf \
264	$(VBOX_QHELP_OUTPUT_FILES) \
265	ChangeLog.html \
266	validatemanual.run \
267	validateaccessibility.run \
268	validatesdkref.run \
269	) \
270	) \
271	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
272	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
273	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
274	$(PATH_STAGE_BIN)/UserManual.pdf \
275	\
276	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
277	$(VBOX_SDKREF_LATEX_FILES_TARGET) \
278	SDKRef.pdf \
279	) \
280	$(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf \
281	\
282	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
283	$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET) \
284	html-single/Accessibility.html \
285	Accessibility.pdf \
286	) \
287	$(PATH_STAGE_BIN)/Accessibility.html \
288	$(PATH_STAGE_BIN)/Accessibility.pdf \
289	\
290	$(VBOX_DOC_XIDL_SRC_TMP) \
291	$(VBOX_MANUAL_APIREF_TMP)
292
293
294	ifndef VBOX_ONLY_SDK
295	#
296	# target for installing UserManual.pdf
297	#
298	INSTALLS += VBox-docs-usermanual
299	VBox-docs-usermanual_INST = $(INST_BIN)
300	VBox-docs-usermanual_MODE = a+r,u+w
301	VBox-docs-usermanual_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
302	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual.pdf
303
304	ifdef VBOX_WITH_DOCS_TRANSLATIONS
305	#
306	# target for installing translated UserManual_*.pdf
307	#
308	INSTALLS += VBox-docs-usermanual-l10n
309	VBox-docs-usermanual-l10n_INST = $(INST_BIN)
310	VBox-docs-usermanual-l10n_MODE = a+r,u+w
311	VBox-docs-usermanual-l10n_SOURCES = \
312	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
313	VBOX_MANUAL_PACK += $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
314	endif
315
316	ifdef VBOX_WITH_DOCS_HTML
317	#
318	# target for installing the chunked HTML docs
319	#
320	INSTALLS += VBox-docs-usermanual-html
321	VBox-docs-usermanual-html_INST = $(INST_BIN)
322	VBox-docs-usermanual-html_MODE = a+r,u+w
323	VBox-docs-usermanual-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip=>UserManual-html.zip
324	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/UserManual-html.zip
325	endif
326
327	ifdef VBOX_WITH_DOCS_QHELP
328	#
329	# Installs the qhelp version of the manual.
330	#
331	INSTALLS += VBox-docs-usermanual-qhelp
332	VBox-docs-usermanual-qhelp_INST = $(INST_BIN)
333	VBox-docs-usermanual-qhelp_MODE = a+r,u+w
334	VBox-docs-usermanual-qhelp_SOURCES = \
335	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qhc \
336	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/UserManual.qch
337	ifdef VBOX_WITH_DOCS_QHELP_PACKING
338	VBOX_MANUAL_PACK += \
339	$(PATH_STAGE_BIN)/UserManual.qch \
340	$(PATH_STAGE_BIN)/UserManual.qhc
341	endif
342	endif
343
344	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
345	#
346	# target for installing Accessibility.pdf
347	#
348	INSTALLS += VBox-docs-accessibility
349	VBox-docs-accessibility_INST = $(INST_BIN)
350	VBox-docs-accessibility_MODE = a+r,u+w
351	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
352
353	#
354	# target for installing Accessibility.html
355	#
356	INSTALLS += VBox-docs-accessibility-html
357	VBox-docs-accessibility-html_INST = $(INST_BIN)
358	VBox-docs-accessibility-html_MODE = a+r,u+w
359	VBox-docs-accessibility-html_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
360	endif
361
362	endif # !VBOX_ONLY_SDK
363
364	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
365	#
366	# target for installing SDKRef.pdf
367	#
368	INSTALLS += VBox-docs-sdkref
369	VBox-docs-sdkref_INST = $(INST_SDK)docs/
370	VBox-docs-sdkref_MODE = a+r,u+w
371	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
372	endif
373
374
375	#
376	# Shared rules for LaTeX based PDF generation - Only used for SDK & Accessibility.
377	#
378
379	ifndef VBOX_OSE
380	# Copy ucs.sty and associated files.
381	## @todo r=bird: This is ugly since only ucs.sty is listed as output while we're actually copying 177 other files.
382	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/ucs.sty): \| $$(dir $$@)
383	$(call MSG_L1,Copying unicode support for LaTeX)
384	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
385	endif
386
387	# Copy the PNG files.
388	define def_vbox_cp_images_pdf
389	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
390	$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/% : \
391	$(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
392	$$(call MSG_L1,Copying temporary $$< => $$@)
393	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
394	endef
395	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
396
397
398	#################################################################################################################################
399	# SDKRef.pdf - xidl => Docbook => LaTeX => PDF #
400	#################################################################################################################################
401
402	VBOX_SDKREF_XML_FILES = SDKRef.xml
403
404	# Replace @a and @c with <tt> tags in VirtualBox.xidl.
405	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
406	$(call MSG_L1,Generating $@)
407	$(QUIET)$(SED) \
408	-e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
409	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
410	--output $@ $<
411
412	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
413	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
414	$(call MSG_L1,Generating $@)
415	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
416
417	# Turn SDKRef.xml into LaTeX.
418	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
419	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
420	$(VBOX_MANUAL_APIREF_TMP) \
421	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
422	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
423	$(VBOX_XML_CATALOG) \
424	$(VBOX_XML_CATALOG_DOCBOOK) \
425	$(VBOX_XML_CATALOG_MANUAL) \
426	$(VBOX_XML_ENTITIES) \
427	$(MAKEFILE_CURRENT) \
428	\| $$(dir $$@)
429	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
430	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
431	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
432	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
433	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
434	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
435	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
436	$(QUIET)$(SED) \
437	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
438	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
439	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
440	--output $@ [email protected]
441	$(QUIET)$(RM) -f [email protected]
442
443	# Turn SDKRef.tex into a PDF.
444	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
445	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
446	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
447	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
448	\| $$(dir $$@)
449	$(call MSG_L1,pdflatex $< (three passes))
450	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
451	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
452	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
453	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
454	$(QUIET)$(SED) -n \
455	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
456	$(basename $<).log
457	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
458
459	# Validating SDKRef.xml. It is invoked automatically at build time,
460	# but can also be manually invoked via the 'validate-sdkref' alias.
461	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
462	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
463	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
464	$(VBOX_MANUAL_APIREF_TMP) \
465	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
466	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
467	$(call MSG_L1,Validating $<)
468	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
469	$(QUIET)$(APPEND) -t "$@" "done"
470
471
472	# Handy aliases.
473	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
474	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
475
476
477	#################################################################################################################################
478	# Accessibility.pdf - Docbook => LaTeX => PDF #
479	#################################################################################################################################
480
481	# Turn Accessibility.xml into LaTeX.
482	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
483	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
484	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
485	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
486	$(VBOX_XML_CATALOG) \
487	$(VBOX_XML_CATALOG_DOCBOOK) \
488	$(VBOX_XML_CATALOG_MANUAL) \
489	$(VBOX_XML_ENTITIES) \
490	$(MAKEFILE_CURRENT) \
491	\| $$(dir $$@)
492	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
493	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
494	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
495	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
496	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
497	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
498	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
499	$(QUIET)$(SED) \
500	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
501	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
502	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
503	--output $@ [email protected]
504	$(QUIET)$(RM) -f [email protected]
505
506	# Turn Accessibility.tex into a PDF.
507	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
508	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
509	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
510	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
511	$(call MSG_L1,pdflatex $< (three passes))
512	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
513	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
514	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
515	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
516	$(QUIET)$(SED) -n \
517	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
518	$(basename $<).log
519	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
520
521	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
522	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
523	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
524	$(VBOX_XML_CATALOG) \
525	$(VBOX_XML_CATALOG_DOCBOOK) \
526	$(VBOX_XML_CATALOG_MANUAL) \
527	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
528	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
529	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
530	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
531	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
532	$<
533
534	# Validating Accessibility.xml. It is invoked automatically at build time,
535	# but can also be manually invoked via the 'validate-accessibility' alias.
536	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
537	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
538	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
539	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
540	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
541	$(call MSG_L1,Validating $<)
542	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
543	$(QUIET)$(APPEND) -t "$@" "done"
544
545
546	# Handy aliases.
547	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
548	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
549	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
550
551
552	#################################################################################################################################
553	# UserManual.* - The user manual in all its output variations (DITA-OT). #
554	#################################################################################################################################
555
556	#
557	# 1. We copy/hardlink all the files under <lang>/dita/* to the corresponding
558	# VBOX_PATH_MANUAL_OUTBASE location. This is mainly to deal with DITO-OT's
559	# inability to search for topic files in more than one place, so we have to
560	# gather generated and static topic sources + the .ditamap-file(s) in one
561	# place.
562	#
563
564	# Determine the basic set of files as dictated by the en_US version of the
565	# user manual (relative to $(lang)/dita). We'll use these to supply
566	# incomplete manual translations.
567	# Note! This includes .png as well as .dita and .ditamap files.
568	VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES := \
569	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/*.ditamap)) \
570	$(addprefix topics/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita))) \
571	$(addprefix topics/images/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*png)))
572
573	##
574	# Produce copying rules for one language and defining the variable
575	# VBOX_USER_MANUAL_DITA_STAGED_FILES_<lang> for use in prerequisite to
576	# anything producing a version of the user manual.
577	#
578	# @param 1 lang
579	define def_vbox_copy_manual_dita_src_files
580	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1) := \
581	$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/*.ditamap)) \
582	$$(addprefix topics/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/*dita))) \
583	$$(addprefix topics/images/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/images/*png)))
584	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK := \
585	$$(filter-out $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)), $$(VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES))
586
587	VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1) = \
588	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/, \
589	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
590	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) )
591
592	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)),)
593	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1))): \
594	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
595	$$(VBOX_PATH_MANUAL_SRC)/$1/dita/% \| $$$$(dir $$$$@)
596	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
597	endif
598
599	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK),)
600	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK)): \
601	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
602	$$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% \| $$$$(dir $$$$@)
603	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
604	endif
605
606	endef
607	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_copy_manual_dita_src_files,$(lang)))
608
609
610	#
611	# 2. Convert the manpages from Docbook refentry files to DITA reference files.
612	#
613	# In DITA links needs proper href values, with both file and ID. Since the
614	# source only has IDs, we scan all topics and refentry-files alike and
615	# generate a mapping database before we start converting them. This DB is
616	# then used at the end of each conversion to fix the hrefs.
617	#
618
619	##
620	# Do per-language stuff for the refentry -> dita file conversion.
621	#
622	# The variable VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_<lang> is defined
623	# by this define and should be expaneded as a prerequisite for any rule
624	# producing a version of the user manual.
625	#
626	# @param 1 Language.
627	#
628	define def_vbox_refentry_to_dita
629	# Generate a ID to FILE mapping database that def_vbox_refentry_to_dita can apply below.
630	VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1) := $$(VBOX_PATH_MANUAL_OUTBASE)/$1/id-mapping-file.db
631	OTHER_CLEAN += $(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1))
632	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)) + $$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)).lst: \
633	$$(VBOX_PATH_MANUAL_SRC)/build_id_to_file_mapping.py \
634	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/*.xml) \
635	$$(filter %.dita,$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1))) \
636	\| $$$$(dir $$$$@)
637	$$(call MSG_L1, $$<)
638	$$(APPEND) -nt "[email protected]" $$(filter-out %.py,$$^)
639	$$(QUIET)$$(VBOX_BLD_PYTHON) "$$<" --output "$$@" @"[email protected]"
640
641	# Accumulated list of conversion output file names to be used as a
642	# prerequisite in rules producing a version of the user manual.
643	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 :=
644
645	endef # def_vbox_refentry_to_dita
646
647	## Convert a single refentry file to dita.
648	# @param 1 Language
649	# @param 2 Filename w/o extension.
650	# @param 3 Alternative fallback filename (for isomakercmd-man.xml).
651	define def_vbox_refentry_file_to_dita
652	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita
653	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita \
654	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml: \
655	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
656	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
657	$$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
658	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1) \
659	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
660	$$(VBOX_XML_CATALOG) \
661	$$(VBOX_XML_CATALOG_DOCBOOK) \
662	$$(VBOX_XML_CATALOG_MANUAL) \
663	$$(VBOX_XML_ENTITIES) \
664	$$(VBOX_VERSION_STAMP) \
665	\| $$$$(dir $$$$@)
666	$$(call MSG_TOOL,xsltproc docbook-refentry-to-manual-dita[-pre].xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
667	$$(QUIET)$$(RM) -f -- "$$@" "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml"
668	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
669	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml" \
670	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
671	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml)
672	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
673	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).dita" \
674	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
675	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).xml"
676	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
677	--mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1)" "$$@"
678	endef # def_vbox_refentry_file_to_dita
679
680	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
681	,$(evalcall2 def_vbox_refentry_to_dita,$(lang)) \
682	$(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount man_VBoxHeadless) \
683	,$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),$(file))) \
684	$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),user_isomakercmd-man, \
685	$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
686
687	## @todo Make use of docbook-refentry-to-manual-overview.xsl again (after dita conversion)?
688
689
690	#
691	# 3a. UserManual.pdf - Run dost.jar from DITA-OT to produce the PDF version.
692	#
693	# Note! The /tempdir is deleted, recreated, used and deleted again for each
694	# run. So, be careful where you point it.
695	# Note! This crappy utility may fail to find files (or fail to parse the
696	# command line) and still return a successfully (0) exit code.
697	#
698	define def_ditamap_to_pdf
699	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf \
700	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log \
701	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.list \
702	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.xml.properties: \
703	$$(VBOX_MANUAL_XML_FILES_COMMON) \
704	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
705	$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(lang)) \
706	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(lang))
707	$$(QUIET)$$(RM) -f -- "$$@" "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log"
708	$$(QUIET)$$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf/"
709	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-pdf,, \
710	"/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
711	"/transtype:pdf" \
712	"/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
713	"/outdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
714	"/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf", \
715	,,"--logfile=$$(@D)/UserManual_pdf.log")
716
717	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
718	endef
719	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
720
721	# Useful aliases
722	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
723
724
725	#
726	# 3b. UserManual.html - Run dost.jar from DITA-OT to produce the HTML versions.
727	#
728	# We produce both chunked and singled paged HTML versions of the en_US manual
729	# mainly for uploading to virtualbox.org. The docs build box produces a zip
730	# including these.
731	#
732
733	## @todo front page
734	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
735	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
736	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
737	$(call MSG_L1,Building html chunks $@)
738	$(QUIET)$(RM) -Rf -- "$(@D)" "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks/"
739	$(QUIET)$(MKDIR) -- "$(@D)"
740	$(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-chunks,, \
741	"/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
742	"/transtype:xhtml" \
743	"/filter:$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
744	"/outdir:$(@D)" \
745	"/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \
746	,,"--logfile=$(@D)/UserManual_xhtml.log")
747
748	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
749
750	# We must modify UserManual.ditamap here, removing all chunk attributes and put
751	# a chunk="to-content" on the root element (bookmap). For clues see:
752	# https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
753	# https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
754	# We stich the index.html and UserManual-Single.html files together using
755	# SED since we haven't been able to convince DITA-OT to combine them.
756	## @todo front page
757	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
758	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
759	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
760	$(call MSG_L1,Building html chunks $@)
761	$(QUIET)$(RM) -f -- "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap"
762	$(SED) -r -e 's/ chunk=["][^"]+["]//g' -e 's/<bookmap /<bookmap chunk="to-content" /' \
763	--output "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
764	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap"
765	$(QUIET)$(RM) -Rf -- "$(@D)" "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single/"
766	$(QUIET)$(MKDIR) -- "$(@D)"
767	$(QUIET)$(call VBOX_DITA_RUN_DOST,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single,, \
768	"/i:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
769	"/transtype:xhtml" \
770	"/outdir:$(@D)" \
771	"/tempdir:$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_single" \
772	,,"--logfile=$(@D)/UserManual-Single_xhtml.log")
773	$(SED) -ne '1,/<body>/{p}' \
774	--output "$@" "$(@D)/UserManual-Single.html"
775	$(APPEND) -n "$@" "<!-- index inject: -->"
776	$(SED) -ne '/<body>/,/<\/body>/{/<body>/d;/<\/body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
777	--append "$@" "$(@D)/index.html"
778	$(APPEND) -n "$@" "<!-- resuming main file: -->"
779	$(SED) -ne '/<body>/,99999999{/<body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
780	--append "$@" "$(@D)/UserManual-Single.html"
781
782	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
783
784	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
785	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
786	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
787	$(call MSG_L1,Packing documentation $@)
788	$(QUIET)$(RM) -f $@
789	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
790	-9 -r "$@" \
791	"html-chunks" \
792	"html-single" \
793	-x "html-chunks/dita.list" \
794	-x "html-chunks/dita.xml.properties" \
795	-x "html-chunks/UserManual_xhtml.log" \
796	-x "html-single/dita.list" \
797	-x "html-single/dita.xml.properties" \
798	-x "html-single/UserManual-Single_xhtml.log" \
799	-x "html-single/index.html" \
800	-x "html-single/UserManual-Single.html"
801
802	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
803
804
805	#
806	# A few things which are shared between htmlhelp and qhelp docs.
807	# TODO: This is Docbook related work. Left here in case we can reuse some of
808	# the ideas from it for DITA-OT.
809	#
810
811	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
812	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
813	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
814	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
815
816	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
817	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
818	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
819	$(call MSG_L1,xsltproc $<)
820	$(QUIET)$(RM) -f [email protected] $@
821	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
822	$(QUIET)$(MV) -f [email protected] $@
823
824	# end old stuff.
825
826	if defined(VBOX_WITH_DOCS_QHELP) && !defined(VBOX_ONLY_SDK)
827	#
828	# 3c. VirtualBox.qch + VirtualBox.qhc - Qt compressed help and collection file.
829	#
830	# See usermanual.pdf under DITA-OT-xxxxx/doc folder for details.
831	#
832
833	# Enable Qt and locate the Qt help generator.
834	ifdef VBOX_WITH_QT6
835	USES += qt6
836	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
837	else
838	USES += qt5
839	VBOX_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')
840	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT5_BIN)/$(if-expr $(VBOX_QHELPGENERATOR_VERSION_MINOR) >= 12,qhelpgenerator,qcollectiongenerator)
841	endif
842
843	## Build QHelp version of manual for given language.
844	# @param 1 Language
845	# @param 2 The language specific qhelp output directory.
846	define def_vbox_usermanual_as_qhelp
847
848	# 1. Generate UserManual.hpp using DITA-OT.
849	#
850	# Setting HHCDIR here so that it fails to locate hcc.exe and always skips the
851	# compilation step that produces the .chm-file, since we don't need it and it
852	# mangles the path so it always fails anyway.
853	## @todo front page.
854	$(2)/UserManual.hhp: \
855	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1)) \
856	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1))
857	$$(QUIET)$$(RM) -Rf -- "$$(@D)" "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-qhelp/"
858	$$(QUIET)$$(MKDIR) -- "$$(@D)"
859	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita-ot-qhelp, -EHHCDIR="$$(@D)", \
860	"/i:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
861	"/transtype:htmlhelp" \
862	"/filter:$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
863	"/outdir:$(2)" \
864	"/tempdir:$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp" \
865	,,"--logfile=$(2)/UserManual_htmlhelp.log")
866
867
868	ditamap-to-htmlhelp: $(2)/UserManual.hhp
869
870	# 2. Generate a Qt Help Project file (QHP) using htmlhelp-qthelp.py.
871	$(2)/UserManual.qhp: \
872	$(2)/UserManual.hhp \
873	$$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py \
874	\| $$$$(dir $$$$@)
875	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
876	$$(QUIET)$$(RM) -f -- "$$@"
877	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py \
878	-d "$$(<D)" -o "$$@" -f UserManual.hhp -t UserManual.hhc
879
880	# 3. Copy the Qt help configuration file from source to the output dir.
881	$(2)/UserManual.qhcp: \
882	$$(VBOX_PATH_MANUAL_SRC)/UserManual.qhcp \
883	\| $(2)/UserManual.hhp # (Must not run parallel to UserManual.hpp, so it can safely nuke the output dir.)
884	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
885
886	# 4. Run the Qt help generator to produce the .qhc and .qch files.
887	$(2)/UserManual.qch \
888	+ $(2)/UserManual.qhc: \
889	$(2)/UserManual.qhcp \
890	$(2)/UserManual.qhp \
891	\| $$$$(dir $$$$@)
892	$$(call MSG_L1,$$(notdir $$(VBOX_QHELPGENERATOR)) $$<,=> $$@)
893	$$(QUIET)$$(RM) -f $$@
894	ifdef VBOX_WITH_QT6
895	$$(QUIET)$$(REDIRECT) -- $$(VBOX_QHELPGENERATOR) $$<
896	else
897	$$(QUIET)$$(REDIRECT) -E QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT5)/plugins -- $$(VBOX_QHELPGENERATOR) $$<
898	endif
899	$$(call MSG_L1,Fresh QCH is now at $$@)
900
901	endef # def_vbox_usermanual_as_qhelp
902
903	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
904	,$(evalcall2 def_vbox_usermanual_as_qhelp,$(lang),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp))
905
906	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
907
908	endif # VBOX_WITH_DOCS_QHELP && !VBOX_ONLY_SDK
909
910
911	#################################################################################################################################
912	# Miscellaneous #
913	#################################################################################################################################
914
915	#
916	# ChangeLog.html
917	#
918	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
919	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
920	#
921	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
922	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
923	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
924	$(VBOX_XML_CATALOG) \
925	$(VBOX_XML_CATALOG_DOCBOOK) \
926	$(VBOX_XML_CATALOG_MANUAL) \
927	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
928	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
929	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
930	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
931
932	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
933
934
935	#
936	# VBoxManage man pages (parts also required by VBoxManage built-in help).
937	#
938
939	##
940	# Emits rules for preprocessing refentry sources (applying remarks element),
941	# and for producing the actual man pages.
942	# $(evalcall2 def_vbox_refentry_to_manpage)
943	# @param 1 The language
944	# @param 2 The file name (no path).
945	define def_vbox_refentry_to_manpage
946	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
947	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
948	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
949	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
950	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
951	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
952	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
953	$$(QUIET)$$(RM) -f "$$@"
954	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
955	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
956	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
957	$$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
958	if defined(VBOX_HAVE_XMLLINT)
959	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
960	endif
961
962	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
963	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
964	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
965	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
966	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
967	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
968	$$(QUIET)$$(RM) -f "$$@"
969	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
970	endef
971	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
972	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
973
974	# Handy aliases.
975	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
976	man-experiment:: $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
977	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
978
979	#
980	# Manually updating the DHCP option list taken from VirtualBox.xidl
981	#
982	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
983	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
984	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $^
985
986
987	#
988	# Packing the docs into a zip file (part of the packing pass on the docs build box).
989	#
990	ifneq ($(VBOX_MANUAL_PACK),)
991	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
992	$(call MSG_L1,Packing documentation $@)
993	$(QUIET)$(RM) -f $@
994	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
995	endif
996
997	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
998
999	include $(FILE_KBUILD_SUB_FOOTER)
1000

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

Download in other formats:

Original Format