Code

Update READMEs for the icons directory.
[inkscape.git] / share / icons / README
1 ========================
2 = INKSCAPE ICON THEMES =
3 ========================
5 Starting with 0.47, Inkscape supports icon theming using the XDG Icon Theme
6 Specification [1]. It is implemented according to the Themable App Specific
7 Icons document [2]. Everything that's needed to replace Inkscape's icons
8 is to put appropriately named icons in your desktop environment's icon theme.
9 A list of the names is available at [3].
11 The monolithic icons.svg file is deprecated and should not be used to add new
12 icons. Support for it will probably be removed in the next release (0.48).
14 == User notes ==
16 To get back the old icons on Linux, do the following:
17 1. Create the directory ~/.icons/OldInkscape
18 2. Copy the contents of the hicolor directory there
19 3. Edit the index.theme file; Replace "Name=hicolor" with "Name=OldInkscape",
20    and in a new line add "Inherits=YourTheme" where YourTheme is the
21    icon theme you're currently using, e.g. Human, gnome, etc.
22 4. Choose the OldInkscape theme from your desktop's appearance preferences.
24 To use the Tango icons on Windows, go to INKDIR/share/icons, where INKDIR is
25 Inkscape's installation directory. Rename "hicolor" to "old", and then rename
26 "tango" to "hicolor".
28 == Developer notes ==
30 The enabling bit of theming on Windows, which isn't mentioned in GTK docs,
31 is the index.theme file. Without it, gtk_icon_theme_load_icon fails with the
32 GTK_ICON_THEME_ERROR_FAILED error.
34 Note that what dir the icon is in (actions, status, places) under the size
35 directory doesn't matter at all when icons are looked up; the lookup function
36 looks in all directories.
38 == How to add an icon ==
40 To add a new icon, you have to do the following:
41 1. Draw the icon on a 48x48px canvas; for new icons, try to follow the Tango
42    guidelines [4].
43 2. Name the icon according to the icon naming guidelines outlines in the
44    theme specification and using existing icons as a reference.
45 2. Place it in the appropriate directory under scalable in both hicolor
46    and tango. Choose the best suitable context ("places" for dialogs,
47    "actions" for actions, and "status" for status indicators and toggles).
48 3. Run the script render-icons.sh and then update-makefiles.sh in both
49    directories.
51 References:
52 [1] http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
53 [2] http://live.gnome.org/ThemableAppSpecificIcons
54 [3] http://wiki.inkscape.org/wiki/index.php/Themable_icons
55 [4] http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines
57 Jan 18, 2008
58 ticotico.jpg is (C) 2008 Dario Sanches, licensed under Creative Commons by-sa 3.0