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/am.css | 237 ++++++++++++++++++------------------------------------------- 1 file changed, 71 insertions(+), 166 deletions(-) (limited to 'doc/am.css') 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; } -- cgit v1.2.3 From e9a3268285e97b7316c3321892e77814703ff71d Mon Sep 17 00:00:00 2001 From: Keith Packard 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 --- 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/am.css') 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 ; Bdale Garbee ; 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 ; Bdale Garbee ; 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 @@ + + + + + + image/svg+xml + + + + + + + + + + + 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 @@ + + + + + + image/svg+xml + + + + + + + + + + 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 @@ + + + + + + image/svg+xml + + + + + + + + + + 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 @@ + + + + + + image/svg+xml + + + + + + + + + + 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 @@ + + + + + + image/svg+xml + + + + + + + + + + + -- cgit v1.2.3