docs/manuals.mak

   1 # rewritten by Thomas to be more simple and working
   2
   3 # SF username
   4 USERNAME ?= thomasvs
   5
   6 ### These are all generic; we set all the variables we need
   7
   8 # intermediary build path
   9 BUILDDIR = build
  10 # same for images
  11 BUILDIMAGESDIR = $(BUILDDIR)/images
  12
  13 # images
  14 # right now, we only allow .png and .fig as source
  15 # we might add more later if we feel the need
  16
  17 # PNG's can be source or built from .fig
  18 PNG = $(strip $(PNG_SRC) $(FIG_SRC:.fig=.png))
  19 # EPS .ps files can be built from .png or .fig
  20 EPS = $(strip $(FIG_SRC:.fig=.ps) $(PNG_SRC:.png=.ps))
  21 # PDF .pdf files can be built from .png or .fig
  22 PDF = $(strip $(FIG_SRC:.fig=.pdf) $(PNG_SRC:.png=.pdf))
  23
  24 # where we expect to find images during building, whether by copying
  25 # or by generating them
  26 PNG_BUILT = $(foreach file, $(PNG), $(BUILDIMAGESDIR)/$(file))
  27 EPS_BUILT = $(foreach file, $(EPS), $(BUILDIMAGESDIR)/$(file))
  28 PDF_BUILT = $(foreach file, $(PDF), $(BUILDIMAGESDIR)/$(file))
  29
  30 # everything considered source
  31 SRC = $(XML) $(PNG_SRC) $(FIG_SRC) $(CSS)
  32
  33 # generate A4 docs
  34 PAPER_LOCALE = nl_NL
  35
  36 ### generate all documentation by default
  37 all: html ps pdf
  38
  39 # can we generate HTML ?
  40 if     DOC_HTML
  41 HTML_DAT = html
  42 HTML_TARGET = html/index.html
  43 else  #!DOC_HTML
  44 HTML_DAT =
  45 HTML_TARGET =
  46 endif #DOC_HTML
  47 html: $(HTML_TARGET)
  48
  49 # can we generate PS ?
  50 if     DOC_PS
  51 PS_DAT = $(DOC).ps
  52 else  #!DOC_PS
  53 PS_DAT =
  54 endif #DOC_PS
  55 ps: $(PS_DAT)
  56
  57 # can we generate PDF ?
  58 if     DOC_PDF
  59 PDF_DAT = $(DOC).pdf
  60 else  #!DOC_PDF
  61 PDF_DAT =
  62 endif #DOC_PDF
  63 pdf: $(PDF_DAT)
  64
  65 debug:
  66         @echo "outputting some useful debug information"
  67         @echo "Source XML:"
  68         @echo "XML: '$(XML)'"
  69         @echo "CSS: '$(CSS)'"
  70         @echo "Source image files:"
  71         @echo "PNG_SRC: '$(PNG_SRC)'"
  72         @echo "FIG_SRC: '$(FIG_SRC)'"
  73         @echo "All used image files:"
  74         @echo "PNG: '$(PNG)'"
  75         @echo "EPS: '$(EPS)'"
  76         @echo "PDF: '$(PDF)'"
  77         @echo "All used image files in their built path:"
  78         @echo "PNG_BUILT: '$(PNG_BUILT)'"
  79         @echo "EPS_BUILT: '$(EPS_BUILT)'"
  80         @echo "PDF_BUILT: '$(PDF_BUILT)'"
  81         @echo "End result products:"
  82         @echo "HTML_DAT: '$(HTML_DAT)'"
  83         @echo "PS_DAT:   '$(PS_DAT)'"
  84         @echo "PDF_DAT:  '$(PDF_DAT)'"
  85
  86 # a rule to copy all of the source for docs into $(builddir)/build
  87 $(BUILDDIR)/$(MAIN): $(XML) $(CSS)
  88         @-mkdir -p $(BUILDDIR)
  89         @for a in $(XML); do cp $(srcdir)/$$a $(BUILDDIR); done
  90         @for a in $(CSS); do cp $(srcdir)/$$a $(BUILDDIR); done
  91         @cp ../version.entities $(BUILDDIR)
  92
  93 html/index.html: $(BUILDDIR)/$(MAIN) $(PNG_BUILT) $(FIG_SRC)
  94         @make check-local
  95         @echo "*** Generating HTML output ***"
  96         @-mkdir -p html
  97         @cp -f $(srcdir)/../image-png $(BUILDDIR)/image.entities
  98         @cd $(BUILDDIR) && docbook2html -o ../html -V '%use-id-as-filename%' $(MAIN)
  99         @test "x$(CSS)" != "x" && \
 100           echo "Copying .css files: $(CSS)" && \
 101           cp $(srcdir)/$(CSS) html
 102         @test "x$(PNG)" != "x" && \
 103           echo "Copying .png images: $(PNG_BUILT)" && \
 104           mkdir -p html/images && \
 105           cp $(PNG_BUILT) html/images || true
 106
 107 $(DOC).ps: $(BUILDDIR)/$(MAIN) $(EPS_BUILT) $(PNG_SRC) $(FIG_SRC)
 108         @make check-local
 109         @echo "*** Generating PS output ***"
 110         @cp -f $(srcdir)/../image-eps $(BUILDDIR)/image.entities
 111         cd $(BUILDDIR) && docbook2ps -o .. $(MAIN)
 112 #       export LC_PAPER=$(PAPER_LOCALE) && cd $(BUILDDIR) && xmlto ps -o .. $(MAIN)
 113
 114 $(DOC).pdf: $(DOC).ps
 115         @make check-local
 116         @echo "*** Generating PDF output ***"
 117         @ps2pdf $(DOC).ps
 118
 119 #$(DOC).pdf: $(MAIN) $(PDF) $(FIG_SRC)
 120 #       @echo "*** Generating PDF output ***"
 121 #       @cp -f $(srcdir)/../image-pdf image.entities
 122 #       @export LC_PAPER=$(PAPER_LOCALE) && xmlto pdf $(MAIN)
 123 #       @rm image.entities
 124
 125 clean-local:
 126         -$(RM) -r $(BUILDDIR)
 127         -$(RM) -r html
 128         -$(RM) $(DOC).ps
 129         -$(RM) $(DOC).pdf
 130         -$(RM) -r www
 131
 132 ### image generation
 133
 134 # copy png from source dir png
 135 $(BUILDIMAGESDIR)/%.png: $(srcdir)/%.png
 136         @echo "Copying $< to $@"
 137         @mkdir -p $(BUILDIMAGESDIR)
 138         @cp $< $@
 139 # make png from fig
 140 $(BUILDIMAGESDIR)/%.png: %.fig
 141         @echo "Generating $@ from $<"
 142         @mkdir -p $(BUILDIMAGESDIR)
 143         @fig2dev -Lpng $< $@
 144
 145 # make ps(EPS) from fig
 146 $(BUILDIMAGESDIR)/%.ps: %.fig
 147         @echo "Generating $@ from $<"
 148         @mkdir -p $(BUILDIMAGESDIR)
 149         @fig2dev -Leps $< $@
 150
 151 # make pdf from fig
 152 $(BUILDIMAGESDIR)/%.pdf: %.fig
 153         @echo "Generating $@ from $<"
 154         @mkdir -p $(BUILDIMAGESDIR)
 155         @fig2dev -Lpdf $< $@
 156
 157 # make pdf from png
 158 $(BUILDIMAGESDIR)/%.pdf: %.png
 159         @echo "Generating $@ from $<"
 160         @mkdir -p $(BUILDIMAGESDIR)
 161         @cat $< | pngtopnm | pnmtops -noturn 2> /dev/null | epstopdf --filter --outfile $@ 2> /dev/null
 162
 163 # make ps(EPS) from png
 164 $(BUILDIMAGESDIR)/%.ps: %.png
 165         @echo "Generating $@ from $<"
 166         @mkdir -p $(BUILDIMAGESDIR)
 167         @cat $< | pngtopnm | pnmtops -noturn > $@ 2> /dev/null
 168
 169 # make sure xml validates properly
 170 check-local: $(BUILDDIR)/$(MAIN)
 171         @cp -f $(srcdir)/../image-png $(BUILDDIR)/image.entities
 172         cd $(BUILDDIR) && xmllint -noout -valid $(MAIN)