Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation of the format for special phrases CSV #3410

Merged
merged 2 commits into from
May 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions docs/customize/Special-Phrases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 changes: 1 addition & 1 deletion docs/library/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading