Add separators.md file to defaults docs

This commit is contained in:
YozoraXCII 2022-10-03 08:40:42 +01:00
parent 2900ddc4a5
commit 5459f9ce61
3 changed files with 75 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 446 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 300 KiB

View file

@ -0,0 +1,75 @@
# Separators Default Metadata File
Separators are a special form of collections which are used similar to index cards in a library, they help to "split up" collections by identifying categories (such as "Studio Collections" and "Holiday Collections").
These are empty collections which do not contain any movies/shows themselves, but highlight that the the collections which follow it are of a certain category.
Below is an example of a separator, which can be seen surrounded by a red square.
![](images/separators.jpg)
Separators are enabled by default, but can be disabled/enabled per-file and per-library.
An example of disabling separators at the library-level cam be seen here
```yaml
libraries:
Movies:
template_variables:
use_separator: false
```
And at the file-level
```yaml
libraries:
Movies:
metadata_path:
- pmm: studio
template_variables:
use_separator: false
```
## Alternative Styles
Multiple styles are available for Separators, to match Plex's "categories" feature.
The available styles avaiable are:
| Style | Value |
|:----------------|:------:|
| Original | orig |
| Blue | blue |
| Brown | stb |
| Gray | gray |
| Green | green |
| Purple | purple |
| Red | red |
This image shows an example separator in each of the above styles
![](images/separators2.jpg)
The style of separator can be defined per-file and per-library.
An example of disabling separators at the library-level cam be seen here
```yaml
libraries:
Movies:
template_variables:
sep_style: red
```
And at the file-level
```yaml
libraries:
Movies:
metadata_path:
- pmm: studio
template_variables:
sep_style: stb
```