From fe3ff829d4c2fde8d4e80f721204b18e7831bb97 Mon Sep 17 00:00:00 2001 From: Bdale Garbee Date: Wed, 10 Oct 2018 20:41:40 -0600 Subject: doc: add bootloader force instructions for TeleBT v4.0 --- doc/updating-firmware.inc | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc') diff --git a/doc/updating-firmware.inc b/doc/updating-firmware.inc index 91aa58f2..d2883829 100644 --- a/doc/updating-firmware.inc +++ b/doc/updating-firmware.inc @@ -131,6 +131,12 @@ to the USB wires on the row of pins towards the center of the board. Ground is available on the capacitor next to it, on the end towards the USB wires. + + TeleBT v4:: + + Connect pin 30 on the CPU to ground. Pin 30 is the 6th + pin from the right on the top when the unit is oriented + such that the SMA is at the top. endif::telemetrum[] Once you've located the right pins: -- cgit v1.2.3 From 6d80b89c0bd82133dd5c93df8604f562ac49c19a Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Thu, 25 Oct 2018 16:50:17 -0700 Subject: doc: Switch to asciidoctor to format docs asciidoc and a2x are no longer actively maintained and Debian policy encourages people to move away from them to asciidoctor. Signed-off-by: Keith Packard --- doc/.gitignore | 1 + doc/Makefile.am | 93 +++++------ doc/altos.txt | 8 + doc/altosui.inc | 50 +++--- doc/altusmetrum-theme.yml | 61 +++++++ doc/altusmetrum.txt | 54 ++++--- doc/am-notoc.css | 334 +++++++++++++++++++++++++++++++++++++++ doc/am.css | 237 +++++++++------------------ doc/companion.txt | 9 ++ doc/config-device.inc | 4 +- doc/easymega-outline.txt | 3 +- doc/easymega.inc | 2 +- doc/easymini-device.inc | 2 +- doc/easymini-outline.txt | 3 +- doc/easymini-release-notes.inc | 26 +-- doc/easymini.txt | 41 +++-- doc/header.inc | 13 ++ doc/load-maps.inc | 2 +- doc/map-loading.txt | 8 + doc/micropeak-oneline.svg | 190 ++++++++++++---------- doc/micropeak.txt | 38 +++-- doc/release-head.inc | 7 + doc/release-notes-0.7.1.inc | 2 +- doc/release-notes-0.8.inc | 2 +- doc/release-notes-0.9.2.inc | 2 +- doc/release-notes-0.9.inc | 2 +- doc/release-notes-1.0.1.inc | 2 +- doc/release-notes-1.1.1.inc | 2 +- doc/release-notes-1.1.inc | 2 +- doc/release-notes-1.2.1.inc | 2 +- doc/release-notes-1.2.inc | 2 +- doc/release-notes-1.3.1.inc | 2 +- doc/release-notes-1.3.2.inc | 2 +- doc/release-notes-1.3.inc | 2 +- doc/release-notes-1.4.1.inc | 2 +- doc/release-notes-1.4.2.inc | 2 +- doc/release-notes-1.4.inc | 2 +- doc/release-notes-1.5.inc | 2 +- doc/release-notes-1.6.1.inc | 2 +- doc/release-notes-1.6.2.inc | 2 +- doc/release-notes-1.6.3.inc | 2 +- doc/release-notes-1.6.4.inc | 2 +- doc/release-notes-1.6.5.inc | 2 +- doc/release-notes-1.6.8.inc | 2 +- doc/release-notes-1.6.inc | 2 +- doc/release-notes-1.7.inc | 2 +- doc/release-notes-1.8.1.inc | 2 +- doc/release-notes-1.8.2.inc | 2 +- doc/release-notes-1.8.3.inc | 3 +- doc/release-notes-1.8.4.inc | 2 +- doc/release-notes-1.8.5.inc | 2 +- doc/release-notes-1.8.6.inc | 2 +- doc/release-notes-1.8.7.inc | 2 +- doc/release-notes-1.8.inc | 2 +- doc/release-notes.inc | 64 ++++---- doc/specs.inc | 16 +- doc/system-operation.inc | 2 +- doc/telegps-application.inc | 30 ++-- doc/telegps-outline.txt | 3 +- doc/telegps-release-notes.inc | 38 ++--- doc/telegps-system-operation.inc | 2 +- doc/telegps.txt | 32 ++-- doc/telemega-outline.txt | 3 +- doc/telemega.inc | 2 +- doc/telemetrum-outline.txt | 3 +- doc/telemetrum.inc | 8 +- doc/telemetry.txt | 11 ++ doc/telemini-v1-outline.txt | 4 +- doc/telemini-v3-outline.txt | 3 +- doc/telemini.inc | 6 +- doc/updating-firmware.inc | 4 + doc/using-am-products.inc | 2 + 72 files changed, 960 insertions(+), 524 deletions(-) create mode 100644 doc/altusmetrum-theme.yml create mode 100644 doc/am-notoc.css create mode 100644 doc/header.inc create mode 100644 doc/release-head.inc (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore index 06ad43eb..27a951c4 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -2,6 +2,7 @@ *.pdf *.fo *.raw +*.adoc titlepage.templates.xsl fop-cfg.xml map-loading.svg diff --git a/doc/Makefile.am b/doc/Makefile.am index 450053f1..b5839bea 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,15 @@ # -# http://docbook.sourceforge.net/release/xsl/current/README +# Copyright © 2018 Keith Packard +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. # if FAKETIME @@ -115,9 +125,11 @@ COMMON_INC_FILES=\ config-ui.inc \ load-maps.inc \ aprs-operation.inc \ - handling.inc + handling.inc \ + release-head.inc INC_FILES=\ + header.inc \ dedication.inc \ intro.inc \ getting-started.inc \ @@ -140,7 +152,7 @@ INC_FILES=\ release-notes.inc \ $(RELNOTES_INC) -RAW_FILES=$(TXT_FILES:.txt=.raw) $(INC_FILES:.inc=.raw) +ADOC_FILES=$(TXT_FILES:.txt=.adoc) $(INC_FILES:.inc=.adoc) TELEGPS_INC_FILES=\ telegps-dedication.inc \ @@ -156,14 +168,14 @@ TELEGPS_INC_FILES=\ TELEGPS_TXT_FILES=\ telegps.txt -TELEGPS_RAW_FILES=$(TELEGPS_TXT_FILES:.txt=.raw) $(TELEGPS_INC_FILES:.inc=.raw) +TELEGPS_ADOC_FILES=$(TELEGPS_TXT_FILES:.txt=.adoc) $(TELEGPS_INC_FILES:.inc=.adoc) MICROPEAK_TXT_FILES=\ micropeak.txt MICROPEAK_INC_FILES= -MICROPEAK_RAW_FILES=$(MICROPEAK_TXT_FILES:.txt=.raw) $(MICROPEAK_INC_FILES:.inc=.raw) +MICROPEAK_ADOC_FILES=$(MICROPEAK_TXT_FILES:.txt=.adoc) $(MICROPEAK_INC_FILES:.inc=.adoc) EASYMINI_TXT_FILES=\ easymini.txt @@ -171,7 +183,7 @@ EASYMINI_TXT_FILES=\ EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc -EASYMINI_RAW_FILES=$(EASYMINI_TXT_FILES:.txt=.raw) $(EASYMINI_INC_FILES:.inc=.raw) +EASYMINI_ADOC_FILES=$(EASYMINI_TXT_FILES:.txt=.adoc) $(EASYMINI_INC_FILES:.inc=.adoc) OUTLINE_TXT_FILES=\ easymega-outline.txt \ @@ -182,7 +194,7 @@ OUTLINE_TXT_FILES=\ telemini-v3-outline.txt \ telegps-outline.txt -OUTLINE_RAW_FILES=$(OUTLINE_TXT_FILES:.txt=.raw) +OUTLINE_ADOC_FILES=$(OUTLINE_TXT_FILES:.txt=.adoc) OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf) @@ -202,7 +214,7 @@ ONEFILE_TXT_FILES=\ telemetry.txt \ map-loading.txt -ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw) +ONEFILE_ADOC_FILES=$(ONEFILE_TXT_FILES:.txt=.adoc) ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html) @@ -212,22 +224,12 @@ PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(ONEFIL HTML=$(PUBLISH_HTML) $(RELNOTES_HTML) -HTML_REVHISTORY=\ - altusmetrum-revhistory.html \ - micropeak-revhistory.html \ - telegps-revhistory.html \ - easymini-revhistory.html - PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(ONEFILE_PDF_FILES) \ $(OUTLINE_PDF_FILES) MAP_DOT_FILES=map-loading.dot MAP_SVG_FILES=$(MAP_DOT_FILES:.dot=.svg) -FOP_STYLE=am-fo.xsl -HTML_STYLE=am-html.xsl -COMMON_STYLE=common.xsl -FOP_XCONF=fop.xconf -STYLESHEET=am.css +STYLESHEET=am.css am-notoc.css FONTS=\ fonts/DejaVuSansMono-BoldOblique.ttf \ @@ -241,56 +243,41 @@ FONTS=\ fonts/OpenSans-Semibold.ttf \ fonts/OpenSans-SemiboldItalic.ttf -TEMPLATES_TMPL=titlepage.templates.tmpl - -TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) - -PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) -HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL) +PDF_CONFIG_FILES=altusmetrum-theme.yml +HTML_CONFIG_FILES= -PUBLISH_DOC=$(PUBLISH_HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) +PUBLISH_DOC=$(PUBLISH_HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET) -DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) +DOC=$(HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET) -SUFFIXES = .dot .svg .tmpl .xsl .inc .txt .raw .pdf .html +SUFFIXES = .dot .svg .inc .txt .adoc .pdf .html .dot.svg: dot -Tsvg -o$@ $*.dot -.txt.raw: +.txt.adoc: sed -e 's/^[ ]*//' -e 's/^\\//' $*.txt > $@ -.inc.raw: +.inc.adoc: sed -e 's/^[ ]*//' -e 's/^\\//' $*.inc > $@ -.raw.html: - a2x -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw - case $* in release-notes*) ./fix-html $*.html ;; esac - $(FAKETIME) a2x -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw +.adoc.html: + asciidoctor -b html5 $*.adoc -.html.pdf: - echo $@ - -.tmpl.xsl: - xsltproc --output $@ /usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl $*.tmpl +.adoc.pdf: + asciidoctor-pdf $*.adoc all: $(HTML) $(PDF) -map-loading.raw: $(MAP_SVG_FILES) - -altusmetrum-revhistory.html: altusmetrum.html - -micropeak-revhistory.html: micropeak.html - -telegps-revhistory.html: telegps.html +map-loading.adoc: $(MAP_SVG_FILES) -altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(RAW_FILES) $(IMAGES) +altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(ADOC_FILES) $(IMAGES) -telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_RAW_FILES) $(IMAGES) +telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_ADOC_FILES) $(IMAGES) -micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_RAW_FILES) $(IMAGES) +micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_ADOC_FILES) $(IMAGES) -easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_RAW_FILES) $(IMAGES) +easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_ADOC_FILES) $(IMAGES) telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg @@ -311,12 +298,12 @@ publish: $(PUBLISH_DOC) $(FONTS) git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ git push) -publish-keithp: am.html $(PUBLISH_DOC) $(FONTS) - scp -p am.html $(PUBLISH_DOC) keithp.com:~keithp/public_html/altos +publish-keithp: am.html $(DOC) $(FONTS) + scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts clean: - rm -f am.html $(HTML) $(HTML_REVHISTORY) $(PDF) $(TEMPLATES_XSL) $(RAW_FILES) $(TELEGPS_RAW_FILES) $(MICROPEAK_RAW_FILES) + rm -f am.html $(HTML) $(PDF) $(ADOC_FILES) $(TELEGPS_ADOC_FILES) $(MICROPEAK_ADOC_FILES) distclean: clean rm -f $(HTML) $(PDF) diff --git a/doc/altos.txt b/doc/altos.txt index f2b1ee59..9d12f12b 100644 --- a/doc/altos.txt +++ b/doc/altos.txt @@ -1,7 +1,15 @@ = AltOS +Keith Packard :doctype: book :toc: +:stylesheet: am.css +:linkcss: :numbered: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts + + include::header.adoc[] == Overview diff --git a/doc/altosui.inc b/doc/altosui.inc index adce6f27..44f77aca 100644 --- a/doc/altosui.inc +++ b/doc/altosui.inc @@ -1,7 +1,7 @@ == AltosUI .AltosUI Main Window - image::altosui.png[width="4.6in"] + image::altosui.png[width=450] The AltosUI program provides a graphical user interface for interacting with the Altus Metrum product family. AltosUI can @@ -12,10 +12,8 @@ the tasks provided from the top-level toolbar. ifdef::radio[] + === Monitor Flight - //// - Receive, Record and Display Telemetry Data - //// Selecting this item brings up a dialog box listing all of the connected TeleDongle devices. When you choose @@ -24,7 +22,7 @@ device. .Device Selection Dialog - image::device-selection.png[width="3.1in"] + image::device-selection.png[width=300] All telemetry data received are automatically recorded in suitable log files. The name of the files includes @@ -84,7 +82,7 @@ ==== Launch Pad .Monitor Flight Launch Pad View - image::launch-pad.png[width="5.5in"] + image::launch-pad.png[width=400] The 'Launch Pad' tab shows information used to decide when the rocket is ready for flight. The first elements include red/green @@ -146,7 +144,7 @@ ==== Ascent .Monitor Flight Ascent View - image::ascent.png[width="5.5in"] + image::ascent.png[width=400] This tab is shown during Boost, Fast and Coast phases. The information displayed here helps monitor the @@ -170,7 +168,7 @@ ==== Descent .Monitor Flight Descent View - image::descent.png[width="5.5in"] + image::descent.png[width=400] Once the rocket has reached apogee and (we hope) activated the apogee charge, attention switches to @@ -209,7 +207,7 @@ ==== Landed .Monitor Flight Landed View - image::landed.png[width="5.5in"] + image::landed.png[width=400] Once the rocket is on the ground, attention switches to recovery. While the radio signal is often lost once @@ -246,7 +244,7 @@ ==== Table .Monitor Flight Table View - image::table.png[width="5.5in"] + image::table.png[width=400] The table view shows all of the data available from the flight computer. Probably the most useful data on @@ -257,7 +255,7 @@ ==== Site Map .Monitor Flight Site Map View - image::site-map.png[width="5.5in"] + image::site-map.png[width=400] When the TeleMetrum has a GPS fix, the Site Map tab will map the rocket's position to make it easier for @@ -291,7 +289,7 @@ ==== Igniter .Monitor Flight Additional Igniter View - image::ignitor.png[width="5.5in"] + image::ignitor.png[width=400] TeleMega includes four additional programmable pyro channels. The Ignitor tab shows whether each of them has @@ -299,6 +297,7 @@ voltage measured here will be close to the pyro battery voltage. A value greater than 3.2V is required for a 'GO' status. + endif::radio[] @@ -375,7 +374,7 @@ ==== Flight Graph .Flight Data Graph - image::graph.png[width="5.5in"] + image::graph.png[width=400] By default, the graph contains acceleration (blue), velocity (green) and altitude (red). @@ -392,7 +391,7 @@ ==== Configure Graph .Flight Graph Configuration - image::graph-configure.png[width="5.5in"] + image::graph-configure.png[width=400] This selects which graph elements to show, and, at the very bottom. It also lets you configure how @@ -420,7 +419,7 @@ ==== Flight Statistics .Flight Statistics - image::graph-stats.png[width="5.5in"] + image::graph-stats.png[width=400] Shows overall data computed from the flight. @@ -428,7 +427,7 @@ ==== Map .Flight Map - image::graph-map.png[width="5.5in"] + image::graph-map.png[width=400] Shows a satellite image of the flight area overlaid with the path of the flight. The red concentric @@ -481,7 +480,7 @@ === Configure Altimeter .Altimeter Configuration - image::configure-altimeter.png[width="3.6in"] + image::configure-altimeter.png[width=350] ifdef::radio[] Select this button and then select either an altimeter or @@ -523,24 +522,25 @@ The rest of the dialog contains the parameters to be configured. - include::config-device.raw[] + include::config-device.adoc[] === Configure AltosUI .Configure AltosUI Dialog - image::configure-altosui.png[width="2.4in"] + image::configure-altosui.png[width=230] This button presents a dialog so that you can configure the AltosUI global settings. - include::config-ui.raw[] + include::config-ui.adoc[] ifdef::radio[] + === Configure Groundstation .Configure Groundstation Dialog - image::configure-groundstation.png[width="3.1in"] + image::configure-groundstation.png[width=300] Select this button and then select a TeleDongle or TeleBT Device from the list provided. @@ -631,7 +631,7 @@ === Fire Igniter .Fire Igniter Window - image::fire-igniter.png[width="1.2in"] + image::fire-igniter.png[width=120] This activates the igniter circuits in the flight computer to help test recovery systems @@ -663,7 +663,7 @@ === Scan Channels .Scan Channels Window - image::scan-channels.png[width="3.2in"] + image::scan-channels.png[width=300] This listens for telemetry packets on all of the configured frequencies, displaying information about @@ -675,14 +675,14 @@ endif::radio[] ifdef::gps[] - include::load-maps.raw[] + include::load-maps.adoc[] endif::gps[] ifdef::radio[] === Monitor Idle .Monitor Idle Window - image::monitor-idle.png[width="5.2in"] + image::monitor-idle.png[width=500] This brings up a dialog similar to the Monitor Flight UI, except it works with the altimeter in “idle” mode diff --git a/doc/altusmetrum-theme.yml b/doc/altusmetrum-theme.yml new file mode 100644 index 00000000..f13fa597 --- /dev/null +++ b/doc/altusmetrum-theme.yml @@ -0,0 +1,61 @@ +base: + font_family: Open Sans Light +heading: + font_color: #78079a + font_size: 17 +font: + catalog: + Open Sans Light: + normal: OpenSans-Light.ttf + italic: OpenSans-LightItalic.ttf + bold: OpenSans-Semibold.ttf + bold_italic: OpenSans-SemiboldItalic.ttf + DejaVu Sans Mono: + normal: DejaVuSansMono.ttf + italic: DejaVuSansMono-Oblique.ttf + bold: DejaVuSansMono-Bold.ttf + bold_italic: DejaVuSansMono-BoldOblique.ttf +title_page: + align: right + logo: + top: 10% + title: + top: 75% + font_size: $heading_h1_font_size + font_color: #000000 + font_style: bold + line_height: 0.9 + subtitle: + font_size: $heading_h3_font_size + font_style: bold_italic + line_height: 1 + authors: + margin_top: $base_font_size * 1.25 + font_size: $base_font_size * 1.5 + font_color: #000000 + revision: + margin_top: $base_font_size * 1.25 +admonition_label: + font_color: #c70909 + font_style: bold + font_size: $heading_h2_font_size +page: + background_color: ffffff + layout: portrait + margin: [0.5in, 0.67in, 0.75in, 0.67in] + size: letter +footer: + height: 0.5in + border_color: #78079a + recto: + left: + content: '{page-number}' + right: + content: '© 2018 Bdale Garbee and Keith Packard. Creative Commons ShareAlike 3.0 License' + verso: + left: + content: $footer_recto_right_content + right: + content: '{page-number}' +literal: + font_family: DejaVu Sans Mono diff --git a/doc/altusmetrum.txt b/doc/altusmetrum.txt index 48211eb8..798301d2 100644 --- a/doc/altusmetrum.txt +++ b/doc/altusmetrum.txt @@ -1,6 +1,15 @@ -= The Altus Metrum System += The Altus Metrum System: An Owner's Manual for Altus Metrum Rocketry Electronics +Keith Packard ; Bdale Garbee ; Bob Finch; Anthony Towns +:title-logo-image: image:../themes/background.png[] +:revnumber: v1.8.7 +:revdate: 8 Oct 2018 +:revremark: Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF calibration to factory value when reflashing. Fix map images. Fix Mac OS X support. +:copyright: Bdale Garbee and Keith Packard 2018 :doctype: book :numbered: +:stylesheet: am.css +:linkcss: +:toc: :altusmetrum: 1 :radio: 1 :gps: 1 @@ -11,41 +20,46 @@ :easymega: 1 :telegps: 1 :application: AltosUI +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts - include::dedication.raw[] + include::header.adoc[] - include::intro.raw[] + include::dedication.adoc[] - include::getting-started.raw[] + include::intro.adoc[] - include::usage.raw[] + include::getting-started.adoc[] - include::telemetrum.raw[] + include::usage.adoc[] - include::telemini.raw[] + include::telemetrum.adoc[] - include::easymini-device.raw[] + include::telemini.adoc[] - include::telemega.raw[] + include::easymini-device.adoc[] - include::easymega.raw[] + include::telemega.adoc[] - include::installation.raw[] + include::easymega.adoc[] - include::using-am-products.raw[] + include::installation.adoc[] - include::altosui.raw[] + include::using-am-products.adoc[] - include::altosdroid.raw[] + include::altosui.adoc[] - include::system-operation.raw[] + include::altosdroid.adoc[] - include::handling.raw[] + include::system-operation.adoc[] - include::updating-firmware.raw[] + include::handling.adoc[] - include::flight-data-recording.raw[] + include::updating-firmware.adoc[] - include::specs.raw[] + include::flight-data-recording.adoc[] - include::release-notes.raw[] + include::specs.adoc[] + + include::release-notes.adoc[] diff --git a/doc/am-notoc.css b/doc/am-notoc.css new file mode 100644 index 00000000..6999d478 --- /dev/null +++ b/doc/am-notoc.css @@ -0,0 +1,334 @@ +/* + CSS stylesheet for XHTML produced by DocBook XSL stylesheets. +*/ + +@font-face { + font-family: 'Open Sans'; + src: url('fonts/OpenSans-Regular.ttf'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'Open Sans'; + src: url('fonts/OpenSans-Italic.ttf'); + font-weight: normal; + font-style: italic; +} + +@font-face { + font-family: 'Open Sans'; + src: url('fonts/OpenSans-Semibold.ttf'); + font-weight: bold; + font-style: normal; +} + +@font-face { + font-family: 'Open Sans'; + src: url('fonts/OpenSans-SemiboldItalic.ttf'); + font-weight: bold; + font-style: italic; +} + +@font-face { + font-family: 'DejaVu Sans Mono'; + src: url('fonts/DejaVuSansMono.ttf'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'DejaVu Sans Mono'; + src: url('fonts/DejaVuSansMono-Oblique.ttf'); + font-weight: normal; + font-style: oblique; +} + +@font-face { + font-family: 'DejaVu Sans Mono'; + src: url('fonts/DejaVuSansMono-Bold.ttf'); + font-weight: bold; + font-style: normal; +} + +@font-face { + font-family: 'DejaVu Sans Mono'; + src: url('fonts/DejaVuSansMono-BoldOblique.ttf'); + font-weight: bold; + font-style: oblique; +} + +body { + font-family: "Open Sans",sans-serif; + font-size: 12pt; + margin: 2em 5em 2em 5em; +} + +code, pre { + font-family: "DejaVu Sans Mono", monospace; +} + +span.strong { + font-weight: bold; +} + +body blockquote { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +a:link { + color: #78079a; +} + +a:visited { + color: #78079a; +} + +h1, h2, h3, h4, h5, h6 +{ + color: #78079a; + font-family: "Open Sans",sans-serif; +} + +div.toc { + display:none; +} + +div.details { + padding-top: 1em; + padding-left: 3em; +} + +span.author { + font-weight: bold; + color: #78079a; +} + +span.email { + font-size: 10pt; +} + +span#revnumber { + font-size: 8pt; +} + +span#revdate { + font-size: 8pt; +} + +span#revremark { + font-size: 8pt; +} + +div#footer { + border-top: 2px solid #808080; +} + +body h1 { + margin: .0em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid #808080; +} + +body h2 { + margin: 0.5em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid #808080; +} + +body h3 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h4 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h5 { + margin: .8em 0 0 -2%; + line-height: 1.3; +} + +body h6 { + margin: .8em 0 0 -1%; + line-height: 1.3; +} + +body hr { + border: none; /* Broken on IE6 */ +} + +body td { + line-height: 1.2 +} + +body th { + line-height: 1.2; +} + +ol { + line-height: 1.2; +} + +ul, body dir, body menu { + line-height: 1.2; +} + +body h1, body h2, body h3, body h4, body h5, body h6 { + margin-left: 0 +} + +body pre { + margin: 0.5em 10% 0.5em 1em; + line-height: 1.0; +} + +tt.literal, code.literal { +} + +.programlisting, .screen { + border: 1px solid #808080; + background: #f4f4f4; + margin: 0.5em 10% 0.5em 0; + padding: 0.5em 1em; +} + +div.sidebar { + background: #ffffee; + margin: 1.0em 10% 0.5em 0; + padding: 0.5em 1em; + border: 1px solid #808080; +} +div.sidebar * { padding: 0; } +div.sidebar div { margin: 0; } +div.sidebar p.title { + margin-top: 0.5em; + margin-bottom: 0.2em; +} + +div.bibliomixed { + margin: 0.5em 5% 0.5em 1em; +} + +div.glossary dt { + font-weight: bold; +} +div.glossary dd p { + margin-top: 0.2em; +} + +dl { + margin: .8em 0; + line-height: 1.2; +} + +dt { + margin-top: 0.5em; +} + +dt span.term { + font-weight: bold; +} + +div.variablelist dd p { + margin-top: 0; +} + +div.itemizedlist li, div.orderedlist li { + margin-left: -0.8em; + margin-top: 0.5em; +} + +ul, ol { + list-style-position: outside; +} + +div.sidebar ul, div.sidebar ol { + margin-left: 2.8em; +} + +div.itemizedlist p.title, +div.orderedlist p.title, +div.variablelist p.title +{ + margin-bottom: -0.8em; +} + +div.revhistory { + border-style: none; +} + +div.revhistory table, div.revhistory th, div.revhistory td { + border-collapse: collapse; + border: 1px solid #808080; + padding: 0.25em; +} + +div.revhistory th { + color: black; +} + +/* Keep TOC and index lines close together. */ +div.toc dl, div.toc dt +{ + line-height: normal; + margin-top: 0; + margin-bottom: 0; +} + +div.admonitionblock { + margin-top: 2em; + margin-bottom: 2em; + margin-left: 2em; + margin-right: 2em; +} + +div.admonitionblock div { + margin-left: 0em; + margin-right: 1em; +} + +div.admonitionblock div.title { + color: #c70909; + font-style: bold; + font-size: 24pt; +} + +div#content table.tableblock { + border-style: solid; + border-width: 1px; + border-collapse: collapse; +} + +div#content table.tableblock td,th { + border-right-style: solid; + border-right-width: 1px; +} + +div#content table.tableblock tbody p { + margin-top: 0.25em; + margin-bottom: 0.25em; + margin-left: 0.25em; + margin-right: 0.25em; +} + +div#content table.tableblock tbody tr:nth-child(odd) { + background: #cccccc; +} + +div.imageblock{ + margin-top: 1em; + margin-bottom: 1em; +} + +div.imageblock img { + margin-bottom: 0.5em; +} + +@media print { + div.navheader, div.navfooter { display: none; } +} diff --git a/doc/am.css b/doc/am.css index 393ef81b..56daface 100644 --- a/doc/am.css +++ b/doc/am.css @@ -61,6 +61,7 @@ body { font-family: "Open Sans",sans-serif; font-size: 12pt; + margin: 0; } code, pre { @@ -77,15 +78,6 @@ body blockquote { margin-bottom: .75em; } -html body { - margin: 1em 5% 1em 5%; - line-height: 1.2; -} - -body div { - margin: 0; -} - a:link { color: #78079a; } @@ -100,33 +92,11 @@ h1, h2, h3, h4, h5, h6 font-family: "Open Sans",sans-serif; } -div.revhistory table { - width: 50%; - border-width: 1px; -} - -div titlepage { - margin-top: 100px; - border-top: 2px; -} - -div.warning h1, div.warning h2, div.warning h3, div.warning h4, div.warning h5, div.warning h6 { - color: #ff2020; -} - -div.warning p, div.note p, div.error p { - margin-left: 5%; - margin-left: 5%; -} - -h3.corpauthor img { - position: fixed; - left: 0px; - top: 0px; - width: 410px; - height: 90px; - border-right: 2px solid #808080; - border-bottom: 2px solid #808080; +div#content, div#header, div#footer { + margin-left: 440px; + margin-right: 2em; + margin-top: 2em; + margin-bottom: 2em; } div.toc { @@ -145,17 +115,16 @@ div.toc { overflow: auto; } -div.toc p, -div.list-of-figures p, -div.list-of-tables p, -div.list-of-examples p, -div.toc a -{ - color: black; -} - -div.toc p { - color: black; +div#logo img { + position: fixed; + left: 0px; + top: 0px; + width: 410px; + height: 92px; + margin-top: 0px; + margin-bottom: 0px; + border-right: 2px solid #808080; + border-bottom: 2px solid #808080; } div.toc a:link { @@ -174,42 +143,34 @@ div.toc a:active { text-decoration: underline; } -div.book { - margin-left: 25em; +div.details { + padding-top: 1em; + padding-left: 3em; } -div.list-of-figures { - display: none; +span.author { + font-weight: bold; + color: #78079a; } -div.list-of-tables { - display: none; +span.email { + font-size: 10pt; } -div.figure p { - text-align: center; -} -div.figure img { - display: block; - margin: auto; +span#revnumber { + font-size: 8pt; } -div.table p.title { - text-align: center; +span#revdate { + font-size: 8pt; } -div.table-contents table { - margin-left: auto; - margin-right: auto; +span#revremark { + font-size: 8pt; } -div.example p.title, -div.sidebar p.title -{ - font-weight: normal; - color: #78079a; - font-family: "Open Sans",sans-serif; - margin-bottom: 0.2em; +div#footer { + border-top: 2px solid #808080; } body h1 { @@ -232,7 +193,6 @@ body h3 { body h4 { margin: .8em 0 0 -3%; line-height: 1.3; - border-top: 2px solid #808080; } body h5 { @@ -248,25 +208,6 @@ body h6 { body hr { border: none; /* Broken on IE6 */ } -div.footnotes hr { - border: 1px solid #808080; -} - -div.navheader th, div.navheader td, div.navfooter td { - font-family: "Open Sans",sans-serif; - font-size: 12pt; - font-weight: normal; - color: #78079a; -} -div.navheader img, div.navfooter img { - border-style: none; -} -div.navheader a, div.navfooter a { - font-weight: normal; -} -div.navfooter hr { - border: 1px solid #808080; -} body td { line-height: 1.2 @@ -284,11 +225,6 @@ ul, body dir, body menu { line-height: 1.2; } -html { - margin: 0; - padding: 0; -} - body h1, body h2, body h3, body h4, body h5, body h6 { margin-left: 0 } @@ -384,93 +320,62 @@ div.revhistory th { } /* Keep TOC and index lines close together. */ -div.toc dl, div.toc dt, -div.list-of-figures dl, div.list-of-figures dt, -div.list-of-tables dl, div.list-of-tables dt, -div.indexdiv dl, div.indexdiv dt +div.toc dl, div.toc dt { line-height: normal; margin-top: 0; margin-bottom: 0; } -/* - Table styling does not work because of overriding attributes in - generated HTML. -*/ -div.table-contents p, -div.informaltable p -{ - margin: 0px; +div.admonitionblock { + margin-top: 2em; + margin-bottom: 2em; + margin-left: 2em; + margin-right: 2em; } -div.table thead, div.table tfoot, -div.informaltable thead, div.informaltable tfoot -{ - font-weight: bold; +div.admonitionblock div { + margin-left: 0em; + margin-right: 1em; +} + +div.admonitionblock div.title { + color: #c70909; + font-style: bold; + font-size: 24pt; +} + +div#content table.tableblock { + border-style: solid; + border-width: 1px; + border-collapse: collapse; } -div.mediaobject img { - margin-bottom: 0.8em; +div#content table.tableblock td,th { + border-right-style: solid; + border-right-width: 1px; } -div.figure p.title, -div.table p.title -{ - margin-top: 1em; - margin-bottom: 0.4em; + +div#content table.tableblock tbody p { + margin-top: 0.25em; + margin-bottom: 0.25em; + margin-left: 0.25em; + margin-right: 0.25em; } -div.calloutlist p -{ - margin-top: 0em; - margin-bottom: 0.4em; +div#content table.tableblock tbody tr:nth-child(odd) { + background: #cccccc; +} + +div.imageblock{ + margin-top: 1em; + margin-bottom: 1em; } -a img { - border-style: none; +div.imageblock img { + margin-bottom: 0.5em; } @media print { div.navheader, div.navfooter { display: none; } } - -span.aqua { color: aqua; } -span.black { color: black; } -span.blue { color: blue; } -span.fuchsia { color: fuchsia; } -span.gray { color: gray; } -span.green { color: green; } -span.lime { color: lime; } -span.maroon { color: maroon; } -span.navy { color: navy; } -span.olive { color: olive; } -span.purple { color: purple; } -span.red { color: red; } -span.silver { color: silver; } -span.teal { color: teal; } -span.white { color: white; } -span.yellow { color: yellow; } - -span.aqua-background { background: aqua; } -span.black-background { background: black; } -span.blue-background { background: blue; } -span.fuchsia-background { background: fuchsia; } -span.gray-background { background: gray; } -span.green-background { background: green; } -span.lime-background { background: lime; } -span.maroon-background { background: maroon; } -span.navy-background { background: navy; } -span.olive-background { background: olive; } -span.purple-background { background: purple; } -span.red-background { background: red; } -span.silver-background { background: silver; } -span.teal-background { background: teal; } -span.white-background { background: white; } -span.yellow-background { background: yellow; } - -span.big { font-size: 2em; } -span.small { font-size: 0.6em; } - -span.underline { text-decoration: underline; } -span.overline { text-decoration: overline; } -span.line-through { text-decoration: line-through; } diff --git a/doc/companion.txt b/doc/companion.txt index 75ffa228..256ffad7 100644 --- a/doc/companion.txt +++ b/doc/companion.txt @@ -1,7 +1,16 @@ = AltOS Companion Port +Keith Packard ; Bdale Garbee :doctype: article +:copyright: Bdale Garbee and Keith Packard 2018 +:stylesheet: am.css +:linkcss: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts :toc: + include::header.adoc[] + == Companion Port Many Altus Metrum products come with an eight pin Micro MaTch diff --git a/doc/config-device.inc b/doc/config-device.inc index 0ca6afff..144b1e8f 100644 --- a/doc/config-device.inc +++ b/doc/config-device.inc @@ -233,7 +233,7 @@ ifdef::telemega,easymega[] ==== Configure Pyro Channels .Additional Pyro Channel Configuration - image::configure-pyro.png[width="5.5in"] + image::configure-pyro.png[width=400] This opens a separate window to configure the additional pyro channels available on TeleMega @@ -262,6 +262,6 @@ ifdef::telemega,easymega[] configuration by pressing the 'Save' button in the main Configure Flight Computer window. - include::pyro-channels.raw[] + include::pyro-channels.adoc[] endif::telemega,easymega[] diff --git a/doc/easymega-outline.txt b/doc/easymega-outline.txt index f5ca982c..d6daf09c 100644 --- a/doc/easymega-outline.txt +++ b/doc/easymega-outline.txt @@ -1,6 +1,7 @@ -= EasyMega Outline and Hole Pattern +:notitle: :doctype: article +== EasyMega Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in EasyMega. EasyMega has overall dimensions of 1.250 x 2.250 inches, and the mounting holes are sized for use diff --git a/doc/easymega.inc b/doc/easymega.inc index c126004b..a948aaae 100644 --- a/doc/easymega.inc +++ b/doc/easymega.inc @@ -1,7 +1,7 @@ == EasyMega .EasyMega Board - image::easymega-v1.0-top.jpg[width="4.5in"] + image::easymega-v1.0-top.jpg[width=430] EasyMega is a 1¼ inch by 2¼ inch circuit board. It was designed to easily fit in a 38mm coupler. Like TeleMetrum, diff --git a/doc/easymini-device.inc b/doc/easymini-device.inc index fb2b6098..82ea959c 100644 --- a/doc/easymini-device.inc +++ b/doc/easymini-device.inc @@ -1,7 +1,7 @@ == EasyMini .EasyMini Board - image::easymini-top.jpg[width="5.5in"] + image::easymini-top.jpg[width=400] EasyMini is built on a 0.8 inch by 1½ inch circuit board. It's designed to fit in a 24mm coupler tube. diff --git a/doc/easymini-outline.txt b/doc/easymini-outline.txt index e031b5ee..c4b1baa5 100644 --- a/doc/easymini-outline.txt +++ b/doc/easymini-outline.txt @@ -1,6 +1,7 @@ -= EasyMini Outline and Hole Pattern +:notitle: :doctype: article +== EasyMini Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in EasyMini. EasyMini has overall dimensions of 0.800 x 1.500 inches, and the mounting holes are sized for diff --git a/doc/easymini-release-notes.inc b/doc/easymini-release-notes.inc index 425236ef..67ba0f4d 100644 --- a/doc/easymini-release-notes.inc +++ b/doc/easymini-release-notes.inc @@ -1,53 +1,53 @@ [appendix] == Release Notes :leveloffset: 2 - include::release-notes-1.8.6.raw[] + include::release-notes-1.8.6.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.5.raw[] + include::release-notes-1.8.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.4.raw[] + include::release-notes-1.8.4.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.3.raw[] + include::release-notes-1.8.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.2.raw[] + include::release-notes-1.8.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.1.raw[] + include::release-notes-1.8.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.raw[] + include::release-notes-1.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.7.raw[] + include::release-notes-1.7.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.8.raw[] + include::release-notes-1.6.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.5.raw[] + include::release-notes-1.6.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.4.raw[] + include::release-notes-1.6.4.adoc[] :leveloffset: 2 - include::release-notes-1.6.3.raw[] + include::release-notes-1.6.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.2.raw[] + include::release-notes-1.6.2.adoc[] :leveloffset: 0 diff --git a/doc/easymini.txt b/doc/easymini.txt index 1a75b929..e3d3fae8 100644 --- a/doc/easymini.txt +++ b/doc/easymini.txt @@ -1,34 +1,47 @@ = EasyMini Owner's Manual +Keith Packard ; Bdale Garbee +:title-logo-image: image:../themes/background.png[] +:revnumber: v1.8.7 +:revdate: 8 Oct 2018 +:copyright: Bdale Garbee and Keith Packard 2018 :doctype: book :numbered: +:toc: +:stylesheet: am.css +:linkcss: :altusmetrum: 1 :easymini: 1 :application: AltosUI +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts - include::dedication.raw[] + include::header.adoc[] - include::intro.raw[] + include::dedication.adoc[] - include::getting-started.raw[] + include::intro.adoc[] - include::usage.raw[] + include::getting-started.adoc[] - include::easymini-device.raw[] + include::usage.adoc[] - include::installation.raw[] + include::easymini-device.adoc[] - include::using-am-products.raw[] + include::installation.adoc[] - include::altosui.raw[] + include::using-am-products.adoc[] - include::system-operation.raw[] + include::altosui.adoc[] - include::handling.raw[] + include::system-operation.adoc[] - include::updating-firmware.raw[] + include::handling.adoc[] - include::flight-data-recording.raw[] + include::updating-firmware.adoc[] - include::specs.raw[] + include::flight-data-recording.adoc[] - include::easymini-release-notes.raw[] + include::specs.adoc[] + + include::easymini-release-notes.adoc[] diff --git a/doc/header.inc b/doc/header.inc new file mode 100644 index 00000000..6bc616f5 --- /dev/null +++ b/doc/header.inc @@ -0,0 +1,13 @@ +ifndef::backend-pdf[] +[#logo] +[link=https://altusmetrum.org] +image::altusmetrum-oneline.svg[Altus Metrum] +endif::[] + +[license] +== License + +Copyright © 2018 Bdale Garbee and Keith Packard + +This document is released under the terms of the link:http://creativecommons.org/licenses/by-sa/3.0/[Creative Commons ShareAlike 3.0 License] + diff --git a/doc/load-maps.inc b/doc/load-maps.inc index ccab4795..520fb364 100644 --- a/doc/load-maps.inc +++ b/doc/load-maps.inc @@ -1,7 +1,7 @@ === Load Maps .Load Maps Window - image::load-maps.png[width="5.2in"] + image::load-maps.png[width=500] Before heading out to a new launch site, you can use this to load satellite images in case you don't have diff --git a/doc/map-loading.txt b/doc/map-loading.txt index 1b39dd6b..f8328176 100644 --- a/doc/map-loading.txt +++ b/doc/map-loading.txt @@ -1,5 +1,13 @@ = Loading Map Tiles from Google Maps +Keith Packard +:title-logo-image: image:load-maps.png[] +:copyright: Keith Packard 2018 :doctype: article +:stylesheet: am-notoc.css +:linkcss: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts == The Google Maps Problem diff --git a/doc/micropeak-oneline.svg b/doc/micropeak-oneline.svg index 4b695827..b892b24d 100644 --- a/doc/micropeak-oneline.svg +++ b/doc/micropeak-oneline.svg @@ -10,14 +10,44 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="444" - height="98" + width="320" + height="63" id="svg2" version="1.1" - inkscape:version="0.91 r13725" - sodipodi:docname="micropeak-oneline.svg"> + inkscape:version="0.48.3.1 r9886" + sodipodi:docname="micropeak-oneline-font.svg"> + + + + + + + + + + @@ -80,7 +110,7 @@ style="overflow:visible"> @@ -108,7 +138,17 @@ x2="280.61411" y2="275.90405" gradientUnits="userSpaceOnUse" - gradientTransform="matrix(1.9246394,0,0,1.9246394,-200.29778,-270.16721)" /> + gradientTransform="matrix(1.58566,0,0,1.58566,-141.69631,-171.10662)" /> + + transform="translate(-241.9891,-229.23188)"> + style="font-size:57.89221573px;font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#7200a4;fill-opacity:1;stroke:none;font-family:ITC Benguiat Gothic Std;-inkscape-font-specification:ITC Benguiat Gothic Std Medium" + id="text2985"> + + + d="m 282.7522,267.42614 -3.93403,-2.77705 -4.51792,1.66641 1.42544,-4.59964 -2.98096,-3.78185 4.815,-0.0657 2.67559,-4.00372 1.55039,4.55904 4.63457,1.30742 -3.85681,2.88333 z" + inkscape:transform-center-x="-0.46292579" + inkscape:transform-center-y="-0.64836539" + transform="matrix(1.58566,0,0,1.58566,-141.69632,-171.10662)" /> + style="font-size:54.73445892px;font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:url(#linearGradient4147);fill-opacity:1;stroke:none;font-family:ITC Benguiat Gothic Std;-inkscape-font-specification:ITC Benguiat Gothic Std Medium" + id="text5351"> + + + + + + + + - - - - - - - - - - - + d="m 538.94589,277.69509 c 0,1.64203 0.60208,2.84619 2.40832,2.84619 1.80623,0 2.40832,-1.20416 2.40832,-2.84619 l 0,-13.40995 c 9.14064,1.2589 12.09631,4.15983 13.40994,13.46468 0.21894,1.53256 0.43788,2.79146 2.35358,2.79146 1.5873,0 2.46305,-0.82102 2.46305,-2.57252 0,-6.23972 -3.22934,-13.40995 -9.57853,-15.32565 l 0,-0.10947 c 3.06513,-1.03995 7.49862,-4.5977 7.49862,-8.15543 0,-1.20416 -0.82102,-2.18938 -1.7515,-2.18938 -1.80624,0 -2.18938,1.25889 -3.94088,3.72194 -1.97044,2.90093 -5.69239,4.87137 -9.30486,4.87137 l -1.14942,0 0,-15.38038 c 0,-1.64204 -0.60209,-2.8462 -2.40832,-2.8462 -1.80624,0 -2.40832,1.20416 -2.40832,2.8462 l 0,32.29333" + style="" + id="path4181" /> diff --git a/doc/micropeak.txt b/doc/micropeak.txt index d5036a00..9569194e 100644 --- a/doc/micropeak.txt +++ b/doc/micropeak.txt @@ -1,6 +1,18 @@ = MicroPeak Owner's Manual +Keith Packard ; Bdale Garbee +:revnumber: v1.8.7 +:revdate: 8 Oct 2018 +:copyright: Bdale Garbee and Keith Packard 2018 +:stylesheet: am.css +:linkcss: +:toc: :doctype: book :numbered: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts + + include::header.adoc[] [dedication] == Acknowledgements @@ -32,7 +44,7 @@ positive (+) terminal facing away from the circuit board. .MicroPeak and Battery - image::micropeak-back.jpg[width="4.5in"] + image::micropeak-back.jpg[width=430] Install MicroPeak in your rocket:: @@ -87,7 +99,7 @@ == The MicroPeak USB adapter .MicroPeak USB Adapter - image::MicroPeakUSB-2.0.jpg[width="4.5in",align="center"] + image::MicroPeakUSB-2.0.jpg[width=430,align="center"] MicroPeak stores barometric pressure information for the first 48 seconds of the flight in on-board non-volatile memory. The @@ -112,25 +124,25 @@ * Start the MicroPeak application. - image::micropeak-nofont.svg[width="0.5in",align="center"] + image::micropeak-nofont.svg[width=50,align="center"] * Click on the Download button at the top of the window. .MicroPeak Application - image::micropeak-app.png[width="4.5in",align="center"] + image::micropeak-app.png[width=430,align="center"] * Select from the listed devices. There will probably be only one. .MicroPeak Device Dialog - image::micropeak-device-dialog.png[width="2.3in",align="center"] + image::micropeak-device-dialog.png[width=220,align="center"] * The application will now wait until it receives valid data from the MicroPeak USB adapter. .MicroPeak Download Dialog - image::micropeak-download.png[width="2in",align="center"] + image::micropeak-download.png[width=200,align="center"] * The MicroPeak USB adapter has a small phototransistor under the hole in the center of the @@ -142,7 +154,7 @@ MicroPeak board itself. .MicroPeak Downloading - image::MicroPeakUSB-2.0-inuse.jpg[width="4.5in",align="center"] + image::MicroPeakUSB-2.0-inuse.jpg[width=430,align="center"] * After the maximum flight height is reported, MicroPeak will pause for a few seconds, blink the @@ -154,7 +166,7 @@ MicroPeak board and try again. .MicroPeak Save Dialog - image::micropeak-save-dialog.png[width="2.3in",align="center"] + image::micropeak-save-dialog.png[width=220,align="center"] * Once the data are saved, a graph will be displayed with height, speed and acceleration values computed @@ -194,7 +206,7 @@ ==== MicroPeak Graphs .MicroPeak Graph - image::micropeak-graph.png[width="4.5in",align="center"] + image::micropeak-graph.png[width=430,align="center"] Under the Graph tab, the height, speed and acceleration values are displayed together. You can zoom in on the graph by @@ -205,7 +217,7 @@ ==== MicroPeak Flight Statistics .MicroPeak Flight Statistics - image::micropeak-statistics.png[width="4.5in",align="center"] + image::micropeak-statistics.png[width=430,align="center"] The Statistics tab presents overall data from the flight. Note that the Maximum height value @@ -220,7 +232,7 @@ ==== Raw Flight Data .MicroPeak Raw Flight Data - image::micropeak-raw-data.png[width="4.5in",align="center"] + image::micropeak-raw-data.png[width=430,align="center"] A table consisting of the both the raw barometric pressure data and values computed from that for each recorded time. @@ -228,7 +240,7 @@ ==== Configuring the Graph .MicroPeak Graph Configuration - image::micropeak-graph-configure.png[width="4.5in",align="center"] + image::micropeak-graph-configure.png[width=430,align="center"] This selects which graph elements to show, and lets you switch between metric and imperial units @@ -236,7 +248,7 @@ === Setting MicroPeak Preferences .MicroPeak Preferences - image::micropeak-preferences.png[width="1.8in",align="center"] + image::micropeak-preferences.png[width=170,align="center"] The MicroPeak application has a few user settings which are configured through the Preferences dialog, which can be diff --git a/doc/release-head.inc b/doc/release-head.inc new file mode 100644 index 00000000..0dbdfc2b --- /dev/null +++ b/doc/release-head.inc @@ -0,0 +1,7 @@ +:toc!: +:doctype: article +:stylesheet: am-notoc.css +:linkcss: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts diff --git a/doc/release-notes-0.7.1.inc b/doc/release-notes-0.7.1.inc index 8ce49f0a..c253e812 100644 --- a/doc/release-notes-0.7.1.inc +++ b/doc/release-notes-0.7.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 0.7.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 0.7.1 is the first release containing our new diff --git a/doc/release-notes-0.8.inc b/doc/release-notes-0.8.inc index 38230593..3ff70c90 100644 --- a/doc/release-notes-0.8.inc +++ b/doc/release-notes-0.8.inc @@ -1,5 +1,5 @@ = Release Notes for Version 0.8 -:toc!: +include::release-head.adoc[] :doctype: article Version 0.8 offers a major upgrade in the AltosUI diff --git a/doc/release-notes-0.9.2.inc b/doc/release-notes-0.9.2.inc index b7c55bb2..9c373c2f 100644 --- a/doc/release-notes-0.9.2.inc +++ b/doc/release-notes-0.9.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 0.9.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 0.9.2 is an AltosUI bug-fix release, with no firmware diff --git a/doc/release-notes-0.9.inc b/doc/release-notes-0.9.inc index 0ee7ea51..a42a18d8 100644 --- a/doc/release-notes-0.9.inc +++ b/doc/release-notes-0.9.inc @@ -1,5 +1,5 @@ = Release Notes for Version 0.9 -:toc!: +include::release-head.adoc[] :doctype: article Version 0.9 adds a few new firmware features and accompanying diff --git a/doc/release-notes-1.0.1.inc b/doc/release-notes-1.0.1.inc index 067727e9..fac31d7f 100644 --- a/doc/release-notes-1.0.1.inc +++ b/doc/release-notes-1.0.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.0.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.0.1 is a major release, adding support for the diff --git a/doc/release-notes-1.1.1.inc b/doc/release-notes-1.1.1.inc index 2e61bfec..2cc30aa8 100644 --- a/doc/release-notes-1.1.1.inc +++ b/doc/release-notes-1.1.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.1.1 is a bug-fix release. It fixes a couple of bugs diff --git a/doc/release-notes-1.1.inc b/doc/release-notes-1.1.inc index b3ea066d..f7283ce4 100644 --- a/doc/release-notes-1.1.inc +++ b/doc/release-notes-1.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.1 is a minor release. It provides a few new features diff --git a/doc/release-notes-1.2.1.inc b/doc/release-notes-1.2.1.inc index 18c5d7e2..f60b8e74 100644 --- a/doc/release-notes-1.2.1.inc +++ b/doc/release-notes-1.2.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.2.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.2.1 is a minor release. It adds support for TeleBT and diff --git a/doc/release-notes-1.2.inc b/doc/release-notes-1.2.inc index 42afad04..f0c2615a 100644 --- a/doc/release-notes-1.2.inc +++ b/doc/release-notes-1.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.2 is a major release. It adds support for MicroPeak diff --git a/doc/release-notes-1.3.1.inc b/doc/release-notes-1.3.1.inc index ff9c8e52..dc9eac87 100644 --- a/doc/release-notes-1.3.1.inc +++ b/doc/release-notes-1.3.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.3.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.3.1 is a minor release. It improves support for diff --git a/doc/release-notes-1.3.2.inc b/doc/release-notes-1.3.2.inc index dae5dd99..7e0f57d6 100644 --- a/doc/release-notes-1.3.2.inc +++ b/doc/release-notes-1.3.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.3.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.3.2 is a minor release. It includes small bug fixes for diff --git a/doc/release-notes-1.3.inc b/doc/release-notes-1.3.inc index ceb677a1..b53354ac 100644 --- a/doc/release-notes-1.3.inc +++ b/doc/release-notes-1.3.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.3 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.3 is a major release. It adds support for TeleMega, diff --git a/doc/release-notes-1.4.1.inc b/doc/release-notes-1.4.1.inc index 5e3e831e..0d9c5350 100644 --- a/doc/release-notes-1.4.1.inc +++ b/doc/release-notes-1.4.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.4.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.4.1 is a minor release. It fixes install issues on diff --git a/doc/release-notes-1.4.2.inc b/doc/release-notes-1.4.2.inc index ded6b408..059b8b95 100644 --- a/doc/release-notes-1.4.2.inc +++ b/doc/release-notes-1.4.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.4.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.4.2 is a minor release. It fixes Java-related install issues on diff --git a/doc/release-notes-1.4.inc b/doc/release-notes-1.4.inc index f4ab9ad2..163aee0c 100644 --- a/doc/release-notes-1.4.inc +++ b/doc/release-notes-1.4.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.4 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.4 is a major release. It includes support for our new diff --git a/doc/release-notes-1.5.inc b/doc/release-notes-1.5.inc index 8d72c0e0..67cf1721 100644 --- a/doc/release-notes-1.5.inc +++ b/doc/release-notes-1.5.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.5 -:toc!: +include::release-head.adoc[] Version 1.5 is a major release. It includes support for our new EasyMega product, new features and bug fixes in in the flight diff --git a/doc/release-notes-1.6.1.inc b/doc/release-notes-1.6.1.inc index 1e03ed4f..8fb90570 100644 --- a/doc/release-notes-1.6.1.inc +++ b/doc/release-notes-1.6.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.1 includes support for our updated TeleBT v3.0 diff --git a/doc/release-notes-1.6.2.inc b/doc/release-notes-1.6.2.inc index 990eb48f..95466bf7 100644 --- a/doc/release-notes-1.6.2.inc +++ b/doc/release-notes-1.6.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.2 includes support for our updated TeleMega v2.0 diff --git a/doc/release-notes-1.6.3.inc b/doc/release-notes-1.6.3.inc index 6aa77042..97946db7 100644 --- a/doc/release-notes-1.6.3.inc +++ b/doc/release-notes-1.6.3.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.3 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.3 adds idle mode to AltosDroid and has bug fixes diff --git a/doc/release-notes-1.6.4.inc b/doc/release-notes-1.6.4.inc index f976a69d..f0c7a59d 100644 --- a/doc/release-notes-1.6.4.inc +++ b/doc/release-notes-1.6.4.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.4 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.4 fixes a bluetooth communication problem with diff --git a/doc/release-notes-1.6.5.inc b/doc/release-notes-1.6.5.inc index 9f3ae281..538c4db3 100644 --- a/doc/release-notes-1.6.5.inc +++ b/doc/release-notes-1.6.5.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.5 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.5 fixes a TeleMega and TeleMetrum v2.0 bug where diff --git a/doc/release-notes-1.6.8.inc b/doc/release-notes-1.6.8.inc index 8e37fe69..7b122425 100644 --- a/doc/release-notes-1.6.8.inc +++ b/doc/release-notes-1.6.8.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6.8 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6.8 fixes a TeleMega and TeleMetrum v2.0 bug where diff --git a/doc/release-notes-1.6.inc b/doc/release-notes-1.6.inc index 0908dfaf..adbded52 100644 --- a/doc/release-notes-1.6.inc +++ b/doc/release-notes-1.6.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.6 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.6 includes support for our updated TeleDongle v3.0 diff --git a/doc/release-notes-1.7.inc b/doc/release-notes-1.7.inc index f2da71f3..b6ed7881 100644 --- a/doc/release-notes-1.7.inc +++ b/doc/release-notes-1.7.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.7 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.7 includes support for our new TeleMini v3.0 diff --git a/doc/release-notes-1.8.1.inc b/doc/release-notes-1.8.1.inc index d9e4a2d9..dc02b3a1 100644 --- a/doc/release-notes-1.8.1.inc +++ b/doc/release-notes-1.8.1.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.1 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.1 includes an important bug fix for Apogee Lockout diff --git a/doc/release-notes-1.8.2.inc b/doc/release-notes-1.8.2.inc index 2923ec11..cbc77bba 100644 --- a/doc/release-notes-1.8.2.inc +++ b/doc/release-notes-1.8.2.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.2 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.2 includes support for TeleGPS version 2.0 along diff --git a/doc/release-notes-1.8.3.inc b/doc/release-notes-1.8.3.inc index 4bc879ad..ef056f01 100644 --- a/doc/release-notes-1.8.3.inc +++ b/doc/release-notes-1.8.3.inc @@ -1,6 +1,5 @@ = Release Notes for Version 1.8.3 -:toc!: -:doctype: article +include::release-head.adoc[] Version 1.8.3 includes support for TeleMega version 3.0 along with two important flight computer fixes. This version also diff --git a/doc/release-notes-1.8.4.inc b/doc/release-notes-1.8.4.inc index f8cb4f11..9a8657b3 100644 --- a/doc/release-notes-1.8.4.inc +++ b/doc/release-notes-1.8.4.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.4 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.4 includes support for EasyMini version 2.0 diff --git a/doc/release-notes-1.8.5.inc b/doc/release-notes-1.8.5.inc index 5b940efd..07d911c1 100644 --- a/doc/release-notes-1.8.5.inc +++ b/doc/release-notes-1.8.5.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.5 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.5 includes fixes to the ground software support diff --git a/doc/release-notes-1.8.6.inc b/doc/release-notes-1.8.6.inc index 1467977c..5c066b80 100644 --- a/doc/release-notes-1.8.6.inc +++ b/doc/release-notes-1.8.6.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.6 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.6 diff --git a/doc/release-notes-1.8.7.inc b/doc/release-notes-1.8.7.inc index f8b7b103..2e387adb 100644 --- a/doc/release-notes-1.8.7.inc +++ b/doc/release-notes-1.8.7.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8.7 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8.7 diff --git a/doc/release-notes-1.8.inc b/doc/release-notes-1.8.inc index 0255c16b..0c97abb4 100644 --- a/doc/release-notes-1.8.inc +++ b/doc/release-notes-1.8.inc @@ -1,5 +1,5 @@ = Release Notes for Version 1.8 -:toc!: +include::release-head.adoc[] :doctype: article Version 1.8 includes support for our new TeleBT v4.0 ground diff --git a/doc/release-notes.inc b/doc/release-notes.inc index 1183fd12..a1dc6720 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,131 +1,131 @@ [appendix] == Release Notes :leveloffset: 2 - include::release-notes-1.8.7.raw[] + include::release-notes-1.8.7.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.6.raw[] + include::release-notes-1.8.6.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.5.raw[] + include::release-notes-1.8.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.4.raw[] + include::release-notes-1.8.4.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.3.raw[] + include::release-notes-1.8.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.2.raw[] + include::release-notes-1.8.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.1.raw[] + include::release-notes-1.8.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.raw[] + include::release-notes-1.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.7.raw[] + include::release-notes-1.7.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.8.raw[] + include::release-notes-1.6.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.5.raw[] + include::release-notes-1.6.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.4.raw[] + include::release-notes-1.6.4.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.3.raw[] + include::release-notes-1.6.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.2.raw[] + include::release-notes-1.6.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.1.raw[] + include::release-notes-1.6.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.raw[] + include::release-notes-1.6.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.5.raw[] + include::release-notes-1.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.2.raw[] + include::release-notes-1.4.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.1.raw[] + include::release-notes-1.4.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.raw[] + include::release-notes-1.4.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.3.2.raw[] + include::release-notes-1.3.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.3.1.raw[] + include::release-notes-1.3.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.3.raw[] + include::release-notes-1.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.2.1.raw[] + include::release-notes-1.2.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.2.raw[] + include::release-notes-1.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.1.1.raw[] + include::release-notes-1.1.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.1.raw[] + include::release-notes-1.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.0.1.raw[] + include::release-notes-1.0.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-0.9.2.raw[] + include::release-notes-0.9.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-0.9.raw[] + include::release-notes-0.9.adoc[] <<<< :leveloffset: 2 - include::release-notes-0.8.raw[] + include::release-notes-0.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-0.7.1.raw[] + include::release-notes-0.7.1.adoc[] :leveloffset: 0 diff --git a/doc/specs.inc b/doc/specs.inc index 1b7ea74b..89c21307 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -6,7 +6,7 @@ .Altus Metrum Flight Computer Electronics [options="header"] - |================================ + |=== |Device | Barometer | Z-axis accel | GPS | 3D sensors | Storage | RF Output | Battery ifdef::telemetrum[] @@ -45,8 +45,8 @@ |8MB |40mW |3.7V - endif::telemetrum[] + endif::telemetrum[] ifdef::telemini[] |TeleMini v1.0 |MP3H6115 10km (33k') @@ -65,8 +65,8 @@ |512kB |40mW |3.7V - endif::telemini[] + endif::telemini[] ifdef::easymini[] |EasyMini v1.0 |MS5607 30km (100k') @@ -85,8 +85,8 @@ |1MB |- |3.7-12V - endif::easymini[] + endif::easymini[] ifdef::telemega[] |TeleMega v1.0 |MS5607 30km (100k') @@ -114,8 +114,8 @@ |8MB |40mW |3.7V - endif::telemega[] + endif::telemega[] ifdef::easymega[] |EasyMega v1.0 |MS5607 30km (100k') @@ -127,12 +127,12 @@ |3.7V endif::easymega[] - |============================== + |=== <<<< .Altus Metrum Flight Computer Mechanical Components [options="header",grid="all"] - |============================== + |=== |Device|Connectors|Screw Terminals|Width|Length|Tube Size ifdef::telemetrum[] @@ -187,4 +187,4 @@ |38mm coupler endif::easymega[] - |==================================== + |=== diff --git a/doc/system-operation.inc b/doc/system-operation.inc index 17dfdf89..1e130976 100644 --- a/doc/system-operation.inc +++ b/doc/system-operation.inc @@ -297,7 +297,7 @@ ifdef::gps+radio[] :aprsdevices: TeleMetrum v2.0 and TeleMega :configure_section: _configure_altimeter - include::aprs-operation.raw[] + include::aprs-operation.adoc[] endif::gps+radio[] === Configurable Parameters diff --git a/doc/telegps-application.inc b/doc/telegps-application.inc index 3e6b385e..668595be 100644 --- a/doc/telegps-application.inc +++ b/doc/telegps-application.inc @@ -65,7 +65,7 @@ the device. .TeleGPS Map View - image::telegps-map.png[width="5.5in"] + image::telegps-map.png[width=400] The map's default scale is approximately 3m (10ft) per pixel. The map can be dragged using @@ -99,7 +99,7 @@ received from TeleGPS. .TeleGPS Location View - image::telegps-location.png[width="5.5in"] + image::telegps-location.png[width=400] ==== Status @@ -108,7 +108,7 @@ received telemetry from it. .TeleGPS Status View - image::telegps-status.png[width="5.5in"] + image::telegps-status.png[width=400] ==== Table @@ -116,7 +116,7 @@ the GPS receiver .TeleGPS Information Table - image::telegps-table.png[width="5.5in"] + image::telegps-table.png[width=400] === TeleGPS Menus @@ -164,12 +164,12 @@ ==== Data Graph .TeleGPS Graph - image::telegps-graph-graph.png[width="5.5in"] + image::telegps-graph-graph.png[width=400] ==== Graph Configuration .TeleGPS Graph Configuration - image::telegps-graph-configure.png[width="5.5in"] + image::telegps-graph-configure.png[width=400] This selects which graph elements to show, and, at the bottom, lets you switch between metric and imperial @@ -178,14 +178,14 @@ ==== Statistics .TeleGPS Statistics - image::telegps-graph-stats.png[width="5.5in"] + image::telegps-graph-stats.png[width=400] Shows overall data computed from the flight. ==== Map .TeleGPS Map - image::telegps-graph-map.png[width="6in"] + image::telegps-graph-map.png[width=450] Shows a map of the area overlaid with the GPS track. As with the telemetry monitoring window, you can select the style @@ -233,14 +233,14 @@ within that application. With this, you can use Google Earth to see the whole path in 3D. - include::load-maps.raw[] + include::load-maps.adoc[] === Preferences .TeleGPS Preferences Window - image::telegps-preferences.png[width="2.4in"] + image::telegps-preferences.png[width=230] - include::config-ui.raw[] + include::config-ui.adoc[] === Close @@ -260,7 +260,7 @@ received by the selected TeleDongle device. .Device Selection Dialog - image::device-selection.png[width="3.1in"] + image::device-selection.png[width=300] === Disconnect @@ -270,7 +270,7 @@ === Scan Channels .Radio Scanning Dialog - image::telegps-scan.png[width="3.1in"] + image::telegps-scan.png[width=300] Scans the configured set of frequencies looking for telemetry signals. A list of all of the discovered @@ -306,7 +306,7 @@ === Configure Device .TeleGPS Configuration Dialog - image::telegps-configure.png[width="3.6in"] + image::telegps-configure.png[width=350] Select this button and then select any connected TeleGPS device from the list provided. @@ -342,7 +342,7 @@ The rest of the dialog contains the parameters to be configured. - include::config-device.raw[] + include::config-device.adoc[] === Flash Device diff --git a/doc/telegps-outline.txt b/doc/telegps-outline.txt index bd1495be..ca10d124 100644 --- a/doc/telegps-outline.txt +++ b/doc/telegps-outline.txt @@ -1,6 +1,7 @@ -= TeleGPS Outline and Hole Pattern +:notitle: :doctype: article +== TeleGPS Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in TeleGPS. TeleGPS has overall dimensions of 1.000 x 1.500 inches, and the mounting holes are sized for diff --git a/doc/telegps-release-notes.inc b/doc/telegps-release-notes.inc index 9c1353f8..ec1135cb 100644 --- a/doc/telegps-release-notes.inc +++ b/doc/telegps-release-notes.inc @@ -2,75 +2,75 @@ == Release Notes :leveloffset: 2 - include::release-notes-1.8.6.raw[] + include::release-notes-1.8.6.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.5.raw[] + include::release-notes-1.8.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.4.raw[] + include::release-notes-1.8.4.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.3.raw[] + include::release-notes-1.8.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.2.raw[] + include::release-notes-1.8.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.1.raw[] + include::release-notes-1.8.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.8.raw[] + include::release-notes-1.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.7.raw[] + include::release-notes-1.7.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.8.raw[] + include::release-notes-1.6.8.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.5.raw[] + include::release-notes-1.6.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.4.raw[] + include::release-notes-1.6.4.adoc[] :leveloffset: 2 - include::release-notes-1.6.3.raw[] + include::release-notes-1.6.3.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.2.raw[] + include::release-notes-1.6.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.1.raw[] + include::release-notes-1.6.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.6.raw[] + include::release-notes-1.6.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.5.raw[] + include::release-notes-1.5.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.2.raw[] + include::release-notes-1.4.2.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.1.raw[] + include::release-notes-1.4.1.adoc[] <<<< :leveloffset: 2 - include::release-notes-1.4.raw[] + include::release-notes-1.4.adoc[] diff --git a/doc/telegps-system-operation.inc b/doc/telegps-system-operation.inc index c9fce7f0..e788bc7c 100644 --- a/doc/telegps-system-operation.inc +++ b/doc/telegps-system-operation.inc @@ -21,7 +21,7 @@ :aprsdevices: TeleGPS :configure_section: _configure_device - include::aprs-operation.raw[] + include::aprs-operation.adoc[] === Configurable Parameters diff --git a/doc/telegps.txt b/doc/telegps.txt index 47eafe37..8b558dbd 100644 --- a/doc/telegps.txt +++ b/doc/telegps.txt @@ -1,25 +1,39 @@ = TeleGPS Owner's Manual +Keith Packard ; Bdale Garbee +:title-logo-image: image:../themes/background.png[] +:revnumber: v1.8.7 +:revdate: 8 Oct 2018 +:revremark: Fix TeleBT v4.0 RF calibration to factory value when reflashing. Fix map images. Fix Mac OS X support. +:copyright: Bdale Garbee and Keith Packard 2018 +:stylesheet: am.css +:linkcss: +:toc: :doctype: book :numbered: :telegps: 1 :radio: 1 :gps: 1 :application: TeleGPS +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts - include::telegps-dedication.raw[] + include::header.adoc[] - include::telegps-quick-start.raw[] + include::telegps-dedication.adoc[] - include::telegps-using.raw[] + include::telegps-quick-start.adoc[] - include::telegps-application.raw[] + include::telegps-using.adoc[] - include::telegps-system-operation.raw[] + include::telegps-application.adoc[] - include::handling.raw[] + include::telegps-system-operation.adoc[] - include::telegps-specs.raw[] + include::handling.adoc[] - include::telegps-updating-firmware.raw[] + include::telegps-specs.adoc[] - include::telegps-release-notes.raw[] + include::telegps-updating-firmware.adoc[] + + include::telegps-release-notes.adoc[] diff --git a/doc/telemega-outline.txt b/doc/telemega-outline.txt index 1af91894..7b1d9269 100644 --- a/doc/telemega-outline.txt +++ b/doc/telemega-outline.txt @@ -1,6 +1,7 @@ -= TeleMega Outline and Hole Pattern +:notitle: :doctype: article +== TeleMega Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in TeleMega. TeleMega has overall dimensions of 1.250 x 3.250 inches, and the mounting holes are sized for use diff --git a/doc/telemega.inc b/doc/telemega.inc index 55f77bc4..0975172f 100644 --- a/doc/telemega.inc +++ b/doc/telemega.inc @@ -1,7 +1,7 @@ == TeleMega .TeleMega Board - image::telemega-v1.0-top.jpg[width="5.5in"] + image::telemega-v1.0-top.jpg[width=400] TeleMega is a 1¼ inch by 3¼ inch circuit board. It was designed to easily fit in a 38mm coupler. Like TeleMetrum, diff --git a/doc/telemetrum-outline.txt b/doc/telemetrum-outline.txt index ab6871f9..f37fed74 100644 --- a/doc/telemetrum-outline.txt +++ b/doc/telemetrum-outline.txt @@ -1,6 +1,7 @@ -= TeleMetrum Outline and Hole Pattern +:notitle: :doctype: article +== TeleMetrum Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in TeleMetrum. TeleMetrum has overall dimensions of 1.000 x 2.750 inches, and the mounting holes are sized for use diff --git a/doc/telemetrum.inc b/doc/telemetrum.inc index 7c9dadb5..35aec6cc 100644 --- a/doc/telemetrum.inc +++ b/doc/telemetrum.inc @@ -1,10 +1,10 @@ == TeleMetrum .TeleMetrum v2 Board - image::telemetrum-v2.0-th.jpg[width="5.5in"] + image::telemetrum-v2.0-th.jpg[width=400] .TeleMetrum v1 Board - image::telemetrum-v1.1-thside.jpg[width="5.5in"] + image::telemetrum-v1.1-thside.jpg[width=400] TeleMetrum is a 1 inch by 2¾ inch circuit board. It was designed to fit inside coupler for 29mm air-frame tubing, but using it in a tube that @@ -39,7 +39,7 @@ .TeleMetrum Screw Terminals [options="header",grid="all",cols="2,3,10"] - |========================= + |=== |Terminal #|Terminal Name|Description |1 |Switch Output |Switch connection to flight computer |2 |Switch Input |Switch connection to positive battery terminal @@ -47,7 +47,7 @@ |4 |Main - |Main pyro channel connection to pyro circuit |5 |Apogee + |Apogee pyro channel common connection to battery + |6 |Apogee - |Apogee pyro channel connection to pyro circuit - |======================== + |=== === Using a Separate Pyro Battery with TeleMetrum diff --git a/doc/telemetry.txt b/doc/telemetry.txt index d7399b6a..ae9c7f9f 100644 --- a/doc/telemetry.txt +++ b/doc/telemetry.txt @@ -1,7 +1,18 @@ = AltOS Telemetry +Keith Packard ; Bdale Garbee +:revnumber: v1.8.7 +:revdate: 8 Oct 2018 +:copyright: Bdale Garbee and Keith Packard 2018 +:stylesheet: am.css +:linkcss: :doctype: article :toc: :numbered: +:pdf-stylesdir: . +:pdf-style: altusmetrum +:pdf-fontsdir: fonts + + include::header.adoc[] == Packet Format Design diff --git a/doc/telemini-v1-outline.txt b/doc/telemini-v1-outline.txt index bce3f651..e331cf8d 100644 --- a/doc/telemini-v1-outline.txt +++ b/doc/telemini-v1-outline.txt @@ -1,6 +1,8 @@ -= TeleMini v1 Outline and Hole Pattern +:notitle: :doctype: article +== TeleMini v1 Outline and Hole Pattern + This image, when printed, provides a precise template for the mounting holes in TeleMini. TeleMini v1 has overall dimensions of 0.500 x 1.500 inches, and the mounting holes are sized for use diff --git a/doc/telemini-v3-outline.txt b/doc/telemini-v3-outline.txt index bb26ed6e..57a738eb 100644 --- a/doc/telemini-v3-outline.txt +++ b/doc/telemini-v3-outline.txt @@ -1,6 +1,7 @@ -= TeleMini v3 Outline and Hole Pattern +:notitle: :doctype: article +== TeleMini v3 Outline and Hole Pattern This image, when printed, provides a precise template for the mounting holes in TeleMini v3. TeleMini v3 has overall dimensions of 0.500 x 1.670 inches, and the mounting holes are sized for use diff --git a/doc/telemini.inc b/doc/telemini.inc index 08893dfb..b7b26a8a 100644 --- a/doc/telemini.inc +++ b/doc/telemini.inc @@ -1,8 +1,8 @@ == TeleMini .TeleMini v3 Board - image::telemini-v3.0-top.jpg[width="5.5in"] - image::telemini-v3.0-bottom.jpg[width="5.5in"] + image::telemini-v3.0-top.jpg[width=400] + image::telemini-v3.0-bottom.jpg[width=400] TeleMini v3 is 0.5 inches by 1.67 inches. It was designed to fit inside an 18mm air-frame tube, but using it in @@ -152,5 +152,5 @@ power switch. .TeleMini v1 Board - image::telemini-v1-top.jpg[width="5.5in"] + image::telemini-v1-top.jpg[width=400] diff --git a/doc/updating-firmware.inc b/doc/updating-firmware.inc index d2883829..ee2f5e9a 100644 --- a/doc/updating-firmware.inc +++ b/doc/updating-firmware.inc @@ -27,10 +27,14 @@ http://www.altusmetrum.org/AltOS/ ifdef::telemega[] + === Updating TeleMega, TeleMetrum v2, EasyMega, EasyMini or TeleDongle v3 Firmware + endif::telemega[] ifndef::telemega[] + === Updating EasyMini Firmware + endif::telemega[] Self-programmable devices are reprogrammed by diff --git a/doc/using-am-products.inc b/doc/using-am-products.inc index 1969529f..1c1ff10e 100644 --- a/doc/using-am-products.inc +++ b/doc/using-am-products.inc @@ -1,12 +1,14 @@ == Using Altus Metrum Products ifdef::radio[] + === Being Legal In the US, you need an link:http://www.altusmetrum.org/Radio/[amateur radio license] or other authorization to legally operate the radio transmitters that are part of our products. + endif::radio[] -- cgit v1.2.3 From d859a7f65baf6c5c170f14fb2d9401b5c607a254 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Thu, 25 Oct 2018 17:01:38 -0700 Subject: doc: Remove asciidoc related files These all helped asciidoc generate documentation Signed-off-by: Keith Packard --- doc/.gitignore | 3 - doc/Makefile.am | 8 +- doc/altos-docinfo.xml | 33 - doc/altusmetrum-docinfo.xml | 289 -------- doc/am-fo.xsl | 231 ------ doc/am-html.xsl | 14 - doc/common.xsl | 124 ---- doc/companion-docinfo.xml | 28 - doc/easymini-docinfo.xml | 62 -- doc/footer.templates.xsl | 52 -- doc/fop.xconf | 88 --- doc/micropeak-docinfo.xml | 90 --- doc/telegps-docinfo.xml | 107 --- doc/telemetry-docinfo.xml | 28 - doc/titlepage.templates.tmpl | 1587 ------------------------------------------ 15 files changed, 4 insertions(+), 2740 deletions(-) delete mode 100644 doc/altos-docinfo.xml delete mode 100644 doc/altusmetrum-docinfo.xml delete mode 100644 doc/am-fo.xsl delete mode 100644 doc/am-html.xsl delete mode 100644 doc/common.xsl delete mode 100644 doc/companion-docinfo.xml delete mode 100644 doc/easymini-docinfo.xml delete mode 100644 doc/footer.templates.xsl delete mode 100644 doc/fop.xconf delete mode 100644 doc/micropeak-docinfo.xml delete mode 100644 doc/telegps-docinfo.xml delete mode 100644 doc/telemetry-docinfo.xml delete mode 100644 doc/titlepage.templates.tmpl (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore index 27a951c4..89b762b3 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,8 +1,5 @@ *.html *.pdf -*.fo *.raw *.adoc -titlepage.templates.xsl -fop-cfg.xml map-loading.svg diff --git a/doc/Makefile.am b/doc/Makefile.am index b5839bea..f7ba9647 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -271,13 +271,13 @@ all: $(HTML) $(PDF) map-loading.adoc: $(MAP_SVG_FILES) -altusmetrum.pdf altusmetrum.html: altusmetrum-docinfo.xml $(ADOC_FILES) $(IMAGES) +altusmetrum.pdf altusmetrum.html: $(ADOC_FILES) $(IMAGES) -telegps.html telegps.pdf: telegps-docinfo.xml $(TELEGPS_ADOC_FILES) $(IMAGES) +telegps.html telegps.pdf: $(TELEGPS_ADOC_FILES) $(IMAGES) -micropeak.pdf micropeak.html: micropeak-docinfo.xml $(MICROPEAK_ADOC_FILES) $(IMAGES) +micropeak.pdf micropeak.html: $(MICROPEAK_ADOC_FILES) $(IMAGES) -easymini.pdf easymini.html: easymini-docinfo.xml $(EASYMINI_ADOC_FILES) $(IMAGES) +easymini.pdf easymini.html: $(EASYMINI_ADOC_FILES) $(IMAGES) telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg diff --git a/doc/altos-docinfo.xml b/doc/altos-docinfo.xml deleted file mode 100644 index b9193a8f..00000000 --- a/doc/altos-docinfo.xml +++ /dev/null @@ -1,33 +0,0 @@ -Altos Metrum Operating System - - Keith - Packard - keithp@keithp.com - -05 November 2012 - - 2012 - Keith Packard - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 1.1 - 05 November 2012 - Portable version - - - 0.1 - 22 November 2010 - Initial content - - diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml deleted file mode 100644 index 18bc644d..00000000 --- a/doc/altusmetrum-docinfo.xml +++ /dev/null @@ -1,289 +0,0 @@ -An Owner's Manual for Altus Metrum Rocketry Electronics - - Bdale - Garbee - bdale@gag.com - - - Keith - Packard - keithp@keithp.com - - - Bob - Finch - - - Anthony - Towns - - - 2018 - Bdale Garbee and Keith Packard - - - - - - - - - - - - - - - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 1.8.7 - 8 Oct 2018 - - Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF - calibration to factory value when reflashing. Fix map images. - Fix Mac OS X support. - - - - 1.8.6 - 6 Aug 2018 - - Various pyro channel configuration updates. - - - - 1.8.5 - 18 Mar 2018 - - Minor ground station software updates. - - - - 1.8.4 - 20 Dec 2017 - - Support EasyMini v2.0 hardware. - - - - 1.8.3 - 11 Dec 2017 - - Support TeleMega v3.0 hardware. Fix one firmware bug affecting - all flight computers and another two affecting TeleMega and - EasyMega. Several new AltosUI graphing features. - - - - 1.8.2 - 18 Sep 2017 - - Support TeleGPS v2.0 hardware. Add accelerometer recalibration - UI. - - - - 1.8.1 - 27 Aug 2017 - - Fix Apogee Lockout time value wrapping bug. Change high-speed - Kalman filter function. - - - - 1.8 - 12 Aug 2017 - - Add support for TeleBT v4.0, updates in data analysis code - - - - 1.7 - 21 Apr 2017 - - Add support for TeleMini v3.0 in firmware, AltosUI and AltosDroid - - - - 1.6.8 - 4 Sep 2016 - - Minor release fixing another TeleMega and TeleMetrum v2.0 bug - which could result in loss of data logging and telemetry in - flight. Also fixed an AltosUI bug which would hide some pad - status values and never show them again. - - - - 1.6.5 - 8 Jul 2016 - - Minor release fixing TeleMega and TeleMetrum v2.0 bug which - would often result in loss of data logging and telemetry in - flight. Thanks to Chuck Haskin for help characterizing the bug - and testing this release. - - - - 1.6.4 - 10 May 2016 - - Minor release fixing TeleBT v1.0 flow control and a few minor - application bugs. - - - - 1.6.3 - 21 April 2016 - - Minor release adding idle mode to AltosDroid and fixing various - host software bugs. - - - - 1.6.2 - 10 January 2016 - - Minor release adding TeleMega v2.0 support. - - - - 1.6.1 - 15 July 2015 - - Minor release adding TeleBT v3.0 support. - - - - 1.6 - 8 January 2015 - - Major release adding TeleDongle v3.0 support. - - - - 1.5 - 6 September 2014 - - Major release adding EasyMega support. - - - - 1.4.2 - 17 August 2014 - - Minor release fixing some Windows installation bugs. - - - - 1.4.1 - 20 June 2014 - - Minor release fixing some installation bugs. - - - - 1.4 - 15 June 2014 - - Major release adding TeleGPS support. - - - - 1.3.2 - 24 January 2014 - - Bug fixes for TeleMega and AltosUI. - - - - 1.3.1 - 21 January 2014 - - Bug fixes for TeleMega and TeleMetrum v2.0 along with a few - small UI improvements. - - - - 1.3 - 12 November 2013 - - Updated for software version 1.3. Version 1.3 adds support - for TeleMega, TeleMetrum v2.0 and EasyMini - and fixes bugs in AltosUI and the AltOS firmware. - - - - 1.2.1 - 21 May 2013 - - Updated for software version 1.2. Version 1.2 adds support - for TeleBT and AltosDroid. It also adds a few minor features - and fixes bugs in AltosUI and the AltOS firmware. - - - - 1.2 - 18 April 2013 - - Updated for software version 1.2. Version 1.2 adds support - for MicroPeak and the MicroPeak USB interface. - - - - 1.1.1 - 16 September 2012 - - Updated for software version 1.1.1 Version 1.1.1 fixes a few - bugs found in version 1.1. - - - - 1.1 - 13 September 2012 - - Updated for software version 1.1. Version 1.1 has new - features but is otherwise compatible with version 1.0. - - - - 1.0 - 24 August 2011 - - Updated for software version 1.0. Note that 1.0 represents a - telemetry format change, meaning both ends of a link - (TeleMetrum/TeleMini and TeleDongle) must be updated or - communications will fail. - - - - 0.9 - 18 January 2011 - - Updated for software version 0.9. Note that 0.9 represents a - telemetry format change, meaning both ends of a link (TeleMetrum and - TeleDongle) must be updated or communications will fail. - - - - 0.8 - 24 November 2010 - Updated for software version 0.8 - - - 0.7.1 - 29 September 2010 - Added AltosUI - - diff --git a/doc/am-fo.xsl b/doc/am-fo.xsl deleted file mode 100644 index 605339d4..00000000 --- a/doc/am-fo.xsl +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - - - - - - - - - - -false - -left - - - - -11 - - pt - - - - - -10 1 1 - - - - - - - - - - - - - - - - - - - - - - - - - 0pt - 0pt - 1pc - - - - - -1pc - 0pt - 0pt - - - - - - 0.75in - 0.75in - - - - - 0.5in - 0.5in - - - - - - - - - - - - - - - - -0.5pt -#78079a -0.5pt -0.5pt -#78079a - - - - - - pt - - - - - - - pt - - - - - - - pt - - - - - - - pt - - - - - - - pt - - - - - 11pt - bold - center - - - - 11pt - bold - center - - - - 0.5pt solid #78079a - 50% - - - - 0.5pt solid #78079a - 11pt - 2pt - - - - 11pt - - - - normal - #78079a - - - - normal - #78079a - - - - normal - #ff4040 - - - - normal - #78079a - - - - solid - 1pt - silver - #ffffee - 12pt - 12pt - 6pt - 6pt - 0pt - 12pt - 6pt - 6pt - - - - - - - - #ffffff - inherit - - - - - - - auto - - - diff --git a/doc/am-html.xsl b/doc/am-html.xsl deleted file mode 100644 index cdfe27f8..00000000 --- a/doc/am-html.xsl +++ /dev/null @@ -1,14 +0,0 @@ - - - - - diff --git a/doc/common.xsl b/doc/common.xsl deleted file mode 100644 index 94b120af..00000000 --- a/doc/common.xsl +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - - - 1 - 0 - - - - - - -images/icons/ -0 - - - - 0 - #E0E0E0 - - - -images/icons/ - - - margin-left: 0; margin-right: 10%; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 12pt - bold - center - - - - 0.5pt solid #78079a - 50% - - - - 0.5pt solid #78079a - 12pt - 2pt - - - - - - - - - - - - -article toc,title -book toc,title,figure,table,example,equation - - -chapter toc,title -part toc,title -preface toc,title -qandadiv toc -qandaset toc -reference toc,title -sect1 toc -sect2 toc -sect3 toc -sect4 toc -sect5 toc -section toc -set toc,title - - - -article nop -book nop - - - - - diff --git a/doc/companion-docinfo.xml b/doc/companion-docinfo.xml deleted file mode 100644 index 243bded0..00000000 --- a/doc/companion-docinfo.xml +++ /dev/null @@ -1,28 +0,0 @@ -Protocol Definitions - - Keith - Packard - keithp@keithp.com - -13 January 2012 - - 2012 - Keith Packard - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 0.1 - 13 January 2012 - Initial content - - diff --git a/doc/easymini-docinfo.xml b/doc/easymini-docinfo.xml deleted file mode 100644 index 85baba1e..00000000 --- a/doc/easymini-docinfo.xml +++ /dev/null @@ -1,62 +0,0 @@ -A Dual-Deploy Rocketry Flight Computer - - Bdale - Garbee - bdale@gag.com - - - Keith - Packard - keithp@keithp.com - - - 2016 - Bdale Garbee and Keith Packard - - - - - - - - - - - - - - - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 1.8.4 - 20 Dec 2017 - - Support EasyMini v2.0 hardware. - - - - 1.6.3 - 21 April 2016 - - Minor release fixing various host software bugs. - - - - 1.6.2 - 10 January 2016 - - First release of separate EasyMini doc - - - diff --git a/doc/footer.templates.xsl b/doc/footer.templates.xsl deleted file mode 100644 index 3484c0eb..00000000 --- a/doc/footer.templates.xsl +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/fop.xconf b/doc/fop.xconf deleted file mode 100644 index 9ac42820..00000000 --- a/doc/fop.xconf +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - - - . - - - 72 - - 72 - - - - - - - - - - - flate - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/micropeak-docinfo.xml b/doc/micropeak-docinfo.xml deleted file mode 100644 index 6fab12b8..00000000 --- a/doc/micropeak-docinfo.xml +++ /dev/null @@ -1,90 +0,0 @@ -A recording altimeter for hobby rocketry - - Keith - Packard - keithp@keithp.com - - - 2018 - Keith Packard - - - - - - - - - - - - - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 1.8.7 - 8 October 2018 - - Poll for MicroPeak USB while the device dialog is open. Fix Mac OS X support. - - - - 1.8.6 - 6 August 2018 - - Report altimeter-recorded maximum height value - - - - 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. - - - diff --git a/doc/telegps-docinfo.xml b/doc/telegps-docinfo.xml deleted file mode 100644 index 4d3533de..00000000 --- a/doc/telegps-docinfo.xml +++ /dev/null @@ -1,107 +0,0 @@ -An Owner's Manual for the TeleGPS recording GPS tracker - - Bdale - Garbee - bdale@gag.com - - - Keith - Packard - keithp@keithp.com - - - 2018 - Bdale Garbee and Keith Packard - - - - - - - - - - - - - - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 1.8.7 - 08 Oct 2018 - - Fix TeleBT v4.0 RF calibration to factory value when - reflashing. Fix map images. Fix Mac OS X support. - - - - 1.8.3 - 11 Dec 2017 - - New graphing features. Improve reliability of data - download. Update KML export to satisfy Tripoli Records board - requirements. - - - - 1.6.4 - 10 May 2016 - - Minor release fixing TeleBT v1.0 flow control and a few minor - application bugs. - - - - 1.6.1 - 15 July 2015 - - Minor release adding TeleBT v3.0 support. - - - - 1.6 - 8 January 2015 - - Major release adding TeleDongle v3.0 support. - - - - 1.5 - 6 September 2014 - - Major release adding EasyMega support. - - - - 1.4.2 - 17 August 2014 - - Minor release fixing some Windows installation bugs. - - - - 1.4.1 - 20 June 2014 - - Minor release fixing some installation bugs. - - - - 1.4 - 15 June 2014 - - Initial version - - - diff --git a/doc/telemetry-docinfo.xml b/doc/telemetry-docinfo.xml deleted file mode 100644 index 19f90ca4..00000000 --- a/doc/telemetry-docinfo.xml +++ /dev/null @@ -1,28 +0,0 @@ -Packet Definitions - - Keith - Packard - keithp@keithp.com - -1 July 2011 - - 2011 - Keith Packard - - - - This document is released under the terms of the - - Creative Commons ShareAlike 3.0 - - license. - - - - - - 0.1 - 1 July 2011 - Initial content - - diff --git a/doc/titlepage.templates.tmpl b/doc/titlepage.templates.tmpl deleted file mode 100644 index f437fb76..00000000 --- a/doc/titlepage.templates.tmpl +++ /dev/null @@ -1,1587 +0,0 @@ - - - - - - - - - - - - -]> - - - - - - - - - - - - - - - <subtitle/> - - <date/> - - <corpauthor space-before="0.5em" - font-size="&hsize2;"/> - <authorgroup space-before="0.5em" - font-size="&hsize2;"/> - <author space-before="0.5em" - font-size="&hsize2;"/> - - <!-- If you add editor, include this t:predicate attribute - because only the first editor generates the list of editors. - <editor t:predicate="[position() = 1]"/> - --> - <othercredit space-before="0.15in"/> - <releaseinfo space-before="0.15in"/> - <copyright space-before="0.15in"/> - <legalnotice text-align="start" - margin-left="0.5in" - margin-right="0.5in" - font-family="{$body.fontset}"/> - <pubdate space-before="0.15in"/> - <revision space-before="0.15in"/> - <revhistory space-before="0.15in"/> - <abstract space-before="0.15in" - text-align="start" - margin-left="0.5in" - margin-right="0.5in" - font-family="{$body.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="set" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:named-template="division.title" - param:node="ancestor-or-self::set[1]" - text-align="center" - font-size="&hsize5;" - space-before="&hsize5space;" - font-weight="bold" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}" - text-align="center"/> - <corpauthor space-before="0.25in"/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<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 - t:named-template="book.verso.title" - font-size="&hsize2;" - font-weight="bold" - font-family="{$title.fontset}"/> - <authorgroup t:named-template="verso.authorgroup"/> - <author/> - <!-- If you add editor, include this t:predicate attribute - because only the first editor generates the list of editors. - <editor t:predicate="[position() = 1]"/> - --> - <othercredit/> - <releaseinfo space-before="0.15in"/> - <pubdate space-before="1em"/> - <copyright/> - <abstract/> - <legalnotice font-size="8pt"/> - <corpauthor text-align="center" space-before="0.5in"/> - <revhistory space-before="0.5in"/> - </t:titlepage-content> - - <t:titlepage-separator> - <fo:block break-after="page"/> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - <fo:block break-after="page"/> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="part" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:named-template="division.title" - param:node="ancestor-or-self::part[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-weight='bold' - font-style='italic' - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="partintro" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - text-align="center" - font-size="&hsize5;" - font-weight="bold" - space-before="1em" - font-family="{$title.fontset}"/> - <subtitle - text-align="center" - font-size="&hsize2;" - font-weight="bold" - font-style="italic" - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="reference" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:named-template="division.title" - param:node="ancestor-or-self::reference[1]" - text-align="center" - font-size="&hsize5;" - space-before="&hsize5space;" - font-weight="bold" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}" - text-align="center"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="refsynopsisdiv" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="refsection" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="refsect1" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="refsect2" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="refsect3" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="dedication" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::dedication[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<!-- Same formatting as dedication --> - <t:titlepage t:element="acknowledgements" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::acknowledgements[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - - -<!-- ==================================================================== --> - - <t:titlepage t:element="preface" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::preface[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="chapter" t:wrapper="fo:block" - font-family="{$title.fontset}"> - <t:titlepage-content t:side="recto" margin-left="{$title.margin.left}"> - <title t:named-template="component.title" - param:node="ancestor-or-self::chapter[1]" - font-size="&hsize5;" - font-weight="bold"/> - - <subtitle space-before="0.5em" - font-style="italic" - font-size="&hsize2;" - font-weight="bold"/> - - <corpauthor space-before="0.5em" - space-after="0.5em" - font-size="&hsize2;"/> - - <authorgroup space-before="0.5em" - space-after="0.5em" - font-size="&hsize2;"/> - - <author space-before="0.5em" - space-after="0.5em" - font-size="&hsize2;"/> - - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="appendix" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:named-template="component.title" - param:node="ancestor-or-self::appendix[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-weight="bold" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - -<t:titlepage t:element="section" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="sect1" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="sect2" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="sect3" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="sect4" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="sect5" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="simplesect" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - margin-left="{$title.margin.left}" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup/> - <author/> - <othercredit/> - <releaseinfo/> - <copyright/> - <legalnotice/> - <pubdate/> - <revision/> - <revhistory/> - <abstract/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<t:titlepage t:element="topic" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-weight="bold" - font-size="&hsize3;" - space-before="1em" - space-after="1em" - font-family="{$title.fontset}"/> - <subtitle - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="bibliography" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::bibliography[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="bibliodiv" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title t:named-template="component.title" - param:node="ancestor-or-self::bibliodiv[1]" - margin-left="{$title.margin.left}" - font-size="&hsize4;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="glossary" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::glossary[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="glossdiv" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title t:named-template="component.title" - param:node="ancestor-or-self::glossdiv[1]" - margin-left="{$title.margin.left}" - font-size="&hsize4;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="index" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::index[1]" - param:pagewide="1" - margin-left="0pt" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <!-- The indexdiv.title template is used so that manual and --> - <!-- automatically generated indexdiv titles get the same --> - <!-- formatting. --> - - <t:titlepage t:element="indexdiv" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title t:force="1" - t:named-template="indexdiv.title" - param:title="title"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="setindex" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::setindex[1]" - param:pagewide="1" - margin-left="0pt" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="colophon" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="component.title" - param:node="ancestor-or-self::colophon[1]" - margin-left="{$title.margin.left}" - font-size="&hsize5;" - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="sidebar" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - font-family="{$title.fontset}" - font-weight="bold"/> - <subtitle - font-family="{$title.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> -<t:titlepage t:element="qandaset" t:wrapper="fo:block" - font-family="{$title.fontset}"> - - <t:titlepage-content t:side="recto" - start-indent="0pt" - text-align="center"> - - <title t:named-template="component.title" - param:node="ancestor-or-self::qandaset[1]" - keep-with-next.within-column="always" - font-size="&hsize5;" - font-weight="bold"/> - - <subtitle/> - - <corpauthor space-before="0.5em" - font-size="&hsize2;"/> - <authorgroup space-before="0.5em" - font-size="&hsize2;"/> - <author space-before="0.5em" - font-size="&hsize2;"/> - - <othercredit space-before="0.5em"/> - <releaseinfo space-before="0.5em"/> - <copyright space-before="0.5em"/> - <legalnotice text-align="start" - margin-left="0.5in" - margin-right="0.5in" - font-family="{$body.fontset}"/> - <pubdate space-before="0.5em"/> - <revision space-before="0.5em"/> - <revhistory space-before="0.5em"/> - <abstract space-before="0.5em" - text-align="start" - margin-left="0.5in" - margin-right="0.5in" - font-family="{$body.fontset}"/> - <itermset/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> -</t:titlepage> - -<!-- ==================================================================== --> - - <t:titlepage t:element="table.of.contents" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'TableofContents'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.tables" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofTables'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.figures" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofFigures'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.examples" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofExamples'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.equations" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofEquations'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.procedures" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofProcedures'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="list.of.unknowns" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofUnknown'" - space-before.minimum="1em" - space-before.optimum="1.5em" - space-before.maximum="2em" - space-after="0.5em" - start-indent="0pt" - font-size="&hsize3;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.tables" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofTables'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.figures" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofFigures'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.examples" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofExamples'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.equations" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofEquations'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.procedures" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofProcedures'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - - <t:titlepage t:element="component.list.of.unknowns" t:wrapper="fo:block"> - <t:titlepage-content t:side="recto"> - <title - t:force="1" - t:named-template="gentext" - param:key="'ListofUnknown'" - space-before.minimum="1em" - space-before.optimum="1em" - space-before.maximum="1em" - space-after="0.5em" - margin-left="{$title.margin.left}" - font-size="&hsize1;" - font-weight="bold" - font-family="{$title.fontset}"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - </t:titlepage-content> - - <t:titlepage-separator> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - </t:titlepage-before> - </t:titlepage> - -<!-- ==================================================================== --> - -</t:templates> -- cgit v1.2.3 From e9a3268285e97b7316c3321892e77814703ff71d Mon Sep 17 00:00:00 2001 From: Keith Packard <keithp@keithp.com> Date: Thu, 1 Nov 2018 19:40:31 -0700 Subject: doc: Use icons for admonitions This replaces the text 'WARNING' or 'NOTE' with a suitable icon instead. Signed-off-by: Keith Packard <keithp@keithp.com> --- doc/Makefile.am | 18 ++++++++++-- doc/altusmetrum.txt | 3 ++ doc/am-notoc.css | 10 +++++++ doc/am.css | 10 +++++++ doc/images/icons/caution.svg | 58 +++++++++++++++++++++++++++++++++++++ doc/images/icons/important.svg | 57 ++++++++++++++++++++++++++++++++++++ doc/images/icons/note.svg | 57 ++++++++++++++++++++++++++++++++++++ doc/images/icons/tip.svg | 57 ++++++++++++++++++++++++++++++++++++ doc/images/icons/warning.svg | 65 ++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 332 insertions(+), 3 deletions(-) create mode 100644 doc/images/icons/caution.svg create mode 100644 doc/images/icons/important.svg create mode 100644 doc/images/icons/note.svg create mode 100644 doc/images/icons/tip.svg create mode 100644 doc/images/icons/warning.svg (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index f7ba9647..404feab3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -243,6 +243,13 @@ FONTS=\ fonts/OpenSans-Semibold.ttf \ fonts/OpenSans-SemiboldItalic.ttf +ICONS=\ + images/icons/caution.svg \ + images/icons/important.svg \ + images/icons/note.svg \ + images/icons/tip.svg \ + images/icons/warning.svg + PDF_CONFIG_FILES=altusmetrum-theme.yml HTML_CONFIG_FILES= @@ -287,20 +294,25 @@ install: all WEB_ROOT=/home/bdale/web/ -publish: $(PUBLISH_DOC) $(FONTS) - cp $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/ +publish: $(PUBLISH_DOC) $(FONTS) $(ICONS) + cp -a $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/ mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ + mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/ + cp $(ICONS) $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/ (cd $(WEB_ROOT)/altusmetrum ; \ git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \ git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ + git add $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/* ;\ echo "update docs" | \ - git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ + git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons ; \ git push) publish-keithp: am.html $(DOC) $(FONTS) + ssh keithp.com 'mkdir -p ~keithp/public_html/altos/fonts ~keithp/public_html/altos/images/icons' scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts + scp -p $(ICONS) keithp.com:~keithp/public_html/altos/images/icons clean: rm -f am.html $(HTML) $(PDF) $(ADOC_FILES) $(TELEGPS_ADOC_FILES) $(MICROPEAK_ADOC_FILES) diff --git a/doc/altusmetrum.txt b/doc/altusmetrum.txt index 798301d2..85391e79 100644 --- a/doc/altusmetrum.txt +++ b/doc/altusmetrum.txt @@ -3,6 +3,8 @@ Keith Packard <keithp@keithp.com>; Bdale Garbee <bdale@gag.com>; Bob Finch; Anth :title-logo-image: image:../themes/background.png[] :revnumber: v1.8.7 :revdate: 8 Oct 2018 +:icons: +:icontype: svg :revremark: Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF calibration to factory value when reflashing. Fix map images. Fix Mac OS X support. :copyright: Bdale Garbee and Keith Packard 2018 :doctype: book @@ -63,3 +65,4 @@ Keith Packard <keithp@keithp.com>; Bdale Garbee <bdale@gag.com>; Bob Finch; Anth include::specs.adoc[] include::release-notes.adoc[] + diff --git a/doc/am-notoc.css b/doc/am-notoc.css index 6999d478..829e8b72 100644 --- a/doc/am-notoc.css +++ b/doc/am-notoc.css @@ -92,6 +92,16 @@ h1, h2, h3, h4, h5, h6 font-family: "Open Sans",sans-serif; } +td.icon { + width: 4em; + height: 3em; +} + +td.icon img { + height: 100%; + width: 100% +} + div.toc { display:none; } diff --git a/doc/am.css b/doc/am.css index 56daface..ccb50ffe 100644 --- a/doc/am.css +++ b/doc/am.css @@ -127,6 +127,16 @@ div#logo img { border-bottom: 2px solid #808080; } +td.icon { + width: 4em; + height: 3em; +} + +td.icon img { + height: 100%; + width: 100% +} + div.toc a:link { text-decoration: none; } diff --git a/doc/images/icons/caution.svg b/doc/images/icons/caution.svg new file mode 100644 index 00000000..28babba2 --- /dev/null +++ b/doc/images/icons/caution.svg @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 384 512" + version="1.1" + id="svg4" + sodipodi:docname="caution.svg" + inkscape:version="0.92.3 (2405546, 2018-03-11)"> + <metadata + id="metadata10"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs8" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1574" + inkscape:window-height="1186" + id="namedview6" + showgrid="false" + inkscape:zoom="1.592106" + inkscape:cx="193.80909" + inkscape:cy="256" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="0" + inkscape:current-layer="svg4" /> + <path + d="M216 23.858c0-23.802-30.653-32.765-44.149-13.038C48 191.851 224 200 224 288c0 35.629-29.114 64.458-64.85 63.994C123.98 351.538 96 322.22 96 287.046v-85.51c0-21.703-26.471-32.225-41.432-16.504C27.801 213.158 0 261.332 0 320c0 105.869 86.131 192 192 192s192-86.131 192-192c0-170.29-168-193.003-168-296.142z" + id="path2" + style="fill:#bf3400;fill-opacity:1" /> +</svg> +<!-- +Font Awesome Free 5.4.2 by @fontawesome - https://fontawesome.com +License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +--> + diff --git a/doc/images/icons/important.svg b/doc/images/icons/important.svg new file mode 100644 index 00000000..4c5baae0 --- /dev/null +++ b/doc/images/icons/important.svg @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 512 512" + version="1.1" + id="svg4" + sodipodi:docname="important.svg" + inkscape:version="0.92.3 (2405546, 2018-03-11)"> + <metadata + id="metadata10"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs8" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="944" + inkscape:window-height="866" + id="namedview6" + showgrid="false" + inkscape:zoom="0.4609375" + inkscape:cx="378.57627" + inkscape:cy="256" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="0" + inkscape:current-layer="svg4" /> + <path + d="M504 256c0 136.997-111.043 248-248 248S8 392.997 8 256C8 119.083 119.043 8 256 8s248 111.083 248 248zm-248 50c-25.405 0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346l7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373 0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884 0-12.356 5.78-11.981 12.654z" + id="path2" + style="fill:#bf0000;fill-opacity:1" /> +</svg> +<!-- +Font Awesome Free 5.4.2 by @fontawesome - https://fontawesome.com +License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +--> + diff --git a/doc/images/icons/note.svg b/doc/images/icons/note.svg new file mode 100644 index 00000000..92f636cf --- /dev/null +++ b/doc/images/icons/note.svg @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 512 512" + version="1.1" + id="svg4" + sodipodi:docname="note.svg" + inkscape:version="0.92.3 (2405546, 2018-03-11)"> + <metadata + id="metadata10"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs8" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1737" + inkscape:window-height="1219" + id="namedview6" + showgrid="false" + inkscape:zoom="1.8527527" + inkscape:cx="257.55137" + inkscape:cy="256" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="0" + inkscape:current-layer="svg4" /> + <path + d="M256 8C119.043 8 8 119.083 8 256c0 136.997 111.043 248 248 248s248-111.003 248-248C504 119.083 392.957 8 256 8zm0 110c23.196 0 42 18.804 42 42s-18.804 42-42 42-42-18.804-42-42 18.804-42 42-42zm56 254c0 6.627-5.373 12-12 12h-88c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h12v-64h-12c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h64c6.627 0 12 5.373 12 12v100h12c6.627 0 12 5.373 12 12v24z" + id="path2" + style="fill:#19407c;fill-opacity:1" /> +</svg> +<!-- +Font Awesome Free 5.4.2 by @fontawesome - https://fontawesome.com +License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +--> + diff --git a/doc/images/icons/tip.svg b/doc/images/icons/tip.svg new file mode 100644 index 00000000..f645f63b --- /dev/null +++ b/doc/images/icons/tip.svg @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 352 512" + version="1.1" + id="svg4" + sodipodi:docname="tip.svg" + inkscape:version="0.92.3 (2405546, 2018-03-11)"> + <metadata + id="metadata10"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs8" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1737" + inkscape:window-height="1304" + id="namedview6" + showgrid="false" + inkscape:zoom="2.0057983" + inkscape:cx="175.98644" + inkscape:cy="256" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="0" + inkscape:current-layer="svg4" /> + <path + d="M96.06 454.35c.01 6.29 1.87 12.45 5.36 17.69l17.09 25.69a31.99 31.99 0 0 0 26.64 14.28h61.71a31.99 31.99 0 0 0 26.64-14.28l17.09-25.69a31.989 31.989 0 0 0 5.36-17.69l.04-38.35H96.01l.05 38.35zM0 176c0 44.37 16.45 84.85 43.56 115.78 16.52 18.85 42.36 58.23 52.21 91.45.04.26.07.52.11.78h160.24c.04-.26.07-.51.11-.78 9.85-33.22 35.69-72.6 52.21-91.45C335.55 260.85 352 220.37 352 176 352 78.61 272.91-.3 175.45 0 73.44.31 0 82.97 0 176zm176-80c-44.11 0-80 35.89-80 80 0 8.84-7.16 16-16 16s-16-7.16-16-16c0-61.76 50.24-112 112-112 8.84 0 16 7.16 16 16s-7.16 16-16 16z" + id="path2" + style="fill:#dfd000;fill-opacity:1" /> +</svg> +<!-- +Font Awesome Free 5.4.2 by @fontawesome - https://fontawesome.com +License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +--> + diff --git a/doc/images/icons/warning.svg b/doc/images/icons/warning.svg new file mode 100644 index 00000000..938d7b31 --- /dev/null +++ b/doc/images/icons/warning.svg @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 576.00019 512" + version="1.1" + id="svg4" + sodipodi:docname="warning.svg" + width="576.00018" + height="512" + inkscape:version="0.92.3 (2405546, 2018-03-11)"> + <metadata + id="metadata10"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs8" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="2557" + inkscape:window-height="1544" + id="namedview6" + showgrid="false" + fit-margin-top="0" + fit-margin-left="0" + fit-margin-right="0" + fit-margin-bottom="0" + inkscape:zoom="2.4379272" + inkscape:cx="170.99331" + inkscape:cy="256" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="0" + inkscape:current-layer="svg4" /> + <path + d="m 569.51729,440.013 c 18.458,31.994 -4.711,71.987 -41.577,71.987 H 48.054283 C 11.117287,512 -11.944713,471.945 6.4772867,440.013 L 246.42329,23.985005 c 18.467,-32.0090001 64.72,-31.9510001 83.154,0 z M 288.00029,354 c -25.405,0 -46,20.595 -46,46 0,25.405 20.595,46 46,46 25.405,0 46,-20.595 46,-46 0,-25.405 -20.595,-46 -46,-46 z m -43.673,-165.346 7.418,136 c 0.347,6.364 5.609,11.346 11.982,11.346 h 48.546 c 6.373,0 11.635,-4.982 11.982,-11.346 l 7.418,-136 c 0.375,-6.874 -5.098,-12.654 -11.982,-12.654 h -63.383 c -6.884,0 -12.356,5.78 -11.981,12.654 z" + id="path2" + style="fill:#bf6900;fill-opacity:1" + inkscape:connector-curvature="0" /> +</svg> +<!-- +Font Awesome Free 5.4.2 by @fontawesome - https://fontawesome.com +License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) +--> + -- cgit v1.2.3 From 58fb7e53989f67fe8d793d7b3ddad8e41682cfbe Mon Sep 17 00:00:00 2001 From: Keith Packard <keithp@keithp.com> Date: Mon, 31 Dec 2018 15:18:08 -0800 Subject: doc: Update doc/RELNOTES to adapt to asciidoctor change Moving to asciidoctor means changing our doc release process Signed-off-by: Keith Packard <keithp@keithp.com> --- doc/RELNOTES | 24 ++---------------------- 1 file changed, 2 insertions(+), 22 deletions(-) (limited to 'doc') diff --git a/doc/RELNOTES b/doc/RELNOTES index 678ac17e..db81297c 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -3,9 +3,8 @@ Creating documentation for a new release of AltOS * Write release notes in release-notes-${version}.inc. Add to Makefile -* Make sure that doc/altusmetrum-docinfo.xml has the right copyright - year, and add release to the revision history at the front (release - notes will be pulled in by release-notes.inc) +* Make sure that doc/altusmetrum.txt has the right copyright + year * Add references to that as appropriate from each of the documents: @@ -14,25 +13,6 @@ Creating documentation for a new release of AltOS easymini-release-notes.inc telegps-release-notes.inc -* Update date and add docinfo short release info for each document as - appropriate - - altusmetrum-docinfo.xml - companion-docinfo.xml - easymini-docinfo.xml - micropeak-docinfo.xml - telegps-docinfo.xml - telemetry-docinfo.xml - -* Update copyright year as appropriate - - altusmetrum-docinfo.xml - companion-docinfo.xml - easymini-docinfo.xml - micropeak-docinfo.xml - telegps-docinfo.xml - telemetry-docinfo.xml - * Add release-notes-${version}.inc to git * Make sure new hardware specs are documented in specs.inc -- cgit v1.2.3 From ec8df548e3f6fd5d809238e2e60a0844775f551a Mon Sep 17 00:00:00 2001 From: Keith Packard <keithp@keithp.com> Date: Mon, 31 Dec 2018 15:17:20 -0800 Subject: doc: Add EasyMega v2.0 specs Signed-off-by: Keith Packard <keithp@keithp.com> --- doc/specs.inc | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc') diff --git a/doc/specs.inc b/doc/specs.inc index 89c21307..48d73f96 100644 --- a/doc/specs.inc +++ b/doc/specs.inc @@ -125,6 +125,15 @@ |8MB |- |3.7V + + |EasyMega v2.0 + |MS5607 30km (100k') + |ADXL375 200g + |- + |MPU9250 + |8MB + |- + |3.7V endif::easymega[] |=== -- cgit v1.2.3 From f9fdbfade5e2d203d2ca5378e4f2a65beae4a19f Mon Sep 17 00:00:00 2001 From: Keith Packard <keithp@keithp.com> Date: Mon, 31 Dec 2018 15:17:42 -0800 Subject: doc: Set doc version to 1.9 Signed-off-by: Keith Packard <keithp@keithp.com> --- doc/altusmetrum.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/altusmetrum.txt b/doc/altusmetrum.txt index 85391e79..17b2a53f 100644 --- a/doc/altusmetrum.txt +++ b/doc/altusmetrum.txt @@ -1,11 +1,11 @@ = The Altus Metrum System: An Owner's Manual for Altus Metrum Rocketry Electronics Keith Packard <keithp@keithp.com>; Bdale Garbee <bdale@gag.com>; Bob Finch; Anthony Towns :title-logo-image: image:../themes/background.png[] -:revnumber: v1.8.7 -:revdate: 8 Oct 2018 +:revnumber: v1.9 +:revdate: 31 Dec 2018 :icons: :icontype: svg -:revremark: Include TeleMega v3.0 firmware in release. Fix TeleBT v4.0 RF calibration to factory value when reflashing. Fix map images. Fix Mac OS X support. +:revremark: Add EasyMega v2.0 support :copyright: Bdale Garbee and Keith Packard 2018 :doctype: book :numbered: -- cgit v1.2.3 From bed019b64d9e37f276ad5aa2dabb7681aae122ec Mon Sep 17 00:00:00 2001 From: Keith Packard <keithp@keithp.com> Date: Mon, 31 Dec 2018 15:17:01 -0800 Subject: doc: Add 1.9 release notes Signed-off-by: Keith Packard <keithp@keithp.com> --- doc/Makefile.am | 1 + doc/release-notes-1.9.inc | 20 ++++++++++++++++++++ doc/release-notes.inc | 4 ++++ 3 files changed, 25 insertions(+) create mode 100644 doc/release-notes-1.9.inc (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 404feab3..67033e8b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -17,6 +17,7 @@ FAKETIME=TZ=UTC faketime -f '$(RELEASE_DATE) 00:00:00 i0' endif RELNOTES_INC=\ + release-notes-1.9.inc \ release-notes-1.8.7.inc \ release-notes-1.8.6.inc \ release-notes-1.8.5.inc \ diff --git a/doc/release-notes-1.9.inc b/doc/release-notes-1.9.inc new file mode 100644 index 00000000..db538536 --- /dev/null +++ b/doc/release-notes-1.9.inc @@ -0,0 +1,20 @@ += Release Notes for Version 1.9 +include::release-head.adoc[] +:doctype: article + + Version 1.9 + + == AltOS + + * Add support for EasyMega v2.0 + + * Replace C library for ARM devices + + * Remove support for 8051-based devices and SDCC compiler + + == AltosUI, TeleGPS, MicroPeak + + * Select ROM images based on product name when reflashing + + * Fix TeleGPS v2 battery voltage display + diff --git a/doc/release-notes.inc b/doc/release-notes.inc index a1dc6720..3ff1942b 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,5 +1,9 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.9.adoc[] + + <<<< :leveloffset: 2 include::release-notes-1.8.7.adoc[] -- cgit v1.2.3