doc/manual/Makefile

   1 # DCP-o-matic manual makefile
   2
   3 all:    html pdf
   4
   5 DIAGRAMS := file-structure.svg 3d-left-right.svg
   6
   7 SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-content-file.png \
   8                still-select-content-file.png examine-thumbs.png examine-content.png timing-tab.png \
   9                calculate-audio-gain.png \
  10                prefs-kdm-email.png prefs-colour-conversions.png prefs-metadata.png prefs-misc.png prefs-tms.png \
  11                making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.png \
  12                audio-plot.png audio-map-eg1.png audio-map-eg2.png audio-map-eg3.png kdm.png
  13
  14 XML := dcpomatic.xml
  15
  16 GRAPHICS :=
  17
  18 #
  19 # For the HTML, default to copying the screenshots direct
  20 #
  21 html/screenshots/%.png: screenshots/%.png
  22         mkdir -p html/screenshots
  23         cp $< $@
  24
  25 #
  26 # Some need resizing...
  27 #
  28 html/screenshots/editor.png: screenshots/editor.png
  29         mkdir -p html/screenshots
  30         convert -resize 50% $< $@
  31 html/screenshots/mixer.png: screenshots/mixer.png
  32         mkdir -p html/screenshots
  33         convert -resize 50% $< $@
  34 html/screenshots/default-folder-for-new-sessions.png: screenshots/default-folder-for-new-sessions.png
  35         mkdir -p html/screenshots
  36         convert -resize 75% $< $@
  37 html/screenshots/welcome-to-ardour.png: screenshots/welcome-to-ardour.png
  38         mkdir -p html/screenshots
  39         convert -resize 75% $< $@
  40 html/screenshots/monitoring-choices.png: screenshots/monitoring-choices.png
  41         mkdir -p html/screenshots
  42         convert -resize 75% $< $@
  43 html/screenshots/monitor-section.png: screenshots/monitor-section.png
  44         mkdir -p html/screenshots
  45         convert -resize 75% $< $@
  46 html/screenshots/audio-midi-setup-device.png: screenshots/audio-midi-setup-device.png
  47         mkdir -p html/screenshots
  48         convert -resize 75% $< $@
  49 html/screenshots/new-session.png: screenshots/new-session.png
  50         mkdir -p html/screenshots
  51         convert -resize 75% $< $@
  52 html/screenshots/export-dialogue.png: screenshots/export-dialogue.png
  53         mkdir -p html/screenshots
  54         convert -resize 75% $< $@
  55 html/screenshots/making-dcp.png: screenshots/making-dcp.png
  56         mkdir -p html/screenshots
  57         convert -resize 75% $< $@
  58
  59 # For HTML: convert graphics from SVG to PNG
  60 graphics/%.png: graphics/%.svg
  61         inkscape -z -f $< --export-png $@ --export-area-drawing
  62
  63 # For LaTeX/PDF: convert graphics from SVG to PDF
  64 graphics/%.pdf: graphics/%.svg
  65         inkscape -z -f $< --export-pdf $@ --export-area-drawing
  66
  67 # For HTML: convert diagrams from SVG to PNG
  68 diagrams/%.png: diagrams/%.svg
  69         inkscape -z -f $< --export-png $@ --export-area-drawing
  70
  71 # For LaTeX/PDF: convert diagrams from SVG to PDF
  72 diagrams/%.pdf: diagrams/%.svg
  73         inkscape -z -f $< --export-pdf $@ --export-area-drawing
  74
  75 #
  76 # HTML
  77 #
  78
  79 html:   $(XML) dcpomatic-html.xsl extensions-html.ent dcpomatic.css \
  80         $(addprefix html/screenshots/,$(SCREENSHOTS)) \
  81         $(subst .svg,.png,$(addprefix diagrams/,$(DIAGRAMS))) \
  82         $(subst .svg,.png,$(addprefix graphics/,$(GRAPHICS))) \
  83
  84 #       The DocBook needs to know what file extensions to look for
  85 #       for screenshots and diagrams; use the correct file to tell it.
  86         cp extensions-html.ent extensions.ent
  87
  88 #       DocBoox -> html
  89         xmlto html -m dcpomatic-html.xsl dcpomatic.xml --skip-validation -o html
  90
  91 #       Copy graphics and CSS in
  92         mkdir -p html/diagrams
  93 #       mkdir -p html/graphics
  94         cp diagrams/*.png html/diagrams
  95 #       cp graphics/*.png html/graphics
  96         cp dcpomatic.css html
  97
  98 #
  99 # PDF
 100 #
 101
 102 pdf:    $(XML) dcpomatic-pdf.xsl extensions-pdf.ent screenshots/*.png $(subst .svg,.pdf,$(addprefix diagrams/,$(DIAGRAMS)))
 103
 104 #       The DocBook needs to know what file extensions to look for
 105 #       for screenshots and diagrams; use the correct file to tell it.
 106         cp extensions-pdf.ent extensions.ent
 107
 108         mkdir -p pdf
 109
 110         dblatex -p dcpomatic-pdf.xsl -s dcpomatic.sty -r pptex.py -T native dcpomatic.xml -t pdf -o pdf/dcpomatic.pdf
 111
 112
 113 #
 114 # LaTeX (handy for debugging)
 115 #
 116
 117 tex:    $(XML) dcpomatic-pdf.xsl extensions-pdf.ent
 118
 119 #       The DocBook needs to know what file extensions to look for
 120 #       for screenshots and diagrams; use the correct file to tell it.
 121         cp extensions-pdf.ent extensions.ent
 122
 123         mkdir -p tex
 124
 125 #       -P <foo> removes the revhistory table
 126         dblatex -P doc.collab.show=0 -P latex.output.revhistory=0 -p dcpomatic-pdf.xsl -s dcpomatic.sty -r pptex.py -T native dcpomatic.xml -t tex -o tex/dcpomatic.tex
 127
 128
 129 clean:; rm -rf html pdf diagrams/*.pdf diagrams/*.png graphics/*.png *.aux dcpomatic.cb dcpomatic.cb2 dcpomatic.glo dcpomatic.idx dcpomatic.ilg
 130         rm -rf dcpomatic.ind dcpomatic.lof dcpomatic.log dcpomatic.tex dcpomatic.toc extensions.ent dcpomatic.out