Browse Source

update docs (#431)

pull/432/head
Jason Dove 4 years ago committed by GitHub
parent
commit
71658c448f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      ErsatzTV/Shared/MainLayout.razor
  2. BIN
      docs/images/sample-schedule-247-balanced-shows-1.png
  3. BIN
      docs/images/sample-schedule-247-balanced-shows-2.png
  4. BIN
      docs/images/sample-schedule-247-show-every-30-minutes-with-filler.png
  5. BIN
      docs/images/sample-schedule-247-show.png
  6. BIN
      docs/images/sample-schedule-247-shows-with-filler-1.png
  7. BIN
      docs/images/sample-schedule-247-shows-with-filler-2.png
  8. 2
      docs/user-guide/add-media-items.md
  9. 20
      docs/user-guide/create-channels.md
  10. 20
      docs/user-guide/local-libraries.md
  11. 31
      docs/user-guide/sample-schedules.md
  12. 8
      docs/user-guide/search.md
  13. 1
      mkdocs.yml

2
ErsatzTV/Shared/MainLayout.razor

@ -52,7 +52,7 @@ @@ -52,7 +52,7 @@
<MudNavLink Href="/media/libraries">Libraries</MudNavLink>
<MudNavLink Href="/media/tv/shows">TV Shows</MudNavLink>
<MudNavLink Href="/media/movies">Movies</MudNavLink>
<MudNavLink Href="/media/music/artists">Music Videos</MudNavLink>
<MudNavLink Href="/media/music/artists">Music</MudNavLink>
<MudNavLink Href="/media/other/videos">Other Videos</MudNavLink>
</MudNavGroup>
<MudNavGroup Title="Lists" Expanded="true">

BIN
docs/images/sample-schedule-247-balanced-shows-1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/images/sample-schedule-247-balanced-shows-2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/images/sample-schedule-247-show-every-30-minutes-with-filler.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

BIN
docs/images/sample-schedule-247-show.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/images/sample-schedule-247-shows-with-filler-1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/images/sample-schedule-247-shows-with-filler-2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

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

@ -11,7 +11,7 @@ With local libraries, ErsatzTV will read metadata from [NFO files](https://kodi. @@ -11,7 +11,7 @@ With local libraries, ErsatzTV will read metadata from [NFO files](https://kodi.
### Add Libraries
ErsatzTV provides three local libraries by default, one for each supported media kind: `Movies`, `Shows` and `Music Videos`.
ErsatzTV provides four local libraries by default, one for each supported media kind: `Movies`, `Shows`, `Music Videos` and `Other Videos`.
Additional libraries can be added under `Media Sources` > `Local`.
### Add Media Items

20
docs/user-guide/create-channels.md

@ -55,12 +55,13 @@ Schedule items can contain the following collection types: @@ -55,12 +55,13 @@ Schedule items can contain the following collection types:
- `Television Season`: Select a specific season of a television show.
- `Artist`: Select all music videos for a specific artist.
- `Multi Collection`: Select all collections within a multi-collection.
- `Smart Collection`: Select all items that match a saved search query.
#### Collection
Based on the selected collection type, select the desired collection.
### Playback Order
#### Playback Order
Select the desired playback order for media items within the selected collection:
@ -74,11 +75,26 @@ Select how you want this schedule item to behave every time it is selected for p @@ -74,11 +75,26 @@ Select how you want this schedule item to behave every time it is selected for p
- `One`: Play one media item from the collection before advancing to the next schedule item.
- `Multiple`: Play the specified `Multiple Count` of media items from the collection before advancing to the next schedule item.
- `Duration`: Play the maximum number of complete media items that will fit in the specified `Playout Duration` before either going offline for the remainder of the playout duration (an `Offline Tail`), or immediately advancing to the next schedule item.
- `Duration`: Play the maximum number of complete media items that will fit in the specified `Playout Duration`
- `Flood`: Play media items from the collection either forever or until the next schedule item's start time, if one exists.
Click `Save Changes` to save all changes made to the schedule's items.
#### Tail Mode (Duration)
Select how you want this duration schedule item to behave when no more complete media items will fit in the specified `Playout Duration`:
- `(none)`: Immediately advance to the next schedule item
- `Offline`: Show the ETV offline image for the remainder of the `Playout Duration`
- `Filler`: Fill the remainder of the `Playout Duration` with the specified collection, followed by the ETV offline image if needed
#### Guide Mode
Select how you want this schedule item to behave in the channel guide:
- `Normal`: show all scheduled items in the channel guide
- `Filler`: hide all scheduled items from the channel guide, and extend the end time for the previous item in the guide
## Create Playout
Playouts assign a schedule to a channel and individually track the ordered playback of collection items.

20
docs/user-guide/local-libraries.md

@ -106,4 +106,22 @@ ErsatzTV will read the following fields from the artist NFO: @@ -106,4 +106,22 @@ ErsatzTV will read the following fields from the artist NFO:
### Artist Fallback Metadata
When no artist NFO is found, the artist metadata will only contain a name, which will be the exact name of the artist subfolder.
When no artist NFO is found, the artist metadata will only contain a name, which will be the exact name of the artist subfolder.
## Other Videos
### Folder Layout
The `Other Videos` library has no folder requirements, but folders can be a useful source of metadata.
### Other Video Fallback Metadata
Other videos will have a tag added to their metadata for every containing folder, including the top-level folder. As an example, consider adding a commercials folder with the following files:
- `Commercials\1990\Cars\1990 Car Commercial 1.mkv`
- `Commercials\1992\Cars\1992 Car Commercial 1.mkv`
Your other video library will then have two media items with the following metadata:
1. title: `1990 Car Commercial 1`, tags: `Commercials`, `1990`, `Cars`
2. title: `1992 Car Commercial 1`, tags: `Commercials`, `1992`, `Cars`

31
docs/user-guide/sample-schedules.md

@ -0,0 +1,31 @@ @@ -0,0 +1,31 @@
## 24/7 Show
This schedule will play a single show 24/7, chronologically, repeating forever with no gaps
Schedule Item 1|
:--:|
![24/7 Show](../images/sample-schedule-247-show.png)|
## 24/7 Balanced Shows
This schedule will play multiple shows in a specific order, each playing chronologically, repeating forever with no gaps
Schedule Item 1 | Schedule Item 2
:--:|:--:
![24/7 Balanced Shows 1](../images/sample-schedule-247-balanced-shows-1.png) | ![24/7 Balanced Shows 2](../images/sample-schedule-247-balanced-shows-2.png)
## 24/7 Shows with Filler
This schedule will play multiple shows, in a mixed order, each playing chronologically, repeating forever with up to 5 minutes of filler between each episode
Schedule Item 1 | Schedule Item 2
:--:|:--:
![24/7 Shows With Filler 1](../images/sample-schedule-247-shows-with-filler-1.png) | ![24/7 Shows With Filler 2](../images/sample-schedule-247-shows-with-filler-2.png)
## 24/7 Show Every 30 Minutes with Filler
This schedule will play a single show 24/7, shuffled, repeating forever and will pad the end of each show to a full 30 minutes with filler content
Schedule Item 1|
:--:|
![24/7 Show Every 30 Minutes with Filler](../images/sample-schedule-247-show-every-30-minutes-with-filler.png)|

8
docs/user-guide/search.md

@ -78,6 +78,14 @@ The following fields are available for searching music videos: @@ -78,6 +78,14 @@ The following fields are available for searching music videos:
- `release_date`: The music video release date (YYYYMMDD)
- `type`: Always `music_video`
### Other Videos
The following fields are available for searching other videos:
- `title`: The filename of the video (without extension)
- `tag`: All of the video's parent folders
- `type`: Always `other_video`
## Special Search Fields
- `released_inthelast`: For any media type that supports `release_date`, `released_inthelast` takes a number and a unit (days, weeks, months, years) and returns items released between the specified time ago and now

1
mkdocs.yml

@ -9,6 +9,7 @@ nav: @@ -9,6 +9,7 @@ nav:
- 'Advanced':
- 'Local Libraries': 'user-guide/local-libraries.md'
- 'Search': 'user-guide/search.md'
- 'Sample Schedules': 'user-guide/sample-schedules.md'
theme:
name: material
palette:

Loading…
Cancel
Save