source: subversion/applications/share/map-icons/README.icons @ 34747

Last change on this file since 34747 was 13978, checked in by guenther, 11 years ago
  • updated documentation
File size: 4.8 KB
Line 
1# README.icons
2#
3# $Id: README.icons 1204 2007-01-11 13:16:56Z dse $
4#
5
6This should give you a short information about the icons here.
7As these structure was originally designed for GpsDrive, maybe not all icons
8may be of use for all maps or other osm applications.
9
10The master file here is "icons.xml", which should hold all the necessary data
11about the icons POI-types and other objects, including names and descriptions
12in various languages and a matching with existing tags used in the database.
13
14If you like to add icons for existing types mentioned there, please read the
15rest of this file and have a look at the index html files, to see which icons
16are still missing.
17
18If you like to add new icons or POI-types, that are not mentioned already,
19please add your new icons to the corresponding folder, and create a new entry
20in "icons.xml".
21
22The structure for the rules in icons.xml is derived from gpsdrive:
23- The key gives the primary usage for that icon
24  (currently poi,dynamic,rendering,general).
25- The value gives a unique identifier for that icon, that also maps the
26  folder structure for the entry.
27
28
29THE ICON FILES:
30----------------
31
32The file format for the icons has to be PNG, transparency allowed.
33The image size should be 16x16, 24x24 or 32x32 pixels, but can be any size,
34that is suitable for your icon theme.
35The icon name should be english, lowercase and must not contain dots or
36whitespaces.
37
38
39THE STRUCTURE:
40---------------
41
42        map-icons/<theme>
43                the icons belonging to theme <theme>
44                Each Scheme has a unique loook.
45
46        map-icons/classic
47                this will hold the `old` gpsdrive icons from J. Ostertag
48
49        map-icons/square.big
50        map-icons/square.small
51                the first icon themes designed for the new structure
52
53        map-icons/svg
54                A set of Icons drawn in svg. So these are scaleable
55
56        map-icons/japan
57                Japanese Style Map icons
58
59        map-icons/svg-twotone
60                SVG-Icons kept in two color Tones.
61
62GUIDELINES:
63------------
64
65Each of these directories has to contain at least one icon for each of the
66(twenty) base categories, e.g. shop.png for the category "Shop" and a
67corresponding subfolder with the same name, containing at least one icon called
68"empty.png". Optionally you can place additional sub icons into those folders,
69to allow a more precise classification of the related POI.
70If it should be necessary, one can add other sub-subfolders.
71
72Example:
73
74        map-icons/themename/
75        |
76        |_ food.png
77        |
78        |_ food
79          |
80          |_ restaurant.png
81          |
82          |_ restaurant/
83          |  |_ italian.png
84          |  |_ greek.png
85          |  |_ bavarian.png
86          |
87          |_ fastfood.png
88          |
89          |_ fastfood/
90          |  |_ burgerking.png
91          |  |_ mcdonalds.png
92          |
93          |_ icecream.png
94          |_ beergarden.png
95
96
97THE BASE POI CATEGORIES:
98-------------------------
99
100  - 1   UNKNOWN                                         (white)
101         Unassigned POI
102  - 2   ACCOMMODATION                                   (light blue)
103         Places to stay
104  - 3   EDUCATION                                       (orange/white)
105         Schools and other educational facilities
106  - 4   FOOD                                            (orange)
107         Restaurants, bars, and so on...
108  - 5   GEOCACHE                                        (gc-colours)
109         Geocaches
110  - 6   HEALTH                                          (red/white)
111         Hospital, doctor, pharmacy, etc.
112  - 7   MONEY                                           (yellow/white)
113         Banks, ATMs, and other money-related places
114  - 8   NAUTICAL                                        (black/white)
115         Special nautical points
116  - 9   PEOPLE                                          (yellow)
117         You, work, your friends, and other people
118  - 10  PLACE                                           (transparent)
119         Settlements, mountains, and other geographical stuff
120  - 11  SERVICE                                         (light red)
121         Public facilities and services
122  - 12  LEISURE                                         (light green)
123         Places used for leisure and recreation (no sports!)
124  - 13  RELIGION                                        (violet)
125         Places of worship and other facilities related to religion
126  - 14  SHOP                                            (dark red)
127         All the places, where you can buy something
128  - 15  SIGHTSEEING                                     (green/white)
129         Historic places and other interesting buildings
130  - 16  SPORT                                           (dark green)
131         Sports clubs, stadiums, and other sports facilities
132  - 17  TRANSPORT                                       (blue/white)
133         Public transportation
134  - 18  VEHICLE                                         (blue)
135         Facilites for drivers, like gas stations or parking places
136  - 19  WLAN                                            (black)
137         WiFi-related points (Kismet)
138  - 20  MISC                                            (white)
139         POIs which don't fit in another category, and custom types
140  - 21  WAYPOINT                                        (white)
141         Wapoints, mostly for imported data from way.txt
142
143The colouring scheme shown here is specific for the themes "square.big" and
144"square.small". You may choose your own style of distinguishing the categories
145for your theme as you like.
146
147
148SCRIPTS:
149---------
150
151create_icons_index.pl   This script creates some html overviews of all
152                        the descriptions in icons.xml, showing also the
153                        icons if available.
154                        This should be a maintainer-only script!
155
156FILES:
157-------
158
159icons.xml               holds all available icon and poi-type information,
160                        including titles and description in various languages.
161
162index_all.en.html       gives you a nice overview of all the currently availabe
163                        icons and POI-Types in english language.
164
165index_*.en.html         there are also several overviews available, sorted by type
166
Note: See TracBrowser for help on using the repository browser.