Plex-Meta-Manager/docs/defaults/show/decade.md

79 lines
4.7 KiB
Markdown
Raw Normal View History

2022-10-10 16:56:05 -04:00
# Decade Collections
The `decade` Collection File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
2023-11-06 15:38:00 -05:00
**This file has a Movie Library [Counterpart](../movie/decade.md).**
![](../images/decade.png)
## Requirements & Recommendations
Supported Library Types: Show
2023-02-08 10:18:02 +00:00
## Collections Section 100
2022-10-10 16:56:05 -04:00
2023-12-13 16:44:44 -05:00
| Collection | Key | Description |
|:-----------------------------------------------------|:----------------------------------|:-------------------------------------------------------------------------------|
2023-11-06 15:38:00 -05:00
| `Decade Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
2023-12-13 16:44:44 -05:00
| `Best of <<Decade>>`<br>**Example:** `Best of 2020s` | `<<Year>>`<br>**Example:** `2020` | Collection of Shows released in this Decade. |
2022-10-10 16:56:05 -04:00
## Config
2022-09-27 18:01:34 -04:00
The below YAML in your config.yml will create the collections:
2022-10-10 16:56:05 -04:00
```yaml
libraries:
2022-10-10 16:56:05 -04:00
TV Shows:
collection_files:
2023-01-06 17:53:05 +00:00
- pmm: decade
```
## Template Variable Default Values
2022-10-10 16:56:05 -04:00
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
2023-11-06 15:38:00 -05:00
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
2022-11-03 15:44:01 -04:00
2023-12-13 16:44:44 -05:00
| Variable | Description & Values |
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater than 0 |
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `critic_rating.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options) |
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../builders/smart.md#sort-options) |
| `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.<br>**Values:** List of Decades found in your library |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. |
2022-10-17 13:13:48 +01:00
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
{%
include-markdown "../collection_variables.md"
%}
{%
include-markdown "../collection_variables.md"
%}
### Example Template Variable Amendments
2022-10-08 12:31:06 -04:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
libraries:
Movies:
collection_files:
- pmm: year
template_variables:
sep_style: purple #(1)!
sort_by: title.asc
sort_by_2020: release.desc #(2)!
```
1. Use the purple [Separator Style](../separators.md#separator-styles)
2. Set the sort order for "Best of 2020s" to release date descending