make/website.make

   1 ################################################################
   2 # website (without the rest of the docs)
   3
   4 ################################################################
   5 #####  SECURITY -- check these values for lilypond.org #########
   6 ################################################################
   7
   8 ifeq ($(WEBSITE_ONLY_BUILD),1)
   9   ### for lilypond.org
  10   TOP_SRC_DIR=$(HOME)/lilypond/lilypond-git
  11   TRUSTED_DIR=$(HOME)/lilypond/trusted-scripts
  12   top-src-dir=$(TOP_SRC_DIR)
  13   depth=.
  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
  19   TEXI2HTML_PROGRAM=$(HOME)/usr/bin/texi2html
  20   EXAMPLES=$(HOME)/lilypond/media/ly-examples
  21   PICTURES=$(HOME)/lilypond/media/pictures
  22   PYTHON=python
  23   PYTHONPATH=$(TRUSTED_DIR)
  24 else
  25   ### for normal git
  26   script-dir=$(top-src-dir)/scripts/build
  27   texi2html-init-file=$(top-src-dir)/Documentation/lilypond-texi2html.init
  28   top-htaccess=$(top-src-dir)/Documentation/web/server/lilypond.org.htaccess
  29   dir-htaccess=$(top-src-dir)/Documentation/web/server/website-dir.htaccess
  30   include $(config_make)
  31   # I assume this is run from top-build-dir
  32   EXAMPLES=Documentation/web/ly-examples/out-www
  33   PICTURES=Documentation/pictures/out-www
  34 endif
  35
  36 ################################################################
  37 #The 4 lines below present an option to force make website to run
  38 # quietly only when it is run as make -s website.  However, we've
  39 # decided not to use this switch, and run the scripts quietly all
  40 # the time
  41 ################################################################
  42 #quiet-run = $(findstring s, $(MAKEFLAGS))
  43 #ifeq ($(quiet-run),s)
  44 #  quiet-flag=-q
  45 #endif
  46
  47 #Nothing clever here - just allows the use of a boolean to control
  48 #  quiet running
  49 quiet-run = true
  50 ifeq ($(quiet-run),true)
  51   quiet-flag=-q
  52 endif
  53
  54 ################################################################
  55 OUT=out-website
  56
  57 WEB_LANGS := $(shell MAKEWEB=1 $(PYTHON) $(top-src-dir)/python/langdefs.py)
  58
  59 TEXI2HTML=ONLY_WEB=1 TOP_SRC_DIR=$(top-src-dir) DEPTH=$(depth) PERL_UNICODE=SD \
  60         $(TEXI2HTML_PROGRAM) -D web_version --prefix=index --split=section \
  61                 --init-file=$(texi2html-init-file) \
  62                 --I=$(dir $<) \
  63                 --I=$(top-src-dir)/Documentation \
  64                 --I=$(OUT) \
  65                 --output=$(dir $@)
  66
  67 EXTRACT_TEXI_FILENAMES=$(PYTHON) $(script-dir)/extract_texi_filenames.py $(quiet-flag) \
  68         --known-missing-files=$(top-src-dir)/scripts/build/website-known-missing-files.txt \
  69                 -I $(top-src-dir)/Documentation \
  70                 -I $(dir $<) \
  71                 -I $(OUT) \
  72                 -o $(OUT)
  73 CREATE_VERSION=python $(script-dir)/create-version-itexi.py
  74 CREATE_WEBLINKS=python $(script-dir)/create-weblinks-itexi.py
  75 MASS_LINK=python $(script-dir)/mass-link.py
  76 WEB_POST=python $(script-dir)/website_post.py
  77 WEB_BIBS=python $(script-dir)/bib2texi.py
  78
  79 SERVER_FILES=$(top-src-dir)/Documentation/web/server
  80
  81 # don't include web
  82 MANUALS = $(MANUALS_TELY) $(MANUALS_TEXI) $(MANUALS_TRANSLATION)
  83 MANUALS_TELY := $(notdir $(wildcard $(top-src-dir)/Documentation/*.tely))
  84 MANUALS_TEXI := contributor.texi
  85
  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)) \
  94 ))
  95
  96 # The web.texi manuals, English and translated
  97 MANUALS_WEB := web.texi $(WEB_LANGS:%=web.%.texi)
  98
  99 # The basename of all manuals (basename includes the language suffix)
 100 MANUALS_BASE = $(basename $(MANUALS) $(MANUALS_WEB))
 101
 102
 103 ###################
 104 ### Generated files
 105
 106 bib-files = $(OUT)/others-did.itexi $(OUT)/we-wrote.itexi
 107
 108 css-src-files := $(notdir $(wildcard $(top-src-dir)/Documentation/css/*.css))
 109 css-files = $(css-src-files:%=$(OUT)/website/%)
 110
 111 example-src-files := $(notdir $(wildcard $(EXAMPLES)/*))
 112 example-files = $(example-src-files:%=$(OUT)/website/ly-examples/%)
 113
 114 misc-files = $(OUT)/.htaccess \
 115              $(OUT)/website/.htaccess \
 116              $(OUT)/website/favicon.ico \
 117              $(OUT)/website/robots.txt
 118
 119 picture-src-files := $(notdir $(wildcard $(PICTURES)/*))
 120 picture-files = $(picture-src-files:%=$(OUT)/website/pictures/%)
 121
 122 post-files = $(OUT)/website/index.html
 123
 124 texinfo-files = $(OUT)/index.html $(WEB_LANGS:%=$(OUT)/%/index.html)
 125
 126 version-files = $(OUT)/version.itexi $(OUT)/weblinks.itexi
 127
 128 xref-files = $(MANUALS_BASE:%=$(OUT)/%.xref-map)
 129
 130
 131 ###########
 132 ### Targets
 133
 134 .PHONY: website website-bibs website-css website-examples website-misc \
 135         website-pictures website-post website-test website-texinfo \
 136         website-version website-xrefs
 137
 138 website: website-post website-examples website-pictures website-css website-misc
 139
 140 website-bibs: website-version $(OUT) $(bib-files)
 141
 142 website-css: $(OUT)/website $(css-files)
 143
 144 website-examples: $(OUT)/website/ly-examples $(example-files)
 145
 146 website-misc: $(OUT)/website $(misc-files)
 147
 148 website-pictures: $(OUT)/website/pictures $(OUT)/pictures $(picture-files)
 149
 150 website-post: website-texinfo $(post-files)
 151
 152 website-test:
 153         echo $(TEXI2HTML)
 154
 155 website-texinfo: website-version website-xrefs website-bibs $(texinfo-files)
 156
 157 website-version: $(OUT) $(version-files)
 158
 159 website-xrefs: website-version $(OUT) $(xref-files)
 160
 161
 162 #########
 163 ### Rules
 164
 165 # Directories
 166 $(OUT) $(OUT)/website $(OUT)/website/ly-examples $(OUT)/website/pictures: %:
 167         mkdir -p $@
 168
 169 $(OUT)/pictures: $(OUT)/website/pictures
 170         ln -sf website/pictures $(OUT)/pictures
 171
 172 # Generated itexi files
 173 $(OUT)/version.itexi: #FIXME: add dependencies
 174         $(CREATE_VERSION) $(top-src-dir) > $(OUT)/version.itexi
 175
 176 $(OUT)/weblinks.itexi: #FIXME: add dependencies
 177         $(CREATE_WEBLINKS) $(top-src-dir) > $(OUT)/weblinks.itexi
 178
 179 $(bib-files): $(OUT)/%.itexi: $(top-src-dir)/Documentation/web/%.bib
 180         BSTINPUTS=$(top-src-dir)/Documentation/web \
 181                 $(WEB_BIBS) -s web \
 182                 -s $(top-src-dir)/Documentation/lily-bib \
 183                 -o $@ \
 184                 $(quiet-flag) \
 185                 $<
 186
 187 # Get xrefs for English tely manuals
 188 $(MANUALS_TELY:%.tely=$(OUT)/%.xref-map): $(OUT)/%.xref-map: $(top-src-dir)/Documentation/%.tely
 189         $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) $<
 190
 191 # Get xrefs for English texi manuals
 192 $(MANUALS_TEXI:%.texi=$(OUT)/%.xref-map): $(OUT)/%.xref-map: $(top-src-dir)/Documentation/%.texi
 193         $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) $<
 194
 195 # Get xrefs for translated tely manuals
 196 $(eval $(foreach l,$(WEB_LANGS),\
 197 $(eval $(MANUALS_$(l):%.tely=$(OUT)/%.$(l).xref-map): $(OUT)/%.$(l).xref-map: $(top-src-dir)/Documentation/$(l)/%.tely; \
 198         $$(DO_TEXI_DEP) $$(EXTRACT_TEXI_FILENAMES) $$< ) \
 199 ))
 200
 201 # Get xrefs for the English web.texi manual
 202 $(OUT)/web.xref-map: $(top-src-dir)/Documentation/web.texi
 203         $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) --split=node $<
 204
 205 # Get xrefs for translated web.texi manuals
 206 $(OUT)/web.%.xref-map: $(top-src-dir)/Documentation/%/web.texi
 207         $(DO_TEXI_DEP) $(EXTRACT_TEXI_FILENAMES) --split=node $<
 208
 209 # Build the English website
 210 $(OUT)/index.html: $(top-src-dir)/Documentation/web.texi
 211         $(DO_TEXI_DEP) $(TEXI2HTML) $<
 212
 213 # Build translated websites
 214 $(eval $(foreach l,$(WEB_LANGS),\
 215 $(eval $(OUT)/$(l)/index.html: $(top-src-dir)/Documentation/$(l)/web.texi; \
 216         $$(DO_TEXI_DEP) $$(TEXI2HTML) --lang="$(l)" $$<; ) \
 217 ))
 218
 219 # Website post-processing
 220 $(OUT)/website/index.html: $(wildcard $(OUT)/*.html)
 221         ls $(OUT)/*.html | sed 's!$(OUT)/!!g' | xargs $(MASS_LINK) --prepend-suffix="" hard $(OUT)/ $(OUT)/website/
 222         $(foreach l,$(WEB_LANGS), \
 223                 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/; )
 224         $(WEB_POST) $(OUT)/website
 225
 226 # Simple copy
 227 $(css-files): $(OUT)/website/%: $(top-src-dir)/Documentation/css/%
 228         cp $< $@
 229
 230 $(example-files): $(OUT)/website/ly-examples/%: $(EXAMPLES)/%
 231         cp $< $@
 232
 233 $(picture-files): $(OUT)/website/pictures/%: $(PICTURES)/%
 234         cp $< $@
 235
 236 $(OUT)/website/favicon.ico: $(SERVER_FILES)/favicon.ico
 237         cp $< $@
 238
 239 $(OUT)/website/robots.txt: $(SERVER_FILES)/robots.txt
 240         cp $< $@
 241
 242 $(OUT)/.htaccess: $(top-htaccess)
 243         cp $< $@
 244
 245 $(OUT)/website/.htaccess: $(dir-htaccess)
 246         cp $< $@