From d064e389c4b7047360ed06654d9e3a0c38df4e12 Mon Sep 17 00:00:00 2001 From: Joseph Guillaume Date: Sat, 30 May 2020 22:39:22 +1000 Subject: [PATCH] Extend documentation for presetsFile --- README.md | 2 +- overpass-wizard | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ef0c4a..9c61ece 100644 --- a/README.md +++ b/README.md @@ -33,4 +33,4 @@ Install via npm: `npm install --save overpass-wizard`. The module exposes a sing * `compactNWR`: produces a query with `nwr` statements if possible (instead of listing `node`, `way` and `relation` separately), resulting in more compact results (default: true) * `aroundRadius`: radius (in m) to be used with `around ` searches (default: 1000) * `comment`: boolean or string. if false, no comments will be added to the Overpass query output. if it is a string, it will be used in the header to explain what the query is doing - * `freeFormPresets`: (*experimental*) path to a JSON file with presets in the [schema](https://github.com/openstreetmap/iD/blob/master/data/presets/presets.json) used by the iD editor. Used to expand *free form* search input (e.g. `Hotel in Vienna`). + * `freeFormPresets`: (*experimental*) path to a JSON file with a presets object in the [schema](https://github.com/openstreetmap/iD/blob/develop/data/presets/presets.json) used by the iD editor. Used to expand *free form* search input (e.g. `Hotel in Vienna`). Each preset is a named object that must have fields `name`, `terms`, `geometry` and `tags`. Presets with `searchable:false` are ignored. diff --git a/overpass-wizard b/overpass-wizard index 2e6c60d..8858c9a 100755 --- a/overpass-wizard +++ b/overpass-wizard @@ -8,6 +8,7 @@ var argv = require('yargs') .boolean('no-compact').describe('no-compact','don\'t use the compact "nwr" syntax (for use with older Overpass-API servers)') .string('bbox').alias('b', 'bbox').describe('bbox','string to replace {{bbox}} shortcuts with') .string('around-radius').describe('around-radius','radius to use for "around " queries') + .string('presetsFile').describe('presetsFile','(experimental) path to a JSON file with iD editor schema presets. Used to expand free form search input (e.g. Hotel in Vienna).') .string('timeout').alias('t', 'timeout').default('timeout', 25).describe('timeout','timeout of overpass query in seconds') .string('maxsize').describe('maxsize','memory limit of overpass query (in bytes)')