Makefile.kmk@ 105535

最後變更在這個檔案從105535是 105515,由 vboxsync 提交於 8 月前
Docs: bugref:10705. Copying the license chapter from doc team's repo. Ditamap inclusion is currently commented out as xsltproc could not find included file.
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Author Date Id Revision`
檔案大小: 54.1 KB

行
1	# /# $Id: Makefile.kmk 105515 2024-07-26 09:38:54Z 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.alldomusa.eu.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	# Java v17 or later (JAVA_HOME), used by DITA-OT.
111	#
112	ifeq ($(VBOX_JAVA17PLUS_HOME),)
113	if defined(VBOX_JAVA_VERSION) && $(VBOX_JAVA_VERSION) >= 170000 && "$(VBOX_JAVA_BIN_PATH)" != ""
114	VBOX_JAVA17PLUS_HOME := $(qabspath ,$(VBOX_JAVA_BIN_PATH)/..)
115	else
116	VBOX_JAVA17PLUS_HOME := $(firstfile \
117	$(rversortfiles $(qwildcard , $(KBUILD_DEVTOOLS_HST)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST)/jdk/v[2-9][0-9].* )) \
118	$(rversortfiles $(qwildcard ,$(KBUILD_DEVTOOLS_HST_ALT)/jdk/v1[789].* $(KBUILD_DEVTOOLS_HST_ALT)/jdk/v[2-9][0-9].* )) \
119	)
120	if "$(KBUILD_HOST)" == "darwin" && "$(VBOX_JAVA17PLUS_HOME)" != ""
121	VBOX_JAVA17PLUS_HOME := $(VBOX_JAVA17PLUS_HOME)/Contents/Home
122	endif
123	endif
124	endif
125
126	#
127	# DITA-OT related globals.
128	#
129	VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH = $(VBOX_DITA_OT_PATH)/plugins/org.oasis-open.dita.v1_2/dtd/technicalContent/dtd
130
131	##
132	# Runs the dost.jar.
133	#
134	# @param 1 Additional kmk_redirect options.
135	# @param 2 Parameters for the invoker.
136	#
137	VBOX_DITA_RUN_DOST = $(REDIRECT_EXT) \
138	-E 'ANT_HOME=$(VBOX_DITA_OT_PATH)' \
139	-E 'DITA_DIR=$(VBOX_DITA_OT_PATH)' \
140	-E 'JAVA_HOME=$(VBOX_JAVA17PLUS_HOME)' \
141	-E 'CLASSPATH=$(VBOX_DITA_CLASSPATH)' \
142	$1 \
143	-- \
144	"$(VBOX_JAVA17PLUS_HOME)/bin/java" \
145	"-Djava.awt.headless=true" \
146	"-Dsun.io.useCanonCaches=true" \
147	"-Dant.home=$(VBOX_DITA_OT_PATH)" \
148	"-Ddita.dir=$(VBOX_DITA_OT_PATH)" \
149	org.apache.tools.ant.launch.Launcher \
150	-cp "$(VBOX_DITA_CLASSPATH)" \
151	-buildfile "$(VBOX_DITA_OT_PATH)/build.xml" \
152	-main "org.dita.dost.invoker.Main" \
153	--args.grammar.cache=yes \
154	--verbose \
155	$(if-expr defined(VBOX_DITA_DEBUG),"--clean.temp=no" "--debug",) \
156	$2
157
158	VBOX_DITA_CLASSPATH = \
159	$(subst $(SP),$(HOST_PATH_SEP),$(strip \
160	$(VBOX_DITA_OT_PATH)/lib/ant-launcher.jar \
161	$(VBOX_DITA_OT_PATH)/config \
162	$(VBOX_DITA_OT_PATH)/lib \
163	$(wildcard \
164	$(VBOX_DITA_OT_PATH)/lib/*.jar \
165	$(VBOX_DITA_OT_PATH)/plugins//lib/.jar)))
166
167
168	#
169	# Targets
170	#
171
172	BLDDIRS += $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, $(VBOX_MANUAL_ALL_LANGUAGES))
173
174	ifdef VBOX_ONLY_DOCS
175	PACKING += $(PATH_STAGE_BIN)/VBoxDocumentation.zip
176	endif
177
178	BLDDIRS += \
179	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita \
180	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics \
181	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/images \
182	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/licensing \
183	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/licensing/vbox-base \
184	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/licensing/vbox-ext
185
186	BLDDIRS += \
187	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/, \
188	$(addsuffix /images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
189	$(addsuffix /html-single, $(VBOX_MANUAL_ALL_LANGUAGES)) \
190	$(addsuffix /html-chunks, $(VBOX_MANUAL_ALL_LANGUAGES)) \
191	$(addsuffix /qhelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
192	$(addsuffix /qhelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
193	$(addsuffix /HTMLHelp, $(VBOX_MANUAL_ALL_LANGUAGES)) \
194	$(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_ALL_LANGUAGES)) \
195	)
196
197	# Explicit cleaning has some overlap with default cleaning rules, since this
198	# Makefile is using very complex conditionals for selectively creating
199	# specific files, and not everyone remembers to use the same with "kmk clean".
200	OTHER_CLEAN += \
201	$(VBOX_XML_CATALOG) \
202	$(VBOX_XML_CATALOG_DOCBOOK) \
203	$(VBOX_XML_CATALOG_MANUAL) \
204	$(VBOX_XML_ENTITIES) \
205	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES) \
206	,$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/, \
207	$(VBOX_XML_XREF_TO_TEXT) \
208	$(VBOX_XML_XREF_TO_TEXT).cat \
209	$(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
210	$(VBOX_MANUAL_XML_REFENTRY_FILES) \
211	$(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
212	man_VBoxHeadless.xml \
213	user_man_VBoxHeadless.xml \
214	man_vboximg-mount.xml \
215	user_man_vboximg-mount.xml \
216	isomakercmd-man.xml \
217	user_isomakercmd-man.xml \
218	$(VBOX_MANUAL_LATEX_FILES_TARGET) \
219	$(VBOX_MANUAL_PNG_FILES_$(lang)) \
220	$(notdir $(VBOX_MANUAL_TEX_UNICODE_FILES)) \
221	$(addprefix HTMLHelp/,$(VBOX_MANUAL_PNG_FILES_$(lang))) \
222	$(addprefix qhelp/, $(VBOX_MANUAL_PNG_FILES_$(lang))) \
223	html-single/UserManual.html \
224	$(addprefix qhelp/, UserManual.qhp UserManual.qhcp $(VBOX_QHELP_OUTPUT_FILES)) \
225	$(addprefix HTMLHelp/, index.html go01.html) \
226	$(addprefix qhelp/, index.html go01.html) \
227	$(addprefix html-chunks/, index.html go01.html) \
228	$(foreach n,01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 \
229	,html-chunks/ch$(n).html \
230	html-chunks/re$(n).html \
231	HTMLHelp/ch$(n).html \
232	HTMLHelp/re$(n).html \
233	$(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)) \
234	qhelp/ch$(n).html \
235	qhelp/re$(n).html \
236	$(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)) ) \
237	$(foreach n,a b c \
238	,html-chunks/ap$(n).html \
239	HTMLHelp/ap$(n).html \
240	$(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) \
241	qhelp/ap$(n).html \
242	$(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) ) \
243	$(foreach n,01 02 03 04 05 \
244	,html-chunks/pr$(n).html \
245	HTMLHelp/pr$(n).html \
246	$(foreach s,01 02 03 04 05 06 07 08,HTMLHelp/pr$(n)s$(s).html) \
247	qhelp/pr$(n).html \
248	$(foreach s,01 02 03 04 05 06 07 08,qhelp/pr$(n)s$(s).html) ) \
249	HTMLHelp/toc.hhc \
250	HTMLHelp/htmlhelp.hhp \
251	qhelp/toc.hhc \
252	qhelp/htmlhelp.hhp \
253	UserManual.pdf \
254	$(VBOX_QHELP_OUTPUT_FILES) \
255	ChangeLog.html \
256	validatemanual.run \
257	validateaccessibility.run \
258	validatesdkref.run \
259	) \
260	) \
261	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl \
262	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
263	$(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
264	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US) \
265	$(addsuffix .kmk,$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)) \
266	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US) \
267	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip \
268	$(PATH_STAGE_BIN)/RefEntryDITA.zip \
269	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip \
270	$(PATH_STAGE_BIN)/ChangeLogDITA.zip \
271	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip \
272	$(PATH_STAGE_BIN)/UserManual-html.zip \
273	$(PATH_STAGE_BIN)/UserManual.pdf \
274	$(PATH_STAGE_BIN)/VBoxDocumentation.zip \
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_USERMANUAL_REFENTRY_DITA
345	#
346	# target for installing the ZIP containing the manpages in DITA format
347	#
348	INSTALLS += VBox-docs-usermanual-refentry-dita
349	VBox-docs-usermanual-refentry-dita_INST = $(INST_BIN)
350	VBox-docs-usermanual-refentry-dita_MODE = a+r,u+w
351	VBox-docs-usermanual-refentry-dita_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
352	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/RefEntryDITA.zip
353	endif
354
355	ifdef VBOX_WITH_DOCS_USERMANUAL_CHANGELOG_DITA
356	#
357	# target for installing the ZIP containing the change log in DITA format
358	#
359	INSTALLS += VBox-docs-usermanual-changelog-dita
360	VBox-docs-usermanual-changelog-dita_INST = $(INST_BIN)
361	VBox-docs-usermanual-changelog-dita_MODE = a+r,u+w
362	VBox-docs-usermanual-changelog-dita_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip
363	VBOX_MANUAL_PACK += $(PATH_STAGE_BIN)/ChangeLogDITA.zip
364	endif
365
366	ifdef VBOX_WITH_DOCS_ACCESSIBILITY
367	#
368	# target for installing Accessibility.pdf
369	#
370	INSTALLS += VBox-docs-accessibility
371	VBox-docs-accessibility_INST = $(INST_BIN)
372	VBox-docs-accessibility_MODE = a+r,u+w
373	VBox-docs-accessibility_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf
374
375	#
376	# target for installing Accessibility.html
377	#
378	INSTALLS += VBox-docs-accessibility-html
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	endif
383
384	endif # !VBOX_ONLY_SDK
385
386	if defined(VBOX_ONLY_SDK) \|\| defined(VBOX_WITH_DOCS_SDKREF)
387	#
388	# target for installing SDKRef.pdf
389	#
390	INSTALLS += VBox-docs-sdkref
391	VBox-docs-sdkref_INST = $(INST_SDK)docs/
392	VBox-docs-sdkref_MODE = a+r,u+w
393	VBox-docs-sdkref_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
394	endif
395
396
397	#
398	# Shared rules for LaTeX based PDF generation - Only used for SDK & Accessibility.
399	#
400
401	ifndef VBOX_OSE
402	# Copy ucs.sty and associated files.
403	## @todo r=bird: This is ugly since only ucs.sty is listed as output while we're actually copying 177 other files.
404	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/ucs.sty): \| $$(dir $$@)
405	$(call MSG_L1,Copying unicode support for LaTeX)
406	$(QUIET)$(INSTALL_STAGING) -m0644 -- $(VBOX_MANUAL_TEX_UNICODE_FILES) "$(@D)"
407	endif
408
409	# Copy the PNG files.
410	define def_vbox_cp_images_pdf
411	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$(VBOX_MANUAL_PNG_FILES_$(lang))): \
412	$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/% : \
413	$(VBOX_PATH_MANUAL_SRC)/$(lang)/% \| $$$$(dir $$$$@)
414	$$(call MSG_L1,Copying temporary $$< => $$@)
415	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
416	endef
417	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_cp_images_pdf))
418
419
420	#################################################################################################################################
421	# SDKRef.pdf - xidl => Docbook => LaTeX => PDF #
422	#################################################################################################################################
423
424	VBOX_SDKREF_XML_FILES = SDKRef.xml
425
426	# Replace @a and @c with <tt> tags in VirtualBox.xidl.
427	$(VBOX_DOC_XIDL_SRC_TMP): $(VBOX_DOC_XIDL_SRC) $(MAKEFILE_CURRENT) \| $$(dir $$@)
428	$(call MSG_L1,Generating $@)
429	$(QUIET)$(SED) \
430	-e 's\|@a \+$\w\+$\|<tt>\1</tt>\|g' \
431	-e 's\|@c \+$\w\+$\|<tt>\1</tt>\|g' \
432	--output $@ $<
433
434	# Generate SDKRef_apiref.xml as a docbook file excerpt that will be referenced from the SDKRef.xml.
435	$(VBOX_MANUAL_APIREF_TMP): $(VBOX_PATH_MANUAL_SRC)/xidl2docbook.xsl $(VBOX_DOC_XIDL_SRC_TMP)
436	$(call MSG_L1,Generating $@)
437	$(QUIET)$(VBOX_XSLTPROC) $(VBOX_XSLTPROC_OPTS) --xinclude --nonet -o $@ $< $(VBOX_DOC_XIDL_SRC_TMP)
438
439	# Turn SDKRef.xml into LaTeX.
440	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex: \
441	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
442	$(VBOX_MANUAL_APIREF_TMP) \
443	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
444	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run,) \
445	$(VBOX_XML_CATALOG) \
446	$(VBOX_XML_CATALOG_DOCBOOK) \
447	$(VBOX_XML_CATALOG_MANUAL) \
448	$(VBOX_XML_ENTITIES) \
449	$(MAKEFILE_CURRENT) \
450	\| $$(dir $$@)
451	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
452	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
453	# generate TeX source from processed docbook and store it in SDKRef.tex.tmp
454	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
455	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
456	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
457	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
458	$(QUIET)$(SED) \
459	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
460	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
461	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
462	--output $@ [email protected]
463	$(QUIET)$(RM) -f [email protected]
464
465	# Turn SDKRef.tex into a PDF.
466	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
467	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
468	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
469	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US)) \
470	\| $$(dir $$@)
471	$(call MSG_L1,pdflatex $< (three passes))
472	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
473	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
474	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) SDKRef.tex
475	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
476	$(QUIET)$(SED) -n \
477	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
478	$(basename $<).log
479	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
480
481	# Validating SDKRef.xml. It is invoked automatically at build time,
482	# but can also be manually invoked via the 'validate-sdkref' alias.
483	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run: \
484	$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef.xml \
485	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_SDKREF_XML_FILES)) \
486	$(VBOX_MANUAL_APIREF_TMP) \
487	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
488	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
489	$(call MSG_L1,Validating $<)
490	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
491	$(QUIET)$(APPEND) -t "$@" "done"
492
493
494	# Handy aliases.
495	validate-sdkref:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validatesdkref.run
496	sdkref:: $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
497
498
499	#################################################################################################################################
500	# Accessibility.pdf - Docbook => LaTeX => PDF #
501	#################################################################################################################################
502
503	# Turn Accessibility.xml into LaTeX.
504	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex: \
505	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
506	$(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl \
507	$(if $(VBOX_HAVE_XMLLINT),$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run,) \
508	$(VBOX_XML_CATALOG) \
509	$(VBOX_XML_CATALOG_DOCBOOK) \
510	$(VBOX_XML_CATALOG_MANUAL) \
511	$(VBOX_XML_ENTITIES) \
512	$(MAKEFILE_CURRENT) \
513	\| $$(dir $$@)
514	$(call MSG_TOOL,xsltproc $(notdir $(filter %.xsl,$^)),,$(firstword $(filter %.xml,$^)),$@)
515	$(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_ACCESSIBILITY_LATEX_FILES_TARGET))
516	# generate TeX source from processed docbook and store it in Accessibility.tex.tmp
517	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
518	-o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
519	# for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
520	# the \QUOTE{} was inserted by docbook2latex.xsl for all quotes _outside_ of screen sections
521	$(QUIET)$(SED) \
522	-e 's\|^\\QUOTE{}\|\\OQ{}\|g' \
523	-e 's\|$\W$\\QUOTE{}\|\1\\OQ{}\|g' \
524	-e 's\|$\w$\\QUOTE{}\|\1\\CQ{}\|g' \
525	--output $@ [email protected]
526	$(QUIET)$(RM) -f [email protected]
527
528	# Turn Accessibility.tex into a PDF.
529	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.pdf: \
530	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/Accessibility.tex \
531	$(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
532	$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_PNG_FILES_en_US))
533	$(call MSG_L1,pdflatex $< (three passes))
534	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
535	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
536	$(QUIET)$(REDIRECT) -C $(<D) -- $(VBOX_PDFLATEX_CMD) Accessibility.tex
537	$(QUIET)$(SED) -ne '/Warning: Hyper reference/p' $(basename $<).log
538	$(QUIET)$(SED) -n \
539	-e '/Warning: There were $undefined references\\|multiply-defined labels$/{p; q 1}' \
540	$(basename $<).log
541	$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
542
543	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html: \
544	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
545	$(VBOX_DOCBOOK_HTML_ONE_PAGE_FORMATCFG) \
546	$(VBOX_XML_CATALOG) \
547	$(VBOX_XML_CATALOG_DOCBOOK) \
548	$(VBOX_XML_CATALOG_MANUAL) \
549	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
550	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
551	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) \
552	--output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html \
553	$(VBOX_PATH_MANUAL_SRC)/docbook-html-one-page-formatcfg.xsl \
554	$<
555
556	# Validating Accessibility.xml. It is invoked automatically at build time,
557	# but can also be manually invoked via the 'validate-accessibility' alias.
558	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run: \
559	$(VBOX_PATH_MANUAL_SRC)/en_US/Accessibility.xml \
560	$(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_ACCESSIBILITY_XML_FILES)) \
561	$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(VBOX_XML_CATALOG_MANUAL) \
562	$(VBOX_XML_ENTITIES) $(MAKEFILE_CURRENT) \| $$(dir $$@)
563	$(call MSG_L1,Validating $<)
564	$(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $<
565	$(QUIET)$(APPEND) -t "$@" "done"
566
567
568	# Handy aliases.
569	validate-accessibility:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/validateaccessibility.run
570	accessibility:: $(PATH_STAGE_BIN)/Accessibility.pdf
571	accessibility-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/Accessibility.html
572
573
574	#################################################################################################################################
575	# UserManual.* - The user manual in all its output variations (DITA-OT). #
576	#################################################################################################################################
577
578	#
579	# 1. We copy/hardlink all the files under <lang>/dita/* to the corresponding
580	# VBOX_PATH_MANUAL_OUTBASE location. This is mainly to deal with DITO-OT's
581	# inability to search for topic files in more than one place, so we have to
582	# gather generated and static topic sources + the .ditamap-file(s) in one
583	# place.
584	#
585
586	# Determine the basic set of files as dictated by the en_US version of the
587	# user manual (relative to $(lang)/dita). We'll use these to supply
588	# incomplete manual translations.
589	# Note! This includes .png as well as .dita and .ditamap files.
590	VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES := \
591	$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/.dita)) \
592	$(addprefix topics/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita))) \
593	$(addprefix topics/images/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*png))) \
594	$(addprefix topics/licensing/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/licensing/dita))) \
595	$(addprefix topics/licensing/vbox-base/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/licensing/vbox-base/*dita))) \
596	$(addprefix topics/licensing/vbox-ext/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/licensing/vbox-ext/*dita)))
597
598	##
599	# Produce copying rules for one language and defining the variable
600	# VBOX_USER_MANUAL_DITA_STAGED_FILES_<lang> for use in prerequisite to
601	# anything producing a version of the user manual.
602	#
603	# @param 1 lang
604	define def_vbox_copy_manual_dita_src_files
605	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1) := \
606	$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/*.ditamap)) \
607	$$(addprefix topics/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/*dita))) \
608	$$(addprefix topics/images/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/images/*png))) \
609	$$(addprefix topics/licensing/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/licensing/dita))) \
610	$$(addprefix topics/licensing/vbox-base/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/licensing/vbox-base/*dita))) \
611	$$(addprefix topics/licensing/vbox-ext/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/licensing/vbox-ext/*dita)))
612	VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK := \
613	$$(filter-out $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)), $$(VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES))
614
615	VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1) = \
616	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/, \
617	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
618	$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) )
619
620	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)),)
621	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1))): \
622	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
623	$$(VBOX_PATH_MANUAL_SRC)/$1/dita/% \| $$$$(dir $$$$@)
624	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
625	endif
626
627	ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK),)
628	$$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK)): \
629	$$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
630	$$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% \| $$$$(dir $$$$@)
631	$$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
632	endif
633
634	endef
635	$(foreach lang, $(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_copy_manual_dita_src_files,$(lang)))
636
637
638	#
639	# 2. Convert the manpages from Docbook refentry files to DITA reference files.
640	#
641	# In DITA links needs proper href values, with both file and ID. Since the
642	# source only has IDs, we scan all topics and refentry-files alike and
643	# generate a mapping database before we start converting them. This DB is
644	# then used at the end of each conversion to fix the hrefs.
645	#
646
647	##
648	# Do per-language stuff for the refentry -> dita file conversion.
649	#
650	# The variable VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_<lang> is defined
651	# by this define and should be expanded as a prerequisite for any rule
652	# producing a version of the user manual.
653	#
654	# @param 1 Language.
655	#
656	define def_vbox_refentry_to_dita
657	# Generate a ID to FILE mapping database that def_vbox_refentry_to_dita can apply below.
658	VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1) := $$(VBOX_PATH_MANUAL_OUTBASE)/$1/id-mapping-file.db
659	OTHER_CLEAN += $(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1))
660	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)) + $$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$(1)).lst: \
661	$$(VBOX_PATH_MANUAL_SRC)/build_id_to_file_mapping.py \
662	$$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/*.xml) \
663	$$(filter %.dita,$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1))) \
664	\| $$$$(dir $$$$@)
665	$$(call MSG_L1, $$<)
666	$$(QUIET)$$(APPEND) -nt "[email protected]" $$(filter-out %.py,$$^)
667	$$(QUIET)$$(VBOX_BLD_PYTHON) "$$<" --output "$$@" @"[email protected]"
668
669	# Accumulated list of conversion output file names to be used as a
670	# prerequisite in rules producing a version of the user manual.
671	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 :=
672
673	endef # def_vbox_refentry_to_dita
674
675	## Convert a single refentry file to dita.
676	# @param 1 Language
677	# @param 2 Filename w/o extension.
678	# @param 3 Alternative fallback filename (for isomakercmd-man.xml).
679	# @note This produces more files than listed in the output, but we currently let kmk be ignorant of that.
680	define def_vbox_refentry_file_to_dita
681	VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap
682	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap \
683	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap.kmk \
684	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita \
685	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml: \
686	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
687	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
688	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.sh \
689	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl \
690	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-topic-ids.xsl \
691	$$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
692	$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1) \
693	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml) \
694	$$(VBOX_XML_CATALOG) \
695	$$(VBOX_XML_CATALOG_DOCBOOK) \
696	$$(VBOX_XML_CATALOG_MANUAL) \
697	$$(VBOX_XML_ENTITIES) \
698	$$(VBOX_VERSION_STAMP) \
699	\| $$$$(dir $$$$@)
700	$$(call MSG_TOOL,xsltproc docbook-refentry-to-manual-dita[-pre].xsl,,$$(firstword $$(filter %.xml,$$^)),$$@)
701	$$(QUIET)$$(RM) -f -- "$$@" \
702	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml" \
703	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
704	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
705	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml" \
706	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
707	$$(qfirstfile , $$(qwildcard , $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2).xml) $(3) $$(VBOX_PATH_MANUAL_SRC)/en_US/$(2).xml)
708	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) \
709	--stringparam "g_fReplaceHyphens" "true" \
710	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita" \
711	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
712	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).xml"
713	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/add_file_to_id_only_references.py \
714	--mapping-file "$$(VBOX_USER_MANUAL_ID_MAPPING_FILE_$1)" \
715	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
716	$$(QUIET)$$(ASH) \
717	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.sh" \
718	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita" \
719	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-topic-ids.xsl" \
720	"$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl" \
721	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap.kmk" \
722	"VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_$(1)" \
723	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics" \
724	-- $$(subst $$(REDIRECT),$$(REDIRECT_EXT),$$(call VBOX_XSLTPROC_WITH_CAT)) $(VBOX_XSLTPROC_WORKAROUND) \
725	--path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)"
726	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) $(VBOX_XSLTPROC_WORKAROUND) \
727	--path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)" \
728	--stringparam g_sMode map \
729	--output "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/$(2).ditamap" \
730	$$(VBOX_PATH_MANUAL_SRC)/dita-refentry-flat-to-single-topic.xsl \
731	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/flat-$(2).dita"
732
733	endef # def_vbox_refentry_file_to_dita
734
735	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
736	,$(evalcall2 def_vbox_refentry_to_dita,$(lang)) \
737	$(foreach file, $(basename $(VBOX_MANUAL_XML_REFENTRY_FILES) man_vboximg-mount man_VBoxHeadless) \
738	,$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),$(file))) \
739	$(evalcall2 def_vbox_refentry_file_to_dita,$(lang),user_isomakercmd-man, \
740	$(PATH_ROOT)/src/VBox/Runtime/common/fs/isomakercmd-man.xml))
741
742	ifdef VBOX_ONLY_DOCS
743	include $(VBOX_PATH_MANUAL_OUTBASE)/refentry.kmk
744
745	$(VBOX_PATH_MANUAL_OUTBASE)/refentry.kmk: \
746	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
747	,$(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(lang).kmk)
748	$(QUIET)$(RM) -f -- "$@"
749	$(APPEND) -tn "$@" '# refentry.kmk'
750	$(APPEND) -n "$@" $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),'include $(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(lang).kmk')
751	$(APPEND) -n "$@" '# done'
752
753	## Include file for all language specific refentry files.
754	# @param 1 Language
755	define def_vbox_refentry_lang_kmk
756	$$(VBOX_PATH_MANUAL_OUTBASE)/refentry_$(1).kmk: \
757	$$(addsuffix .kmk,$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1)))
758	$$(QUIET)$$(RM) -f -- "$$@"
759	$$(APPEND) -tn "$$@" '# refentry_$(1).kmk'
760	$$(APPEND) -n "$$@" $$(addprefix 'include ,$$(addsuffix .kmk',$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1))))
761	$$(APPEND) -n "$$@" '# done'
762
763	endef # def_vbox_refentry_lang_kmk
764
765	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
766	,$(evalcall2 def_vbox_refentry_lang_kmk,$(lang)))
767	endif
768
769	# Run conversion testcase.
770	refentry-to-dita-test:
771	$(RM) -f -- \
772	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml" \
773	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.dita"
774	$(call VBOX_XSLTPROC_WITH_CAT) \
775	--output "$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml" \
776	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita-pre.xsl \
777	$(VBOX_PATH_MANUAL_SRC)/testcase/refentry1.xml
778	$(call VBOX_XSLTPROC_WITH_CAT) \
779	--output "$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.dita" \
780	$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-dita.xsl \
781	"$(VBOX_PATH_MANUAL_OUTBASE)/testcase-refentry1.xml"
782
783	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip: \
784	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US) \
785	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES2_en_US) \
786	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/vboxmanage-cmd-overview.dita
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	$(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$^)
792
793	refentry-dita-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/RefEntryDITA.zip
794
795	#
796	# 2b. Generate the VBoxManage commands overview topic based upon the
797	# command synopis dita files generated in the above step.
798	#
799
800	# @param 1 Language
801	define def_vbox_generate_vboxmanage_overview
802	VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita
803	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita \
804	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/vboxmanage-cmd-overview.dita.files.xml: \
805	$$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
806	$$(VBOX_PATH_MANUAL_SRC)/vboxmanage-cmd-overview.xsl \
807	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1)) \
808	\| $$$$(dir $$$$@)
809	$$(call MSG_TOOL,xsltproc vboxmanage-cmd-overview.dita.xsl,,,$$@)
810	$$(QUIET)$$(RM) -f -- "$$@" "[email protected]"
811	$$(APPEND) -tn "[email protected]" '<?xml version="1.0"?>' '<files>'
812	$$(SED) -n \
813	-e 's/^.topicref .topics\/man_VBoxManage-$[^.]$\.ditamap.$$(DOLLAR)/<file>vboxmanage-\1-synopsis.dita<\/file>/p' \
814	--append "[email protected]" \
815	$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/UserManual.ditamap
816	$$(APPEND) -n "[email protected]" '</files>'
817	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) $(VBOX_XSLTPROC_WORKAROUND) --path "$$(VBOX_DITA_TECHNICAL_CONTENT_DTD_PATH)" \
818	--output "$$@" \
819	$$(VBOX_PATH_MANUAL_SRC)/$(1)/vboxmanage-cmd-overview.xsl \
820	"[email protected]"
821
822	endef # def_vbox_generate_vboxmanage_overview
823	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_generate_vboxmanage_overview,$(lang)))
824
825
826	#
827	# 3. Convert the changelog from DocBook to a bunch of DITA topics and corresponding map.
828	#
829
830	##
831	# @param 1 Language
832	# @note We don't really need to do this for each language, but whatever.
833	# @note Outputs a bunch of .dita files for each version too...
834	define def_vbox_convert_changelog_to_dita
835	VBOX_USER_MANUAL_DITA_STAGED_FILES_$1 += $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap
836	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap \
837	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics/changelog-versions.ditamap.kmk: \
838	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
839	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
840	$$(VBOX_XML_CATALOG) \
841	$$(VBOX_XML_CATALOG_DOCBOOK) \
842	$$(VBOX_XML_CATALOG_MANUAL) \
843	\| $$$$(dir $$$$@)
844	$$(call MSG_TOOL,xsltproc docbook-changelog-to-manual-dita.xsl,,,$$@)
845	$$(QUIET)$$(RM) -f -- "$$@" "[email protected]"
846	$$(QUIET)$$(ASH) \
847	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.sh \
848	$$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml \
849	$$(VBOX_PATH_MANUAL_SRC)/docbook-changelog-to-manual-dita.xsl \
850	$$(@).kmk \
851	VBOX_USER_MANUAL_CONVERTED_CHANGELOG_DITA_FILES_$(1) \
852	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/topics \
853	-- \
854	$$(call VBOX_XSLTPROC_WITH_CAT)
855	endef # def_vbox_convert_changelog_to_dita
856	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_vbox_convert_changelog_to_dita,$(lang)))
857
858	ifdef VBOX_ONLY_DOCS
859	include $(VBOX_PATH_MANUAL_OUTBASE)/changelog.kmk
860
861	$(VBOX_PATH_MANUAL_OUTBASE)/changelog.kmk: \
862	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
863	,$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/changelog-versions.ditamap.kmk)
864	$(QUIET)$(RM) -f -- "$@"
865	$(APPEND) -tn "$@" '# changelog.kmk'
866	$(APPEND) -n "$@" $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),'include $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/dita/topics/changelog-versions.ditamap.kmk')
867	$(APPEND) -n "$@" '# done'
868
869	endif
870
871	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip: \
872	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/topics/changelog-versions.ditamap \
873	$(VBOX_USER_MANUAL_CONVERTED_CHANGELOG_DITA_FILES_en_US)
874	$(call MSG_L1,Packing documentation $@)
875	$(QUIET)$(RM) -f $@
876	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
877	-9 -r "$@" \
878	$(patsubst $(VBOX_PATH_MANUAL_OUTBASE)/en_US/%,%,$^)
879
880	changelog-dita-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLogDITA.zip
881
882
883	#
884	# 4a. UserManual.pdf - Run dost.jar from DITA-OT to produce the PDF version.
885	#
886	# Note! The --temp (dir) is deleted, recreated, used and deleted again for each
887	# run. So, be careful where you point it.
888	# Note! This crappy utility may fail to find files (or fail to parse the
889	# command line) and still return a successfully (0) exit code.
890	#
891	define def_ditamap_to_pdf
892	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf \
893	+ $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log \
894	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.list \
895	+\| $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita.xml.properties: \
896	$$(VBOX_MANUAL_XML_FILES_COMMON) \
897	$$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
898	$$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(lang)) \
899	$$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(lang)) \
900	$$(VBOX_PATH_MANUAL_SRC)/pdf-theme-UserManual.yaml \
901	$$(VBOX_PATH_MANUAL_SRC)/en_US/images/vboxlogo.png
902	$$(call MSG_L1,Building $$@ ($$(@D)/UserManual_pdf.log))
903	$$(QUIET)$$(RM) -f -- "$$@"
904	$$(QUIET)$$(RM) -Rf -- "$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf"
905	$$(QUIET)$$(call VBOX_DITA_RUN_DOST,, \
906	"--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
907	"--format=pdf" \
908	"--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/ohc.ditaval" \
909	"--output=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)" \
910	"--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_pdf" \
911	"--theme=$$(VBOX_PATH_MANUAL_SRC)/pdf-theme-UserManual.yaml" \
912	"--logfile=$$(@D)/UserManual_pdf.log" \
913	)
914
915	ditamap-to-pdf: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual.pdf
916	.PRECIOUS: $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/UserManual_pdf.log
917	endef
918	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(evalcall2 def_ditamap_to_pdf,$(lang)))
919
920	# Useful aliases
921	usermanual UserManual.pdf:: $(PATH_STAGE_BIN)/UserManual.pdf
922
923
924	#
925	# 4b. UserManual.html - Run dost.jar from DITA-OT to produce the HTML versions.
926	#
927	# We produce both chunked and singled paged HTML versions of the en_US manual
928	# mainly for uploading to virtualbox.org. The docs build box produces a zip
929	# including these.
930	#
931
932	## @todo front page
933	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html: \
934	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
935	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
936	$(QUIET)$(RM) -Rf -- "$(@D)" \
937	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks"
938	$(call MSG_L1,Building html chunks $@ ($(@D)/UserManual_xhtml.log))
939	$(QUIET)$(MKDIR) -- "$(@D)"
940	$(QUIET)$(call VBOX_DITA_RUN_DOST,, \
941	"--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap" \
942	"--format=xhtml" \
943	"--filter=$(VBOX_PATH_MANUAL_SRC)/en_US/dita/htmlhelp.ditaval" \
944	"--output=$(@D)" \
945	"--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_chunks" \
946	"--logfile=$(@D)/UserManual_xhtml.log" \
947	"--store-type=memory" \
948	)
949
950	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html
951
952	# We must modify UserManual.ditamap here, removing all chunk attributes and put
953	# a chunk="to-content" on the root element (bookmap). For clues see:
954	# https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html
955	# https://www.oxygenxml.com/forum/post25114.html?hilit=dita%20xhtml%20chunk#p25114
956	# We stich the index.html and UserManual-Single.html files together using
957	# SED since we haven't been able to convince DITA-OT to combine them.
958	#
959	## @todo This is excruciatingly slow with 4.0.2 because of a preprocessing step
960	# (move-meta in the org.dita.base plugin) is doing 986 read+writes of
961	# the singled combined dita document (XML). This is probably the two
962	# for loops in the pushMetadata() method in
963	# src/main/java/org/dita/dost/module/MoveMetaModule.java. The netbeans
964	# profiler says that ouf 283 sec runtime, 64 secs are spent reading
965	# the xml big doc and 212 secs spent writing it out again (212+64=276).
966	#
967	# For the chunked version, the move-meta work is done on each .ditamap
968	# and .dita (topic) file instead, which is a lot less expensive.
969	#
970	# The problem is forced by the AbstractDomFilter.read() design, which
971	# reads XML to DOM, modifies DOM, writes out DOM as XML. The
972	# modifications done by the DitaMetaWriter.process function is
973	# restricted to a single topic, which is means this must be done this
974	# way.
975	#
976	# A workaround, though, would be to implement a custom cache that
977	# cache the document and doesn't write it to disk until the loops
978	# finishes. This could build on the CacheStore.java code, only
979	# potential challenge is to clone the job as the Job.store property is
980	# immutable.
981	#
982	## @todo front page
983	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html: \
984	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_en_US) \
985	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_en_US)
986	$(call MSG_L1,Building html chunks $@ ($(@D)/UserManual-Single_xhtml.log))
987	$(QUIET)$(RM) -Rf -- "$(@D)" \
988	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita-ot-html-single/" \
989	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap"
990	$(SED) -r -e 's/ chunk=["][^"]+["]//g' -e 's/<bookmap /<bookmap chunk="to-content" /' \
991	--output "$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
992	"$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual.ditamap"
993	$(QUIET)$(MKDIR) -- "$(@D)"
994	$(QUIET)$(call VBOX_DITA_RUN_DOST,, \
995	"--input=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/UserManual-Single.ditamap" \
996	"--format=xhtml" \
997	"--output=$(@D)" \
998	"--temp=$(VBOX_PATH_MANUAL_OUTBASE)/en_US/dita/temp_xhtml_single" \
999	"--logfile=$(@D)/UserManual-Single_xhtml.log" \
1000	"--store-type=memory" \
1001	)
1002	$(SED) -ne '1,/<body>/{p}' \
1003	--output "$@" "$(@D)/UserManual-Single.html"
1004	$(APPEND) -n "$@" "<!-- index inject: -->"
1005	$(SED) -ne '/<body>/,/<\/body>/{/<body>/d;/<\/body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
1006	--append "$@" "$(@D)/index.html"
1007	$(APPEND) -n "$@" "<!-- resuming main file: -->"
1008	$(SED) -ne '/<body>/,99999999{/<body>/d;s/UserManual-Single.html/UserManual.html/g;p}' \
1009	--append "$@" "$(@D)/UserManual-Single.html"
1010
1011	html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
1012
1013	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip: \
1014	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
1015	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html
1016	$(call MSG_L1,Packing documentation $@)
1017	$(QUIET)$(RM) -f $@
1018	$(QUIET)$(REDIRECT) -C $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ -- $(VBOX_ZIP) \
1019	-9 -r "$@" \
1020	"html-chunks" \
1021	"html-single" \
1022	-x "html-chunks/dita.list" \
1023	-x "html-chunks/dita.xml.properties" \
1024	-x "html-chunks/UserManual_xhtml.log" \
1025	-x "html-single/dita.list" \
1026	-x "html-single/dita.xml.properties" \
1027	-x "html-single/UserManual-Single_xhtml.log" \
1028	-x "html-single/index.html" \
1029	-x "html-single/UserManual-Single.html"
1030
1031	html-zip:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.zip
1032
1033
1034	#
1035	# A few things which are shared between htmlhelp and qhelp docs.
1036	# TODO: This is Docbook related work. Left here in case we can reuse some of
1037	# the ideas from it for DITA-OT.
1038	#
1039
1040	VBOX_DOCBOOK_HTMLHELP_FORMATCFG = \
1041	$(VBOX_PATH_MANUAL_SRC)/docbook-htmlhelp-formatcfg.xsl \
1042	$(VBOX_PATH_MANUAL_SRC)/common-formatcfg.xsl \
1043	$(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
1044
1045	# Prepare the XSL file for our title page, htmlhelp and qhelp variant.
1046	$(VBOX_PATH_MANUAL_OUTBASE)/titlepage-htmlhelp.xsl: \
1047	$(VBOX_PATH_MANUAL_SRC)/titlepage-htmlhelp.xml $(MAKEFILE_CURRENT) \| $$(dir $$@)
1048	$(call MSG_L1,xsltproc $<)
1049	$(QUIET)$(RM) -f [email protected] $@
1050	$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet -o [email protected] $(VBOX_PATH_DOCBOOK)/template/titlepage.xsl $<
1051	$(QUIET)$(MV) -f [email protected] $@
1052
1053	# end old stuff.
1054
1055	if defined(VBOX_WITH_DOCS_QHELP) && !defined(VBOX_ONLY_SDK)
1056	#
1057	# 4c. VirtualBox.qch + VirtualBox.qhc - Qt compressed help and collection file.
1058	#
1059	# See usermanual.pdf under DITA-OT-xxxxx/doc folder for details.
1060	#
1061
1062	# Enable Qt and locate the Qt help generator.
1063	USES += qt6
1064	VBOX_QHELPGENERATOR = $(PATH_TOOL_QT6_LIBEXEC)/qhelpgenerator
1065
1066	## Build QHelp version of manual for given language.
1067	# @param 1 Language
1068	# @param 2 The language specific qhelp output directory.
1069	define def_vbox_usermanual_as_qhelp
1070
1071	# 1. Generate UserManual.hpp using DITA-OT.
1072	#
1073	# Setting HHCDIR here so that it fails to locate hcc.exe and always skips the
1074	# compilation step that produces the .chm-file, since we don't need it and it
1075	# mangles the path so it always fails anyway.
1076	#
1077	# HACK ALERT! Putting MSG_L1 between RM and MKDIR as the latter sometimes fails
1078	# on windows because the deleted directory still exists on Windows.
1079	#
1080	# HACK ALERT! For 4.0.2 we must set Ant property dita.output.dir to the output
1081	# dir to prevent the .hhp+.html+*.png files from being placed in
1082	# the temporary directory and removed upon completion (idea being
1083	# that hhc.exe had run and the files weren't needed any more - the
1084	# htmlhelp plugin sets temp.output.dir.name to 'temp_chm_dir').
1085	#
1086	## @todo front page.
1087	$(2)/UserManual.hhp: \
1088	$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1)) \
1089	$(VBOX_USER_MANUAL_CONVERTED_REFENTRY_DITA_FILES_$(1))
1090	$$(QUIET)$$(RM) -Rf -- "$$(@D)" \
1091	"$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp"
1092	$$(call MSG_L1,dita-ot-qhelp, => $$@ ($(2)/UserManual_htmlhelp.log))
1093	$$(QUIET)$$(MKDIR) -- "$$(@D)"
1094	$$(QUIET)$$(call VBOX_DITA_RUN_DOST, -EHHCDIR="$$(@D)", \
1095	"--input=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/UserManual.ditamap" \
1096	"--format=htmlhelp" \
1097	"--filter=$$(VBOX_PATH_MANUAL_SRC)/$(1)/dita/htmlhelp.ditaval" \
1098	"--output=$(2)" \
1099	"--temp=$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/dita/temp_qhelp" \
1100	"--logfile=$(2)/UserManual_htmlhelp.log" \
1101	"-Ddita.output.dir=$(2)" \
1102	)
1103
1104	ditamap-to-htmlhelp: $(2)/UserManual.hhp
1105
1106	# 2. Generate a Qt Help Project file (QHP) using htmlhelp-qthelp.py.
1107	$(2)/UserManual.qhp: \
1108	$(2)/UserManual.hhp \
1109	$$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py
1110	$$(call MSG_L1,htmlhelp-qthelp.py $$<,=> $$@)
1111	$$(QUIET)$$(RM) -f -- "$$@"
1112	$$(QUIET)$$(VBOX_BLD_PYTHON) $$(VBOX_PATH_MANUAL_SRC)/htmlhelp-qthelp.py \
1113	-d "$$(<D)" -o "$$@" -f UserManual.hhp -t UserManual.hhc
1114
1115	# 3. Copy the Qt help configuration file from source to the output dir.
1116	$(2)/UserManual.qhcp: \
1117	$$(VBOX_PATH_MANUAL_SRC)/UserManual.qhcp \
1118	$(2)/UserManual.hhp # Order-only gets confused by rm -Rf, as kmk will cache the existance of the target \
1119	# file and not remake it because kmk thinks it still exists. Real dep fixes this.
1120	$$(call MSG_L1,, => $$@ ($(2)/UserManual_htmlhelp.log))
1121	$$(QUIET)$$(INSTALL_STAGING) -m0644 -- '$$<' '$$(@D)'
1122
1123	# 4. Run the Qt help generator to produce the .qhc and .qch files.
1124	$(2)/UserManual.qch \
1125	+ $(2)/UserManual.qhc: \
1126	$(2)/UserManual.qhcp \
1127	$(2)/UserManual.qhp
1128	$$(call MSG_L1,$$(notdir $$(VBOX_QHELPGENERATOR)) $$<,=> $$@)
1129	$$(QUIET)$$(RM) -f -- "$$@"
1130	$$(QUIET)$$(REDIRECT) -E "QT_PLUGIN_PATH=$$(PATH_SDK_QT6)/plugins" -E "QT_QPA_PLATFORM_PLUGIN_PATH=$$(PATH_SDK_QT6)/plugins/platforms" -- $$(VBOX_QHELPGENERATOR) $$<
1131	$$(call MSG_L1,Fresh QCH is now at $$@)
1132
1133	endef # def_vbox_usermanual_as_qhelp
1134
1135	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES) \
1136	,$(evalcall2 def_vbox_usermanual_as_qhelp,$(lang),$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/qhelp))
1137
1138	qhelp:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/qhelp/, $(VBOX_QHELP_OUTPUT_FILES))
1139
1140	endif # VBOX_WITH_DOCS_QHELP && !VBOX_ONLY_SDK
1141
1142
1143	#################################################################################################################################
1144	# Miscellaneous #
1145	#################################################################################################################################
1146
1147	#
1148	# ChangeLog.html
1149	#
1150	# This XSLT rule formats en_US/user_ChangeLog.xml (which includes the actual change log
1151	# contained in user_ChangeLogImpl.xml) as a standalone HTML file.
1152	#
1153	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
1154	$(VBOX_PATH_MANUAL_SRC)/en_US/docbook-changelog-formatcfg.xsl \
1155	$(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml \
1156	$(VBOX_XML_CATALOG) \
1157	$(VBOX_XML_CATALOG_DOCBOOK) \
1158	$(VBOX_XML_CATALOG_MANUAL) \
1159	$(VBOX_XML_ENTITIES) \| $$(dir $$@)
1160	$(call MSG_TOOL,xsltproc $(notdir $(firstword $(filter %.xsl,$^))),,$(firstword $(filter %.xml,$^)),$@)
1161	$(QUIET)$(call VBOX_XSLTPROC_WITH_CAT) --output "$@" "$<" $(filter %.xml,$^)
1162	$(call MSG_L1,Fresh ChangeLog.html is now at $@)
1163
1164	cl-html:: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
1165
1166
1167	#
1168	# VBoxManage man pages (parts also required by VBoxManage built-in help).
1169	#
1170
1171	##
1172	# Emits rules for preprocessing refentry sources (applying remarks element),
1173	# and for producing the actual man pages.
1174	# $(evalcall2 def_vbox_refentry_to_manpage)
1175	# @param 1 The language
1176	# @param 2 The file name (no path).
1177	define def_vbox_refentry_to_manpage
1178	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
1179	$$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
1180	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
1181	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) \
1182	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
1183	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
1184	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
1185	$$(QUIET)$$(RM) -f "$$@"
1186	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output $$@ \
1187	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
1188	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --output [email protected] $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$$(VBOX_XML_XREF_TO_TEXT) $$@
1189	$$(QUIET)$$(MV) -f -- "[email protected]" "$$@"
1190	if defined(VBOX_HAVE_XMLLINT)
1191	$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
1192	endif
1193
1194	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
1195	$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
1196	$$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl \
1197	$$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(VBOX_XML_CATALOG_MANUAL) \
1198	$$(VBOX_XML_ENTITIES) $$(VBOX_VERSION_STAMP) \| $$$$(dir $$$$@)
1199	$$(call MSG_TOOL,xsltproc $$(notdir $$(firstword $$(filter %.xsl,$$^))),,$$(firstword $$(filter %.xml,$$^)),$$@)
1200	$$(QUIET)$$(RM) -f "$$@"
1201	$$(QUIET)$$(call VBOX_XSLTPROC_WITH_CAT) --maxdepth 6000 --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage.xsl $$<
1202	endef
1203	$(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1204	, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
1205
1206	# Handy aliases.
1207	validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
1208	man-experiment:: $(foreach lang,$(VBOX_MANUAL_ALL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
1209	,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
1210
1211	#
1212	# Manually updating the DHCP option list taken from VirtualBox.xidl
1213	#
1214	dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
1215	$(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
1216	$(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $^
1217
1218
1219	#
1220	# Packing the docs into a zip file (part of the packing pass on the docs build box).
1221	#
1222	ifneq ($(VBOX_MANUAL_PACK),)
1223	$(PATH_STAGE_BIN)/VBoxDocumentation.zip: $(VBOX_MANUAL_PACK)
1224	$(call MSG_L1,Packing documentation $@)
1225	$(QUIET)$(RM) -f $@
1226	$(QUIET)$(REDIRECT) -C $(PATH_STAGE_BIN) -- $(VBOX_ZIP) -9 $@ $(notdir $^)
1227	endif
1228
1229
1230	endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) \|\| defined(VBOX_ONLY_DOCS) \|\| defined(VBOX_ONLY_SDK))
1231
1232	include $(FILE_KBUILD_SUB_FOOTER)
1233

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

以其他格式下載:

原來格式