Browse Source

add search docs [no docker]

pull/164/head
Jason Dove 5 years ago
parent
commit
993293c104
  1. BIN
      docs/images/search-box.png
  2. 45
      docs/user-guide/search.md
  3. 3
      mkdocs.yml

BIN
docs/images/search-box.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.5 KiB

45
docs/user-guide/search.md

@ -0,0 +1,45 @@ @@ -0,0 +1,45 @@
## Search Box
Movies, Shows, Artists and Music Videos can be searched using the search box next to the ErsatzTV logo.
![Search Box](../images/search-box.png)
## Search Fields
The following fields are available for searching:
- `title`: The movie, show, artist or music video name/title
- `genre`: The movie, show, or artist genre
- `tag`: The movie or show tag (not available with Plex metadata)
- `style`: The artist style
- `mood`: The artist mood
- `plot`: The movie or show plot
- `studio`: The movie or show studio
- `library_name`: The name of the library
- `language`: The movie, show or music video audio stream language
- `release_date`: The movie or show release date (YYYYMMDD)
- `type`: The media item type: `movie`, `show`, `artist` or `music_video`
Note that the `title` field is searched by default if no other field is specified.
## Sample Searches
### Christmas Movies
`plot:christmas`
### Christmas Movies without Horror
`plot:christmas NOT genre:horror`
### 1970's Movies
`type:movie AND release_date:197*`
### 1970's-1980's Comedies
`genre:comedy AND (release_date:197* OR release_date:198*)`
### Lush Music
`mood:lush`

3
mkdocs.yml

@ -7,12 +7,15 @@ nav: @@ -7,12 +7,15 @@ nav:
- 'Configure Clients': 'user-guide/configure-clients.md'
- 'Advanced':
- 'Local Libraries': 'user-guide/local-libraries.md'
- 'Search': 'user-guide/search.md'
theme:
name: material
palette:
scheme: slate
logo: images/ersatztv-square-logo.png
favicon: images/favicon-32x32.png
features:
- navigation.expand
extra_css:
- stylesheets/extra.css
copyright: Copyright © 2020 - 2021 Jason Dove

Loading…
Cancel
Save