#KeyGuideMaker#

This is a collection of KeyGuide components. It includes:

• a line command tool (KeyGuideMaker.py) - see info below on this
• a web front end (you can see a live version of this here)
• a directory of keyguide templates and a syntax for creating them (XML files with SVG)

We also have a directory of ready-compiled, ready-to-print designs that need no tool to get going with. (YET TO BE INCLUDED)

If you want to make templates you will need to read this easy to read guide (YET TO BE WRITTEN! In short - take image, import into ai/inkscape. Resize to correct actual screen size. Draw boxes (0.01mm stroke), Export as SVG. Write brief XML file.)

##Credits##

Simon Judge and Will Wade wrote this with some testing and support from Marie and original designs by Chris. Thanks to Fablab Manchester for helping to cut and trial Simon and Marie's designs.

#KeyGuideMaker.py#

This is a line command tool to combine multiple SVG elements into one. It allows for the most flexibility.

##Installation:##

• Python
• svg_utils

If you want to develop the web front end you will also want to install the line command tools of imagemagick

sudo apt-get install imagemagick 

should do the trick. This will allow the conversion of the final image to other formats.

You may also want to use InkScape to do any little personal editing after the basic keyguide has been created (e.g. convert to PDF, EPS or change the line thickness for different laser cutting machines)

##Usage##

/KeyGuideMaker.py -h
usage: KeyGuideMaker [-h] [--type TYPE] [--designs DESIGNS] [--output OUTPUT]
                     [--filename FILENAME] [--formachine FORMACHINE]
                     [--version]

Creates keyguides from xml design files and svgs. Use like: /KeyGuideMaker.py
-t iPad -d "TouchChat-80,iPadHomeButton" -f will

optional arguments:
  -h, --help            
                        show this help message and exit
  
  --type TYPE, -t TYPE  
                        What device are these for? iPad, iPadMini, Powerbox?
  
  --designs DESIGNS, -d DESIGNS
                        list the name of the designs you want to convert to a guide.
                          NB: uses the filenames of the XML files
  
  --output OUTPUT, -o OUTPUT
                        Not working. EPS, SVG, PDF, PS
  
  --filename FILENAME, -f FILENAME
                        Name of the final keyguide image that gets created
  
  --formachine FORMACHINE, -m FORMACHINE
                        Change the format of the file ready for a particular machine.
                          e.g ponoko or razorlab need blue instead of black.
  
  --version             Get version number

For example: To make a keyguide of TouchChat-80 with a home button and some suckers for attachment, called "TouchChatKeyGuide.svg" and ready it for Ponoko (who use blue lines for cutting) use:

./KeyGuideMaker.py -t iPad -d "TouchChat-80,iPadHomeButton,iPadSuckers"  -m ponoko -f TouchChatKeyGuide

For a list of ready available components to add to your keyguide look at the templates directory.

##Licence##

This is part of the Open Assistive Technology Initiative. That means it conforms to CC-BY (Creative Commons Attribution).