osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-09-11 11:15:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3410 from lonvia/docs-special-phrases

Browse Source 
Add documentation of the format for special phrases CSV
This commit is contained in:
Sarah Hoffmann 2024-05-05 11:14:22 +02:00 committed by GitHub
commit ccb5cf155d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/customize/Special-Phrases.md
View File

@ -11,16 +11,31 @@ nominatim special-phrases --import-from-wiki
## Importing custom special phrases
But, it is also possible to import some phrases from a csv file.
To do so, you have access to the following command:
Special phrases may also be imported from any custom CSV file. The file needs
to have a header line, use comma as delimiter and define the following
columns:
* **phrase**: the keyword to look for
* **class**: key of the main tag of the place to find
(see [principal tags in import style](../Import-Styles.md#set_main_tags-principal-tags)
* **type**: value of the main tag
* **operator**: type of special phrase, may be one of:
* *in*: place is within the place defined by the search term (e.g. "_Hotels in_ Berlin")
* *near*: place is near the place defined by the search term (e.g. "_bus stops near_ Big Ben")
* *named*: special phrase is a classifier (e.g. "_hotel_ California")
* *-*: unspecified, can be any of the above
If the file contains any other columns, then they are silently ignored
To import the CSV file, use the following command:
```sh
nominatim special-phrases --import-from-csv <csv file>
```
Note that the two previous import commands will update the phrases from your database.
This means that if you import some phrases from a csv file, only the phrases
present in the csv file will be kept into the database. All other phrases will
This means that if you import some phrases from a CSV file, only the phrases
present in the CSV file will be kept into the database. All other phrases will
be removed.
If you want to only add new phrases and not update the other ones you can add
@ -30,5 +45,5 @@ the argument `--no-replace` to the import command. For example:
nominatim special-phrases --import-from-csv <csv file> --no-replace
```
This will add the phrases present in the csv file into the database without
This will add the phrases present in the CSV file into the database without
removing the other ones.

2
docs/library/Getting-Started.md
View File

@ -103,7 +103,7 @@ You should have set up this directory as part of the Nominatim import.
Any configuration found in the `.env` file in this directory will automatically
used.
Yo may also configure Nominatim be setting environment variables.
You may also configure Nominatim by setting environment variables.
Normally, Nominatim will check the operating system environment. This can be
overwritten by giving the constructor a dictionary of configuration parameters.