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

Last change on this file since 6809 was 6334, checked in by ulf, 12 years ago

fix various typos

File size: 3.5 KB
Line 
1# README.icons
2#
3# $Id: README.icons 1204 2007-01-11 13:16:56Z dse $
4#
5
6THE ICON FILES:
7----------------
8
9The file format for the icons has to be PNG, transparency allowed.
10The image size should be 16x16, 24x24 or 32x32 pixels, but can be any size,
11that is suitable for your icon theme.
12The icon name should be english, lowercase and must not contain dots or
13whitespaces.
14
15
16THE STRUCTURE:
17---------------
18
19        icons/theme
20                the icons belonging to theme "theme"
21
22        icons/classic
23                this will hold the `old` gpsdrive icons from tweety
24
25        icons/square.big
26        icons/square.small
27                the first icon themes designed for the new structure
28
29
30GUIDELINES:
31------------
32
33Each of these directories has to contain at least one icon for each of the
34twenty base categories, e.g. shopping.png for the category "Shopping" and a
35corresponding subfolder with the same name, containing at least one icon called
36"empty.png". Optionally you can place additional sub icons into those folders,
37to allow a more precise classification of the related POI.
38If it should be necessary, one can add other sub-subfolders.
39
40Example:
41
42        icons/themename/
43        |
44        |_ food.png
45        |
46        |_ food
47          |
48          |_ restaurant.png
49          |
50          |_ restaurant/
51          |  |_ italian.png
52          |  |_ greek.png
53          |  |_ bavarian.png
54          |
55          |_ fastfood.png
56          |
57          |_ fastfood/
58          |  |_ burgerking.png
59          |  |_ mcdonalds.png
60          |
61          |_ icecream.png
62          |_ beergarden.png
63
64
65THE BASE POI CATEGORIES:
66-------------------------
67
68  - 1   UNKNOWN                                         (white)
69         Unassigned POI
70  - 2   ACCOMMODATION                                   (light blue)
71         Places to stay
72  - 3   EDUCATION                                       (orange/white)
73         Schools and other educational facilities
74  - 4   FOOD                                            (orange)
75         Restaurants, bars, and so on...
76  - 5   GEOCACHE                                        (gc-colours)
77         Geocaches
78  - 6   HEALTH                                          (red/white)
79         Hospital, doctor, pharmacy, etc.
80  - 7   MONEY                                           (yellow/white)
81         Banks, ATMs, and other money-related places
82  - 8   NAUTICAL                                        (black/white)
83         Special nautical points
84  - 9   PEOPLE                                          (yellow)
85         You, work, your friends, and other people
86  - 10  PLACES                                          (transparent)
87         Settlements, mountains, and other geographical stuff
88  - 11  PUBLIC                                          (light red)
89         Public facilities
90  - 12  RECREATION                                      (light green)
91         Places used for recreation (no sports!)
92  - 13  RELIGION                                        (violet)
93         Places of worship and other facilities related to religion
94  - 14  SHOPPING                                (dark red)
95         All the places, where you can buy something
96  - 15  SIGHTSEEING                                     (green/white)
97         Historic places and other interesting buildings
98  - 16  SPORTS                                          (dark green)
99         Sports clubs, stadiums, and other sports facilities
100  - 17  TRANSPORT                                       (blue/white)
101         Public transportation
102  - 18  VEHICLE                                         (blue)
103         Facilites for drivers, like gas stations or parking places
104  - 19  WLAN                                            (black)
105         WiFi-related points (Kismet)
106  - 20  MISC                                            (white)
107         POIs which don't fit in another category, and custom types
108  - 21  WAYPOINT                                        (white)
109         Wapoints, mostly for imported data from way.txt
110
111The colouring scheme shown here is specific for the themes "square.big" and
112"square.small". You may choose your own style of distinguishing the categories
113for your theme as you like.
114
115
116SCRIPTS:
117---------
118
119update_icons.pl         This file creates not only the file icons.xml from
120                        their available icons, it builds also a nice html-
121                        overview of the icons and POI-Types.
122                        This should be a maintainer-only script!
123FILES:
124-------
125
126icons.xml               holds all available icon and poi-type information,
127                        including titles and description in various languages.
128
129overview.html           gives you a nice overview of the currently availabe
130                        icons and POI-Types in english language.
131
132overview.de.html        same as above in german (if available)
133
Note: See TracBrowser for help on using the repository browser.