Skip to content

Add Documentation for default fulltext seach provider #26

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Documentation for default fulltext seach provider #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 37 additions & 12 deletions src/topics/Search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,27 +440,52 @@ curl 'http://localhost:8983/solr/gdi/CONFIG_NAME?command=full-import'
```


### Configuring the search for a theme
### Configuring the search as default or for a specific theme

To use a fulltext search in a theme, configure a `fulltext` search provider in `themesConfig.json` as follows:
To use a fulltext search as **default for all themes**, configure a `fulltext` search provider in `themesConfig.json` as follows:

```json
"searchProviders": [
{
"defaultSearchProviders": [
{
"provider": "fulltext",
"params": {
"default": [<FACET_NAME>],
"layers": {
"<layer_name>": "<FACET_NAME>"
}
"provider": "fulltext",
"params": {
"default": [<FACET_NAME>],
"layers": {
"<layer_name>": "<FACET_NAME>"
}
}
}
]
]
}
```
Where:

To use a fulltext search in **a specific theme**, configure a `fulltext` search provider in `themesConfig.json` as follows:

```json
{
"themes": {
"items": [
{
"searchProviders": [
{
"provider": "fulltext",
"params": {
"default": [<FACET_NAME>],
"layers": {
"<layer_name>": "<FACET_NAME>"
}
}
}
]
}
]
}
}
```
Where:
* `default` lists the search facets enabled by default.
* `layers` providides a mapping of facets which are enabled whenever the theme layer `<layer_name>` is visible on the map.
* `layers` (optional) providides a mapping of facets which are enabled whenever the theme layer `<layer_name>` is visible on the map.

Next, create the resources in the Admin GUI to control the search permissions:

Expand Down