doc: Finish converting docs to asciidoc format
[fw/altos] / doc / Makefile
index 52934290777b14d59a070decf9d367398caf9eaa..df1a884c78945e280209f5d3ff11f77eafe79d99 100644 (file)
 #      http://docbook.sourceforge.net/release/xsl/current/README
 #
 
-HTML=telemetrum-doc.html altosui-doc.html altos.html
-PDF=telemetrum-doc.pdf altosui-doc.pdf altos.pdf
-DOC=$(HTML) $(PDF)
-HTMLSTYLE=/usr/share/xml/docbook/stylesheet/docbook-xsl/html/docbook.xsl
-FOSTYLE=/usr/share/xml/docbook/stylesheet/docbook-xsl/fo/docbook.xsl
-PDFSTYLE=
+RELNOTES_INC=\
+       release-notes-0.7.1.inc \
+       release-notes-0.8.inc \
+       release-notes-0.9.inc \
+       release-notes-0.9.2.inc \
+       release-notes-1.0.1.inc \
+       release-notes-1.1.inc \
+       release-notes-1.1.1.inc \
+       release-notes-1.2.inc \
+       release-notes-1.2.1.inc \
+       release-notes-1.3.inc \
+       release-notes-1.3.1.inc \
+       release-notes-1.3.2.inc \
+       release-notes-1.4.inc \
+       release-notes-1.4.1.inc \
+       release-notes-1.4.2.inc \
+       release-notes-1.5.inc \
+       release-notes-1.6.inc \
+       release-notes-1.6.1.inc
 
-.SUFFIXES: .xsl .html .fo .pdf
+PICTURES=\
+       altosui.png \
+       ascent.png \
+       configure-altimeter.png \
+       configure-altosui.png \
+       configure-groundstation.png \
+       configure-pyro.png \
+       descent.png \
+       device-selection.png \
+       easymini-top.jpg \
+       fire-igniter.png \
+       graph-configure.png \
+       graph-map.png \
+       graph.png \
+       graph-stats.png \
+       landed.png \
+       launch-pad.png \
+       load-maps.png \
+       micropeak-app.png \
+       micropeak-back.jpg \
+       micropeak-device-dialog.png \
+       micropeak-dime.jpg \
+       micropeak-download.png \
+       micropeak-graph-configure.png \
+       micropeak-graph.png \
+       micropeak-preferences.png \
+       micropeak-raw-data.png \
+       micropeak-save-dialog.png \
+       micropeak-statistics.png \
+       MicroPeakUSB-2.0-inuse.jpg \
+       MicroPeakUSB-2.0.jpg \
+       monitor-idle.png \
+       scan-channels.png \
+       site-map.png \
+       table.png \
+       telemega-v1.0-top.jpg \
+       telemetrum-v1.1-thside.jpg \
+       telemini-v1-top.jpg \
+       telemini-v2-top.jpg
 
-.xsl.html:
-       xsltproc -o $@ $(HTMLSTYLE) $*.xsl
+TXT_FILES=altusmetrum.txt
 
-.xsl.fo:
-       xsltproc -o $@ $(FOSTYLE) $*.xsl
+INC_FILES=\
+       dedication.inc \
+       intro.inc \
+       getting-started.inc \
+       usage.inc \
+       telemetrum.inc \
+       telemini-v1.0.inc \
+       telemini-v2.0.inc \
+       easymini.inc \
+       telemega.inc \
+       easymega.inc \
+       installation.inc \
+       using-am-products.inc \
+       updating-firmware.inc \
+       altosui.inc \
+       altosdroid.inc \
+       system-operation.inc \
+       pyro-channels.inc \
+       flight-data-recording.inc \
+       handling.inc \
+       specs.inc \
+       release-notes.inc \
+       $(RELNOTES_INC)
 
