1 ################################################################
2 # website (without the rest of the docs)
4 ################################################################
5 ##### SECURITY -- check these values for lilypond.org #########
6 ################################################################
8 ifeq ($(WEBSITE_ONLY_BUILD),1)
10 TOP_SRC_DIR=$(LILYPOND_GIT)
11 TRUSTED_DIR=$(HOME)/lilypond/trusted-scripts
12 top-src-dir=$(TOP_SRC_DIR)
14 trusted-dir=$(TRUSTED_DIR)
15 script-dir=$(trusted-dir)
16 texi2html-init-file=$(trusted-dir)/lilypond-texi2html.init
17 top-htaccess=$(trusted-dir)/lilypond.org.htaccess
18 dir-htaccess=$(trusted-dir)/website-dir.htaccess
20 TEXI2HTML_PROGRAM=texi2html
22 PYTHONPATH=$(TRUSTED_DIR)
25 script-dir=$(top-src-dir)/scripts/build
26 texi2html-init-file=$(top-src-dir)/Documentation/lilypond-texi2html.init
27 top-htaccess=$(top-src-dir)/Documentation/web/server/lilypond.org.htaccess
28 dir-htaccess=$(top-src-dir)/Documentation/web/server/website-dir.htaccess
29 include $(config_make)
32 ################################################################
33 #The 4 lines below present an option to force make website to run
34 # quietly only when it is run as make -s website. However, we've
35 # decided not to use this switch, and run the scripts quietly all
37 ################################################################
38 #quiet-run = $(findstring s, $(MAKEFLAGS))
39 #ifeq ($(quiet-run),s)
43 #Nothing clever here - just allows the use of a boolean to control
46 ifeq ($(quiet-run),true)
50 ################################################################
53 WEB_LANGS := $(shell MAKEWEB=1 $(PYTHON) $(top-src-dir)/python/langdefs.py)
55 TEXI2HTML=ONLY_WEB=1 TOP_SRC_DIR=$(top-src-dir) DEPTH=$(depth) PERL_UNICODE=SD \
56 $(TEXI2HTML_PROGRAM) -D web_version --prefix=index --split=section \
57 --init-file=$(texi2html-init-file) \
59 --I=$(top-src-dir)/Documentation \
63 EXTRACT_TEXI_FILENAMES=$(PYTHON) $(script-dir)/extract_texi_filenames.py $(quiet-flag) \
64 --known-missing-files=$(top-src-dir)/scripts/build/website-known-missing-files.txt \
65 -I $(top-src-dir)/Documentation \
69 CREATE_VERSION=python $(script-dir)/create-version-itexi.py
70 CREATE_WEBLINKS=python $(script-dir)/create-weblinks-itexi.py
71 MASS_LINK=python $(script-dir)/mass-link.py
72 WEB_POST=python $(script-dir)/website_post.py
73 WEB_BIBS=python $(script-dir)/bib2texi.py
75 EXAMPLES=$(LILYPOND_WEB_MEDIA_GIT)/ly-examples
76 PICTURES=$(LILYPOND_WEB_MEDIA_GIT)/pictures
77 PDFS=$(LILYPOND_WEB_MEDIA_GIT)/pdf
79 SERVER_FILES=$(top-src-dir)/Documentation/web/server
82 MANUALS = $(MANUALS_TELY) $(MANUALS_TEXI) $(MANUALS_TRANSLATION)
83 MANUALS_TELY := $(notdir $(wildcard $(top-src-dir)/Documentation/*.tely))
84 MANUALS_TEXI := contributor.texi
86 # Harvest the translated manuals.
87 # - Store each manual in a language-specific macro, e.g. when we find
88 # de/learning.tely we add learning.tely to MANUALS_de,
89 # - Store each manual with an added language suffix in MANUALS_TRANSLATION,
90 # e.g. learning.de.tely for the German learning manual.
91 $(eval $(foreach l,$(WEB_LANGS),\
92 $(eval MANUALS_$(l) := $(notdir $(wildcard $(top-src-dir)/Documentation/$(l)/*.tely))) \
93 $(eval MANUALS_TRANSLATION += $(MANUALS_$(l):%.tely=%.$(l).tely)) \
96 # The web.texi manuals, English and translated
97 MANUALS_WEB := web.texi $(WEB_LANGS:%=web.%.texi)
99 # The basename of all manuals (basename includes the language suffix)
100 MANUALS_BASE = $(basename $(MANUALS) $(MANUALS_WEB))
103 #######################
104 ### Dependency tracking
106 # Find the file $(1) within the texinfo include dirs and return its path.
107 # If not found, i.e. it is a generated file, then the file is ignored.
110 $(wildcard $(dir $<)$(1)) \
111 $(wildcard $(top-src-dir)/Documentation/$(1)) \
114 # Recursively scan the file $(1) for @include, search for included files
115 # within the texinfo include dirs, and return all dependencies.
117 $(foreach f, $(shell echo | sed -ne "/^@include[[:space:]]/s/@include//p" $(1)), \
118 $(call find-texi,$(f)) \
119 $(call scan-texi,$(call find-texi,$(f))) \
122 # Find dependencies for the target $@, based on the texinfo source file $<,
123 # and write the dependencies to a .dep file.
124 DO_TEXI_DEP = ( mkdir -p $(dir $@) && echo ./$@: $(call scan-texi,$<) > $@.dep ) &&
126 # This is where we import the .dep files so that `make' knows about
127 # the various dependencies.
128 -include dummy.dep $(wildcard $(OUT)/*.dep) $(wildcard $(OUT)/*/*.dep)
134 bib-files = $(OUT)/others-did.itexi $(OUT)/we-wrote.itexi
136 css-src-files := $(notdir $(wildcard $(top-src-dir)/Documentation/css/*.css))
137 css-files = $(css-src-files:%=$(OUT)/website/css/%)
139 example-src-files := $(notdir $(wildcard $(EXAMPLES)/*))
140 example-files = $(example-src-files:%=$(OUT)/website/ly-examples/%)
142 misc-files = $(OUT)/.htaccess \
143 $(OUT)/website/.htaccess \
144 $(OUT)/website/favicon.ico \
145 $(OUT)/website/robots.txt
147 picture-src-files := $(notdir $(wildcard $(PICTURES)/*))
148 picture-files = $(picture-src-files:%=$(OUT)/website/pictures/%)
150 pdf-src-files := $(notdir $(wildcard $(PDFS)/*))
151 pdf-files = $(pdf-src-files:%=$(OUT)/website/pdf/%)
153 post-files = $(OUT)/website/index.html
155 texinfo-files = $(OUT)/index.html $(WEB_LANGS:%=$(OUT)/%/index.html)
157 version-files = $(OUT)/version.itexi $(OUT)/weblinks.itexi
159 xref-files = $(MANUALS_BASE:%=$(OUT)/%.xref-map)
165 .PHONY: website website-bibs website-css website-examples website-misc \
166 website-pictures website-post website-test website-texinfo \
167 website-version website-xrefs check-setup website-pdf
170 ifeq ($(LILYPOND_WEB_MEDIA_GIT),)
171 echo "Need a LILYPOND_WEB_MEDIA_GIT environment variable!"
175 website: check-setup website-post website-examples website-pictures website-css website-misc website-pdf
177 website-bibs: website-version $(OUT) $(bib-files)
179 website-css: $(OUT)/website/css $(css-files)
181 website-examples: $(OUT)/website/ly-examples $(example-files)
183 website-misc: $(OUT)/website $(misc-files)
185 website-pictures: $(OUT)/website/pictures $(OUT)/pictures $(picture-files)
187 website-pdf: $(OUT)/website/pdf $(pdf-files)
189 website-post: website-texinfo $(post-files)
194 website-texinfo: website-version website-xrefs website-bibs $(texinfo-files)
196 website-version: $(OUT) $(version-files)
198 website-xrefs: website-version $(OUT) $(xref-files)
205 $(OUT) $(OUT)/website $(OUT)/website/css $(OUT)/website/ly-examples $(OUT)/website/pictures $(OUT)/website/pdf: %:
208 $(OUT)/pictures: $(OUT)/website/pictures
209 ln -sf website/pictures $(OUT)/pictures
211 # Generated itexi files
212 $(OUT)/version.itexi: $(top-src-dir)/VERSION
213 $(CREATE_VERSION) $(top-src-dir) > $(OUT)/version.itexi
215 $(OUT)/weblinks.itexi: $(top-src-dir)/VERSION
216 $(CREATE_WEBLINKS) $(top-src-dir) > $(OUT)/weblinks.itexi
218 $(bib-files): $(OUT)/%.itexi: $(top-src-dir)/Documentation/web/%.bib
219 BSTINPUTS=$(top-src-dir)/Documentation/web \
221 -s $(top-src-dir)/Documentation/lily-bib \
226 # Get xrefs for English tely manuals
227 $(MANUALS_TELY:%.tely=$(OUT)/%.xref-map): $(OUT)/%.xref-map: $(top-src-dir)/Documentation/%.tely
228 $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) $<
230 # Get xrefs for English texi manuals
231 $(MANUALS_TEXI:%.texi=$(OUT)/%.xref-map): $(OUT)/%.xref-map: $(top-src-dir)/Documentation/%.texi
232 $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) $<
234 # Get xrefs for translated tely manuals
235 $(eval $(foreach l,$(WEB_LANGS),\
236 $(eval $(MANUALS_$(l):%.tely=$(OUT)/%.$(l).xref-map): $(OUT)/%.$(l).xref-map: $(top-src-dir)/Documentation/$(l)/%.tely; \
237 $$(DO_TEXI_DEP) $$(EXTRACT_TEXI_FILENAMES) $$< ) \
240 # Get xrefs for the English web.texi manual
241 $(OUT)/web.xref-map: $(top-src-dir)/Documentation/web.texi
242 $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) --split=node $<
244 # Get xrefs for translated web.texi manuals
245 $(OUT)/web.%.xref-map: $(top-src-dir)/Documentation/%/web.texi
246 $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) --split=node $<
248 # Build the English website
249 $(OUT)/index.html: $(top-src-dir)/Documentation/web.texi $(xref-files)
250 $(DO_TEXI_DEP) $(TEXI2HTML) $<
252 # Build translated websites
253 $(eval $(foreach l,$(WEB_LANGS),\
254 $(eval $(OUT)/$(l)/index.html: $(top-src-dir)/Documentation/$(l)/web.texi $(xref-files); \
255 $$(DO_TEXI_DEP) $$(TEXI2HTML) --lang="$(l)" $$<; ) \
258 # Website post-processing
259 $(OUT)/website/index.html: $(wildcard $(OUT)/*.html)
260 ls $(OUT)/*.html | sed 's!$(OUT)/!!g' | xargs $(MASS_LINK) --prepend-suffix="" hard $(OUT)/ $(OUT)/website/
261 $(foreach l,$(WEB_LANGS), \
262 ls $(OUT)/$(l)/*.html | xargs grep -L 'UNTRANSLATED NODE: IGNORE ME' | sed 's!$(OUT)/$(l)/!!g' | xargs $(MASS_LINK) --prepend-suffix=".$(l)" hard $(OUT)/$(l)/ $(OUT)/website/; )
263 $(WEB_POST) $(OUT)/website
266 $(css-files): $(OUT)/website/css/%: $(top-src-dir)/Documentation/css/%
269 $(example-files): $(OUT)/website/ly-examples/%: $(EXAMPLES)/%
272 $(picture-files): $(OUT)/website/pictures/%: $(PICTURES)/%
275 $(pdf-files): $(OUT)/website/pdf/%: $(PDFS)/%
278 $(OUT)/website/favicon.ico: $(SERVER_FILES)/favicon.ico
281 $(OUT)/website/robots.txt: $(SERVER_FILES)/robots.txt
284 $(OUT)/.htaccess: $(top-htaccess)
287 $(OUT)/website/.htaccess: $(dir-htaccess)