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=$(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   # grab it from PATH
  20   TEXI2HTML_PROGRAM=texi2html
  21   PYTHON=python
  22   PYTHONPATH=$(TRUSTED_DIR)
  23 else
  24   ### for normal git
  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)
  30 endif
  31
  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
  36 # the time
  37 ################################################################
  38 #quiet-run = $(findstring s, $(MAKEFLAGS))
  39 #ifeq ($(quiet-run),s)
  40 #  quiet-flag=-q
  41 #endif
  42
  43 #Nothing clever here - just allows the use of a boolean to control
  44 #  quiet running
  45 quiet-run = true
  46 ifeq ($(quiet-run),true)
  47   quiet-flag=-q
  48 endif
  49
  50 ################################################################
  51 OUT=out-website
  52
  53 WEB_LANGS := $(shell MAKEWEB=1 $(PYTHON) $(top-src-dir)/python/langdefs.py)
  54
  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) \
  58                 --I=$(dir $<) \
  59                 --I=$(top-src-dir)/Documentation \
  60                 --I=$(OUT) \
  61                 --output=$(dir $@)
  62
  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 \
  66                 -I $(dir $<) \
  67                 -I $(OUT) \
  68                 -o $(OUT)
  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
  74
  75 EXAMPLES=$(LILYPOND_WEB_MEDIA_GIT)/ly-examples
  76 PICTURES=$(LILYPOND_WEB_MEDIA_GIT)/pictures
  77 PDFS=$(LILYPOND_WEB_MEDIA_GIT)/pdf
  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 ### Dependency tracking
 105
 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.
 108 find-texi = \
 109 $(firstword \
 110         $(wildcard $(dir $<)$(1)) \
 111         $(wildcard $(top-src-dir)/Documentation/$(1)) \
 112 )
 113
 114 # Recursively scan the file $(1) for @include, search for included files
 115 # within the texinfo include dirs, and return all dependencies.
 116 scan-texi = \
 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))) \
 120 )
 121
 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 ) &&
 125
 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)
 129
 130
 131 ###################
 132 ### Generated files
 133
 134 bib-files = $(OUT)/others-did.itexi $(OUT)/we-wrote.itexi
 135
 136 css-src-files := $(notdir $(wildcard $(top-src-dir)/Documentation/css/*.css))
 137 css-files = $(css-src-files:%=$(OUT)/website/css/%)
 138
 139 example-src-files := $(notdir $(wildcard $(EXAMPLES)/*))
 140 example-files = $(example-src-files:%=$(OUT)/website/ly-examples/%)
 141
 142 misc-files = $(OUT)/.htaccess \
 143              $(OUT)/website/.htaccess \
 144              $(OUT)/website/favicon.ico \
 145              $(OUT)/website/robots.txt
 146
 147 picture-src-files := $(notdir $(wildcard $(PICTURES)/*))
 148 picture-files = $(picture-src-files:%=$(OUT)/website/pictures/%)
 149
 150 pdf-src-files := $(notdir $(wildcard $(PDFS)/*))
 151 pdf-files = $(pdf-src-files:%=$(OUT)/website/pdf/%)
 152
 153 post-files = $(OUT)/website/index.html
 154
 155 texinfo-files = $(OUT)/index.html $(WEB_LANGS:%=$(OUT)/%/index.html)
 156
 157 version-files = $(OUT)/version.itexi $(OUT)/weblinks.itexi
 158
 159 xref-files = $(MANUALS_BASE:%=$(OUT)/%.xref-map)
 160
 161
 162 ###########
 163 ### Targets
 164
 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
 168
 169 check-setup:
 170 ifeq ($(LILYPOND_WEB_MEDIA_GIT),)
 171         echo "Need a LILYPOND_WEB_MEDIA_GIT environment variable!"
 172         exit 1
 173 endif
 174
 175 website: check-setup website-post website-examples website-pictures website-css website-misc website-pdf
 176
 177 website-bibs: website-version $(OUT) $(bib-files)
 178
 179 website-css: $(OUT)/website/css $(css-files)
 180
 181 website-examples: $(OUT)/website/ly-examples $(example-files)
 182
 183 website-misc: $(OUT)/website $(misc-files)
 184
 185 website-pictures: $(OUT)/website/pictures $(OUT)/pictures $(picture-files)
 186
 187 website-pdf: $(OUT)/website/pdf $(pdf-files)
 188
 189 website-post: website-texinfo $(post-files)
 190
 191 website-test:
 192         echo $(TEXI2HTML)
 193
 194 website-texinfo: website-version website-xrefs website-bibs $(texinfo-files)
 195
 196 website-version: $(OUT) $(version-files)
 197
 198 website-xrefs: website-version $(OUT) $(xref-files)
 199
 200
 201 #########
 202 ### Rules
 203
 204 # Directories
 205 $(OUT) $(OUT)/website $(OUT)/website/css $(OUT)/website/ly-examples $(OUT)/website/pictures $(OUT)/website/pdf: %:
 206         mkdir -p $@
 207
 208 $(OUT)/pictures: $(OUT)/website/pictures
 209         ln -sf website/pictures $(OUT)/pictures
 210
 211 # Generated itexi files
 212 $(OUT)/version.itexi: $(top-src-dir)/VERSION
 213         $(CREATE_VERSION) $(top-src-dir) > $(OUT)/version.itexi
 214
 215 $(OUT)/weblinks.itexi: $(top-src-dir)/VERSION
 216         $(CREATE_WEBLINKS) $(top-src-dir) > $(OUT)/weblinks.itexi
 217
 218 $(bib-files): $(OUT)/%.itexi: $(top-src-dir)/Documentation/web/%.bib
 219         BSTINPUTS=$(top-src-dir)/Documentation/web \
 220                 $(WEB_BIBS) -s web \
 221                 -s $(top-src-dir)/Documentation/lily-bib \
 222                 -o $@ \
 223                 $(quiet-flag) \
 224                 $<
 225
 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) $<
 229
 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) $<
 233
 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) $$< ) \
 238 ))
 239
 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 $<
 243
 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 $<
 247
 248 # Build the English website
 249 $(OUT)/index.html: $(top-src-dir)/Documentation/web.texi $(xref-files)
 250         $(DO_TEXI_DEP) $(TEXI2HTML) $<
 251
 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)" $$<; ) \
 256 ))
 257
 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
 264
 265 # Simple copy
 266 $(css-files): $(OUT)/website/css/%: $(top-src-dir)/Documentation/css/%
 267         cp $< $@
 268
 269 $(example-files): $(OUT)/website/ly-examples/%: $(EXAMPLES)/%
 270         cp $< $@
 271
 272 $(picture-files): $(OUT)/website/pictures/%: $(PICTURES)/%
 273         cp $< $@
 274
 275 $(pdf-files): $(OUT)/website/pdf/%: $(PDFS)/%
 276         cp $< $@
 277
 278 $(OUT)/website/favicon.ico: $(SERVER_FILES)/favicon.ico
 279         cp $< $@
 280
 281 $(OUT)/website/robots.txt: $(SERVER_FILES)/robots.txt
 282         cp $< $@
 283
 284 $(OUT)/.htaccess: $(top-htaccess)
 285         cp $< $@
 286
 287 $(OUT)/website/.htaccess: $(dir-htaccess)
 288         cp $< $@