1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
# Copyright (C) 2012-2020 SUSE Software Solutions Germany GmbH
#
# Author:
# Frank Sundermeyer <fsundermeyer at opensuse dot org>
#
# HTML/HTMLSINGLE generation for DAPS
#
# Please submit feedback or patches to
# <fsundermeyer at opensuse dot org>
#
# includes are set in selector.mk
# include $(DAPSROOT)/make/setfiles.mk
# include $(DAPSROOT)/make/profiling.mk
# include $(DAPSROOT)/make/validate.mk
# include $(DAPSROOT)/make/images.mk
#
# HTML_DIR is already set in common_variables.mk
#
#----------
# Stylesheets
#
# HTML / HTMLSINGLE
HTML_SUFFIX := html
ifeq "$(HTML5)" "1"
H_DIR := /xhtml5
else
H_DIR := /xhtml
endif
ifeq "$(HTMLSINGLE)" "1"
# Single HTML
STYLEHTML := $(firstword $(wildcard \
$(addsuffix $(H_DIR)/docbook.xsl,$(STYLE_ROOTDIRS))))
RESULT_NAME := Single HTML
else
# Chunked HTML
STYLEHTML := $(firstword $(wildcard \
$(addsuffix $(H_DIR)/chunk.xsl,$(STYLE_ROOTDIRS))))
RESULT_NAME := HTML
endif
#
# NOTE: Style image handling needs to go into a function. It is needed by
# epub, html and webhelp
#
# Three scenarios:
#
# <STYLESHEETDIR>/xhtml/static
# |-css
# |-js
# |-images
#
# or
#
# <STYLESHEETDIR>/static
# |-css
# |-js
# |-images
#
#
# or we have the DocBook standard layout:
# <STYLESHEETDIR>/images
# <STYLESHEETDIR>/xhtml/<FOO>.css
#
# If <STYLESHEETDIR>/xhtml/static exists, it is used by default. If not,
# <STYLESHEETDIR>/static is used. We also assume that
# parameters for [admon|callout|navig].graphics.path are correctly set in
# the stylesheets. Alternatively, a custom static directory can be specified
# with the --statdir parameter.
#
# In case we have the standard docbook layout, we need to set
# [admon|callout|navig].graphics.path.
#
# IS_STATIC is used to determine
# whether we have a static dir (IS_STATIC=static) or not.
#
# Set the styleimage directory. If no custom directory is set with --statdir,
# it can either be <STYLEROOT>/xhtml/static, <STYLEROOT>/static or
# <STYLEROOT>/images. If more than one of these directories exist, they will
# be used in the order listed (firstword function)
#
ifdef STATIC_DIR
STYLEIMG := $(STATIC_DIR)
IS_STATIC := static
else
#
# Make sure to use the STYLEIMG directory that comes alongside the
# STYLEROOT that is actually used. This is needed to ensure that the
# correct STYLEIMG is used, even when the current STYLEROOT is a
# fallback directory
#
# dir (patsubst %/,%,(dir STYLEEPUB)):
# - remove filename
# - remove trailing slash (dir function only works when last character
# is no "/") -> patsubst is greedy
# - remove dirname
#
STYLEIMG := $(firstword $(wildcard \
$(addsuffix static, $(dir $(STYLEHTML)))\
$(addsuffix static,$(dir $(patsubst %/,%,$(dir $(STYLEHTML)))))\
$(addsuffix images,$(dir $(patsubst %/,%,$(dir $(STYLEHTML)))))))
ifeq "$(strip $(STYLEIMG))" ""
$(error $(shell ccecho "error" "Fatal error: Could not find stylesheet images"))
endif
IS_STATIC := $(notdir $(STYLEIMG))
ifndef HTML_CSS
ifneq "$(IS_STATIC)" "static"
HTML_CSS := $(shell readlink -e $(firstword $(wildcard $(dir $(STYLEHTML))*.css)) 2>/dev/null )
ifeq "$(VERBOSITY)" "1"
HTML_CSS_INFO := No CSS file specified. Automatically using\n$(HTML_CSS)
endif
endif
endif
endif
HTMLSTRINGS += --param "show.comments=$(REMARKS)" \
--param "use.id.as.filename=1" \
--stringparam "base.dir=$(HTML_DIR)/" \
--stringparam "draft.mode=$(DRAFT)" \
--stringparam "img.src.path=images/"
# DocBook uses .xhtml for XHTML5 by default
ifeq "$(HTML5)" "1"
HTMLSTRINGS += --stringparam "html.ext=.html"
endif
# test if DocBook layout
ifneq "$(IS_STATIC)" "static"
HTMLSTRINGS += --stringparam "admon.graphics.path=static/images/" \
--stringparam "callout.graphics.path=static/images/callouts/" \
--stringparam "navig.graphics.path=static/images/"
# With the SUSE Stylesheets we use an alternative draft image for HTML
# builds (draft_html.png). The original DocBook Stylesheets use draft.png for
# _both_ HML and FO
HTML_DRAFT_IMG = $(subst $(STYLEIMG)/,static/images/,$(firstword \
$(wildcard $(STYLEIMG)/draft_html.png \
$(STYLEIMG)/draft.png)))
ifdef HTML_DRAFT_IMG
HTMLSTRINGS += --stringparam "draft.watermark.image=$(HTML_DRAFT_IMG)"
endif
endif
ifdef HTML_CSS
ifneq "$(HTML_CSS)" "none"
HTMLSTRINGS += --stringparam "html.stylesheet=static/css/$(notdir $(HTML_CSS))"
else
HTML_CSS_INFO := CSS was set to none, using no CSS
HTMLSTRINGS += --stringparam "html.stylesheet=\"\""
endif
endif
# inline Images
#
HTML_INLINE_IMAGES := $(subst $(IMG_GENDIR)/color/,$(HTML_DIR)/images/,$(ONLINE_IMAGES))
#--------------
# HTML
#
# In order to avoid unwanted results when deleting $(HTML_DIR), we are adding
# a security check before deleting
#
.PHONY: html
ifeq "$(CLEAN_DIR)" "1"
html: $(shell if [[ $$(expr match "$(HTML_DIR)" "$(RESULT_DIR)") -gt 0 && -d "$(HTML_DIR)" ]]; then rm -r "$(HTML_DIR)"; fi 2>&1 >/dev/null)
endif
html: list-images-multisrc list-images-missing
ifdef ONLINE_IMAGES
html: $(ONLINE_IMAGES) copy_inline_images_html
endif
html: copy_static_images_html
html: $(HTML_RESULT)
ifeq "$(TARGET)" "html"
@ccecho "result" "$(RESULT_NAME) book built with REMARKS=$(REMARKS), DRAFT=$(DRAFT) and META=$(META):\n$(HTML_DIR)/"
endif
#------------------------------------------------------------------------
#
# "Helper" targets
#
# create HTMLDIR and HTMLSIR/static:
#
$(HTML_DIR) $(HTML_DIR)/images $(HTML_DIR)/static $(HTML_DIR)/static/css:
mkdir -p $@
#---------------
# Copy static and inline images
#
# static target needs to be PHONY, since I do not know which files need to
# be copied/linked, we just copy/link the whole directory
#
.PHONY: copy_static_images_html
ifneq "$(IS_STATIC)" "static"
copy_static_images_html: | $(HTML_DIR)/static
ifdef HTML_CSS
copy_static_images_html: | $(HTML_DIR)/static/css
endif
copy_static_images_html: $(STYLEIMG)
ifeq "$(STATIC_HTML)" "0"
$(HTML_GRAPH_COMMAND) $(STYLEIMG) $(HTML_DIR)/static
else
tar cph --exclude-vcs -C $(dir $<) images | \
(cd $(HTML_DIR)/static; tar xpv) >/dev/null
endif
else
copy_static_images_html: | $(HTML_DIR)/static
ifdef HTML_CSS
copy_static_images_html: | $(HTML_DIR)/static/css
endif
copy_static_images_html: $(STYLEIMG)
ifeq "$(STATIC_HTML)" "0"
$(HTML_GRAPH_COMMAND) $</* $(HTML_DIR)/static
else
tar cph --exclude-vcs -C $(dir $<) static | \
(cd $(HTML_DIR); tar xpv) >/dev/null
endif
endif
ifdef HTML_CSS
ifneq "$(HTML_CSS)" "none"
$(HTML_GRAPH_COMMAND) $(HTML_CSS) $(HTML_DIR)/static/css/
endif
endif
# inline images
# needs to be PHONY, because we either create links (of no --static) or
# copies of the images (with --static). Using a PHONY target ensures that
# links can be overwritten with copies and vice versa
# Thus we also need the ugly for loop instead of creating images by
# $(HTML_DIR)/images/% rule
#
.PHONY: copy_inline_images_html
copy_inline_images_html: | $(HTML_DIR)/images
copy_inline_images_html: $(ONLINE_IMAGES)
for IMG in $(ONLINE_IMAGES); do $(HTML_GRAPH_COMMAND) $$IMG $(HTML_DIR)/images; done
#---------------
# Generate HTML from profiled xml
#
# XSLTPARAM is a variable that can be set via wrapper script in order to
# temporarily overwrite styleseet settings such as margins
#
ifdef METASTRING
$(HTML_RESULT): $(PROFILEDIR)/METAFILE
endif
$(HTML_RESULT): $(PROFILES) $(PROFILEDIR)/.validate $(DOCFILES)
ifeq "$(VERBOSITY)" "2"
@ccecho "info" "Creating HTML pages"
ifdef HTML_CSS_INFO
@ccecho "info" "$(HTML_CSS_INFO)"
endif
endif
ifeq "$(HTMLSINGLE)" "1"
$(XSLTPROC) $(HTMLSTRINGS) $(ROOTSTRING) $(METASTRING) $(DAPSSTRINGS) \
$(XSLTPARAM) $(PARAMS) $(STRINGPARAMS) \
--output $@ --xinclude --stylesheet $(STYLEHTML) \
--file $(PROFILED_MAIN) $(XSLTPROCESSOR) $(DEVNULL) $(ERR_DEVNULL)
(cd $(HTML_DIR) && ln -sf $(notdir $@) index.html)
else
$(XSLTPROC) $(HTMLSTRINGS) $(ROOTSTRING) $(METASTRING) $(DAPSSTRINGS) \
$(XSLTPARAM) $(PARAMS) $(STRINGPARAMS) \
--xinclude --stylesheet $(STYLEHTML) \
--file $(PROFILED_MAIN) $(XSLTPROCESSOR) $(DEVNULL) $(ERR_DEVNULL)
ifdef ROOTID
if [ ! -e $@ ]; then \
(cd $(HTML_DIR) && ln -sf $(ROOTID).$(HTML_SUFFIX) $@) \
elif [ ! -e $(HTML_DIR)/$(ROOTID).$(HTML_SUFFIX) ]; then \
(cd $(HTML_DIR) && ln -sf $(notdir $@) $(ROOTID).$(HTML_SUFFIX)); \
fi;
endif
endif
|