-.fo.pdf:
-       fop -fo $*.fo -pdf $@
+RAW_FILES=$(TXT_FILES:.txt=.raw) $(INC_FILES:.inc=.raw)
+
+TELEGPS_INC_FILES=\
+       dedication.inc \
+       telegps-quick-start.inc \
+       telegps-using.inc \
+       telegps-system-operation.inc \
+       telegps-application.inc \
+       handling.inc \
+       telegps-specs.inc \
+       telegps-updating-firmware.inc \
+       telegps-release-notes.inc
+
+TELEGPS_TXT_FILES=\
+       telegps.txt
+
+TELEGPS_RAW_FILES=$(TELEGPS_TXT_FILES:.txt=.raw) $(TELEGPS_INC_FILES:.inc=.raw)
+
+MICROPEAK_TXT_FILES=\
+       micropeak.txt
+
+MICROPEAK_INC_FILES=
+
+MICROPEAK_RAW_FILES=$(MICROPEAK_TXT_FILES:.txt=.raw) $(MICROPEAK_INC_FILES:.inc=.raw)
+
+OUTLINE_TXT_FILES=\
+       easymega-outline.txt \
+       easymini-outline.txt \
+       telemega-outline.txt \
+       telemetrum-outline.txt \
+       telemini-outline.txt
+
+OUTLINE_RAW_FILES=$(OUTLINE_TXT_FILES:.txt=.raw)
+
+OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf)
+
+SVG=\
+       easymini.svg \
+       telemega.svg \
+       telemetrum.svg \
+       telemini.svg \
+       easymega.svg
+
+RELNOTES_PDF=$(RELNOTES_INC:.inc=.pdf)
+RELNOTES_HTML=$(RELNOTES_INC:.inc=.html)
+
+HTML=altusmetrum.html altos.html telemetry.html companion.html micropeak.html telegps.html $(RELNOTES_HTML)
+
+PDF=altusmetrum.pdf $(RELNOTES_PDF) altos.pdf telemetry.pdf companion.pdf micropeak.pdf telegps.pdf \
+       $(OUTLINE_PDF_FILES)
+
+FOSTYLE=xorg-fo.xsl
+
+TEMPLATES_TMPL=titlepage.templates.tmpl
+
+TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl)
+
+IMAGES=$(PICTURES) $(SVG)
+
+DOC=$(HTML) $(PDF) $(IMAGES)
+
+.SUFFIXES: .tmpl .xsl .inc .txt .raw .pdf .html
+
+XSLTFLAGS=--stringparam section.autolabel 1 --xinclude
+
+.txt.raw:
+       sed -e 's/@@VERSION@@/$(VERSION)/' -e 's/@@DATE@@/$(DATE)/' -e 's/^[    ]*//' -e 's/^\\//' $*.txt > $@
+
+.inc.raw:
+       sed -e 's/@@VERSION@@/$(VERSION)/' -e 's/@@DATE@@/$(DATE)/' -e 's/^[    ]*//' -e 's/^\\//' $*.inc > $@
+
+.raw.pdf:
+       a2x --verbose -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file am-fo.xsl --fop --fop-opts="-c fop.xconf" $*.raw
+
+.raw.html:
+       a2x --verbose -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --stylesheet=am.css $*.raw
+
+.tmpl.xsl:
+       xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl
 
 all:   $(HTML) $(PDF)
 
+$(HTML): $(PDF)
+
+altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(RAW_INC) $(IMAGES)
+
+telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES)
+
+micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_RAW_FILES) $(IMAGES)
+
+install:       all
+
 publish:       $(DOC)
-       cp $(DOC)telemetrum-doc.html home/bdale/web/altusmetrum/TeleMetrum/doc/
-       (cd /home/bdale/web/altusmetrum ; echo "update docs" | git commit -F - /home/bdale/web/altusmetrum/TeleMetrum/doc/* ; git push)
+       cp $(DOC) /home/bdale/web/altusmetrum/AltOS/doc/
+       (cd /home/bdale/web/altusmetrum ; \
+        git add /home/bdale/web/altusmetrum/AltOS/doc/* ; \
+        echo "update docs" | \
+        git commit -F - /home/bdale/web/altusmetrum/AltOS/doc/* ; \
+        git push)
 
 clean:
-       rm -f *.html *.pdf *.fo
-
-distclean:
-       rm -f *.html *.pdf *.fo
+       rm -f $(HTML) $(PDF) $(TEMPLATES_XSL)
 
-indent:                telemetrum-doc.xsl
-       xmlindent -i 2 < telemetrum-doc.xsl > telemetrum-doc.new
+distclean: clean
+       rm -f $(HTML) $(PDF)
 
+$(PDF): $(FOSTYLE) $(TEMPLATES_XSL)
+$(HTML): $(TEMPLATES_XSL)