CalvinBackup/iD
1
0
Fork 0
mirror of https://github.com/FoggedLens/iD.git synced 2026-02-13 09:12:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Editing presets README

Browse Source
This commit is contained in:
John Firebaugh
2013-03-13 11:45:02 -07:00
parent c1aa8e0270
commit 8117252b7f
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
data/presets/README.md
View File

@@ -5,9 +5,9 @@ preset definitions and simple structure.
## Individual Presets
Specific presets are located under `data/presets/presets`. For convenience,
they're stored in sub-directories like `data/presets/presets/leisure/park.json`,
but these have no effect on their final functionality.
Specific presets are located under `data/presets/presets`. They're organized in a
directory hierarchy based on OSM key/value pairs. For example, the preset that matches
the tag `leisure=park` is in the file `data/presets/presets/leisure/park.json`.
## Preset Format
@@ -67,8 +67,18 @@ In which `type` is the fields's type. Valid field types are
* address
* defaultcheck - a checkbox that can be yes, no, or null - not filled
The `key` property names the OSM key that the field will edit. Alternatively, for
compound fields like `address`, you can specify an array of keys in the `keys`
property.
Each field definition lives in a separate file in `data/presets/fields`. The field
name (used in the preset `fields` property) is the name of the file (minus the `.json`
extension).
## Building
Presets are built with the `build.js` script in iD's root. `build.js` combines
all presets together with imagery data, deprecated and discarded tags into
one file, `data/data.js`.
To build presets, all you need to to is run `make`.
This command will take care of running the build script, which packages all presets
together with imagery data, and deprecated or discarded tags into one file, `data/data.js`,
which is included in the packaged iD.js file.