Commit 961888db authored by Juraj Fiala's avatar Juraj Fiala

readme: Basic style fixes

Now that it is in Markdown we can make use of some niceness it provides. Also fix some typos and update the bugtracker URL.
parent 3942a05c
Bugs and Requests
-----------------
Requests for icons that will be useful for more than a a single
Requests for icons that will be useful for more than a single
application and it makes sense to share it in an icon theme should be
filed in GNOME bugzilla (bugzilla.gnome.org) under the
gnome-icon-theme module.
filed in the GitLab [issue tracker][1] of this module.
High resolution icons
......@@ -17,7 +16,7 @@ in providing a high resolution variant. For Tango, the canvas size is
We suggest creating artwork for this large canvas as vectors. It may
require more time as vector art with filter effects tends to be very
computentionally intensive, but the benefit is that it allows to
create derivative works easily. In addition, if we need a higher
create derivative works easily. In addition, if we need a higher
resolution than 256x256 in future, it's simply a matter of
re-rendering the icons.
......@@ -25,9 +24,9 @@ Due to the large canvas a lot of the guidelines discussed elsewhere in
this document do not apply. What still stands is the use of colors,
the perspective and lighting.
FIXME: outlines (strokes alternative - wip)
FIXME: highlights (inner stroke alternative)
FIXME: shadows (wip)
* FIXME: outlines (strokes alternative - wip)
* FIXME: highlights (inner stroke alternative)
* FIXME: shadows (wip)
Inkscape workflow tips:
-----------------------
......@@ -42,21 +41,21 @@ Inkscape workflow tips:
things, nonsenses and so on:-)) using the Bitstream Vera Sans
typeface with a 6pt size, trying to have the main bodies of the
letters between two horizontal major grid lines, then we convert the
text object to path and simplify (ctrl+l) 3 times. In case the text
text object to path and simplify (`ctrl+l`) 3 times. In case the text
is not visible enough when scaling down overlaying the line with a
very subtle rectangle 4px tall will help (see text-x-generic).
very subtle rectangle 4px tall will help (see `text-x-generic`).
* Outlines: to make the things stand out we darken the edges using
various tecniques. Lapo's favourite is to group the all objects
costituting the shape; copy, paste in place, ungroup and make the
boolean union to obtain the silouhette [ctrl+c, crtl+alt+v, ctrl+u,
ctrl++]; copy again; set this path fill to none, set the stroke from
boolean union to obtain the silouhette [`ctrl+c`, `crtl+alt+v`, `ctrl+u`,
`ctrl++`]; copy again; set this path fill to none, set the stroke from
0.5 to 2 pixels in a dark color (usaully black) and set blur from 1
to 2 points; group it with the previous group; paste in place and
select the new group and the pasted path apply a clipping mask (the
pasted path will be used as a clipping mask) [Object -> Clip ->
Set]. Now you can do group editing with the clipping mask in place
[ctrl+enter to "enter" the group]. You can play with various stroke
[`ctrl+enter` to "enter" the group]. You can play with various stroke
width and color or gradients and with different blur settings.
* Shadows: there's usually two shadow objects, one darker, less
......@@ -71,9 +70,9 @@ follows the Tango style guidelines for specific purposes. This would
include OSD messages, panel system/notification area, and possibly
menu icons.
Icons follow the naming specification, but have a -symbolic suffix, so
Icons follow the naming specification, but have a `-symbolic` suffix, so
only applications specifically looking up these symbolic icons will
render them. If a -symbolic icon is missing, the app will fall back to
render them. If a `-symbolic` icon is missing, the app will fall back to
the regular name.
Primitive build instructions
......@@ -89,29 +88,29 @@ Targets
=======
Here's places that should make use of this style (and look up icons as
-symbolic).
`-symbolic`).
* Panel systray (and gnome-shell equivalents)
* Nautilus' sidebar eject emblem for mounted drives
* OSD (volume levels, display, eject etc)
* text input widgets (caps lock warning, clear icons)
* Panel systray (and gnome-shell equivalents)
* Nautilus' sidebar eject emblem for mounted drives
* OSD (volume levels, display, eject etc)
* text input widgets (caps lock warning, clear icons)
HOWTO
=====
The whole set is maintained in a single SVG,
src/gnome-stencils.svg. Each context (apps, actions, mimetypes...)
`src/gnome-stencils.svg`. Each context (apps, actions, mimetypes...)
lives inside an Inkscape layer (group). Any group inside that layer
is treated as an icon and will be exported into the
gnome/scalable/<context>/<inkscape:label>-symbolic.svg of the
`gnome/scalable/<context>/<inkscape:label>-symbolic.svg` of the
group. This export is handled by using Inkscape's verbs, which means
it will pop up Inkscape GUI at you and will take ages.
The best way to assure your icon will be precisely 16x16, is to
include a blank rectangle in the group. This rectangle, as long as it
is 16 pixels wide and high, will be removed by the crop script. To
name the group, open up the object properties dialog (Ctrl+Shfit+O)
and use the 'label' field. Do not add the -symbolic suffix there, that
name the group, open up the object properties dialog (`Ctrl+Shfit+O`)
and use the 'label' field. Do not add the `-symbolic` suffix there, that
will be done by the script. Also, don't nest groups too much inside
the main one. The script will only convert outlines properly down to
two subgroups.
......@@ -125,13 +124,13 @@ xml container that has a stylesheet overriding the colors.
There is a couple of things the icon author needs to be aware of and a few
things s/he can make use of. The stylesheet is setting the color of the fill
for all rectangles and paths. _DO_NOT_ leave any rectangles or paths
for all rectangles and paths. **DO NOT** leave any rectangles or paths
with no fill/stroke thinking it's invisible.
Note that the export script in gnome-icon-theme-symbolic will convert
Note that the export script in `gnome-icon-theme-symbolic` will convert
strokes to paths, so you will need to do this manually (Path -> Stroke
to Path in inkscape) if you ship an icon outside of
gnome-icon-theme-symbolic.
`gnome-icon-theme-symbolic`.
If you need colorize specific part of an icon you need to set a class
of that object. In inkscape 0.47 this is sadly only achievable by
......@@ -139,7 +138,8 @@ selecting the object, going into the xml editor and creating a new
attribute 'class' and setting its value. There are currently 3
possible values:
- warning - this maps to gtk @warning_color
- error - maps to @error_color
- success - maps to @success_color
- warning - this maps to gtk `@warning_color`
- error - maps to `@error_color`
- success - maps to `@success_color`
[1]: https://gitlab.gnome.org/GNOME/adwaita-icon-theme/issues
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment