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>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f7ba96470c45c80b2869ee6dc735b3f68f13933a..404feab372845a29dd210a93bdc6c1ade5bde2c4 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -243,6 +243,13 @@ FONTS=\
        fonts/OpenSans-Semibold.ttf \
        fonts/OpenSans-SemiboldItalic.ttf
 
        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=
 
 PDF_CONFIG_FILES=altusmetrum-theme.yml
 HTML_CONFIG_FILES=
 


@@ -287,20 +294,25 @@ install:  all
 
 WEB_ROOT=/home/bdale/web/
 
 
 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/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/* ; \
        (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" | \
         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)
         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 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)
 
 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 798301d2a15ebe053e4b8a449a0ccb7223ede96c..85391e7954bd0b9c83e247160c8c248138016fe0 100644 (file)
--- 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
 :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
 :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[]
        include::specs.adoc[]
 
        include::release-notes.adoc[]

+

diff --git a/doc/am-notoc.css b/doc/am-notoc.css
index 6999d4783eeeeba6acdb639474cca6c36946a521..829e8b72d59bba75ae837e748e326005a69701f6 100644 (file)
--- 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;
 }
 
   font-family: "Open Sans",sans-serif;
 }
 

+td.icon {
+    width: 4em;
+    height: 3em;
+}
+
+td.icon img {
+    height: 100%;
+    width: 100%
+}
+

 div.toc {
     display:none;
 }
 div.toc {
     display:none;
 }

diff --git a/doc/am.css b/doc/am.css
index 56daface41da610315c56dbed1c46e57e3298414..ccb50ffede7ed92126c5fda6362f3db641af2831 100644 (file)
--- a/doc/am.css
+++ b/doc/am.css
@@ -127,6 +127,16 @@ div#logo img {
     border-bottom: 2px solid #808080;
 }
 
     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;
 }
 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 (file)
index 0000000..28babba
--- /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 (file)
index 0000000..4c5baae
--- /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 (file)
index 0000000..92f636c
--- /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 (file)
index 0000000..f645f63
--- /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 (file)
index 0000000..938d7b3
--- /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)
+-->
+