mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
Merge pull request #1070 from YozoraXCII/defaults
Add separators.md file to defaults docs
This commit is contained in:
commit
1832a8e03a
4 changed files with 75 additions and 13 deletions
BIN
docs/defaults/images/separators.jpg
Normal file
BIN
docs/defaults/images/separators.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 446 KiB |
BIN
docs/defaults/images/separators2.jpg
Normal file
BIN
docs/defaults/images/separators2.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 300 KiB |
75
docs/defaults/separators.md
Normal file
75
docs/defaults/separators.md
Normal 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
|
||||
```
|
||||
|
||||
|
|
@ -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).
|
||||
|
|
Loading…
Reference in a new issue