Sugar Iconify
Description
Sugar uses entities for its SVG colors in order to match the icon
colors to the user colors.
The sugariconify.py script is used to convert SVGs into the format
required for Sugar icons, adding the necessary stroke and fill
entities. This is a Python script, and as such requires Python to run.
It will create Sugar-compatible SVG icons from an input.svg by
adding the appropriate stroke and fill entities. It can be used to
convert a single icon or run over a batch of icons at one time.
You can find the script in the sugariconify repository. You can find a web version at https://github.com/sugarlabs/iconify-web
For creating an SVG suitable for Sugar,
see the tutorial on Making Sugar
Icons.
In some cases, you may desire to update a single icon, or a subset of
the icons defined within a given SVG. To do so, pass a pattern to the
script with -p, and only those icons which match the pattern will be
exported.
Usage
sugariconify.py [-ceghipv] [-s stroke_hex] [-f fill_hex] [-m | -o ] [-d directory] input.svg
Example usage:
python sugariconify.py input.svg
Options
-c Apply default color entities (#666666, #FFFFFF) to output
-d [directory] The preferred output directory
-e Do not insert entities for strokes and fills
-f [hex] Hex value to replace with fill entity
-g Automatically accept guesses for stroke and fill entities
-h Display this help message
-i Insert "isolated stroke" entities
-m Multiple export; export top level groups as separate icons
-o Modify input file in place, overwriting it; overridden by -m
-p [pattern] Only export icons whose name contains pattern
-s [hex] Hex value to replace with stroke entity
-v Verbose
-x Create HTML preview files, for icon validation
Note: A common problem encountered when using this script is when the
target SVG has more than two colors.
Details
Given a simple input SVG:
<?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"
version="1.1"
viewBox="0 0 55 55"
height="55mm"
width="55mm">
<rect
y="2.5"
x="2.5"
height="50"
width="50"
style="fill:#ffff00;fill-opacity:1;stroke:#ff0000;stroke-width:3.5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
</svg>
The resulting output would look like this:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC '-//W3C//DTD SVG 1.1//EN'
'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd' [
<!ENTITY stroke_color "#666666">
<!ENTITY fill_color "#ffffff">
]>
<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"
viewBox="0 0 55 55"
height="55mm"
width="55mm">
<rect
<rect
y="2.5"
x="2.5"
height="50"
width="50"
style="fill:&fill_color;;fill-opacity:1;stroke:&stroke_color;;stroke-width:3.5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"/>
</svg>
Instantiating SugarIconify
It is also possible to use SugarIconify in your own Python scripts.
from sugariconify import SugarIconify
icon = SugarIconify()
Methods
#set_stroke_color():
It is equivalent of -s on command line, it can be a hex value
(e.g #FFFF00) or a rgb percent value such as rgb(31%, 28%, 56%).
icon.set_stroke_color('#FFFF00')
icon.set_stroke_color('rgb(55%, 12%, 55%)')
#set_fill_color():
It is equivalent of -f on command line, it can be a hex value
(e.g #FF0000) or a rgb percent value such as rgb(32%, 33%, 87%).
icon.set_fill_color('#FFFFFF')
icon.set_fill_color('rgb(55%, 12%, 55%)')
#set_confirm_guess():
It is equivalent of -g on command line, so it can automatically
accept guesses for stroke and fill entities, True or False are
the only accepted values.
icon.set_confirm_guess(True)
#set_use_default_colors():
It is equivalent of -c on command line, uses default stroke and
fill entities (#666666, #FFFFFF) for sugar iconify, True or False
are the only accepted values.
icon.set_use_default_colors(True)
#set_overwrite_input():
It is equivalent of -o on command line, overrides input file in
place, True or False are the only accepted values.
icon.set_overwrite_input(True)
#set_output_path():
It is equivalent of -d on command line, sets the output path where
the iconified file will be placed, string values are accepted.
icon.set_output_path('/home/user/Desktop')
#set_use_entity():
It is equivalent of -e on command line, do not insert entities for
strokes and fills, True or False are the only accepted values.
icon.set_use_entity(True)
#set_verbose():
It is equivalent of -v on command line, outputs information messages
on console, True or False are the only accepted values.
icon.set_verbose(True)
#set_pattern():
It is equivalent of -p on command line, only export icons whose name
contains pattern, string values are accepted.
icon.set_pattern('pattern')
#set_multiple():
It is equivalent of -m on command line, export top level groups as
separate icons, True or False are the only accepted values.
icon.set_multiple(True)
#set_output_examples():It is equivalent of -x on command line,
create HTML preview files, for icon validation, True or False are
the only accepted values.
icon.set_output_examples(True)
#set_use_iso_strokes():
It is equivalent of -i on command line, insert "isolated stroke"
entities, True or False are the only accepted values.
icon.set_use_iso_strokes(True)
Example
from sugariconify import SugarIconify
icon = SugarIconify()
icon.set_use_default_colors(True)
icon.iconify('/home/user/Desktop/image.svg')