Add initial TeleMini v3 docs
[fw/altos] / doc / Makefile
1 #
2 #       http://docbook.sourceforge.net/release/xsl/current/README
3 #
4
5 RELNOTES_INC=\
6         release-notes-1.6.8.inc \
7         release-notes-1.6.5.inc \
8         release-notes-1.6.4.inc \
9         release-notes-1.6.3.inc \
10         release-notes-1.6.2.inc \
11         release-notes-1.6.1.inc \
12         release-notes-1.6.inc \
13         release-notes-1.5.inc \
14         release-notes-1.4.2.inc \
15         release-notes-1.4.1.inc \
16         release-notes-1.4.inc \
17         release-notes-1.3.2.inc \
18         release-notes-1.3.1.inc \
19         release-notes-1.3.inc \
20         release-notes-1.2.1.inc \
21         release-notes-1.2.inc \
22         release-notes-1.1.1.inc \
23         release-notes-1.1.inc \
24         release-notes-1.0.1.inc \
25         release-notes-0.9.2.inc \
26         release-notes-0.9.inc \
27         release-notes-0.8.inc \
28         release-notes-0.7.1.inc
29
30 IMAGES=\
31         altosui.png \
32         ascent.png \
33         configure-altimeter.png \
34         configure-altosui.png \
35         configure-groundstation.png \
36         configure-pyro.png \
37         descent.png \
38         device-selection.png \
39         easymega.svg \
40         easymega-v1.0-bottom.jpg \
41         easymega-v1.0-top.jpg \
42         easymini.svg \
43         easymini-top.jpg \
44         fire-igniter.png \
45         graph-configure.png \
46         graph-map.png \
47         graph.png \
48         graph-stats.png \
49         ignitor.png \
50         landed.png \
51         launch-pad.png \
52         load-maps.png \
53         micropeak-app.png \
54         micropeak-back.jpg \
55         micropeak-device-dialog.png \
56         micropeak-dime.jpg \
57         micropeak-download.png \
58         micropeak-graph-configure.png \
59         micropeak-graph.png \
60         micropeak-nofont.svg \
61         micropeak-preferences.png \
62         micropeak-raw-data.png \
63         micropeak-save-dialog.png \
64         micropeak-statistics.png \
65         MicroPeakUSB-2.0-inuse.jpg \
66         MicroPeakUSB-2.0.jpg \
67         monitor-idle.png \
68         scan-channels.png \
69         site-map.png \
70         table.png \
71         telegps-configure.png \
72         telegps-graph-configure.png \
73         telegps-graph-graph.png \
74         telegps-graph-map.png \
75         telegps-graph-stats.png \
76         telegps-info.png \
77         telegps-location.png \
78         telegps-map.png \
79         telegps-preferences.png \
80         telegps-scan.png \
81         telegps-status.png \
82         telegps-table.png \
83         telegps-v1.0-top.jpg \
84         telemega.svg \
85         telemega-v1.0-top.jpg \
86         telemetrum.svg \
87         telemetrum-v1.1-thside.jpg \
88         telemetrum-v2.0-th.jpg \
89         telemini-v1.svg \
90         telemini-v1-top.jpg \
91         telemini-v3.svg \
92         telemini-v3.jpg \
93         altusmetrum-oneline.svg \
94         telegps-oneline.svg \
95         micropeak-oneline.svg
96
97 TXT_FILES=altusmetrum.txt
98
99 COMMON_INC_FILES=\
100         config-device.inc \
101         config-ui.inc \
102         load-maps.inc \
103         aprs-operation.inc \
104         handling.inc
105
106 INC_FILES=\
107         dedication.inc \
108         intro.inc \
109         getting-started.inc \
110         usage.inc \
111         telemetrum.inc \
112         telemini.inc \
113         easymini-device.inc \
114         telemega.inc \
115         easymega.inc \
116         installation.inc \
117         using-am-products.inc \
118         updating-firmware.inc \
119         altosui.inc \
120         altosdroid.inc \
121         system-operation.inc \
122         pyro-channels.inc \
123         flight-data-recording.inc \
124         specs.inc \
125         $(COMMON_INC_FILES) \
126         release-notes.inc \
127         $(RELNOTES_INC)
128
129 RAW_FILES=$(TXT_FILES:.txt=.raw) $(INC_FILES:.inc=.raw)
130
131 TELEGPS_INC_FILES=\
132         telegps-dedication.inc \
133         telegps-quick-start.inc \
134         telegps-using.inc \
135         telegps-system-operation.inc \
136         telegps-application.inc \
137         telegps-specs.inc \
138         telegps-updating-firmware.inc \
139         telegps-release-notes.inc \
140         $(COMMON_INC_FILES)
141
142 TELEGPS_TXT_FILES=\
143         telegps.txt
144
145 TELEGPS_RAW_FILES=$(TELEGPS_TXT_FILES:.txt=.raw) $(TELEGPS_INC_FILES:.inc=.raw)
146
147 MICROPEAK_TXT_FILES=\
148         micropeak.txt
149
150 MICROPEAK_INC_FILES=
151
152 MICROPEAK_RAW_FILES=$(MICROPEAK_TXT_FILES:.txt=.raw) $(MICROPEAK_INC_FILES:.inc=.raw)
153
154 EASYMINI_TXT_FILES=\
155         easymini.txt
156
157 EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc
158
159
160 EASYMINI_RAW_FILES=$(EASYMINI_TXT_FILES:.txt=.raw) $(EASYMINI_INC_FILES:.inc=.raw)
161
162 OUTLINE_TXT_FILES=\
163         easymega-outline.txt \
164         easymini-outline.txt \
165         telemega-outline.txt \
166         telemetrum-outline.txt \
167         telemini-v1-outline.txt \
168         telemini-v3-outline.txt
169
170 OUTLINE_RAW_FILES=$(OUTLINE_TXT_FILES:.txt=.raw)
171
172 OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf)
173
174 SVG=\
175         easymini.svg \
176         telemega.svg \
177         telemetrum.svg \
178         telemini-v1.svg \
179         telemini-v3.svg \
180         easymega.svg
181
182 RELNOTES_PDF=$(RELNOTES_INC:.inc=.pdf)
183 RELNOTES_HTML=$(RELNOTES_INC:.inc=.html)
184
185 ONEFILE_TXT_FILES=\
186         altos.txt \
187         companion.txt \
188         telemetry.txt
189
190 ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw)
191 ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf)
192
193 AM_HTML=am.html
194
195 HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(RELNOTES_HTML) $(ONEFILE_HTML_FILES)
196
197 HTML_REVHISTORY=\
198         altusmetrum-revhistory.html \
199         micropeak-revhistory.html \
200         telegps-revhistory.html \
201         easymini-revhistory.html
202
203 PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(RELNOTES_PDF) $(ONEFILE_PDF_FILES) \
204         $(OUTLINE_PDF_FILES)
205
206 FOP_STYLE=am-fo.xsl
207 HTML_STYLE=am-html.xsl
208 COMMON_STYLE=common.xsl
209 FOP_XCONF=fop.xconf
210 STYLESHEET=am.css
211
212 FONTS=\
213         fonts/DejaVuSansMono-BoldOblique.ttf \
214         fonts/DejaVuSansMono-Bold.ttf \
215         fonts/DejaVuSansMono-Oblique.ttf \
216         fonts/DejaVuSansMono.ttf \
217         fonts/OpenSans-Light.ttf \
218         fonts/OpenSans-LightItalic.ttf \
219         fonts/OpenSans-Regular.ttf \
220         fonts/OpenSans-Italic.ttf \
221         fonts/OpenSans-Semibold.ttf \
222         fonts/OpenSans-SemiboldItalic.ttf
223
224 TEMPLATES_TMPL=titlepage.templates.tmpl
225
226 TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl)
227
228 PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL)
229 HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL)
230
231 DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET)
232
233 .SUFFIXES: .tmpl .xsl .inc .txt .raw .pdf .html
234
235 .txt.raw:
236         sed -e 's/^[    ]*//' -e 's/^\\//' $*.txt > $@
237
238 .inc.raw:
239         sed -e 's/^[    ]*//' -e 's/^\\//' $*.inc > $@
240
241 .raw.pdf:
242         a2x --verbose -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw
243         a2x --verbose -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw
244         case $* in release-notes*) ./fix-html $*.html ;; esac
245
246 .pdf.html:
247         @touch $@
248
249 .tmpl.xsl:
250         xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl
251
252 all:    $(HTML) $(PDF)
253
254 altusmetrum-revhistory.html: altusmetrum.html
255
256 micropeak-revhistory.html: micropeak.html
257
258 telegps-revhistory.html: telegps.html
259
260 altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(IMAGES)
261
262 telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES)
263
264 micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_RAW_FILES) $(IMAGES)
265
266 easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_RAW_FILES) $(IMAGES)
267
268 telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg
269
270 telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg
271
272 install:        all
273
274 publish:        $(DOC) $(FONTS)
275         cp $(DOC) /home/bdale/web/altusmetrum/AltOS/doc/
276         mkdir -p /home/bdale/web/altusmetrum/AltOS/doc/fonts/
277         cp $(FONTS) /home/bdale/web/altusmetrum/AltOS/doc/fonts/
278         (cd /home/bdale/web/altusmetrum ; \
279          git add /home/bdale/web/altusmetrum/AltOS/doc/* ; \
280          git add /home/bdale/web/altusmetrum/AltOS/doc/fonts/* ; \
281          echo "update docs" | \
282          git commit -F - /home/bdale/web/altusmetrum/AltOS/doc/* /home/bdale/web/altusmetrum/AltOS/doc/fonts/* ; \
283          git push)
284
285 publish-keithp: am.html $(DOC) $(FONTS)
286         scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos
287         scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts
288
289 clean:
290         rm -f am.html $(HTML) $(HTML_REVHISTORY) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES)
291
292 distclean: clean
293         rm -f $(HTML) $(PDF)
294
295 $(PDF): $(PDF_CONFIG_FILES)
296 $(HTML): $(HTML_CONFIG_FILES)
297
298 am.html: Makefile make-am-html $(HTML)
299         sh ./make-am-html $(HTML) > $@