Merge PR #991

docs/signs.rst

@@ -147,10 +147,12 @@ Here is a more complex example where not every marker of a certain id has a cert
                         'y':85,
                         'z':-234,
                         'name':'Bar'}],
-        'markers': [dict(name="Towns", filterFunction=townFilter, icon="town.png")],
+        'markers': [dict(name="Towns", filterFunction=townFilter, icon="icons/marker_town.png")],
         ### Note: The 'icon' parameter allows you to specify a custom icon, as per
         ###       standard markers. This icon must exist in the same folder as your
         ###       custom webassets or in the same folder as the generated index.html
+        ###       in this case, we use the marker_town.png icon which comes with
+        ###       the Overviewer by default, located in a subdirectory of web_assets.
     }
     
 
@@ -235,3 +237,12 @@ Predefined Filter Functions
 
 TODO write some filter functions, then document them here
 
+Marker Icons Overviewer ships by default
+========================================
+
+Overviewer comes with multiple small icons that you can use for your markers.
+You can find them in the ``overviewer_core/data/web_assets/icons`` directory.
+
+If you want to make your own in the same style, you can use the provided
+``marker_base_plain.svg`` and ``marker_base_plain_red.svg`` as template, with
+a vector editing software such as `Inkscape <http://inkscape.org>`_.

overviewer_core/data/web_assets/icons/marker_base_plain.svg

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<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"
+     version="1.1"
+     width="32"
+     height="37"
+     id="svg2">
+    <defs
+         id="defs4">
+        <filter
+             x="-0.25"
+             y="-0.25"
+             width="1.5"
+             height="1.5"
+             id="filter3802">
+            <feGaussianBlur
+                 result="blur"
+                 stdDeviation="2"
+                 in="SourceAlpha"
+                 id="feGaussianBlur3804" />
+            <feColorMatrix
+                 values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0.5 0 "
+                 type="matrix"
+                 result="bluralpha"
+                 id="feColorMatrix3806" />
+            <feOffset
+                 result="offsetBlur"
+                 dy="0"
+                 dx="0"
+                 in="bluralpha"
+                 id="feOffset3808" />
+            <feMerge
+                 id="feMerge3810">
+                <feMergeNode
+                     in="offsetBlur"
+                     id="feMergeNode3812" />
+                <feMergeNode
+                     in="SourceGraphic"
+                     id="feMergeNode3814" />
+            </feMerge>
+        </filter>
+    </defs>
+    <metadata
+         id="metadata7">
+        <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>
+    <g
+         transform="translate(0,-1015.3622)"
+         id="layer1">
+        <path
+             d="m 5.3953731,1018.8294 c -1.0681842,0 -1.928114,0.8381 -1.928114,1.8793 l 0,20.6699 c 0,1.0409 0.8599298,1.879 1.928114,1.879 l 4.3382568,0 5.7843411,5.6373 0.964058,0 5.784341,-5.6373 4.338257,0 c 1.068185,0 1.928114,-0.8381 1.928114,-1.879 l 0,-20.6699 c 0,-1.0412 -0.859929,-1.8793 -1.928114,-1.8793 l -21.2092539,0 z"
+             id="rect2987"
+             style="fill:#6e68e3;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;filter:url(#filter3802)" />
+    </g>
+</svg>

overviewer_core/data/web_assets/icons/marker_base_plain_red.svg

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<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"
+     version="1.1"
+     width="32"
+     height="37"
+     id="svg2">
+    <defs
+         id="defs4">
+        <filter
+             x="-0.25"
+             y="-0.25"
+             width="1.5"
+             height="1.5"
+             id="filter3802">
+            <feGaussianBlur
+                 result="blur"
+                 stdDeviation="2"
+                 in="SourceAlpha"
+                 id="feGaussianBlur3804" />
+            <feColorMatrix
+                 values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0.5 0 "
+                 type="matrix"
+                 result="bluralpha"
+                 id="feColorMatrix3806" />
+            <feOffset
+                 result="offsetBlur"
+                 dy="0"
+                 dx="0"
+                 in="bluralpha"
+                 id="feOffset3808" />
+            <feMerge
+                 id="feMerge3810">
+                <feMergeNode
+                     in="offsetBlur"
+                     id="feMergeNode3812" />
+                <feMergeNode
+                     in="SourceGraphic"
+                     id="feMergeNode3814" />
+            </feMerge>
+        </filter>
+    </defs>
+    <metadata
+         id="metadata7">
+        <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>
+    <g
+         transform="translate(0,-1015.3622)"
+         id="layer1">
+        <path
+             d="m 5.4024076,1018.8378 c -1.0674758,0 -1.926835,0.8375 -1.926835,1.878 l 0,20.6586 c 0,1.0404 0.8593592,1.8781 1.926835,1.8781 l 4.3353787,0 5.7805047,5.6341 0.963418,0 5.780506,-5.6341 4.335377,0 c 1.067477,0 1.926836,-0.8377 1.926836,-1.8781 l 0,-20.6586 c 0,-1.0405 -0.859359,-1.878 -1.926836,-1.878 l -21.1951844,0 z"
+             id="rect2987"
+             style="fill:#de634e;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;filter:url(#filter3802)" />
+    </g>
+</svg>