Skip to content

Home Information - Your home, your data, organized.

Python

Added doc about creating Location SVGs.

Anthony Cassandra1c2f7940e885
diff --git a/docs/graphics/LocationSVG.md b/docs/graphics/LocationSVG.md
new file mode 100644
index 00000000..5c850a32
--- /dev/null
+++ b/docs/graphics/LocationSVG.md
@@ -0,0 +1,73 @@
+<img src="../../src/hi/static/img/hi-logo-w-tagline-197x96.png" alt="Home Information Logo" width="128">
+
+_WORK IN PROGRESS_
+
+# Location SVGs
+
+## Location SVG Guidelines
+
+- For best result use SVG viewbox at least 1200 in each direction and less than 2200.
+- Location image does not have to be square.
+
+## Creating Location SVGs
+
+Create a series of individual SVG files with a single `<path>` tag to represent different types of features. The `<path>` "id" attribute should have one of the following ids to indicate which feature it is:
+
+``` text
+asphalt
+bathtubs
+brick
+ceiling-transitions
+countertops
+dead-space
+door-arcs
+doors
+exterior-walls
+fencing
+fireplaces
+floor-transitions
+foliage
+furniture
+grass
+gravel
+ground
+interior-floors
+interior-walls
+landscape-transitions
+mulch
+pavement
+pavers
+pool-coping
+property-lines
+rock-beds
+secondary-walls
+sheds
+shelves
+sinks
+stairs
+stone-walls
+tiles
+toilets
+utilities
+water
+windows
+wood-decks
+```
+
+If using Gimp, this translates to having a "Path" layer with the given name, then using the "Export Path" function since Gimp will add the path name as the path id.
+
+With the individual SVG files assembled in a directory, run the following command to combine and format them into a single SVG suitable for importing.
+
+``` shell
+./tools/combine-svgs.py -i <INPUT_DIR> -o <OUTPUT_FILE>
+```
+
+e.g.,
+
+``` shell
+./tools/combine-svgs.py -i locations/bordeaux/paths -o locations/bordeaux/bordeaux.svg
+./tools/combine-svgs.py -i locations/bordeaux-attic/paths -o locations/bordeaux-attic//bordeaux-attic.svg
+./tools/combine-svgs.py -i locations/default/paths -o locations/default/default.svg
+```
+
+Try to keep the SVG image size on the small side. It will get loaded and manipulated by javascript, so past a certain size there will probably be issues.