doc/manual/Makefile

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