source: subversion/applications/share/map-icons/README @ 10274

Last change on this file since 10274 was 4193, checked in by joerg, 12 years ago

rename jp to japan

File size: 3.8 KB
Line 
1This is the general OSM Map-Icons directory.
2All the icons in these directories have to get an
3entry into the map-features.xml file. So we have one common
4place for all icons used for drawing maps.
5
6Discussions showed that probably the best Licence for all the
7icons would be a PD-Style Licence. Because this wouldn't interfeer
8with any use which is planed. So we expect new icons inserted here
9to be PD-Style-Licence
10
11We currently have six subdirectories representing
12the six icon schemes(classic,square.big,square.small,svg,japan).
13This means that the user can choose between those
14six (for now) styles for rendering. The styles
15are each represented in there directories:
16  - classic: normally no frames, no borders, transparent
17             but if you are unsure put the icons here
18  - square.big: these icons all have a square shaped frame,
19             where the color of the frame tells which category they belong to.
20  - square.small: similar to the above(square.big), only smaller
21  - svg: these are vectorgrafics in svg-format.
22  - jp:  these are japanese map-sign, as found in openclipart and wikipedia
23For the two svg directories there also exists an thumbnails directory which holds
24thumbnails for easier viewing on a website, ... These thumbnails directories
25 (svg_tn, jp_tn) are only created by the build process. This is the reason
26they are not found in svn (any more).
27The build proccess also takes care of filling up directories from others if it
28thinks this is usefull and possible.
29
30Inside these directories the icons are structured by category.
31Where every category has it's own sub-directory.
32There are the following top-categories:
33      - accommodation
34      - education
35      - food
36      - geocache
37      - health
38      - money
39      - nautical
40      - misc
41      - people
42      - places
43      - public
44      - recreation
45      - religion
46      - shopping
47      - sightseeing
48      - sports
49      - transport
50      - unknown
51      - vehicle
52      - waypoint
53      - wlan
54Each of these categories except 'unknown' can have sub-categories. If you 're
55adding more icons you should try to put them into one of the existing
56categories. For each (sub-)category we have a category-icon which is named
57like the category directory. So for example, for the directory <style>/food/
58we have to have an icon <style>/food.png. The same always applies to each
59sub-sub-directory. Before you start a sub-category you'll have to create an
60icon for this subcategory. This way the renderer can always take the category
61icon if there does not exist a specific icon for this.
62If you are not sure where to put the icon you should consider using
63the misc (directory misc).
64
65Additional files:
66
67- overview.en.html
68        gives a nice overview of the available Icons with english descriptions
69- overview.de.html
70        gives a nice overview of the available Icons with german descriptions
71
72
73The Tools in this directory are used to maintain the map-icons directory:
74copy_icons_to_dir.sh <Verzeichnis>
75        Ist eine Art mini "make install"
76update_thumbnails.pl
77        erzeugt die beiden Verzeichnisse svg_tn und jp_tn aus den svg Dateien
78merge-icons-all-from-svg2classic2square.sh
79        versucht in dem angegebenen Verzeichnis So viele Icons durch mischen
80        der einzelnen Dateien aus den unterschiedlichen Themes zu erzeugen.
81        Sollte man auf keinen Fall im Hauptverzeichnis anwenden, wenn man
82        geänderte Icons dort hat, denn sonst kennt man sich danach gar nicht mehr
83        aus. Update_thumbnails sollte vorher ausgeführt werden, denn von dort wird
84        auch versucht die Daten zu holen.
85copy_icons_to_debian_package_dirs.pl
86        Verteilt die Icons in build/* in die debian packages
87update_icons.pl
88        liesst jetzt nur noch die XML und ergänzt sie evtl.
89create_overview.pl <Directory>
90        erzeugt die beiden overview*.html Dateien
91
92create_makefile.sh
93        Ist geblieben und erzeugt immer noch das alte automake Makefile.am
94
Note: See TracBrowser for help on using the repository browser.