Browse Source

update collection docs [no docker]

pull/409/head
Jason Dove 4 years ago
parent
commit
742ac21ad7
  1. BIN
      docs/images/trakt-list-search.png
  2. 5
      docs/index.md
  3. 23
      docs/user-guide/add-media-items.md
  4. 65
      docs/user-guide/create-collections.md
  5. 1
      mkdocs.yml

BIN
docs/images/trakt-list-search.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

5
docs/index.md

@ -10,5 +10,6 @@ Want to say thanks? Consider [sponsorship on GitHub](https://github.com/sponsors @@ -10,5 +10,6 @@ Want to say thanks? Consider [sponsorship on GitHub](https://github.com/sponsors
1. [Install ErsatzTV](user-guide/install.md)
2. [Add Media Items](user-guide/add-media-items.md)
3. [Create Channels](user-guide/create-channels.md)
4. [Configure Clients](user-guide/configure-clients.md)
3. [Create Collections](user-guide/create-collections.md)
4. [Create Channels](user-guide/create-channels.md)
5. [Configure Clients](user-guide/configure-clients.md)

23
docs/user-guide/add-media-items.md

@ -194,26 +194,3 @@ Click `Add Path Replacement` to add a new path replacement, and enter the `Emby @@ -194,26 +194,3 @@ Click `Add Path Replacement` to add a new path replacement, and enter the `Emby
Click `Save Changes` after you have created all needed path replacements.
![Emby Path Replacements](../images/emby-media-source-path-replacements.png)
## Collections
ErsatzTV does not schedule individual media items; only collections of items can be scheduled.
To create a collection, find the media items you would like to include and select them by clicking the selection button in the top left of the poster:
![Poster Selection Button](../images/poster-selection-button.png)
Then, add to a collection by clicking the `Add To Collection` button at the top of the page.
![Add Selection To Collection](../images/add-selection-to-collection.png)
In the `Add To Collection` dialog, either select an existing collection for the items, or enter a new collection name to create a collection and add all of the selected items in a single step.
![Add To Collection Dialog](../images/add-to-collection-dialog.png)
---
Big Buck Bunny: (c) copyright 2008, Blender Foundation / [www.bigbuckbunny.org](https://www.bigbuckbunny.org)
Sintel: © copyright Blender Foundation | [www.sintel.org](https://www.sintel.org)
Tears of Steel: (CC) Blender Foundation | [mango.blender.org](https://mango.blender.org)

65
docs/user-guide/create-collections.md

@ -0,0 +1,65 @@ @@ -0,0 +1,65 @@
## Collection Types
ErsatzTV does not schedule individual media items; only collections of items can be scheduled. There are three (3) collection types:
- `Collection`: contains manually-added items
- `Smart Collection`: contains items from search results or imported Trakt Lists, and updates dynamically
- `Multi Collection`: contains other Collections and Smart Collections.
### Collections
Collections are created manually by adding individual media items to it. There is no restriction on media type. A collection can contain a single media type, eg. movies or any combination of media types.
The items to be added can be found by browsing your libraries or by using ErsatzTV's powerful Search feature. An empty collection can be created under `Lists` > `Collections` > `Add Collection`.
To create a collection, find the media items you would like to include and select them by clicking the selection button in the top left of the poster:
![Poster Selection Button](../images/poster-selection-button.png)
Then, add to a collection by clicking the `Add To Collection` button at the top of the page.
![Add Selection To Collection](../images/add-selection-to-collection.png)
In the `Add To Collection` dialog, either select an existing collection for the items, or enter a new collection name to create a collection and add all of the selected items in a single step.
![Add To Collection Dialog](../images/add-to-collection-dialog.png)
### Smart Collections
Smart Collections are created by saving searches or saving imported Trakt Lists.
#### From Searches
To create a smart collection, type a search query in the search box and press enter.
If the result shown meets your expectations, save as a Smart Collection by clicking the `Save As` button.
If it doesn't meet your expectations, refine the search query until it does and then save.
#### From Imported Trakt Lists
To import a Trakt List, navigate to the `Lists` > `Trakt Lists` page and click the `Add Trakt List` button. Trakt lists can be imported by url or by `user/list`.
- To re-download a Trakt List, simply add it again. There is no need to delete.
- Unmatched item details are written to the log.
- Trakt Lists can only be scheduled after being saved as a Smart Collection.
To see matching items from an imported Trakt list, click the search button on the row of the Trakt List.
![Trakt List Search](../images/trakt-list-search.png)
### Multi Collections
Multi Collections contain other Collections and/or Smart Collections. The primary purpose of these are to enable the scheduling of sets of Media Items in a controlled manner.
Here we are referring to Movie Boxsets, e.g. X-Men Collection, Star Trek Collection and Before... Collection as well as related movies and tv show groups such as Arrowverse, MARVEL Cinematic Universe, Worlds of DC and Battlestar Galactica (Reboot).
To Add a Multi Collection
- Navigate to `Lists` > `Collections` and click the `Add Multi Collection` button
- Give the Multi Collection a name
- Add collections and/or smart collections as required and click `Add Multi Collection` to save
---
Big Buck Bunny: (c) copyright 2008, Blender Foundation / [www.bigbuckbunny.org](https://www.bigbuckbunny.org)
Sintel: © copyright Blender Foundation | [www.sintel.org](https://www.sintel.org)
Tears of Steel: (CC) Blender Foundation | [mango.blender.org](https://mango.blender.org)

1
mkdocs.yml

@ -3,6 +3,7 @@ nav: @@ -3,6 +3,7 @@ nav:
- 'Quick Start':
- 'Install ErsatzTV': 'user-guide/install.md'
- 'Add Media Items': 'user-guide/add-media-items.md'
- 'Create Collections': 'user-guide/create-collections.md'
- 'Create Channels': 'user-guide/create-channels.md'
- 'Configure Clients': 'user-guide/configure-clients.md'
- 'Advanced':

Loading…
Cancel
Save