From: Keith Packard Date: Fri, 2 Nov 2018 02:40:31 +0000 (-0700) Subject: doc: Use icons for admonitions X-Git-Tag: 1.9~14 X-Git-Url: https://git.gag.com/?p=fw%2Faltos;a=commitdiff_plain;h=e9a3268285e97b7316c3321892e77814703ff71d doc: Use icons for admonitions This replaces the text 'WARNING' or 'NOTE' with a suitable icon instead. Signed-off-by: Keith Packard --- 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 + + + + + + + + + + +