doc/manual/Makefile

   1 # DCP-o-matic manual makefile
   2
   3 INKSCAPE = ~/Applications/inkscape
   4 LIBDCP = ~/src/libdcp
   5
   6
   7 all:    html pdf
   8
   9 DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.svg pipeline1.svg pipeline2.svg \
  10             pipeline3.svg pipeline4.svg burn-in.svg discrete.svg dcp-copy.svg dcp-refer.svg reels-by-video.svg \
  11             crypt.svg
  12
  13 SCREENSHOTS := file-new.pdf new-film.pdf video-select-content-file.pdf \
  14                still-select-content-file.pdf examine-content.pdf timing-tab.pdf \
  15                calculate-audio-gain.pdf add-file.pdf dcp-tab.pdf colour-conversion.pdf \
  16                prefs-email.pdf prefs-kdm-email.pdf prefs-general.pdf prefs-tms.pdf prefs-cover-sheet.pdf \
  17                prefs-advanced.pdf prefs-defaults.pdf prefs-servers.pdf prefs-keys.pdf \
  18                prefs-notifications.pdf timeline1.pdf timed-text-tab.pdf \
  19                making-dcp.pdf filters.pdf video-tab.pdf audio-tab.pdf \
  20                audio-plot.pdf audio-map-eg1.pdf audio-map-eg2.pdf audio-map-eg3.pdf kdm.pdf \
  21                kdm-creator.pdf export.pdf advanced-content.pdf disk-writer-notice.pdf disk-writer.pdf \
  22                markers.pdf
  23
  24 XML := dcpomatic.xml
  25
  26 #
  27 # For the HTML: convert PDF screenshots to PNG and copy into html/screenshots, scaling some.
  28 #
  29 html/screenshots/%.png: screenshots/%.pdf
  30         mkdir -p html/screenshots
  31         pdftoppm $< $(basename $@) -png -f 1 -singlefile -rx 80 -ry 80
  32
  33
  34 # For LaTeX/PDF: crop some of the PDF screenshots; use others as-is
  35 screenshots/%.pdf: raw-screenshots/%.pdf
  36         cp $< $@
  37
  38 screenshots/prefs-general.pdf: raw-screenshots/prefs-general.pdf
  39         python3 pdf_crop_by.py $< $@ 0 400 0 0
  40
  41 screenshots/prefs-defaults.pdf: raw-screenshots/prefs-defaults.pdf
  42         python3 pdf_crop_by.py $< $@ 0 400 0 0
  43
  44 screenshots/prefs-servers.pdf: raw-screenshots/prefs-servers.pdf
  45         python3 pdf_crop_by.py $< $@ 0 700 0 0
  46
  47 screenshots/prefs-keys.pdf: raw-screenshots/prefs-keys.pdf
  48         python3 pdf_crop_by.py $< $@ 0 600 0 0
  49
  50 screenshots/prefs-tms.pdf: raw-screenshots/prefs-tms.pdf
  51         python3 pdf_crop_by.py $< $@ 0 600 0 0
  52
  53 screenshots/prefs-email.pdf: raw-screenshots/prefs-email.pdf
  54         python3 pdf_crop_by.py $< $@ 0 700 0 0
  55
  56 screenshots/prefs-cover-sheet.pdf: raw-screenshots/prefs-cover-sheet.pdf
  57         python3 pdf_crop_by.py $< $@ 0 600 0 0
  58
  59 screenshots/examine-content.pdf: raw-screenshots/examine-content.pdf
  60         python3 pdf_crop_by.py $< $@ 460 270 200 580
  61
  62 screenshots/audio-tab.pdf: raw-screenshots/audio-tab.pdf
  63         python3 pdf_crop_by.py $< $@ 0 0 1480 420
  64
  65 screenshots/timing-tab.pdf: raw-screenshots/timing-tab.pdf
  66         python3 pdf_crop_by.py $< $@ 0 100 1475 420
  67
  68 screenshots/timed-text-tab.pdf: raw-screenshots/timed-text-tab.pdf
  69         python3 pdf_crop_by.py $< $@ 0 50 1480 420
  70
  71 screenshots/video-tab.pdf: raw-screenshots/video-tab.pdf
  72         python3 pdf_crop_by.py $< $@ 0 0 1480 365
  73
  74 screenshots/add-file.pdf: raw-screenshots/add-file.pdf
  75         python3 pdf_crop_by.py $< $@ 0 600 1210 0
  76
  77 screenshots/making-dcp.pdf: raw-screenshots/making-dcp.pdf
  78         python3 pdf_crop_by.py $< $@ 470 190 300 700
  79
  80 screenshots/audio-map-eg1.pdf: raw-screenshots/audio-map-eg1.pdf
  81         python3 pdf_crop_by.py $< $@ 10 195 1350 630
  82
  83 screenshots/audio-map-eg2.pdf: raw-screenshots/audio-map-eg2.pdf
  84         python3 pdf_crop_by.py $< $@ 10 195 1350 630
  85
  86 screenshots/audio-map-eg3.pdf: raw-screenshots/audio-map-eg3.pdf
  87         python3 pdf_crop_by.py $< $@ 10 75 1350 630
  88
  89 screenshots/dcp-tab.pdf: raw-screenshots/dcp-tab.pdf
  90         python3 pdf_crop_by.py $< $@ 0 250 1480 30
  91
  92
  93 # For HTML: convert diagrams from SVG to PNG
  94 diagrams/%.png: diagrams/%.svg
  95         $(INKSCAPE) $< --export-type=png --export-filename=$@ --export-area-drawing
  96
  97 # For LaTeX/PDF: convert diagrams from SVG to PDF
  98 diagrams/%.pdf: diagrams/%.svg
  99         $(INKSCAPE) $< --export-type=pdf --export-filename=$@ --export-area-drawing
 100
 101 config.xml:     ../../src/lib/config.cc config.py
 102         python3 config.py ../../src/lib/config.cc > config.xml
 103
 104 SHORTCUTS :=    ../../src/tools/dcpomatic.cc
 105
 106 shortcuts.xml:  $(SHORTCUTS) shortcuts.py
 107         python3 shortcuts.py $(SHORTCUTS) > $@
 108
 109 LIBDCP_DEPS = $(LIBDCP)/src/verify_j2k.cc $(LIBDCP)/src/dcp.cc $(LIBDCP)/src/verify.cc
 110
 111 verify_errors.xml:      verifier.py $(LIBDCP_DEPS)
 112         python3 verifier.py $(LIBDCP) ERROR > $@
 113
 114 verify_bv21_errors.xml: verifier.py $(LIBDCP_DEPS)
 115         python3 verifier.py $(LIBDCP) BV21_ERROR > $@
 116
 117 verify_warnings.xml:    verifier.py $(LIBDCP_DEPS)
 118         python3 verifier.py $(LIBDCP) WARNING > $@
 119
 120
 121 #
 122 # HTML
 123 #
 124
 125 html:   $(XML) config.xml shortcuts.xml verify_errors.xml verify_bv21_errors.xml verify_warnings.xml \
 126         dcpomatic-html.xsl extensions-html.ent dcpomatic.css dcpomatic_create.xml dcpomatic_cli.xml dcpomatic_kdm_cli.xml \
 127         $(subst .pdf,.png,$(addprefix html/screenshots/,$(SCREENSHOTS))) \
 128         $(subst .svg,.png,$(addprefix diagrams/,$(DIAGRAMS))) \
 129
 130 #       The DocBook needs to know what file extensions to look for
 131 #       for screenshots and diagrams; use the correct file to tell it.
 132         cp extensions-html.ent extensions.ent
 133
 134 #       DocBoox -> html
 135         xmlto html -m dcpomatic-html.xsl dcpomatic.xml --skip-validation -o html
 136
 137 #       Copy graphics and CSS in
 138         mkdir -p html/diagrams
 139         cp diagrams/*.png html/diagrams
 140         cp dcpomatic.css html
 141
 142 #
 143 # PDF
 144 #
 145
 146 pdf:    $(XML) config.xml shortcuts.xml verify_errors.xml verify_bv21_errors.xml verify_warnings.xml \
 147         dcpomatic-pdf.xsl extensions-pdf.ent dcpomatic_create.xml dcpomatic_cli.xml dcpomatic_kdm_cli.xml \
 148         $(addprefix screenshots/,$(SCREENSHOTS)) \
 149         $(subst .svg,.pdf,$(addprefix diagrams/,$(DIAGRAMS)))
 150
 151 #       The DocBook needs to know what file extensions to look for
 152 #       for screenshots and diagrams; use the correct file to tell it.
 153         cp extensions-pdf.ent extensions.ent
 154
 155         mkdir -p pdf
 156
 157         dblatex -p dcpomatic-pdf.xsl -s dcpomatic.sty -r pptex.py -T native dcpomatic.xml -t pdf -o pdf/dcpomatic.pdf
 158
 159
 160 #
 161 # LaTeX (handy for debugging)
 162 #
 163
 164 tex:    $(XML) config.xml dcpomatic-pdf.xsl extensions-pdf.ent
 165
 166 #       The DocBook needs to know what file extensions to look for
 167 #       for screenshots and diagrams; use the correct file to tell it.
 168         cp extensions-pdf.ent extensions.ent
 169
 170         mkdir -p tex
 171
 172 #       -P <foo> removes the revhistory table
 173         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
 174
 175
 176 clean:; rm -rf html pdf diagrams/*.pdf diagrams/*.png graphics/*.png *.aux dcpomatic.cb dcpomatic.cb2 dcpomatic.glo dcpomatic.idx dcpomatic.ilg
 177         rm -rf dcpomatic.ind dcpomatic.lof dcpomatic.log dcpomatic.tex dcpomatic.toc extensions.ent dcpomatic.out