Merge pull request #1070 from YozoraXCII/defaults

Add separators.md file to defaults docs
This commit is contained in:
meisnate12 2022-10-03 09:09:01 -04:00 committed by GitHub
commit 1832a8e03a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 75 additions and 13 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
```

View file

@ -216,19 +216,6 @@ libraries:
```
</details>
## Separators
By default, most metadata files use separators to denote different sections of collection like actor collections vs studio collections.
<details>
<summary>Click to expand to see an example of Separators.</summary>
![](separators.jpg)
</details>
* Can be turned off by [customizing your config](#customizing-configs)
## Collection Section Order
Almost every default metadata file has a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs).