From ce297f14ff54d230d01fb6dedaafca571e8b836b Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sat, 31 Oct 2015 21:34:42 -0700 Subject: doc: Finish converting docs to asciidoc format Signed-off-by: Keith Packard --- doc/micropeak-docinfo.xml | 68 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 doc/micropeak-docinfo.xml (limited to 'doc/micropeak-docinfo.xml') diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml new file mode 100644 index 00000000..b401a193 --- /dev/null +++ b/doc/micropeak-docinfo.xml @@ -0,0 +1,68 @@ +A recording altimeter for hobby rocketry + + Keith + Packard + keithp@keithp.com + + + 2014 + Keith Packard + + + + + + + + + This document is released under the terms of the + + Creative Commons ShareAlike 3.0 + + license. + + + + + 1.3.2 + 12 February 2014 + + Add a "Download" button to the main window, which makes it + quicker to access the download function. Update the data + download documentation to reflect the new MicroPeak USB + adapter design. Monitor data during download to let you see + if the USB connection is working at all by showing the + characters received from the MicroPeak USB adapter. + + + + 1.2 + 20 January 2013 + + Add documentation for the MicroPeak USB adapter board. Note + the switch to a Kalman filter for peak altitude + determination. + + + + 1.1 + 12 December 2012 + + Add comments about EEPROM storage format and programming jig. + + + + 1.0 + 18 November 2012 + + Updates for version 1.0 release. + + + + 0.1 + 29 October 2012 + + Initial release with preliminary hardware. + + + -- cgit v1.2.3 From edcb80f25875200a73269045db71c1579b0c2c82 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sun, 1 Nov 2015 04:22:27 -0800 Subject: doc: Split revhistory to separate file for html docs This avoids having the revhistory clutter the top of the document. Signed-off-by: Keith Packard --- doc/Makefile | 20 ++++++++++++++++---- doc/altos-docinfo.xml | 1 + doc/altusmetrum-docinfo.xml | 1 + doc/am-html.xsl | 14 ++++++++++++++ doc/am.css | 36 ++++++++++++++++++++---------------- doc/common.xsl | 26 ++++++++++++++++++++++---- doc/companion-docinfo.xml | 1 + doc/micropeak-docinfo.xml | 1 + doc/telegps-docinfo.xml | 1 + doc/telemetry-docinfo.xml | 1 + 10 files changed, 78 insertions(+), 24 deletions(-) create mode 100644 doc/am-html.xsl (limited to 'doc/micropeak-docinfo.xml') diff --git a/doc/Makefile b/doc/Makefile index 0b66a1d1..d3c88b37 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -167,10 +167,16 @@ ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) HTML=altusmetrum.html micropeak.html telegps.html $(RELNOTES_HTML) $(ONEFILE_HTML_FILES) +HTML_REVHISTORY=\ + altusmetrum-revhistory.html \ + micropeak-revhistory.html \ + telegps-revhistory.html + PDF=altusmetrum.pdf micropeak.pdf telegps.pdf $(RELNOTES_PDF) $(ONEFILE_PDF_FILES) \ $(OUTLINE_PDF_FILES) FOP_STYLE=am-fo.xsl +HTML_STYLE=am-html.xsl FOP_XCONF=fop.xconf STYLESHEET=am.css @@ -189,9 +195,9 @@ TEMPLATES_TMPL=titlepage.templates.tmpl TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) PDF_CONFIG_FILES=$(FOP_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) -HTML_CONFIG_FILES=$(TEMPLATES_XSL) $(STYLESHEET) +HTML_CONFIG_FILES=$(TEMPLATES_XSL) -DOC=$(HTML) $(PDF) $(IMAGES) $(STYLESHEET) +DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) .SUFFIXES: .tmpl .xsl .inc .txt .raw .pdf .html @@ -205,7 +211,7 @@ DOC=$(HTML) $(PDF) $(IMAGES) $(STYLESHEET) a2x -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw .raw.html: - a2x -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --stylesheet=$(STYLESHEET) $*.raw + a2x -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw .tmpl.xsl: xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl @@ -214,6 +220,12 @@ all: $(HTML) $(PDF) $(HTML): $(PDF) +altusmetrum-revhistory.html: altusmetrum.html + +micropeak-revhistory.html: micropeak.html + +telegps-revhistory.html: telegps.html + altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(RAW_INC) $(IMAGES) telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES) @@ -238,7 +250,7 @@ publish-keithp: $(DOC) $(FONTS) scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts clean: - rm -f $(HTML) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES) + rm -f $(HTML) $(HTML_REVHISTORY) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES) distclean: clean rm -f $(HTML) $(PDF) diff --git a/doc/altos-docinfo.xml b/doc/altos-docinfo.xml index 1b6ad648..b9193a8f 100644 --- a/doc/altos-docinfo.xml +++ b/doc/altos-docinfo.xml @@ -19,6 +19,7 @@ + 1.1 05 November 2012 diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 19c1e5d9..11df900c 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -36,6 +36,7 @@ + 1.6.1 15 July 2015 diff --git a/doc/am-html.xsl b/doc/am-html.xsl new file mode 100644 index 00000000..cdfe27f8 --- /dev/null +++ b/doc/am-html.xsl @@ -0,0 +1,14 @@ + + + + + diff --git a/doc/am.css b/doc/am.css index c2faa015..7723b14a 100644 --- a/doc/am.css +++ b/doc/am.css @@ -348,24 +348,16 @@ div.variablelist p.title margin-bottom: -0.8em; } -table { - border: none; -} - div.revhistory { border-style: none; } -div.revhistory table, th, td, tr { - margin-top: 1em; - border-width: 1px; +div.revhistory table, div.revhistory th, div.revhistory td { border-collapse: collapse; - border-top: 1px; - border-bottom: 1px; - border-left: 1px; - border-right: 1px; - border: 1px solid black; + border: 1px solid #0080ff; + padding: 0.25em; } + div.revhistory th { color: #0080ff; } @@ -385,12 +377,18 @@ div.indexdiv dl, div.indexdiv dt Table styling does not work because of overriding attributes in generated HTML. */ +div.table-contents p, +div.informaltable p +{ + margin: 0px; +} +/* div.table table, div.informaltable table { margin-left: 0; - margin-right: 5%; - margin-bottom: 0.8em; + margin-right: 0.25em; + margin-bottom: 0.25em; } div.informaltable table { @@ -404,9 +402,15 @@ div.informaltable tfoot, div.informaltable tbody { /* No effect in IE6. */ - border-top: 3px solid #527bbd; - border-bottom: 3px solid #527bbd; + border-top: 1px solid #0080ff; + border-bottom: 1px solid #0080ff; + border-left: 1px solid #0080ff; + border-right: 1px solid #0080ff !important; + border-width: 1px !important; } +*/ + + div.table thead, div.table tfoot, div.informaltable thead, div.informaltable tfoot { diff --git a/doc/common.xsl b/doc/common.xsl index 2e5cbc23..1bb323c0 100644 --- a/doc/common.xsl +++ b/doc/common.xsl @@ -56,17 +56,35 @@ - - + - + - + + + 12pt + bold + center + + + + 0.5pt solid #0080ff + 50% + + + + 0.5pt solid #0080ff + 12pt + 2pt + + + + diff --git a/doc/companion-docinfo.xml b/doc/companion-docinfo.xml index 2e0bc567..243bded0 100644 --- a/doc/companion-docinfo.xml +++ b/doc/companion-docinfo.xml @@ -19,6 +19,7 @@ + 0.1 13 January 2012 diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml index b401a193..4b33e0be 100644 --- a/doc/micropeak-docinfo.xml +++ b/doc/micropeak-docinfo.xml @@ -23,6 +23,7 @@ + 1.3.2 12 February 2014 diff --git a/doc/telegps-docinfo.xml b/doc/telegps-docinfo.xml index fcceae3f..633e56cc 100644 --- a/doc/telegps-docinfo.xml +++ b/doc/telegps-docinfo.xml @@ -28,6 +28,7 @@ + 1.6.1 15 July 2015 diff --git a/doc/telemetry-docinfo.xml b/doc/telemetry-docinfo.xml index c7b1f060..19f90ca4 100644 --- a/doc/telemetry-docinfo.xml +++ b/doc/telemetry-docinfo.xml @@ -19,6 +19,7 @@ + 0.1 1 July 2011 -- cgit v1.2.3 From ef2ba847ca53a8ddfcddd4e51a0dd43c45161c85 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Sun, 1 Nov 2015 21:05:20 -0800 Subject: doc: Add product logos to books This places the product logo on the title verso in pdf form, and above the TOC in html form. Signed-off-by: Keith Packard --- doc/Makefile | 12 +- doc/altusmetrum-docinfo.xml | 9 ++ doc/altusmetrum-oneline.svg | 354 +++++++++++++++++++++++++++++++++++++++++ doc/am-fo.xsl | 14 +- doc/am.css | 40 +++-- doc/common.xsl | 8 +- doc/micropeak-docinfo.xml | 7 + doc/micropeak-oneline-font.svg | 199 +++++++++++++++++++++++ doc/micropeak-oneline.svg | 239 ++++++++++++++++++++++++++++ doc/telegps-docinfo.xml | 8 + doc/telegps-oneline-font.svg | 304 +++++++++++++++++++++++++++++++++++ doc/telegps-oneline.svg | 332 ++++++++++++++++++++++++++++++++++++++ doc/titlepage.templates.tmpl | 62 ++++---- 13 files changed, 1529 insertions(+), 59 deletions(-) create mode 100644 doc/altusmetrum-oneline.svg create mode 100644 doc/micropeak-oneline-font.svg create mode 100644 doc/micropeak-oneline.svg create mode 100644 doc/telegps-oneline-font.svg create mode 100644 doc/telegps-oneline.svg (limited to 'doc/micropeak-docinfo.xml') diff --git a/doc/Makefile b/doc/Makefile index 2aecc230..89a302ff 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -83,7 +83,10 @@ IMAGES=\ telemetrum-v2.0-th.jpg \ telemini.svg \ telemini-v1-top.jpg \ - telemini-v2-top.jpg + telemini-v2-top.jpg \ + altusmetrum-oneline.svg \ + telegps-oneline.svg \ + micropeak-oneline.svg TXT_FILES=altusmetrum.txt @@ -177,6 +180,7 @@ PDF=altusmetrum.pdf micropeak.pdf telegps.pdf $(RELNOTES_PDF) $(ONEFILE_PDF_FILE FOP_STYLE=am-fo.xsl HTML_STYLE=am-html.xsl +COMMON_STYLE=common.xsl FOP_XCONF=fop.xconf STYLESHEET=am.css @@ -187,6 +191,8 @@ FONTS=\ fonts/DejaVuSansMono.ttf \ fonts/OpenSans-Light.ttf \ fonts/OpenSans-LightItalic.ttf \ + fonts/OpenSans-Regular.ttf \ + fonts/OpenSans-Italic.ttf \ fonts/OpenSans-Semibold.ttf \ fonts/OpenSans-SemiboldItalic.ttf @@ -194,8 +200,8 @@ TEMPLATES_TMPL=titlepage.templates.tmpl TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) -PDF_CONFIG_FILES=$(FOP_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) -HTML_CONFIG_FILES=$(TEMPLATES_XSL) +PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) +HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL) DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 11df900c..69a769b6 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -26,6 +26,15 @@ + + + + + + + + + This document is released under the terms of the diff --git a/doc/altusmetrum-oneline.svg b/doc/altusmetrum-oneline.svg new file mode 100644 index 00000000..0ed7b6cd --- /dev/null +++ b/doc/altusmetrum-oneline.svg @@ -0,0 +1,354 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/am-fo.xsl b/doc/am-fo.xsl index 5743a24c..605339d4 100644 --- a/doc/am-fo.xsl +++ b/doc/am-fo.xsl @@ -106,10 +106,10 @@ 0.5pt -#0080ff +#78079a 0.5pt 0.5pt -#0080ff +#78079a @@ -160,12 +160,12 @@ - 0.5pt solid #0080ff + 0.5pt solid #78079a 50% - 0.5pt solid #0080ff + 0.5pt solid #78079a 11pt 2pt @@ -176,12 +176,12 @@ normal - #0080ff + #78079a normal - #0080ff + #78079a @@ -191,7 +191,7 @@ normal - #0080ff + #78079a diff --git a/doc/am.css b/doc/am.css index 7723b14a..1dee27ea 100644 --- a/doc/am.css +++ b/doc/am.css @@ -87,16 +87,16 @@ body div { } a:link { - color: #0080ff; + color: #78079a; } a:visited { - color: #0080ff; + color: #78079a; } h1, h2, h3, h4, h5, h6 { - color: #0080ff; + color: #78079a; font-family: "Open Sans",sans-serif; } @@ -119,16 +119,26 @@ div.warning p, div.note p, div.error p { margin-left: 5%; } -div.toc { +h3.corpauthor img { position: fixed; left: 0px; top: 0px; - height: 100%; - width: 25em; + width: 410px; + height: 90px; + border-right: 2px solid #78079a; + border-bottom: 2px solid #78079a; +} + +div.toc { + position: fixed; + left: 0px; + top: 92px; + bottom: 0; + width: 410px; margin-right: 5ex; margin-left: 0px; float: left; - border-right: 2px solid #0080ff; + border-right: 2px solid #78079a; border-collapse: collapse; overflow: auto; } @@ -186,7 +196,7 @@ div.example p.title, div.sidebar p.title { font-weight: normal; - color: #0080ff; + color: #78079a; font-family: "Open Sans",sans-serif; margin-bottom: 0.2em; } @@ -235,7 +245,7 @@ div.navheader th, div.navheader td, div.navfooter td { font-family: "Open Sans",sans-serif; font-size: 12pt; font-weight: normal; - color: #0080ff; + color: #78079a; } div.navheader img, div.navfooter img { border-style: none; @@ -354,12 +364,12 @@ div.revhistory { div.revhistory table, div.revhistory th, div.revhistory td { border-collapse: collapse; - border: 1px solid #0080ff; + border: 1px solid #78079a; padding: 0.25em; } div.revhistory th { - color: #0080ff; + color: #78079a; } /* Keep TOC and index lines close together. */ @@ -402,10 +412,10 @@ div.informaltable tfoot, div.informaltable tbody { /* No effect in IE6. */ - border-top: 1px solid #0080ff; - border-bottom: 1px solid #0080ff; - border-left: 1px solid #0080ff; - border-right: 1px solid #0080ff !important; + border-top: 1px solid #78079a; + border-bottom: 1px solid #78079a; + border-left: 1px solid #78079a; + border-right: 1px solid #78079a !important; border-width: 1px !important; } */ diff --git a/doc/common.xsl b/doc/common.xsl index 1bb323c0..94b120af 100644 --- a/doc/common.xsl +++ b/doc/common.xsl @@ -56,12 +56,12 @@ - + - + @@ -73,12 +73,12 @@ - 0.5pt solid #0080ff + 0.5pt solid #78079a 50% - 0.5pt solid #0080ff + 0.5pt solid #78079a 12pt 2pt diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml index 4b33e0be..37c6e770 100644 --- a/doc/micropeak-docinfo.xml +++ b/doc/micropeak-docinfo.xml @@ -13,6 +13,13 @@ + + + + + + + This document is released under the terms of the diff --git a/doc/micropeak-oneline-font.svg b/doc/micropeak-oneline-font.svg new file mode 100644 index 00000000..f6b23aa3 --- /dev/null +++ b/doc/micropeak-oneline-font.svg @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + μ + + + MicroPeak + + diff --git a/doc/micropeak-oneline.svg b/doc/micropeak-oneline.svg new file mode 100644 index 00000000..4b695827 --- /dev/null +++ b/doc/micropeak-oneline.svg @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/telegps-docinfo.xml b/doc/telegps-docinfo.xml index 633e56cc..4ba3f73c 100644 --- a/doc/telegps-docinfo.xml +++ b/doc/telegps-docinfo.xml @@ -18,6 +18,14 @@ + + + + + + + + This document is released under the terms of the diff --git a/doc/telegps-oneline-font.svg b/doc/telegps-oneline-font.svg new file mode 100644 index 00000000..a2cf540b --- /dev/null +++ b/doc/telegps-oneline-font.svg @@ -0,0 +1,304 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + TeleGPS + + diff --git a/doc/telegps-oneline.svg b/doc/telegps-oneline.svg new file mode 100644 index 00000000..21497899 --- /dev/null +++ b/doc/telegps-oneline.svg @@ -0,0 +1,332 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/doc/titlepage.templates.tmpl b/doc/titlepage.templates.tmpl index 9de1b31f..1669e465 100644 --- a/doc/titlepage.templates.tmpl +++ b/doc/titlepage.templates.tmpl @@ -132,35 +132,37 @@ - - - - <subtitle - text-align="center" - font-size="&hsize4;" - space-before="&hsize4space;" - font-family="{$title.fontset}"/> - <corpauthor font-size="&hsize3;" - keep-with-next.within-column="always" - space-before="2in"/> - <authorgroup space-before="2in"/> - <author font-size="&hsize3;" - space-before="&hsize2space;" - keep-with-next.within-column="always"/> - <!-- If you add editor, include this t:predicate attribute - because only the first editor generates the list of editors. - <editor t:predicate="[position() = 1]"/> - --> - <mediaobject space-before="1.5in"/> - <itermset/> - </t:titlepage-content> +<t:titlepage t:element="book" t:wrapper="fo:block"> + <t:titlepage-content t:side="recto"> + <title + t:named-template="division.title" + param:node="ancestor-or-self::book[1]" + text-align="center" + font-size="&hsize5;" + space-before="&hsize5space;" + font-weight="bold" + font-family="{$title.fontset}"/> + <subtitle + text-align="center" + font-size="&hsize4;" + space-before="&hsize4space;" + font-family="{$title.fontset}"/> +<!-- + <corpauthor font-size="&hsize3;" + keep-with-next.within-column="always" + space-before="2in"/> + --> + <authorgroup space-before="2in"/> + <author font-size="&hsize3;" + space-before="&hsize2space;" + keep-with-next.within-column="always"/> + <!-- If you add editor, include this t:predicate attribute + because only the first editor generates the list of editors. + <editor t:predicate="[position() = 1]"/> + --> + <mediaobject space-before="1.5in"/> + <itermset/> + </t:titlepage-content> <t:titlepage-content t:side="verso"> <title @@ -168,7 +170,6 @@ font-size="&hsize2;" font-weight="bold" font-family="{$title.fontset}"/> - <corpauthor/> <authorgroup t:named-template="verso.authorgroup"/> <author/> <!-- If you add editor, include this t:predicate attribute @@ -181,6 +182,7 @@ <copyright/> <abstract/> <legalnotice font-size="8pt"/> + <corpauthor text-align="center"/> <revhistory space-before="0.5in"/> </t:titlepage-content> -- cgit v1.2.3