1 ### These are all generic; we set all the variables we need
3 # intermediary build path
6 BUILDIMAGESDIR = $(BUILDDIR)/images
9 # right now, we only allow .png and .fig as source
10 # we might add more later if we feel the need
12 # PNG's can be source or built from .fig
13 PNG = $(strip $(PNG_SRC) $(FIG_SRC:.fig=.png))
14 # EPS .ps files can be built from .png or .fig
15 EPS = $(strip $(FIG_SRC:.fig=.ps) $(PNG_SRC:.png=.ps))
16 # PDF .pdf files can be built from .png or .fig
17 PDF = $(strip $(FIG_SRC:.fig=.pdf) $(PNG_SRC:.png=.pdf))
19 # where we expect to find images during building, whether by copying
20 # or by generating them
21 PNG_BUILT = $(foreach file, $(PNG), $(BUILDIMAGESDIR)/$(file))
22 EPS_BUILT = $(foreach file, $(EPS), $(BUILDIMAGESDIR)/$(file))
23 PDF_BUILT = $(foreach file, $(PDF), $(BUILDIMAGESDIR)/$(file))
25 SRC = $(XML) $(PNG_SRC) $(FIG_SRC) $(CSS) $(EXTRA_SRC)
30 ### generate all documentation by default
31 # hook in html generation
34 # can we generate HTML ?
37 HTML_TARGET = html/index.html
44 # can we generate PS ?
52 # can we generate PDF ?
61 @echo "outputting some useful debug information"
65 @echo "Source image files:"
66 @echo "PNG_SRC: '$(PNG_SRC)'"
67 @echo "FIG_SRC: '$(FIG_SRC)'"
68 @echo "All used image files:"
72 @echo "All used image files in their built path:"
73 @echo "PNG_BUILT: '$(PNG_BUILT)'"
74 @echo "EPS_BUILT: '$(EPS_BUILT)'"
75 @echo "PDF_BUILT: '$(PDF_BUILT)'"
76 @echo "End result products:"
77 @echo "HTML_DAT: '$(HTML_DAT)'"
78 @echo "PS_DAT: '$(PS_DAT)'"
79 @echo "PDF_DAT: '$(PDF_DAT)'"
81 # a rule to copy all of the source for docs into $(builddir)/build
82 $(BUILDDIR)/$(MAIN): $(XML) $(CSS) $(EXTRA_SRC)
83 @-mkdir -p $(BUILDDIR); \
84 if test "x$(EXTRA_SRC)" != "x"; then for a in $(EXTRA_SRC); do cp $(srcdir)/$$a $(BUILDDIR); done; fi ; \
85 for a in $(XML); do cp $(srcdir)/$$a $(BUILDDIR); done ; \
86 for a in $(CSS); do cp $(srcdir)/$$a $(BUILDDIR); done ; \
87 cp ../version.entities $(BUILDDIR) ; \
88 cp $(top_srcdir)/docs/url.entities $(BUILDDIR)
90 html/index.html: $(BUILDDIR)/$(MAIN) $(PNG_BUILT) $(FIG_SRC)
92 @echo "*** Generating HTML output ***"
94 @cp -f $(srcdir)/../image-png $(BUILDDIR)/image.entities
95 @cd $(BUILDDIR) && $(XSLTPROC) -o ../html/ --stringparam chunker.output.encoding UTF-8 --stringparam use.id.as.filename 1 $(XSLTPROC_FLAGS) "http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl" $(MAIN)
96 @test "x$(CSS)" != "x" && \
97 echo "Copying .css files: $(CSS)" && \
98 cp $(srcdir)/$(CSS) html
99 @test "x$(PNG)" != "x" && \
100 echo "Copying .png images: $(PNG_BUILT)" && \
101 mkdir -p html/images && \
102 cp $(PNG_BUILT) html/images || true
104 $(DOC).ps: $(BUILDDIR)/$(MAIN) $(EPS_BUILT) $(PNG_SRC) $(FIG_SRC)
106 @echo "*** Generating PS output ***"
107 @cp -f $(srcdir)/../image-eps $(BUILDDIR)/image.entities
108 cd $(BUILDDIR) && SP_ENCODING="UTF-8" docbook2ps -o .. $(MAIN)
109 # export LC_PAPER=$(PAPER_LOCALE) && cd $(BUILDDIR) && xmlto ps -o .. $(MAIN)
111 $(DOC).pdf: $(DOC).ps
113 @echo "*** Generating PDF output ***"
116 #$(DOC).pdf: $(MAIN) $(PDF) $(FIG_SRC)
117 # @echo "*** Generating PDF output ***"
118 # @cp -f $(srcdir)/../image-pdf image.entities
119 # @export LC_PAPER=$(PAPER_LOCALE) && xmlto pdf $(MAIN)
123 -$(RM) -r $(BUILDDIR)
131 # copy png from source dir png
132 $(BUILDIMAGESDIR)/%.png: $(srcdir)/%.png
133 @echo "Copying $< to $@"
134 @mkdir -p $(BUILDIMAGESDIR)
137 $(BUILDIMAGESDIR)/%.png: %.fig
138 @echo "Generating $@ from $<"
139 @mkdir -p $(BUILDIMAGESDIR)
142 # make ps(EPS) from fig
143 $(BUILDIMAGESDIR)/%.ps: %.fig
144 @echo "Generating $@ from $<"
145 @mkdir -p $(BUILDIMAGESDIR)
149 $(BUILDIMAGESDIR)/%.pdf: %.fig
150 @echo "Generating $@ from $<"
151 @mkdir -p $(BUILDIMAGESDIR)
155 $(BUILDIMAGESDIR)/%.pdf: %.png
156 @echo "Generating $@ from $<"
157 @mkdir -p $(BUILDIMAGESDIR)
158 @cat $< | pngtopnm | pnmtops -noturn 2> /dev/null | epstopdf --filter --outfile $@ 2> /dev/null
160 # make ps(EPS) from png
161 $(BUILDIMAGESDIR)/%.ps: %.png
162 @echo "Generating $@ from $<"
163 @mkdir -p $(BUILDIMAGESDIR)
164 @cat $< | pngtopnm | pnmtops -noturn > $@ 2> /dev/null
166 # make sure xml validates properly
167 check-local: $(BUILDDIR)/$(MAIN)
168 @cp -f $(srcdir)/../image-png $(BUILDDIR)/image.entities
169 @cd $(BUILDDIR) && xmllint -noout -valid $(MAIN)
171 if [ `which curl` ]; then \
172 links=`$(XSLTPROC) $(XSLTPROC_FLAGS) --xinclude $(abs_top_srcdir)/docs/list-ulink.xsl $(MAIN) | egrep '^http' | sort | uniq` && \
174 for link in $$links; do \
175 code=`curl -s -m20 -o /dev/null -I -w "%{http_code}" $$link`; \
176 if [ \( $$? -ne 0 \) -o \( $$code -gt 399 \) ]; then \
177 echo "exit_status=$$?, http_code=$$code: $$link"; \
178 grep -Hnr "$$link" .; \
184 # avoid 'cp: cannot create regular file `build/image.entities': File exists'
185 # errors during 'make distcheck' by disabling parallel builds