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.
8.7 KiB
8.7 KiB
Network Collections
The network Default Collection File is used to dynamically create collections based on the networks available in your library.
Requirements & Recommendations
Supported Library Types: Show
Collections Section 050
| Collection | Key | Description |
|---|---|---|
Network Collections |
separator |
Separator Collection to denote the Section of Collections. |
<<network>>Example: NBC |
<<network>>Example: NBC |
Collection of Shows the aired on the network. |
Poster Styles
This Default can use the style template variable to easily change the posters styles.
Color Style (Default)
White Style
Config
The below YAML in your config.yml will create the collections:
libraries:
TV Shows:
collection_files:
- pmm: network
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.
??? info "Click to expand"
=== "File-Specific Template Variables"
The below template variables are available specifically for this PMM Defaults file.
Be sure to also check out the "Shared Template Variables" tab for additional variables.
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
| Variable | Description & Values |
|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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) |
| `style` | **Description:** Choose between the default color version or the **white** one.<br>**Values:** `color` or `white` |
| `include` | **Description:** Overrides the [default include list](#include).<br>**Values:** List of Networks found in your library |
| `append_include` | **Description:** Appends to the [default include list](#include).<br>**Values:** List of Networks found in your library |
| `remove_include` | **Description:** Removes from the [default include list](#include).<br>**Values:** List of Networks found in your library |
| `exclude` | **Description:** Exclude these Networks from creating a Dynamic Collection.<br>**Values:** List of Networks 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 Networks found in your library |
| `append_addons` | **Description:** Appends to the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Networks found in your library |
| `remove_addons` | **Description:** Removes from the [default addons dictionary](#addons).<br>**Values:** Dictionary List of Networks found in your library |
| `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 broadcast on <<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"
%}
### Example Template Variable Amendments
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: network
template_variables:
style: white
append_exclude:
- BBC #(1)!
sort_by: title.asc
collection_mode: show_items #(2)!
sep_style: gray #(3)!
```
1. exclude "BBC" from the list of items that should be included in the Collection list
2. Show these collections and their items within the "Library" tab
3. Use the gray [Separator Style](../separators.md#separator-styles)
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) ¶"
<div id="include" />
```yaml
include: {%
include-markdown "../../../defaults/show/network.yml"
comments=false
preserve-includer-indent=false
start="include:"
end="addons:"
%}
```
??? example "Default addons (click to expand) ¶"
<div id="addons" />
```yaml
addons: {%
include-markdown "../../../defaults/show/network.yml"
comments=false
preserve-includer-indent=false
start="addons:"
%}
```