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.
165 lines
11 KiB
165 lines
11 KiB
# Region Collections
|
|
|
|
The `region` Default Collection File is used to dynamically create collections based on the countries within your
|
|
library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of
|
|
countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with
|
|
everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those
|
|
libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point
|
|
might be seen as controversial. You are welcome to edit this to fit your own audience's needs.
|
|
|
|
**[This file has a Show Library Counterpart.](../show/region.md)**
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
Supported Library Types: Movie
|
|
|
|
## Collections Section 081
|
|
|
|
| Collection | Key | Description |
|
|
|:--------------------------------------|:--------------------------------------|:-------------------------------------------------------------------------------|
|
|
| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
|
| `<<Region>>`<br>**Example:** `Nordic` | `<<Region>>`<br>**Example:** `Nordic` | Collection of Movies that have been tagged with countries in this region. |
|
|
| `Other Regions` | `other` | Collection of Movies that are in other uncommon Regions. |
|
|
|
|
## Config
|
|
|
|
The below YAML in your config.yml will create the collections:
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: region
|
|
```
|
|
|
|
## Color Style
|
|
|
|
Below is a screenshot of the alternative Color (`color`) style which can be set via the `style` template variable.
|
|
|
|
|
|
|
|
## 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 `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
|
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
|
|
|
??? abstract "Variable Lists (click to expand)"
|
|
|
|
* **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file.
|
|
|
|
* **Shared Template Variables** are additional variables shared across the Kometa Defaults.
|
|
|
|
* **Shared Separator Variables** are additional variables available since this Default contains a
|
|
[Separator](../separators.md).
|
|
|
|
=== "File-Specific Template Variables"
|
|
|
|
| Variable | Description & Values |
|
|
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<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:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../files/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](../../files/builders/smart.md#sort-options) |
|
|
| `include` | **Description:** Overrides the [default include list](#include).<br>**Values:** List of Countries found in your library |
|
|
| `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.<br>**Values:** List of Countries found in your library |
|
|
| `addons` | **Description:** Overrides the [default addons dictionary](#addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Dictionary List of Countries found in your library |
|
|
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Countries found in your library |
|
|
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Countries found in your library |
|
|
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Countries found in your library |
|
|
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Countries found in your library |
|
|
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
|
|
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
|
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
|
|
|
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
|
`<<key>>` with when calling.
|
|
|
|
=== "Shared Template Variables"
|
|
|
|
{%
|
|
include-markdown "../collection_variables.md"
|
|
%}
|
|
|
|
=== "Shared Separator Variables"
|
|
|
|
{%
|
|
include-markdown "../separator_variables.md"
|
|
%}
|
|
|
|
???+ example "Example Template Variable Amendments"
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
|
|
|
Click the :fontawesome-solid-circle-plus: icon to learn more
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: region
|
|
template_variables:
|
|
use_other: false #(1)!
|
|
use_separator: false #(2)!
|
|
style: color #(3)!
|
|
exclude:
|
|
- French #(4)!
|
|
sort_by: title.asc
|
|
```
|
|
|
|
1. Do not create the "Other Regions" collection
|
|
2. Do not create a "Region Collections" separator
|
|
3. Set the [Color Style](#color-style)
|
|
4. Exclude "French" from the list of collections that are created
|
|
|
|
## Default Values
|
|
|
|
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
|
show how to change a name or a list.**
|
|
|
|
If you want to customize these values, use the methods described above.
|
|
|
|
??? example "Default `include` (click to expand) <a class="headerlink" href="#include" title="Permanent link">¶</a>"
|
|
|
|
<div id="include" />
|
|
|
|
```{ .dtd .no-copy }
|
|
###############################################################################
|
|
################################## IMPORTANT ##################################
|
|
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
|
|
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
|
|
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
|
|
###############################################################################
|
|
include: {%
|
|
include-markdown "../../../defaults/movie/region.yml"
|
|
comments=false
|
|
preserve-includer-indent=false
|
|
start="include:"
|
|
end="addons:"
|
|
%}
|
|
```
|
|
|
|
??? example "Default `addons` (click to expand) <a class="headerlink" href="#addons" title="Permanent link">¶</a>"
|
|
|
|
<div id="addons" />
|
|
|
|
```{ .dtd .no-copy }
|
|
###############################################################################
|
|
################################## IMPORTANT ##################################
|
|
##################### THIS DATA IS PROVIDED FOR REFERENCE ####################
|
|
## DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
|
|
############# SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
|
|
###############################################################################
|
|
addons: {%
|
|
include-markdown "../../../defaults/movie/region.yml"
|
|
comments=false
|
|
preserve-includer-indent=false
|
|
start="addons:"
|
|
%}
|
|
```
|