Changes between Version 63 and Version 65 of DevelopersGuide/DefaultPresets


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • DevelopersGuide/DefaultPresets

    v63 v65  
    11[[TranslatedPages]]
    22[[PageOutline(2-10, Table of Contents)]]
    3 = Defaultpresets Guidelines
     3= Defaultpresets Guidelines =
    44
    55This page contains rough guidelines for the [source:/trunk/resources/data/defaultpresets.xml defaultpresets] and new icons.
     6
    67
    78== New Tags and Values ==
     
    1011
    1112Basically we have to make sure that the preset menu isn't too cluttered, because it would get hard to find the useful every-day stuff if we had too many exotic entries. New tags and values should have:
    12 * a proper documentation in the [osmwiki: OSM-wiki]
    13 * decent usage numbers (absolute and by number of mappers)
    14 * world wide usage
    15 * Controversial cases (like `contact:phone=*` vs. `phone=*`) need to be decided case by case.
    16 * If a features is only mapped by a handful of specialists, it is better suited for an [wikitr:/Presets#PublishanewAvailablepresetsitem external preset]. Usually this includes tagging schemes restriced to one specific country, hobby, sport or profession. Instead of creating an own external preset you could also extend [wikitr:/Presets/NewTags].
     13* a proper documentation in the [osmwiki: OSM-wiki],
     14* decent usage numbers (absolute and by number of mappers),
     15* world wide usage,
     16* controversial cases (like `contact:phone=*` vs. `phone=*`) need to be decided case by case,
     17* if a features is only mapped by a handful of specialists, it is better suited for an [wikitr:/Presets#PublishanewAvailablepresetsitem external preset]. Usually this includes tagging schemes restriced to one specific country, hobby, sport or profession. Instead of creating an own external preset you could also extend [wikitr:/Presets/NewTags].
    1718
    1819**Note**:
     
    2728* The file format must be **svg** for lossless scaling. (Technically png is supported too but all preset icons are svg since August 2016.)
    2829* The icon must be **identifiable at a size of 16 pixels**. This is the default size the icons are displayed in the [wikitr:/Help/MapView Map View] on standard dpi (not hidpi) screens.
    29 * The **license** needs to be compatible with GPL3 (like PD or CC0). A good source for Icons is [https://openclipart.org openclipart.org] (all icons there are PD), [https://publicdomainvectors.org/ publicdomainvectors.org] (all icons CC0), [https://freesvg.org/ freesvg.org] (all icons CC0) or [http://osm-icons.org/wiki/Icons osm-icons.org] (a lot are CC0). You can also check if JOSM already has a fitting unused icon in one of its icon folders: [browser:josm/trunk/resources/images used icons] and [browser:josm/trunk/nodist/images unused icons].
    30 * If the tag applies to nodes, the icon in the MapView and the icon of the preset should be the same if possible. (It is not possible when different features use the same preset, e.g. crossing=island and crossing=traffic_signals have different icons, but are handled in only one preset "Pedestrian Crossing".)
     30* The **license** needs to be compatible with GPL3 (like PD or CC0). A good source for Icons is [https://openclipart.org openclipart.org] (all icons there are PD), [https://publicdomainvectors.org/ publicdomainvectors.org] (all icons CC0), [https://freesvg.org/ freesvg.org] (all icons CC0) or [http://osm-icons.org/wiki/Icons osm-icons.org] (a lot are CC0). You can also check if JOSM already has a fitting unused icon in one of its icon folders: [source:josm/trunk/resources/images used icons] and [source:josm/trunk/nodist/images unused icons].
     31* If the tag applies to nodes, the icon in the MapView and the icon of the preset should be the same if possible. (It is not possible when different features use the same preset, e.g. `crossing=island` and `crossing=traffic_signals` have different icons, but are handled in only one preset "Pedestrian Crossing".)
    3132* Icons with transparent background must **not be only black or only white**. Otherwise if one uses a black or white background (no aerial imagery as background) in the Map View black or white icons would be invisible. Workaround: if you want to use a black icon add a square white background to the icon instead of a transparent background or better use a white halo. \\
    32  Examples: [[Image(BlackWhiteIcon.png,middle,link=)]] Colored icons are preferred though.
     33 Example: [[Image(BlackWhiteIcon.png,middle,link=)]] Colored icons are preferred though.
    3334* The icon should hide as less as possible in the mapview, so colourful icons with transparent background are preferred over black/white icons with square background.
    3435* The icon should be understandable in all countries.
     
    4243* There are some svg libraries which do not work with JOSM (the images get deformed). If you have such a file try the following workaround: create a new svg document with Inkscape, copy the svg data to this new file, resize the page to the data and save.
    4344* Resize your icon to 16px or an integer multiple size of it (not something like 458.1534) to avoid display inaccuracies due to rounding errors within java.
    44 * Check the code of the file in a text editor. Search for **viewBox** value in the beginning of the file. If the icon is, for example, in 16x16 pixels, and if you made it in Inkscape (at least this happens in 0.91 version) and have defined in Document Properties 16,00000 by 16,00000 pixels, probably in the file code you have these values **viewBox="0 0 16.000002 16.000001"**. Change it to **viewBox="0 0 16 16"** or you will have problems (see #12201 and the fix [o31865])
     45* Check the code of the file in a text editor. Search for **viewBox** value in the beginning of the file. If the icon is, for example, in 16x16 pixels, and if you made it in Inkscape (at least this happens in 0.91 version) and have defined in Document Properties 16,00000 by 16,00000 pixels, probably in the file code you have these values **viewBox="0 0 16.000002 16.000001"**. Change it to **viewBox="0 0 16 16"** or you will have problems (see #12201)
    4546* svg icons are automatically cleaned up to reduce file size in the JOSM build. So there is no need to do this step manually before uploading svg files to svn. See comment:35:ticket:10479, comment:10:ticket:10877 and ticket:12201#comment:21 Uncleaned svgs are better for further editing.
    4647* Due to a bug in svgcleaner however, the svg code shouldn't contain arguments starting with special characters in style codes e.g. `-inkscape-font-specification:Sans;`. This can lead to color changes (see #13158).