You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
72 lines
17 KiB
72 lines
17 KiB
# Seasonal Collections
|
|
|
|
The `seasonal` Default Metadata File is used to dynamically create seasonal collections based on holidays .
|
|
|
|
**This file only works with Movie Libraries.**
|
|
|
|
|
|
|
|
## Collections Section 00
|
|
|
|
| Collection | Key | Description |
|
|
|:-----------------------------|:--------------:|:-----------------------------------------------------------|
|
|
| `Seasonal Collections` | `separator` | Separator Collection to denote the Section of Collections. |
|
|
| `🎊 New Year's Day Movies` | `years` | Collection of Movies related to New Year's Day. |
|
|
| `💘 Valentine's Day Movies` | `valentine` | Collection of Movies related to Valentine's Day. |
|
|
| `☘ St. Patrick's Day Movies` | `patrick` | Collection of Movies related to St. Patrick's Day. |
|
|
| `🐰 Easter Movies` | `easter` | Collection of Movies related to Easter. |
|
|
| `🤱 Mother's Day Movies` | `mother` | Collection of Movies related to Mother's Day. |
|
|
| `🪖 Memorial Day Movies` | `memorial` | Collection of Movies related to Memorial Day. |
|
|
| `👨 Father's Day Movies` | `father` | Collection of Movies related to Father's Day. |
|
|
| `🎆 Independence Day Movies` | `independence` | Collection of Movies related to Independence Day. |
|
|
| `⚒ Labor Day Movies` | `labor` | Collection of Movies related to Labor Day. |
|
|
| `🎃 Halloween Movies` | `halloween` | Collection of Movies related to Halloween. |
|
|
| `🦃 Thanksgiving Movies` | `thanksgiving` | Collection of Movies related to Thanksgiving. |
|
|
| `🎅 Christmas Movies` | `christmas` | Collection of Movies related to Christmas. |
|
|
|
|
## Config
|
|
|
|
The below YAML in your config.yml will create the collections:
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
metadata_path:
|
|
- pmm: seasonal
|
|
```
|
|
|
|
## Template Variables
|
|
|
|
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.
|
|
|
|
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
|
|
|
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
|
|
|
|
| Variable | Description & Values |
|
|
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `true` to turn on the collection |
|
|
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` |
|
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
|
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
|
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
|
| `schedule_<<key>>` | **Description:** Changes the Schedule of the specified key's collection.<br>**Default:**<table class="clearTable"><tr><td><code>🎊 New Year's Day Movies</code></td><td>range(12/26-01/04)</td></tr><tr><td><code>💘 Valentine's Day Movies</code></td><td>range(02/01-02/29)</td></tr><tr><td><code>☘ St. Patrick's Day Movies</code></td><td>range(03/01-03/18)</td></tr><tr><td><code>🐰 Easter Movies</code></td><td>range(03/20-04/30)</td></tr><tr><td><code>🤱 Mother's Day Movies</code></td><td>range(05/05-05/10)</td></tr><tr><td><code>🪖 Memorial Day Movies</code></td><td>range(5/18-6/7)</td></tr><tr><td><code>👨 Father's Day Movies</code></td><td>range(06/15-06/20)</td></tr><tr><td><code>🎆 Independence Day Movies</code></td><td>range(06/23-07/11)</td></tr><tr><td><code>⚒ Labor Day Movies</code></td><td>range(09/01-09/10)</td></tr><tr><td><code>🎃 Halloween Movies</code></td><td>range(10/01-10/31)</td></tr><tr><td><code>🦃 Thanksgiving Movies</code></td><td>range(11/01-11/30)</td></tr><tr><td><code>🎅 Christmas Movies</code></td><td>range(12/01-12/31)</td></tr></table><br>**Values:** [Any Schedule Option](../../metadata/details/schedule) |
|
|
| `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.<br>**Values:** List of Seasons Keys |
|
|
| `seasonal_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
|
| `seasonal_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `A collection of <<key_name>> <<library_translation>>s that may relate to the season.`<br>**Values:** Any string. |
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
metadata_path:
|
|
- pmm: seasonal
|
|
template_variables:
|
|
use_separator: true
|
|
sep_style: stb
|
|
use_independence: false
|
|
schedule_thanksgiving: range(10/01-10/30)
|
|
sort_by: random
|
|
``` |